HP OneView REST API Reference

server-hardware
server-hardware.html[10/17/2013 10:35:23 AM]
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.
Note: servers in an enclosure are added by adding the enclosure resource.
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"
Request
Body
Attributes Description
AddServer Required Contains the information necessary to add a rack
server.
Response Description
TaskResourceV2 Returns a TaskResource resource that can be used to monitor the
progress of server addition.
Response Codes
REST API Response Codes
Examples
Add the server via the management processor
enc-ilo.corp.com using the login "Administrator" and
password "mypassword":
POST https://{appl}/rest/server-hardware
{
"hostname" : "enc-ilo.corp.com",
"username" : "Administrator",
"password" : "mypassword",
"force" : false,
"licensingIntent":"OneView"
}
URI: /rest/server-hardware/schema
Method API
GET Gets the JSON schema of the server hardware 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 object model representation of a server hardware
resource
Response Codes
REST API Response Codes
URI: /rest/server-hardware/{id}/environmentalConfiguration
Method API
GET Gets the settings that describe the environmental configuration (supported feature set, calibrated minimum & maximum power, location &
dimensions, ...) of the server hardware 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-