EMC ViPR REST API

Search (SHIFT+S)

API Reference


Get File Virtual Pool

GET /file/vpools/{id}

Get info for File Store VirtualPool

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
<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>

Examples

Request
GET https://192.168.0.0:4443/file/vpools/urn:storageos:VirtualPool:0a846371-d0f8-4e1a-9fc4-7035b8ee58f0: 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"?>
<file_vpool>
    <creation_time>1379828525989</creation_time>
    <id>urn:storageos:VirtualPool:0a846371-d0f8-4e1a-9fc4-7035b8ee58f0:</id>
    <inactive>false</inactive>
    <link href="/file/vpools/urn:storageos:VirtualPool:0a846371-d0f8-4e1a-9fc4-7035b8ee58f0:" rel="self"/>
    <name>Medium_Performance_File_Real</name>
    <tags/>
    <assigned_storage_pools>
        <storage_pool>
            <id>urn:storageos:StoragePool:97cb123e-125d-4e58-b86f-0072337a1e5d:</id>
            <link href="/vdc/storage-systems/urn:storageos:StorageSystem:c4362098-8928-4464-812e-41e22797457a:/storage-pools/urn:storageos:StoragePool:97cb123e-125d-4e58-b86f-0072337a1e5d:" rel="self"/>
        </storage_pool>
    </assigned_storage_pools>
    <description>Medium_Performance_File_Real</description>
    <invalid_matched_pools/>
    <matched_storage_pools>
        <storage_pool>
            <id>urn:storageos:StoragePool:97cb123e-125d-4e58-b86f-0072337a1e5d:</id>
            <link href="/vdc/storage-systems/urn:storageos:StorageSystem:c4362098-8928-4464-812e-41e22797457a:/storage-pools/urn:storageos:StoragePool:97cb123e-125d-4e58-b86f-0072337a1e5d:" rel="self"/>
        </storage_pool>
    </matched_storage_pools>
    <num_resources>160</num_resources>
    <protocols>
        <protocol>NFS</protocol>
    </protocols>
    <provisioning_type>Thin</provisioning_type>
    <system_type>NONE</system_type>
    <type>file</type>
    <use_matched_pools>false</use_matched_pools>
    <varrays>
        <varray>
            <id>urn:storageos:VirtualArray:ff4c01e2-6288-4a8c-8ccb-b856b0cca6b4:</id>
            <link href="/vdc/varrays/urn:storageos:VirtualArray:ff4c01e2-6288-4a8c-8ccb-b856b0cca6b4:" rel="self"/>
        </varray>
    </varrays>
    <protection>
        <snapshots>
            <max_native_snapshots>1234567</max_native_snapshots>
        </snapshots>
    </protection>
</file_vpool>