NetworkInDeviceIpsResource


List external ips from a network defined for a device


Retrieve external IPs from a network defined for a device.
By default it only returns the available IPs, and there is a filter to return all of them.

GET https://example.com/api/cloud/locations/{location}/devices/{device}/networks/{network}/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 How to order the search. Available values are: \{IP, QUARANTINE, MAC, LEASE, VLAN, VIRTUALDATACENTER, VIRTUALMACHINE, VIRTUALAPPLIANCE, ENTERPRISENAME\}
has String If present filter to apply in the search.
ip String If present, filter to look up by IP literal
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)
free Boolean false If present and true, filter only IPs not assigned to VM; Otherwise, filter used IPs.
available Boolean If present and true, filter only available IPs, or false, filter not available ones. Default false

Accept : externalips

Example

List public ips from a network defined for a device


Retrieve public IPs from a network defined for a device.
By default it only returns the available IPs, and there is a filter to return all of them.

GET https://example.com/api/cloud/locations/{location}/devices/{device}/networks/{network}/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 How to order the search. Available values are: \{IP, QUARANTINE, MAC, LEASE, VLAN, VIRTUALDATACENTER, VIRTUALMACHINE, VIRTUALAPPLIANCE, ENTERPRISENAME\}
has String If present filter to apply in the search.
ip String if present filter to lookup by IP literal *
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)
available Boolean if present and true filter only available IPs or false to not available ones. Default false

Accept : publicips

Example

List unmanaged ips from a network defined for a device


Retrieve unmanaged IPs from a network defined for a device.
By default it only returns the available IPs, and there is a filter to return all of them.

GET https://example.com/api/cloud/locations/{location}/devices/{device}/networks/{network}/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 How to order the search. Available values are: \{IP, QUARANTINE, MAC, LEASE, VLAN, VIRTUALDATACENTER, VIRTUALMACHINE, VIRTUALAPPLIANCE, ENTERPRISENAME\}
has String If present filter to apply in the search.
ip String if present filter to lookup by IP literal
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)
free Boolean false if present and true filter only not assigned to vm. Otherwise used ones.
available Boolean if present and true filter only available IPs or false to not available ones. Default false

Accept : unmanagedips

Example

Get a external ip from a network defined for a device


Retrieve an external IP from a network defined for a device

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

Roles : [ROLE_PHYS_DC_RETRIEVE_DETAILS, ROLE_VDC_ENUMERATE]

Accept : externalip

Example

Get a public ip from a network defined for a device


Retrieve a public IP from a network defined for a device

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

Roles : [ROLE_PHYS_DC_RETRIEVE_DETAILS, ROLE_VDC_ENUMERATE]

Accept : publicip

Get a unmanaged ip from a network defined for a device


Retrieve an unmanaged IP from a network defined for a device

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

Roles : [ROLE_PHYS_DC_RETRIEVE_DETAILS, ROLE_VDC_ENUMERATE]

Accept : unmanagedip

Example