HP OneView REST API Reference

server-hardware
server-hardware.html[10/17/2013 10:35:23 AM]
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 "X-
API-Version:3"
Request Body Attributes Description
ServerRefreshRequest Required An object describing the refresh request.
Response Description
TaskResourceV2 Returns a TaskResource resource that can be used to monitor the
progress of server refresh.
Response Codes
REST API Response Codes
Examples
Initiate a server hardware refresh operation:
PUT https://{appl}/rest/server-hardware/123-45-67-89-123/refreshState
{
"refreshState" : "RefreshPending"
}
Initiate a refresh operation for a rack server specifying
credentials to fix any access issues:
PUT https://{appl}/rest/server-hardware/123-45-67-89-123/refreshState
{
"refreshState" : "RefreshPending",
"username" : "Administrator",
"password" : "mypassword"
}
URI: /rest/server-hardware/{id}/remoteConsoleUrl
Method API
GET Generates a Single Sign-On (SSO) session for the iLO Integrated Remote Console Application (IRC) and returns the URL to launch it. If
the server hardware is unmanaged or unsupported, the resulting URL will not use SSO and the IRC application will prompt for credentials.
Use of this URL requires a previous installation of the iLO IRC and is supported only on Windows clients.
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
RemoteConsoleUrlResult The URL to new session on Remote Console
Response Codes
REST API Response Codes
Examples
Generate an SSO session for the Integrated Remote Console
Application (IRC) and return the URL to launch it:
GET https://{appl}/rest/server-hardware/123-45-67-89-123/remoteConsoleUrl
URI: /rest/server-hardware/{id}/utilization
Method API
GET Retrieves historical utilization data for the specified resource, metrics, and time span.