Docs4dev
Docs
ansible / latest / collections / ngine_io / cloudstack / cs_ip_address_module.html

ngine_io.cloudstack.cs_ip_address – Manages public IP address associations on Apache CloudStack based clouds.

Note

This plugin is part of the ngine_io.cloudstack collection (version 2.2.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install ngine_io.cloudstack.

To use it in a playbook, specify: ngine_io.cloudstack.cs_ip_address.

New in version 0.1.0: of ngine_io.cloudstack

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.
  • Tagging the IP address can also make the call idempotent.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • cs >= 0.9.0

Parameters

Parameter Choices/Defaults Comments
account
string
Account the IP address is related to.
api_http_method
string
    Choices:
  • get ←
  • post
HTTP method used to query the API endpoint.
If not given, the CLOUDSTACK_METHOD env variable is considered.
api_key
string / required
API key of the CloudStack API.
If not given, the CLOUDSTACK_KEY env variable is considered.
api_secret
string / required
Secret key of the CloudStack API.
If not set, the CLOUDSTACK_SECRET env variable is considered.
api_timeout
integer
Default:
10
HTTP timeout in seconds.
If not given, the CLOUDSTACK_TIMEOUT env variable is considered.
api_url
string / required
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the CLOUDSTACK_ENDPOINT env variable is considered.
api_verify_ssl_cert
string
Verify CA authority cert file.
If not given, the CLOUDSTACK_VERIFY env variable is considered.
domain
string
Domain the IP address is related to.
ip_address
string
Public IP address.
Required if state=absent and tags is not set.
network
string
Network the IP address is related to.
Mutually exclusive with vpc.
poll_async
boolean
    Choices:
  • no
  • yes ←
Poll async jobs until job has finished.
project
string
Name of the project the IP address is related to.
state
string
    Choices:
  • present ←
  • absent
State of the IP address.
tags
list / elements=dictionary
List of tags. Tags are a list of dictionaries having keys key and value.
Tags can be used as an unique identifier for the IP Addresses.
In this case, at least one of them must be unique to ensure idempotency.

aliases: tag
vpc
string
VPC the IP address is related to.
Mutually exclusive with network.
zone
string / required
Name of the zone in which the IP address is in.

Notes

Note

  • A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
  • This module supports check mode.

Examples

- name: Associate an IP address conditionally
  ngine_io.cloudstack.cs_ip_address:
    network: My Network
    zone: zone01
  register: ip_address
  when: instance.public_ip is undefined

- name: Disassociate an IP address
  ngine_io.cloudstack.cs_ip_address:
    ip_address: 1.2.3.4
    zone: zone01
    state: absent

- name: Associate an IP address with tags
  ngine_io.cloudstack.cs_ip_address:
    network: My Network
    zone: zone01
    tags:
      - key: myCustomID
        value: 5510c31a-416e-11e8-9013-02000a6b00bf
  register: ip_address

- name: Disassociate an IP address with tags
  ngine_io.cloudstack.cs_ip_address:
    state: absent
    zone: zone01
    tags:
      - key: myCustomID
        value: 5510c31a-416e-11e8-9013-02000a6b00bf

Return Values

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

Key Returned Description
account
string
success
Account the IP address is related to.

Sample:
example account
domain
string
success
Domain the IP address is related to.

Sample:
example domain
id
string
success
UUID of the Public IP address.

Sample:
a6f7a5fc-43f8-11e5-a151-feff819cdc9f
ip_address
string
success
Public IP address.

Sample:
1.2.3.4
project
string
success
Name of project the IP address is related to.

Sample:
Production
tags
dictionary
success
List of resource tags associated with the IP address.

Sample:
[ { "key": "myCustomID", "value": "5510c31a-416e-11e8-9013-02000a6b00bf" } ]
zone
string
success
Name of zone the IP address is related to.

Sample:
ch-gva-2


Authors

  • Darren Worrall (@dazworrall)
  • René Moser (@resmo)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ngine_io/cloudstack/cs_ip_address_module.html