NatIpsResource


Create a nat ip


POST https://example.com/api/admin/datacenters/{datacenter}/natnetworks/{natnetwork}/ips

Roles : [ROLE_PHYS_DC_ALLOW_MODIFY_NETWORK]

Content-Type : natip Accept : natip

Error Codes

  • NAT-IP-9 - NAT IP does not belong to NAT network CIDR

Example

Create multiple nat ips


POST https://example.com/api/admin/datacenters/{datacenter}/natnetworks/{natnetwork}/ips

Roles : [ROLE_PHYS_DC_ALLOW_MODIFY_NETWORK]

Content-Type : ipsbulkcreation Accept : natips

Error Codes

  • NAT-IP-9 - NAT IP does not belong to NAT network CIDR

Example

List nat ips


Retrieve NAT IPs of a NAT network in a datacenter.

GET https://example.com/api/admin/datacenters/{datacenter}/natnetworks/{natnetwork}/ips

Roles : [ROLE_PHYS_DC_RETRIEVE_DETAILS]

Parameter Type Default Value Description
startwith Integer 0 The first element to be retrieved of the filtered search
by String ip Order by : {@link NatIpDAO.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 true filter by IP literal
available Boolean If true only return available NAT IPs. If false only return not available NAT IPs
snatdefault Boolean false If true only return NAT IPs being used as default SNAT in some virtual datacenter

Accept : natips

Example

Disable a nat ip in a nat network


POST https://example.com/api/admin/datacenters/{datacenter}/natnetworks/{natnetwork}/ips/action/disable

Roles : [ROLE_PHYS_DC_ALLOW_MODIFY_NETWORK]

Content-Type : ipliterals

Example

Disable all nat ips in a nat network


POST https://example.com/api/admin/datacenters/{datacenter}/natnetworks/{natnetwork}/ips/action/disableall

Roles : [ROLE_PHYS_DC_ALLOW_MODIFY_NETWORK]

Example

Enable a nat ip in a nat network


POST https://example.com/api/admin/datacenters/{datacenter}/natnetworks/{natnetwork}/ips/action/enable

Roles : [ROLE_PHYS_DC_ALLOW_MODIFY_NETWORK]

Content-Type : ipliterals

Example

Enable all nat ips in a nat network


POST https://example.com/api/admin/datacenters/{datacenter}/natnetworks/{natnetwork}/ips/action/enableall

Roles : [ROLE_PHYS_DC_ALLOW_MODIFY_NETWORK]

Example

Delete a nat ip


DELETE https://example.com/api/admin/datacenters/{datacenter}/natnetworks/{natnetwork}/ips/{ip}

Roles : [ROLE_PHYS_DC_ALLOW_MODIFY_NETWORK]

Example

Get a nat ip


GET https://example.com/api/admin/datacenters/{datacenter}/natnetworks/{natnetwork}/ips/{ip}

Roles : [ROLE_PHYS_DC_RETRIEVE_DETAILS]

Accept : natip

Example

Update quarantine in a nat ip


Toggle the quarantine flag in a NAT IP

POST https://example.com/api/admin/datacenters/{datacenter}/natnetworks/{natnetwork}/ips/{ip}/action/quarantine

Roles : [ROLE_PHYS_DC_ALLOW_MODIFY_NETWORK]

Accept : natip

Example