EMC ViPR REST API

Search (SHIFT+S)

API Reference


Get Protection System

GET /vdc/protection-systems/{id}

Get information about the registered protection system with the passed id.

idthe URN of a ViPR protection system.

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN
  • SYSTEM_MONITOR

Response Body

A reference to a ProtectionSystemRestRep

Field Description Type Notes
<protection_system>
<installation_id> The Installation ID of this Protection System String
<ip_address> IP Address of the Protection System device String
<major_version> The Major Version of the Protection System device String
<minor_version> The Minor Version of the Protection System device String
<port_number> Management Port Number of the Protection System device Integer
<reachable> Reachable Status which indicates that the Portection System is reachable by ViPR doing a ping. (establish connection) Boolean
<user_name> String
<clusters>     0-* Elements
<cluster_name> String
<cluster_id> String
<assigned_virtual_array> String 0-* Elements
</clusters>      
<last_discovery_status_message> The last discovery status message for this system String
<system_type> A short mnemonic that indicates what kind of system is being represented. Valid values: brocade isilon netapp mds = Cisco MDS series swicth rp = Recoverpoint vmax vnxblock vnxfile vplex String
<job_discovery_status> The status of the last discovery job for this system Valid values: CREATED IN_PROGRESS COMPLETE ERROR String
<last_discovery_run_time> The timestamp for the last discovery job for this system Long
<last_metering_run_time> The timestamp for the last metric collection job for this system Long
<job_metering_status> The status of the last metric collection job for this system Valid values: CREATED IN_PROGRESS COMPLETE ERROR String
<next_discovery_run_time> The timestamp for the next scheduled discovery job for this system Long
<next_metering_run_time> The timestamp for the next scheduled metric collection job for this system Long
<success_discovery_time> The latest timestamp when the system run Discovery successfully Long
<success_metering_time> The latest timestamp when the system run Metering successfully Long
<registration_status> Whether or not the system is registered with ViPR. A system must be registered before it can be managed by ViPR. Valid values: REGISTERED UNREGISTERED String
<compatibility_status> Whether or not this system is compatible with ViPR. Valid values: OMPATIBLE INCOMPATIBLE UNKNOWN String
<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
</protection_system>

Examples

Request
GET https://192.168.0.0:4443/vdc/protection-systems/urn:storageos:ProtectionSystem:10cdc65d-3d36-4e19-b1f6-c9f396df27e7: 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"?>
<protection_system>
   <compatibility_status>COMPATIBLE</compatibility_status>
   <creation_time>1380721813332</creation_time>
   <id>urn:storageos:ProtectionSystem:10cdc65d-3d36-4e19-b1f6-c9f396df27e7:</id>
   <inactive>false</inactive>
   <installation_id>6b93babb3bc882b3a1695247e2d9b78f13ebddc0</installation_id>
   <ip_address>example.com</ip_address>
   <job_discovery_status>COMPLETE</job_discovery_status>
   <job_metering_status>CREATED</job_metering_status>
   <last_discovery_run_time>1380721825711</last_discovery_run_time>
   <last_discovery_status_message>Discovery completed successfully for Protection System: urn:storageos:ProtectionSystem:10cdc65d-3d36-4e19-b1f6-c9f396df27e7:</last_discovery_status_message>
   <last_metering_run_time>0</last_metering_run_time>
   <link href="/vdc/protection-systems/urn:storageos:ProtectionSystem:10cdc65d-3d36-4e19-b1f6-c9f396df27e7:"
      rel="self"/>
   <major_version>3.5.SP2(p.74)</major_version>
   <name>rp_protection_system</name>
   <native_guid>RP+6b93babb3bc882b3a1695247e2d9b78f13ebddc0</native_guid>
   <next_discovery_run_time>1380725413402</next_discovery_run_time>
   <next_metering_run_time>0</next_metering_run_time>
   <port_number>7225</port_number>
   <registration_status>REGISTERED</registration_status>
   <secondary_ip>192.168.0.10</secondary_ip>
   <system_type>rp</system_type>
   <tags/>
   <user_name>admin</user_name>
</protection_system>