google.cloud.gcp_dns_managed_zone_info 模块 – 收集 GCP 托管区域信息

注意

此模块是 google.cloud 集合 (版本 1.4.1) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install google.cloud。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在剧本中使用它，请指定：google.cloud.gcp_dns_managed_zone_info。

注意

由于违反了 Ansible 包含要求，google.cloud 集合将在 Ansible 12 中移除。该集合存在未解决的完整性测试失败。有关更多信息，请参阅讨论主题。

概要 

收集 GCP 托管区域信息

要求 

执行此模块的主机需要以下要求。

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

参数 

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。选项 `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
dns_name 列表 / 元素=字符串	将列表限制为仅返回具有此域名区域。
env_type 字符串	指定您在此模块中运行的 Ansible 环境。除非您知道自己在做什么，否则不应设置此选项。这只会更改任何 API 请求的用户代理字符串。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / 元素=字符串	要使用的作用域数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典或表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不想使用默认电子邮件，则可以选择的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

备注 

注意

对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_FILE 环境变量设置 service_account_file。
对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_CONTENTS 环境变量设置 service_account_contents。
对于身份验证，您可以使用 GCP_SERVICE_ACCOUNT_EMAIL 环境变量设置 service_account_email。
对于身份验证，您可以使用 GCP_ACCESS_TOKEN 环境变量设置 access_token。
对于身份验证，您可以使用 GCP_AUTH_KIND 环境变量设置 auth_kind。
对于身份验证，您可以使用 GCP_SCOPES 环境变量设置 scopes。
只有在未设置剧本值时才会使用环境变量值。
service_account_email 和 service_account_file 选项是互斥的。

示例 

- 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"

返回值 

常见的返回值已记录在此处，以下是此模块特有的字段

键	描述
resources 复杂	资源列表返回：始终
creationTime 字符串	此资源在服务器上创建的时间。此时间采用 RFC3339 文本格式。返回：成功
description 字符串	与该资源关联的可变字符串，最多 1024 个字符，方便用户使用。对托管区域的功能没有影响。返回：成功
dnsName 字符串	此托管区域的 DNS 名称，例如“example.com”。返回：成功
dnssecConfig 复杂	DNSSEC 配置。返回：成功
defaultKeySpecs 复杂	指定将用于为此托管区域生成初始 DnsKeys 的参数。如果您为 keySigning 或 zoneSigning 提供规范，则也必须为另一个提供规范。 default_key_specs 只能在状态为 `off` 时更新。返回：成功
algorithm 字符串	指定此密钥的 DNSSEC 算法的字符串助记符。返回：成功
keyLength 整数	密钥的长度（以位为单位）。返回：成功
keyType 字符串	指定这是密钥签名密钥 (KSK) 还是区域签名密钥 (ZSK)。密钥签名密钥已设置安全入口点标志，并且在活动时，仅用于签署类型为 DNSKEY 的资源记录集。区域签名密钥未设置安全入口点标志，将用于签署所有其他类型的资源记录集。返回：成功
kind 字符串	标识这是什么类型的资源。返回：成功
kind 字符串	标识这是什么类型的资源。返回：成功
nonExistence 字符串	指定用于提供经过身份验证的非存在响应的机制。 non_existence 只能在状态为 `off` 时更新。返回：成功
state 字符串	指定是否启用 DNSSEC，以及处于什么模式。返回：成功
forwardingConfig 复杂	此字段的存在表示为此区域启用了出站转发。此字段的值包含要转发到的目标集。返回：成功
targetNameServers 复杂	要转发的目标名称服务器列表。如果指定多个目标，Cloud DNS 将选择最佳的可用名称服务器。返回：成功
forwardingPath 字符串	此 TargetNameServer 的转发路径。如果未设置或为“default”，Cloud DNS 将根据地址范围（即 RFC1918 地址转到 VPC，非 RFC1918 地址转到 Internet）做出转发决策。设置为“private”时，Cloud DNS 将始终为此目标通过 VPC 发送查询。返回：成功
ipv4Address 字符串	目标名称服务器的 IPv4 地址。返回：成功
id 整数	资源的唯一标识符；由服务器定义。返回：成功
labels 字典	一组键/值标签对，用于分配给此 ManagedZone。返回：成功
name 字符串	为此资源分配的用户名称。在项目中必须唯一。返回：成功
nameServers 列表 / 元素=字符串	将您的 managed_zone 委派给这些虚拟名称服务器；由服务器定义。返回：成功
nameServerSet 字符串	可选地指定此 ManagedZone 的 NameServerSet。NameServerSet 是所有托管相同 ManagedZone 的 DNS 名称服务器的集合。大多数用户会保留此字段的未设置状态。返回：成功
peeringConfig 复杂	此字段的存在表示已为此区域启用 DNS 对等互连。此字段的值包含要与其对等的网络。返回：成功
targetNetwork 复杂	要与其对等的网络。返回：成功
networkUrl 字符串	要将查询转发到的 VPC 网络的完全限定 URL。格式应类似于 `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`。返回：成功
privateVisibilityConfig 复杂	对于私有可见区域，该区域可见的虚拟专用云资源集。返回：成功
networks 复杂	可以看到此区域的 VPC 网络列表。返回：成功
networkUrl 字符串	要绑定到的 VPC 网络的完全限定 URL。格式应类似于 `https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`。返回：成功
visibility 字符串	区域的可见性：公共区域公开给 Internet，而私有区域仅对虚拟专用云资源可见。返回：成功

作者

Google Inc. (@googlecloudplatform)