EMC ViPR REST API

Search (SHIFT+S)

API Reference


Get Initiator

GET /compute/initiators/{id}

Show the information for an initiator.

idthe URN of a ViPR initiator

Required Roles

This call has no restrictions.


Response Body

A reference to an InitiatorRestRep specifying the initiator data.

Field Description Type Notes
<initiator>
<hostname> The host name for the initiator. String
<clustername> The name of the cluster for the initiator. String
<initiator_node> The initiator node. String
<initiator_port> The port for the initiator. String
<label> The label for the initiator. String
<host>    
<id> ViPR ID of the related object URI
<link> A hyperlink to the related object
</host>      
<protocol> The host interface protocol. String
<registration_status> The host interface registration status. Only registered hosts can be used for provisioning operations. Valid values: UNREGISTERED REGISTERED 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
</initiator>

Examples

Request
GET https://192.168.0.0:4443/compute/initiators/urn:storageos:Initiator:03063015-055b-425c-99c8-540c3dacc1c7: 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"?>
  <initiator>
       <creation_time>1379175929788</creation_time>
       <id>urn:storageos:Initiator:03063015-055b-425c-99c8-540c3dacc1c7:</id>
       <inactive>false</inactive>
       <link href="/compute/initiators/urn:storageos:Initiator:03063015-055b-425c-99c8-540c3dacc1c7:" rel="self"/>
       <name>vmhba33</name>
       <tags/>
       <host>
            <id>urn:storageos:Host:3c817b8c-896e-43ab-9909-04449293c1a1:</id>
            <link href="/compute/hosts/urn:storageos:Host:3c817b8c-896e-43ab-9909-04449293c1a1:" rel="self"/>
       </host>
       <protocol>iSCSI</protocol>
       <hostname>lrmc071.lss.emc.com</hostname>
       <initiator_node></initiator_node>
       <initiator_port>iqn.1998-01.com.vmware:lrmc071-5d6356a7</initiator_port>
  </initiator>