HP OneView REST API Reference

server-hardware
server-hardware.html[10/17/2013 10:35:23 AM]
Updated: October 16, 2013 4:53
MDT
API Specifications Create Read Update Delete
/rest/server-hardware POST GET
/rest/server-hardware/schema GET
/rest/server-hardware/{id}/environmentalConfiguration GET PUT
/rest/server-hardware/{id}/iloSsoUrl GET
/rest/server-hardware/{id}/javaRemoteConsoleUrl GET
/rest/server-hardware/{id}/mpFirmwareVersion PUT
/rest/server-hardware/{id}/powerState PUT
/rest/server-hardware/{id}/refreshState PUT
/rest/server-hardware/{id}/remoteConsoleUrl GET
/rest/server-hardware/{id}/utilization GET
/rest/server-hardware/{id} GET DELETE
Resource Model
ServerHardware
ServerHardwareList
AddServer
ServerPowerControlRequest
ServerRefreshRequest
IloSsoUrlResult
JavaRemoteConsoleUrlResult
RemoteConsoleUrlResult
UtilizationData
EnvironmentalConfigurationUpdate
EnvironmentalConfiguration
HP OneView REST API Reference
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.
URI: /rest/server-hardware
Method API
GET Gets a list of server hardware resources. Returns a list of resources 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). 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. 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. 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.
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).
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
ServerHardwareList A list of server hardware resources.
Response Codes
REST API Response Codes
Examples