Documentation

gcp_dns_managed_zone – Creates a GCP ManagedZone

New in version 2.5.

Synopsis

  • A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.

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
string / required
    Choices:
  • application
  • machineaccount
  • serviceaccount
The type of credential used.
description
- / required
A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.
dns_name
- / required
The DNS name of this managed zone, for instance "example.com.".
labels
-
added in 2.8
A set of key/value label pairs to assign to this ManagedZone.
name
- / required
User assigned name for this resource.
Must be unique within the project.
name_server_set
-
Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.
private_visibility_config
-
added in 2.8
For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.
networks
-
The list of VPC networks that can see this zone.
network_url
-
The fully qualified URL of the VPC network to bind to.
project
string
The Google Cloud Platform project to use.
scopes
list
Array of scopes to be used.
service_account_contents
string
A string representing the contents of a Service Account JSON file.
This should not be passed in as a dictionary, but a string that has the exact contents of a service account json file (valid JSON)
service_account_email
string
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
service_account_file
path
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
visibility
-
added in 2.8
    Choices:
  • private
  • public ←
The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
Must be one of: `public`, `private`.

Notes

Note

  • API Reference: https://cloud.google.com/dns/api/v1/managedZones
  • Managing Zones: https://cloud.google.com/dns/zones/
  • 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 service_account_contents using the GCP_SERVICE_ACCOUNT_CONTENTS 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: test_object
    dns_name: test.somewild2.example.com.
    description: test zone
    project: test_project
    auth_kind: serviceaccount
    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
creationTime
string
success
The time that this resource was created on the server.
This is in RFC3339 text format.

description
string
success
A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function.

dnsName
string
success
The DNS name of this managed zone, for instance "example.com.".

id
integer
success
Unique identifier for the resource; defined by the server.

labels
dictionary
success
A set of key/value label pairs to assign to this ManagedZone.

name
string
success
User assigned name for this resource.
Must be unique within the project.

nameServers
list
success
Delegate your managed_zone to these virtual name servers; defined by the server .

nameServerSet
string
success
Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users will leave this field unset.

privateVisibilityConfig
complex
success
For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from.

  networks
complex
success
The list of VPC networks that can see this zone.

    networkUrl
string
success
The fully qualified URL of the VPC network to bind to.

visibility
string
success
The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources.
Must be one of: `public`, `private`.



Status

Authors

  • Google Inc. (@googlecloudplatform)

Hint

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