Return codes, URI format, Resource model format | HP OneView

5.2 Return codes

Return code	Description
2xx	Successful operation
4xx	Client-side error with error message returned
5xx	Appliance error with error message returned

NOTE: If an error occurs, indicated by a return code 4xx or 5xx, an ErrorMessage is returned. The expected resource model is not returned.

5.3 URI format

All URIs point to resources. The client does not need to create or modify URIs. The URI for a resource is static and uses the format https://{appl}/rest/resource category/resource ID where:

https://{appl}	Appliance address
/rest	Type of URI
/resource category	Category of the resource (for example server-profiles)
/resource instance ID	Identifier of specific resource instance (optional)

5.4 Resource model format

The resources support JSON (JavaScript Object Notation) for exchanging data using a REST API. If not otherwise specified in the REST API operation, the default is JSON.

5.5 Log in to the appliance using REST APIs

When you log in to the appliance using the login-sessionsREST API, a session ID is returned. You use the session ID in all subsequent REST API operations in the auth header, except as noted in REST API Request Headers. The session ID is valid for 24 hours.

Log in

Operation

POST

API

/rest/login-sessions

Request headers

REST API Request Headers

Request body

{"userName":"YourUserName","password":"YourPassword"}

NOTE: This is an example of a local log in on the appliance. If you are using a directory service, you must add the following attributes: authnHost and authLoginDomain.

Response

The LoginSessionIdDTO that includes the session ID

Log out

Operation

DELETE

API

/rest/login-sessions

Request headers

auth:{YourSessionID}

REST API Request Headers

Request body

None

Response

204 No Content

5.6 REST API version

When you perform a REST API operation, a X-API-Versionheader is required. This version header corresponds to the REST API version of software currently running on the appliance. To

72 Using the REST APIs and other programmatic interfaces

Image 72

HP OneView Return codes, URI format, Resource model format, Log in to the appliance using Rest APIs, Rest API version

Contents

