google.cloud.gcp_dns_managed_zone_info 模块 – 收集 GCP ManagedZone 的信息

注意

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

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

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

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

注意

由于违反了 Ansible 包含要求，google.cloud 集合将从 Ansible 12 中删除。该集合有未解决的健全性测试失败。有关详细信息，请参阅讨论主题。

概要

  • 收集 GCP ManagedZone 的信息

要求

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

  • 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。

  • 只有在未设置 playbook 值时，才会使用环境变量值。

  • 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

复杂

指定用于为此 ManagedZone 生成初始 DnsKeys 的参数。如果您为密钥签名或区域签名提供规范，则还必须为另一个提供规范。

仅当状态为“off”时，才能更新 default_key_specs。

返回：成功

algorithm

字符串

指定此密钥的 DNSSEC 算法的字符串助记符。

返回：成功

keyLength

整数

密钥的长度（以位为单位）。

返回：成功

keyType

字符串

指定这是否是密钥签名密钥 (KSK) 或区域签名密钥 (ZSK)。密钥签名密钥设置了安全入口点标志，并且在激活时，仅用于对 DNSKEY 类型的资源记录集进行签名。区域签名密钥没有设置安全入口点标志，将用于对所有其他类型的资源记录集进行签名。

返回：成功

kind

字符串

标识这是一种什么类型的资源。

返回：成功

kind

字符串

标识这是一种什么类型的资源。

返回：成功

nonExistence

字符串

指定用于提供经过身份验证的拒绝存在响应的机制。

仅当状态为“off”时，才能更新 non_existence。

返回：成功

state

字符串

指定是否启用 DNSSEC 以及它处于什么模式。

返回：成功

forwardingConfig

复杂

此字段的存在表示已为此区域启用出站转发。此字段的值包含要转发到的目标集。

返回：成功

targetNameServers

复杂

要转发到的目标名称服务器列表。如果给出多个目标，则 Cloud DNS 将选择最佳可用名称服务器。

返回：成功

forwardingPath

字符串

此 TargetNameServer 的转发路径。如果未设置或为“default”，则 Cloud DNS 将根据地址范围做出转发决策，即 RFC1918 地址转到 VPC，非 RFC1918 地址转到 Internet。设置为“private”时，Cloud DNS 将始终通过此目标的 VPC 发送查询。

返回：成功

ipv4Address

字符串

目标名称服务器的 IPv4 地址。

返回：成功

id

整数

资源的唯一标识符；由服务器定义。

返回：成功

labels

字典

一组用于分配给此托管区域的键/值标签对。

返回：成功

名称

字符串

此资源的用户分配名称。

在项目内必须唯一。

返回：成功

名称服务器

列表 / 元素=字符串

将您的托管区域委派给这些虚拟名称服务器；由服务器定义。

返回：成功

名称服务器集

字符串

可选地指定此托管区域的名称服务器集。名称服务器集是一组托管相同托管区域的 DNS 名称服务器。大多数用户将保留此字段未设置。

返回：成功

对等配置

复杂

此字段的存在表示已为此区域启用 DNS 对等。此字段的值包含要与之对等的网络。

返回：成功

目标网络

复杂

要与之对等的网络。

返回：成功

网络 URL

字符串

要将查询转发到的 VPC 网络的完全限定 URL。

格式应如下所示：`https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` 。

返回：成功

私有可见性配置

复杂

对于私有可见区域，该区域可见的虚拟私有云资源集。

返回：成功

网络

复杂

可以看到此区域的 VPC 网络列表。

返回：成功

网络 URL

字符串

要绑定到的 VPC 网络的完全限定 URL。

格式应如下所示：`https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}` 。

返回：成功

可见性

字符串

区域的可见性：公共区域暴露给互联网，而私有区域仅对虚拟私有云资源可见。

返回：成功

作者

  • Google Inc. (@googlecloudplatform)