EMC ViPR REST API

Search (SHIFT+S)

API Reference


Discover Protection Systems All

POST /vdc/protection-systems/discover

Allows the user to manually discover all protection systems.


Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • RESTRICTED_SYSTEM_ADMIN

Request Payload

No Request Payload


Response Body

This is an asychronous operation that returns a task object. For information on working with tasks, see Asynchronous Operations.

Field Description Type Notes
<tasks>
<task>     0-* Elements
<op_id> The task operation id String
<resource>    
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</resource>      
<tenant>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</tenant>      
<associated_resources> A list of links for associated resources
<associated_resource>     0-* Elements
<name> The name of the resource String
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</associated_resource>      
</associated_resources>
<state> The state of the task Valid values: queued = task is queued pending = task is pending ready = task succeed error = task fails suspended_error = task is suspended due to an error suspended_no_error = task is suspended due to config/request String
<allowed_operations> The allowed operations of the task String
<message> The task detail message String
<description> The description of the task String
<service_error>    
<code> The numerical code associated with the error encountered when processing a service request Integer
<description> The description of the error String
<details> Detailed information concerning the error String
</service_error>      
<start_time> The date and time of when the task was started DateTime
<end_time> The date and time of when the task ended DateTime
<progress> Integer
<workflow>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</workflow>      
<queuedStartTime> DateTime
<queueName> 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
</task>      
</tasks>

XML Example

Request
POST https://192.168.0.0:4443/vdc/protection-systems/discover HTTP/1.1

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<tasks>
    <task>
        <op_id>1a7fc01a-fd52-4309-9a80-3e7fa6842790</op_id>
        <resource>
            <id>urn:storageos:ProtectionSystem:1334de80-8efc-4c5b-951e-cf018c9e3efa:</id>
            <link href="/vdc/protection-systems/urn:storageos:ProtectionSystem:1334de80-8efc-4c5b-951e-cf018c9e3efa:" rel="self"/>
            <name>vRPA</name>
        </resource>
        <link href="/vdc/protection-systems/urn:storageos:ProtectionSystem:1334de80-8efc-4c5b-951e-cf018c9e3efa:/tasks/1a7fc01a-fd52-4309-9a80-3e7fa6842790" rel="self"/>
        <start_time>1380773404144</start_time>
        <state>pending</state>
    </task>
    <task>
        <op_id>e2aafb65-e069-48bb-a787-da9d1601555c</op_id>
        <resource>
            <id>urn:storageos:ProtectionSystem:201d8d6f-547f-4c4a-8a8f-d89647c238e2:</id>
            <link href="/vdc/protection-systems/urn:storageos:ProtectionSystem:201d8d6f-547f-4c4a-8a8f-d89647c238e2:" rel="self"/>
            <name>lglw6185</name>
        </resource>
        <link href="/vdc/protection-systems/urn:storageos:ProtectionSystem:201d8d6f-547f-4c4a-8a8f-d89647c238e2:/tasks/e2aafb65-e069-48bb-a787-da9d1601555c" rel="self"/>
        <start_time>1380773404173</start_time>
        <state>pending</state>
    </task>
    <task>
        <op_id>45e39ed2-6285-4554-a2b1-207930689194</op_id>
        <resource>
            <id>urn:storageos:ProtectionSystem:83d263f1-f59d-455b-80db-b17c627427c3:</id>
            <link href="/vdc/protection-systems/urn:storageos:ProtectionSystem:83d263f1-f59d-455b-80db-b17c627427c3:" rel="self"/>
            <name>rp_protection_system</name>
        </resource>
        <link href="/vdc/protection-systems/urn:storageos:ProtectionSystem:83d263f1-f59d-455b-80db-b17c627427c3:/tasks/45e39ed2-6285-4554-a2b1-207930689194" rel="self"/>
        <start_time>1380773404281</start_time>
        <state>pending</state>
    </task>
</tasks>