os_zone - Manage OpenStack DNS zones

New in version 2.2.

Synopsis

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

Requirements (on host that executes module)

  • python >= 2.6
  • python >= 2.7
  • shade

Options

parameter required default choices comments
api_timeout
no None
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
no
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 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
no password
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
no
Ignored. Present for backwards compatibility
cacert
no None
A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
cert
no None
A path to a client certificate to use as part of the SSL transaction.
cloud
no
Named cloud to operate against. 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.
description
no None
Zone description
email
no
Email of the zone owner (only applies if zone_type is primary)
endpoint_type
no public
  • public
  • internal
  • admin
Endpoint URL type to fetch from the service catalog.
key
no None
A path to a client key to use as part of the SSL transaction.
masters
no None
Master nameservers (only applies if zone_type is secondary)
name
yes
Zone name
region_name
no
Name of the region.
state
no present
  • present
  • absent
Should the resource be present or absent.
timeout
no 180
How long should ansible wait for the requested resource.
ttl
no None
TTL (Time To Live) value in seconds
validate_certs
no
Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.
aliases: verify
wait
no yes
  • yes
  • no
Should ansible wait until the requested resource is complete.
zone_type
no None
  • primary
  • secondary
Zone type

Examples

# Create a zone named "example.net"
- os_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
- os_zone:
    cloud: mycloud
    state: present
    name: example.net.
    ttl: 7200

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

Return Values

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

name description returned type sample
zone
Dictionary describing the zone.
On success when I(state) is 'present'. complex
contains:
name description returned type sample
masters
Zone master nameservers
list []
description
Zone description
string Test description
name
Zone name
string example.net.
ttl
Zone TTL value
int 3600
type
Zone type
string PRIMARY
id
Unique zone ID
string c1c530a3-3619-46f3-b0f6-236927b2618c
email
Zone owner email
string [email protected]

Notes

Note

  • The standard OpenStack environment variables, such as OS_USERNAME may be used instead of providing explicit values.
  • Auth information is driven by os-client-config, 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 http://docs.openstack.org/developer/os-client-config

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_zone_module.html