gcp_dns_managed_zone - Creates a GCP ManagedZone¶

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

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 required	Choices: machineaccount serviceaccount application	The type of credential used.
description		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		The DNS name of this managed zone, for instance "example.com.".
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.
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

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: "test_object"
      dns_name: test.somewild2.example.com.
      description: test zone
      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
creation_time str	success	The time that this resource was created on the server. This is in RFC3339 text format.
description str	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.
dns_name str	success	The DNS name of this managed zone, for instance "example.com.".
id int	success	Unique identifier for the resource; defined by the server.
name str	success	User assigned name for this resource. Must be unique within the project.
name_server_set list	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.
name_servers list	success	Delegate your managed_zone to these virtual name servers; defined by the server .

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.