ngine_io.cloudstack.cs_region – Manages regions 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_region
.
New in version 0.1.0: of ngine_io.cloudstack
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.6
cs >= 0.9.0
Parameters
Parameter |
Comments |
---|---|
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: 10 |
|
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 |
|
Endpoint URL of the region. Required if state=present |
|
ID of the region. Must be an number (int). |
|
Name of the region. Required if state=present |
|
State of the region. 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 a region
ngine_io.cloudstack.cs_region:
id: 2
name: geneva
endpoint: https://cloud.gva.example.com
- name: remove a region with ID 2
ngine_io.cloudstack.cs_region:
id: 2
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Whether the GSLB service is enabled or not. Returned: success Sample: true |
|
ID of the region. Returned: success Sample: 1 |
|
Name of the region. Returned: success Sample: “local” |
|
Whether the portable IP service is enabled or not. Returned: success Sample: true |
Authors
René Moser (@resmo)