Block Virtual Pool:Get Matching Pools For Virtual Pool Attributes

Search (SHIFT+S)

API Reference


Get Matching Pools For Virtual Pool Attributes

POST /block/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
<block_vpool_create>
<max_paths> The maximum number of paths to a given StorageArray from a host. Depending on paths_per_initiator, one or more ports may be assigned to an initiator if max_paths is sufficiently high for the number of initiators.

The number of paths is balanced across multiple networks (as determined from the initiators) if possible.

This variable repalces num_paths (which is deprecated) but essentially did the same thing. The new name emphasizes that this is the maximum number of paths that will be provisioned. Port usage will not be more than the lessor of number of initiators * paths_per_initiator or max_paths, whichever is smaller.

The Storage Pool matcher will not match pools where the array containing the pool has less usable ports than max_paths.

Integer Valid Values:
  •  Range: 1..65535
<min_paths> The minimum number of paths that can be used between a host and a storage volume. If this many paths cannot be configured, Export requests will fail. Integer Valid Values:
  •  Range: 1..65535
<num_paths> Integer Valid Values:
  •  Range: 1..65535
<paths_per_initiator> The number of paths to be provisioned for each initiator that is used. In any event no more ports are used per host than max_paths. If there are excess initiators that cannot be paired with paths_per_initiator number of ports because max_paths is too low, the excess initiators are not provisioned. Integer Valid Values:
  •  Range: 1..65535
<raid_levels>
<raid_level> String 0-* Elements
</raid_levels>
<auto_tiering_policy_name> AutoTiering Policy Name can be specified, only if System Type is specified. AutoTiering Policy Name is supported only for System Types: vmax, vnxblock String
<drive_type> Supported Drive Type. Valid values: NONE = No specific drive type SSD = Solid State Drive FC = Fibre Channel SAS = Serial Attached SCSI SATA = Serial Advanced Technology Attachment String
<thin_volume_preallocation_percentage> PreAllocation size for VMAX Thin volumes. Integer
<multi_volume_consistency> Flag to specify whether a volume created in this pool could be added to a Consistency Group. Boolean
<fast_expansion> Indicates that virtual pool volumes should use concatenated meta volumes, not striped. Boolean
<expandable> Indicates if volume expansion is supported. Boolean
<protection>    
<continuous_copies>    
<max_native_continuous_copies> The maximum number of continuous copies for a virtual pool. Integer
<protection_mirror_vpool> The virtual pool for protection mirrors. URI
<haMaxMirrors> Integer
<ha_protection_mirror_vpool> The virtual pool for protection mirrors on the High Availability side. URI
</continuous_copies>      
<recoverpoint>    
<copies>
<protection_varray_vpool>     0-* Elements
<varray> The virtual array. URI
<vpool> The virtual pool. URI
<policy>    
<journal_size> The journal size for a protection copy. String
<journal_varray> The journal virtual array for a protection copy. URI
<journal_vpool> The journal virtual pool for a protection copy. URI
</policy>      
</protection_varray_vpool>      
</copies>
<source_policy>    
<journal_size> The journal size for a protection source. String
<journal_varray> The journal virtual array for a protection source/active source. URI
<journal_vpool> The journal virtual pool for a protection source/active source. URI
<standby_journal_varray> The journal virtual array for stand-by source. URI
<standby_journal_vpool> The journal virtual pool for stand-by source. URI
<remote_copy_mode> The remote copy mode, sync or async Valid value: ASYNCHRONOUS = RecoverPoint CG will be in Asynchronous mode (default) SYNCHRONOUS = RecoverPoint CG will be in Synchronous mode String
<rpo_value> RPO value sent to RP Long
<rpo_type> Type of RPO unit Valid values: SECONDS MINUTES HOURS WRITES BYTES KB MB GB TB String
</source_policy>      
</recoverpoint>      
<remote_copies>    
<remote_copy_settings>
<remote_copy_setting>     0-* Elements
<varray> URI
<vpool> URI
<remote_copy_mode> String
</remote_copy_setting>      
</remote_copy_settings>
</remote_copies>      
<snapshots>    
<max_native_snapshots> The maximum snapshots. Integer
</snapshots>      
</protection>      
<high_availability>    
<type> The high availability type. Valid values: vplex_local vplex_distributed String
<ha_varray_vpool>    
<varray> The virtual array. URI
<vpool> The virtual pool. URI
<activeProtectionAtHASite> Indicates whether or not to use the HA side of the VPlex as the RecoverPoint protected site in an RP+VPLEX setup. In a MetroPoint context, if true, this field indicates that the HA VPlex site will be the active site. Boolean
</ha_varray_vpool>      
<metroPoint> Flag to specify whether or not MetroPoint configuration will be used. Boolean
<autoCrossConnectExport> Flag to specify whether to automatically export both VPlex Clusters to cross-connected hosts. Boolean
</high_availability>      
<unique_auto_tier_policy_names> If set to true, then only unique Auto Tiering Policy Names will be returned else all policies will be returned. Boolean
<host_io_limit_bandwidth> Integer
<host_io_limit_iops> 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
<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
</block_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>

