EMC ViPR REST API

Search (SHIFT+S)

API Reference


Create Ip Interface

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

Creates a new ip interface 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
<ip_interface_create>
<protocol> The protocol supported by the interface which should be IPv4 or IPv6. String
<ip_address> The IPv4 or IPv6 address of this interface. String
<netmask> 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.. Integer Valid Values:
  •  Range: 1..32
<prefix_length> The IPv6 prefix length. Integer Valid Values:
  •  Range: 1..128
<scope_id> The IPv6 scope id. String
<name> The name of the IpInterface String
</ip_interface_create>

Response Body

The details of the host interface, including its id and link, when creation completes successfully.

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>

Examples

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

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>
<ip_interface_create>
       <protocol>IPV4</protocol>
       <ip_address>1.1.1.1</ip_address>
       <netmask>24</netmask>
</ip_interface_create>
Response
HTTP/1.1 200 OK
Content-Type: application/xml

<ip_interface>
       <creation_time>1380655859544</creation_time>
       <id>urn:storageos:IpInterface:1e77789f-5ce0-4de0-87df-cc9599c491e8:</id>
       <inactive>false</inactive>
       <link
              href="/compute/ip-interfaces/urn:storageos:IpInterface:1e77789f-5ce0-4de0-87df-cc9599c491e8:"
              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>IPV4</protocol>
       <ip_address>1.1.1.1</ip_address>
       <netmask>24</netmask>
</ip_interface>