google.cloud.gcp_dns_managed_zone 模块 – 创建 GCP 托管区域

注意

此模块是 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。

注意

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

概要

• 区域是单一管理责任下 DNS 命名空间的子树。ManagedZone 是一个资源，它表示由 Cloud DNS 服务托管的 DNS 区域。

要求

以下是执行此模块的主机所需的条件。

• python >= 2.6

• requests >= 2.18.4

• google-auth >= 1.3.0

参数

参数	注释
access_token 字符串	如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。
auth_kind 字符串 / 必需	使用的凭据类型。 选项 "application" "machineaccount" "serviceaccount" "accesstoken"
description 字符串 / 必需	最多 1024 个字符的可变字符串，与此资源关联，供用户方便使用。对托管区域的功能没有影响。
dns_name 字符串 / 必需	此托管区域的 DNS 名称，例如“example.com”。
dnssec_config 字典	DNSSEC 配置。
default_key_specs 列表 / 元素=字典	指定将用于为此 ManagedZone 生成初始 DnsKey 的参数。如果您为 keySigning 或 zoneSigning 提供规范，则也必须为另一个提供规范。 当状态为 `off` 时，才能更新 default_key_specs。
algorithm 字符串	指定此密钥的 DNSSEC 算法的字符串助记符。 一些有效的选项包括：“ecdsap256sha256”、“ecdsap384sha384”、“rsasha1”、“rsasha256”、“rsasha512”
key_length 整数	密钥的长度（以位为单位）。
key_type 字符串	指定这是密钥签名密钥 (KSK) 还是区域签名密钥 (ZSK)。密钥签名密钥已设置安全入口点标志，并且在激活时，仅用于签名类型为 DNSKEY 的资源记录集。区域签名密钥未设置安全入口点标志，将用于签名所有其他类型的资源记录集。 一些有效的选项包括：“keySigning”、“zoneSigning”
kind 字符串	标识这是什么类型的资源。 默认值： "dns#dnsKeySpec"
kind 字符串	标识这是什么类型的资源。 默认值： "dns#managedZoneDnsSecConfig"
non_existence 字符串	指定用于提供经过身份验证的非存在响应的机制。 当状态为 `off` 时，才能更新 non_existence。 一些有效的选项包括：“nsec”、“nsec3”
state 字符串	指定是否启用 DNSSEC，以及它的模式。 一些有效的选项包括：“off”、“on”、“transfer”
env_type 字符串	指定您在哪个 Ansible 环境中运行此模块。 除非您知道自己在做什么，否则不应设置此项。 这只会更改任何 API 请求的用户代理字符串。
forwarding_config 字典	此字段的存在表示已为此区域启用出站转发。此字段的值包含要转发到的目标集。
target_name_servers 列表 / 元素=字典 / 必需	要转发到的目标名称服务器列表。如果给出了多个目标，Cloud DNS 将选择最佳的可用名称服务器。
forwarding_path 字符串	此 TargetNameServer 的转发路径。如果未设置或为 `default`，Cloud DNS 将根据地址范围（即 RFC1918 地址转到 VPC，非 RFC1918 地址转到 Internet）做出转发决策。设置为 `private` 时，Cloud DNS 将始终为此目标通过 VPC 发送查询。 一些有效的选项包括：“default”、“private”
ipv4_address 字符串 / 必需	目标名称服务器的 IPv4 地址。
labels 字典	一组键/值标签对，用于分配给此 ManagedZone。
name 字符串 / 必需	为此资源分配的用户名称。 在项目中必须唯一。
name_server_set 字符串	可以选择为此 ManagedZone 指定 NameServerSet。NameServerSet 是所有托管相同 ManagedZone 的 DNS 服务器集。大多数用户都会将此字段保持未设置状态。
peering_config 字典	此字段的存在表示已为此区域启用 DNS 对等互连。此字段的值包含要与其对等互连的网络。
target_network 字典 / 必需	要与其对等互连的网络。
network_url 字符串 / 必需	要将查询转发到的 VPC 网络的完全限定 URL。 这应该像`https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`这样格式化。
private_visibility_config 字典	对于私有可见区域，该区域可见的虚拟私有云资源集。
networks 列表 / 元素=字典 / 必需	可以看到此区域的 VPC 网络列表。
network_url 字符串 / 必需	要绑定的 VPC 网络的完全限定 URL。 这应该像`https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network}`这样格式化。
project 字符串	要使用的 Google Cloud Platform 项目。
scopes 列表 / 元素=字符串	要使用的范围数组
service_account_contents jsonarg	服务帐户 JSON 文件的内容，可以是字典，也可以是表示它的 JSON 字符串。
service_account_email 字符串	如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则可以选择的服务帐户电子邮件地址。
service_account_file 路径	如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。
state 字符串	给定对象是否应该存在于 GCP 中 选项 "present" ← (默认) "absent"
visibility 字符串	区域的可见性：公共区域暴露于互联网，而私有区域仅对虚拟私有云资源可见。 一些有效的选项包括：“private”、“public” 默认： "public"

注释

注意

• API 参考：https://cloud.google.com/dns/api/v1/managedZones

• 管理区域：https://cloud.google.com/dns/zones/

• 对于身份验证，您可以使用 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: create a managed zone
  google.cloud.gcp_dns_managed_zone:
    name: test_object
    dns_name: test.somewild2.example.com.
    description: test zone
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

返回值

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

键	描述
creationTime 字符串	此资源在服务器上创建的时间。 这是 RFC3339 文本格式。 返回：成功
description 字符串	最多 1024 个字符的可变字符串，与此资源关联，供用户方便使用。对托管区域的功能没有影响。 返回：成功
dnsName 字符串	此托管区域的 DNS 名称，例如“example.com”。 返回：成功
dnssecConfig 复杂	DNSSEC 配置。 返回：成功
defaultKeySpecs 复杂	指定将用于为此 ManagedZone 生成初始 DnsKey 的参数。如果您为 keySigning 或 zoneSigning 提供规范，则也必须为另一个提供规范。 当状态为 `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 字典	一组键/值标签对，用于分配给此 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 字符串	区域的可见性：公共区域暴露于互联网，而私有区域仅对虚拟私有云资源可见。 返回：成功

作者

• Google Inc. (@googlecloudplatform)

收藏链接

• 问题跟踪器
• 主页
• 存储库（源代码）