New in version 2.5.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_kind
required |
|
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 |
The Google Cloud Platform project to use.
|
|
scopes
required |
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
required |
|
Whether the given object should exist in GCP
|
Note
GCP_SERVICE_ACCOUNT_FILE
env variable.GCP_SERVICE_ACCOUNT_EMAIL
env variable.GCP_AUTH_KIND
env variable.GCP_SCOPES
env variable.- name: create a managed zone
gcp_dns_managed_zone:
name: testObject
dns_name: test.somewild2.example.com.
description: 'test zone'
project: testProject
auth_kind: service_account
service_account_file: /tmp/auth.pem
scopes:
- https://www.googleapis.com/auth/ndev.clouddns.readwrite
state: present
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.
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.