HP OneView 1.0 User Guide Abstract Acknowledgments Contents Understanding the security features of the appliance Navigating the graphical user interface Using the Rest APIs and other programmatic interfaces Accessing documentation and helpPlanning for configuration changes II Planning tasks Planning your data center resources An HP 3PAR Storage System 105 107Managing networks and network resources 115 Managing power and temperature 139 Managing users and authentication 143Managing enclosures and enclosure groups 131 Managing firmware for managed devices 135 Backing up an appliance 149 Managing the appliance 153 Monitoring power and temperature 179 About unsupported and unmanaged hardware 165 Using the State-Change Message Bus Scmb 185 VI Troubleshooting 197 199 Restoring an appliance from a backup file 221 Support and other resources 227231 Using the virtual appliance console 269 Backup and restore script examples 271Index 293 Part I Learning about HP OneView Page Learning about HP OneView HP OneView for converged infrastructure managementArchitecture HP OneView for converged infrastructure management Hardware and software provisioning features One tool and one data set-one viewLearning about HP OneView Hardware and software provisioning features Server profilesGroups, templates, and sets Expert design with consistent deployment Define configurations for specific environments Types of groups and sets Streamlined process for bringing hardware under management Operating system deploymentFlexibility in design and deployment Firmware and configuration change management features Monitoring and response featuresSimplified configuration change management Simplified firmware management Automatic configuration for monitoring Monitoring the environment and responding to issuesMonitoring and response features Isolated management network Data center environmental management Resource utilization monitoringAlert and health management Backup and restore features Specialized user role for creating backup filesRecovery from catastrophic failures Backup and restore features Security features Availability features Graphical and programmatic interfaces User interface-efficiency and simplicity by designRest APIs-automation and integration Integration with other HP management software Open integrationConvenient licensing model Networking features Networking featuresSupported networks Logical interconnects Network sets Resource model summary diagram Understanding the resource model Server profiles Connection templatesRelationship to other resources UI screens and Rest API resources Connections Server hardware typesConnection-templates Connections and server-profiles Server hardware Zero or more server profilesUI screen Rest API resource Server Hardware Types Server-hardware-types Enclosure groups Enclosure typesServer-hardware Enclosure-groups Zero or more power delivery devices EnclosuresInterconnect types Exactly one enclosure group Interconnects Interconnect-types Logical interconnect groups UI screen Rest API resources InterconnectsInterconnects , interconnect-types , Logical-interconnects Logical interconnects UI screen Rest API resource Logical Interconnect GroupsLogical-interconnect-groups Uplink sets UI screen Rest API resource Logical InterconnectsLogical-downlinks To a downlink Networks Network setsZero or one uplink set per logical interconnect Uplink-sets Domains ApplianceNetwork-sets Domains Resources related data center facilities Data centersRacks Relationship to other resources Power delivery devices Power-devicesUnmanaged devices Zero or more unmanaged devices UI screen Rest API resource Unmanaged Devices Unmanaged-devicesYou can view, add, or edit the properties Rest APIsPage Understanding the security features of the appliance Securing the applianceSecuring the appliance Understanding the security features of the appliance Best practices for maintaining a secure appliance Creating a login session Authentication for appliance accessCreating a login session Controlling access for authorized users Protecting credentialsUnderstanding the audit log Specifying user accounts and roles Resource category MessageUnderstanding the audit log Appliance access over SSL Example 1 Sample audit entries user login and logoutManaging certificates from a browser Overview Using a certificate authority Verifying a certificateDownloading and importing a self-signed certificate Managing certificates from a browser Passwords Browser best practices for a secure environmentNonbrowser clients SSL connection Access to the appliance console Switching from one console to anotherPorts needed for HP OneView Required ports Enabling or disabling authorized services access Restricting console accessAlgorithms for securing the appliance SSL see Downloads from the appliance Downloads from the appliancePage Required plug-ins and settings Commonly used browser features and settingsNavigating the graphical user interface Browsers About the graphical user interface Set the browser for US or metric units of measurementSet US or metric units of measurement Screen topography About the graphical user interface About the Activity sidebar Banner and main menuButton functions Filters sidebar Help sidebarUI buttons Icon descriptions Oneviewcommunity online Status and severity icons User control iconsLarge icon Small icon Resource Activity Task Critical Display details Map view screen details Informational icons Notifications area Notifications area Log out of the appliance Search help topics Search resources About help system search results Error Unknown Disabled View resources according to their health statusAdvanced searching and filtering with properties Nameenclosure10 name192.0.2.0, PDU Reset the health status view View resources according to their health statusPage Using the Rest APIs and other programmatic interfaces Resource operationsOperation Http Verb Create Resource data Log in to the appliance using Rest APIs Return codesURI format Resource model format Error handling Concurrency control using etagsAsynchronous versus synchronous operations Task resource Querying resources using common Rest API parameters State Change Message BusDeveloper tools in a web browser Accessing documentation and help Online help-conceptual and task information as you need itThis user guide supplements the online help Rest API help design Where to find HP OneView documentation Accessing documentation and helpHP OneView documentation Downloading Html help and Rest API files Part II Planning tasks Page Planning your data center resources How many data centers?Security planning Determining your backup policy Choosing a security certificate policyDetermining roles and restrictions for authorized users Choosing a policy for the audit log Preparing your data center network switches Reviewing your firewall accessPlanning your resource names Planning the appliance configuration Appliance VM and host requirementsResource name Planning for high availability Location of the applianceSeparate networks for data and management Time clocks and NTPPage Planning for configuration changes ApplianceEnclosures Interconnects and logical interconnects Planning for configuration changes Server profiles and server hardwareAdding a network Adding an enclosure Page Part III Configuration quick starts Page Quick Start Initial Configuration Configure the environment for the first timeProcess overview Process overview Local authentication Directory-based authenticationEthernet Fibre Channel Configuration step Required action or input Configuration step Add power devices to the appliance Page Process Resource Task Description Networks Add the network Resource Task Server Profiles HardwarePage Checklist connecting a server blade to a data center network Page Process Resource Task Enclosures Resource Task Logical Create a logical Interconnect Groups EnclosureServer Profiles Do one Following Hardware Create a server It to the server Enter a name for 104 105 Resource Task Description Networks Add the Fibre Sets for the DirectAttach network Resource Task Server Hardware Add the server using Rest APIs for107 108 Part IV Configuration and management 110 Server hardware features supported by the appliance Managing servers and server profilesUI screens and Rest API resources Server-profiles and connections Prerequisites for bringing server hardware under management RolesTasks for server profiles Tasks for server hardware Tasks for server hardware typesEffects of managing server hardware iLOs Tasks for server hardware Learning more Data center switch port requirements Managing networks and network resourcesManaging Fibre Channel networks SANs Interconnects Managing Ethernet networks About network connectivityRoles Tasks About Fibre Channel networks Fibre Channel network typesAbout network connectivity Fabric attach Fibre Channel networks Direct attach Fibre Channel networks About Ethernet networks About network setsFibre Channel networks and FCoE Ethernet networks and network sets Network set details Managing enclosure interconnect hardware About interconnectsManaging enclosure interconnect hardware Interconnects Networking features Learning moreConnectivity and synchronization with the appliance About unsupported interconnects About logical interconnects Uplink sets Server Blade Logical Interconnect Stacking modes Stacking healthAdding a logical interconnect About logical interconnect groups Deleting a logical interconnect About Snmp settings Logical Interconnect Group a Items Compliance checking Ethernet interconnect settings Configuration defined by the logical interconnect group?Set? Interconnect maps Configure a port to monitor network traffic 130 Managing enclosures and enclosure groups Prerequisites for bringing an enclosure under management Tasks About enclosuresConnectivity and synchronization with the appliance Managing enclosures and enclosure groups About enclosure groups Effects of managing an enclosureAbout enclosure groups 134 Managing firmware for managed devices About the appliance firmware repositoryAbout unsupported firmware Unsupported firmware for firmware bundles Firmware update process Roles and TasksUnsupported firmware for enclosures Unsupported firmware for server profiles Best practices for firmware OptionBest practice First step Upload the latest current SPP Troubleshooting firmware bundles Best practice Managing power and temperature Managing powerAbout power delivery devices Managing power and temperature About racks Managing temperature Default data center DatacenterDefault rack placement Managing temperature About utilization graphs Managing users and authentication Reset the administrator passwordAbout user accounts About user roles Action privileges for user rolesAppliance role types Action privileges for user roles Administrator Backups Global settingsLogin sessions Restores About authentication settings About directory service authentication Managing user passwords Managing user passwords Reset the administrator password Resetting the administrator password Overview of the backup process Backup file nameBackups Backing up an appliance Guidelines for creating a backup file Create and download a backup fileBacking up an appliance Creating and downloading a backup file Post /rest/backupsDownload the backup file GET /rest/backups/archive/backup URI 152 Managing the appliance Managing appliance availabilityBest practices for managing a VM appliance How the appliance handles an unexpected shutdown Appliance recovery operations What to do when an appliance restartsShut down the appliance Restart the appliance Managing the appliance settings About appliance Snmp settingsRestarting the appliance Managing the security features of the appliance Enabling or disabling HP support access to the applianceManaging addresses and ID pools Id-pools Managing SSL certificates Managing the HP public keyRoles Tasks Managing licenses Downloading audit logsAudit-logs Licenses About licensing License typesLicense delivery License reporting Server hardware licensing View license statusLicense graph colors Licensed features Server blade licensing at the enclosure levelEnclosure licensing policy behavior Rack mount server licensing Licensing and utilization statisticsLicensing scenarios Rack mount server licensing behavior Updating the appliance Licensing scenarios Appliance/firmware About unsupported and unmanaged hardware How the appliance handles unsupported hardwareAbout unmanaged devices How the appliance handles unsupported hardware 166 Part V Monitoring 168 Monitoring data center status, health, and performance Daily monitoringInitial check the Dashboard Activities Monitor data center temperature Best practices for monitoring data centersBest practices for monitoring health with the appliance UI General health monitoring steps Best practices for monitoring health using Rest APIs Server hardware health monitoringNetwork health monitoring Overall health monitoring Get a specific alert using the alert ID GET /rest/alertsGET /rest/alerts/id Get the associated events Managing activities About activitiesGET /rest/logical-interconnects/id Managing activities Activity types alerts and tasks About alertsAbout tasks Task type Description User Activity states Activity statuses Using the Dashboard screen How to interpret the Dashboard graphsAbout the Dashboard Dashboard screen details Disabled or Unknown Status icons Monitoring data center status, health, and performance Monitoring power and temperature Power and temperature monitoring feature overviewPower and temperature monitoring features by resource UI power and temperature monitoring Monitoring power and temperature Manipulating the view of the data center visualization Monitoring power and temperature utilization About the Utilization panelAbout utilization graphs Enclosures Power Delivery Devices Server Hardware Utilization statistics gathered by resourceUtilization graphs Utilization metric Resource Power utilization metrics Rest API power and temperature monitoring Update enclosure power capacity settingsUpdate server hardware power capacity settings Prerequisites Using the State-Change Message Bus Scmb GET /rest/certificates/client/rabbitmq/keypair/defaultConnect to the Scmb Create and download the Amqp client certificate Set up a queue to connect to the HP OneView Scmb exchange Using the State-Change Message Bus Scmb Json structure of message received from the Scmb Sample queues NET C# code example ChangeType valuesExample 2 Json example Additional example-specific prerequisites NET C# code example Examples Java code example Java code example Python code example Example 5 Java code example Example 6 Python code example pika Python code example Example 7 Python code example amqplib Re-create the Amqp client certificate Delete /rest/certificates/ca/rabbitmqreadonlyRe-create the Amqp client certificate 196 Part VI Troubleshooting 198 Troubleshooting Category199 Basic troubleshooting techniques About network setup errorsAbout reported serious errors Recommendation Details Look for a message When VM host is down or nonresponsive Create a support dump fileCreating a support dump file Recommendation Details Creating a support dump using Rest APIs Create support dump Post /rest/appliance/support-dumpsDownload the support dump file GET /rest/appliance/support-dumps/file name Troubleshooting the appliance First time setupAppliance cannot access the network Unexpected appliance shutdown Appliance update is unsuccessful Support dump file creation action failsCertificate action fails Insufficient time Backup file creation, download, or restore action fails Backup file creation is still in progressBackup file is incompatible Appliance network is down Profile operation was running during the backup Restore operation fails or times outInternal server error Restart or shutdown failure VM does not restart when VM host time is manually set Reinstall the remote consoleReinstall the software Troubleshooting enclosures and enclosures groups Add or remove enclosure is unsuccessfulClear vcmode Restart interconnect Restart interconnect N Troubleshooting firmware bundles Certificate ErrorAdd server blade is unsuccessful Incorrect credentials Troubleshooting interconnects Troubleshooting licensing Troubleshooting logical interconnects 27.9.1 I/O bay occupancy errorsUplink set warnings or errors License assigned does not match the type specified Troubleshooting networks Troubleshooting server hardwarePhysical interconnect warnings and errors Network create operation is unsuccessful Cannot control power on server blade Is claimed by that software Troubleshooting server profiles Server profile is not created or updated correctlyTroubleshooting server profiles Prerequisites and conditions have not been met What to do when you cannot apply the server profile Server hardware or its iLO are powered-off or resetInvalid configuration Verify the operational status of the server hardware Troubleshooting user accounts Unauthenticated user or groupProfile operations fail Incorrect privileges Directory service not available Cannot add directory serviceUser public key is not accepted Inaccurate credentials Cannot add server for a directory service Lost connection with directory service hostUser or group not configured in the directory service Cannot add directory user or group Restoring an appliance from a backup file Restore operation overviewRestores See also Post-restoration tasks Preparing to restore an appliance Restoring an appliance from a backup file Restore an appliance from a backup file Restore an appliance from a backup file Using Rest APIs to restore an appliance from a backup file Creating a custom script to restore an applianceRestoring an appliance from a backup file Post-restoration tasks Preventing duplicate IDs on the network after a restore Post-restoration tasks 226 How to contact HP Software technical support and software updatesSupport and other resources Get connected to the HP OneView online user forum Using your software technical support and update service Related informationDocumentation Product websites Support and other resources Submit documentation feedback For UI and Rest API helpFor user guides and other manuals Docsfeedback@hp.com 230 Tasks you can perform without data center hardware Information about the sample data centerSample data center hardware Tasks you can perform without data center hardware ILOAdmin OAAdminRack mount server Enclosure Data center networks Fibre Channel networksFibre Channel networks for the SAN fabrics SAN a and SAN B Fibre Channel network configurations Switches in the data centerStorage system Ethernet Networks Networks for vMotion and virtual machine managementProduction networks Planning the configuration Planning for installation of the applianceEthernet network configuration values Development networks Planning the configuration Planning for network setsPlanning for users and roles Installing the appliance Planning resource namesAssumptions Workflow Configuring the networks and network sets Configuring the Fibre Channel SAN networksCopying the template server profile to eight servers Configuring the Ethernet networks Use the following names and Vlan IDs for the test networks Prod 1101 1102 1103 1104 Configuring the network sets Page Creating a logical interconnect group and its uplink sets Creating the logical interconnect group Creating the uplink sets for the Fibre Channel networks Creating the uplink sets for the Ethernet networks ProdUS DevUSTestUS Creating an enclosure group for vSphere ESXi hosts Click Create to create the logical interconnect group Enclosures Password Adding the enclosureViewing the server hardware types 172.18.1.12 Address Creating a server profile to use as a template Viewing server hardware typesEditing server hardware types View information about the server hardwarePage Attribute Value Device type Ethernet Network Esxi mgmtSecondary Esxi vmotion Boot Not bootable Attribute Value Device type Fibre Channel NetworkRequested bandwidth Page Copying the template server profile to eight servers Name Server hardwareEsx02 Encl1, bay Esx03 Esx04 Esx05 Esx06 Esx07 Esx08 Creating the Flat SAN networks 172.18.1.14 Address Page Page Creating the server profile Enclosure nameEncl2 Enclosure group name Requested bandwidth Default value FlexNIC Device type Fibre Channel NetworkFlatSAN a FlatSAN B Page Assumptions Powering on the server Adding the server hardwareViewing information about the server 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 Backup and restore script examples Sample backup scriptSample backup script Sample script Example 8 Sample backup.ps1 script Backup and restore script examples 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 Host, security access, 80 initial configuration Index293 Eula Index Scmb see State-Change Message Bus 295 Logical interconnect, 125 State-Change Message Bus Status icon, 62 storage system website Vlan ID 297