EMC ViPR REST API

Search (SHIFT+S)

API Reference


Get Auto Tier Policy

GET /vdc/auto-tier-policies/{id}

Show the specified auto tiering policy.

idthe URN of a ViPR auto tier policy

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • SYSTEM_MONITOR

Response Body

Policy Object

Field Description Type Notes
<auto_tiering_policy>
<policy_enabled> Determines the operational state of auto tiering policy Boolean
<policy_name> Name of the auto tiering policy String
<provisioning_type> The provisioning type of the auto tiering policy Valid value: Thin Thick All String
<system_type> The type of storage system to which the auto tiering policy belongs Valid value: vmax vnxblock String
<storage_system>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</storage_system>      
<storagegroup_name> Name of the default storage group. String
<storage_pools> The list of storage pools associated with this auto tiering policy String 0-* Elements
<native_guid> The native unique identifier for this resource

Network Transport Types:

  • FC = Fibre-Channel

Network System Types:

  • BROCADE
  • MDS

Storage System Types:

  • CELERRA = VNX File
  • CLARIION = VNX Block
  • ISILON
  • NETAPP
  • SYMMETRIX
Valid values: Network NetworkSystem StoragePool StoragePort StorageSystem StorageTier:VMAX StorageTier: VNX
String
<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
</auto_tiering_policy>

XML Example

Request
GET https://192.168.0.0:4443/vdc/auto-tier-policies/urn:storageos:AutoTieringPolicy:5adadd56-ea64-4a6c-9467-d2643fc8d8f1:

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"?>
  <auto_tiering_policy>
       <creation_time>1379168889435</creation_time>
       <id>urn:storageos:AutoTieringPolicy:5adadd56-ea64-4a6c-9467-d2643fc8d8f1:</id>
       <inactive>false</inactive>
       <link href="/vdc/auto-tier-policies/urn:storageos:AutoTieringPolicy:5adadd56-ea64-4a6c-9467-d2643fc8d8f1:" rel="self"/>
       <name>DEFAULT_HIGHEST_AVAILABLE</name>
       <tags/>
       <native_guid>CLARiiON+APM00112900836+FASTPOLICY+DEFAULT_HIGHEST_AVAILABLE</native_guid>
       <policy_enabled>true</policy_enabled>
       <policy_name>DEFAULT_HIGHEST_AVAILABLE</policy_name>
       <provisioning_type>All</provisioning_type>
       <storage_system>
            <id>urn:storageos:StorageSystem:c4ca726b-d108-49b5-8d79-ba060cc8775b:</id>
            <link href="/vdc/storage-systems/urn:storageos:StorageSystem:c4ca726b-d108-49b5-8d79-ba060cc8775b:" rel="self"/>
       </storage_system>
       <system_type>vnxblock</system_type>
  </auto_tiering_policy>