HP OneView REST API Reference

id-pools/vsn/ranges
id-pools-vsn-ranges.html[10/17/2013 10:35:18 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 free
fragments.
Response Codes
REST API Response Codes
Examples
The following example shows how to get the list of free fragments in a
range whose identifier is {range-id}
GET : https://{appl}/rest/id-pools/vsn/ranges/{range-id}/free-
fragments?start=0&count=-1
IdRange
description: Defines a Range resource. Allowed values are vmac,vsn,vwwn
type: object
Properties
category: description: Resource category used for authorizations and resource type groupings
type: string
collectorUri: description: Uri of the Collector for this Range
type: string
allocatorUri: description: Uri of the Allocator for this Range
type: string
name: description: Defined name for the Range
type: string
uri: description: The canonical URI of the resource