HP OneView REST API Reference

id-pools
id-pools.html[10/17/2013 10:35:17 AM]
Updated: October 16, 2013 4:41
MDT
API Specifications Create Read Update Delete
/rest/id-pools/schema GET
/rest/id-pools/{id} GET PUT
/rest/id-pools/{id}/allocator PUT
/rest/id-pools/{id}/collector PUT
/rest/id-pools/{id}/generate GET
/rest/id-pools/{id}/validate PUT
Resource Model
Pool
Fragment
Allocator
Collector
HP OneView REST API Reference
id-pools
The id-pools resource provides REST APIs for managing ID pools. The types of pools available are Vmac, Vsn, Vwwn. You
can request an id from any of the pools, use the ID and then return it. The returned IDs are reclaimed by the pool and are
available for reuse. The pools are accessed by https://{appl}/rest/id-pools/{vmac,vsn,vwwn}. The REST API (GET,
UPDATE) supports an 'accept-language' in the request header. The default is 'en_US'. An 'auth:{token}' in the request
header is required. The {token} can be retrieved from https://{appl}/rest/login-sessions.
URI: /rest/id-pools/schema
Method API
GET Gets the JSON formatted schema for a pool
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
JsonSchema The JSON schema of the pool.
Response Codes
REST API Response Codes
Examples
The following example shows how to fetch the JSON formatted schema for
a pool.
GET : https://{appl}/rest/id-pools/schema
URI: /rest/id-pools/{id}
Method API
GET Gets a pool. Using the pool, the allocator and collector associated with the pool allocate IDs from
and collect IDs to return to the pool.