HP OneView 1.0 REST API Reference Abstract This document provides the detailed information about each REST API, including the attributes of each resource. The reference also includes the parameters, request headers, response headers, and response codes that apply to all REST APIs.
© Copyright 2013 Hewlett-Packard Development Company, L.P. The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein. Acknowledgments Java® is a registered trademark of Oracle and/or its affiliates.
HP OneView REST API Reference OneView REST API Reference ACTIVITY SERVERS alerts tasks audit-logs events server-profiles connections id-pools id-pools-vmac-ranges id-pools-vsn-ranges id-pools-vwwn-ranges enclosure-groups enclosures server-hardware server-hardware-types NETWORKING FACILITIES logical-interconnect-groups logical-interconnects logical-downlinks uplink-sets ethernet-networks fc-networks network-sets connection-templates interconnects interconnect-types datacenters racks power-devices unm
HP OneView REST API Reference restores version SEARCH SECURITY resources associations trees search-suggestions users roles authz certificates login-sessions active-user-sessions logindomains logindomains/global-settings logindomains/grouptorolemapping sessions COMMON Association names Parameters Request Headers Response Headers Response Codes index.
alerts HP OneView REST API Reference Updated: October 16, 2013 3:55 MDT alerts The alert resource is used to inform end users about issues with resources managed by the appliance, including the appliance itself. An alert represents an event for a given resource that typically originates from the resource. An example event would be: an SNMP trap received from a server's Integrated Lights-Out (iLO) management processor.
alerts filter Experimental A general filter string to narrow the list of resources to be deleted by a multi-resource DELETE (delete) request. The default is no filter (all resources are deleted). The filter parameter is based on the URI Filter Language. NOTE: Do NOT use the filter usage defined under standard parameters documentation. The format and usage of this filter parameter is similar to that of the query parameter documented under standard parameters.
alerts https://{appl}/rest/alerts?filter="alertState EQ 'Active'" The above example deletes all the alerts whose alertState equals Active. GET Retrieves alerts based on the specified filters. Returns the Etag value of the resource in the response body for each of the alerts returned. Parameter Attributes Description start Optional The 0-based index of the first resource to return (start=0 starts with the first available resource).
alerts NOTE: Do NOT use the filter usage defined under standard parameters documentation. The format and usage of this filter parameter is similar to that of the query parameter documented under standard parameters. Format: filter="{attribute} {operator} '{value}'" filter="{attribute} {operator} '{value}'"{multi-filter operator}filter="{attribute} {operator} '{value}'" • {attribute}: the resource attribute being filtered (e.g., model, platform, etc.
alerts Examples GET https://{appl}/rest/alerts?start=0&count=-1&filter= "alertState EQ 'Active'" The above example retrieves all the alerts whose alertState equals Active. GET https://{appl}/rest/alerts?view=alertSummary If you specify the view parameter, the total alert counts for all alert severities are returned in addition to the alerts themselves. GET https://{appl}/rest/alerts?start=-1&count=25&filter= "alertTypeID EQ 'Trap.
alerts Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description JsonSchema The JSON schema of the alert object. Response Codes REST API Response Codes Examples GET https://{appl}/rest/alerts/schema URI: /rest/alerts/{id} Method API DELETE Deletes a single alert resource identified by its ID.
alerts Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description AlertResourceV2 The alert that is represented by the ID. Response Codes REST API Response Codes Examples GET https://{appl}/rest/alerts/{id} The above example retrieves the alert which matches the unique identifier specified. PUT Modifies the attributes of a single alert.
alerts { "alertState": "Cleared", "assignedToUser": "Paul", "alertUrgency":"None", "notes":"Problem fixed", "eTag":"2013-06-27T17:48:50.526Z" } The above example, updates the attributes with the values specified in the sample request body, for the alert, which matches the unique identifier specified. AlertResourceV2 description: AlertResourceV2 object represents the attributes of an alert.
alerts normal/informational behavior. Disabled - not a valid severity for an Alert and will be obsoleted. Warning - needs attention soon. Critical - needs immediate attention. enum: resourceID: alertTypeID: healthCategory: physicalResourceType: type: lifeCycle: alerts.
alerts created as a result of some activity on a resource such as powering on or off a server or inserting a blade server in an enclosure. If the severity of a life cycle alert is not set to OK, the system will automatically set the severity of a life cycle alert to OK. description: changeLog: type: boolean description: The description provides a quick summary of the issue for which the alert is created.
alerts eTag: associatedResource: minLength: 0 maxLength: 2048 description: Entity tag/version ID of the resource, the same value that is returned in the ETag header on a GET of the resource type: string description: Details about the resource for which the alert is created. The resource can be an enclosure, server or any other managed resource. For example, if the alert is created for an enclosure, the associatedResource has the details about that enclosure.
alerts Cleared Locked created: activityUri: clearedTime: uri: associatedEventUris: urgency: description: The time that the alert resource was created and stored; the format is an extended ISO 8601 String expressed as UTC format: YYYY-MM-DDThh:mm:ss.sssZ pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
alerts AlertResourceCollectionV2 description: AlertResourceCollectionV2 is a collection of alert objects of the type AlertResourceV2. type: object Properties alertSeverityCounts: type: object Properties disabledCount: okCount: criticalCount: warningCount: unknownCount: count: total: nextPageUri: prevPageUri: uri: created: alerts.html[10/17/2013 10:35:10 AM] description: The disabledCount is not valid for an alert and will be obsoleted.
alerts start: eTag: members: type: string format: YYYY-MM-DDThh:mm:ss.
alerts OK Disabled Warning Critical resourceID: alertTypeID: healthCategory: physicalResourceType: alerts.html[10/17/2013 10:35:10 AM] type: string required: true description: A unique identifier, specific path or attribute identifying a component within the resource for which the alert is created. For example, in a server with a Mezzanine card, physical port, physical function the resourceID may be represented as adapter/1/ports/2/function/4a.
alerts activityUri: lifeCycle: description: changeLog: minLength: 0 description: (Optional) URI of the task resource of the activity that created the alert, if the alert was caused by an operation in the appliance. Used in tracking root causes. maxLength: 128 type: string minLength: 0 description: Life cycle alerts do not determine status of a resource.
alerts notes: created: correctiveAction: eTag: associatedResource: description: User-added notes regarding the alert resource. type: string minLength: 0 maxLength: 1024 description: Creation time of the log entry, when the alert resource changed. Formatted as an ISO 8601 formatted string. format: YYYY-MMDD'T'hh:mm:ss.sss'Z' pattern: [1-2][0-9][0-9][0-9]-([01][0-9])-[0-3][0-9]T[0-2] [0-9]:[0-5][0-9]:[0-5][09](.
alerts associationType: type: string description: Type of association enum: resourceCategory: resourceName: clearedByUser: alertState: alerts.html[10/17/2013 10:35:10 AM] type: string description: Category of the resource type: string description: Name of the resource type: string description: The name of the user who last set the alert state to cleared. Alerts can be Cleared by the user or by the system.
alerts 2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])? Z type: clearedTime: modified: associatedEventUris: urgency: readonly: true type: string description: Identifies the resource type. This field must be set to 'AlertResourceV2'. type: string description: The time when the alert is cleared pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[02][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])? Z type: string format: YYYY-MM-DD'T'hh:mm:ss.
alerts modified: category: type: alerts.html[10/17/2013 10:35:10 AM] description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9] [0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: Resource category used for authorizations and resource type groupings type: string description: Identifies the resource type. This field must be set to 'AlertResourceCollectionV2'.
tasks HP OneView REST API Reference Updated: October 16, 2013 4:26 MDT tasks Task Tracker is used to record and update a task running in the system. It is not a task engine. It provides REST APIs version #2 to allow monitoring of tasks.
tasks { "resourceCategory": "my-rm-category" } } 2) POST https://{appl}/rest/tasks { "type":"TaskResourceV2", "name":"mytask1", "owner":"Administrator", "data":null, "percentComplete":0, "userInitiated":false, "taskStatus":"myresults", "taskState":"Interrupted", "associatedTaskUri":"associatedTaskUri", "parentTaskUri":"/rest/tasks/myparenttask", "progressUpdates":[ ], "totalSteps":0, "completedSteps":0, "taskOutput":[ ], "expectedDuration":0, "computedPercentComplete":0, "eTag":null, "taskType":"Appliance"
tasks Experimental query This parameter is experimental for this release: While generally functional when used in simple cases, restrictions might be noted in the implementation description. If the query is supported, the following is the way it works. A general query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request. The default is no query (all resources are returned).
tasks URI: /rest/tasks/schema Method API GET Gets the JSON schema of the TaskResourceV2 Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
tasks This example returns the task V2 with task ID: 1234-1234-1234 GET https://{appl}/rest/tasks/1234-1234-1234 PUT Updates the task V2 corresponding to a given task ID Parameter Attributes Description force Optional If set to true, the operation completes even if there are network connectivity issues or resource errors. The default is false. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
tasks TaskTreeV2 Represents the tree for task V2 with the specified ID Response Codes REST API Response Codes Examples This example returns the tree for task ID: 1234-1234-1234 GET https://{appl}/rest/tasks/1234-1234-1234?view=tree TaskResourceV2 type: object Properties taskOutput: completedSteps: modified: taskErrors: description: Output resulting from the running of the task type: array description: Number of steps currently completed by the task type: integer description: Date and time
tasks details: message: data: associatedTaskUri: percentComplete: taskType: userInitiated: category: taskStatus: parentTaskUri: stateReason: type: tasks.
tasks type: progressUpdates: string description: List of timestamped objects describing the progress of the task. type: array Items timestamp: statusUpdate: eTag: associatedResource: Date and time when the progress update was logged format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5] [0-9]:[0-5][0-9](.
tasks taskState: format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
tasks modified: start: eTag: nextPageUri: members: description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])? Z type: string format: YYYY-MM-DDThh:mm:ss.
tasks errorCode: details: message: data: associatedTaskUri: percentComplete: taskType: userInitiated: category: tasks.
tasks taskStatus: parentTaskUri: stateReason: type: progressUpdates: type: string description: Short summary of the current execution/completion status type: string description: URI of the parent task. NULL if no parent exists type: string description: Contains the reason for changing to current state of the task type: string description: Identifies the resource type. This field must be set to 'TaskResourceV2'.
tasks associationType: description: Type of Association. type: string enum: resourceCategory: resourceUri: totalSteps: name: created: taskState: total: description: Category of the Resource. type: string description: URI of the Resource.
tasks type: description: Identifies the resource type. This field must be set to 'TaskResourcePaginatedCollectionV2'.
tasks information message: data: associatedTaskUri: percentComplete: taskType: userInitiated: category: taskStatus: parentTaskUri: stateReason: tasks.html[10/17/2013 10:35:11 AM] string description: Description of the error condition type: string description: Contains extra data defined for the particular error type: object description: If the current task is associated with another task, this represents the URI of another task.
tasks type: progressUpdates: description: Identifies the resource type. This field must be set to 'TaskResourceV2'. type: string description: List of timestamped objects describing the progress of the task. type: array Items timestamp: statusUpdate: eTag: associatedResource: Date and time when the progress update was logged pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][09]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9] [0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
tasks name: created: taskState: type: integer description: Display name for the task type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]: [0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
tasks enum: taskErrors: Unknown New Running Suspended Terminated Killed Completed Error Warning Interrupted Starting Stopping Pending description: Error messages associated with the task type: array Items errorCode: message: details: recommendedActions: errorSource: nestedErrors: description: A string code which uniquely identifies the specific error allowing clients to switch on specific errors without having to parse the error message type: string description: Description of the error c
tasks Items id: type: timestamp: description: Date and time when the progress update was logged type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5] [0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z format: YYYY-MM-DDThh:mm:ss.
tasks enum: tasks.
audit-logs HP OneView REST API Reference Updated: October 16, 2013 4:16 MDT audit-logs The audit-logs service filters and downloads audit-logs that are present in the appliance.
audit-logs Response Description AuditLogCollection Contains AuditLogRecordDetail objects and pagination information Response Codes REST API Response Codes Examples Below examples are to fetch the audit-logs as per specified parameters GET https://{appl}/rest/audit-logs? start=0&count=150&filter="result='success'" GET https://{appl}/rest/audit-logs? start=0&count=150&filter="date>='2012-05-30'" POST Creates a log entry in the audit log file.
audit-logs current release, this must be set to "X-API-Version:3" Request Body Attributes Description AuditLogRecordDetail Required Contains all the information related to auditing Response Description void Response Codes REST API Response Codes Examples Below example is to create multiple audit-logs at once with parameters specified POST https://{appl}/rest/audit-logs?multiResource=true [ { "componentId":"MyComponent", "domain":"domain", "organizationId":"", "taskId":"", "sourceIp":"", "action":"L
audit-logs REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
audit-logs objectType: objectTypeDescriptor: severity: taskId: msg: type: string description: Type of the object on which an action is being performed type: string description: Description of the object type type: string description: Severity of the action performed, such as INFO, WARNING or CRITICAL type: string description: Task ID if this audit log record is associated with a task type: string description: Audit log detailed message set while making audit log entry type: string
audit-logs start: eTag: nextPageUri: members: format: YYYY-MM-DDThh:mm:ss.
audit-logs RESTORE, SAVE, SETUP, UNSETUP, DEPLOY, START, DONE, KILLED, CANCELED, LOGIN or LOGOUT sourceIp: componentId: objectTypeDescriptor: objectType: total: type: type: string description: Client source IP from which the action originated. The default setting is null/empty.
events HP OneView REST API Reference Updated: October 16, 2013 4:08 MDT events The event resource manager provides REST APIs to create an event resource, or to retrieve or delete one or more event resources (optionally using filters). An event resource describes a single, low-level problem or life cycle change in a resource.
events filter Experimental A general filter string to narrow the list of resources to be returned by a multi-resource GET (get) request. The default is no filter (all resources are returned). The filter parameter is based on the URI filter Language. NOTE: Do NOT use the filter usage defined under standard parameters documentation. The format and usage of this filter parameter is similar to that of the query parameter documented under standard parameters.
events Response Codes REST API Response Codes Examples GET https://{appl}/rest/events example: GET https://{appl}/rest/events?start=-1&count=25&filter= "eventTypeID EQ 'Trap.cpqHe4FltTolPowerSupplyFailed'" &filter="healthCategory EQ 'POWER'" The above example retrieves the first filtered 25 events of type power supply failure and the health category of POWER. The above example uses eventTypeID to filter on an SNMP Trap, where the eventTypeID is of the format Trap.
events POST https://{appl}/rest/events" with a request body of { "type":"EventResourceV2", "description":"This is a very simple test event", "severity":"OK", "healthCategory":"PROCESSOR", "eventTypeID":"hp.justATest", "rxTime":"2012-05-14T20:23:56.688Z", "urgency":"None", "eventDetails": [{"eventItemName":"ipv4Address", "eventItemValue":"127.0.0.1", "isThisVarbindData":false, "varBindOrderIndex":-1}] } The above example posts a simple event for a resource whose IPv4 address is 127.0.0.1.
events view=viewDescription is specified, then the description details for all the event items is returned. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description EventResourceV2 An object in JSON format of the events schema.
events created: description: modified: uri: eTag: eventTypeID: type: string required: true description: The time that the Event resource was created and stored. The format is an extended ISO 8601 string expressed as UTC format: YYYY-MM-DDThh:mm:ss.sssZ type: string readonly: true pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][09])?Z description: The description of the problem this event relates to.
events processed: eventDetails: type: string maxLength: 255 description: A flag that indicates if the alert service has processed the event or not. After processing the event, the alert service sets the flag by creating a corresponding alert. This allows the event service to determine whether it needs to resend the event. readonly: true type: boolean description: Contains name, value pairs describing the specific event such as, Trap/WBEM information.
events varBindOrderIndex: eventItemValue: isThisVarbindData: healthCategory: type: urgency: string description: This data holds the SNMP trap varbind order index if this event item represents a SNMP trap varbind data. type: integer description: The actual value for this item required: true type: string description: This flag is used to indicate whether this event data represents SNMP trap varbind data.
events 9])?Z EventResourceCollectionV2 description: EventResourceCollectionV2 is a collection of event objects of the type EventResourceV2 objects.
events Items category: description: created: uri: modified: eTag: eventTypeID: events.html[10/17/2013 10:35:13 AM] description: The category used to help identify this resource. It will always be set to events. type: string readonly: true description: The description of the problem this event relates to. Include enough details to make the problem completely clear to anyone.
events and there could be multiple periods in the eventTypeID to further differentiate the ID. For example, an event type of Trap.cpqHo2NicStatusFailed indicates a trap where the NIC was in a failed condition. processed: eventDetails: events.html[10/17/2013 10:35:13 AM] minLength: 1 required: true type: string maxLength: 255 description: A flag that indicates if the alert service has processed the event or not.
events represented as adapter/1/ports/2/function/4a.) Items eventItemName: eventItemDescription: isThisVarbindData: eventItemValue: varBindOrderIndex: eventItemSnmpOid: healthCategory: events.html[10/17/2013 10:35:13 AM] description: The name used to identify this piece of data. Possible values, such as ipv4Address or resourceUri, are found in the EventResource class. required: true type: string description: The description of this event item details.
events rxTime: type: urgency: type: string minLength: 0 maxLength: 255 description: The source timestamp of an externally generated event such as an SNMP trap or WBEM indication was received. The format is an extended ISO 8601 String expressed as UTC pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[05][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: Identifies the resource type. This field must be set to 'EventResourceV2'.
server-profiles HP OneView REST API Reference Updated: October 16, 2013 4:51 MDT server-profiles The server profile resource manager provides REST APIs to create, retrieve, modify, and delete server profiles. These APIs require a valid authentication token to be provided in the request header which can be obtained from the Authentication Resource Manager. Users can also provide language data in the header, but any errors or status messages will default to English if this value is not provided.
server-profiles when used in simple cases, restrictions might be noted in the implementation description. If the query is supported, the following is the way it works. A general query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request. The default is no query (all resources are returned). One advantage query has over filter is that it can have embedded ORs.
server-profiles Note: The filter function allows for both actual and partial matches of data in the profile. Any requests that wish to use a wild card match must include a %25 as illustrated in the example. This is how that character is encoded for transmission to the appliance. DELETE Deletes all Server Profile objects from the appliance that match the provided filter. If a filter string is not provided, then the API will delete all Server Profile objects from the appliance.
server-profiles to the appliance. Notes: 1. This method will return 202 ACCEPTED even if there is no match for the filter. 2. A successful return of this API only indicates that a delete profiles was successfully requested. Monitor the returned TaskResourceV2 URI to determine the outcome delete profiles operation. POST Creates a server profile using the information provided in the request body. Connection requests can be one of the following types - port auto, auto and explicit.
server-profiles "wwnType":"Virtual", "connections":[ { "id":1, "functionType":"Ethernet", "portId":"FlexibleLOM:1-a", "requestedMbps":2500, "networkUri": "/rest/ethernet-networks/{networkUUID}", "boot":{ "priority":"Primary" } }, { "id":2, "functionType":"Ethernet", "portId":"Auto", "requestedMbps":2500, "networkUri": "/rest/network-sets/{networkSetUUID}", "boot":{ "priority":"Secondary" } }, { "id":3, "functionType":"FibreChannel", "portId":"Auto", "requestedMbps":2500, "networkUri": "/rest/fc-networks/03
server-profiles {"type":"ServerProfileV1", "name": "Profile101", "serverHardwareUri":"/rest/server-hardware/{serverUUID}" "macType": "Virtual", "serialNumberType": "Virtual", "wwnType":"Virtual", "connections":[ { "id":1, "functionType":"Ethernet", "portId":"FlexibleLOM:1-a", "requestedMbps":2500, "networkUri": "/rest/ethernet-networks/{networkUUID}", "boot":{ "priority":"Primary" } }, { "id":2, "functionType":"Ethernet", "portId":"Auto", "requestedMbps":2500, "networkUri": "/rest/network-sets/{networkSetU
server-profiles "priority":"Secondary" "targets":[{"arrayWwpn":"arrayWwpn","lun":"lun"}] } } ], "boot":{"manageBoot":true,"order":["PXE", "HardDisk","CD", "Floppy", "USB"]}, "bios":{ "manageBios":true, "overriddenSettings":[ { "id":"91", "value":"1" }, { "id":"158", "value":"2" } ] }, "firmware":{ "manageFirmware":true, "firmwareBaselineUri": "/rest/firmware-drivers/{fwBaselineId}" } The list of supported firmware bundles can be retrieved performing a GET REST request to the rest/firmware-drivers API The l
server-profiles networks, network sets and fc networks along with the ports that the networks are available on.
server-profiles AvailableServer list of Server objects which is a list of servers,available for profile assignment. Response Codes REST API Response Codes Examples Obtain all available servers.
server-profiles Response Codes REST API Response Codes Examples GET https://{appl}/rest/server-profiles/messages/schema URI: /rest/server-profiles/profile-ports Method API GET This API retrieves portmodel associated with a server or server hardware type and enclosure group Parameter Attributes Description serverHardwareUri Optional The UUID of the Server Hardware object It is required when serverHardwareTypeUri and enclosureGroupUri are not specified serverHardwareTypeUri Optional The UUID of
server-profiles Response Codes REST API Response Codes Examples GET https://{appl}/rest/server-profiles/profile-ports/ schema URI: /rest/server-profiles/schema Method API GET Generate the ServerProfile JSON formatted schema Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
server-profiles GET This API retrieves a server profile managed by the appliance based on its Profile Manager UUID. This API will always return an eTag value in the header, and this value can be used in subsequent invocations of this API to determine if the requested profile object has changed on the appliance. The eTag is included as "If-NoneMatch" element in the request header, and the API will respond with a NOT_MODIFIED (HTTP Status Code 304) if the object has not changed.
server-profiles simple as a name or description change or much more complex changes around the assigned server and networking configuration. It should be noted that selection of a virtual or physical MAC or Serial Number is not mutable once a profile has been created, and attempts to change those elements will not be applied to the target profile. Connection requests can be one of the following types - port Auto, auto and explicit.
server-profiles "boot":{ "priority":"Secondary" } }, { "id":3, "functionType":"FibreChannel", "portId":"Auto", "requestedMbps":2500, "networkUri": "/rest/fc-networks/{fcNetworkID}", "boot":{ "priority":"Primary" "targets":[{"arrayWwpn":"arrayWwpn","lun":"lun"}] } }, { "id":4, "functionType":"Ethernet", "portId":"Auto", "requestedMbps":2500, "macType":"UserDefined", "mac":"12:11:11:11:00:00:00" "networkUri": "/rest/network-sets/{networkSetUUID}", "boot":{ "priority":"NotBootable" } }, { "id":5, "functionTyp
server-profiles } portId parameter is set to "Auto" by default. By specifying just the adapter and port on the portId parameter the user could request a physical port specific automatic FlexNIC assignment. By specifying the portId as "Auto" the user could request an automatic assignment that could be result in a FlexNIC assignment from any physical port. By specifying all three values as part of the portId, the user could request an explicit connection.
server-profiles readonly: readonly: description: Id of the Port. The port can be a physical port, e.g. FlexibleLOM:1, or a specific FlexNIC, e.g. FlexibleLOM:1-a type: string readonly: true true true AvailableServer type: object Properties name: serverHardwareUri: serverHardwareTypeUri: enclosureGroupUri: powerState: description: Unique display name of this Server type: string description: Identifies the server hardware.
server-profiles limitedToPorts: uri: vlan: connectionTemplateUri: networkSets: description: List of port names on which this network is available. type: array readonly: true description: URI of the Ethernet, EthernetSet, or FibreChannel resource type: string readonly: true format: URI description: VLAN identifier for the Ethernet or FibreChannel network. type: integer readonly: true description: Default Connection Template Uri.
server-profiles fcNetworks: description: List of the FC network resources. type: array Items name: type: limitedToPorts: uri: vlan: connectionTemplateUri: readonly: description: Display name of the network resource. type: string readonly: true description: Type of network resource. type: string readonly: true description: List of port names on which this network is available.
server-profiles type: array Items allocatedMbps: networkUri: deploymentStatus: portId: functionType: requestedMbps: boot: description: The transmit throughput (mbps) currently allocated to this connection. type: integer readonly: true description: Identifies the network or network set to be connected.
server-profiles PXE and FCoE connections are treated separately; an Ethernet connection and an FCoE connection can both be marked as Primary. The 'order' attribute controls ordering among the different device types. type: targets: string description: Defines the boot target that the server will attempt to boot. Only one boot target is currently supported. The boot target can only be specified if the bootPriority is specified, and only for Fibre Channel connections.
server-profiles FlexNIC and deployed to the FlexFabric switch. The value can be a virtual WWPN, user defined WWPN or physical WWPN read from the device. It cannot be modified after the connection is created. interconnectUri: maximumMbps: wwpnType: id: macType: serverHardwareUri: macType: server-profiles.html[10/17/2013 10:35:14 AM] type: string searchable: true description: the interconnectUri associated to the connection.
server-profiles category: serverHardwareTypeUri: uuid: firmware: description: Resource category used for authorizations and resource type groupings type: string description: Identifies the server hardware type for which the Server Profile was designed. The serverHardwareTypeUri is determined when the profile is created and cannot be modified. Must not be a DL rack mount type.
server-profiles overriddenSettings: description: The BIOS settings to be modified. All omitted BIOS settings are reset to their factory default values. type: array Items id: value: manageBios: state: enclosureUri: status: description: eTag: server-profiles.html[10/17/2013 10:35:14 AM] Identifies the BIOS setting to be configured. required: true type: string description: The value to be configured for the specified BIOS setting.
server-profiles taskUri: enclosureBay: name: uri: created: serialNumber: enclosureGroupUri: modified: server-profiles.html[10/17/2013 10:35:14 AM] type: string readonly: true description: URI of the task currently executing or most recently executed on this server profile. type: string readonly: true format: URI description: Identifies the enclosure device bay number that the Server Profile is currently assgined to, if applicable.
server-profiles inProgress: format: YYYY-MM-DDThh:mm:ss.sssZ pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
server-profiles Items wwnType: serialNumberType: connections: description: Specifies the type of WWN address to be programmed into the IO devices. The value can be 'Virtual' or 'Physical'. It cannot be modified after the profile is created. default: Virtual type: string description: Specifies the type of Serial Number and UUID to be programmed into the server ROM. The value can be 'Virtual', 'UserDefined', or 'Physical'.
server-profiles the connection will not be configured on the server hardware. When omitted, portId defaults to 'Auto'. Use /rest/serverprofiles/ports to retrieve the list of available ports. wwpnType: deploymentStatus: boot: type: string description: Specifies the type of WWN address to be porgrammed into the IO Devices. The value can be 'Virtual', 'Physical' or 'UserDefined'. It cannot be modified after the connection is created.
server-profiles lun: arrayWwpn: wwnn: mac: server-profiles.html[10/17/2013 10:35:14 AM] description: The LUN of the Boot Volume presented by the target device. This value can be either 1 to 3 decimal digits in the range 0 to 255, or 13 to 16 hex digits with no other characters required: true type: string description: The wwpn of the target device that provides access to the Boot Volume. This value must contain 16 HEX digits.
server-profiles modified after the connection is created. wwpn: interconnectUri: maximumMbps: functionType: id: macType: serverHardwareUri: server-profiles.html[10/17/2013 10:35:14 AM] type: string searchable: true description: The port WWN address that is currently programmed on the FlexNIC and deployed to the FlexFabric switch. The value can be a virtual WWPN, user defined WWPN or physical WWPN read from the device. It cannot be modified after the connection is created.
server-profiles modified: macType: category: serverHardwareTypeUri: uuid: firmware: format: URI description: The time that the Server Profile was most recently modified format: YYYY-MM-DDThh:mm:ss.sssZ pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](. [0-9][0-9][0-9])?Z readonly: true type: string description: Specifies the type of MAC address to be programmed into the IO devices. The value can be 'Virtual' or 'Physical'.
server-profiles Properties manageBoot: order: bios: description: Indicates whether the boot order is configured using the server profile. Values include 'true' and 'false'. type: boolean description: Determines the order in which boot will be attempted on the available devices. This is equivalent to the ProLiant IPL. Values include 'CD', 'Floppy', 'USB', 'HardDisk', and 'PXE'. It recommended that all values are included. minItems: 1 maxItems: 5 type: array description: Server BIOS settings.
server-profiles enclosureUri: status: description: eTag: taskUri: enclosureBay: name: created: server-profiles.html[10/17/2013 10:35:14 AM] description: Identifies the enclosure that the Server Profile is currently assgined to, if applicable. searchable: true format: URI type: string readonly: true description: Overall health status of the resource.
server-profiles [0-9][0-9][0-9])?Z serialNumber: enclosureGroupUri: uri: inProgress: total: type: readonly: true type: string description: A 10-byte value that is exposed to the Operating System as the server hardware's Serial Number. The value can be a virtual serial number, user defined serial number or physical serial number read from the server's ROM. It cannot be modified after the profile is created.
server-profiles connectionId: status: messages: description: Identifies the connection associated with these status messages. type: number readonly: true required: true description: Overall status of this connection. type: string readonly: true required: true description: Status messages for this connection. type: array Items status: messageId: errorSource: sourceName: activityUri: message: recommendedActions: server-profiles.
server-profiles createdTime: readonly: firmwareStatus: readonly: true description: The time the message was created. type: string readonly: true readonly: true required: true true description: Status messages for firmware of this server profile. This section is omitted if there are no firmware status messages. type: object readonly: true Properties status: messages: description: Overall status of the firmware.
server-profiles message: recommendedActions: createdTime: name: version: serverHardware: description: The description of the error condition. type: string readonly: true required: true description: Describes what can be done to rectify the problem. type: string readonly: true description: The time the message was created. type: string readonly: true readonly: true required: true description: Display name for the firmware bundle.
server-profiles messageId: errorSource: sourceName: activityUri: message: recommendedActions: createdTime: eTag: type: string readonly: true required: true description: Uniquely identifies the specific error allowing clients to switch on specific errors without having to parse the error message. type: string readonly: true required: true description: A reference to the resource or attribute that the error applies to.
server-profiles server-profiles.
connections HP OneView REST API Reference Updated: October 16, 2013 4:33 MDT connections The connections resource manages connections between a source (for example a server) and one or more networks. A 'network' may be an Ethernet network, a FibreChannel network, or a NetworkSet. Each connection is associated with a lifecycle state: Reserved, Deployed, Active, Failed, or Released. The REST API (POST, GET, UPDATE, DELETE) supports an 'accept-language' in the request header which defaults to 'en_US'.
connections While generally functional when used in simple cases, restrictions might be noted in the implementation description. If the query is supported, the following is the way it works. A general query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request. The default is no query (all resources are returned). One advantage query has over filter is that it can have embedded ORs.
connections GET Gets the connection schema. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
connections Properties uri: wwnAssignment: maximum: type: number typical: type: number description: The canonical URI of the resource type: string description: The World Wide Name (WWN) assignment type, which may be physical or virtual.
connections Physical UserDefined interconnectUri: type: status: interconnectPort: description: connectionInstanceId: connectionInstanceStatus: description: The interconnect URI to which the connection will be (or currently is) deployed type: string minLength: 1 maxLength: 255 description: Identifies the resource type. This field must be set to 'ConnectionInstance'. type: string description: Overall health status of the resource.
connections type: string ipaddress: type: string connectionInstanceType: description: The connection instance type default: Ethernet type: string enum: Ethernet Fcoe NetworkSet macaddress: type: name: description: Display name for the resource type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9] (.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
connections category: created: prevPageUri: uri: modified: start: eTag: nextPageUri: members: description: Resource category used for authorizations and resource type groupings type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])? Z type: string format: YYYY-MM-DDThh:mm:ss.
connections 9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z wwnAssignment: type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: The World Wide Name (WWN) assignment type, which may be physical or virtual.
connections interconnectUri: type: connectionBandwidth: type: string description: The interconnect URI to which the connection will be (or currently is) deployed maxLength: 255 type: string minLength: 1 description: Identifies the resource type. This field must be set to 'ConnectionInstance'.
connections value that is returned in the ETag header on a GET of the resource type: string ipaddress: type: string connectionInstanceType: description: The connection instance type default: Ethernet enum: Ethernet Fcoe NetworkSet type: macaddress: type: name: description: Display name for the resource type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][09]:[0-5][0-9]:[0-5][0-9](.
id-pools HP OneView REST API Reference Updated: October 16, 2013 4:41 MDT id-pools The id-pools resource provides REST APIs for managing ID pools. The types of pools available are Vmac, Vsn, Vwwn. You can request an id from any of the pools, use the ID and then return it. The returned IDs are reclaimed by the pool and are available for reuse. The pools are accessed by https://{appl}/rest/id-pools/{vmac,vsn,vwwn}. The REST API (GET, UPDATE) supports an 'accept-language' in the request header.
id-pools Parameter Attributes Description view Optional Return a specific subset of the attributes of the resource or collection by specifying the name of a predefined view. The default view is expand (show all attributes of the resource, and all elements of collections or resources). fields Optional Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
id-pools URI: /rest/id-pools/{id}/allocator Method API PUT Allocates one or more IDs from a pool. The allocator returned contains the list of allocated ids. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
id-pools The following example shows how to collect IDs to be returned back to a pool resource whose identifier is {id} PUT : https://{appl}/rest/id-pools/{id}/collector Request Body: { "idList": [ "E2:89:E8:B0:00:00", "E2:89:E8:B0:00:01", "E2:89:E8:B0:00:02", "E2:89:E8:B0:00:03", "E2:89:E8:B0:00:04" ] } URI: /rest/id-pools/{id}/generate Method API GET Generates a random range and returns it. Used to generate a range for validation prior to actually creating it.
id-pools Response Description Allocator The DTO containing the validated list of IDs. Response Codes REST API Response Codes Examples The following example shows how to validate a set of user specified IDs which you want to reserve in this pool. PUT : https://{appl}/rest/id-pools/{id}/validate Request Body: { "idList":[ "10:00:2c:6c:28:80:00:00" ,"10:00:2c:6c:28:80:00:01" ] } Pool description: Defines a Pool resource. Allowed values are vmac,vsn,vwwn.
id-pools uri: totalCount: prefix: eTag: freeCount: rangeUris: type: allocatedCount: format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][09])?Z description: The canonical URI of the resource type: string description: Total count of IDs managed by this pool. Adding or removing ranges alters the totalCount type: number description: Prefix to be used in front of the generated IDs.
id-pools startAddress: description: Defines the start value of this fragment type: string Allocator description: Defines an allocator resource, which contains the list of allocated IDs type: object Properties valid: type: eTag: description: Entity tag/version ID of the resource. This is the same value that is returned in the ETag header on a GET of the resource.
id-pools/vmac/ranges HP OneView REST API Reference Updated: October 16, 2013 4:41 MDT id-pools/vmac/ranges This resource provides APIs for Managing vmac ranges. A vmac can be requested, used, and returned. Once returned, the vmac is reclaimed by the range and is available for reuse. The range is accessed by: https://{appl}/id-pools/vmac/ranges. The REST API (POST, GET, UPDATE, DELETE) supports an 'accept-language' in the request header. The default is 'en_US'.
id-pools/vmac/ranges POST https://{appl}/rest/id-pools/vmac/ranges/ Request Body: { "type": "Range", "name": null, "prefix": null, "enabled": true, "rangeCategory": "GENERATED", "startAddress": "E2:13:C5:F0:00:00", "endAddress": "E2:13:C5:FF:FF:FF", "totalCount": 1048575, "freeIdCount": 1048575, "allocatedIdCount": 0, "allocatorUri": "/rest/id-pools/vmac/ranges/5613a502-9253-45c6-aa78a83635241cf8/allocator" , "collectorUri": "/rest/id-pools/vmac/ranges/5613a502-9253-45c6-aa78a83635241cf8/collector" , "rese
id-pools/vmac/ranges Examples The following example shows how to get the JSON schema for a vmac range. https://{appl}/rest/id-pools/vmac/ranges/schema URI: /rest/id-pools/vmac/ranges/{id} Method API DELETE Deletes a vmac range. Parameter Attributes Description force Optional If set to true, the operation completes even if there are network connectivity issues or resource errors. The default is false.
id-pools/vmac/ranges REST API Response Codes Examples The following example shows how to get a vmac range whose identifier is {range-id} GET https://{appl}/rest/id-pools/vmac/ranges/{range-id} PUT Enables or disables a vmac range. Parameter Attributes Description force Optional If set to true, the operation completes even if there are network connectivity issues or resource errors. The default is false.
id-pools/vmac/ranges count Optional Optional parameter that specifies the number of resources to return from each API invocation. The number of resources returned on each call is referred to as a page. If you specify a count, the API attempts to return the specified number of resources, however this may be limited due to response time constraints and/or actual number of resources available to return.
id-pools/vmac/ranges The following example shows how to allocate IDs from a vmac range whose identifier is {range-id} PUT https://{appl}/rest/id-pools/vmac/ranges/{range-id}/allocator Request Body: {"count":5} URI: /rest/id-pools/vmac/ranges/{id}/collector Method API PUT Collects a set of IDs back to a vmac range. The collector returned contains the list of IDs successfully collected.
id-pools/vmac/ranges start parameter to view additional resource pages. The default value for start is 0 (first available resource). count Optional Optional parameter that specifies the number of resources to return from each API invocation. The number of resources returned on each call is referred to as a page.
id-pools/vmac/ranges uri: allocatedIdCount: endAddress: enabled: type: string description: The canonical URI of the resource type: string description: Count of Ids allocated from this Range type: integer description: The end address of this Range type: string description: Defines the status of the Pool type: boolean defaultRange: type: modified: description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.
id-pools/vmac/ranges startAddress: freeFragmentUri: reservedIdCount: type: description: The start address of this Range type: string description: Uri of free fragments for this Range type: string description: Count of Ids reserved in this Range type: integer description: Identifies the resource type. This field must be set to 'Range'.
id-pools/vmac/ranges FragmentList description: Defines a Paginated fragment collection to return list of fragments type: object Properties count: category: nextPageUri: prevPageUri: uri: created: start: eTag: members: description: The actual number of resources returned in this page.
id-pools/vmac/ranges enum: type: modified: total: type: IN_USE FREE string description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])? Z description: The total number of resources that would be returned from the query (including any filters), if there was no pagination (or enforced resource limits) employed.
id-pools/vsn/ranges HP OneView REST API Reference Updated: October 16, 2013 4:41 MDT id-pools/vsn/ranges This resource provides apis to manage vsn ranges. A vsn may be requested, used, and returned. Once returned, the vsn is reclaimed by the range and available for reuse. The range is accessed by: https://{appl}/id-pools/vsn/ranges. The REST API (POST, GET, UPDATE, DELETE) supports an 'accept-language' in the request header which defaults to 'en_US'. An 'auth:{token}' in the request header is required.
id-pools/vsn/ranges Request Body: { "type": "Range", "name": "VSN", "prefix": null, "enabled": true, "startAddress": "VCGS5EI000", "endAddress": "VCGS5EIZZZ", "rangeCategory": "GENERATED", "totalCount": 46656, "freeIdCount": 46656, "allocatedIdCount": 0, "defaultRange": true, "allocatorUri": "/rest/id-pools/vsn/ranges/ae2df099-5570-4f9e-950316531324d9a4/allocator" , "collectorUri": "/rest/id-pools/vsn/ranges/ae2df099-5570-4f9e-950316531324d9a4/collector" , "reservedIdCount": 0, "freeFragmentUri": "/res
id-pools/vsn/ranges Examples The following example shows how to get the JSON schema of a vsn range. https://{appl}/rest/id-pools/vsn/ranges/schema URI: /rest/id-pools/vsn/ranges/{id} Method API DELETE Deletes a vsn range. Parameter Attributes Description force Optional If set to true, the operation completes even if there are network connectivity issues or resource errors. The default is false.
id-pools/vsn/ranges REST API Response Codes Examples The following example shows how to get a vsn range whose identifier is {range-id} GET https://{appl}/rest/id-pools/vsn/ranges/{range-id} PUT Enables or disables a vsn range. Parameter Attributes Description force Optional If set to true, the operation completes even if there are network connectivity issues or resource errors. The default is false.
id-pools/vsn/ranges from each API invocation. The number of resources returned on each call is referred to as a page. If you specify a count, the API attempts to return the specified number of resources, however this may be limited due to response time constraints and/or actual number of resources available to return. The results include the total number of resources that match the filter or query, the actual count returned, and the URIs to go to the next page, previous page, or both.
id-pools/vsn/ranges The following example shows how to allocate IDs from a range whose identifier is {range-id} PUT :https://{appl}/rest/id-pools/vsn/ranges/{range-id}/allocator Request Body:{"count":10} URI: /rest/id-pools/vsn/ranges/{id}/collector Method API PUT Collects a set of IDs back to a vsn range. The collector returned contains the list of IDs successfully collected. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
id-pools/vsn/ranges count Optional Optional parameter that specifies the number of resources to return from each API invocation. The number of resources returned on each call is referred to as a page. If you specify a count, the API attempts to return the specified number of resources, however this may be limited due to response time constraints and/or actual number of resources available to return.
id-pools/vsn/ranges allocatedIdCount: endAddress: enabled: type: string description: Count of Ids allocated from this Range type: integer description: The end address of this Range type: string description: Defines the status of the Pool type: boolean defaultRange: type: modified: description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
id-pools/vsn/ranges freeFragmentUri: reservedIdCount: type: description: Uri of free fragments for this Range type: string description: Count of Ids reserved in this Range type: integer description: Identifies the resource type. This field must be set to 'Range'. type: string Allocator description: Defines an allocator resource, which contains the list of allocated IDs type: object Properties valid: type: eTag: description: Entity tag/version ID of the resource.
id-pools/vsn/ranges description: Defines a Paginated fragment collection to return list of fragments type: object Properties count: category: nextPageUri: prevPageUri: uri: created: start: eTag: members: description: The actual number of resources returned in this page.
id-pools/vsn/ranges type: modified: total: type: string description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])? Z description: The total number of resources that would be returned from the query (including any filters), if there was no pagination (or enforced resource limits) employed.
id-pools/vwwn/ranges HP OneView REST API Reference Updated: October 16, 2013 4:41 MDT id-pools/vwwn/ranges This resource provides apis to manage vwwn ranges. A vwwn may be requested, used, and returned. Once returned, the vwwn is reclaimed by the range and available for reuse. The range is accessed by: https://{appl}/id-pools/vwwn/ranges. The REST API (POST, GET, UPDATE, DELETE) supports an 'accept-language' in the request header which defaults to 'en_US'.
id-pools/vwwn/ranges POST : https://{appl}/rest/id-pools/vwwn/ranges/ Request Body: { "type": "Range", "name": "VWWN", "prefix": null, "enabled": true, "startAddress": "10:00:38:9d:30:60:00:00", "endAddress": "10:00:38:9d:30:6f:ff:ff", "rangeCategory": "GENERATED", "totalCount": 1048576, "freeIdCount": 1048576, "allocatedIdCount": 0, "defaultRange": true, "allocatorUri": "/rest/id-pools/vwwn/ranges/daa36872-03b1-463b-aaf709d58b650142/allocator" , "collectorUri": "/rest/id-pools/vwwn/ranges/daa36872-03b1
id-pools/vwwn/ranges REST API Response Codes Examples The following example shows how to get the JSON schema for a vwwn range. https://{appl}/rest/id-pools/vwwn/ranges/schema URI: /rest/id-pools/vwwn/ranges/{id} Method API DELETE Deletes a vwwn range. Parameter Attributes Description force Optional If set to true, the operation completes even if there are network connectivity issues or resource errors. The default is false.
id-pools/vwwn/ranges Response Codes REST API Response Codes Examples The following example shows how to get a vwwn range whose identifier is {range-id} GET https://{appl}/rest/id-pools/vwwn/ranges/{range-id} PUT Enables or disables a vwwn range. Parameter Attributes Description force Optional If set to true, the operation completes even if there are network connectivity issues or resource errors. The default is false.
id-pools/vwwn/ranges count Optional Optional parameter that specifies the number of resources to return from each API invocation. The number of resources returned on each call is referred to as a page. If you specify a count, the API attempts to return the specified number of resources, however this may be limited due to response time constraints and/or actual number of resources available to return.
id-pools/vwwn/ranges Examples The following examples shows how to allocate IDs from a vwwn range whose identifer is {range-id} PUT : https://{appl}/rest/id-pools/vwwn/ranges/{range-id}/allocator Request Body: {"count" :10} URI: /rest/id-pools/vwwn/ranges/{id}/collector Method API PUT Collects a set of IDs back to a vwwn range. The collector returned contains the list of IDs successfully collected.
id-pools/vwwn/ranges for is (first available resource). count Optional Optional parameter that specifies the number of resources to return from each API invocation. The number of resources returned on each call is referred to as a page. If you specify a count, the API attempts to return the specified number of resources, however this may be limited due to response time constraints and/or actual number of resources available to return.
id-pools/vwwn/ranges uri: allocatedIdCount: endAddress: enabled: type: string description: The canonical URI of the resource type: string description: Count of Ids allocated from this Range type: integer description: The end address of this Range type: string description: Defines the status of the Pool type: boolean defaultRange: type: modified: description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.
id-pools/vwwn/ranges startAddress: freeFragmentUri: reservedIdCount: type: description: The start address of this Range type: string description: Uri of free fragments for this Range type: string description: Count of Ids reserved in this Range type: integer description: Identifies the resource type. This field must be set to 'Range'.
id-pools/vwwn/ranges FragmentList description: Defines a Paginated fragment collection to return list of fragments type: object Properties count: category: nextPageUri: prevPageUri: uri: created: start: eTag: members: description: The actual number of resources returned in this page.
id-pools/vwwn/ranges enum: type: modified: total: type: IN_USE FREE string description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])? Z description: The total number of resources that would be returned from the query (including any filters), if there was no pagination (or enforced resource limits) employed.
enclosure-groups HP OneView REST API Reference Updated: October 16, 2013 4:47 MDT enclosure-groups The enclosure group resource provides REST APIs for managing enclosure groups. An enclosure group is a resource that defines common settings that should be applied to all enclosures within the group. You can retrieve an enclosure group resource representing any enclosure group managed by the appliance, create new enclosure groups, and update existing enclosure groups.
enclosure-groups filter Experimental This parameter is experimental for this release: While generally functional when used in simple cases, restrictions might be noted in the implementation description. A general filter/query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request. The default is no filter (all resources are returned).
enclosure-groups groups/aeef7314-527d-4053-868c-17b87df1b57c" }, { "interconnectBay": 2, "logicalInterconnectGroupUri": groups/aeef7314-527d-4053-868c-17b87df1b57c" }, { "interconnectBay": 3, "logicalInterconnectGroupUri": groups/aeef7314-527d-4053-868c-17b87df1b57c" }, { "interconnectBay": 4, "logicalInterconnectGroupUri": groups/aeef7314-527d-4053-868c-17b87df1b57c" }, { "interconnectBay": 5, "logicalInterconnectGroupUri": groups/aeef7314-527d-4053-868c-17b87df1b57c" }, { "interconnectBay": 6, "logicalIn
enclosure-groups GET https://{appl}/rest/enclosure-groups/schema URI: /rest/enclosure-groups/{id} Method API GET Gets the enclosure-group resource with the specified URI. Parameter Attributes Description Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
enclosure-groups Header REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description String Null with the status code "No-Content" Response Codes REST API Response Codes Examples Deletes the enclosure group with the specified {id}.
enclosure-groups Pending, Failed and Normal. interconnectBayMappings: readonly: true type: string description: Defines which logical interconnect group is associated with each interconnect bay. This indicates the network connectivity that will be available to each bay.
enclosure-groups in the ETag header on a GET of the resource modified: category: type: stackingMode: type: string description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](. [0-9][0-9][0-9])?Z description: Resource category used for authorizations and resource type groupings type: string description: Identifies the resource type.
enclosure-groups collection uri: modified: start: eTag: nextPageUri: members: type: string description: The canonical URI of the resource type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
enclosure-groups name: portMappingCount: created: uri: interconnectBayMappings: description: Display name for the resource type: string description: The number of port mappings. type: integer maximum: 8 readonly: true minimum: 0 description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[05][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
enclosure-groups 5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z interconnectBayMappingCount: state: eTag: category: type: stackingMode: type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: The number of interconnectbay mappings. This number is determined by the number of interconnect bay mappings specified. required: true maximum: 8 readonly: true minimum: 1 type: integer description: The current resource state of the enclosure group. Possible values are Pending, Failed and Normal.
enclosures HP OneView REST API Reference Updated: October 16, 2013 4:47 MDT enclosures The enclosures resource provides REST APIs for managing BladeSystem c7000 enclosures. You can retrieve the enclosure resource representing any enclosure managed by the appliance, add new enclosures, and remove existing enclosures.
enclosures added to the enclosure group with the specified group URI. POST: https://{appl}/rest/enclosures { "hostname" : "enc-oa.corp.com", "username" : "Administrator", "password" : "mypassword", "force" : false, "enclosureGroupUri : "/rest/enclosure-groups/7238aac1-6c37-45d2a40e-b810-b12bed2a", "firmwareBaselineUri" : "/rest/firmwaredrivers/SPPBLRH2012100_2012_1119", "updateFirmwareOn" : "EnclosureOnly" } GET Gets a list of enclosures.
enclosures Header REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description EnclosureList Returns a list of enclosure resources. Response Codes REST API Response Codes Examples Get a subset of enclosures based on default sorting and filtering. The subset starts at the 11th enclosure, and returns up to 10 enclosures.
enclosures Response Description Enclosure An enclosure resource Response Codes REST API Response Codes Examples GET the enclosure with a specific URI. GET https://{appl}/rest/enclosures/{id} DELETE Removes an enclosure and its servers and interconnects from management of the appliance. Parameter Attributes Description force Optional If set to true, the operation completes even if there are network connectivity issues or resource errors. The default is false.
enclosures Onboard Administrator of the enclosure with the specified ID. https://{appl}/rest/enclosures/{id}/activeOaSsoUrl URI: /rest/enclosures/{id}/enclosureFwBaseline Method API PUT Applies a firmware baseline to the enclosure. This can be used to update the OA firmware or the OA, logical interconnect, and server profiles in the enclosure. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
enclosures Examples Retrieve environmental configuration data for a given enclosure resource: GET https://{appl}/rest/enclosures/{id}/environmentalConfiguration PUT Sets the calibrated max power of an unmanaged or unsupported enclosure. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
enclosures Start an enclosure refresh. The status of the refresh can be tracked with the task resource that is returned. PUT https://{appliance_name_or_ip}/rest/enclosures/{id}/refreshState { "refreshState":"RefreshPending" } Start an enclosure refresh. The status of the refresh can be tracked with the task resource that is returned. The "address" field specifies an alternate address of the OA that should be used.
enclosures Get a single sign-on URL for the active Onboard Administrator of the enclosure. GET https://{appl}/rest/enclosures/{id}/activeOaSsoUrl URI: /rest/enclosures/{id}/utilization Method API GET Retrieves historical utilization data for the specified enclosure, metrics, and time span. Parameter Attributes Description refresh Optional Specifies that if necessary an additional request will be queued to obtain the most recent utilization data from the enclosure.
enclosures RatedCapacity Enclosure dynamic power cap rated capacity setting in Watts during this sample interval. If unspecified, all metrics supported are returned. filter Experimental Provides an expression of the requested time range of data. One condition (startDate/endDate) is specified per filter specification as described below. The condition must be specified via the equals (=) operator. startDate Start date of requested starting time range in ISO 8601 format.
enclosures AddEnclosure description: The resource used to add an enclosure. type: object Properties username: password: force: licensingIntent: description: OA administrator user name (e.g. Administrator). required: true type: string description: Password for the specified user name. required: true type: string description: Use this optional flag with caution, because force-adding an enclosure makes it unmanagable by any other system managing it and removes any existing configuration.
enclosures Properties status: category: name: ipv6Address: created: uri: modified: mac: state: eTag: enclosures.html[10/17/2013 10:35:21 AM] description: Overall health status of the resource.
enclosures deviceType: maxPwrConsumed: ipv4Address: model: height: type: id: uuid: firmwareBaselineUri: enclosureUri: enclosures.html[10/17/2013 10:35:21 AM] type: string description: When discovered via an HP Intelligent Power Distribution Unit (iPDU), this is the management processor type of the attached resource:iLO, APM Chassis, BladeSystem, Storage, Networking, or Server-Other. readonly: true type: string description: The maximum power consumed by the device in watts.
enclosures Enclosure description: Enclosure resource. type: object Properties standbyOaPreferredIP: vcmDomainName: modified: interconnectBayCount: isFwManaged: interconnectBays: description: Preferred IP address for the enclosure's standby OA. minLength: 0 readonly: true maxLength: 255 type: string description: Domain name of the enclosure.
enclosures logicalInterconnectUri: bayNumber: category: fwBaselineUri: uuid: vcmUrl: assetTag: licensingIntent: enclosures.html[10/17/2013 10:35:21 AM] URI for logical interconnect associated with the interconnect module in this bay. maxLength: 255 type: string minLength: 0 description: Interconnect bay number.
enclosures fwBaselineName: state: stateReason: type: status: description: deviceBayCount: eTag: refreshState: description: The name of the current firmware baseline. readonly: true type: string description: The current resource state of the enclosure. Possible values are 'Adding', 'Removing', 'Configuring', 'Pending', 'Interrupted', 'Unmanaged', 'Unsupported', 'RemoveFailed' and 'Configured'. type: string description: The reason for the current resource state of the enclosure.
enclosures created: serialNumber: enclosureGroupUri: activeOaPreferredIP: oa: minLength: 1 readonly: true maxLength: 32 type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9] [0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: Serial number of the enclosure.
enclosures fwVersion: role: description: Firmware version of the OA. maxLength: 255 type: string minLength: 0 description: Role of the OA, eg:Active, Standby, etc. enum: fqdnHostName: ipv6Addresses: Unknown OaAbsent Standby Transition Active type: string description: Fully qualified domain name maxLength: 255 type: string minLength: 0 description: Set of IPv6 addresses of the OA. type: array Items type: description: Type of the OA IPv6 address.
enclosures enclosureType: rackName: partNumber: vcmMode: deviceBays: readonly: true type: integer description: Enclosure type of the enclosure, eg, 'Blade System c7000 Enclosure G2' minLength: 0 readonly: true maxLength: 255 type: string description: Name of the rack in which the enclosure resides. minLength: 1 readonly: true maxLength: 32 type: string description: Part number of the enclosure.
enclosures coveredByDevice: uri: modified: availableForFullHeightProfile: eTag: profileUri: availableForHalfHeightProfile: bayNumber: model: enclosures.html[10/17/2013 10:35:21 AM] pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3] [0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](. [0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
enclosures devicePresence: type: deviceUri: enclosureUri: type: string minLength: 0 maxLength: 255 description: Indicates whether a device is present in the bay. type: string minLength: 0 maxLength: 255 description: Identifies the resource type. This field must be set to 'DeviceBay'.
enclosures uri: modified: start: eTag: nextPageUri: members: type: string description: The canonical URI of the resource type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
enclosures isFwManaged: interconnectBays: type: integer readonly: true description: Flag indicating whether the firmware is managed. type: boolean readonly: true description: List of interconnect bays in the enclosure. type: array readonly: true Items interconnectUri: logicalInterconnectUri: bayNumber: category: fwBaselineUri: uuid: vcmUrl: enclosures.html[10/17/2013 10:35:21 AM] description: URI of the interconnect associated with the interconnect module in this bay.
enclosures assetTag: licensingIntent: minLength: 0 maxLength: 255 readonly: true type: string description: Asset tag for the enclosure. minLength: 0 maxLength: 32 readonly: true type: string description: The licensing policy for all the servers in the enclosure. readonly: true enum: fwBaselineName: state: stateReason: type: status: description: deviceBayCount: enclosures.
enclosures eTag: refreshState: required: true type: integer description: Entity tag/version ID of the resource, the same value that is returned in the ETag header on a GET of the resource type: string description: Indicates if the resource is currently refreshing. type: string enum: partNumber: name: created: serialNumber: enclosureGroupUri: modified: enclosures.
enclosures format: oa: YYYY-MM-DDThh:mm:ss.sssZ description: List of OAs in the enclosure. type: array readonly: true Items fwVersion: dhcpIpv6Enable: ipv6Addresses: description: Firmware version of the OA. type: string minLength: 0 maxLength: 255 description: DHCP Enable flag in IPv6 setting type: boolean description: Set of IPv6 addresses of the OA. type: array Items type: description: Type of the OA IPv6 address. type: string enum: address: state: enclosures.
enclosures fwBuildDate: dhcpEnable: ipAddress: fqdnHostName: oaBayCount: enclosureType: rackName: vcmDomainId: vcmMode: enclosures.html[10/17/2013 10:35:21 AM] type: integer description: Build date of the OA's current firmware type: string minLength: 0 maxLength: 255 description: DHCP Enable flag type: boolean description: IPv4 address of the OA.
enclosures deviceBays: readonly: true required: true type: boolean description: List of device bays in the enclosure. type: array readonly: true Items category: coveredByProfile: created: enclosureUri: coveredByDevice: uri: enclosures.
enclosures of the resource modified: availableForFullHeightProfile: eTag: profileUri: availableForHalfHeightProfile: model: devicePresence: enclosures.html[10/17/2013 10:35:21 AM] type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]([0-1][0-9])-[0-3][09]T[0-2][0-9]:[0-5] [0-9]:[0-5][0-9](.[09][0-9][0-9])?Z type: string format: YYYY-MMDDThh:mm:ss.
enclosures in the bay. type: deviceUri: bayNumber: total: type: maxLength: 255 type: string minLength: 0 description: Identifies the resource type. This field must be set to 'DeviceBay'. type: string description: URI for the serverhardware in the bay maxLength: 255 type: string minLength: 0 description: Device Bay number.
enclosures SsoUrlData description: Contains data used to make a request to an Onboard Administrator for single sign-on access. type: object Properties ssoUrl: attributes: description: POST the attribute map to this URL for SSO access. type: string description: A map of name-value attribute pairs that should be sent as a POST request to the ssoUrl. type: object UtilizationData description: The requested utilization data for the resource.
enclosures refreshTaskUri: uri: resolution: sliceStartTime: sliceEndTime: newestSampleTime: oldestSampleTime: isFresh: description: The uri of a task resource to track the collection of the most recent utilization data (null if no collection is required). When the task completes, repeat the request to obtain any newly collected data. type: string description: The uri of the resource associated with this metric data.
enclosures type: object Properties calibratedMaxPower: description: The calibrated maximum power of the resource. Calibrated Maximum Power is defined as the maximum potential power that the device can consume, subject to the following requirements and constraints: 1. The value reported MUST be the maximum which can be sustained for greater than 1/2 second (i.e., in-rush currents and other spikes that may persist for less than a 1/2 second are not to be included). 2.
enclosures seconds (5 minutes). historyBufferSize: powerCapType: type: integer required: true description: Number of history samples maintained by the device. For example, 288 samples at 5 minute intervals cover 24 hours. type: integer required: true description: The type of power capping supported by this device. type: string enum: idleMaxPower: calibratedMaxPower: psuList: None Thermal Electrical description: Minimum power consumption seen (in Watts), 0 if unknown.
enclosures inputVoltage: side: description: The line voltage (input) to the power supply (sampled or nominal). type: integer description: The logical power delivery grouping of the power supply. In a known non-redundant configuration, all power supplies should be considered on side A. In a known ACredundant configuration, the 2 sets of redundant power supplies should be identified as side A/B groupings.
enclosures None, then there are no known issues preventing access to environmental monitoring features of the resource. If the value is iLOAdvanced, then the server hardware must have an iLOAdvanced license applied to environmental monitoring features. If the value is OneView, then it indicates that there are insufficient HP OneView licenses available to the appliance to enable environmental management features on the resource.
server-hardware HP OneView REST API Reference Updated: October 16, 2013 4:53 MDT server-hardware The server hardware resource is a representation of a physical server. The server hardware resource provides APIs for server management tasks such as applying a profile, importing a server and managing an iLO.
server-hardware Get all server hardware resources: GET https://{appl}/rest/server-hardware?start=0&count=-1 Get maximum of 5 server hardware resources that do not have a profile assigned,sorted by enclosure bay number in descending order: GET https://{appl}/rest/server-hardware? start=0&count=5&sort=position:desc&filter="serverProfileUri=null" POST Adds a rack-mount server for management by the appliance. This API initiates the asynchronous addition of supported server models.
server-hardware API-Version:3" Response Description EnvironmentalConfiguration An EnvironmentalConfiguration object for the requested resource. Response Codes REST API Response Codes Examples Retrieve environmental configuration data for a given server hardware resource: GET PUT https://{appl}/rest/server-hardware/{id}/environmentalConfiguration Sets the calibrated max power of an unmanaged or unsupported server hardware resource.
server-hardware Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
server-hardware URI: /rest/server-hardware/{id}/refreshState Method API PUT Refreshes the server hardware to fix configuration issues. Parameter Attributes Description Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "XAPI-Version:3" Request Body Attributes Description ServerRefreshRequest Required An object describing the refresh request.
server-hardware Parameter Attributes Description refresh Optional Specifies that if necessary an additional request will be queued to obtain the most recent utilization data from the iLO. The response will not include any refreshed data. To track the availability of the newly collected data, monitor the TaskResource identified by the refreshTaskUri property in the response. If null, no refresh was queued. view Optional Specifies the resolution interval length of the samples to be retrieved.
server-hardware Response Codes REST API Response Codes Examples Get most recent 24-hour CPU Utilization & Frequency data for server USE7335NW3 (endDate should be present time): GET https://{appl}/rest/server-hardware/USE7335NW3/utilization? fields=CpuUtilization&fields=CpuAverageFreq&filter=endDate=20120403T113000.
server-hardware type: object Properties powerLock: modified: processorType: mpIpAddress: category: mpFirmwareVersion: serverHardwareTypeUri: uuid: assetTag: licensingIntent: description: Indicates if an operation is being performed on this server hardware (such as a profile assignment) that prevents its power state from being manipulated via the server hardware API.
server-hardware Items physicalPorts: description: List of physical ports on the device. type: array readonly: true Items interconnectPort: virtualPorts: description: The downlink port number that this physical port is connected to on the interconnect module. type: integer readonly: true description: For Flex-capable devices, a list of FlexNICs defined on the server.
server-hardware type: description: Physical port type. Values include Ethernet and FibreChannel. type: string readonly: true enum: deviceName: oaSlotNumber: slotNumber: location: description: The name or model of the adapter. type: string readonly: true description: The internal physical slot number of this device as known by the Onboard Administrator. type: integer readonly: true description: The slot number of the adapter on the server hardware within its specified location.
server-hardware serverProfileUri: type: status: description: formFactor: virtualSerialNumber: eTag: processorSpeedMhz: refreshState: type: string readonly: true description: URI of a server profile assigned to this server hardware, if one is assigned. If not assigned this value is null. type: string readonly: true description: Identifies the resource type. This field must be set to 'server-hardware-1'. type: string description: Overall health status of the resource.
server-hardware enum: name: created: serialNumber: processorCoreCount: uri: processorCount: romVersion: virtualUuid: mpDnsName: signature: Unknown - unable to determine the power state On - power is on Off - power is off PoweringOn - server is powering on PoweringOff - server is powering off Resetting - server is resetting type: string searchable: true required: true description: The name of the server.
server-hardware position: model: type: integer readonly: true description: For blade servers, the number of the physical enclosure bay in which the server hardware resides. For rack mount servers, this value is null. type: integer readonly: true searchable: true description: The full server hardware model string. type: string readonly: true searchable: true ServerHardwareList description: A list of server hardware.
server-hardware uri: processorType: mpIpAddress: category: mpFirmwareVersion: serverHardwareTypeUri: uuid: assetTag: licensingIntent: searchable: true description: The canonical URI of the resource type: string description: Type of CPU installed on this server hardware. readonly: true type: string description: IP Address of the management processor (iLO) resident on this server hardware.
server-hardware this physical port is connected to on the interconnect module. virtualPorts: readonly: true type: integer description: For Flex-capable devices, a list of FlexNICs defined on the server. readonly: true type: array Items wwpn: mac: portNumber: portFunction: wwnn: mac: server-hardware.html[10/17/2013 10:35:23 AM] description: description: The world wide port name assigned to this virtual port.
server-hardware portNumber: interconnectUri: type: readonly: true type: string description: Physical port number of the adaptor. readonly: true type: integer description: URI of the interconnect module connected to this physical port. readonly: true type: string description: Physical port type. Values include Ethernet and FibreChannel. readonly: true enum: type: deviceName: location: oaSlotNumber: memoryMb: state: The name or model of the adapter.
server-hardware stateReason: type: string description: The reason for the current resource state of the server hardware. This only applies when the state is 'Unmanaged', otherwise it is set to 'NotApplicable'. The supported values are enumerated in the table below. readonly: true enum: mpModel: serverProfileUri: type: status: description: formFactor: virtualSerialNumber: eTag: processorSpeedMhz: refreshState: type: string description: The model type of the iLO, such as iLO4.
server-hardware locationUri: shortModel: serverGroupUri: powerState: searchable: true description: For blade servers, the enclosure in which this blade server resides. This URI can be used to retrieve information about the enclosure. This value is not set for rack mount servers. readonly: true type: string description: Short version of the server hardware model string, typically something like BL460 Gen8.
server-hardware virtualUuid: mpDnsName: signature: description: Virtual UUID associated with this server hardware (if specified in the profile assigned to this server). readonly: true type: string description: The DNS name of the iLO/Management Processor that resides on this server hardware. readonly: true type: string description: Data representing the current configuration or 'signature' of the server.
server-hardware force: licensingIntent: description: Use this optional flag with caution because using force to add a server removes its existing configuration and takes ownership away from any other management system already managing it. Specify 'true' to force the addition and take ownership away from any other manager. Default is 'false'. type: boolean description: The type of product license to assign to the server hardware. Valid options are: OneView or OneViewNoiLO.
server-hardware type: boolean IloSsoUrlResult description: The IloSsoUrlResult contains the URL to the HP iLO Single Sign On (SSO) web session as created by a REST GET /rest/serverhardware/{id}/iloSsoUrl request. type: object Properties iloSsoUrl: description: URL to launch a Single Sign-On (SSO) session for the iLO web interface.
server-hardware metricSamples: description: The set of utilization sample arrays keyed by metric name. Each sample element in the array is itself an array containing a time value (metricSamples[i][0]) followed by the value at that time (metricSamples[i][1])).The time value is represented as the number of milliseconds between the time and midnight January 1 1970. The samples are sorted in time order from most-recent to oldest. The value representation is dependent upon the metric selected.
server-hardware power can be used, the larger number MUST be reported when the device is next queried for this metric. 4. The value reported does not represent potential input power in the case of error conditions such as short circuits. 5. The actual power used by the device MUST NOT exceed the reported Calibrated Maximum Power by greater than 1%. 6. The Calibrated Maximum Power SHOULD NOT exceed the actual maximum power that the device is capable of using by more than 5%.
server-hardware used by the device MUST NOT exceed the reported Calibrated Maximum Power by greater than 1%. 6. The Calibrated Maximum Power SHOULD NOT exceed the actual maximum power that the device is capable of using by more than 5%. psuList: type: integer required: true description: The list of configuration data for each power supply of the device. type: array Items capacity: psuId: inputVoltage: side: description: The size of the power supply in Watts.
server-hardware enum: required: server-hardware.
server-hardware-types HP OneView REST API Reference Updated: October 16, 2013 4:55 MDT server-hardware-types The server hardware types resource is a representation/abstraction of a physical server managed by the appliance. It defines capabilities and settings that can be used in a server profile.
server-hardware-types Response Codes REST API Response Codes Examples Get all server hardware type resources: GET https://{appl}/rest/server-hardware-types URI: /rest/server-hardware-types/schema Method API GET Get the JSON schema of the server hardware types resource. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
server-hardware-types Body Map Required Map of key value pairs where the key is the name of the attribute and the value is the what you are setting it to. Response Description ServerHardwareType A server hardware type resource with the updated attribute(s).
server-hardware-types created: type: biosSettings: minLength: 0 required: true type: string maxLength: 255 description: Date and time when the resource was created format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z description: Identifies the resource type. This field must be set to 'server-hardware-type-1'.
server-hardware-types type: description: Type of a BIOS setting. The type serves to specify what values can be assigned to the setting. Settings of type 'String' accept ASCII string values, while settings of type 'Option' accept any of the listed options. readonly: true enum: type: options: String Option Number string description: The list of avaliable options for a setting. This list is only available for settings of type 'Option'. See 'type' for more details.
server-hardware-types Set settingId: optionId: id: uri: capabilities: modified: eTag: model: adapters: type: string description: The identifier of the setting affected by this link. readonly: true type: string description: Identifies an option in the linked setting where the link action has to be applied to. readonly: true type: string description: Identifies a valid option for a given setting.
server-hardware-types capabilities: location: readonly: true type: integer description: List of server hardware type capabilities indicating high-level features that can be defined in a profile. If a capability is present in the list, it is supported by this server type. If 'FirmwareUpdate' is present, the server type supports firmware updates in server profiles. 'ManageBIOS' and 'ManageBootOrder' indicate the server profile can manage BIOS settings or boot order for this server type.
server-hardware-types number: physicalFunctionCount: oaSlotNumber: bootCapabilities: description: readonly: true type: string description: The port number of the adapter port. readonly: true type: integer description: The number of functions (e.g. FlexNICs) that can be supported on this physical port. readonly: true type: integer description: The internal physical slot number of this device as known by the Onboard Administrator.
server-hardware-types modified: start: eTag: nextPageUri: members: type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
server-hardware-types capabilities: location: type: integer readonly: true description: List of server hardware type capabilities indicating highlevel features that can be defined in a profile. If a capability is present in the list, it is supported by this server type. If 'FirmwareUpdate' is present, the server type supports firmware updates in server profiles. 'ManageBIOS' and 'ManageBootOrder' indicate the server profile can manage BIOS settings or boot order for this server type.
server-hardware-types used to determine which interconnect device the server port will attach to. For blade servers, this value provides a mapping to the enclosure midplane. The enclosure provides a matching value that maps the midplane to the interconnect bay. physicalFunctionCount: number: oaSlotNumber: biosSettings: type: integer readonly: true description: The number of functions (e.g. FlexNICs) that can be supported on this physical port.
server-hardware-types options: type: string readonly: true description: The list of avaliable options for a setting. This list is only available for settings of type 'Option'. See 'type' for more details. type: array readonly: true Items id: name: optionLinks: description: Identifies a valid option for a given setting. type: string readonly: true description: The localized name that describes the option.
server-hardware-types option should be avoided. Set means the option should be selected. Composes means the option should be selected. This action enables desired 'canned' combinations of options to be set for a group of settings by a single, higher level setting. type: string readonly: true enum: settingId: optionId: stringMaxLength: helpText: server-hardware-types.html[10/17/2013 10:35:25 AM] Avoid Composes Set description: The identifier of the setting affected by this link.
server-hardware-types type: description: Type of a BIOS setting. The type serves to specify what values can be assigned to the setting. Settings of type 'String' accept ASCII string values, while settings of type 'Option' accept any of the listed options. type: string readonly: true enum: id: uri: capabilities: modified: eTag: model: type: bootCapabilities: server-hardware-types.
server-hardware-types description: total: type: type: array readonly: true description: Brief description of the server hardware type type: string minLength: 0 maxLength: 255 description: The total number of resources that would be returned from the query (including any filters), without pagination or enforced resource limits type: integer description: Identifies the resource type. This field must be set to 'server-hardware-type-list-1'. type: string server-hardware-types.
logical-interconnect-groups HP OneView REST API Reference Updated: October 16, 2013 4:31 MDT logical-interconnect-groups Manages logical interconnect groups. A logical interconnect group serves as a structural reference when building a logical interconnect. All of the configuration constructs of a logical interconnect are present in the logical interconnect group. The logical interconnect group serves as the initial and ongoing reference for the structure of a logical interconnect.
logical-interconnect-groups Response Description LogicalInterconnectGroupCollection A paginated collection of logical interconnect group resources Response Codes REST API Response Codes Examples Gets the first 10 logical interconnect groups: GET https://{appl}/rest/logical-interconnect-groups?start=0&count=10 Gets all the logical interconnect groups in the domain: GET https://{appl}/rest/logical-interconnect-groups POST Creates a logical interconnect group.
logical-interconnect-groups }, { "logicalDownlinkUri" : null, "logicalLocation" : { "locationEntries" : [ { "relativeValue" : "2", "type" : "Bay" }, { "relativeValue" : 1, "type" : "Enclosure" } ] }, "permittedInterconnectTypeUri" : "/rest/interconnect-types/46d7ffad-4424-4e36-acf3-b379c3116206" }, { "logicalDownlinkUri" : null, "logicalLocation" : { "locationEntries" : [ { "relativeValue" : 3, "type" : "Bay" }, { "relativeValue" : 1, "type" : "Enclosure" } ] }, "permittedInterconnectTypeUri" : null }, { "
logical-interconnect-groups }, { "relativeValue" : 1, "type" : "Enclosure" } ] }, "permittedInterconnectTypeUri" : null } ] }, "type" : "logical-interconnect-group", "uri" : null } URI: /rest/logical-interconnect-groups/defaultSettings Method API GET Gets the default interconnect settings for a logical interconnect group. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logical-interconnect-groups URI: /rest/logical-interconnect-groups/{id} Method API GET Gets a logical interconnect group. Parameter Attributes Description Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logical-interconnect-groups Response Codes REST API Response Codes Examples Update an existing logical interconnect group by adding an uplink set "EnetUplink1" with an Ethernet network on port X5 of the interconnects in bays 1 and 2: PUT https://{appl}/rest/logical-interconnect-groups/dce3fc90-873e-48f7-8340-cc927d625b16 Request body: { "category" : null, "created" : null, "description" : null, "eTag" : null, "uplinkSets" : [ { "logicalPortConfigInfos" : [ { "desiredSpeed" : "Auto", "logicalLocation" : { "
logical-interconnect-groups { "relativeValue" : 1, "type" : "Enclosure" } ] }, "permittedInterconnectTypeUri" : "/rest/interconnect-types/46d7ffad-4424-4e36-acf3-b379c3116206" }, { "logicalDownlinkUri" : null, "logicalLocation" : { "locationEntries" "type" : "Bay" }, { "relativeValue" : 1, "type" : "Enclosure" } ] }, "permittedInterconnectTypeUri" : null }, { "logicalDownlinkUri" : null, "logicalLocation" : { "locationEntries" "type" : "Bay" }, { "relativeValue" : 1, "type" : "Enclosure" } ] }, "permittedI
logical-interconnect-groups "permittedInterconnectTypeUri" : null } ] }, "type" : "logical-interconnect-group", "uri" : "/rest/logical-interconnect-groups/dce3fc90-873e-48f7-8340-cc927d625b16" } URI: /rest/logical-interconnect-groups/{id}/settings/{settingsId} Method API GET Gets the interconnect settings for a logical interconnect group. Parameter Attributes Description Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logical-interconnect-groups Properties status: category: name: created: sampleCount: enableTelemetry: uri: modified: state: eTag: sampleInterval: logical-interconnect-groups.html[10/17/2013 10:35:26 AM] description: Overall health status of the resource.
logical-interconnect-groups type: description: created: stackingHealth: uplinkSets: 300 minimum: 1 type: integer description: Identifies the resource type. This field must be set to 'telemetry-configuration'. type: string description: Brief description of the resource type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
logical-interconnect-groups relativeValue: nativeNetworkUri: reachability: integer type: string description: The reachability of the uplink set group.
logical-interconnect-groups type: description: The type of the location type: string enum: relativeValue: modified: state: interconnectMapTemplate: true type: array required: true type: array description: The relative value of the location -- Type:Enclosure, Relative value:1; Type:Bay, Relative values:1 to 8; Type:Port, Relative values:Downlink Ports:D1 is 1, D2 is 2, ....,D15 is 15, D16; Uplink Ports:X1 is 17, X2 is 18, ....,X9 is 25, X10 is 26.
logical-interconnect-groups locationEntries: description: A set of logical locations type: array Items type: description: The type of the location type: string enum: relativeValue: permittedInterconnectTypeUri: ethernetSettings: Port Bay Enclosure description: The relative value of the location -- Type:Enclosure, Relative value:1; Type:Bay, Relative values:1 to 8; Type:Port, Relative values:Downlink Ports:D1 is 1, D2 is 2, ....,D15 is 15, D16; Uplink Ports:X1 is 17, X2 is 18, ....
logical-interconnect-groups name: created: enableNetworkLoopProtection: enableFastMacCacheFailover: uri: enableIgmpSnooping: state: eTag: modified: dependentResourceUri: category: type: logical-interconnect-groups.html[10/17/2013 10:35:26 AM] maximum: 30 minimum: 1 description: A user friendly name type: string readonly: true description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
logical-interconnect-groups id: description: snmpConfiguration: description: Ignore this because it is not needed, and it will be taken out later. type: string readonly: true description: Brief description of the resource type: string description: The SNMP configuration for the logical interconnect group.
logical-interconnect-groups eTag: snmpAccess: trapDestinations: type: string description: Entity tag/version ID of the resource, the same value that is returned in the ETag header on a GET of the resource type: string description: The access list allowed for GET operations type: array description: The list of configured trap destinations type: array Items enetTrapCategories: vcmTrapCategories: trapSeverities: communityString: fcTrapCategories: trapDestination: description: Filter th
logical-interconnect-groups MultiEnclosure description: type: string required: true description: Brief description of the resource type: string LogicalInterconnectGroupCollection type: object Properties count: category: created: prevPageUri: uri: modified: start: eTag: nextPageUri: members: description: The actual number of resources returned in the specified page type: integer description: Resource category used for authorizations and resource type groupings type: string desc
logical-interconnect-groups status: category: eTag: name: created: type: description: uri: uplinkSets: description: Overall health status of the resource. The following are the valid values for the status of the resource:Unknown - should be avoided, but there may be rare occasions where status is Unknown; OK - indicates normal/informational behavior; Disabled - indicates that a resource is not operational; Warning needs attention soon; Critical - needs immediate attention.
logical-interconnect-groups relativeValue: nativeNetworkUri: reachability: integer type: string description: The reachability of the uplink set group.
logical-interconnect-groups Items type: description: enum: relativeValue: modified: state: true type: array required: true type: array Port Bay Enclosure type: string description: The relative value of the location -Type:Enclosure, Relative value:1; Type:Bay, Relative values:1 to 8; Type:Port, Relative values:Downlink Ports:D1 is 1, D2 is 2, ....,D15 is 15, D16; Uplink Ports:X1 is 17, X2 is 18, ....,X9 is 25, X10 is 26.
logical-interconnect-groups sampleCount: enableTelemetry: uri: modified: state: eTag: sampleInterval: type: description: interconnectMapTemplate: YYYY-MM-DDThh:mm:ss.
logical-interconnect-groups interconnectMapEntryTemplates: description: Array of interconnect map associated with the Logical Interconnect Group type: array Items logicalDownlinkUri: logicalLocation: description: Logical downlink URI readonly: true type: string description: Logical location type: object Properties locationEntries: description: A set of logical locations type: array Items type: description: enum: relativeValue: permittedInterconnectTypeUri: ethernetSettings: Port
logical-interconnect-groups type: string enum: status: igmpIdleTimeoutInterval: macRefreshInterval: name: created: enableNetworkLoopProtection: enableFastMacCacheFailover: uri: enableIgmpSnooping: logical-interconnect-groups.html[10/17/2013 10:35:26 AM] Ethernet FibreChannel readonly: true description: Overall health status of the resource.
logical-interconnect-groups state: eTag: modified: dependentResourceUri: category: type: id: description: stackingHealth: logical-interconnect-groups.
logical-interconnect-groups type: object Properties status: category: name: readCommunity: created: enabled: uri: modified: systemContact: description: Overall health status of the resource.
logical-interconnect-groups type: array Items enetTrapCategories: vcmTrapCategories: trapFormat: description: Filter the traps for this trap destination by the list of configured Ethernet traps type: array description: Filter the traps for this trap destination by the list of configured VCM traps type: array description: The trap format (SNMP version) for this trap destination default: SNMPv1 enum: communityString: fcTrapCategories: trapDestination: SNMPv1 SNMPv2 type: string descri
logical-interconnect-groups attention. category: description: created: uri: modified: state: type: string description: Resource category used for authorizations and resource type groupings type: string description: Brief description of the resource type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
logical-interconnect-groups macRefreshInterval: name: created: enableNetworkLoopProtection: enableFastMacCacheFailover: uri: enableIgmpSnooping: state: eTag: modified: logical-interconnect-groups.
logical-interconnect-groups dependentResourceUri: category: type: id: description: type: name: description: The URI which the setting will be applied to. This returned value will be either logical interconnect or logical interconnect template URI. type: string readonly: true description: Resource category used for authorizations and resource type groupings type: string description: Identifies the resource type. This field must be set to 'EthernetInterconnectSettings'.
logical-interconnect-groups enabled: uri: modified: systemContact: description: Used to enable/disable SNMP default: false type: boolean description: The canonical URI of the resource type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
logical-interconnect-groups default: trapFormat: type: string description: The trap format (SNMP version) for this trap destination default: SNMPv1 type: string enum: type: description: SNMPv1 SNMPv2 description: Identifies the resource type. This field must be set to 'snmp-configuration'.
logical-interconnect-groups vcmTrapCategories: enetTrapCategories: fcTrapCategories: type: array description: Filter the traps for this trap destination by the list of configured VCM traps type: array description: Filter the traps for this trap destination by the list of configured Ethernet traps type: array description: Filter the traps for this trap destination by the list of configured Fibre Channel traps type: array logical-interconnect-groups.
logical-interconnects HP OneView REST API Reference Updated: October 16, 2013 4:31 MDT logical-interconnects This resource manages logical interconnects. A logical interconnect aggregates one or more interconnects with a common configuration, providing L2/L3 Ethernet and Fibre Channel connectivity to a set of downlinks and uplinks. Downlinks provide connectivity to servers. Uplinks provide connectivity to data center interconnect infrastructure and corresponding network resources.
logical-interconnects count Optional Optional parameter that specifies the number of resources to return from each API invocation. The number of resources returned on each call is referred to as a page. If you specify a count, the API attempts to return the specified number of resources, however this may be limited due to response time constraints and/or actual number of resources available to return.
logical-interconnects DELETE Removes an interconnect from a location. Parameter Attributes Description location Required The location of the interconnect to be removed Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logical-interconnects REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logical-interconnects REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logical-interconnects GET Gets the installed firmware for a logical interconnect. Parameter Attributes Description Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logical-interconnects PUT Updates the SNMP configuration of a logical interconnect. Changes to the SNMP configuration are asynchronously applied to all managed interconnects. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logical-interconnects Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Request Body Attributes Description SwitchDumpGenerationInfo Required The interconnect support dump generation request data.
logical-interconnects Header REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logical-interconnects Response Codes REST API Response Codes Examples Update the port monitor configuration on the logical interconnect that matches ID d0432852-28a7-4060-ba49-57ca973ef6c2: PUT https://{appl}/rest/logical-interconnects/d0432852-28a7-4060-ba49-57ca973ef6c2/port-monitor URI: /rest/logical-interconnects/{lsId}/telemetry-configurations/{tcId} Method API PUT Updates the telemetry configuration of a logical interconnect.
logical-interconnects 459f-89cb-8c6c98766c06 LogicalInterconnect description: A logical interconnect aggregates one or more interconnects with a common configuration and the goal of providing both L2/L3 Ethernet and Fibre Channel connectivity to a set of downlinks and uplinks. type: object Properties status: category: stackingHealth: description: Overall health status of the resource.
logical-interconnects location: description: The location to which this entry applies represented as a collection of name:value pairs. For example, an interconnect in a C-Class enclosure will be described as:ENCLOSURE:{enclosure uri}, BAY:{bay number}. type: object Properties locationEntries: description: A set of location entries type: array Items type: description: Location type.
logical-interconnects associated logical interconnect group. 'NotConsistent' means that logical interconnect no longer has a configuration that is consistent with the associated logical interconnect group. type: string enum: portMonitor: CONSISTENT NOT_CONSISTENT description: The port monitor configuration type: object Properties status: category: analyzerPort: description: Overall health status of the resource.
logical-interconnects interconnectUri: portName: interconnectName: bayNumber: description: created: enablePortMonitor: monitoredPorts: description: The URI of the interconnect that the analyzer or monitored ports are defined on type: string description: The name of the Analyzer port as it appears on the interconnect faceplate, for example 'X1'.
logical-interconnects 'AnalyzerPort' type: string enum: portUri: interconnectUri: portName: interconnectName: bayNumber: uri: state: eTag: modified: type: name: telemetryConfiguration: logical-interconnects.
logical-interconnects Properties status: category: name: created: sampleCount: enableTelemetry: uri: modified: state: eTag: logical-interconnects.html[10/17/2013 10:35:29 AM] description: Overall health status of the resource.
logical-interconnects sampleInterval: type: description: name: state: snmpConfiguration: Telemetry sample interval in seconds default: 300 required: true maximum: 300 minimum: 1 type: integer description: Identifies the resource type. This field must be set to 'telemetry-configuration'.
logical-interconnects enabled: uri: modified: systemContact: pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
logical-interconnects fcTrapCategories: trapDestination: description: Filter the traps for this trap destination by the list of configured Fibre Channel traps type: array description: The trap destination IP address or host name default: trapFormat: type: string description: The trap format (SNMP version) for this trap destination default: SNMPv1 type: string enum: type: description: modified: ethernetSettings: SNMPv1 SNMPv2 description: Identifies the resource type.
logical-interconnects macRefreshInterval: name: created: enableNetworkLoopProtection: enableFastMacCacheFailover: uri: enableIgmpSnooping: state: eTag: modified: logical-interconnects.
logical-interconnects dependentResourceUri: category: type: id: description: uri: type: description: format: YYYY-MM-DDThh:mm:ss.sssZ description: The URI which the setting will be applied to. This returned value will be either logical interconnect or logical interconnect template URI. type: string readonly: true description: Resource category used for authorizations and resource type groupings type: string description: Identifies the resource type.
logical-interconnects uri: modified: state: description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: The canonical URI of the resource type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
logical-interconnects macRefreshInterval: name: created: enableNetworkLoopProtection: enableFastMacCacheFailover: uri: enableIgmpSnooping: state: eTag: modified: dependentResourceUri: logical-interconnects.
logical-interconnects template URI. category: type: id: description: type: name: type: string readonly: true description: Resource category used for authorizations and resource type groupings type: string description: Identifies the resource type. This field must be set to 'EthernetInterconnectSettings'. type: string description: Ignore this because it is not needed, and it will be taken out later.
logical-interconnects enum: force: command: sppUri: type: string sppName: type: string interconnectUri: type: string deviceType: type: string installedFw: type: string desiredFw: type: string updateFlagDesc: type: string interconnectName: type: string description: For force Firmware UPDATE/STAGE type: boolean description: Operation type: string enum: fwBaseline: sppUri: sppName: STAGE ACTIVATE UPDATE NONE required: true description: Firmware version ID type: str
logical-interconnects valid: errorMessage: description: Logical Interconnect is in valid state for firmware or not type: boolean description: Error message encountered in validation type: string LILoginRedistribute type: object Properties uplinkSets: description: A list of uplink set URIs that this logical interconnect contains type: array required: true LogicalInterconnectCollection type: object Properties count: category: created: prevPageUri: uri: modified: description: The a
logical-interconnects start: eTag: nextPageUri: members: format: YYYY-MM-DDThh:mm:ss.
logical-interconnects type: location: string description: The location to which this entry applies represented as a collection of name:value pairs. For example, an interconnect in a C-Class enclosure will be described as:ENCLOSURE: {enclosure uri}, BAY:{bay number}. type: object Properties locationEntries: description: A set of location entries type: array Items type: description: enum: value: permittedInterconnectTypeUri: interconnects: created: enclosureUris: logical-interconnects.
logical-interconnects fusionDomainUri: description: logicalInterconnectGroupUri: state: type: array description: The HP OneView domain URI required: true type: string description: Brief description of the resource type: string description: The logical interconnect group URI type: string description: The current resource state of the Logical Interconnect. The supported values are enumerated in the table below.
logical-interconnects enum: portHealthStatus: type: string description: Indicates if the port is operating normally, has been disabled, or has encountered any errors or warnings enum: portMonitorConfigInfo: interconnectName: portName: interconnectUri: bayNumber: description: created: logical-interconnects.html[10/17/2013 10:35:29 AM] Normal Warning Error Disabled type: string description: Indicates the mode this port is in.
logical-interconnects enablePortMonitor: monitoredPorts: description: Enables or disables port monitoring default: false required: true type: boolean description: List of all monitored ports type: array Items portStatus: description: enum: portHealthStatus: string description: Indicates if the port is operating normally, has been disabled, or has encountered any errors or warnings interconnectName: portName: interconnectUri: logical-interconnects.
logical-interconnects bayNumber: uri: state: eTag: modified: type: name: telemetryConfiguration: description: The interconnect bay number that the analyzer or monitored ports reside on type: integer description: The canonical URI of the resource type: string description: Current state of the resource type: string description: Entity tag/version ID of the resource, the same value that is returned in the ETag header on a GET of the resource type: string description: Date and time whe
logical-interconnects enableTelemetry: uri: modified: state: eTag: sampleInterval: type: description: type: ethernetSettings: logical-interconnects.
logical-interconnects type: object Properties interconnectType: description: The type of the network this will be used for default: Ethernet type: string enum: status: igmpIdleTimeoutInterval: macRefreshInterval: name: created: enableNetworkLoopProtection: enableFastMacCacheFailover: logical-interconnects.html[10/17/2013 10:35:29 AM] Ethernet FibreChannel readonly: true description: Overall health status of the resource.
logical-interconnects uri: enableIgmpSnooping: state: eTag: modified: dependentResourceUri: category: type: id: description: snmpConfiguration: default: true type: boolean description: The canonical URI of the resource type: string description: Internet Group Management protocol (IGMP) allows modules to monitor the IGMP IP multicast membership activities.
logical-interconnects indicates normal/informational behavior; Disabled - indicates that a resource is not operational; Warning needs attention soon; Critical - needs immediate attention.
logical-interconnects type: array Items enetTrapCategories: vcmTrapCategories: trapFormat: description: Filter the traps for this trap destination by the list of configured Ethernet traps type: array description: Filter the traps for this trap destination by the list of configured VCM traps type: array description: The trap format (SNMP version) for this trap destination default: SNMPv1 enum: communityString: fcTrapCategories: trapDestination: SNMPv1 SNMPv2 type: string description:
logical-interconnects type: total: type: string description: The total number of resources that would be returned from the query (including any filters), without pagination or enforced resource limits type: integer description: Identifies the resource type. This field must be set to 'LogicalInterconnectCollection'. type: string PortMonitor type: object Properties status: category: analyzerPort: description: Overall health status of the resource.
logical-interconnects interconnectUri: portName: interconnectName: bayNumber: description: created: enablePortMonitor: monitoredPorts: type: string description: The URI of the interconnect that the analyzer or monitored ports are defined on type: string description: The name of the Analyzer port as it appears on the interconnect faceplate, for example 'X1'.
logical-interconnects enum: portUri: interconnectUri: portName: interconnectName: bayNumber: uri: state: eTag: modified: type: name: type: string description: The URI of the analyzer/monitored port(s) type: string description: The URI of the interconnect that the analyzer or monitored ports are defined on type: string description: The name of the Analyzer port as it appears on the interconnect faceplate, for example 'X1'.
logical-interconnects Properties status: category: name: created: sampleCount: enableTelemetry: uri: modified: state: description: Overall health status of the resource. The following are the valid values for the status of the resource:Unknown - should be avoided, but there may be rare occasions where status is Unknown; OK - indicates normal/informational behavior; Disabled - indicates that a resource is not operational; Warning - needs attention soon; Critical - needs immediate attention.
logical-interconnects eTag: sampleInterval: type: description: description: Entity tag/version ID of the resource, the same value that is returned in the ETag header on a GET of the resource type: string description: Telemetry sample interval in seconds default: 300 required: true maximum: 300 minimum: 1 type: integer description: Identifies the resource type. This field must be set to 'telemetry-configuration'.
logical-interconnects type: string TrapDestination type: object Properties trapDestination: description: The trap destination IP address or host name type: string default: communityString: trapFormat: description: Authentication string for the trap destination type: string default: public description: The trap format (SNMP version) for this trap destination type: string enum: trapSeverities: vcmTrapCategories: enetTrapCategories: fcTrapCategories: logical-interconnects.
logical-downlinks HP OneView REST API Reference Updated: October 16, 2013 4:31 MDT logical-downlinks This resource manages logical downlinks. A logical downlink represents the set of networks and downlink capabilities available for connections at a specific interconnect map location. If multiple interconnect map locations support the same set of networks and downlink capabilities, they all refer to the same logical downlink. The REST API (GET) supports an 'accept-language' in the request header.
logical-downlinks generally functional when used in simple cases, restrictions might be noted in the implementation description. A general filter/query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request. The default is no filter (all resources are returned). Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logical-downlinks and filtering, and constrained by start and count parameters. Parameter Attributes Description start Optional The 0-based index of the first resource to return (start=0 starts with the first available resource). If the specified count does not return all resources within the maximum allowed time (see count), use the start parameter to view additional resource pages. The default value for start is 0 (first available resource).
logical-downlinks URI: /rest/logical-downlinks/{id} Method API GET Gets a logical downlink. Parameter Attributes Description Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logical-downlinks LogicalDownlink description: A logical downlink represents the set of networks and downlink capabilities available for connections at a specific interconnect map location. If multiple interconnect map locations support the same set of networks and dowlink capabilities, they all refer to the same logical downlink.
logical-downlinks Unknown eTag: downlinkCapabilities: category: type: minNetworks: description: description: Entity tag/version ID of the resource, the same value that is returned in the ETag header on a GET of the resource type: string description: The set of all supported downlink capabilities for a logical downlink type: array description: Resource category used for authorizations and resource type groupings type: string description: Identifies the resource type.
logical-downlinks start: eTag: nextPageUri: members: pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])? Z type: string format: YYYY-MM-DDThh:mm:ss.
logical-downlinks modified: state: description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[05][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: The current resource state of the Logical Downlink. The supported values are enumerated in the table below.
uplink-sets HP OneView REST API Reference Updated: October 16, 2013 4:31 MDT uplink-sets This resource manages uplink sets. Interconnect uplinks are grouped into an uplink set and managed as a unit, with an assigned set of one or more networks. The traffic carried over the uplinks is determined by the network assignment of the uplink set. Uplink sets can support either Ethernet or Fibre Channel networks.
uplink-sets with the oldest entry first. Experimental filter This parameter is experimental for this release: While generally functional when used in simple cases, restrictions might be noted in the implementation description. A general filter/query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request. The default is no filter (all resources are returned).
uplink-sets Request Body Attributes Description UplinkSet Required The uplink set to be updated Response Description TaskResourceV2 An object that can be used to track the progress of the update uplink set operation to completion Response Codes REST API Response Codes Examples Update a uplink set that matches ID 9b8f7ec0-52b3-475e-84f4-c4eac51c2c20 using the supplied resource information: PUT https://{appl}/rest/uplink-sets/9b8f7ec0-52b3-475e-84f4-c4eac51c2c20 GET Gets an uplink set.
uplink-sets networkUris: status: name: description: logicalInterconnectUri: connectionMode: description: A set of network URIs assigned to the uplink set. The list can be empty but not null. required: true type: array description: Overall health status of the resource.
uplink-sets Reachable RedundantlyReachable state: description: The current resource state of the Uplink Set. The supported values are enumerated in the table below.
uplink-sets category: type: primaryPortLocation: required: true type: array description: Resource category used for authorizations and resource type groupings type: string description: Identifies the resource type. This field must be set to 'uplink-set'. type: string description: The Ethernet primary failover port type: object Properties locationEntries: description: A set of location entries type: array Items type: description: Location type.
uplink-sets count: category: created: prevPageUri: uri: modified: start: eTag: nextPageUri: members: description: The actual number of resources returned in the specified page type: integer description: Resource category used for authorizations and resource type groupings type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
uplink-sets enum: value: name: connectionMode: nativeNetworkUri: modified: created: uri: eTag: fcNetworkUris: reachability: description: The value associated with corresponding location type type: string type: string description: The Ethernet uplink failover mode Auto Failover type: string required: true description: The network that is designated as the native network. All external untagged traffic which ingresses the uplink set will be placed on this network.
uplink-sets logicalInterconnectUri: manualLoginRedistributionState: type: string description: The URI of the logical interconnect to which the uplink set is associated required: true type: string description: The current state of Manual Login Redistribution enum: networkType: Supported NotSupported Distributing Distributed DistributionFailed type: string required: true description: The network type carried by the uplink set enum: portConfigInfos: Ethernet FibreChannel type: string
uplink-sets category: type: description: total: type: required: true type: array description: Resource category used for authorizations and resource type groupings type: string description: Identifies the resource type. This field must be set to 'uplink-set'.
ethernet-networks HP OneView REST API Reference Updated: October 16, 2013 4:30 MDT ethernet-networks The Ethernet networks resource provides APIs for managing Ethernet Networks. An Ethernet network is an L2/L3 network supporting 802.1Q/VLAN encapsulation. It is a shared resource and available to all logical interconnects. It is directly associated with a connection template governing the bandwidth permitted to connections which use the network.
ethernet-networks "vlanId":"10", "purpose":"General", "name":"vlan10", "smartLink":false, "privateNetwork":false, "connectionTemplateUri":null, "type":"ethernet-network" } GET Gets a default or paginated collection of Ethernet networks. The collection is based on optional sorting and filtering, and constrained by start and count parameters. Parameter Attributes Description start Optional The 0-based index of the first resource to return (start=0 starts with the first available resource).
ethernet-networks If default query response time is below expectation, the user can paginate two or more times to reduce the response time by setting count to a desired number of Ethernet network resources to be returned for each page. The next/previous getters in the responded collection DTO is used to get the query statement URI for the next resources to retrieve or the previous resources retrieved. Pagination query terminates when next query URI is NULL.
ethernet-networks GET Gets an Ethernet network Parameter Attributes Description Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
ethernet-networks Response Description TaskResourceV2 An object that can be used to track the update Ethernet network operation to completion Response Codes REST API Response Codes Examples Update an Ethernet network with the name "vlan10b": Before doing an update, please do a GET of the network to obtain the required eTag value and use it in the request body.
ethernet-networks created: uri: vlanId: modified: state: type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[09][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: The canonical URI of the resource type: string description: The Virtual LAN (VLAN) identification number assigned to the network. The VLAN ID must be unique.
ethernet-networks privateNetwork: connectionTemplateUri: category: type: smartLink: name: description: When enabled, the network is configured so that all downlink (server) ports connected to the network are prevented from communicating with each other within the logical interconnect. Servers on the network only communicate with each other through an external L3 router that redirects the traffic back to the logical interconnect.
ethernet-networks created: prevPageUri: uri: modified: start: eTag: nextPageUri: members: type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])? Z type: string format: YYYY-MM-DDThh:mm:ss.
ethernet-networks description: name: created: uri: vlanId: modified: state: type: integer maximum: 1001 description: Brief description of the resource type: string description: Display name for the resource type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[05][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
ethernet-networks purpose: description: enum: connectionTemplateUri: category: type: smartLink: privateNetwork: ethernet-networks.html[10/17/2013 10:35:33 AM] A description of the network's role within the logical interconnect General Management VMMigration FaultTolerance type: string searchable: true required: true description: The URI of the existing connection template associated with the network. This value must be null when creating a new network.
ethernet-networks total: type: description: The total number of resources that would be returned from the query (including any filters), without pagination or enforced resource limits type: integer description: Identifies the resource type. This field must be set to 'NetworkCollection'. type: string ethernet-networks.
fc-networks HP OneView REST API Reference Updated: October 16, 2013 4:31 MDT fc-networks The Fibre Channel networks resource provides REST APIs for managing Fibre Channel Networks. A Fibre Channel (FC) network is a shared resource and available to any logical interconnect. The logical interconnect assigns the FC network to an uplink set. FC networks are not switched across stacking links within the logical interconnect.
fc-networks functional when used in simple cases, restrictions might be noted in the implementation description. A general filter/query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request. The default is no filter (all resources are returned). Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
fc-networks "autoLoginRedistribution":true, "fabricType":"FabricAttach", "type":"fc-network" } URI: /rest/fc-networks/schema Method API GET Gets the Fibre Channel network schema. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
fc-networks Examples The following example returns the FC network with the specified ID: GET https://{appl}/rest/fc-networks/d5fc4334-78c7-4487-a4eb40739d47ab02 DELETE Deletes a Fibre Channel network. Any deployed connections that are using the network are placed in the 'Failed' state. Parameter Attributes Description Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
fc-networks PUT https://{appl}/rest/fc-networks/d5fc4334-78c7-4487-a4eb40739d47ab02 Request Body: { "eTag":"360141ed-5286-49da-bb27-ab20c4417134", "name":"vsan3a", "connectionTemplateUri":"/rest/connection-templates/b34500f6ab41-4930-ad93-ef2cca9230b2", "linkStabilityTime":"30", "uplinkBandwidth":"Auto", "autoLoginRedistribution":true, "fabricType":"FabricAttach", "type":"fc-network" } FcNetwork description: A Fibre Channel (FC) network supporting external access to Fibre Channel fabrics/SANs type: obj
fc-networks created: uri: modified: state: searchable: true description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](. [0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: The canonical URI of the resource type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
fc-networks connectionTemplateUri: category: type: description: maximum: 1800 minimum: 1 type: integer description: The connection template URI that is associated with this Fibre Channel network. This value must be null when creating a new Fibre Channel network. searchable: true minLength: 0 maxLength: 255 type: string description: Resource category used for authorizations and resource type groupings type: string description: Identifies the resource type.
fc-networks modified: start: eTag: nextPageUri: members: type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])? Z type: string format: YYYY-MM-DDThh:mm:ss.
fc-networks created: uri: modified: state: required: true type: boolean searchable: true description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]: [0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
fc-networks autoLoginRedistribution is false. connectionTemplateUri: category: type: description: total: type: searchable: true default: 30 required: true maximum: 1800 minimum: 1 type: integer description: The connection template URI that is associated with this Fibre Channel network. This value must be null when creating a new Fibre Channel network.
network-sets HP OneView REST API Reference Updated: October 16, 2013 4:31 MDT network-sets This resource manages network sets. A network set is a group of Ethernet L2/L3 networks assigned to one or more connections, giving each single connection access to multiple networks. A network set is a shared resource available to all logical interconnects. It is directly associated with a connection template governing the bandwidth permitted to connections that use the network set.
network-sets filter Experimental This parameter is experimental for this release: While generally functional when used in simple cases, restrictions might be noted in the implementation description. A general filter/query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request. The default is no filter (all resources are returned).
network-sets "nativeNetworkUri":null, "networkUris":[ "/rest/ethernet-networks/0f4aa1ec-c2a9-40dc-bf394963783862cd", "/rest/ethernet-networks/a9533968-29dc-48d9-b3ce2778dcb7c47d" ], "connectionTemplateUri":null, "type":"network-set" } URI: /rest/network-sets/schema Method API GET Gets the JSON schema for the network set. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
network-sets number of resources that match the or , the actual count returned, and the URIs to go to the next page, previous page, or both. If necessary, you can make several requests using the URI for the next or previous page (or different start parameters) to get the desired count. sort Optional The sort order of the returned data set. By default, the sort order is based on the create time, with the oldest entry first.
network-sets REST API Response Codes Examples Get the network set that matches ID f984237c-7450-47a0-820a84518b119c06: GET https://{appl}/rest/network-sets/f984237c-7450-47a0-820a84518b119c06 DELETE Deletes a network set. Any connections which reference the network set and are currently deployed will be placed into a 'Failed' state. Parameter Attributes Description Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
network-sets value and use it in the request body.
network-sets networkUris: status: description: created: nativeNetworkUri: uri: modified: state: description: A set of Ethernet network URIs that will be members of this network set required: true type: array searchable: true description: Overall health status of the resource.
network-sets connectionTemplateUri: category: type: name: description: The URI of the connection template associated with this object type: string searchable: true description: Resource category used for authorizations and resource type groupings type: string description: Identifies the resource type. This field must be set to 'network-set'.
network-sets eTag: nextPageUri: members: description: Entity tag/version ID of the resource, the same value that is returned in the ETag header on a GET of the resource type: string description: URI pointing to the page of resources following the list of resources contained in the specified collection type: string description: An array of Network Sets type: array Items networkUris: status: description: created: nativeNetworkUri: uri: modified: network-sets.
network-sets state: type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: The current resource state of the Network Set. The supported values are enumerated in the table below.
connection-templates HP OneView REST API Reference Updated: October 16, 2013 4:30 MDT connection-templates The connection templates resource provides APIs to manage connection templates. A connection template is associated with one network. Each connection template describes the legal bandwidth range available to all connections utilizing the network. A connection may specify bandwidth which is less than or equal to (but never greater than) the bandwidth range of the connection template.
connection-templates sort Optional The sort order of the returned data set. By default, the sort order is based on the create time, with the oldest entry first. filter Experimental This parameter is experimental for this release: While generally functional when used in simple cases, restrictions might be noted in the implementation description. A general filter/query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request.
connection-templates URI: /rest/connection-templates/schema Method API GET Gets the connection template schema. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
connection-templates Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
connection-templates bandwidth: type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: The bandwidth assigned to the connection-template required: true type: object Properties typicalBandwidth: maximumBandwidth: uri: modified: state: type: name: The typical bandwidth of a network connection, expressed in Mbps required: true type: number description: The maximum bandwidth of a network connection, expressed in Mbps.
connection-templates ConnectionTemplateCollection type: object Properties count: category: created: prevPageUri: uri: modified: start: eTag: nextPageUri: members: description: The actual number of resources returned in the specified page type: integer description: Resource category used for authorizations and resource type groupings type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0
connection-templates values for the status of the resource:Unknown - should be avoided, but there may be rare occasions where status is Unknown; OK - indicates normal/informational behavior; Disabled - indicates that a resource is not operational; Warning - needs attention soon; Critical - needs immediate attention.
connection-templates FCoE bandwidth is 8Gbps. description: state: enum: type: name: total: type: required: true type: number The current resource state of the Connection Template. The supported values are enumerated in the table below. Active Degraded Failed Unknown type: string description: Identifies the resource type. This field must be set to 'connectiontemplate'.
interconnects HP OneView REST API Reference Updated: October 16, 2013 4:31 MDT interconnects This resource provides APIs for managing interconnects. Interconnects are centrally managed by their containing logical interconnect. The interconnect provides a physical view of detailed downlink and uplink port state and configuration, including the current link state, speed, port role (uplink, downlink, or stacking), current pluggable media, power state, and immediate connected neighbor.
interconnects Response Codes REST API Response Codes Examples This example assumes you have 6 interconnects, and want to use pagination to retrieve all 6. pages with the recommended 2 interconnects per page, follow these steps: 1. Get the first page of the 2 interconnects in the domain with their port information: GET https://{appl}/rest/interconnects?start=0&count=2 2. Get the second page: GET https://{appl}/rest/interconnects?start=2&count=2 3.
interconnects PUT Applies or re-applies the current interconnect configuration. Parameter Attributes Description Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
interconnects Response Codes REST API Response Codes Examples Update the port instance on the interconnect that matches ID 9b8f7ec0-52b3-475e-84f4-c4eac51c2c20: PUT https://{appl}/rest/interconnects/9b8f7ec0-52b3-475e-84f4-c4eac51c2c20/ports URI: /rest/interconnects/{id}/ports/{portId} Method API GET Gets an interconnect port. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
interconnects REST API Response Codes Examples Resets the statistics on the interconnect that matches ID 9b8f7ec0-52b3-475e-84f4-c4eac51c2c20: PUT https://{appl}/rest/interconnects/9b8f7ec0-52b3-475e-84f4-c4eac51c2c20/statistics/reset URI: /rest/interconnects/{id}/statistics/{portName} Method API GET Gets the statistics for the specified port name on an interconnect. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
interconnects Response Codes REST API Response Codes Examples Get the list of name server resources for an interconnect that matches ID 9b8f7ec0-52b3-475e-84f4-c4eac51c2c20: GET https://{appl}/rest/interconnects/9b8f7ec0-52b3-475e-84f4-c4eac51c2c20/nameServers Interconnect description: Interconnects are centrally managed by the logical interconnect that contains them.
interconnects enabled: uri: modified: systemContact: format: YYYY-MM-DDThh:mm:ss.sssZ description: Used to enable/disable SNMP default: false type: boolean description: The canonical URI of the resource type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9] [0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
interconnects type: description: category: igmpIdleTimeoutInterval: enableFastMacCacheFailover: enableIgmpSnooping: state: enclosureUri: status: description: enableNetworkLoopProtection: productName: logicalInterconnectUri: subPortCount: networkLoopProtectionInterval: interconnectIP: partNumber: interconnects.html[10/17/2013 10:35:37 AM] Identifies the resource type. This field must be set to 'snmp-configuration'.
interconnects edgeVirtualBridgingAvailable: interconnectLocation: type: string description: Indicates whether or not Edge Virtual Bridging is available on this interconnect type: boolean description: Physical location of the interconnect. For example, identifies the enclosure and the bay which contains this interconnect type: object searchable: true Properties locationEntries: description: A set of location entries type: array Items type: description: Location type.
interconnects Speed_24G Speed_30G Speed_40G Speed_100G model: ports: description: Interconnect model type: string searchable: true description: Ports on the interconnect type: array Items configPortTypes: type: array uri: type: string lagId: type: integer connectorType: type: string operationalSpeed: type: string portStatus: type: enum: string Linked Unlinked Unknown category: type: string associatedUplinkSetObjectId: type: string portStatusReason: type: enum: portId:
interconnects AdminHidden LoopDetected PauseFloodDetected AdminDisabled EkeyMismatch Unpopulated ModuleUnrecognized FailedValidation ModuleUnsupported ModuleIncompatible SmartLink SmartLinkButNoDCC OkUncertified OkNonHP UnsupportedStorage FabricTypeMismatch Ok portNumber: type: integer portStatus: type: string enum: portType: type: string enum: type: Uplink Downlink Stacking Auto description: Identifies the resource type. This field must be set to 'port'.
interconnects created: type: string enabled: type: boolean modified: type: string capability: type: array neighbor: type: object Properties remoteMgmtAddress: type: string remotePortIdType: type: string remoteChassisId: type: string remotePortId: type: string remotePortDescription: type: string remoteMgmtAddressType: type: string remoteSystemCapabilities: type: string remoteType: type: string remoteChassisIdType: type: string remoteSystemName: type: string remot
interconnects interconnects.
interconnects fcStatistics: rfc2665Dot3StatsLateCollisions: type: number rfc2665Dot3StatsMultipleCollisionFrames: type: number rfc1757StatsOctets: type: number rfc2665Dot3InPauseFrames: type: number rfc1213IfOutDiscards: type: number rfc1493Dot1DTpPortInFrames: type: number rfc1757StatsPkts: type: number rfc1757StatsPkts65To127Octets: type: number rfc1493Dot1DPortInDiscards: type: number rfc1213IfOutOctets: type: number rfc2665Dot3StatsSingleCollisionFrames: type: number r
interconnects subportStatistics: fcTotalTxBytes: type: number fcAddressErrors: type: number fcPrimitiveSeqProtocolErrors: type: number fcFramesTruncated: type: number fcBBCreditRRDYFailures: type: number fcFramesTooLong: type: number fcClass3TxFrames: type: number fcLossOfSynchronization: type: number description: Subport statistics type: array Items portNumber: advancedStatistics: description: Port number type: number description: Advanced packet-related statistics such
interconnects portWwn: nodeWwn: symbolicPortName: symbolicNodeName: connectionMap: portType: readonly: true required: true description: The World Wide Name of the server or storage port type: string readonly: true required: true description: The World Wide Name of the server or storage node type: string readonly: true required: true description: The symbolic name of the server or storage port type: string readonly: true required: true description: The symbolic name of the
interconnects connectorType: operationalSpeed: description: category: associatedUplinkSetObjectId: fcPortProperties: type: integer description: The type of the SFP connector readonly: true required: true type: string description: The operational speed readonly: true required: true type: string description: Brief description of the resource type: string description: Resource category used for authorizations and resource type groupings type: string description: The associated
interconnects readonly: enum: state: Internal External Unknown type: string required: true description: The current resource state of the Port. The supported values are enumerated in the table below.
interconnects Auto type: status: portStatus: type: string required: true description: Identifies the resource type. This field must be set to 'port'. type: string description: Overall health status of the resource.
interconnects Unpopulated ModuleUnrecognized FailedValidation ModuleUnsupported ModuleIncompatible SmartLink SmartLinkButNoDCC OkUncertified OkNonHP UnsupportedStorage FabricTypeMismatch Ok name: created: enabled: uri: capability: neighbor: type: string required: true description: Display name for the resource type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
interconnects remoteSystemCapabilities: remoteType: remoteChassisIdType: remoteSystemName: remoteSystemDescription: bayNumber: description: Capabilities of the remote system. Values depend on what type of devcie the remote system is and how it is configured. Typically for a network switch this will say 'bridge,router' type: string description: The type of the remote device.
interconnects Items configPortTypes: uri: lagId: connectorType: operationalSpeed: portStatus: description: The configured port types for the port readonly: true required: true type: array description: The canonical URI of the resource type: string description: The LAG (Link Aggregation Group) ID in which the port participates type: integer readonly: true description: The type of the SFP connector readonly: true required: true type: string description: The operational speed
interconnects OkNonHP UnsupportedStorage FabricTypeMismatch Ok portId: portTypeExtended: type: string required: true description: The ID of the port readonly: true required: true type: string description: The extended information for portType readonly: true enum: state: type: string required: true description: The current resource state of the Port. The supported values are enumerated in the table below.
interconnects portStatus: type: integer description: The subport status for this subport readonly: true enum: portType: type: status: description: portMonitorConfigInfo: portName: interconnectName: interconnects.html[10/17/2013 10:35:37 AM] required: true readonly: true Uplink Downlink Stacking Auto type: string required: true description: Identifies the resource type. This field must be set to 'port'. type: string description: Overall health status of the resource.
interconnects type: fcPortProperties: string description: The properties specific to a Fibre Channel port type: object readonly: true Properties fcfMac: loginsCount: wwnn: principleInterconnectName: logins: neighborInterconnectName: opOnline: wwpn: opOnlineReason: name: created: enabled: modified: capability: neighbor: interconnects.
interconnects required: true type: object Properties remoteMgmtAddress: remotePortIdType: remoteChassisId: remotePortId: remotePortDescription: remoteMgmtAddressType: remoteSystemCapabilities: remoteType: remoteChassisIdType: remoteSystemName: remoteSystemDescription: bayNumber: total: type: description: The management address for the connected device.
interconnects UplinkPortCollection type: object Properties count: category: nextPageUri: prevPageUri: uri: created: start: eTag: members: description: The actual number of resources returned in the specified page type: integer description: Resource category used for authorizations and resource type groupings type: string description: URI pointing to the page of resources following the list of resources contained in the specified collection type: string description: URI pointing to t
interconnects interconnectName: bayNumber: modified: total: type: description: The interconnect name, consisting of the enclosure name and the interconnect location. This is in the format of 'ENCNAME, interconnect 1' type: string description: The interconnect bay number of the interconnect that contains this uplink port type: integer description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.
interconnects fcStatistics: rfc1757StatsRXNoErrors: type: number rfc2665Dot3StatsDeferredTransmissions: type: number rfc2665Dot3StatsInternalMacTransmitErrors: type: number rfc2665Dot3StatsCarrierSenseErrors: type: number rfc1213IfInErrors: type: number rfc2665Dot3ControlInUnknownOpcodes: type: number rfc2233IfHCInMulticastPkts: type: number rfc1213IfOutUcastPkts: type: number rfc2233IfHCOutMulticastPkts: type: number rfc1757StatsCollisions: type: number rfc2233IfHCOutUcastPk
interconnects Properties subportStatistics: fcBBCreditFrameFailures: type: number fcTotalTxFrames: type: number fcLinkFailures: type: number portNumber: type: number fcRxByteRate: type: number fcInvalidTxWords: type: number fcSmoothingOverflowErrors: type: number fcInvalidCRC: type: number fcRxLinkResets: type: number fcTotalRxFrames: type: number fcClass2TxFrames: type: number fcTotalRxBytes: type: number fcFBSYFrames: type: number fcRxFrameRate: type: number fc
interconnects subportCommonStatistics: resetTime: type: number subportNumber: type: number receiveKilobytesPerSec: type: string receivePacketsPerSec: type: string portNumber: type: number receiveNonunicastPacketsPerSec: type: string transmitKilobytesPerSec: type: string receiveKilobitsPerSec: type: string transmitKilobitsPerSec: type: string description: Subport common statistics.
interconnects SubportStatistics type: object Properties subportNumber: subportCommonStatistics: description: SubPort Name. type: number description: Subport common statistics.
interconnects type: string switchPortId: type: name: description: Display name for the resource type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
interconnects connector: vendorName: vendorOui: vendorPartNumber: vendorRevision: portName: description: Pluggable Module connector information. type: string description: Pluggable Module Vendor Name. type: string description: Pluggable Module Vendor Organizationally Unique Identifier. type: string description: Pluggable Module Vendor part number. type: string description: Pluggable Module Vendor revision. type: string description: Pluggable Module port name.
interconnects SwitchDumpDataInfo type: object Properties status: category: created: uri: modified: state: description: Short summary of the operation result. type: string description: Resource category used for authorizations and resource type groupings type: string description: Date and time when the resource was created format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
interconnects SwitchFrmUpgRequest type: object Properties state: description: Operation type: string enum: sppUri: frmVersionId: logicalSwitchId: Applying Activating Applied Activated Active Staging_Failed Activation_Failed Uninitialized description: SPP URI type: string required: true description: Firmware version ID type: string description: Parent logical switch ID type: string InterconnectCollection type: object Properties count: category: created: prevPageUri: uri: mod
interconnects type: members: string type: array Items powerStatus: description: Indicates whether the interconnect is currently powered on or off readonly: true enum: interconnectTypeUri: modified: firmwareVersion: snmpConfiguration: On Off Unknown type: string description: Interconnect type URI, provides access to interconnect model, partnumber, supported firmware version, and port capabilities type: string description: Date and time when the resource was last modified pattern: [1-
interconnects systemContact: pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[05][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
interconnects type: category: igmpIdleTimeoutInterval: portCount: enableFastMacCacheFailover: enableIgmpSnooping: state: description: Resource category used for authorizations and resource type groupings type: string description: IGMP idle timeout interval type: integer description: Number of ports on the interconnect type: integer description: Indicates whether Fast Mac Cache Failover is enabled on this interconnect type: boolean description: Indicates whether IGMP snooping is enabl
interconnects model: edgeVirtualBridgingAvailable: interconnectLocation: description: Interconnect model type: string searchable: true description: Indicates whether or not Edge Virtual Bridging is available on this interconnect type: boolean description: Physical location of the interconnect.
interconnects Speed_40G Speed_100G partNumber: ports: type: string description: Interconnect part number type: string description: Ports on the interconnect type: array Items portHealthStatus: enum: Normal Warning Error Disabled type: string modified: type: string lagId: type: integer connectorType: type: string operationalSpeed: type: string description: type: string category: type: string associatedUplinkSetObjectId: type: string fcPortProperties: type: object Pr
interconnects ModuleIncompatible SmartLink SmartLinkButNoDCC OkUncertified OkNonHP UnsupportedStorage FabricTypeMismatch Ok type: string portNumber: type: integer portStatus: enum: type: portType: enum: type: type: Uplink Downlink Stacking Auto string Identifies the resource type. This field must be set to 'port'.
interconnects enabled: type: boolean uri: type: string capability: type: array neighbor: type: object Properties type: type: string remotePortIdType: type: string remoteChassisId: type: string remotePortId: type: string remotePortDescription: type: string remoteMgmtAddressType: type: string remoteSystemCapabilities: type: string remoteType: type: string remoteChassisIdType: type: string remoteSystemName: type: string remoteSystemDescription: type: string type:
interconnects interconnectId: bayNumber: uri: type: string description: The interconnect id that could be uas as part of a URI type: string description: The interconnect bay number of the interconnect that contains this uplink port type: integer description: The URI of this uplink port type: string interconnects.
interconnect-types HP OneView REST API Reference Updated: October 16, 2013 4:31 MDT interconnect-types An interconnect type associates the following: an interconnect model, part number, uplink and downlink port structure and capabilities, and supported firmware versions. Interconnect types are automatically populated. They cannot be directly created or deleted. Together with an interconnect location, an interconnect type is used to construct an interconnect map.
interconnect-types might be noted in the implementation description. A general filter/query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request. The default is no filter (all resources are returned). Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
interconnect-types Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
interconnect-types downlinkCount: minimumFirmwareVersion: maximumFirmwareVersion: uri: state: description: The number of downlinks for this interconnect type readonly: true required: true type: integer description: The minimum firmware version for this interconnect type readonly: true required: true type: string description: The maximum firmware version for this interconnect type readonly: true required: true type: string description: The canonical URI of the resource type:
interconnect-types readonly: true required: true type: array description: portInfos: Detailed port properties for this interconnect type Items portName: portNumber: downlinkCapable: uplinkCapable: portCapability: The port names, e.g. d1, d2, X1, X2, and so on readonly: true required: true type: string description: The port number, e.g.
interconnect-types count: category: created: prevPageUri: uri: modified: start: eTag: nextPageUri: members: description: The actual number of resources returned in the specified page type: integer description: Resource category used for authorizations and resource type groupings type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
interconnect-types category: description: created: type: minimumFirmwareVersion: maximumFirmwareVersion: uri: state: description: Resource category used for authorizations and resource type groupings type: string description: Brief description of the resource type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]: [0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
interconnect-types Items portName: uplinkCapable: downlinkCapable: portNumber: portCapability: modified: partNumber: interconnect-types.html[10/17/2013 10:35:39 AM] description: The port names, e.g.
interconnect-types downlinkCount: downlinkCapabilities: name: total: type: required: true type: string description: The number of downlinks for this interconnect type readonly: true required: true type: integer description: The set of downlink capabilities for this interconnect type readonly: true required: true type: array description: Display name for the resource type: string description: The total number of resources that would be returned from the query (including any fil
datacenters HP OneView REST API Reference Updated: October 16, 2013 4:37 MDT datacenters The datacenters resource allows you to get the configuration data for one or more datacenters, create a datacenter, specify the datacenter physical content, modify datacenter attributes, or delete a datacenter. A datacenter represents a physically contiguous area in which racks containing IT equipment are located.
datacenters Experimental query This parameter is experimental for this release: While generally functional when used in simple cases, restrictions might be noted in the implementation description. If the query is supported, the following is the way it works. A general query string that narrows the list of resources returned by a multiresource GET (read) request and DELETE (delete) request. The default is no query (all resources are returned).
datacenters Gets all data centers with a uuid that ends with 82fac9caf4f2: https://{appl}/rest/datacenters?filter="uuid matches '%2582fac9caf4f2'" (%25 is the encoded value for the wild character (%), and is required to do partial matches.) POST Adds a data center resource based upon the attributes specified. All attributes without default values must be specified in the POST body. The response contains the data center resource as added to the appliance with default and assigned properties expanded.
datacenters Add a data center including an existing rack: https://{appl}/rest/datacenters Request body: { "name":"MyDatacenter", "width":4000, "depth":5000, "contents":[{ "resourceUri": "/rest/racks/c14294e3", "x":1000, "y":1000 } ] } DELETE Deletes the set of datacenters according to the specified parameters. A filter is required to identify the set of resources to be deleted. The actual deletion will proceed asynchronously.
datacenters URI: /rest/datacenters/schema Method API GET Gets a JSON-formatted schema describing the resource. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description JsonSchema The JSON schema of the resource.
datacenters Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Request Body Attributes Datacenter Required Description Response Description Datacenter The resource as updated in the persistence layer.
datacenters Deletes the data center with id 123: https://{appl}/rest/datacenters/123 URI: /rest/datacenters/{id}/visualContent Method API GET Gets a list of visual content objects describing each rack within the data center. The response aggregates data center and rack data with a specified metric (peak24HourTemp) to provide simplified access to display data for the data center. Parameter Attributes Description metric Optional The metric name of the value to be returned for each rack resource.
datacenters groupings name: currency: deratingType: type: string description: Display name for the resource type: string description: The currency unit for energy costs. default: USD required: true type: string description: The electrical derating type. Values include Custom, None, NaJp. None indicates no derating. NaJp indicates 20 percent derating. Custom enables specification of a specific derating percentage. default: NaJp enum: created: uri: eTag: id: width: datacenters.
datacenters depth: state: deratingPercentage: contents: description: The depth in millimeters of the data center. This is associated with the PhysicalLocation y position. required: true minimum: 1000 type: integer maximum: 50000 description: The current state of the resource. Valid values include Adding, AddError, Configured, CredentialError, Refreshing, RefreshError, Removing, RemoveError, and Unmanaged. readonly: true type: string description: The electrical derating percentage.
datacenters coolingCapacity: modified: defaultPowerLineVoltage: type: coolingMultiplier: costPerKilowattHour: uuid: description: Maximum cooling capacity for the datacenter in watts. minimum: 0 type: integer description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
datacenters type: object Properties name: uri: healthStatus: metric: metricTimeStamp: depth: height: width: inferred: resourceUri: x: y: rotation: description: The display name of the resource. type: string description: The URI of the resource. type: string description: The health status of the resource. type: string description: The metric value associated with the resource. type: number description: The timestamp at which the metric value was observed.
datacenters type: number default: 0 DatacenterList type: object Properties count: category: created: prevPageUri: uri: modified: start: eTag: nextPageUri: members: description: The actual number of resources returned in the specified page type: integer description: Resource category used for authorizations and resource type groupings type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0
datacenters type: array Items status: category: state: name: created: coolingMultiplier: deratingType: datacenters.html[10/17/2013 10:35:40 AM] description: Overall health status of the resource.
datacenters default: enum: width: uri: modified: currency: depth: eTag: deratingPercentage: datacenters.html[10/17/2013 10:35:40 AM] NaJp None Custom NaJp type: string required: true description: The width in millimeters of the data center. This is associated with the PhysicalLocation x position.
datacenters costPerKilowattHour: coolingCapacity: defaultPowerLineVoltage: type: id: contents: required: true type: number description: The energy cost per kilowatt-hour. type: number description: Maximum cooling capacity for the datacenter in watts. type: integer minimum: 0 description: The default power line voltage used for watts/amps translation when voltage is not otherwise available (for example when summarizing power at the rack or data center level).
datacenters rotation: x: uuid: total: type: description: The rotation (degrees) from 0-359 around the center of the resource. default: 0 type: number description: The coordinate of the front left corner of the unrotated resource in the data center layout width axis where the given resource is located. Units are in millimeters. required: true type: number description: The universally unique identifier of the resource.
datacenters Items errorSource: recommendedActions: nestedError: errorCode: details: message: data: associatedTaskUri: percentComplete: taskType: userInitiated: datacenters.
datacenters category: taskStatus: parentTaskUri: stateReason: type: progressUpdates: default: false type: boolean description: Resource category used for authorizations and resource type groupings type: string description: Short summary of the current execution/completion status type: string description: URI of the parent task.
datacenters HAS_A IS_A resourceCategory: resourceUri: totalSteps: name: created: taskState: datacenters.html[10/17/2013 10:35:40 AM] string description: Category of the Resource. type: string description: URI of the Resource. type: string description: Total number of steps to be completed for this task type: integer description: Display name for the task type: string description: Date and time when the resource was created format: YYYY-MM-DDThh:mm:ss.
racks HP OneView REST API Reference Updated: October 16, 2013 4:37 MDT racks A rack is a physical structure that contains IT equipment such as enclosures, servers, power delivery devices and unmanaged devices, in a data center. Describing the physical layout of equipment in racks in your data center simplifies locating specific devices for hands-on-servicing, and enables space/power planning.
racks If the query is supported, the following is the way it works. A general query string that narrows the list of resources returned by a multiresource GET (read) request and DELETE (delete) request. The default is no query (all resources are returned). One advantage query has over filter is that it can have embedded ORs. A single query parameter can do what would take multiple parameters or multiple GET requests using filter. Use query for more complex queries.
racks (%25 is the encoded value for the wild character (%), and is required to do partial matches.) POST Adds a rack resource based upon the attributes specified. All attributes without default values must be specified in the POST body. The response contains the rack resource as added to the appliance with default and assigned properties expanded. The id and uri are assigned by the management appliance and are used to uniquely identify this particular resource.
racks DELETE Deletes the set of racks according to the specified parameters. A filter is required to identify the set of resources to be deleted. The actual deletion will proceed asynchronously. Use the returned task resource to track the completion and any errors that may occur. Parameter Attributes Description filter Experimental This parameter is experimental for this release: While generally functional when used in simple cases, restrictions might be noted in the implementation description.
racks REST API Response Codes Examples GET https://{appl}/rest/racks/schema URI: /rest/racks/{id} Method API GET Gets a single rack resource based upon its uri. Parameter Attributes Description Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description Rack The requested resource.
racks Examples Each rack resource has a uri representation in the form of https://{appl}/rest/racks/{id} Update rack name and size, reset the omitted properties to their default values: https://{appl}/rest/racks/4b4b87e2-eea8-4c90-8eca-b92eaaeecfff Request body: { "id":"4b4b87e2-eea8-4c90-8eca-b92eaaeecfff", "uuid":"4b4b87e2-eea8-4c90-8eca-b92eaaeecfff", "name":"MyRack", "depth":20, "height":30, "width":20 } DELETE Deletes the resource specified by {id}.
racks Response Description EnvironmentalAnalysis EnvironmentalAnalysis Object representing information about the device topology within the rack. Response Codes REST API Response Codes Examples https://{appl}/rest/racks/0ABDE00534F/deviceTopology Rack description: A rack is a physical structure that contains IT equipment such as enclosures, servers, power delivery devices and unmanaged devices, in a data center.
racks uri: eTag: height: width: depth: state: created: modified: id: description: The canonical URI of the resource type: string description: Entity tag/version ID of the resource, the same value that is returned in the ETag header on a GET of the resource type: string description: The height of the rack. Units are in millimeters. default: 2004 minimum: 0 type: integer required: true description: The width of the rack. Units are in millimeters.
racks partNumber: type: rackMounts: readonly: true required: true type: string description: The part number of the rack. type: string searchable: true description: Identifies the resource type. This field must be set to 'Rack'. type: string description: References to the resources contained in the rack.
racks readonly: true type: string RackList type: object Properties count: category: created: prevPageUri: uri: modified: start: eTag: nextPageUri: members: description: The actual number of resources returned in the specified page type: integer description: Resource category used for authorizations and resource type groupings type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9]
racks type: array Items status: category: thermalLimit: name: uHeight: rackMounts: description: Overall health status of the resource. The following are the valid values for the status of the resource:Unknown - should be avoided, but there may be rare occasions where status is Unknown; OK - indicates normal/informational behavior; Disabled - indicates that a resource is not operational; Warning needs attention soon; Critical - needs immediate attention.
racks relativeOrder: mountUri: serialNumber: uri: height: width: depth: eTag: racks.html[10/17/2013 10:35:42 AM] required: true description: Used only for BladeSystem enclosures, the relative order of resources mounted in the rack when topUSlot is not specified. Resources are depicted in order from top-to-bottom starting with one (1) at the top of the rack. This value is derived from the BladeSystem enclosure management link cable connections.
racks created: modified: state: partNumber: type: id: uuid: total: type: type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5] [0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5] [0-9](.
racks description: A read-only environmental analysis object providing an aggregated environmental summary (power capacity, power allocation, peak temperature, etc.) of a resource based upon its configuration and relationships with other resources. type: object Properties inferredPosition: max: peakTemp: peakTempTime: device: description: This resource is (or an associated resource) is being depicted without explicit data indicating its position.
racks modified: state: eTag: type: id: uuid: capacity: type: string description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[05][0-9](.[0-9][0-9][0-9])?Z description: The current state of the resource. Valid values include Adding, AddError, Configured, CredentialError, Refreshing, RefreshError, Removing, RemoveError, and Unmanaged.
racks modified: taskErrors: description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][09][0-9])?Z description: Error messages associated with the task type: array Items errorSource: recommendedActions: nestedError: errorCode: details: message: data: associatedTaskUri: percentComplete: taskType: racks.
racks enum: owner: userInitiated: category: taskStatus: parentTaskUri: stateReason: type: progressUpdates: User Appliance Background type: string description: The name of the user under whose authority the task is running type: string description: If task is the result of an user initiated command, it is TRUE. Otherwise FALSE.
racks type: associatedResource: string type: object Properties resourceName: associationType: description: Name of the Resource. type: string description: Type of Association. enum: resourceCategory: resourceUri: totalSteps: name: created: taskState: racks.html[10/17/2013 10:35:42 AM] type: string description: Category of the Resource. type: string description: URI of the Resource.
power-devices HP OneView REST API Reference Updated: October 16, 2013 4:37 MDT power-devices Power delivery devices describe the electrical power delivery to IT equipment in the data center. A typical power topology in a data center includes power delivery devices such as power feeds, breaker panels, branch circuits, rack power distribution units (and their load segment, outlet bar, outlet components).
power-devices constraints and/or actual number of resources available to return. The results include the total number of resources that match the filter or query, the actual count returned, and the URIs to go to the next page, previous page, or both. If necessary, you can make several requests using the URI for the next or previous page (or different start parameters) to get the desired count. sort Optional The sort order of the returned data set.
power-devices https://{appl}/rest/power-devices?sort=name:asc Gets the power device resource with name test: https://{appl}/rest/power-devices?filter="name='test'" Gets all power devices with a uuid that starts with b0fb8894: https://{appl}/rest/power-devices?filter="uuid matches 'b0fb8894%25'" (%25 is the encoded value for the wild character (%), and is required to do partial matches.
power-devices Add a power device with predefined values: http://{appl}/rest/power-devices Request body: { "uuid":"4b4b87e2-eea8-4c90-8eca-b72eaaeecggf", "name":"MyPdd", "ratedCapacity":40, "deviceType":"PowerFeed", "model":"Main power 6B" } Add a power delivery device which provides power to an existing power device: http://{appl}/rest/power-devices Request body: { "id":"4b4b87e2-eea8-4c90-8eca-b72eaaeecggf", "uuid":"4b4b87e2-eea8-4c90-8eca-b72eaaeecggf", "name":"MyPdd", "ratedCapacity":40, "deviceType":"P
power-devices Each power delivery device resource has a uri representation in the form of https://{appl}/rest/power-devices. Deletes all power device resources with names beginning with 'XYZ': https://{appl}/rest/power-devices?filter="name matches 'XYZ%25'" Deletes all power device resources: https://{appl}/rest/power-devices?filter="id matches '%25'" URI: /rest/power-devices/discover Method API POST Add an HP iPDU and bring all components under management by discovery of its management module.
power-devices force the add by adding the force parameter in the request body for the Add. Request Body { "hostname":"power-device.hp.com", "username":"admin", "password":"admin", "force": true } URI: /rest/power-devices/schema Method API GET Gets a JSON-formatted schema describing the resource. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
power-devices TaskResourceV2 A task resource used to track the progress of the remove operation. Response Codes REST API Response Codes Examples Each resource type has an URL representation in the form of https://{appl}/rest/power-devices/{id} Deletes the power delivery device object with id = 123. https://{appl}/rest/power-devices/123 GET Gets a single power delivery device resource based upon its uri.
power-devices REST API Response Codes Examples Each power delivery device resource has a uri representation in the form of: https://{appl}/rest/power-devices/{id} Update power device name and rated capacity, reset the omitted properties to their default values: https://{appl}/rest/power-devices/4b4b87e2-eea8-4c90-8ecab92eaaeecfff Request body: { "id":"4b4b87e2-eea8-4c90-8eca-b92eaaeecfff", "uuid":"4b4b87e2-eea8-4c90-8eca-b92eaaeecfff", "name":"MyPDD", "ratedCapacity": "4000" } URI: /rest/power-devices/{i
power-devices Header REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Request Body Attributes Description OutletState Required - Outlet power state to be set. Response Description TaskResourceV2 TaskResource representing the power state update operation.
power-devices refreshing the power delivery device. If username and password fields are not specified, the previously established access authorization is used. Response Description TaskResourceV2 TaskResource representing the import task.
power-devices REST API Response Codes Examples https://{appl}/rest/power-devices/{id}/uidState Returns the UID state of the power delivery device with the URI /rest/power-devices/A-B-C that is being managed by the appliance app1.corp.net. https://app1.corp.net/rest/power-devices/A-B-C/uidState PUT Sets the unit identification (UID) light state of the specified power delivery device.
power-devices component of an HP iPDU. Parameter Attributes Description refresh Optional Specifies that if necessary an additional request will be queued to obtain the most recent utilization data for the power delivery device. The response will not include any refreshed data. To track the availability of the newly collected data, monitor the TaskResource identified by the refreshTaskUri property in the response. If null, no refresh was queued.
power-devices endDate minus 24 hours. endDate End date of requested starting time range in ISO 8601 format. When omitted the endDate includes the latest data sample available. If an excessive number of samples would otherwise be returned, the results will be segmented. The caller is responsible for comparing the returned sliceStartTime with the requested startTime in the response.
power-devices /utilization?fields=PeakPower&view=day PowerDeliveryDevice description: Power delivery devices describe the electrical power delivery to IT equipment in the data center. Power delivery devices represent the generic power delivery capabilities of power feeds, breaker panels, branch circuits, PDUs (and their load segment, outlet bar, outlet components).
power-devices firmwareVersion: id: category: lineVoltage: uuid: loadSegmentId: coreId: state: deviceType: description: The firmware version on the iPDU core unit. type: string description: The internal identifier of the resource. readonly: true required: true type: string description: Resource category used for authorizations and resource type groupings type: string description: The line voltage (input) of this power device in volts.
power-devices BreakerPanel BranchCircuit RackPdu RackUps PowerStrip LoadSegment Outlet ratedCapacity: outletId: status: phaseType: type: string required: true description: The rated capacity of this power delivery device in Amps. This may come from the inherent capacity of the device, or by an explicit circuit breaker rating minimum: 0 type: integer required: true description: The outlet index, enumerated starting with one (1), in a discovered power topology.
power-devices partNumber: name: created: type: serialNumber: modified: powerConnections: type: string description: The part number of the power device. type: string searchable: true description: Display name for the resource type: string description: Date and time when the resource was created format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
power-devices AddPowerDeliveryDevice description: Provides information to bring a particular HP Intelligent Power Distribution Unit (iPDU) under management. type: object Properties hostname: username: password: force: description: IP address or host name of an HP Intelligent Power Distribution Unit (iPDU) management processor. type: string description: User name of an administrative account on the iPDU. type: string description: The password for the supplied user name.
power-devices password: force: type: string description: The password for the supplied user name. type: string description: The flag to indicate whether to claim the server if it is already claimed by another management appliance. type: boolean default: false OutletState description: Object that encapsulates the state of an outlet; regarding power and UID light. type: object Properties powerState: description: The outlet power state (i.e., On, Off, Unknown).
power-devices the GET utilization method for a resource to determine the supported metrics for that resource. The list of metrics includes CpuUtilization, CpuAverageFreq, AmbientTemperature, AveragePower, PowerCap, PeakPower, RatedCapacity, DeratedCapacity. metricSamples: type: string required: true description: The set of utilization sample arrays keyed by metric name.
power-devices newestSampleTime: oldestSampleTime: isFresh: format: YYYY-MM-DDThh:mm:ss.sssZ description: The end time of the newest (most recent) sample of any metric for this resource. The format is an extended ISO 8601 String (as GMT) type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9] [0-9])?Z format: YYYY-MM-DDThh:mm:ss.sssZ description: The oldest (earliest in time) sample of any metric for this resource.
power-devices start: eTag: nextPageUri: members: pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])? Z type: string format: YYYY-MM-DDThh:mm:ss.
power-devices state: description: Current state of the iPDU as a whole. type: string enum: partNumber: model: firmwareVersion: id: category: lineVoltage: uuid: loadSegmentId: coreId: power-devices.html[10/17/2013 10:35:43 AM] Configured CredentialError ConfigError description: Part number of the iPDU core unit. type: string description: The model name of the iPDU core unit. type: string description: The firmware version on the iPDU core unit.
power-devices state: deviceType: readonly: true minimum: 0 description: The current state of the resource. Valid values include Adding, AddError, Configured, CredentialError, Refreshing, RefreshError, Removing, RemoveError, and Unmanaged. type: string readonly: true description: The type that this power delivery device represents. default: BranchCircuit enum: ratedCapacity: type: status: phaseType: power-devices.
power-devices enum: eTag: feedIdentifier: model: name: created: outletId: serialNumber: uri: powerConnections: power-devices.html[10/17/2013 10:35:43 AM] Unknown SinglePhase SinglePhaseIntl ThreePhaseWye ThreePhaseDelta ThreePhaseUnknown type: string required: true description: Entity tag/version ID of the resource, the same value that is returned in the ETag header on a GET of the resource type: string description: A user provided power feed identifier string.
power-devices Items deviceConnection: connectionUri: sourceConnection: partNumber: total: type: description: The power supply number of the connection to the resource. type: integer description: The uri of the resource that is connected to the power delivery device. type: string description: An optional connection on the power delivery device. A value of 0 indicates a discovered connection. Manually specified source connections should be greater than zero.
power-devices type: array Items errorSource: recommendedActions: nestedError: errorCode: details: message: data: associatedTaskUri: percentComplete: taskType: A reference to the resource or attribute that applies to an error type: string description: A description of what can be done to rectify the problem type: array description: An array of task errors used when there are multiple errors type: object description: A string code which uniquely identifies the specific error allowing
power-devices userInitiated: category: taskStatus: parentTaskUri: stateReason: type: progressUpdates: description: If task is the result of an user initiated command, it is TRUE. Otherwise FALSE. default: false type: boolean description: Resource category used for authorizations and resource type groupings type: string description: Short summary of the current execution/completion status type: string description: URI of the parent task.
power-devices associationType: description: enum: resourceCategory: resourceUri: totalSteps: name: created: taskState: MANAGED_BY HAS_A IS_A type: string description: Category of the Resource. type: string description: URI of the Resource. type: string description: Total number of steps to be completed for this task type: integer description: Display name for the task type: string description: Date and time when the resource was created format: YYYY-MM-DDThh:mm:ss.
unmanaged-devices HP OneView REST API Reference Updated: October 16, 2013 4:37 MDT unmanaged-devices An unmanaged device is used to manually describe any device, such as a server, enclosure, storage array, networking switch, tape drive, or display that takes up space in a rack or consumes power but cannot otherwise be managed by the appliance.
unmanaged-devices If the query is supported, the following is the way it works. A general query string that narrows the list of resources returned by a multiresource GET (read) request and DELETE (delete) request. The default is no query (all resources are returned). One advantage query has over filter is that it can have embedded ORs. A single query parameter can do what would take multiple parameters or multiple GET requests using filter. Use query for more complex queries.
unmanaged-devices '%2582fac9caf4f2'" (%25 is the encoded value for the wild character (%), and is required to do partial matches.) POST Adds an unmanaged device resource based upon the attributes specified. Use this method to create an unmanaged device to represent resources that consume space within a rack, or consume power from a power delivery device but cannot otherwise be represented by the management appliance. All attributes without default values must be specified in the POST body.
unmanaged-devices Use the returned task resource to track the completion and any errors that may occur. Parameter Attributes Description filter Experimental This parameter is experimental for this release: While generally functional when used in simple cases, restrictions might be noted in the implementation description. A general filter/query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request.
unmanaged-devices Examples GET https://{appl}/rest/unmanaged-devices/schema URI: /rest/unmanaged-devices/{id} Method API GET Gets a single unmanaged device resource based upon its uri. Parameter Attributes Description Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description UnmanagedDevice The requested resource.
unmanaged-devices https://{appl}/rest/unmanaged-devices/{id} Update unmanaged device name, model and device type; reset the omitted properties to their default values: https://{appl}/rest/unmanaged-devices/31e5dcba-b8ac-4f64-bbaa7a4474f11770 Request body: { "id":"31e5dcba-b8ac-4f64-bbaa-7a4474f11770", "uuid":"31e5dcba-b8ac-4f64-bbaa-7a4474f11770", "name": "MyUnmanagedDevice", "model":"Procurve 4200VL", "deviceType":"Server", } DELETE Deletes the resource specified by {id}.
unmanaged-devices occasions where status is Unknown; OK - indicates normal/informational behavior; Disabled - indicates that a resource is not operational; Warning - needs attention soon; Critical - needs immediate attention.
unmanaged-devices maxPwrConsumed: ipv4Address: model: height: type: id: uuid: type: string description: The maximum power consumed by the device in watts. This value is usedfor capacity/consumption analysis and should represent an accurate upper-boundon power consumption. minimum: 0 type: integer description: The IPv4 address of the management processor for the device. type: string searchable: true description: The model information or product name.
unmanaged-devices Z prevPageUri: uri: modified: start: eTag: nextPageUri: members: type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: URI pointing to the page of resources preceding the list of resources contained in the specified collection type: string description: The canonical URI of the resource type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
unmanaged-devices ipv6Address: created: uri: eTag: modified: mac: state: deviceType: ipv4Address: unmanaged-devices.html[10/17/2013 10:35:44 AM] description: Display name for the resource type: string description: The IPv6 address of the management processor for the device. type: string searchable: true description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[05][0-9](.
unmanaged-devices model: height: type: id: maxPwrConsumed: total: type: searchable: true description: The model information or product name. required: true type: string description: The height of the unmanaged device in U-slots. type: integer description: Identifies the resource type. This field must be set to 'UnmanagedDevice'. type: string description: The internal identifier of the resource.
unmanaged-devices pattern: taskErrors: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
unmanaged-devices owner: userInitiated: category: taskStatus: parentTaskUri: stateReason: type: progressUpdates: description: The name of the user under whose authority the task is running type: string description: If task is the result of an user initiated command, it is TRUE. Otherwise FALSE.
unmanaged-devices resourceName: associationType: description: Name of the Resource. type: string description: Type of Association. enum: resourceCategory: resourceUri: totalSteps: name: created: taskState: type: string description: Category of the Resource. type: string description: URI of the Resource.
licenses HP OneView REST API Reference Updated: October 16, 2013 4:15 MDT licenses The licenses resource provides details about product licenses. Licenses can be added to the appliance and retrieved for reporting purposes. API Specifications Create Read /rest/licenses POST GET Update Delete Resource Model License LicenseSummary LicenseList LicenseSummaryList URI: /rest/licenses Method API POST Adds a license to the appliance. Licenses are added to the appliance via a license key.
licenses QBSV C9MA H9P9 8HU3 V7B5 HWWB Y9JL KMPL KCJD NG5Q UVUW JH2E EUUT H42V ENQG 2VCB LK4U R4UR V886 VC9X MQT3 G3AD LVKK 5LRG E2UX GHA3"Order123 Product123 HP_Product_Desc EON123" _35S4X-ZQTZM-KSJ0B-T6AJC-L2P3B POST: https://{appl}/rest/licenses Request body: { "key": "#HP Product 123\nQBSV C9MA H9P9 8HU3 V7B5 HWWB Y9JL KMPL KCJD NG5Q UVUW JH2E EUUT H42V ENQG 2VCB LK4U R4UR V886 VC9X MQT3 G3AD LVKK 5LRG E2UX GHA3\"Order123 Product123 HP_Product_Desc EON123\"_35S4X-ZQTZM-KSJ0B-T6AJC-L2P3B" , "type":"Lice
licenses current release, this must be set to "X-API-Version:3" Response Description LicenseList A paginated list of licenses resources.
licenses or both. If necessary, you can make several requests using the URI for the next or previous page (or different start parameters) to get the desired count. view Required Currently supported view: view=summary filter Experimental Currently supported filter: product Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
licenses additionalKeys: salesOrder: eon: uri: modified: eTag: availableCapacity: key: created: nodes: description: Additional keys that may be embedded in a product license.
licenses nodeName: type: licenseType: true type: string description: User friendly name of the resource assigned to the license type: string description: Identifies the resource type. This field must be set to 'License'. type: string description: The type of license (for example, permanent or unlicensed).
licenses consumedCapacity: unlicensedCount: percentageCompliance: description: Total consumed capacity of all the licenses. This is the difference of total capacity and available capacity for the product type: integer default: 0 description: Nodes that did not consume any license due to unavailability of the capacity. type: integer default: 0 description: Compliance for the licensed product type: number default: 0.
licenses start: eTag: nextPageUri: members: description: The row or record number of the first resource returned in the specified page type: integer description: Entity tag/version ID of the resource, the same value that is returned in the ETag header on a GET of the resource type: string description: URI pointing to the page of resources following the list of resources contained in the specified collection type: string description: List of license resources type: array Items category:
licenses (not yet consumed) key: modified: nodes: type: integer description: This is the product license key type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][09]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
licenses totalCapacity: total: type: description: Total capacity of the license. The quantity of licenses in a license key. type: integer description: The total number of resources that would be returned from the query (including any filters), without pagination or enforced resource limits type: integer description: Identifies the resource type. This field must be set to 'LicenseList'.
licenses eTag: nextPageUri: members: description: Entity tag/version ID of the resource, the same value that is returned in the ETag header on a GET of the resource type: string description: URI pointing to the page of resources following the list of resources contained in the specified collection type: string description: List of LicenseSummary type: array Items product: percentageCompliance: unlicensedCount: uri: availableCapacity: consumedCapacity: totalCapacity: licenses.
licenses total: type: description: The total number of resources that would be returned from the query (including any filters), without pagination or enforced resource limits type: integer description: Identifies the resource type. This field must be set to 'LicenseSummaryList'. type: string licenses.
firmware-drivers HP OneView REST API Reference Updated: October 16, 2013 4:39 MDT firmware-drivers The firmware driver resource manager provides REST APIs to upload an SPP (HP Service Pack for ProLiant) into the repository, retrieve the content of the SPP, and delete from the repository. It also provide an API to retrieve the repository's total disk space as well as the free disk space.
firmware-drivers functional when used in simple cases, restrictions might be noted in the implementation description. A general filter/query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request. The default is no filter (all resources are returned). Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
firmware-drivers Method API GET Gets the individual firmware baseline resource for the given URI. Note that the view parameter is not currently supported. Parameter Attributes Description view Optional Return a specific subset of the attributes of the resource or collection by specifying the name of a predefined view. The default view is expand (show all attributes of the resource, and all elements of collections or resources).
firmware-drivers DELETE https://{appl}/rest/firmwaredrivers/SPP2012080.2012_0713.57 FwBaseline description: Firmware baseline resource. type: object Properties version: resourceId: modified: releaseDate: baselineShortName: supportedLanguages: category: uuid: description: state: description: The version of the firmware bundle. type: string description: The resource id of the firmware baseline resource.
firmware-drivers isoFileName: xmlKeyName: type: status: swPackagesFullPath: bundleSize: eTag: lastTaskUri: fwComponents: readonly: true type: string description: The full iso file name which includes the '.iso' extension. type: string description: The baseline xml file name for internal use. type: string description: Identifies the resource type. This field must be set to 'firmware-baselines'. type: string description: Overall health status of the resource.
firmware-drivers created: uri: supportedOSList: type: string description: Date and time when the resource was created format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][09][0-9])?Z description: The canonical URI of the resource type: string description: The list of the operating systems supported by this firmware baseline resource.
firmware-drivers start: eTag: nextPageUri: members: format: YYYY-MM-DDThh:mm:ss.
firmware-drivers firmware baseline is associated with at least one resource manager), Removing (the firmware baseline is being removed), RemoveFailed (the firmware baseline remove attempt failed), and Removed (the firmware baseline has been removed). version: bundleSize: xmlKeyName: type: status: supportedLanguages: isoFileName: eTag: lastTaskUri: fwComponents: type: string readonly: true description: The version of the firmware bundle.
firmware-drivers componentVersion: name: swKeyNameList: name: created: modified: supportedOSList: total: type: type: string description: The version of this component. type: string description: The name of this component. type: string description: A list of the software key name for this component.
firmware-drivers totalRepoSize: freeRepoSpace: type: string description: The total repository size in kbytes. type: integer description: The available space in the repository in kbytes. type: integer firmware-drivers.
firmware-bundles HP OneView REST API Reference Updated: October 16, 2013 4:39 MDT firmware-bundles The firmware-bundles resource provides REST APIs for uploading firmware SPP files to the CI appliance. API Specifications Create /rest/firmware-bundles POST Read Update Delete URI: /rest/firmware-bundles Method API POST Upload an SPP ISO image file to the appliance. Parameter Attributes Description file Required The ISO image file as a MultipartFile file to be uploaded.
firmware-bundles curl -m 1200 -k -X POST -H "Accept: application/json" -H "auth: {authentication token}" -H "uploadfilename:${SPP ISO image filename}" -F file="{at character}{fully qualified path to the SPP ISO image filename}" https://{appl}/rest/firmware-bundles For example: curl -m 1200 -k -X POST -H "Accept: application/json" -H "auth:abcdefghijk123" -H "uploadfilename:SPP2013020B.2013_0628.2.iso" -F file="{at character}/var/spps/SPP2013020B.2013_0628.2.iso" https://198.51.100.
appliance HP OneView REST API Reference Updated: October 16, 2013 4:10 MDT appliance The nodeinfo resource manager provides REST APIs to retrieve information about nodes of the appliance.
appliance NodeVersion Contains the node version Response Codes REST API Response Codes Examples Retrieve version of the appliance node. for example: GET https://{appl}/rest/appliance/version, or GET https://{appl}/rest/appliance/nodeinfo/version NodeStatus description: Contains data describing node's status. type: object Properties networkConfigured: memory: memoryUnits: memoryStatusError: cpu: cpuSpeed: cpuSpeedUnits: cpuStatusError: lan: lanUnits: appliance.
appliance lanStatusError: lanLinkStatusError: type: string description: Status is set as error if minimum LAN speed requirements are not met. type: string description: Status is set as error if LAN link is not detected type: string NodeVersion description: Contains node's version details.
appliance build: date: type: platformType: minor: revision: description: Node model number type: string description: Node build number type: string description: Date of build format: [YYYY-MM-DD] type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9] description: Identifies the resource type. This field must be set to 'NodeVersionDto'.
appliance/network-interfaces HP OneView REST API Reference Updated: October 16, 2013 4:10 MDT appliance/network-interfaces The network-interfaces resource manager provides REST APIs to configure and retrieve network, time and locale settings of the appliance.These APIs support operations on multiple NICs configured on the appliance.
appliance/network-interfaces { "activeNode":1, "unconfigure":false, "app1Ipv4Addr":null, "app1Ipv6Addr":null, "app2Ipv4Addr":null, "app2Ipv6Addr":null, "virtIpv4Addr":null, "virtIpv6Addr":null, "app1Ipv4Alias":null, "app1Ipv6Alias":null, "app2Ipv4Alias":null, "app2Ipv6Alias":null, "hostname":"host1.example.
appliance/network-interfaces REST API Response Codes Examples Example to get configuration of all network-interfaces and time and language of the appliance GET https://{appl}/rest/appliance/network-interfaces URI: /rest/appliance/network-interfaces/mac-addresses Method API GET Gets information about unconfigured network interfaces on the appliance. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
appliance/network-interfaces Examples The example below retrieves network settings of a particular NIC identified by MAC address supplied in request parameter GET https://{appl}/rest/appliance/network-interfaces/00:11:22:33:44:55 NetworkWithTimeLocale description: Contains configuration details of NICs along with time and locale of the appliance. type: object Properties locale: description: Locale of the appliance. 'English (United States)' is the only supported appliance locale.
appliance/network-interfaces app2Ipv4Alias: app1Ipv4Addr: ipv6Type: description: Node2 IPv4 alias for management LAN type: string description: Node1 IPv4 address type: string description: IPv6 network type enum: unconfigure: app2Ipv4Addr: app2Ipv6Addr: searchDomains: hostname: ipv4Type: type: string description: This field indicates if this NIC needs to be unconfigured. Primary NIC cannot be unconfigured.
appliance/network-interfaces address Format overrideDhcpDnsServers: device: ipv6Gateway: allowTransientValidationErrors: interfaceName: confOneNode: domainName: app1Ipv4Alias: app1Ipv6Addr: ipv6Subnet: virtIpv6Addr: appliance-network-interfaces.html[10/17/2013 10:35:48 AM] type: array description: Flag indicating whether overriding DHCP provided DNS servers is enabled or not. It must be set to 'false' for static network configuration. type: boolean description: Internal name of NIC.
appliance/network-interfaces ipv4Subnet: activeNode: time: description: IPv4 subnet mask or CIDR bit count type: string description: ID of active node minimum: 1 type: integer maximum: 2 description: This field stores information about date-time, timezone and NTP servers of the appliance.
appliance/network-interfaces unconfigure: allowTransientValidationErrors: bondedTo: confOneNode: activeNode: app2Ipv4Addr: virtIpv4Addr: app2Ipv6Addr: virtIpv6Addr: app1Ipv4Alias: app2Ipv4Alias: app1Ipv6Alias: app2Ipv6Alias: domainName: searchDomains: appliance-network-interfaces.html[10/17/2013 10:35:48 AM] description: This field indicates if this NIC needs to be unconfigured. Primary NIC cannot be unconfigured.
appliance/network-interfaces interfaceName: ipv4Type: type: array description: String describing usage of network interface and shall not be changed. For example: 'Appliance', 'Management' and so on. 'Appliance' is the default name of primary NIC.
appliance/network-interfaces device: type: string description: Internal name of NIC. This property has been deprecated. type: string Mac-Address description: Contains MAC-address and device name details of all NICs on the appliance.
appliance/network-interfaces macAddress: modified: total: type: type: string description: MAC-address of the network interface type: string description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
appliance/device-read-community-string HP OneView REST API Reference Updated: October 16, 2013 4:57 MDT appliance/device-read-community-string The device read community string is used by the appliance to establish SNMP communication with devices managed by the appliance. API Specifications Create Read /rest/appliance/device-read-community-string POST GET URI: /rest/appliance/device-read-community-string Method API GET Retrieves the global community string.
appliance/device-read-community-string REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Request Body Attributes DeviceCommunityString Required Description Response Description void The collection of requested trap destinations.
appliance/eula HP OneView REST API Reference Updated: October 16, 2013 4:10 MDT appliance/eula This resource provides APIs for managing the status of the End User License Agreement (EULA) and related data.
appliance/eula Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description Boolean True if eula display is needed. Otherwise false. Response Codes REST API Response Codes Examples Gets the current state of EULA in the appliance.
appliance/firmware HP OneView REST API Reference Updated: October 16, 2013 4:27 MDT appliance/firmware The firmware resource manager provides REST APIs to upgrade/patch the appliance firmware. It also fields APIs to update HP public key of the appliance. API Specifications Create /rest/appliance/firmware/document-content/{tarFileName}.
appliance/firmware Use this API to get the document content of uploaded file (upgrade image) {tarFileName} default: update.bin {documentType} for ReleaseNotes document: release for example: The following GET request will retrieve you the release notes of the upgrade package. GET https://{appl}/rest/appliance/firmware/documentcontent/.bin/release URI: /rest/appliance/firmware/image Method API POST Uploads upgrade image sent from client. It takes 'MultipartFile' as input.
appliance/firmware Response Codes REST API Response Codes Examples Retrieve upgrade's status for example: GET https://{appl}/rest/appliance/firmware/notification URI: /rest/appliance/firmware/pending Method API GET Gets upgrade information from the uploaded upgrade image Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
appliance/firmware Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description void Response Codes REST API Response Codes Examples Delete data related to upgrade task. for example: DELETE https://{appl}/rest/appliance/firmware/pending URI: /rest/appliance/firmware/verificationKey Method API PUT Updates HP public key of the appliance.
appliance/firmware Response Description VerificationKeyInfo Data containing HP public key in string format Response Codes REST API Response Codes Examples Retrieve HP public key of the appliance for example: GET https://{appl}/rest/appliance/firmware/verificationKey URI: /rest/appliance/firmware/verificationKeyFile Method API PUT Updates HP public key of the appliance. It expects a file containing the key.
appliance/firmware preupgradeTimeout: rebootRequired: estimatedUpgradeTime: readonly: true description: Preupgrade script timeout type: number description: This is set to 'true', if reboot is required once upgrade is done.
appliance/firmware type: string success: type: boolean upgradeDate: description: Upgraded date/time string in ISO 8601 UI format for UTC time-zone type: string appliance-firmware.
appliance/health-status HP OneView REST API Reference Updated: October 16, 2013 4:28 MDT appliance/health-status The health-status resource manager provides APIs to get information about the health of appliance's various components including RAM, Hard disk space, and CPU.
appliance/health-status severity: available: capacity: statusMessage: description: Severity of the health status type: string description: Available capacity of the resource/component, for example: 2GB of disk space is available. type: string description: Total capacity of the resource/component type: string description: Health status message of the resource/component type: string ApplianceHealthStatus description: Contains data describing appliance health.
appliance/health-status header on a GET of the resource type: members: string description: List of ResourceHealthStatus data type: array Items available: capacity: severity: resourceType: resourceId: statusMessage: modified: total: type: description: Available capacity of the resource/component, for example:2GB of disk space is available.
appliance/shutdown HP OneView REST API Reference Updated: October 16, 2013 4:05 MDT appliance/shutdown The shutdown resource provides the API to shutdown or reboot an appliance. API Specifications Create /rest/appliance/shutdown POST Read Update URI: /rest/appliance/shutdown Method API POST Shuts down or reboots the appliance.
appliance/support-dumps HP OneView REST API Reference Updated: October 16, 2013 4:24 MDT appliance/support-dumps This is the support-dumps service for generating and downloading support dumps from an appliance. API Specifications Create /rest/appliance/support-dumps POST /rest/appliance/support-dumps/{dumpFileName}.{suffix} Read Update Delete Resource Model DumpGenerationInfo GET DumpDataInfo URI: /rest/appliance/support-dumps Method API POST Generates the dump.
appliance/support-dumps URI: /rest/appliance/support-dumps/{dumpFileName}.{suffix} Method API GET Downloads the generated dump file to the client. Parameter Attributes Description encrypt Optional Not used anymore Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
appliance/support-dumps directories are /ci/logs/,/var/tmp/,/updatelogs/ and subdirectories of these directories such as /ci/logs/audit/,/var/tmp/test/ product: type: array description: The name of the product for which the directories are included.
appliance/settings HP OneView REST API Reference Updated: October 16, 2013 4:20 MDT appliance/settings This API allows to disable or enable services access (i.e. root shell access) for emergency troubleshooting purposes by Authorized support access Personnel, get service access status information.
appliance/settings Method API GET This API is used to get service access status Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description boolean true if service access is enabled, else false. Response Codes REST API Response Codes Examples GET https://example.com/rest/appliance/settings/serviceaccess appliance-settings.
appliance/trap-destinations HP OneView REST API Reference Updated: October 16, 2013 4:57 MDT appliance/trap-destinations SNMP trap destinations is a service that allows the user to modify settings related to trap destinations in the management appliance. SNMP trap forwarding causes the appliance to send all received SNMP traps to the specified destinations.
appliance/trap-destinations queries. fields Optional Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description TrapDestinationList The collection of requested trap destinations.
appliance/trap-destinations POST Validate whether a host name or IP address is a valid trap destination. If validation fails, it throws an exception identifying the error that occurred. The uri is used to determine if other trap destinations already exist with the specified uri. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
appliance/trap-destinations "communityString": "public" } POST Adds or updates the specified trap forwarding destination. The trap destination associated with the given id will be updated if a trap destination with that id already exists. If the given id is not found, then a trap destination will be created with the given id. Parameter Attributes Description Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
appliance/trap-destinations type: object Properties port: destination: communityString: uri: description: The trap destination port type: integer required: true description: The IP address or host name of the trap destination type: string required: true description: The community string associated with this trap destination type: string required: true description: The canonical URI of the resource.
appliance/trap-destinations start: eTag: members: type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
backups HP OneView REST API Reference Updated: October 16, 2013 4:00 MDT backups The backup resource manager provides REST APIs to backup the appliance, retrieve the status of a backup, cancel a backup, upload a backup file, and download a backup file for off device storage. You must download the backup file after a backup operation successfully completes. You can use the GET API's to poll the status of the backup. Once a backup is created it can not be deleted from the appliance.
backups query string that narrows the list of resources returned by a multiresource GET (read) request and DELETE (delete) request. The default is no query (all resources are returned). One advantage query has over filter is that it can have embedded ORs. A single query parameter can do what would take multiple parameters or multiple GET requests using filter. Use query for more complex queries.
backups Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description void Response Codes REST API Response Codes Examples The following example creates a backup of the appliance. POST https://{appl}/rest/backups/ URI: /rest/backups/archive Method API POST Uploads a backup file onto the appliance.
backups error if a backup, restore, or backup upload is already in progress. Also, it returns an error if the requested backup is not found or an internal error occurs. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description void Response Codes REST API Response Codes Examples The following example downloads a backup file.
backups DELETE Cancels the specified backup in progress. The API returns an error if a backup is not in progress. Parameter Attributes Description force Optional If set to true, the operation completes even if there are network connectivity issues or resource errors. The default is false. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
backups resolutionMessage: percentComplete: modified: downloadStatus: description: Contains a resolution message describing the failure if the backup/restore fails type: string description: The percentage of the backup that has completed minimum: 0 type: integer maximum: 100 description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
backups downloadUserName: uri: platformType: backupType: description: The user name of the user who requested the backup download type: string description: The canonical URI of the resource type: string description: The platform type of the appliance where the backup was taken required: true type: string description: The backup type enum: firmwareVersionMajor: errorParms: status: type: string required: true description: The major version of the firmware installed when the backu
backups created: type: type: string description: Date and time when the resource was created format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](. [0-9][0-9][0-9])?Z description: Identifies the resource type. This field must be set to 'BACKUP'.
backups Z start: eTag: nextPageUri: members: type: string format: YYYY-MM-DDThh:mm:ss.
backups downloadStatus: maximum: 100 description: The backup download status type: string enum: hardwareModel: fullyQualifiedHostName: id: category: compatibilityVersion: errorKey: downloadUserName: platformType: backupType: description: The hardware model of the appliance where the backup was taken required: true type: string description: The fully qualified host name of the system where the backup was taken required: true type: string description: Backup identifier containin
backups firmwareVersionMajor: errorParms: status: type: string required: true description: The major version of the firmware installed when the backup was taken required: true type: string description: Contains parameters to insert into a localized error message if the backup/restore fails type: array description: The status of the backup enum: errorMessage: downloadTime: eTag: taskUri: backupSize: userName: created: backups.
backups type: uri: resolutionKey: downloadUri: total: type: format: YYYY-MM-DDThh:mm:ss.sssZ description: Identifies the resource type. This field must be set to 'BACKUP'.
domains HP OneView REST API Reference Updated: October 16, 2013 4:30 MDT domains This resource provides REST APIs for managing domains.
domains (delete) request. The default is no filter (all resources are returned). Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
domains Response Description Domain The domain resource with the specified ID Response Codes REST API Response Codes Examples Get the domain with the ID 9b8f7ec0-52b3-475e-84f4-c4eac51c2c20: GET https://{appl}/rest/domains/9b8f7ec0-52b3-475e-84f4-c4eac51c2c20 URI: /rest/domains/{id}/ethernetNetworkLimits Method API GET Gets the maximum number of Ethernet networks that can be created in the specified domain.
domains Response Codes REST API Response Codes Examples Get the FC network limits for the domain with the ID 9b8f7ec0-52b3-475e84f4-c4eac51c2c20: GET https://{appl}/rest/domains/9b8f7ec0-52b3-475e-84f4c4eac51c2c20/fcNetworkLimits URI: /rest/domains/{id}/networkSetLimits Method API GET Gets the maximum number of networks that can be added to a network set in the specified domain.
domains name: created: uri: canonicalName: modified: state: description: Display name for the resource type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][09])?Z type: string format: YYYY-MM-DDThh:mm:ss.
domains minNetworks: type: integer readonly: true description: The minimum number of networks that can be defined for the domain type: integer readonly: true DomainCollection type: object Properties count: category: created: prevPageUri: uri: modified: start: eTag: nextPageUri: description: The actual number of resources returned in the specified page type: integer description: Resource category used for authorizations and resource type groupings type: string description: Dat
domains specified collection type: members: string description: An array of domains type: array Items status: category: name: created: uri: canonicalName: modified: state: description: Overall health status of the resource.
domains returned in the ETag header on a GET of the resource type: description: total: type: type: string description: Identifies the resource type. This field must be set to 'domain'. type: string description: Brief description of the resource type: string description: The total number of resources that would be returned from the query (including any filters), without pagination or enforced resource limits type: integer description: Identifies the resource type.
global-settings HP OneView REST API Reference Updated: October 16, 2013 4:23 MDT global-settings The global-settings resource provides APIs and a place to write and read global settings. The settings service is used to store and retrieve name/value pairs which can be read and written by any service in the stack.
global-settings A general query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request. The default is no query (all resources are returned). One advantage query has over filter is that it can have embedded ORs. A single query parameter can do what would take multiple parameters or multiple GET requests using filter. Use query for more complex queries.
global-settings value and so on Response Description Setting Contains the 'setting' object parameters like name, value and so on Response Codes REST API Response Codes Examples These examples add new settings with the specified parameters POST https://{appl}/rest/global-settings { "type":"Setting", "value":"the value", "name":"the-name" } POST https://{appl}/rest/global-settings { "type":"Setting", "name":"setting1", "value":"value1", "state":"state", "description":"description", "status":"status", "ca
global-settings This example adds multiple settings at once POST https://{appl}/rest/global-settings?multiResource=true [ { "type":"Setting", "value":"the value", "name":"the-name" } ] PUT Updates the existing global settings Parameter Attributes Description force Optional If set to true, the operation completes even if there are network connectivity issues or resource errors. The default is false.
global-settings Method API GET Generates the 'setting' JSON formatted schema Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
global-settings Parameter Attributes Description force Optional If set to true, the operation completes even if there are network connectivity issues or resource errors. The default is false. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
global-settings "name":"the-name", "value":"the value" } Setting type: object Properties category: status: name: created: modified: value: uri: state: eTag: description: Resource category used for authorizations and resource type groupings type: string description: Overall health status of the resource.
global-settings type: description: type: string description: Identifies the resource type. This field must be set to 'Setting'.
global-settings specified collection type: members: string description: Lists the settings type: array Items category: status: name: created: modified: value: uri: state: eTag: type: global-settings.html[10/17/2013 10:35:54 AM] description: Resource category used for authorizations and resource type groupings type: string description: Overall health status of the resource.
global-settings description: total: type: type: string description: Brief description of the resource type: string description: The total number of resources that would be returned from the query (including any filters), without pagination or enforced resource limits type: integer description: Identifies the resource type. This field must be set to 'SettingsPaginatedCollection'. type: string global-settings.
restores HP OneView REST API Reference Updated: October 16, 2013 4:02 MDT restores The restore resource manager provides REST APIs to restore an appliance and to get the status of a restore operation. API Specifications Create Read /rest/restores POST GET RestoreResource GET RestoreResourceList /rest/restores/{id} Update Delete Resource Model URI: /rest/restores Method API POST Starts a restore operation from the backup file already uploaded to the appliance.
restores with the first available resource). If the specified count does not return all resources within the maximum allowed time (see count), use the start parameter to view additional resource pages. The default value for start is 0 (first available resource). count Optional Optional parameter that specifies the number of resources to return from each API invocation. The number of resources returned on each call is referred to as a page.
restores RestoreResourceList The status of a restore operation contained within a paginated collection list. Response Codes REST API Response Codes Examples Get the status of any ongoing or completed restore GET https://{appl}/rest/restores/ URI: /rest/restores/{id} Method API GET Gets the status of a restore operation specified by the {id}. The restore status contains details about the restore in progress including the status, start time, progress step and percent complete.
restores type: object Properties resolutionParms: description: Contains parameters to insert into a localized resolution message if the backup/restore fails type: array restoreStartTime: type: hostName: description: The unqualified host name of the system where the backup was taken required: true type: string description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.
restores category: errorKey: type: errorParms: status: required: true type: string description: Resource category used for authorizations and resource type groupings type: string description: Contains the key used to generate a localized error message if the backup/restore fails type: string description: Identifies the resource type. This field must be set to 'RESTORE'.
restores type: string RestoreResourceList type: object Properties count: category: created: prevPageUri: uri: modified: start: eTag: nextPageUri: members: description: The actual number of resources returned in the specified page type: integer description: Resource category used for authorizations and resource type groupings type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
restores Items resolutionParms: description: Contains parameters to insert into a localized resolution message if the backup/restore fails type: array restoreStartTime: type: hostName: description: The unqualified host name of the system where the backup was taken required: true type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]: [0-5][0-9]:[0-5][0-9](.
restores category: errorKey: type: errorParms: status: required: true type: string description: Resource category used for authorizations and resource type groupings type: string description: Contains the key used to generate a localized error message if the backup/restore fails type: string description: Identifies the resource type. This field must be set to 'RESTORE'.
restores resolutionKey: total: type: description: Contains the key used to generate a localized resolution message if the backup/restore fails type: string description: The total number of resources that would be returned from the query (including any filters), without pagination or enforced resource limits type: integer description: Identifies the resource type. This field must be set to 'PaginatedCollectionResource'. type: string restores.
version HP OneView REST API Reference Updated: October 16, 2013 4:05 MDT version The version resource provides the REST API to determine the supported X-API-Version specified in the request header for all the REST API's supported by the appliance. API Specifications Create /rest/version Read Update Delete GET Resource Model VersionInfo URI: /rest/version Method API GET Returns the range of possible API versions supported by the appliance.
version currentVersion: minimum: 1 readonly: true description: The latest supported API version type: integer minimum: 1 readonly: true version.
index/resources HP OneView REST API Reference Updated: October 16, 2013 4:13 MDT index/resources The index/resources resource provides APIs for managing index resources, including retrieving, creating/updating, and deleting index resources. To make searches faster, the index stores an index resource for each resource. Index resources contain normal search parameters such as name, category, status, state, description, and so on. They also contain attributes, with searchable data from the resource.
index/resources when used in simple cases, restrictions might be noted in the implementation description. If the query is supported, the following is the way it works. A general query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request. The default is no query (all resources are returned). One advantage query has over filter is that it can have embedded ORs.
index/resources view Optional Return a specific subset of the attributes of the resource or collection by specifying the name of a predefined view. The default view is expand (show all attributes of the resource, and all elements of collections or resources). fields Optional Specifies which fields/columns should be returned in the response Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
index/resources type: object Properties count: nextPageUri: prevPageUri: start: members: description: Count of Resources for a given query type: integer description: URI of the next page type: string description: URI of the previous page type: string description: Start of IndexResource type: integer description: Lists of IndexResource returned from the query type: array Items status: category: name: created: multiAttributes: uri: index-resources.
index/resources modified: state: eTag: attributes: ownerId: type: description: total: description: Date and time when the resource was last modified. Index service will not update the modified time if it is already set by resource manager. Index service will update only if the modified field is set to null or empty pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]: [0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
index/resources type: members: integer description: Lists of IndexResource returned from the query type: array Items status: category: name: created: multiAttributes: uri: modified: state: eTag: index-resources.html[10/17/2013 10:35:56 AM] description: Overall health status of the resource.
index/resources attributes: ownerId: type: description: total: unFilteredTotal: description: Entity tag/version ID of the resource, the same value that is returned in the ETag header on a GET of the resource type: string description: The attributes for a given resource that has a single value per attribute type: object description: The ID of the user under whose authority the index is running type: string description: Identifies the resource type.
index/resources modified: uri: state: eTag: ownerId: multiAttributes: attributes: type: description: type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: Date and time when the resource was last modified. Index service will not update the modified time if it is already set by resource manager. Index service will update only if the modified field is set to null or empty pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
index/associations HP OneView REST API Reference Updated: October 16, 2013 4:13 MDT index/associations This resource provides APIs for managing parent/child associations between resources. Used for creating, naming, deleting, and searching associations, generating association schema in JSON format, and so on.
index/associations GET https://{appl}/rest/index/associations?parentUri=/uri/1 URI: /rest/index/associations/resources Method API GET Gets the paginated collection of index association objects for X-API-VERSION = 2 or above based upon given parameters Parameter Attributes Description parentUri Optional The URI of the parent resource in the association relationship childUri Optional The URI of the child resource in the association relationship name Optional The name of the association refe
index/associations A general filter/query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request. The default is no filter (all resources are returned). Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
index/associations GET https://{appl}/rest/index/associations/schema Association type: object Properties name: parentUri: childUri: description: The association name of the relationship type: string description: The parent in the relationship type: string description: The child in the relationship type: string Associations type: object Properties total: start: count: members: description: Total number of associations type: integer description: Starting association type: integ
index/associations childUri: type: string description: The child in the relationship type: string AssociationPaginatedCollection type: object Properties count: nextPageUri: prevPageUri: start: members: description: Count of IndexResourceAssociation for a given query type: integer description: URI of the next page. type: string description: URI of the previous page.
index/associations created: multiAttributes: uri: modified: state: eTag: attributes: ownerId: type: description: associationName: childResource: index-associations.html[10/17/2013 10:35:57 AM] type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
index/associations Properties status: category: name: created: multiAttributes: uri: modified: state: eTag: attributes: ownerId: index-associations.html[10/17/2013 10:35:57 AM] description: Overall health status of the resource.
index/associations type: description: total: unFilteredTotal: description: Identifies the resource type. This field must be set to 'IndexResource'.
index/associations uri: state: eTag: ownerId: multiAttributes: attributes: type: description: associationName: childResource: pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
index/associations name: created: modified: uri: state: eTag: ownerId: multiAttributes: attributes: type: description: index-associations.html[10/17/2013 10:35:57 AM] description: Display name for the resource type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
index/trees HP OneView REST API Reference Updated: October 16, 2013 4:13 MDT index/trees The index/trees resource provides APIs for getting index trees for specified searches. Index trees show the hierarchy of relationships for multiple resources.
index/trees count, the API attempts to return the specified number of resources, however this may be limited due to response time constraints and/or actual number of resources available to return. The results include the total number of resources that match the filter or query, the actual count returned, and the URIs to go to the next page, previous page, or both.
index/trees Response Codes REST API Response Codes Examples Below example fetches all the trees GET https://{appl}/rest/index/trees URI: /rest/index/trees/** Method API GET Gets the tree for a specified resource Parameter Attributes Description childDepth Optional The depth of children to return. A depth of 2 would return the given resource's children and the children of its children parentDepth Optional The depth of parents to return.
index/trees Method API GET Gets the tree for a specified resource Parameter Attributes Description childDepth Optional The depth of children to return. A depth of 2 would return the given resource's children and the children of its children parentDepth Optional The depth of parents to return.
index/trees parentDepth Optional The depth of parents to return. A depth of 2 would return the given resource's parents and the parents of its parents treeLimit Optional The number of children and parents per association details Optional If true all the attributes on the index resources will be returned, if false a minimal set will be returned start Optional The 0-based index of the first resource to return (start=0 starts with the first available resource).
index/trees Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
index/trees relationship for multiple resources Response Codes REST API Response Codes Examples Get the tree for a specified resource URI: GET https://{appl}/rest/index/trees/minified/ URI: /rest/index/trees/schema Method API GET Get the tree schema in JSON format Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
index/trees created: modified: uri: state: eTag: ownerId: multiAttributes: attributes: type: description: type: string description: Date and time when the resource was created. Index service will not update the created time if it is already set by resource manager. Index service will update only if the created field is set to null or empty pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9] [0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
index/trees Properties parents: resource: description: The parents of this resource type: object description: The index resource for this tree node type: object Properties category: created: uri: modified: eTag: type: children: description: Resource category used for authorizations and resource type groupings type: string description: Date and time when the resource was created format: YYYY-MM-DDThh:mm:ss.
index/trees type: array Items resource: type: object Properties category: type: string uri: type: string eTag: type: string created: type: string modified: type: string parents: type: object children: type: object TreesPaginatedCollection type: object Properties count: nextPageUri: prevPageUri: start: members: description: Count of IndexResource for a given query type: integer description: URI of the next page. type: string description: URI of the previous page.
index/trees created: uri: modified: eTag: type: parents: children: total: unFilteredTotal: description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][09]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
index/trees children: type: object description: The children of this resource type: object UriTrees type: object Properties resources: total: uriTrees: description: Lists the resources of the trees type: object description: Total number of resources type: integer description: Lists the trees of resources type: array Items treeUri: parents: children: description: The canonical URI of the resource type: string description: The parents of this resource type: object descripti
index/trees type: object Properties rootUri: categories: links: description: Root URI of the resource type: string description: Categorise the nodes based on category of a resource type: object description: Associations of the resources type: array Items parentUri: childUri: index-trees.
index/search-suggestions HP OneView REST API Reference Updated: October 16, 2013 4:13 MDT index/search-suggestions The index/search-suggestions resource provides APIs for getting suggestions for specified searches.
index/search-suggestions query has over filter is that it can have embedded ORs. A single query parameter can do what would take multiple parameters or multiple GET requests using filter. Use query for more complex queries. view Optional Return a specific subset of the attributes of the resource or collection by specifying the name of a predefined view. The default view is expand (show all attributes of the resource, and all elements of collections or resources).
index/search-suggestions Get suggestions in JSON format: GET https://{appl}/rest/index/search-suggestions/schema Suggestions type: object Properties suggestions: description: A list of suggestions for the given search type: array index-search-suggestions.
users HP OneView REST API Reference Updated: October 16, 2013 4:21 MDT users The users resource provides REST APIs to configure user settings in the appliance.
users UserAddV2 Required User and role details to be added Response Description UserRolesV2 Details of the newly added user Response Codes REST API Response Codes Examples REQUEST-TYPE: POST Add a new user named testuser, including user details and specifying role as Read Only.
users "userName" : "testUser1", "fullName" : "testUser1", "password" : "myPass1234", "emailAddress" : "", "officePhone" : "555-1212", "mobilePhone" : "555-2121", "enabled" : "true" }, { "userName" : "testUser2", "fullName" : "testUser2", "password" : "myPass1234", "emailAddress" : "", "officePhone" : "555-1212", "mobilePhone" : "555-2121", "enabled" : "true" }] DELETE Deletes multiple users based on query criteria.
users REST API Response Codes Examples DELETE https://{appl}/rest/users Example : Deletes multiple users from the appliance with user names testUser1 or testUser2 https://{app1}/rest/users?query="(loginname='testUser1') OR (loginname='testUser2')" GET Gets all local users from the appliance. Parameter Attributes Description start Optional The 0-based index of the first resource to return (start=0 starts with the first available resource).
users functional when used in simple cases, restrictions might be noted in the implementation description. A general filter/query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request. The default is no filter (all resources are returned). Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
users "category": "users", "created": "2013-08-06T10:06:32.317Z", "eTag": null, "modified": "2013-08-06T10:06:32.319Z" } PUT Changes user details including associated roles. This allows logged in users of the appliance to modify the user account properties(except user name) and roles of other's user account. Requires to be executed by user with update permission. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
users https://{app1}/rest/users { "userName" : "testUser", "enabled" : "true" } Example 4: Update user attributes email/phone numbers of user with proper privileges by supplying only the user name and any or all of emailAddress, officePhone, mobilePhone fields.
users PUT Resets the administrator password. This operation is allowed only by a local user from kiosk/console. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
users { "userName" : "user1", "oldPassword" : "password123", "newPassword" : "password123" } The above call can be only be used for initial password change for the administrator account during initial appliance setup. URI: /rest/users/role/{userName} Method API GET Gets all the roles for specified local user from the appliance. Parameter Attributes Description start Optional The 0-based index of the first resource to return (start=0 starts with the first available resource).
users fields Optional filter Experimental This parameter is experimental for this release: While generally functional when used in simple cases, restrictions might be noted in the implementation description. A general filter/query string that narrows the list of resources returned by a multi-resource GET (read) request and DELETE (delete) request. The default is no filter (all resources are returned).
users force Optional If set to true, the operation completes even if there are network connectivity issues or resource errors. The default is false. query Experimental This parameter is experimental for this release: While generally functional when used in simple cases, restrictions might be noted in the implementation description. If the query is supported, the following is the way it works.
users use the parameter to view additional resource pages. The default value for start is 0 (first available resource). count Optional Optional parameter that specifies the number of resources to return from each API invocation. The number of resources returned on each call is referred to as a page. If you specify a count, the API attempts to return the specified number of resources, however this may be limited due to response time constraints and/or actual number of resources available to return.
users REST API Response Codes Examples Example : Gets all the users with the specified role name from the appliance GET https://{appl}/rest/users/roles/users/{role} Response Body: { "type": "UserNameDtoCollection", "members": [ { "userName": "administrator" }, { "userName": "paul" }, { "userName": "ralph" }, { "userName": "april" } ], "count": 4, "total": 4, "start": 0, "prevPageUri": null, "nextPageUri": null, "uri": "/rest/users/roles/users/Infrastructure administrator", "category": "users", "created": "
users boolean If the user name is already present, true is returned, otherwise false.
users DELETE Deletes user with name as testUser. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description void Response Codes REST API Response Codes Examples DELETE https://{appl}/rest/users/{userName} Example : https://{app1}/rest/users/testUser GET Gets details of the local user from the appliance.
users } URI: /rest/users/{userName}/roles Method API POST Adds a given set of roles to an existing user. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
users REST API Response Codes Examples PUT https://{appl}/rest/users/{userName}/roles?multiResource=true Example : Modifies the roles of existing user testUser https://{app1}/rest/users/testUser/roles/?multiResource=true [{ "type" : "RoleNameDtoV2", "roleName" : "Infrastructure administrator" }, { "type" : "RoleNameDtoV2", "roleName" : "" }] ResetPassword description: The ResetPassword is a data transfer object to reset the administrator user's password.
users roles: pattern: ^[a-zA-Z]+?[0-9-_a-zA-Z]*$ searchable: true required: true minLength: 1 maxLength: 39 description: List of role names to be assigned to the user. Role names are case sensitive. type: array RoleNameV2 description: The RoleName is a data transfer object to assign/get roles to/from an existing user account. A user cannot modify the roles assigned to the user's own account.
users state: eTag: roleName: type: name: description: State is not applicable to this resource. type: string description: Entity tag/version ID of the resource, the same value that is returned in the ETag header on a GET of the resource type: string description: Name of the role to be assigned/get to/from the existing user account. Role names are case sensitive required: true type: string searchable: true description: Identifies the resource type.
users modified: start: eTag: nextPageUri: members: description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])? Z type: string format: YYYY-MM-DDThh:mm:ss.
users state: eTag: roleName: type: name: total: type: type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: State is not applicable to this resource. type: string description: Entity tag/version ID of the resource, the same value that is returned in the ETag header on a GET of the resource type: string description: Name of the role to be assigned/get to/from the existing user account.
users roles: maxLength: 39 description: List of role names to be un-assigned to the user account, role names are case sensitive type: array UserAdd description: The UserAdd is a data transfer object to add users to the appliance. Any user whose roles have the {users,Create} authorization is allowed to create local users. Validations are performed to ensure that no user with the same user name and full name already exist.
users officePhone: mobilePhone: enabled: searchable: true minLength: 1 maxLength: 64 description: Office phone number of the user type: string pattern: ^[^\"'&=<>]+$ minLength: 1 maxLength: 25 description: Mobile phone number of the user type: string pattern: ^[^\"'&=<>]+$ minLength: 1 maxLength: 25 description: Specifies if the user account is enabled or not type: boolean default: false UserV2 description: This User is a data transfer object to get user details from the
users description: created: enabled: uri: name: state: eTag: emailAddress: modified: officePhone: type: string description: Brief description of the resource type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][09])?Z type: string format: YYYY-MM-DDThh:mm:ss.
users fullName: category: type: mobilePhone: type: string description: Full name of the user. should contain only letters and the characters ' . - _ and space searchable: true pattern: ^[a-zA-Z0-9 ._'-]+$ maxLength: 39 minLength: 1 type: string description: Resource category used for authorizations and resource type groupings type: string description: Identifies the resource type. This field must be set to 'UserDtoV2'.
users modified: start: eTag: created: members: type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])? Z type: string format: YYYY-MM-DDThh:mm:ss.
users groupings created: enabled: uri: mobilePhone: modified: state: eTag: emailAddress: fullName: users.html[10/17/2013 10:35:59 AM] type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5] [0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
users officePhone: type: name: total: type: type: string searchable: true pattern: ^[a-zA-Z0-9 ._'-]+$ maxLength: 39 minLength: 1 description: Office phone number of the user pattern: ^[^\"'&=<>]+$ maxLength: 25 minLength: 1 type: string description: Identifies the resource type. This field must be set to 'UserDtoV2'.
users replaceRoles: currentPassword: roles: userName: emailAddress: officePhone: mobilePhone: users.html[10/17/2013 10:35:59 AM] maxLength: 40 description: Specifies whether the new roles replace, or are added to, the user's existing roles. type: boolean default: false description: Current password of user.
users enabled: fullName: type: string pattern: ^[^\"'&=<>]+$ minLength: 1 maxLength: 25 description: Specifies if the user account is enabled or not type: boolean default: false description: Full name of the user. Should contain only letters and the characters ' . - _ and space type: string pattern: ^[a-zA-Z0-9 .
users start: eTag: members: type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
users userName: oldPassword: newPassword: description: User name of the user type: string pattern: ^[a-zA-Z]+?[0-9-_a-zA-Z]*$ searchable: true required: true minLength: 1 maxLength: 39 description: Current password of user. Password should not contain any of < > ; , \" ' & \\/ | + : = and space type: string pattern: ^[^<>;,\"'&\\\\/|+:= ]+$ required: true minLength: 8 maxLength: 40 description: New password, to replace the user's existing password.
users status: description: roles: created: enabled: uri: name: state: eTag: emailAddress: modified: type: string minLength: 1 description: Overall health status of the resource.
users officePhone: fullName: category: type: mobilePhone: pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][09])?Z type: string format: YYYY-MM-DDThh:mm:ss.sssZ description: Office phone number of the user pattern: ^[^\"'&=<>]+$ maxLength: 25 minLength: 1 type: string description: Full name of the user. should contain only letters and the characters ' . - _ and space searchable: true pattern: ^[a-zA-Z0-9 .
users password: trustedComponentToken: required: true minLength: 1 maxLength: 39 description: Current password of user. Password should not contain any of < > ; , \" ' & \\/ | + : = and space type: string pattern: ^[^<>;,\"'&\\\\/|+:= ]+$ required: true minLength: 8 maxLength: 40 description: The trusted component token type: string UserAddV2 description: The UserAddV2 is a data transfer object used to add user with roles to the appliance.
users emailAddress: officePhone: mobilePhone: enabled: roles: type: string pattern: ^[a-zA-Z]+?[0-9-_a-zA-Z]*$ searchable: true required: true minLength: 1 maxLength: 39 description: Email address of the user type: string pattern: ^[_A-Za-z0-9-]+(\\.[_A-Za-z0-9-]+)*@[A-Za-z0-9]+(\\.[A-Za-z0-9]+)*(\\.
roles HP OneView REST API Reference Updated: October 16, 2013 4:20 MDT roles The roles resource manager provides REST APIs to retrieve all roles from the appliance.
roles view Optional Return a specific subset of the attributes of the resource or collection by specifying the name of a predefined view. The default view is expand (show all attributes of the resource, and all elements of collections or resources). fields Optional filter Experimental This parameter is experimental for this release: While generally functional when used in simple cases, restrictions might be noted in the implementation description.
roles current release, this must be set to "X-API-Version:3" Response Description RoleNameV2 RoleNameDtoV2 Role name details Response Codes REST API Response Codes Examples GET https://{appl}/rest/roles/{roleName} Example: Gets details for the role name "Read only" https://localhost/rest/roles/Read only RoleName description: The RoleName is a data transfer object to assign/get roles to/from an existing user account. User cannot modify roles of own account. Role names are case sensitive.
roles prevPageUri: uri: created: start: eTag: members: type: string description: URI pointing to the page of resources preceding the list of resources contained in the specified collection type: string description: The canonical URI of the resource type: string description: Date and time when the resource was created format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
authz HP OneView REST API Reference Updated: October 16, 2013 3:59 MDT authz The authz resource manager provides REST APIs to check if a user has permission on a specific category and action, retrieve all list category and actions. It also provides API to retrieve all roles and associated category and actions.
authz ORs. A single query parameter can do what would take multiple parameters or multiple GET requests using filter. Use query for more complex queries. view Optional Return a specific subset of the attributes of the resource or collection by specifying the name of a predefined view. The default view is expand (show all attributes of the resource, and all elements of collections or resources).
authz ], "count":2, "total":2, "start":0, "prevPageUri":null, "nextPageUri":null, "uri":null, "category":"authorization", "eTag":null, "created":null, "modified":null } URI: /rest/authz/role-category-actions Method API GET Gets the list of all roles and associated category and actions from the database. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
authz "debug-logs":["Read","Create","Delete","Update"] } } URI: /rest/authz/validator Method API POST Checks if a user has permissions on a specific category and action. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
authz description: type: string required: true description: The description of the action type: string CategoryActionBaseList description: Encapsulates the list of category and action details type: object Properties count: category: nextPageUri: prevPageUri: uri: created: start: eTag: members: description: The actual number of resources returned in the specified page type: integer description: Resource category used for authorizations and resource type groupings type: string d
authz actionDto: categoryDto: modified: total: type: description: The action details type: string description: The category details type: string description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
certificates HP OneView REST API Reference Updated: October 16, 2013 4:04 MDT certificates The certificates resource provides REST APIs to do the following: 1.Configure SSL certificates for secured communication with the web server (httpd). The /certificates/https resource is a named context in which SSL certificates can be created,retrieved and imported.
certificates each call is referred to as a page. If you specify a count, the API attempts to return the specified number of resources, however this may be limited due to response time constraints and/or actual number of resources available to return. The results include the total number of resources that match the filter or query, the actual count returned, and the URIs to go to the next page, previous page, or both.
certificates The following example retrieves a list of SSL certificates based on the filter criteria. An example URI is included. GET https://example.net//rest/certificates? sort=ascending&start=0&count=2&filter=localhost&filter=testcert POST Imports the given SSL certificate into the appliance. Parameter Attributes Description Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
certificates Response Codes REST API Response Codes Examples The following example imports the given list of SSL certificates into the appliance. An example URI and request body are included. POST https://example.net/rest/certificates?multiResource=true [{"type":"SSLCertificateDTO", "status":null, "base64SSLCertData":"-----BEGIN CERTIFICATE-----...
certificates [{"type":"SSLCertificateDTO", "status":null, "base64SSLCertData":"-----BEGIN CERTIFICATE-----...-----END CERTIFICATE-----", "aliasName":"localhostone", "verifyTrustChainAndRevocation":false, "verifyRevocationStatus":false }, {"type":"SSLCertificateDTO", "status":null, "base64SSLCertData":"-----BEGIN CERTIFICATE-----...
certificates The following example deletes the list of SSL certificates based on the alias names 'localhost' and 'testcert' specified as part of filter criteria. An example URI is included. DELETE https://example.net/rest/certificates? filter=localhost&filter=testcert URI: /rest/certificates/ca Method API GET Retrieves the internal CA's root certificate Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
certificates the internal CA in base-64 encoded format. An example URI is included. GET https://{appliance}/rest/certificates/ca/crl URI: /rest/certificates/ca/{aliasName} Method API DELETE The Atlas CA root certificate and RabbitMQ client and server certificates will be re-generated. This will invalidate the previous version of RabbitMQ client certificate. RabbitMQ server will be restarted to read the latest certificates. X-API-Version in the HTTP header should be at least 2.
certificates name is default, empty or null, then a client certificate will be created for a default RabbitMq user name. Response Description void HP recommends polling for the completion of the task and then,to get the client certificate and key, invoking the following resource: https://{appl}/rest/certificates/client/rabbitmq/ keypair/{aliasName} Response Codes REST API Response Codes Examples Example 1: To generate a CA signed client certificate, signed by internal CA.
certificates associated with the RabbitMq user based on alias name. Example URIs are included. GET https://example.net/rest/certificates/client/rabbitmq/keypair/default GET https://example.
certificates REST API Response Codes Examples The following example gets the existing SSL certificate information. An example URI is included. GET https://example.net/rest/certificates/https PUT Creates a Self Signed Certificate based on input certificate data. This is an asynchronous API and returns the TaskResourceV2 data object that contains the information about the task to be monitored for this purpose. X-API-Version in the HTTP header should be at least 2.
certificates "initials":"", "dnQualifier":"", "unstructuredName":"123", "challengePassword":"12345678" } URI: /rest/certificates/https/certificaterequest Method API POST Creates a Certificate Signing Request (CSR) based on input certificate data object and returns the data object that contains information about the newly created CSR. X-API-Version in the HTTP header should be at least 2.
certificates "givenName":"", "initials":"", "dnQualifier":"", "unstructuredName":"123", "challengePassword":"12345678" } PUT Imports or accepts a signed certificate based on input certificate data . This is an asynchronous API. It returns the TaskResourceV2 data object containing information about the task to be monitored for this purpose. X-API-Version in the HTTP header should be at least 2.
certificates Response Description SSLCertificate SSL certificate along with the validity status. Valid - if X509 compliance and not expired, Expired if Certificate Expired, Invalid - If not a valid X509 certificate. Response Codes REST API Response Codes Examples The following example validates an SSL certificate. An example URI and request body are included. POST https://example.
certificates Examples The following example gets the existing SSL certificate information for a given alias name. An example URI is included. GET https://example.net/rest/certificates/certaliasname1 PUT Replaces the existing SSL certificate with the new certificate for the given certificate alias name as part of the {id}. Parameter Attributes Description force Optional If set to true, the operation completes even if there are network connectivity issues or resource errors. The default is false.
certificates REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description Map Status of the certificate deletion Response Codes REST API Response Codes Examples The following example deletes the SSL certificate based on the alias name. An example URI is included. DELETE https://example.
certificates characters version: type: email: status: description: sha1Fingerprint: dnQualifier: contactPerson: base64Data: eTag: unstructuredName: expiresInDays: certificates.html[10/17/2013 10:36:02 AM] type: string description: X.509 version information for the certificate, a prevalent version is X.509 version 3, which is a standard that allows a certificate to contain customized extensions type: string description: Identifies the resource type.
certificates organizationalUnit: validFrom: validUntil: name: created: country: serialNumber: modified: md5Fingerprint: organization: alternativeName: givenName: initials: certificates.
certificates type: string CertificateDataV2 description: Used to transport and store configuration data to accept or retrieve the content of the certificate signing request information type: object Properties status: category: description: created: uri: modified: state: eTag: base64Data: description: Overall health status of the resource.
certificates type: name: format: -----BEGIN CERTIFICATE----- encoded data here -----END CERTIFICATE----- description: Identifies the resource type. This field must be set to 'CertificateDataV2'.
certificates type: status: description: countryName: eTag: emailAddress: expiresInDays: organizationName: name: created: modified: stateOrProvinceName: certificates.html[10/17/2013 10:36:02 AM] description: Identifies the resource type. This field must be set to 'RabbitMqClientCert'. type: string description: Overall health status of the resource.
certificates keysize: signedCert: type: string description: The size of the key in bits, default - 2048 bits type: string description: Option to generate either a CA signed certificate or a self signed certificate type: boolean TaskResourceV2 type: object Properties taskOutput: completedSteps: modified: taskErrors: description: Output resulting from the running of the task type: array description: Number of steps currently completed by the task type: integer description: Date and
certificates details: message: data: associatedTaskUri: percentComplete: taskType: userInitiated: category: taskStatus: parentTaskUri: stateReason: type: certificates.
certificates progressUpdates: description: List of timestamped objects describing the progress of the task. type: array Items timestamp: statusUpdate: eTag: associatedResource: Date and time when the progress update was logged format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5] [0-9]:[0-5][0-9](.
certificates taskState: type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
certificates format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[05][0-9](.[0-9][0-9][0-9])?Z verifyTrustChainAndRevocation: type: uri: description: The canonical URI of the resource type: string description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[05][0-9](.
certificates prevPageUri: uri: modified: start: eTag: nextPageUri: members: description: URI pointing to the page of resources preceding the list of resources contained in the specified collection type: string description: The canonical URI of the resource type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])? Z type: string format: YYYY-MM-DDThh:mm:ss.
certificates verifyRevocationStatus: description: Verification status of the input SSL certificate or chain for revocation status against a CRL file offline type: boolean type: uri: description: The canonical URI of the resource type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][09]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9] [0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
login-sessions HP OneView REST API Reference Updated: October 16, 2013 3:57 MDT login-sessions Authentication service provides REST APIs to login, reconnect to an existing session, and terminate a session (logout). The login API returns a session token on successful authentication. The reconnect and logout REST APIs require a session token in the request header.
login-sessions "password":"mypassword", } PUT Reconnects to an existing session that is neither explicitly logged out nor timed out. Callers must provide the session token in the request header. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description LoginSessionId Returns a session token on success. Returns an error message on failure.
login-sessions Response Description JsonSchema[] Returns a collection of JSON schema for login APIs Response Codes REST API Response Codes Examples GET https://{appl}/rest/login-sessions/schema The following example retrieves the formatted schema for the login APIs https://example.
active-user-sessions HP OneView REST API Reference Updated: October 16, 2013 4:20 MDT active-user-sessions The active user sessions resource manager provides REST APIs to retrieve list of all active user sessions from the appliance API Specifications Create Read /rest/active-user-sessions Update Delete GET Resource Model SessionUserListV2 SessionUserV2 URI: /rest/active-user-sessions Method API GET Gets the list of active user sessions.
active-user-sessions nextPageUri: prevPageUri: uri: modified: start: eTag: created: members: description: URI pointing to the page of resources following the list of resources contained in the specified collection type: string description: URI pointing to the page of resources preceding the list of resources contained in the specified collection type: string description: The canonical URI of the resource type: string description: Date and time when the resource was last modified patte
active-user-sessions created: loginDomain: loggingID: uri: state: eTag: modified: clientHost: category: type: timeAccessed: active-user-sessions.html[10/17/2013 10:36:04 AM] pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5] [0-9](.[0-9][0-9][0-9])?Z required: true type: number format: YYYY-MM-DDThh:mm:ss.
active-user-sessions description: total: type: required: true type: number format: YYYY-MM-DDThh:mm:ss.sssZ description: Brief description of the resource type: string description: The total number of resources that would be returned from the query (including any filters), without pagination or enforced resource limits type: integer description: Identifies the resource type. This field must be set to 'SessionUserCollectionV2'.
active-user-sessions loginDomain: loggingID: uri: state: eTag: modified: clientHost: category: type: timeAccessed: description: format: YYYY-MM-DDThh:mm:ss.sssZ description: The user login domain type: string description: The log identifier type: string description: The canonical URI of the resource type: string description: State is not applicable to this resource.
logindomains HP OneView REST API Reference Updated: October 16, 2013 3:57 MDT logindomains The logindomains API set helps to configure a directory like Microsoft Active Directory to authenticate users who log in to the appliance. In addition, this API set enables or disables local user authentication and configures a directory for authentication.
logindomains POST https://{appl}/rest/logindomains The following example adds the directory with name MyDirectory https://example.com/rest/logindomains { "type":"LoginDomainConfigVersion2Dto", "name":"MyDirectory","credential": {"userName":"administrator","password":"mypassword"}, "authProtocol":"AD","useSsl":true,"top":"dc=example,dc=com","org":"cn=Users","userNameField":"cn", "directoryServers":[{"type":"LoginDomainDirectoryServerInfoDto", "directoryServerIpAddress":"192.0.2.
logindomains this must be set to "X-API-Version:3" Response Description JsonSchema[] Returns the collection of JSON schemas for the directory configuration Response Codes REST API Response Codes Examples GET https://{appl}/rest/logindomains/schema The following example retrieves the schema for the directory configuration https://example.
logindomains Request Body Attributes Description LoginDomainConfigVersion2 Required Directory configuration to be validated Response Description LoginDomainConfigVersion2 Returns the directory configuration on success. Returns an error message on failure. Response Codes REST API Response Codes Examples POST https://{appl}/rest/logindomains/validator The following example validates the directory configuration for the directory with name NewDirectory https://example.
logindomains The following example retrieves the directory configuration for the specified directory which is identified as 1 https://example.com/rest/logindomains/1 PUT Updates a directory configuration on the appliance. For instance, it helps to add or remove the configured directory servers or change search context for locating users in the directory. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logindomains REST API Response Codes Examples DELETE https://{appl}/rest/logindomains/{loginDomain} The following example obtains a directory identifier for directory, MyDirectory Using GET https://example.com/rest/logindomains Response: {"name":"MyDirectory", "loginDomain":"1", "uri":"/rest/logindomains/1", ... } The following example removes the directory, myLoginDomain which is identified as 1 https://example.
logindomains loginDomain: modified: uri: eTag: type: pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z description: The unique identifier of the directory type: string description: Date and time when the resource was last modified format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
logindomains created: directoryServers: type: string description: Date and time when the resource was created pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.[0-9][0-9][0-9])?Z type: string format: YYYY-MM-DDThh:mm:ss.
logindomains 'LoginDomainDirectoryServerInfoDto'. serverStatus: uri: authProtocol: modified: eTag: org: type: type: string description: Directory server status type: string description: The canonical URI of the resource type: string description: Type of the directory - AD or LDAP. Use AD to denote Microsoft Active Directory andLDAP to denote OpenLDAP based directory.
logindomains/global-settings HP OneView REST API Reference Updated: October 16, 2013 3:57 MDT logindomains/global-settings This service provides REST APIs to the global settings used for authentication. The global settings include the default directory, enabling local login, and the configured directories.
logindomains/global-settings default directory, enabling local login, and the configured directories. NOTE: The configured directories in the request are ignored. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logindomains/global-settings login The following example checks if local authentication is enabled https://example.com/rest/logindomains/global-settings/allow-local-login POST Enables or disables local user authentication Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logindomains/global-settings Examples GET https://{appl}/rest/logindomains/global-settings/default-logindomain The following example retrieves the default directory set https://example.com/rest/logindomains/global-settings/default-logindomain POST Sets the default directory to be used for authentication when a directory is not specified in the login request. Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logindomains/global-settings Examples GET https://{appl}/rest/logindomains/global-settings/schema The following example retrieves the formatted JSON schema for global settings used for authentication https://example.
logindomains/global-settings type: allowLocalLogin: configuredLoginDomains: type: string description: Identifies the resource type. This field must be set to 'LoginDomainConfigInfoDto'. type: string description: The setting to enable or disable local user authentication type: boolean description: The list of configured directories type: array Items category: name: created: loginDomain: uri: modified: eTag: type: logindomains-global-settings.
logindomains/global-settings AllowLocalLogin description: Setting for enabling or disabling the local user authentication type: object Properties allowLocalLogin: description: The setting to enable or disable local user authentication type: boolean LoginDomainConfigInfo description: Data model for a directory configuration type: object Properties category: name: created: loginDomain: modified: uri: eTag: description: Resource category used for authorizations and resource type groupings
logindomains/global-settings type: description: Identifies the resource type. This field must be set to 'LoginDomainConfigInfoDto'. type: string logindomains-global-settings.
logindomains/grouptorolemapping HP OneView REST API Reference Updated: October 16, 2013 3:57 MDT logindomains/grouptorolemapping This service provides REST APIs to assign directory group to appliance roles like Infrastructure Administrator, Network Administrator.
logindomains/grouptorolemapping Request Body Attributes Description Group2RolesMappingPerGroupValidation Required Details of directory groups with the roles to be assigned and user credentials for the directory access. Response Description Group2RolesMappingPerGroup Returns the directory group with assigned roles Response Codes REST API Response Codes Examples POST https://example.
logindomains/grouptorolemapping filter or query, the actual count returned, and the URIs to go to the next page, previous page, or both. If necessary, you can make several requests using the URI for the next or previous page (or different start parameters) to get the desired count. sort Optional The sort order of the returned data set. By default, the sort order is based on the create time, with the oldest entry first.
logindomains/grouptorolemapping success. failure. Returns an error message on Response Codes REST API Response Codes Examples POST https://{appl}/rest/logindomains/grouptorolemapping/validator The following example validates the group and roles https://example.
logindomains/grouptorolemapping returned). Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to "X-API-Version:3" Response Description Group2RolesMappingList Returns list of directory groups to role assignments on success. Returns an error message on failure.
logindomains/grouptorolemapping } The following example deletes the roles assiged to the group, ServerAdminGroup from the directory, MyDirectory which is identified as 1. https://example.com/rest/logindomains/grouptorolemapping/1/ServerAdminGroup GET Retrieves the roles assignment for a directory group under a directory Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
logindomains/grouptorolemapping the resource type: credentials: string description: The user credentials for the directory access type: object Properties userName: password: type: group2rolesPerGroup: description: The user name type: string description: The password type: string description: Identifies the resource type. This field must be set to 'Group2RolesMappingPerGroupValidationDto'.
logindomains/grouptorolemapping description: Data model for a group to roles assignment at a group level type: object Properties category: egroup: roles: created: loginDomain: uri: modified: eTag: type: description: Resource category used for authorizations and resource type groupings type: string description: The directory group for which the roles assignment is requested type: string description: A list of roles for the specified directory group type: array description: Date and
logindomains/grouptorolemapping prevPageUri: uri: modified: start: eTag: nextPageUri: members: description: URI pointing to the page of resources preceding the list of resources contained in the specified collection type: string description: The canonical URI of the resource type: string description: Date and time when the resource was last modified pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
logindomains/grouptorolemapping enforced resource limits type: type: integer description: Identifies the resource type. This field must be set to 'Group2RolesMappingPerGroupCollection'.
sessions HP OneView REST API Reference Updated: October 16, 2013 4:22 MDT sessions The sessions resource manager provides REST APIs to create unique session identifiers, retrieve the session identifiers, and delete the session identifiers. It also provides APIs to configure session timeouts, update session access time, and session reference counts. Session identifiers are used across the CI architecture to associate attribute information with a user or a service.
sessions idle time [optional] "true": To reset the session idle time Example: Gets the user session information for the specified session identifier https://example.net/rest/sessions URI: /rest/sessions/idle-timeout Method API POST Changes the length of time the session can remain in the idle state before timed out Request Header Attributes Description REST API Request Headers NOTE: The X-API-Version header is required for all APIs.
sessions Response Codes REST API Response Codes Examples REQUEST-TYPE: GET URI: https://{appl}/rest/sessions/idle-timeout Request Header Parameters: "Session-ID" : The session identifier [required] Example: Gets the idle timeout value for the specified session https://example.
sessions multiple GET requests using filter. Use query for more complex queries. view Optional fields Optional filter Experimental Return a specific subset of the attributes of the resource or collection by specifying the name of a predefined view. The default view is expand (show all attributes of the resource, and all elements of collections or resources).
sessions clientHost: userDefinedData: holdReference: roles: type: string description: The client host name type: string description: The user defined data type: string description: The flag to indicate whether to hold reference on session type: boolean default: false description: The list of roles to be associated with the user session type: array Session description: Encapsulates the session details type: object Properties loginDomain: username: clientHost: serverHost: user
sessions SessionIdleTimeout description: Encapsulates the session idle timeout details type: object Properties idleTimeout: description: The session idle timeout value in milliseconds type: number required: true SessionReference description: Encapsulates the session reference count type: object Properties reference: description: The session reference count type: integer required: true SessionUserList description: Encapsulates the list of session user details type: object Propertie
sessions uri: created: start: eTag: members: description: The canonical URI of the resource type: string description: Date and time when the resource was created format: YYYY-MM-DDThh:mm:ss.sssZ type: string pattern: [1-2][0-9][0-9][0-9]-([0-1][0-9])-[0-3][0-9]T[0-2][0-9]:[0-5][0-9]:[0-5][0-9](.
sessions filters), without pagination or enforced resource limits type: type: integer description: Identifies the resource type. This field must be set to 'SessionUserCollection'.
Association names HP OneView REST API Reference Association names HP OneView provides a fully connected resource model. The following associations describe the relationships between the OneView resources. See the associations API documentation for details on accessing and using associations.
Association names ethernet-networks LOGICAL_INTERCONNECT_TO_NETWORK_REACHABLE fc-networks LOGICAL_INTERCONNECT_TO_FC_NETWORK_ASSIGNED fc-networks LOGICAL_INTERCONNECT_TO_FC_NETWORK_UNASSIGNED network-sets ethernet-networks NETWORKSET_TO_NETWORK power-devices enclosures PDD_TO_POWER_CONSUMER logicalinterconnects server-hardware unmanageddevices racks enclosures RACK_TO_PHYSICAL_DEVICE power-devices server-hardware unmanageddevices server-hardwaretype server-profiles server-hardware s
Association names fc-networks server_profiles_to_fc_networks server-hardware server_profiles_to_server_hardware resourceassociations.
Common REST API Parameters HP OneView REST API Reference Common REST API Parameters Name Description count Optional parameter that specifies the number of resources to return from each API invocation. The number of resources returned on each call is referred to as a page. If you specify a count, the API attempts to return the specified number of resources, however this may be limited due to response time constraints and/or actual number of resources available to return.
Common REST API Parameters Equals (==, seq, SEQ, sEQ), Not Equals(sne, SNE, sNE), sregex and smatches can be used for case-sensitive string comparisons on 'values'. This parameter usually requires quoting as shown in the examples here (double quotes around the entire filter parameter, and single-quotes around the {value} field) Use dot-notation to reference attributes that are members of objects contained within the primary resource object.
Common REST API Parameters Example for regex: name with value 'alertMax'(Case insensitively): https://{appl}/settings/rest/resources?filter="'name' regex 'alertMax'" name with value exactly 'alertMax' (Case sensitively): https://{appl}/settings/rest/resources?filter="'name' sregex 'alertMax'" name starts with alertMax https://{appl}/settings/rest/resources?filter="'name' regex '^alertMax'" name ends with some words Deviation https://{appl}/settings/rest/resources?filter="'name' regex 'Deviation$'" name con
Common REST API Parameters Not expected to work: expressions that reference nested fields Notes NOT is used to negate the condition. The operands [ GT, GE, LT, LE ] only apply to numeric attributes Equals (eq, EQ) and Not Equals(ne, NE) can be used for case-insensitive string comparisons on 'values'.
Common REST API Parameters owner with specify multiple values 'administrator' or 'infrastructure': https:// {appl} /rest/tasks?query="owner IN ('administrator','infrastructure')" 'AND' operator displays a record if both the first condition and the second condition are true.
Common REST API Parameters Sort the returned list of resources by the name field in ascending order, then by status in descending order: sort=name:asc,status:desc Sort alphanumerically the returned list of resources by the name field in ascending order, then then sort by status in descending order: sort=name:asc:natural,status:desc Limitations: 1. The alphanumeric sort option should not be used with DISTINCT query.
REST API Request Headers HP OneView REST API Reference REST API Request Headers Name Requirements Usage X-APIVersion Required (unless otherwise noted in the documentation) X-API-Version:[apiversion] NOTE: The requests documented in the HP OneView REST API Reference and REST API scripting chapter correspond to a versionNumber of 3. Requests specifying API version 3 always provide the behavior documented here. Future API changes will introduce higher version numbers.
REST API Request Headers The Accept header is currently ignored, and JSON is always returned by default, regardless of the Accept header. This may change in future releases. . AcceptCharset Optional Accept-Charset:[charset] The character sets that are acceptable in the response. The only supported value is UTF8 (Default). Any other value returns a 406 response code (Not Acceptable). AcceptLanguage Optional AcceptLanguage:[language/locale] The language code requested in the response.
REST API Request Headers value. This prevents a client from overwriting modifications made by another client.. If the ETag specified in this header does not match the current ETag for the resource, status code 412 (Precondition Failed) will be returned from the PUT. stdreqhdrs.
REST API Response Headers HP OneView REST API Reference REST API Response Headers Name Usage Description Etag Returned on singleresource GET/PUT/POST requests. For multiresource GET/PUT/POST requests, the ETag for each resource is returned in the response body for that resource. etag: Returned from ALL requests. Cache-Control:no-cache CacheControl Determines the "revision" of the resource.
REST API Response Headers returned and the Location header is populated with the URI of a Task resource, which can be polled to monitor the status of the asynchronous operation. In the future this header will also be returned for synchronous POST operations that create a new resource that is identifiable by a URI. The field from the Location header can be used to access the newly created resource.
REST API Response Codes HP OneView REST API Reference REST API Response Codes Status Code Methods Scenario Response body 200 OK GET Successful return from a synchronous read/query operation. An entity (or list of entities) corresponding to the requested resource(s). GET The URI points to a valid resource or collection, but there is nothing to return based on specified filters. Empty list. PUT Successful return from a synchronous update (or add) operation.
REST API Response Codes parameter sent in request. GET, DELETE The syntax of a request parameter (filter, query, start, count, sort) is invalid or refers to invalid resource attribute names. Error Message entity indicating the specific request parameter(s) in error, and the specific problem(s) with those parameters. POST, PUT Field validation failed: One or more field values sent in an add/update request are not acceptable, because the format or content of the field is invalid.
REST API Response Codes support the TRACE and HEAD methods. 409 CONFLICT POST, PUT, DELETE The request could not be completed due to a conflict with the current state of the resource(s). Error Message entity indicating the specific conflict with which resource(s).
