cs_zone - Manages zones on Apache CloudStack based clouds.
New in version 2.1.
Synopsis
Create, update and remove zones.
Requirements (on host that executes module)
- python >= 2.6
- cs >= 0.6.10
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| api_http_method |
no | get |
|
HTTP method used. |
| api_key |
no | API key of the CloudStack API. | ||
| api_region |
no | cloudstack | Name of the ini section in the cloustack.ini file. | |
| api_secret |
no | Secret key of the CloudStack API. | ||
| api_timeout |
no | 10 | HTTP timeout. | |
| api_url |
no | URL of the CloudStack API e.g. https://cloud.example.com/client/api. | ||
| dhcp_provider |
no | DHCP provider for the Zone. | ||
| dns1 |
no | First DNS for the zone. Required if state=present | ||
| dns1_ipv6 |
no | First DNS for IPv6 for the zone. | ||
| dns2 |
no | Second DNS for the zone. | ||
| dns2_ipv6 |
no | Second DNS for IPv6 for the zone. | ||
| domain |
no | Domain the zone is related to. Zone is a public zone if not set. | ||
| guest_cidr_address |
no | Guest CIDR address for the zone. | ||
| id |
no | uuid of the exising zone. | ||
| internal_dns1 |
no | First internal DNS for the zone. If not set dns1 will be used on state=present. | ||
| internal_dns2 |
no | Second internal DNS for the zone. | ||
| name |
yes | Name of the zone. | ||
| network_domain |
no | Network domain for the zone. | ||
| network_type |
no | basic |
|
Network type of the zone. |
| state |
no | present |
|
State of the zone. |
Examples
# Ensure a zone is present - local_action: module: cs_zone name: ch-zrh-ix-01 dns1: 8.8.8.8 dns2: 8.8.4.4 network_type: basic # Ensure a zone is disabled - local_action: module: cs_zone name: ch-zrh-ix-01 state: disabled # Ensure a zone is enabled - local_action: module: cs_zone name: ch-zrh-ix-01 state: enabled # Ensure a zone is absent - local_action: module: cs_zone name: ch-zrh-ix-01 state: absent
Return Values
Common return values are documented here Common Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| domain | Domain the zone is related to. | success | string | ROOT |
| tags | List of resource tags associated with the zone. | success | dict | [{'key': 'foo', 'value': 'bar'}] |
| dhcp_provider | DHCP provider for the zone | success | string | VirtualRouter |
| dns2_ipv6 | Second IPv6 DNS for the zone. | success | string | 2001:4860:4860::8844 |
| allocation_state | State of the zone. | success | string | Enabled |
| id | UUID of the zone. | success | string | 04589590-ac63-4ffc-93f5-b698b8ac38b6 |
| securitygroups_enabled | Security groups support is enabled. | success | bool | False |
| dns1_ipv6 | First IPv6 DNS for the zone. | success | string | 2001:4860:4860::8888 |
| internal_dns1 | First internal DNS for the zone. | success | string | 8.8.8.8 |
| internal_dns2 | Second internal DNS for the zone. | success | string | 8.8.4.4 |
| name | Name of the zone. | success | string | zone01 |
| dns2 | Second DNS for the zone. | success | string | 8.8.4.4 |
| dns1 | First DNS for the zone. | success | string | 8.8.8.8 |
| zone_token | Zone token | success | string | ccb0a60c-79c8-3230-ab8b-8bdbe8c45bb7 |
| guest_cidr_address | Guest CIDR address for the zone | success | string | 10.1.1.0/24 |
| network_domain | Network domain for the zone. | success | string | example.com |
| local_storage_enabled | Local storage offering enabled. | success | bool | False |
| network_type | Network type for the zone. | success | string | basic |
Notes
Note
Ansible uses the cs library’s configuration method if credentials are not provided by the arguments api_url, api_key, api_secret. Configuration is read from several locations, in the following order. - The CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET and CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT environment variables. - A CLOUDSTACK_CONFIG environment variable pointing to an .ini file, - A cloudstack.ini file in the current working directory. - A .cloudstack.ini file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections in cloudstack.ini. Use the argument api_region to select the section name, default section is cloudstack. See https://github.com/exoscale/cs for more information.
Note
This module supports check mode.
This is an Extras Module
For more information on what this means please read Extras Modules
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.