W3cubDocs

/Ansible 2.10

community.general.gcdns_zone – Creates or removes zones in Google Cloud DNS

Note

This plugin is part of the community.general collection.

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.gcdns_zone.

DEPRECATED
Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

DEPRECATED

Removed in: version 2.0.0
Why: Updated modules released with increased functionality
Alternative: Use google.cloud.gcp_dns_managed_zone instead.

Synopsis

Creates or removes managed zones in Google Cloud DNS.

Requirements

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

apache-libcloud >= 0.19.0

Parameters

Parameter	Choices/Defaults	Comments
credentials_file string		The path to the JSON file associated with the service account email.
description string	Default: ""	An arbitrary text string to use for the zone description.
pem_file string		The path to the PEM file associated with the service account email. This option is deprecated and may be removed in a future release. Use credentials_file instead.
project_id string		The Google Cloud Platform project ID to use.
service_account_email string		The e-mail address for a service account with access to Google Cloud DNS.
state string	Choices: present ← absent	Whether the given zone should or should not be present.
zone string / required		The DNS domain name of the zone. This is NOT the Google Cloud DNS zone ID (e.g., example-com). If you attempt to specify a zone ID, this module will attempt to create a TLD and will fail. aliases: name

Notes

Note

See also community.general.gcdns_record.
Zones that are newly created must still be set up with a domain registrar before they can be used.

Examples

# Basic zone creation example.
- name: Create a basic zone with the minimum number of parameters.
  community.general.gcdns_zone: zone=example.com

# Zone removal example.
- name: Remove a zone.
  community.general.gcdns_zone: zone=example.com state=absent

# Zone creation with description
- name: Creating a zone with a description
  community.general.gcdns_zone: zone=example.com description="This is an awesome zone"

Return Values

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

Key	Returned	Description
description string	success	The zone's description Sample: This is an awesome zone
state string	success	Whether the zone is present or absent Sample: present
zone string	success	The zone's DNS name Sample: example.com.

Status

This module will be removed in version 2.0.0. [deprecated]
For more information see DEPRECATED.

Authors

William Albert (@walbert947)

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