Guide to HP OneView: Downloading the State-Change Message Bus SCMB

26 Using the State-Change Message Bus (SCMB)

The State-Change Message Bus (SCMB) is an interface that uses asynchronous messaging to notify subscribers of changes to managed resources—both logical and physical. For example, you can program applications to receive notifications when new server hardware is added to the managed environment or when the health status of physical resources changes—without having to continuously poll the appliance for status using the REST APIs.

HP OneView resources publish messages to the SCMB when they are created, updated, or deleted. The message content is sent in JSON format and includes the resource’s Data Transfer Object.

To use the SCMB, you must:

1.Use REST APIs to create and download an AMQP certificate from the appliance.

2.Connect to the SCMB using one or both of these methods:

•Use the “EXTERNAL” authentication mechanism

•Connect without sending a user name and password

Using one of these methods ensures that certificate-based authentication is used.

3.Set up a queue with an empty queue name.

4.AMQP generates a unique queue name.

You use this queue name to bind to exchanges and receive messages.

To view the list of HP OneView resources that publish messages, see the HP OneView REST API Reference in the online help.

26.1 Connect to the SCMB

Before you connect a client to the SCMB, you must create and download an AMQP certificate from the appliance. After you connect the client to the SCMB, you can create a queue and listen for messages.

Prerequisites

•Minimum required session ID privileges: Infrastructure administrator

Create and download the AMQP client certificate

Creating and downloading the client certificate, private key, and root CA certificate using REST APIs

1.Create the certificate.

POST /rest/certificates/client/rabbitmq Request body: { "commonName":"default" }

2.Download the certificate and private key.

GET /rest/certificates/client/rabbitmq/keypair/default

3.Download the root CA certificate.

GET /rest/certificates/ca

26.1 Connect to the SCMB 185

Image 185

HP OneView Using the State-Change Message Bus Scmb, Connect to the Scmb, Create and download the Amqp client certificate

Contents

