community.dns.hetzner_dns_zone_info 模块 – 在 Hetzner DNS 服务中检索区域信息

注意

此模块是 community.dns 集合（版本 3.1.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.dns。

要在 playbook 中使用它，请指定：community.dns.hetzner_dns_zone_info。

community.dns 2.0.0 中的新增功能

概要 

在 Hetzner DNS 服务中检索区域信息。

参数 

参数	注释
hetzner_token 别名: api_token 字符串 / 必需	Hetzner API 的令牌。如果未提供，将从环境变量 `HETZNER_DNS_TOKEN` 中读取。
zone_id 字符串在 community.dns 0.2.0 中添加	要查询的 DNS 区域的 ID。必须指定 `zone_name` 和 `zone_id` 中的一个。
zone_name 别名: zone 字符串	要查询的 DNS 区域。必须指定 `zone_name` 和 `zone_id` 中的一个。

属性 

属性	支持	描述
action_group	操作组: community.dns.hetzner 在 community.dns 2.4.0 中添加	在 `module_defaults` 中使用 `group/community.dns.hetzner` 为此模块设置默认值。
check_mode	支持: 完全此操作不修改状态。	可以在 `check_mode` 中运行并返回更改的状态预测，而无需修改目标。
diff_mode	支持: N/A 此操作不修改状态。	当处于差异模式时，将返回有关已更改（或可能需要在 `check_mode` 中更改）的详细信息。

示例 

- name: Retrieve details for foo.com zone
  community.dns.hetzner_dns_zone_info:
    zone: foo.com
    hetzner_token: access_token
  register: rec

- name: Retrieve details for zone 23
  community.dns.hetzner_dns_zone_info:
    zone_id: 23
    hetzner_token: access_token

返回值 

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

Key	描述
zone_id 字符串	区域的 ID。返回: 成功示例: `"23"`
zone_info 字典	API 返回的额外信息。返回: 成功
created 字符串	创建区域的时间。返回: 成功示例: `"2021-07-15T19:23:58Z"`
is_secondary_dns 布尔值	指示区域是否为辅助 DNS 区域。返回: 成功示例: `true`
legacy_dns_host 字符串	未知。返回: 成功
legacy_ns 列表 / elements=字符串	导入期间的名称服务器列表。返回: 成功
modified 字符串	区域上次修改的时间。返回: 成功示例: `"2021-07-15T19:23:58Z"`
ns 列表 / elements=字符串	使用 Hetzner 的 DNS 时，该区域应具有的名称服务器列表。返回: 成功
owner 字符串	区域的所有者。返回: 成功
paused 布尔值	未知。返回: 成功示例: `true`
permission 字符串	区域的权限。返回: 成功
project 字符串	未知。返回: 成功
records_count 整数	与此区域关联的记录数。返回: 成功示例: `0`
registrar 字符串	未知。返回: 成功
status 字符串	区域的状态。可以是 `verified`、 `failed` 和 `pending` 中的一个。返回: 成功示例: `"verified"`
ttl 整数	区域的 TTL (生存时间)。返回: 成功示例: `0`
txt_verification 字典	为验证区域而必须设置的 TXT 记录的形状。如果 name 和 token 为空，则无需设置 TXT 记录。返回: 成功示例: `{"name": "", "token": ""}`
name 字符串	TXT 记录的名称。返回: 成功
token 字符串	TXT 记录的内容。返回: 成功
verified 字符串	区域被验证的时间。返回: 成功示例: `"2021-07-15T19:23:58Z"`
zone_name 整数	区域的名称。返回: 成功示例: `"example.com"`

作者

Markus Bergholz (@markuman)
Felix Fontein (@felixfontein)