IP Interface:Get Ip Interface

Search (SHIFT+S)



Get Ip Interface

GET /compute/ip-interfaces/{id}

Shows the data for an IP interface

idthe URN of a ViPR IP interface

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR
  • SYSTEM_ADMIN
  • TENANT_ADMIN

Response Body

A IpInterfaceRestRep reference specifying the data for the IP interface with the passed id.

Field Description Type Notes
<ip_interface>
<ip_address> The IPv4 or IPv6 address of this interface. String Valid Values:
  •  example: 10.247.12.99
<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. 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
</ip_interface>
Notes: