EMC ViPR REST API

Search (SHIFT+S)

API Reference


Get Virtual Array

GET /vdc/varrays/{id}

Get info for VirtualArray

idthe URN of a ViPR VirtualArray

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • SYSTEM_MONITOR

Response Body

VirtualArray details

Field Description Type Notes
<varray>
<block_settings>    
<auto_san_zoning> Boolean
</block_settings>      
<object_settings>    
<device_registered> if device is registered Boolean
<protection_type> varray protection type String
</object_settings>      
<auto_san_zoning> ViPR creates the required zones in the SAN fabric when a request to export a volume is made in this virtualstorage array. This will allow the exported volume to be visible on the specified hosts. Boolean
<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
</varray>

Examples

Request
GET https://192.168.0.0:4443/vdc/varrays/urn:storageos:VirtualArray:110acf4a-2459-4025-adff-ce429fc4c5c3: 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"?>
  <varray>
       <creation_time>1379169014280</creation_time>
       <id>urn:storageos:VirtualArray:110acf4a-2459-4025-adff-ce429fc4c5c3:</id>
       <inactive>false</inactive>
       <link href="/vdc/varrays/urn:storageos:VirtualArray:110acf4a-2459-4025-adff-ce429fc4c5c3:" rel="self"/>
       <name>Freemont</name>
       <tags/>
       <auto_san_zoning>true</auto_san_zoning>
  </varray>