ngine_io.cloudstack.cs_zone_info – Gathering information about zones from 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_info.
New in version 0.1.0: of ngine_io.cloudstack
Synopsis
- Gathering information from the API of a zone.
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 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.
|
|
| zone
string
|
Name of the zone.
If not specified information about all zones is gathered.
aliases: name |
Notes
Note
- A detailed guide about cloudstack modules can be found in the CloudStack Cloud Guide.
- This module supports check mode.
Examples
- name: Gather information from a zone
ngine_io.cloudstack.cs_zone_info:
zone: ch-gva-1
register: zone
- name: Show the returned results of the registered variable
debug:
msg: "{{ zone }}"
- name: Gather information from all zones
ngine_io.cloudstack.cs_zone_info:
register: zones
- name: Show information on all zones
debug:
msg: "{{ zones }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
| zones
list / elements=string
|
success |
A list of matching zones.
|
|
| 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_info_module.html