Documentation

gcp_dns_resource_record_set - Creates a GCP ResourceRecordSet

New in version 2.6.

Synopsis

  • A single DNS record that exists on a domain name (i.e. in a managed zone).
  • This record defines the information about the domain and where the domain / subdomains direct to.
  • The record will include the domain/subdomain name, a type (i.e. A, AAA, CAA, MX, CNAME, NS, etc) .

Requirements

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

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Parameters

Parameter Choices/Defaults Comments
auth_kind
required
    Choices:
  • machineaccount
  • serviceaccount
  • application
The type of credential used.
managed_zone
required
Identifies the managed zone addressed by this request.
Can be the managed zone name or id.
name
required
For example, www.example.com.
project Default:
None
The Google Cloud Platform project to use.
scopes
Array of scopes to be used.
service_account_email
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file
The path of a Service Account JSON file if serviceaccount is selected as type.
state
    Choices:
  • present ←
  • absent
Whether the given object should exist in GCP
target
As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) .
ttl
Number of seconds that this ResourceRecordSet can be cached by resolvers.
type
required
    Choices:
  • A
  • AAAA
  • CAA
  • CNAME
  • MX
  • NAPTR
  • NS
  • PTR
  • SOA
  • SPF
  • SRV
  • TXT
One of valid DNS resource types.

Notes

Note

  • For authentication, you can set service_account_file using the GCP_SERVICE_ACCOUNT_FILE env variable.
  • For authentication, you can set service_account_email using the GCP_SERVICE_ACCOUNT_EMAIL env variable.
  • For authentication, you can set auth_kind using the GCP_AUTH_KIND env variable.
  • For authentication, you can set scopes using the GCP_SCOPES env variable.
  • Environment variables values will only be used if the playbook values are not set.
  • The service_account_email and service_account_file options are mutually exclusive.

Examples

- name: create a managed zone
  gcp_dns_managed_zone:
      name: "managedzone-rrs"
      dns_name: testzone-4.com.
      description: test zone
      project: "{{ gcp_project }}"
      auth_kind: "{{ gcp_cred_kind }}"
      service_account_file: "{{ gcp_cred_file }}"
      state: present
  register: managed_zone

- name: create a resource record set
  gcp_dns_resource_record_set:
      name: www.testzone-4.com.
      managed_zone: "{{ managed_zone }}"
      type: A
      ttl: 600
      target:
      - 10.1.2.3
      - 40.5.6.7
      project: "test_project"
      auth_kind: "service_account"
      service_account_file: "/tmp/auth.pem"
      state: present

Return Values

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

Key Returned Description
managed_zone
dict
success
Identifies the managed zone addressed by this request.
Can be the managed zone name or id.

name
str
success
For example, www.example.com.

target
list
success
As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) .

ttl
int
success
Number of seconds that this ResourceRecordSet can be cached by resolvers.

type
str
success
One of valid DNS resource types.



Status

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

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Google Inc. (@googlecloudplatform)

Hint

If you notice any issues in this documentation you can edit this document to improve it.