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

Synopsis

  • Create, update and remove zones.

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
    Choices:
  • get ←
  • post
HTTP method used to query the API endpoint.
If not given, the CLOUDSTACK_METHOD env variable is considered.
api_key
string / required
API key of the CloudStack API.
If not given, the CLOUDSTACK_KEY env variable is considered.
api_secret
string / required
Secret key of the CloudStack API.
If not set, the CLOUDSTACK_SECRET env variable is considered.
api_timeout
integer
Default:
10
HTTP timeout in seconds.
If not given, the CLOUDSTACK_TIMEOUT env variable is considered.
api_url
string / required
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
If not given, the CLOUDSTACK_ENDPOINT env variable is considered.
api_verify_ssl_cert
string
Verify CA authority cert file.
If not given, the CLOUDSTACK_VERIFY env variable is considered.
dhcp_provider
string
DHCP provider for the Zone.
dns1
string
First DNS for the zone.
Required if state=present
dns1_ipv6
string
First DNS for IPv6 for the zone.
dns2
string
Second DNS for the zone.
dns2_ipv6
string
Second DNS for IPv6 for the zone.
domain
string
Domain the zone is related to.
Zone is a public zone if not set.
guest_cidr_address
string
Guest CIDR address for the zone.
id
string
uuid of the existing zone.
internal_dns1
string
First internal DNS for the zone.
If not set dns1 will be used on state=present.
internal_dns2
string
Second internal DNS for the zone.
local_storage_enabled
boolean
    Choices:
  • no
  • yes
Whether to enable local storage for the zone or not..
name
string / required
Name of the zone.
network_domain
string
Network domain for the zone.
network_type
string
    Choices:
  • Basic ←
  • Advanced
Network type of the zone.
securitygroups_enabled
boolean
    Choices:
  • no
  • yes
Whether the zone is security group enabled or not.
state
string
    Choices:
  • present ←
  • enabled
  • disabled
  • absent
State of the zone.

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 Returned Description
allocation_state
string
success
State of the zone.

Sample:
Enabled
dhcp_provider
string
success
DHCP provider for the zone

Sample:
VirtualRouter
dns1
string
success
First DNS for the zone.

Sample:
8.8.8.8
dns1_ipv6
string
success
First IPv6 DNS for the zone.

Sample:
2001:4860:4860::8888
dns2
string
success
Second DNS for the zone.

Sample:
8.8.4.4
dns2_ipv6
string
success
Second IPv6 DNS for the zone.

Sample:
2001:4860:4860::8844
domain
string
success
Domain the zone is related to.

Sample:
ROOT
guest_cidr_address
string
success
Guest CIDR address for the zone

Sample:
10.1.1.0/24
id
string
success
UUID of the zone.

Sample:
04589590-ac63-4ffc-93f5-b698b8ac38b6
internal_dns1
string
success
First internal DNS for the zone.

Sample:
8.8.8.8
internal_dns2
string
success
Second internal DNS for the zone.

Sample:
8.8.4.4
local_storage_enabled
boolean
success
Local storage offering enabled.
name
string
success
Name of the zone.

Sample:
zone01
network_domain
string
success
Network domain for the zone.

Sample:
example.com
network_type
string
success
Network type for the zone.

Sample:
basic
securitygroups_enabled
boolean
success
Security groups support is enabled.
tags
list / elements=string
success
List of resource tags associated with the zone.

Sample:
[{'key': 'foo', 'value': 'bar'}]
zone_token
string
success
Zone token

Sample:
ccb0a60c-79c8-3230-ab8b-8bdbe8c45bb7


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/latest/collections/ngine_io/cloudstack/cs_zone_module.html