Abstract HP OneView 1.0 User Guide Acknowledgments Contents Navigating the graphical user interface Understanding the security features of the appliance Accessing documentation and help Using the Rest APIs and other programmatic interfacesPlanning for configuration changes II Planning tasks Planning your data center resources Managing networks and network resources 115 An HP 3PAR Storage System 105107 Managing users and authentication 143 Managing power and temperature 139Managing enclosures and enclosure groups 131 Managing firmware for managed devices 135 Managing the appliance 153 Backing up an appliance 149 About unsupported and unmanaged hardware 165 Monitoring power and temperature 179 VI Troubleshooting 197 199 Using the State-Change Message Bus Scmb 185 231 Restoring an appliance from a backup file 221Support and other resources 227 Index 293 Using the virtual appliance console 269Backup and restore script examples 271 Part I Learning about HP OneView Page HP OneView for converged infrastructure management Learning about HP OneViewArchitecture HP OneView for converged infrastructure management Learning about HP OneView Hardware and software provisioning featuresOne tool and one data set-one view Server profiles Hardware and software provisioning featuresGroups, templates, and sets Expert design with consistent deployment Types of groups and sets Define configurations for specific environments Flexibility in design and deployment Streamlined process for bringing hardware under managementOperating system deployment Monitoring and response features Firmware and configuration change management featuresSimplified configuration change management Simplified firmware management Monitoring the environment and responding to issues Automatic configuration for monitoringMonitoring and response features Isolated management network Alert and health management Data center environmental managementResource utilization monitoring Specialized user role for creating backup files Backup and restore featuresRecovery from catastrophic failures Backup and restore features Availability features Security features Rest APIs-automation and integration Graphical and programmatic interfacesUser interface-efficiency and simplicity by design Convenient licensing model Integration with other HP management softwareOpen integration Networking features Networking featuresSupported networks Logical interconnects Network sets Understanding the resource model Resource model summary diagram Connection templates Server profilesRelationship to other resources UI screens and Rest API resources Server hardware types ConnectionsConnection-templates Connections and server-profiles Zero or more server profiles Server hardwareUI screen Rest API resource Server Hardware Types Server-hardware-types Enclosure types Enclosure groupsServer-hardware Enclosure-groups Enclosures Zero or more power delivery devicesInterconnect types Exactly one enclosure group Interconnect-types Interconnects UI screen Rest API resources Interconnects Logical interconnect groupsInterconnects , interconnect-types , Logical-interconnects Logical-interconnect-groups Logical interconnectsUI screen Rest API resource Logical Interconnect Groups UI screen Rest API resource Logical Interconnects Uplink setsLogical-downlinks To a downlink Network sets NetworksZero or one uplink set per logical interconnect Uplink-sets Appliance DomainsNetwork-sets Domains Data centers Resources related data center facilitiesRacks Relationship to other resources Power-devices Power delivery devicesUnmanaged devices Zero or more unmanaged devices Unmanaged-devices UI screen Rest API resource Unmanaged DevicesYou can view, add, or edit the properties Rest APIsPage Securing the appliance Understanding the security features of the applianceSecuring the appliance Best practices for maintaining a secure appliance Understanding the security features of the appliance Creating a login session Creating a login sessionAuthentication for appliance access Protecting credentials Controlling access for authorized usersUnderstanding the audit log Specifying user accounts and roles Understanding the audit log Resource categoryMessage Example 1 Sample audit entries user login and logout Appliance access over SSLManaging certificates from a browser Overview Verifying a certificate Using a certificate authorityDownloading and importing a self-signed certificate Managing certificates from a browser Browser best practices for a secure environment PasswordsNonbrowser clients SSL connection Switching from one console to another Access to the appliance consolePorts needed for HP OneView Required ports Restricting console access Enabling or disabling authorized services accessAlgorithms for securing the appliance SSL see Downloads from the appliance Downloads from the appliancePage Commonly used browser features and settings Required plug-ins and settingsNavigating the graphical user interface Browsers Set US or metric units of measurement About the graphical user interfaceSet the browser for US or metric units of measurement About the graphical user interface Screen topography Button functions About the Activity sidebarBanner and main menu UI buttons Filters sidebarHelp sidebar Oneviewcommunity online Icon descriptions User control icons Status and severity iconsLarge icon Small icon Resource Activity Task Critical Display details Informational icons Map view screen details Notifications area Notifications area Search help topics Log out of the appliance About help system search results Search resources View resources according to their health status Error Unknown DisabledAdvanced searching and filtering with properties Nameenclosure10 name192.0.2.0, PDU View resources according to their health status Reset the health status viewPage Resource operations Using the Rest APIs and other programmatic interfacesOperation Http Verb Create Resource data Return codes Log in to the appliance using Rest APIsURI format Resource model format Concurrency control using etags Error handlingAsynchronous versus synchronous operations Task resource Developer tools in a web browser Querying resources using common Rest API parametersState Change Message Bus Online help-conceptual and task information as you need it Accessing documentation and helpThis user guide supplements the online help Rest API help design Accessing documentation and help Where to find HP OneView documentationHP OneView documentation Downloading Html help and Rest API files Part II Planning tasks Page Security planning Planning your data center resourcesHow many data centers? Choosing a security certificate policy Determining your backup policyDetermining roles and restrictions for authorized users Choosing a policy for the audit log Planning your resource names Preparing your data center network switchesReviewing your firewall access Resource name Planning the appliance configurationAppliance VM and host requirements Location of the appliance Planning for high availabilitySeparate networks for data and management Time clocks and NTPPage Appliance Planning for configuration changesEnclosures Interconnects and logical interconnects Adding a network Planning for configuration changesServer profiles and server hardware Adding an enclosure Page Part III Configuration quick starts Page Configure the environment for the first time Quick Start Initial ConfigurationProcess overview Process overview Directory-based authentication Local authenticationEthernet Fibre Channel Configuration step Required action or input Configuration step Add power devices to the appliance Page Resource Task Description Networks Add the network Process Server Profiles Hardware Resource TaskPage Checklist connecting a server blade to a data center network Page Resource Task Enclosures Process Groups Enclosure Resource Task Logical Create a logical InterconnectServer Profiles Do one Following Hardware Create a server It to the server Enter a name for 104 105 Attach network Resource Task Description Networks Add the FibreSets for the Direct 107 Resource Task Server Hardware Add the server usingRest APIs for 108 Part IV Configuration and management 110 Managing servers and server profiles Server hardware features supported by the applianceUI screens and Rest API resources Server-profiles and connections Tasks for server profiles Prerequisites for bringing server hardware under managementRoles Tasks for server hardware types Tasks for server hardwareEffects of managing server hardware iLOs Tasks for server hardware Learning more Managing networks and network resources Data center switch port requirementsManaging Fibre Channel networks SANs Interconnects About network connectivity Managing Ethernet networksRoles Tasks About network connectivity About Fibre Channel networksFibre Channel network types Direct attach Fibre Channel networks Fabric attach Fibre Channel networks About network sets About Ethernet networksFibre Channel networks and FCoE Ethernet networks and network sets Network set details Managing enclosure interconnect hardware Managing enclosure interconnect hardwareAbout interconnects Learning more Interconnects Networking featuresConnectivity and synchronization with the appliance About unsupported interconnects About logical interconnects Server Blade Logical Interconnect Uplink sets Adding a logical interconnect Stacking modesStacking health Deleting a logical interconnect About logical interconnect groups Logical Interconnect Group a About Snmp settings Configuration defined by the logical interconnect group? Items Compliance checking Ethernet interconnect settingsSet? Interconnect maps Configure a port to monitor network traffic 130 Prerequisites for bringing an enclosure under management Managing enclosures and enclosure groups About enclosures TasksConnectivity and synchronization with the appliance Managing enclosures and enclosure groups About enclosure groups About enclosure groupsEffects of managing an enclosure 134 About the appliance firmware repository Managing firmware for managed devicesAbout unsupported firmware Unsupported firmware for firmware bundles Roles and Tasks Firmware update processUnsupported firmware for enclosures Unsupported firmware for server profiles Best practice First step Upload the latest current SPP Best practices for firmwareOption Best practice Troubleshooting firmware bundles About power delivery devices Managing power and temperatureManaging power About racks Managing power and temperature Default data center Datacenter Managing temperatureDefault rack placement Managing temperature About utilization graphs About user accounts Managing users and authenticationReset the administrator password Action privileges for user roles About user rolesAppliance role types Action privileges for user roles Global settings Administrator BackupsLogin sessions Restores About directory service authentication About authentication settings Managing user passwords Managing user passwords Resetting the administrator password Reset the administrator password Backup file name Overview of the backup processBackups Backing up an appliance Backing up an appliance Guidelines for creating a backup fileCreate and download a backup file Post /rest/backups Creating and downloading a backup fileDownload the backup file GET /rest/backups/archive/backup URI 152 Managing appliance availability Managing the applianceBest practices for managing a VM appliance How the appliance handles an unexpected shutdown What to do when an appliance restarts Appliance recovery operationsShut down the appliance Restart the appliance Restarting the appliance Managing the appliance settingsAbout appliance Snmp settings Enabling or disabling HP support access to the appliance Managing the security features of the applianceManaging addresses and ID pools Id-pools Managing the HP public key Managing SSL certificatesRoles Tasks Downloading audit logs Managing licensesAudit-logs Licenses License types About licensingLicense delivery License reporting License graph colors Server hardware licensingView license status Enclosure licensing policy behavior Licensed featuresServer blade licensing at the enclosure level Licensing and utilization statistics Rack mount server licensingLicensing scenarios Rack mount server licensing behavior Licensing scenarios Updating the appliance Appliance/firmware How the appliance handles unsupported hardware About unsupported and unmanaged hardwareAbout unmanaged devices How the appliance handles unsupported hardware 166 Part V Monitoring 168 Daily monitoring Monitoring data center status, health, and performanceInitial check the Dashboard Activities Best practices for monitoring data centers Monitor data center temperatureBest practices for monitoring health with the appliance UI General health monitoring steps Server hardware health monitoring Best practices for monitoring health using Rest APIsNetwork health monitoring Overall health monitoring GET /rest/alerts Get a specific alert using the alert IDGET /rest/alerts/id Get the associated events About activities Managing activitiesGET /rest/logical-interconnects/id Managing activities About alerts Activity types alerts and tasksAbout tasks Task type Description User Activity statuses Activity states How to interpret the Dashboard graphs Using the Dashboard screenAbout the Dashboard Dashboard screen details Status icons Disabled or Unknown Monitoring data center status, health, and performance Power and temperature monitoring feature overview Monitoring power and temperaturePower and temperature monitoring features by resource UI power and temperature monitoring Manipulating the view of the data center visualization Monitoring power and temperature About utilization graphs Monitoring power and temperature utilizationAbout the Utilization panel Utilization statistics gathered by resource Enclosures Power Delivery Devices Server HardwareUtilization graphs Utilization metric Resource Power utilization metrics Update enclosure power capacity settings Rest API power and temperature monitoringUpdate server hardware power capacity settings Prerequisites GET /rest/certificates/client/rabbitmq/keypair/default Using the State-Change Message Bus ScmbConnect to the Scmb Create and download the Amqp client certificate Using the State-Change Message Bus Scmb Set up a queue to connect to the HP OneView Scmb exchange Sample queues Json structure of message received from the Scmb Example 2 Json example NET C# code exampleChangeType values NET C# code example Additional example-specific prerequisites Examples Java code example Java code example Example 5 Java code example Python code example Python code example Example 6 Python code example pika Example 7 Python code example amqplib Re-create the Amqp client certificate Re-create the Amqp client certificateDelete /rest/certificates/ca/rabbitmqreadonly 196 Part VI Troubleshooting 198 199 TroubleshootingCategory About network setup errors Basic troubleshooting techniquesAbout reported serious errors Recommendation Details Look for a message Create a support dump file When VM host is down or nonresponsiveCreating a support dump file Recommendation Details Post /rest/appliance/support-dumps Creating a support dump using Rest APIs Create support dumpDownload the support dump file GET /rest/appliance/support-dumps/file name First time setup Troubleshooting the applianceAppliance cannot access the network Unexpected appliance shutdown Support dump file creation action fails Appliance update is unsuccessfulCertificate action fails Insufficient time Backup file creation is still in progress Backup file creation, download, or restore action failsBackup file is incompatible Appliance network is down Restore operation fails or times out Profile operation was running during the backupInternal server error Restart or shutdown failure Reinstall the software VM does not restart when VM host time is manually setReinstall the remote console Add or remove enclosure is unsuccessful Troubleshooting enclosures and enclosures groupsClear vcmode Restart interconnect Restart interconnect N Certificate Error Troubleshooting firmware bundlesAdd server blade is unsuccessful Incorrect credentials Troubleshooting licensing Troubleshooting interconnects 27.9.1 I/O bay occupancy errors Troubleshooting logical interconnectsUplink set warnings or errors License assigned does not match the type specified Troubleshooting server hardware Troubleshooting networksPhysical interconnect warnings and errors Network create operation is unsuccessful Is claimed by that software Cannot control power on server blade Troubleshooting server profiles Troubleshooting server profilesServer profile is not created or updated correctly Prerequisites and conditions have not been met Server hardware or its iLO are powered-off or reset What to do when you cannot apply the server profileInvalid configuration Verify the operational status of the server hardware Unauthenticated user or group Troubleshooting user accountsProfile operations fail Incorrect privileges Cannot add directory service Directory service not availableUser public key is not accepted Inaccurate credentials Lost connection with directory service host Cannot add server for a directory serviceUser or group not configured in the directory service Cannot add directory user or group Restore operation overview Restoring an appliance from a backup fileRestores See also Post-restoration tasks Restoring an appliance from a backup file Preparing to restore an appliance Restore an appliance from a backup file Restore an appliance from a backup file Creating a custom script to restore an appliance Using Rest APIs to restore an appliance from a backup fileRestoring an appliance from a backup file Post-restoration tasks Post-restoration tasks Preventing duplicate IDs on the network after a restore 226 Software technical support and software updates How to contact HPSupport and other resources Get connected to the HP OneView online user forum Related information Using your software technical support and update serviceDocumentation Product websites Support and other resources For UI and Rest API help Submit documentation feedbackFor user guides and other manuals Docsfeedback@hp.com 230 Information about the sample data center Tasks you can perform without data center hardwareSample data center hardware Tasks you can perform without data center hardware OAAdmin ILOAdminRack mount server Enclosure Fibre Channel networks for the SAN fabrics Data center networksFibre Channel networks Storage system SAN a and SAN B Fibre Channel network configurationsSwitches in the data center Production networks Ethernet NetworksNetworks for vMotion and virtual machine management Planning for installation of the appliance Planning the configurationEthernet network configuration values Development networks Planning for users and roles Planning the configurationPlanning for network sets Planning resource names Installing the applianceAssumptions Workflow Copying the template server profile to eight servers Configuring the networks and network setsConfiguring the Fibre Channel SAN networks Configuring the Ethernet networks Prod 1101 1102 1103 1104 Use the following names and Vlan IDs for the test networks Configuring the network sets Page Creating the logical interconnect group Creating a logical interconnect group and its uplink sets Creating the uplink sets for the Fibre Channel networks Creating the uplink sets for the Ethernet networks TestUS ProdUSDevUS Click Create to create the logical interconnect group Creating an enclosure group for vSphere ESXi hosts Adding the enclosure Enclosures PasswordViewing the server hardware types 172.18.1.12 Address Viewing server hardware types Creating a server profile to use as a templateEditing server hardware types View information about the server hardwarePage Esxi mgmt Attribute Value Device type Ethernet NetworkSecondary Esxi vmotion Requested bandwidth Boot Not bootableAttribute Value Device type Fibre Channel Network Page Esx02 Encl1, bay Esx03 Esx04 Esx05 Esx06 Esx07 Esx08 Copying the template server profile to eight serversName Server hardware Creating the Flat SAN networks 172.18.1.14 Address Page Page Enclosure name Creating the server profileEncl2 Enclosure group name FlatSAN a Requested bandwidth Default value FlexNICDevice type Fibre Channel Network FlatSAN B Page Assumptions Viewing information about the server Powering on the serverAdding the server hardware Page Adding a license for the server Page Using the virtual appliance console Using the virtual appliance consoleUsing the virtual appliance console Key combinations for the virtual appliance console 270 Sample backup script Backup and restore script examplesSample backup script Sample script Backup and restore script examples Example 8 Sample backup.ps1 script Sample backup script None, does not accept piping Sample backup script Backup and restore script examples Backup resource object Absolute path of the download file Sample backup script Backup and restore script examples Sample backup script Sample restore script Sample restore script Example 9 Sample restore.ps1 script Outputs the new active Api version Response body to the upload post request Sample restore script Outputs the response body from the Post restore call None, end of script upon completion or fail Uri of the restore task in string form Sample restore script Backup and restore script examples 293 Host, security access, 80 initial configurationIndex Index Eula 295 Scmb see State-Change Message Bus Status icon, 62 storage system website Logical interconnect, 125 State-Change Message Bus 297 Vlan ID