EMC ViPR REST API

Search (SHIFT+S)

API Reference


Get Matching Pools For Virtual Pool Attributes

POST /file/vpools/matching-pools

Return the matching pools for a given set of VirtualPool attributes. This API is useful for user to find the matching pools before creating a 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

: matching pools.

Field Description Type Notes
<storage_pools>
<storage_pool>     0-* Elements
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_pool>      
</storage_pools>