ngine_io.cloudstack.cs_zone – Manages zones 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_zone
.
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 |
|
DHCP provider for the Zone. |
|
First DNS for the zone. Required if state=present |
|
First DNS for IPv6 for the zone. |
|
Second DNS for the zone. |
|
Second DNS for IPv6 for the zone. |
|
Domain the zone is related to. Zone is a public zone if not set. |
|
Guest CIDR address for the zone. |
|
uuid of the existing zone. |
|
First internal DNS for the zone. If not set dns1 will be used on state=present. |
|
Second internal DNS for the zone. |
|
Whether to enable local storage for the zone or not.. Choices:
|
|
Name of the zone. |
|
Network domain for the zone. |
|
Network type of the zone. Choices:
|
|
Whether the zone is security group enabled or not. Choices:
|
|
State of the zone. Choices:
|
Notes
Note
A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
This module supports check mode.
Examples
- name: Ensure a zone is present
ngine_io.cloudstack.cs_zone:
name: ch-zrh-ix-01
dns1: 8.8.8.8
dns2: 8.8.4.4
network_type: basic
- name: Ensure a zone is disabled
ngine_io.cloudstack.cs_zone:
name: ch-zrh-ix-01
state: disabled
- name: Ensure a zone is enabled
ngine_io.cloudstack.cs_zone:
name: ch-zrh-ix-01
state: enabled
- name: Ensure a zone is absent
ngine_io.cloudstack.cs_zone:
name: ch-zrh-ix-01
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
State of the zone. Returned: success Sample: “Enabled” |
|
DHCP provider for the zone Returned: success Sample: “VirtualRouter” |
|
First DNS for the zone. Returned: success Sample: “8.8.8.8” |
|
First IPv6 DNS for the zone. Returned: success Sample: “2001:4860:4860::8888” |
|
Second DNS for the zone. Returned: success Sample: “8.8.4.4” |
|
Second IPv6 DNS for the zone. Returned: success Sample: “2001:4860:4860::8844” |
|
Domain the zone is related to. Returned: success Sample: “ROOT” |
|
Guest CIDR address for the zone Returned: success Sample: “10.1.1.0/24” |
|
UUID of the zone. Returned: success Sample: “04589590-ac63-4ffc-93f5-b698b8ac38b6” |
|
First internal DNS for the zone. Returned: success Sample: “8.8.8.8” |
|
Second internal DNS for the zone. Returned: success Sample: “8.8.4.4” |
|
Local storage offering enabled. Returned: success Sample: false |
|
Name of the zone. Returned: success Sample: “zone01” |
|
Network domain for the zone. Returned: success Sample: “example.com” |
|
Network type for the zone. Returned: success Sample: “basic” |
|
Security groups support is enabled. Returned: success Sample: false |
|
List of resource tags associated with the zone. Returned: success Sample: [{“key”: “foo”, “value”: “bar”}] |
|
Zone token Returned: success Sample: “ccb0a60c-79c8-3230-ab8b-8bdbe8c45bb7” |
Authors
René Moser (@resmo)