openstack.cloud.dns_zone module – Manage OpenStack DNS zones

Note

This module is part of the openstack.cloud collection (version 1.9.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.

Synopsis

  • Manage OpenStack DNS zones. Zones can be created, deleted or updated. Only the email, description, ttl and masters values can be updated.

Requirements

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

  • openstacksdk

  • openstacksdk >= 0.36, < 0.99.0

  • python >= 3.6

Parameters

Parameter

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

aliases: cacert

string

A path to a CA Cert bundle that can be used as part of verifying SSL API requests.

client_cert

aliases: cert

string

A path to a client certificate to use as part of the SSL transaction.

client_key

aliases: key

string

A path to a client key to use as part of the SSL transaction.

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

aliases: endpoint_type

string

Endpoint URL type to fetch from the service catalog.

Choices:

  • admin

  • internal

  • public ← (default)

masters

list / elements=string

Master nameservers (only applies if zone_type is secondary)

name

string / required

Zone name

region_name

string

Name of the region.

state

string

Should the resource be present or absent.

Choices:

  • present ← (default)

  • absent

timeout

integer

How long should ansible wait for the requested resource.

Default: 180

ttl

integer

TTL (Time To Live) value in seconds

validate_certs

aliases: verify

boolean

Whether or not SSL API requests should be verified.

Before Ansible 2.3 this defaulted to yes.

Choices:

  • no

  • yes

wait

boolean

Should ansible wait until the requested resource is complete.

Choices:

  • no

  • yes ← (default)

zone_type

string

Zone type

Choices:

  • primary

  • secondary

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_zone:
    cloud: mycloud
    state: present
    name: example.net.
    zone_type: primary
    email: [email protected]
    description: Test zone
    ttl: 3600

# Update the TTL on existing "example.net." zone
- openstack.cloud.dns_zone:
    cloud: mycloud
    state: present
    name: example.net.
    ttl: 7200

# Delete zone named "example.net."
- openstack.cloud.dns_zone:
    cloud: mycloud
    state: absent
    name: example.net.

Return Values

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

Key

Description

zone

complex

Dictionary describing the zone.

Returned: On success when state is ‘present’.

description

string

Zone description

Returned: success

Sample: “Test description”

email

string

Zone owner email

Returned: success

Sample:test@example.net

id

string

Unique zone ID

Returned: success

Sample: “c1c530a3-3619-46f3-b0f6-236927b2618c”

masters

list / elements=string

Zone master nameservers

Returned: success

Sample: []

name

string

Zone name

Returned: success

Sample: “example.net.”

ttl

integer

Zone TTL value

Returned: success

Sample: 3600

type

string

Zone type

Returned: success

Sample: “PRIMARY”

Authors

  • OpenStack Ansible SIG