EMC ViPR REST API

Search (SHIFT+S)

API Reference


Get Virtual Pool

GET /block/vpools/{id}

Get info for block store virtual pool

idthe URN of a ViPR VirtualPool

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • SYSTEM_MONITOR

Response Body

VirtualPool details

Field Description Type Notes
<block_vpool>
<auto_tiering_policy_name> Name of the auto tier policy for the virtual pool. String
<drive_type> The supported disk drive type for the virtual pool. Valid values: NONE = No specific drive type SSD = Solid State Drive FC = Fibre Channel SAS = Serial Attached SCSI SATA = Serial Advanced Technology Attachment String
<expandable> Specifies whether or not volumes can be expanded. Boolean
<fast_expansion> Indicates that virtual pool volumes should use concatenated meta volumes, not striped. Boolean
<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>      
<thin_volume_preallocation_percentage> The preallocation size for VMAX thin volumes. Integer
<multi_volume_consistency> Specifies whether or not multi-volume consistency is supported for the virtual pool. 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>      
<raid_levels>
<raid_level> String 0-* Elements
</raid_levels>
<unique_auto_tier_policy_names> Specifies whether or not unique auto tier policy names are required. Boolean
<max_paths> Number of max paths supported by this virtual pool. Integer
<min_paths> Integer
<paths_per_initiator> Number of paths to be provisioned per initiator. Integer
<compression_enabled> Boolean
<host_io_limit_bandwidth> Integer
<host_io_limit_iops> Integer
<dedup_capable> Boolean
<placement_policy> Resource placement policy used by the virtual pool. Valid values: default_policy (storage system/pool selection based on metrics and capacity) array_affinity (storage system/pool selection based on host/cluster's array affinity first, then metrics and capacity) 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
</block_vpool>

Examples

Request
GET https://192.168.0.0:4443/block/vpools/urn:storageos:VirtualPool:18af14df-1f7e-4883-a0bd-44aee9372407: HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
Response
HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<block_vpool>
    <creation_time>1379170809621</creation_time>
    <id>urn:storageos:VirtualPool:18af14df-1f7e-4883-a0bd-44aee9372407:</id>
    <inactive>false</inactive>
    <link href="/block/vpools/urn:storageos:VirtualPool:18af14df-1f7e-4883-a0bd-44aee9372407:" rel="self"/>
    <name>Basic RP Protection</name>
    <tags/>
    <assigned_storage_pools/>
    <description>VPool for RP FC+ISCSI</description>
    <invalid_matched_pools/>
    <matched_storage_pools>
        <storage_pool>
            <id>urn:storageos:StoragePool:6d6956c6-8bd8-4507-adc5-62c4d2ec8ce7:</id>
            <link href="/vdc/storage-systems/urn:storageos:StorageSystem:033e2902-7fa6-4a89-b38e-1825bd801434:/storage-pools/urn:storageos:StoragePool:6d6956c6-8bd8-4507-adc5-62c4d2ec8ce7:" rel="self"/>
        </storage_pool>
        <storage_pool>
            <id>urn:storageos:StoragePool:049c6907-ed6c-4d79-816b-bb5b7324a659:</id>
            <link href="/vdc/storage-systems/urn:storageos:StorageSystem:c532fa10-1ff4-4527-b628-50372cf609af:/storage-pools/urn:storageos:StoragePool:049c6907-ed6c-4d79-816b-bb5b7324a659:" rel="self"/>
        </storage_pool>
        <storage_pool>
            <id>urn:storageos:StoragePool:ffd7dcc4-845b-4ef7-ba35-2639a64bdf04:</id>
            <link href="/vdc/storage-systems/urn:storageos:StorageSystem:739327ca-5da1-4452-a39c-5e6d0289706f:/storage-pools/urn:storageos:StoragePool:ffd7dcc4-845b-4ef7-ba35-2639a64bdf04:" rel="self"/>
        </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"/>
        </storage_pool>
        <storage_pool>
            <id>urn:storageos:StoragePool:ce4bc60d-7109-4b63-82aa-918e18c8301f:</id>
            <link href="/vdc/storage-systems/urn:storageos:StorageSystem:006195bf-53ae-4d16-a397-f0a756071caf:/storage-pools/urn:storageos:StoragePool:ce4bc60d-7109-4b63-82aa-918e18c8301f:" rel="self"/>
        </storage_pool>
        <storage_pool>
            <id>urn:storageos:StoragePool:86936add-c946-4285-aff8-28d074bf932b:</id>
            <link href="/vdc/storage-systems/urn:storageos:StorageSystem:c532fa10-1ff4-4527-b628-50372cf609af:/storage-pools/urn:storageos:StoragePool:86936add-c946-4285-aff8-28d074bf932b:" rel="self"/>
        </storage_pool>
        <storage_pool>
            <id>urn:storageos:StoragePool:6b161dc8-a5c3-4c0b-9434-5a7f5508e8a2:</id>
            <link href="/vdc/storage-systems/urn:storageos:StorageSystem:3d7afbb5-1c41-4cd4-a571-f61ba34f39e4:/storage-pools/urn:storageos:StoragePool:6b161dc8-a5c3-4c0b-9434-5a7f5508e8a2:" rel="self"/>
        </storage_pool>
    </matched_storage_pools>
    <num_paths>1</num_paths>
    <num_resources>0</num_resources>
    <protocols>
        <protocol>FC</protocol>
    </protocols>
    <provisioning_type>Thin</provisioning_type>
    <type>block</type>
    <use_matched_pools>true</use_matched_pools>
    <varrays>
        <varray>
            <id>urn:storageos:VirtualArray:110acf4a-2459-4025-adff-ce429fc4c5c3:</id>
            <link href="/vdc/varrays/urn:storageos:VirtualArray:110acf4a-2459-4025-adff-ce429fc4c5c3:" rel="self"/>
        </varray>
    </varrays>
    <expandable>true</expandable>
    <protection>
        <snapshots>
            <max_native_snapshots>0</max_native_snapshots>
        </snapshots>
        <continuous_copies>
            <max_native_continuous_copies>0</max_native_continuous_copies>
        </continuous_copies>
        <recoverpoint>
            <copies>
                <protection_varray_vpool>
                    <varray>urn:storageos:VirtualArray:110acf4a-2459-4025-adff-ce429fc4c5c3:</varray>
                    <vpool>urn:storageos:VirtualPool:bf7104ec-3db2-4dcb-9e0d-7232a4460aea:</vpool>
                    <policy/>
                </protection_varray_vpool>
            </copies>
        </recoverpoint>
    </protection>
    <raid_levels/>
    <unique_auto_tier_policy_names>false</unique_auto_tier_policy_names>
</block_vpool>