Host:Create Initiator

Search (SHIFT+S)

API Reference


Create Initiator

POST /compute/hosts/{id}/initiators

Creates a new initiator for a host.

idthe URN of a ViPR Host

Required Roles

  • TENANT_ADMIN

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<initiator_create>
<protocol> The protocols supported by the initiator which should be FC or iSCSI Valid values: FC iSCSI String
<initiator_node> The FC (Fibre Channel) initiator WWN (World Wide Name) of the initiator node String
<initiator_port> The initiator port which can be the WWN of an FC port or the IQN or EUI of an iSCSI port String
<name> The label of the initiator String
</initiator_create>

Response Body

The details of the host initiator when creation is successfully.

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

Field Description Type Notes
<task>
<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 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>

Examples

Request
POST https://192.168.0.0:4443/compute/hosts/urn:storageos:Host:0ad4cab1-77b6-4919-bfb5-07e1fc3f3ac5:/initiators HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<initiator_create>
       <protocol>iSCSI</protocol>
       <initiator_port>iqn.2001-10.com.emc.lss.host1</initiator_port>
</initiator_create>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
<initiator>
       <creation_time>1380656352646</creation_time>
       <id>urn:storageos:Initiator:6f67a31e-db04-4cd1-bd06-15a2f0acebb9:</id>
       <inactive>false</inactive>
       <link
              href="/compute/initiators/urn:storageos:Initiator:6f67a31e-db04-4cd1-bd06-15a2f0acebb9:"
              rel="self"/>
       <tags/>
       <host>
              <id>urn:storageos:Host:2df35fce-e946-4b5f-8598-676a94f29a59:</id>
              <link
                     href="/compute/hosts/urn:storageos:Host:2df35fce-e946-4b5f-8598-676a94f29a59:"
                     rel="self"/>
       </host>
       <protocol>iSCSI</protocol>
       <hostname>halahost1.lss.emc.com</hostname>
       <initiator_port>iqn.2001-10.com.emc.lss.host1</initiator_port>
</initiator>
Notes: