HP OneView REST API Reference

id-pools
id-pools.html[10/17/2013 10:35:17 AM]
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
Pool The DTO that describes the pool
Response Codes
REST API Response Codes
Examples
The following example shows the method to get an ID pool resource whose
identifer is {id}
GET: https://{appl}/rest/id-pools/{id}/
PUT Sets the pool state to enabled or disabled
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"
Request
Body
Attributes Description
Pool Required
Response Description
Pool The DTO that describes the pool
Response Codes
REST API Response Codes
Examples
The following example shows how to set the pool state to enabled or
disabled
PUT : https://{appl}/rest/id-pools/{id}/
Request Body: {"type":"Pool","enabled":true}