HP OneView REST API Reference

server-hardware-types
server-hardware-types.html[10/17/2013 10:35:25 AM]
Updated: October 16, 2013 4:55
MDT
API Specifications Create Read Update Delete
/rest/server-hardware-types GET
/rest/server-hardware-types/schema GET
/rest/server-hardware-types/{id} GET PUT DELETE
Resource Model
ServerHardwareType
ServerHardwareTypeList
HP OneView REST API Reference
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.
URI: /rest/server-hardware-types
Method API
GET Get the list of server hardware type resources defined on 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). 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
ServerHardwareTypeList Returns a list of server hardware type resources