W3cubDocs

/Ansible

openstack.cloud.dns_zone_info – Getting information about dns zones

Note

This plugin is part of the openstack.cloud collection (version 1.5.1).

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 openstack.cloud.

To use it in a playbook, specify: openstack.cloud.dns_zone_info.

Synopsis

  • Getting information about dns zones. Output can be filtered.

Requirements

The below requirements are needed on the host that executes this module.

  • openstacksdk
  • openstacksdk >= 0.12.0
  • python >= 3.6

Parameters

Parameter Choices/Defaults Comments
api_timeout
integer
How long should the socket layer wait before timing out for API calls. If this is omitted, nothing will be passed to the requests library.
auth
dictionary
Dictionary containing auth information as needed by the cloud's auth plugin strategy. For the default password plugin, this would contain auth_url, username, password, project_name and any information about domains (for example, user_domain_name or project_domain_name) if the cloud supports them. For other plugins, this param will need to contain whatever parameters that auth plugin requires. This parameter is not needed if a named cloud is provided or OpenStack OS_* environment variables are present.
auth_type
string
Name of the auth plugin to use. If the cloud uses something other than password authentication, the name of the plugin should be indicated here and the contents of the auth parameter should be updated accordingly.
availability_zone
string
Ignored. Present for backwards compatibility
ca_cert
string
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

aliases: cacert
client_cert
string
A path to a client certificate to use as part of the SSL transaction.

aliases: cert
client_key
string
A path to a client key to use as part of the SSL transaction.

aliases: key
cloud
raw
Named cloud or cloud config to operate against. If cloud is a string, it references a named cloud config as defined in an OpenStack clouds.yaml file. Provides default values for auth and auth_type. This parameter is not needed if auth is provided or if OpenStack OS_* environment variables are present. If cloud is a dict, it contains a complete cloud configuration like would be in a section of clouds.yaml.
description
string
Zone description.
email
string
Email of the zone owner (only applies if zone_type is primary).
interface
string
    Choices:
  • admin
  • internal
  • public ←
Endpoint URL type to fetch from the service catalog.

aliases: endpoint_type
name
string
Zone name.
region_name
string
Name of the region.
timeout
integer
Default:
180
How long should ansible wait for the requested resource.
ttl
integer
TTL (Time To Live) value in seconds.
type
string
    Choices:
  • primary
  • secondary
Zone type.
validate_certs
boolean
    Choices:
  • no
  • yes
Whether or not SSL API requests should be verified.
Before Ansible 2.3 this defaulted to yes.

aliases: verify
wait
boolean
    Choices:
  • no
  • yes ←
Should ansible wait until the requested resource is complete.

Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.
  • Auth information is driven by openstacksdk, which means that values can come from a yaml config file in /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from standard environment variables, then finally by explicit parameters in plays. More information can be found at https://docs.openstack.org/openstacksdk/

Examples

# Create a zone named "example.net"
- openstack.cloud.dns_zones:

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
zone
complex
On success when state is 'present'.
Dictionary describing the zone.
action
string
success
Current action in progress on the resource.

Sample:
CREATE
attributes
dictionary
success
Key:Value pairs of information about this zone, and the pool the user would like to place the zone in. This information can be used by the scheduler to place zones on the correct pool.

Sample:
{'ha': 'true', 'tier': 'gold'}
created_at
string
success
Date / Time when resource was created.

Sample:
2014-07-07T18:25:31.275934
description
string
success
Description for this zone.

Sample:
This is an example zone.
email
string
success
E-mail for the zone. Used in SOA records for the zone.

Sample:
id
integer
success
ID for the resource.

Sample:
a86dba58-0043-4cc6-a1bb-69d5e86f3ca3
links
dictionary
success
Links to the resource, and other related resources. When a response has been broken into pages, we will include a next link that should be followed to retrieve all results.

Sample:
{'self': 'https://127.0.0.1:9001/v2/zones/a86dba58-0043-4cc6-a1bb-69d5e86f3ca3'}
masters
list / elements=string
success
Mandatory for secondary zones. The servers to slave from to get DNS information.

Sample:
[]
name
string
success
DNS Name for the zone.

Sample:
test.test.
pool_id
string
success
ID for the pool hosting this zone.

Sample:
a86dba58-0043-4cc6-a1bb-69d5e86f3ca3
project_id
string
success
ID for the project that owns the resource.

Sample:
4335d1f0-f793-11e2-b778-0800200c9a66
serial
integer
success
Current serial number for the zone.

Sample:
1404757531
status
string
success
Status of the resource.

Sample:
ACTIVE
ttl
integer
success
TTL (Time to Live) for the zone.

Sample:
7200
type
string
success
Type of zone. PRIMARY is controlled by Designate, SECONDARY zones are slaved from another DNS Server. Defaults to PRIMARY

Sample:
PRIMARY
updated_at
string
success
Date / Time when resource last updated.

Sample:
2014-07-07T18:25:31.275934


Authors

  • OpenStack Ansible SIG

© 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/openstack/cloud/dns_zone_info_module.html