Object Virtual Pool:Create Object Virtual Pool

Search (SHIFT+S)



New in this release

Create Object Virtual Pool

POST /object/vpools

Create Object Store VirtualPool


Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • RESTRICTED_SYSTEM_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<object_vpool_create>
<max_retention> The maximum retention settings for the virtual pool. Integer
<name> The name for the virtual pool. String Valid Values:
  •  Length: 2..128
<description> The description for the virtual pool. String
<protocols>
<protocol> String 0-* Elements
</protocols>
<varrays>
<varray> String 0-* Elements
</varrays>
<use_matched_pools> Determines if matched or valid assigned pools are returned from command to retrieve the list of storage pools. Boolean Valid Values:
  •  true
  •  false
<provisioning_type> The provisioning type for the virtual pool. String Valid Values:
  •  Thin
  •  Thick
<system_type> The supported system type for the virtual pool. String Valid Values:
  •  vnxblock (Block)
  •  vmax (Block)
  •  openstack (Block)
  •  vnxfile (File)
  •  isilon (File)
  •  netapp (File)
<long_term_retention> Boolean
</object_vpool_create>

Response Body

VirtualPool details

Field Description Type Notes
<object_vpool>
<max_retention> Integer
<type> Virtual pool storage resource type String Valid Values:
  •  block = Volume
  •  file = File System
  •  object = Object Store
<description> User defined description for this virtual pool. String
<provisioning_type> Storage type provisioned for this virtual pool. String Valid Values:
  •  Thick
  •  Thin
<protocols>
<protocol> String 0-* Elements
</protocols>
<system_type> The supported system type for the virtual pool. String Valid Values:
  •  vnxblock (Block)
  •  vmax (Block)
  •  vnxfile (File)
  •  isilon (File)
  •  netapp (File)
<num_paths> Integer
<num_resources> Number of resources provisioned to this ViPR using this virtual pool. Integer
<varrays>
<varray>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</varray>      
</varrays>
<use_matched_pools> Determines if matched or valid assigned pools are returned from command to retrieve the list of storage pools. Boolean Valid Values:
  •  false
  •  true
<assigned_storage_pools>
<storage_pool>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_pool>      
</assigned_storage_pools>
<invalid_matched_pools>
<storage_pool>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_pool>      
</invalid_matched_pools>
<matched_storage_pools>
<storage_pool>     0-* Elements
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_pool>      
</matched_storage_pools>
<name> The name assigned to this resource in ViPR. The resource name is set by a user and can be changed at any time. It is not a unique identifier. String
<id> An identifier that is generated by ViPR when the resource is created. The resource ID is guaranteed to be unique and immutable across all virtual data centers for all time. URI Valid Values:
  •  urn:storageos:resource-type:UUID:
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime Valid Values:
  •  YYYY-MM-DDTHH:mm:ssZ
<tags> Keywords and labels that can be added by a user to a resource to make it easy to find when doing a search.
<tag> String 0-* Elements
</tags>
<inactive> Whether or not the resource is inactive. When a user removes a resource, the resource is put in this state before it is removed from the ViPR database. Boolean Valid Values:
  •  true
  •  false
<global> Boolean
<remote> Boolean
<vdc>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</vdc>      
<internal> Whether or not the resource is an internal resource. Boolean Valid Values:
  •  true
  •  false
</object_vpool>
Notes: