HP OneView REST API Reference

server-profiles
server-profiles.html[10/17/2013 10:35:14 AM]
GET This API retrieves a server profile managed by the appliance based on its Profile Manager UUID. This API will
always return an eTag value in the header, and this value can be used in subsequent invocations of this API to
determine if the requested profile object has changed on the appliance. The eTag is included as "If-None-
Match" element in the request header, and the API will respond with a NOT_MODIFIED (HTTP Status Code
304) if the object has not changed.
Parameter Attributes Description
view Optional Return a specific subset of the attributes of the resource or collection by specifying
the name of a predefined view. The default view is expand (show all attributes of
the resource, and all elements of collections or resources).
fields Optional
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
ServerProfileV1 Server Profile object that matches the requested UUID
Response Codes
REST API Response Codes
Examples
The example listed here retrieves a single server:
GET https://{appl}/rest/server-profiles/{id}
DELETE Deletes a server profile object from the appliance based on its Server Profile UUID.
Parameter Attributes Description
force Optional If set to true, the operation completes even if there are network connectivity issues
or resource errors. The default is false.
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
TaskResourceV2 TaskResourceV2 object for tracking of the delete operation to
completion
Response Codes
REST API Response Codes
Examples
Delete a single server profile:
DELETE https://{appl}/rest/server-profiles/{id}
DELETE
https://{appl}/rest/server-profiles/{id}?force=true
Notes:
A successful return of this API only indicates that a
delete profile was successfully requested. Monitor the
returned TaskResourceV2 URI to determine the outcome
delete profile operation.
PUT This API allows for a server profile object to have its configuration modified. These modifications can be as