ngine_io.cloudstack.cs_affinitygroup – Manages affinity groups 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_affinitygroup.

New in version 0.1.0: of ngine_io.cloudstack

Synopsis

  • Create and remove affinity groups.

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 affinity group is related to.
affinity_type
string
Type of the affinity group. If not specified, first found affinity type is used.
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.
description
string
Description of the affinity group.
domain
string
Domain the affinity group is related to.
name
string / required
Name of the affinity group.
poll_async
boolean
    Choices:
  • no
  • yes ←
Poll async jobs until job has finished.
project
string
Name of the project the affinity group is related to.
state
string
    Choices:
  • present ←
  • absent
State of the affinity group.

Notes

Note

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

Examples

- name: Create a affinity group
  ngine_io.cloudstack.cs_affinitygroup:
    name: haproxy
    affinity_type: host anti-affinity

- name: Remove a affinity group
  ngine_io.cloudstack.cs_affinitygroup:
    name: haproxy
    state: absent

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 affinity group is related to.

Sample:
example account
affinity_type
string
success
Type of affinity group.

Sample:
host anti-affinity
description
string
success
Description of affinity group.

Sample:
application affinity group
domain
string
success
Domain the affinity group is related to.

Sample:
example domain
id
string
success
UUID of the affinity group.

Sample:
87b1e0ce-4e01-11e4-bb66-0050569e64b8
name
string
success
Name of affinity group.

Sample:
app
project
string
success
Name of project the affinity group is related to.

Sample:
Production


Authors

  • 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_affinitygroup_module.html