ngine_io.cloudstack.cs_region – Manages regions on Apache CloudStack based clouds.
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.0.0).
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
Synopsis
- Add, update and remove regions.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- cs >= 0.9.0
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
api_http_method string |
|
HTTP method used to query the API endpoint. If not given, the |
api_key string / required |
API key of the CloudStack API. If not given, the | |
api_secret string / required |
Secret key of the CloudStack API. If not set, the | |
api_timeout integer |
Default: 10 |
HTTP timeout in seconds. If not given, the |
api_url string / required |
URL of the CloudStack API e.g. https://cloud.example.com/client/api. If not given, the | |
api_verify_ssl_cert string |
Verify CA authority cert file. If not given, the | |
endpoint string |
Endpoint URL of the region. Required if state=present | |
id integer / required |
ID of the region. Must be an number (int). | |
name string |
Name of the region. Required if state=present | |
state string |
|
State of the region. |
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 | Returned | Description |
---|---|---|
endpoint string |
success |
Endpoint of the region.
Sample: |
gslb_service_enabled boolean |
success |
Whether the GSLB service is enabled or not.
Sample: True |
id integer |
success |
ID of the region.
Sample: 1 |
name string |
success |
Name of the region.
Sample: local |
portable_ip_service_enabled boolean |
success |
Whether the portable IP service is enabled or not.
Sample: True |
Authors
- René Moser (@resmo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ngine_io/cloudstack/cs_region_module.html