CloudStack v2.2.13 - 2.2.14 Root Admin API Reference
listPublicIpAddresses
Lists all public ip addresses
Request parameters
Parameter Name | Description | Required |
allocatedonly | limits search results to allocated public IP addresses | false |
associatednetworkid | lists all public IP addresses associated to the network specified | false |
forloadbalancing | list only ips used for load balancing | false |
forvirtualnetwork | the virtual network for the IP address | false |
id | lists ip address by id | false |
ipaddress | lists the specified IP address | false |
issourcenat | list only source nat ip addresses | false |
isstaticnat | list only static nat ip addresses | false |
physicalnetworkid | lists all public IP addresses by physical network id | false |
projectid | list firewall rules by project | false |
vlanid | lists all public IP addresses by VLAN ID | false |
zoneid | lists all public IP addresses by Zone ID | false |
Response Tags
Response Name | Description |
id | public IP address id |
account | the account the public IP address is associated with |
allocated | date the public IP address was acquired |
associatednetworkid | the ID of the Network associated with the IP address |
domain | the domain the public IP address is associated with |
domainid | the domain ID the public IP address is associated with |
forvirtualnetwork | the virtual network for the IP address |
ipaddress | public IP address |
iselastic | true if this ip is elastic ip (was allocated as a part of deployVm or createLbRule) |
issourcenat | true if the IP address is a source nat address, false otherwise |
isstaticnat | true if this ip is for static nat, false otherwise |
networkid | the ID of the Network where ip belongs to |
physicalnetworkid | the physical network this belongs to |
project | the project name of the address |
projectid | the project id of the ipaddress |
state | State of the ip address. Can be: Allocatin, Allocated and Releasing |
virtualmachinedisplayname | virutal machine display name the ip address is assigned to (not null only for static nat Ip) |
virtualmachineid | virutal machine id the ip address is assigned to (not null only for static nat Ip) |
virtualmachinename | virutal machine name the ip address is assigned to (not null only for static nat Ip) |
vlanid | the ID of the VLAN associated with the IP address |
vlanname | the VLAN associated with the IP address |
zoneid | the ID of the zone the public IP address belongs to |
zonename | the name of the zone the public IP address belongs to |