community.general.gcdns_zone (1.3.14) — module

Install collection

Install with ansible-galaxy collection install community.general:==1.3.14

Add to requirements.yml

  collections:
    - name: community.general
      version: 1.3.14

Description

Creates or removes managed zones in Google Cloud DNS.

Requirements

• apache-libcloud >= 0.19.0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
zone:
    aliases:
    - name
    description:
    - 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.
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the given zone should or should not be present.
    type: str

pem_file:
    description:
    - 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 I(credentials_file)
      instead.
    type: path

project_id:
    description:
    - The Google Cloud Platform project ID to use.
    type: str

description:
    default: ''
    description:
    - An arbitrary text string to use for the zone description.
    type: str

credentials_file:
    description:
    - The path to the JSON file associated with the service account email.
    type: path

service_account_email:
    description:
    - The e-mail address for a service account with access to Google Cloud DNS.
    type: str

Outputs

description:
  description: The zone's description
  returned: success
  sample: This is an awesome zone
  type: str
state:
  description: Whether the zone is present or absent
  returned: success
  sample: present
  type: str
zone:
  description: The zone's DNS name
  returned: success
  sample: example.com.
  type: str