google.cloud.gcp_dns_managed_zone_info module – Gather info for GCP ManagedZone
Note
This module is part of the google.cloud collection (version 1.4.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install google.cloud
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: google.cloud.gcp_dns_managed_zone_info
.
Synopsis
Gather info for GCP ManagedZone
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 |
Comments |
---|---|
An OAuth2 access token if credential type is accesstoken. |
|
The type of credential used. Choices:
|
|
Restricts the list to return only zones with this domain name. |
|
Specifies which Ansible environment you’re running this module within. This should not be set unless you know what you’re doing. This only alters the User Agent string for any API requests. |
|
The Google Cloud Platform project to use. |
|
Array of scopes to be used |
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it. |
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email. |
|
The path of a Service Account JSON file if serviceaccount is selected as type. |
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_contents using the
GCP_SERVICE_ACCOUNT_CONTENTS
env variable.For authentication, you can set service_account_email using the
GCP_SERVICE_ACCOUNT_EMAIL
env variable.For authentication, you can set access_token using the
GCP_ACCESS_TOKEN
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: get info on a managed zone
gcp_dns_managed_zone_info:
dns_name: test.somewild2.example.com.
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of resources Returned: always |
|
The time that this resource was created on the server. This is in RFC3339 text format. Returned: 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. Returned: success |
|
The DNS name of this managed zone, for instance “example.com.”. Returned: success |
|
DNSSEC configuration. Returned: success |
|
Specifies parameters that will be used for generating initial DnsKeys for this ManagedZone. If you provide a spec for keySigning or zoneSigning, you must also provide one for the other. default_key_specs can only be updated when the state is `off`. Returned: success |
|
String mnemonic specifying the DNSSEC algorithm of this key. Returned: success |
|
Length of the keys in bits. Returned: success |
|
Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets. Returned: success |
|
Identifies what kind of resource this is. Returned: success |
|
Identifies what kind of resource this is. Returned: success |
|
Specifies the mechanism used to provide authenticated denial-of-existence responses. non_existence can only be updated when the state is `off`. Returned: success |
|
Specifies whether DNSSEC is enabled, and what mode it is in. Returned: success |
|
The presence for this field indicates that outbound forwarding is enabled for this zone. The value of this field contains the set of destinations to forward to. Returned: success |
|
List of target name servers to forward to. Cloud DNS will select the best available name server if more than one target is given. Returned: success |
|
Forwarding path for this TargetNameServer. If unset or `default` Cloud DNS will make forwarding decision based on address ranges, i.e. RFC1918 addresses go to the VPC, Non-RFC1918 addresses go to the Internet. When set to `private`, Cloud DNS will always send queries through VPC for this target . Returned: success |
|
IPv4 address of a target name server. Returned: success |
|
Unique identifier for the resource; defined by the server. Returned: success |
|
A set of key/value label pairs to assign to this ManagedZone. Returned: success |
|
User assigned name for this resource. Must be unique within the project. Returned: success |
|
Delegate your managed_zone to these virtual name servers; defined by the server . Returned: 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. Returned: success |
|
The presence of this field indicates that DNS Peering is enabled for this zone. The value of this field contains the network to peer with. Returned: success |
|
The network with which to peer. Returned: success |
|
The fully qualified URL of the VPC network to forward queries to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` . Returned: success |
|
For privately visible zones, the set of Virtual Private Cloud resources that the zone is visible from. Returned: success |
|
The list of VPC networks that can see this zone. Returned: success |
|
The fully qualified URL of the VPC network to bind to. This should be formatted like `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` . Returned: success |
|
The zone’s visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. Returned: success |