W3cubDocs

/Ansible

cs_affinitygroup - Manages affinity groups on Apache CloudStack based clouds.

New in version 2.0.

Synopsis

  • Create and remove affinity groups.

Requirements (on host that executes module)

  • python >= 2.6
  • cs >= 0.6.10

Options

parameter required default choices comments
account
 no
Account the affinity group is related to.
affinty_type
 no
Type of the affinity group. If not specified, first found affinity type is used.
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.
description
 no
Description of the affinity group.
domain
 no
Domain the affinity group is related to.
name
 yes
Name of the affinity group.
poll_async
 no True
Poll async jobs until job has finished.
project
 no
Name of the project the affinity group is related to.
state
 no present
  • present
  • absent
State of the affinity group.

Examples

# Create a affinity group
- local_action:
    module: cs_affinitygroup
    name: haproxy
    affinty_type: host anti-affinity

# Remove a affinity group
- local_action:
    module: cs_affinitygroup
    name: haproxy
    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 affinity group is related to.
 success string Production
domain
Domain the affinity group is related to.
 success string example domain
description
Description of affinity group.
 success string application affinity group
name
Name of affinity group.
 success string app
account
Account the affinity group is related to.
 success string example account
affinity_type
Type of affinity group.
 success string host anti-affinity
id
UUID of the affinity group.
 success string 87b1e0ce-4e01-11e4-bb66-0050569e64b8

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.

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

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/cs_affinitygroup_module.html