cs_ip_address - Manages public IP address associations on Apache CloudStack based clouds.¶

New in version 2.0.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
- Status
- Support

Synopsis ¶

Acquires and associates a public IP to an account or project. Due to API limitations this is not an idempotent call, so be sure to only conditionally call this when state=present

Requirements (on host that executes module)¶

python >= 2.6

cs >= 0.6.10

Options ¶

parameter	required	default	choices	comments
account	no			Account the IP address is related to.
api_http_method	no	get	get post	HTTP method used.
api_key	no			API key of the CloudStack API.
api_region	no	cloudstack		Name of the ini section in the `cloustack.ini` file.
api_secret	no			Secret key of the CloudStack API.
api_timeout	no	10		HTTP timeout.
api_url	no			URL of the CloudStack API e.g. https://cloud.example.com/client/api.
domain	no			Domain the IP address is related to.
ip_address	no			Public IP address. Required if `state=absent`
network	no			Network the IP address is related to.
poll_async	no	True		Poll async jobs until job has finished.
project	no			Name of the project the IP address is related to.
vpc (added in 2.2)	no			VPC the IP address is related to.
zone	no			Name of the zone in which the IP address is in. If not set, default zone is used.

Examples ¶

# Associate an IP address conditonally
- local_action:
    module: cs_ip_address
    network: My Network
  register: ip_address
  when: instance.public_ip is undefined

# Disassociate an IP address
- local_action:
    module: cs_ip_address
    ip_address: 1.2.3.4
    state: absent

Return Values ¶

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
project	Name of project the IP address is related to.	success	string	Production
domain	Domain the IP address is related to.	success	string	example domain
zone	Name of zone the IP address is related to.	success	string	ch-gva-2
ip_address	Public IP address.	success	string	1.2.3.4
account	Account the IP address is related to.	success	string	example account
id	UUID of the Public IP address.	success	string	a6f7a5fc-43f8-11e5-a151-feff819cdc9f

Notes ¶

Note

Ansible uses the cs library’s configuration method if credentials are not provided by the arguments api_url, api_key, api_secret. Configuration is read from several locations, in the following order. - The CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET and CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT environment variables. - A CLOUDSTACK_CONFIG environment variable pointing to an .ini file, - A cloudstack.ini file in the current working directory. - A .cloudstack.ini file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections in cloudstack.ini. Use the argument api_region to select the section name, default section is cloudstack. See https://github.com/exoscale/cs for more information.
A detailed guide about cloudstack modules can be found on http://docs.ansible.com/ansible/guide_cloudstack.html
This module supports check mode.

Status ¶

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Support ¶

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.