HP OneView REST API Reference

id-pools/vmac/ranges
id-pools-vmac-ranges.html[10/17/2013 10:35:17 AM]
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.
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
FragmentList PaginatedFragmentCollection resource describing all
the allocated
fragments.
Response Codes
REST API Response Codes
Examples
The following examples show how to get the list of all the fragments
that have been allocated from a range which is identified by {id}
GET https://{appl}/rest/id-pools/vmac/ranges/{range-id}/allocated-
fragments?start=0&count=-1
URI: /rest/id-pools/vmac/ranges/{id}/allocator
Method API
PUT Allocates a set of IDs from a vmac range. The allocator returned contains the list of IDs
successfully allocated.
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
Allocator Required
Response Description
Allocator the Allocator DTO with the allocated IDs
Response Codes
REST API Response Codes
Examples