CloudStack v2.2.13 - 2.2.14 User 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
networkid	The network this ip address should be associated to.	false
projectid	Deploy vm for the project	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
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