NatNetworkInDeviceIpsResource


Assign a nat ip of a nat network in a device to virtual datacenter


(purchase) Select a NAT IP in the NAT network and assign to a virtual datacenter.
Requires a ''virtualdatacenter'' link

POST https://example.com/api/cloud/locations/{location}/devices/{device}/natnetworks/{natnetwork}/ips

Roles : [ROLE_PHYS_DC_ALLOW_MODIFY_NETWORK, ROLE_MANAGE_NATIPS]

Content-Type : links Accept : natip

Error Codes

  • NAT-IP-5 - There is no IP available in the NAT network

Example

List nat ips of a nat network in a device


Retrieve NAT IPs of a NAT network.

GET https://example.com/api/cloud/locations/{location}/devices/{device}/natnetworks/{natnetwork}/ips

Roles : [ROLE_PHYS_DC_RETRIEVE_DETAILS, ROLE_VDC_ENUMERATE]

Parameter Type Default Value Description
startwith Integer 0 The first element to be retrieved of the filtered search
by String ip Order by
has String If present filter to apply in the search.
limit Integer 25 The number of entities to retrieve
asc Boolean true If the value of the 'by' parameter must be sorted in ascending order (true) or descending order (false)
ip String If present, filter by IP literal
vdcid Integer If present, filter by assigned to the virtual datacenter identifier
snatdefault Boolean false If true, only return NAT IPs being used as default SNAT in a virtual datacenter
assigned Boolean If true, only returns NAT IPs assigned to a virtual datacenter. If false, only returns NAT IPs not assigned to any virtual datacenter.
available Boolean If true, only returns available NAT IPs

Accept : natips

Example

Get a nat ip of a nat network in a device


GET https://example.com/api/cloud/locations/{location}/devices/{device}/natnetworks/{natnetwork}/ips/{ip}

Roles : [ROLE_PHYS_DC_RETRIEVE_DETAILS, ROLE_VDC_ENUMERATE]

Accept : natip

Example

Update a nat ip of a nat network in a device


Un-assign from a virtual datacenter (remvoe the ''virtualdatacenter'' link) or update the default SNAT role of the NAT IP

PUT https://example.com/api/cloud/locations/{location}/devices/{device}/natnetworks/{natnetwork}/ips/{ip}

Roles : [ROLE_PHYS_DC_ALLOW_MODIFY_NETWORK, ROLE_MANAGE_NATIPS]

Content-Type : natip Accept : natip

Error Codes

  • NAT-IP-11 - NAT IP is not attached
  • NAT-IP-14 - Cannot delete the default NAT IP of a VDC
  • NAT-IP-15 - To change the default SNAT IP, assign another NAT IP as the default for SNAT

Example