HP OneView REST API Reference

server-profiles
server-profiles.html[10/17/2013 10:35:14 AM]
Updated: October 16, 2013 4:51
MDT
API Specifications Create Read Update Delete
/rest/server-profiles POST GET DELETE
/rest/server-profiles/available-networks GET
/rest/server-profiles/available-networks/schema GET
/rest/server-profiles/available-servers GET
/rest/server-profiles/available-servers/schema GET
/rest/server-profiles/messages/schema GET
/rest/server-profiles/profile-ports GET
/rest/server-profiles/profile-ports/schema GET
/rest/server-profiles/schema GET
/rest/server-profiles/{id}/messages GET
/rest/server-profiles/{id} GET PUT DELETE
Resource Model
ProfilePortModel
AvailableServer
AvailableNetworks
ServerProfileV1
ServerProfileListV1
ServerProfileHealth
HP OneView REST API Reference
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 are not supported on DL rack mount servers.
URI: /rest/server-profiles
Method API
GET Gets a list of server profiles based on optional sorting and filtering, and constrained by start and count
parameters. Providing a -1 for the count parameter will restrict the result set size to 64 server profiles. The
maximum number of profiles is restricted to 256, i.e., if user requests more than 256, this will be internally
limited to 256. Filters are supported for the name, description, serialNumber, uuid, macType, wwnType,
serialNumberType, status and state attributes.
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 parameter is used to specify the sorting order of the returned data set.
By default, the sort order is based on the UUID of the profiles.
query Experimental This parameter is experimental for this release: While generally functional