ngine_io.cloudstack.cs_instancegroup module – Manages instance groups on Apache CloudStack based clouds.
Note
This module is part of the ngine_io.cloudstack collection (version 2.3.0).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: ngine_io.cloudstack.cs_instancegroup
.
New in ngine_io.cloudstack 0.1.0
Synopsis
Create and remove instance groups.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
cs >= 0.9.0
Parameters
Parameter |
Comments |
---|---|
Account the instance group is related to. |
|
HTTP method used to query the API endpoint. If not given, the Choices:
|
|
API key of the CloudStack API. If not given, the |
|
Secret key of the CloudStack API. If not set, the |
|
HTTP timeout in seconds. If not given, the Default: |
|
URL of the CloudStack API e.g. https://cloud.example.com/client/api. If not given, the |
|
Verify CA authority cert file. If not given, the |
|
Domain the instance group is related to. |
|
Name of the instance group. |
|
Project the instance group is related to. |
|
State of the instance group. Choices:
|
Notes
Note
A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
This module supports check mode.
Examples
- name: Create an instance group
ngine_io.cloudstack.cs_instancegroup:
name: loadbalancers
- name: Remove an instance group
ngine_io.cloudstack.cs_instancegroup:
name: loadbalancers
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Account the instance group is related to. Returned: success Sample: |
|
Date when the instance group was created. Returned: success Sample: |
|
Domain the instance group is related to. Returned: success Sample: |
|
UUID of the instance group. Returned: success Sample: |
|
Name of the instance group. Returned: success Sample: |
|
Project the instance group is related to. Returned: success Sample: |