Examples

Request
POST https://192.168.0.0:4443/block/vpools/matching-pools HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<block_vpool_create>
     <use_matched_pools>true</use_matched_pools>
     <system_type>vnxblock</system_type>
     <provisioning_type>thin</provisioning_type>
</block_vpool_create>
Response
HTTP/1.1 200 OK 
Content-Type: application/xml 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <storage_pools>
       <storage_pool>
            <id>urn:storageos:StoragePool:5ec6fa92-1c94-4315-8b85-cbf9c91e25e9:</id>
            <link href="/vdc/storage-systems/urn:storageos:StorageSystem:ed5035a8-5f72-43e8-b970-847b4d76e17c:/storage-pools/urn:storageos:StoragePool:5ec6fa92-1c94-4315-8b85-cbf9c91e25e9:" rel="self"/>
            <name>CLARIION+APM00120400480+POOL+U+Pool 2</name>
       </storage_pool>
       <storage_pool>
            <id>urn:storageos:StoragePool:d4c6dd87-348f-422f-b3c4-2a6239734cb2:</id>
            <link href="/vdc/storage-systems/urn:storageos:StorageSystem:dc56440b-296c-4b7a-bd77-bf222cba45e2:/storage-pools/urn:storageos:StoragePool:d4c6dd87-348f-422f-b3c4-2a6239734cb2:" rel="self"/>
            <name>CLARIION+APM00121202922+POOL+U+Pool 2</name>
       </storage_pool>
       <storage_pool>
            <id>urn:storageos:StoragePool:53e905a7-9b4c-4e57-9a77-f98ddb67b66e:</id>
            <link href="/vdc/storage-systems/urn:storageos:StorageSystem:b03f9168-a7c8-49e1-a395-9d23a9999617:/storage-pools/urn:storageos:StoragePool:53e905a7-9b4c-4e57-9a77-f98ddb67b66e:" rel="self"/>
            <name>CLARIION+APM00120701245+POOL+U+Bourne Development</name>
       </storage_pool>
       <storage_pool>
            <id>urn:storageos:StoragePool:31d0cd23-d7b0-4c88-af71-690f5a4d3058:</id>
            <link href="/vdc/storage-systems/urn:storageos:StorageSystem:dc56440b-296c-4b7a-bd77-bf222cba45e2:/storage-pools/urn:storageos:StoragePool:31d0cd23-d7b0-4c88-af71-690f5a4d3058:" rel="self"/>
            <name>CLARIION+APM00121202922+POOL+U+Mixed Disk</name>
       </storage_pool>
            <storage_pool><id>urn:storageos:StoragePool:ffa42140-feea-4f92-aeac-5d787af599e6:</id>
            <link href="/vdc/storage-systems/urn:storageos:StorageSystem:dc56440b-296c-4b7a-bd77-bf222cba45e2:/storage-pools/urn:storageos:StoragePool:ffa42140-feea-4f92-aeac-5d787af599e6:" rel="self"/>
            <name>CLARIION+APM00121202922+POOL+U+cli</name>
       </storage_pool>
  </storage_pools>
Notes: