EMC ViPR REST API

Search (SHIFT+S)

API Reference


Create File Virtual Pool

POST /file/vpools

Create File 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
<file_vpool_create>
<protection>    
<replication_params>    
<copies>
<protection_varray_vpool>     0-* Elements
<varray> URI
<vpool> URI
<remote_copy_mode> String
</protection_varray_vpool>      
</copies>
<file_replication_policy>    
<copy_mode> The remote copy mode, sync or async Valid values: ASYNCHRONOUS = Replication will be in Asynchronous mode (default) SYNCHRONOUS = Replication will be in Synchronous mode String
<rpo_value> RPO value Long
<rpo_type> Type of RPO unit Valid values: MINUTES = Minutes (time-based RPO) HOURS = Hours (time-based RPO) String
<replication_type> Type of file replication Valid values: LOCAL REMOTE NONE String
</file_replication_policy>      
</replication_params>      
<schedule_snapshots> The schedule snapshot protection settings for a virtual pool. Boolean
<snapshots>    
<max_native_snapshots> The maximum snapshots. Integer
</snapshots>      
</protection>      
<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
<provisioning_type> The provisioning type for the virtual pool. Valid values: NONE Thin Thick String
<system_type> The supported system type for the virtual pool. Valid values: NONE vnxblock (block) vmax (block) openstack (block) vnxfile (file) isilon (file) netapp (file) String
<long_term_retention> Boolean
</file_vpool_create>

Response Body

VirtualPool details

Field Description Type Notes
<file_vpool>
<protection>    
<replication_params>    
<copies>
<protection_varray_vpool>     0-* Elements
<varray> URI
<vpool> URI
<remote_copy_mode> String
</protection_varray_vpool>      
</copies>
<file_replication_policy>    
<copy_mode> The remote copy mode, sync or async Valid values: ASYNCHRONOUS = Replication will be in Asynchronous mode (default) SYNCHRONOUS = Replication will be in Synchronous mode String
<rpo_value> RPO value Long
<rpo_type> Type of RPO unit Valid values: MINUTES = Minutes (time-based RPO) HOURS = Hours (time-based RPO) String
<replication_type> Type of file replication Valid values: LOCAL REMOTE NONE String
</file_replication_policy>      
</replication_params>      
<schedule_snapshots> The schedule snapshot protection settings for a virtual pool. Boolean
<snapshots>    
<max_native_snapshots> The maximum snapshots. Integer
</snapshots>      
</protection>      
<long_term_retention> Not currently used Boolean
<file_replication_type> String
<type> Virtual pool storage resource type. Valid values: block = Volume file = File System object = Object Store String
<description> User defined description for this virtual pool. String
<provisioning_type> Storage type provisioned for this virtual pool. String
<protocols>
<protocol> String 0-* Elements
</protocols>
<system_type> The supported system type for the virtual pool. Valid values: NONE vnxblock (Block) vmax (Block) vnxfile (File) isilon (File) netapp (File) String
<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
<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
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime
<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
<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
</file_vpool>