Initiator:Deregister Initiator

Search (SHIFT+S)



Deregister Initiator

POST /compute/initiators/{id}/deregister

Allows the user to deregister a registered initiator so that it is no longer used by the system. This simply sets the registration_status of the initiator to UNREGISTERED.

idthe URN of a ViPR initiator

Required Roles

  • TENANT_ADMIN

Request Payload

No Request Payload


Response Body

Status response indicating success or failure

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. String Valid Values:
  •  UNREGISTERED
  •  REGISTERED
<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 Valid Values:
  •  urn:storageos:resource-type:UUID:
<link> A hyperlink to the details for this resource
<creation_time> A timestamp that shows when this resource was created in ViPR DateTime Valid Values:
  •  YYYY-MM-DDTHH:mm:ssZ
<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 Valid Values:
  •  true
  •  false
<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 Valid Values:
  •  true
  •  false
</initiator>
Notes: