New in version 2.0.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
---|---|---|
account
|
Default:
None
|
Account the affinity group is related to.
|
affinity_type
|
Default:
None
|
Type of the affinity group. If not specified, first found affinity type is used.
aliases: affinty_type |
api_http_method
|
|
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
|
Default:
None
|
Description of the affinity group.
|
domain
|
Default:
None
|
Domain the affinity group is related to.
|
name
required |
|
Name of the affinity group.
|
poll_async
|
Default:
yes
|
Poll async jobs until job has finished.
|
project
|
Default:
None
|
Name of the project the affinity group is related to.
|
state
|
|
State of the affinity group.
|
Note
# 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
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
|
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
Hint
If you notice any issues in this documentation you can edit this document to improve it.