Apache CloudStack 4.18.0.0 Root Admin API Reference
associateIpAddress
Acquires and associates a public IP to an account.
Request parameters
| Parameter Name | Description | Required |
| account | the account to associate with this IP address | false |
| domainid | the ID of the domain to associate with this IP address | false |
| fordisplay | an optional field, whether to the display the IP to the end user or not | false |
| ipaddress | IP Address to be associated | false |
| isportable | should be set to true if public IP is required to be transferable across zones, if not specified defaults to false | false |
| networkid | The network this IP address should be associated to. | false |
| projectid | Deploy VM for the project | false |
| regionid | region ID from where portable IP is to be associated. | false |
| vpcid | the VPC you want the IP address to be associated with | false |
| zoneid | the ID of the availability zone you want to acquire an public IP address from | 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 |
| associatednetworkname | the name 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 |
| fordisplay | is public ip for display to the regular user |
| forvirtualnetwork | the virtual network for the IP address |
| ipaddress | public IP address |
| isportable | is public IP portable across the zones |
| issourcenat | true if the IP address is a source nat address, false otherwise |
| isstaticnat | true if this ip is for static nat, false otherwise |
| issystem | true if this ip is system ip (was allocated as a part of deployVm or createLbRule) |
| networkid | the ID of the Network where ip belongs to |
| networkname | the name 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 |
| purpose | purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value |
| state | State of the ip address. Can be: Allocatin, Allocated and Releasing |
| virtualmachinedisplayname | virtual machine display name the ip address is assigned to (not null only for static nat Ip) |
| virtualmachineid | virtual machine id the ip address is assigned to (not null only for static nat Ip) |
| virtualmachinename | virtual 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. This parameter is visible to ROOT admins only |
| vlanname | the VLAN associated with the IP address |
| vmipaddress | virtual machine (dnat) ip address (not null only for static nat Ip) |
| vpcid | VPC id the ip belongs to |
| vpcname | VPC name the ip belongs to |
| zoneid | the ID of the zone the public IP address belongs to |
| zonename | the name of the zone the public IP address belongs to |
| tags(*) | the list of resource tags associated with ip address |
| account | the account associated with the tag |
| customer | customer associated with the tag |
| domain | the domain associated with the tag |
| domainid | the ID of the domain associated with the tag |
| key | tag key name |
| project | the project name where tag belongs to |
| projectid | the project id the tag belongs to |
| resourceid | id of the resource |
| resourcetype | resource type |
| value | tag value |
| jobid | the ID of the latest async job acting on this object |
| jobstatus | the current status of the latest async job acting on this object |