cs_affinitygroup - Manages affinity groups on Apache CloudStack based clouds.¶

New in version 2.0.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

Synopsis ¶

Create and remove affinity groups.

Requirements ¶

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

python >= 2.6
cs >= 0.6.10

Parameters ¶

Parameter	Choices/Defaults	Comments
account		Account the affinity group is related to.
affinity_type		Type of the affinity group. If not specified, first found affinity type is used. aliases: affinty_type
api_http_method	Choices: get post	HTTP method used to query the API endpoint. If not given, the `CLOUDSTACK_METHOD` env variable is considered. As the last option, the value is taken from the ini config file, also see the notes. Fallback value is `get` if not specified.
api_key		API key of the CloudStack API. If not given, the `CLOUDSTACK_KEY` env variable is considered. As the last option, the value is taken from the ini config file, also see the notes.
api_region	Default: cloudstack	Name of the ini section in the `cloustack.ini` file. If not given, the `CLOUDSTACK_REGION` env variable is considered.
api_secret		Secret key of the CloudStack API. If not set, the `CLOUDSTACK_SECRET` env variable is considered. As the last option, the value is taken from the ini config file, also see the notes.
api_timeout		HTTP timeout in seconds. If not given, the `CLOUDSTACK_TIMEOUT` env variable is considered. As the last option, the value is taken from the ini config file, also see the notes. Fallback value is 10 seconds if not specified.
api_url		URL of the CloudStack API e.g. https://cloud.example.com/client/api. If not given, the `CLOUDSTACK_ENDPOINT` env variable is considered. As the last option, the value is taken from the ini config file, also see the notes.
description		Description of the affinity group.
domain		Domain the affinity group is related to.
name required		Name of the affinity group.
poll_async bool	Choices: no yes ←	Poll async jobs until job has finished.
project		Name of the project the affinity group is related to.
state	Choices: present ← absent	State of the affinity group.

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 in the CloudStack Cloud Guide.
This module supports check mode.

Examples ¶

# Create a affinity group
- local_action:
    module: cs_affinitygroup
    name: haproxy
    affinity_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, 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

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.

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

René Moser (@resmo)

Hint

If you notice any issues in this documentation you can edit this document to improve it.