EMC ViPR REST API

Search (SHIFT+S)

API Reference


Deregister Ip Interface

POST /compute/ip-interfaces/{id}/deregister

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

idthe URN of a ViPR IP interface

Required Roles

  • TENANT_ADMIN

Request Payload

No Request Payload


Response Body

Status response indicating success or failure

Field Description Type Notes
<ip_interface>
<ip_address> The IPv4 or IPv6 address of this interface. String
<netmask> Gets the netmask of an IPv4 address expressed as the integer prefix in an IPv4 address CIDR notation. For example 24 for 255.255.255.0 and 16 for 255.255.0.0 etc.. String
<prefix_length> Returns the prefix length for an IPv6 interface Integer
<scope_id> Gets the scope id for an IPv6 interface. String
<name> Gets the name of the interface 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
</ip_interface>