gcdns_zone - Creates or removes zones in Google Cloud DNS
New in version 2.2.
Synopsis
- Creates or removes managed zones in Google Cloud DNS.
Requirements (on host that executes module)
- python >= 2.6
- apache-libcloud >= 0.19.0
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| credentials_file | no | The path to the JSON file associated with the service account email. | ||
| description | no | An arbitrary text string to use for the zone description. | ||
| pem_file | no | 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 | no | The Google Cloud Platform project ID to use. | ||
| service_account_email | no | The e-mail address for a service account with access to Google Cloud DNS. | ||
| state | no | present |
| Whether the given zone should or should not be present. |
| zone | yes | 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 |
Examples
# Basic zone creation example. - name: Create a basic zone with the minimum number of parameters. gcdns_zone: zone=example.com # Zone removal example. - name: Remove a zone. gcdns_zone: zone=example.com state=absent # Zone creation with description - name: Creating a zone with a description gcdns_zone: zone=example.com description="This is an awesome zone"
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| description | The zone's description | success | string | This is an awesome zone |
| state | Whether the zone is present or absent | success | string | present |
| zone | The zone's DNS name | success | string | example.com. |
Notes
Note
- See also gcdns_record.
- Zones that are newly created must still be set up with a domain registrar before they can be used.
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/gcdns_zone_module.html