community.dns.hetzner_dns_record_info 模块 – 在 Hetzner DNS 服务中检索记录

注意

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

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

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

要在剧本中使用它，请指定：community.dns.hetzner_dns_record_info。

community.dns 2.0.0 中的新增功能

概要

  • 检索 Hetzner DNS 服务中的 DNS 记录。

参数

参数

注释

hetzner_token

别名：api_token

字符串 / 必需

Hetzner API 的令牌。

如果未提供，将从环境变量 HETZNER_DNS_TOKEN 中读取。

prefix

字符串

DNS 记录的前缀。

这是 record 在 zone_name 之前的部分。例如，如果要修改的记录是区域 example.com 的 www.example.com，则前缀为 www。如果此示例中的记录为 example.com，则前缀为 ''（空字符串）。

如果 what 为 single_record 或 all_types_for_record，则需要 record 和 prefix 中的一个。

record

字符串

要检索的完整 DNS 记录。

如果 what 为 single_record 或 all_types_for_record，则需要 record 和 prefix 中的一个。

txt_character_encoding

字符串

在 community.dns 2.5.0 中添加

是否将数字转义序列（\xyz）视为八进制数或十进制数。仅当 txt_transformation=quoted 时才使用。

在 community.dns 3.0.0 中，默认值更改为 decimal。在此之前，默认值为 octal。decimal 值与 RFC 1035 兼容。

选项

  • "decimal" ← (默认)

  • "octal"

txt_transformation

字符串

确定如何在 API 和此模块的输入和输出之间转换 TXT 条目值。

api 值表示从此模块返回的值与 API 返回的值相同，并将其推送到 API 中，就像它们已传递到此模块一样。对于幂等性检查，将输入字符串与 API 返回的字符串进行比较。API 可能会自动转换某些值，例如拆分长值或添加引号，这可能会导致幂等性问题。

值 unquoted 会自动转换值，允许您传入未加引号的值，模块也会返回未加引号的值。如果您传入加引号的值，它们将被双引号包围。

值 quoted 会自动转换值，要求包含空格、引号和反斜杠等字符以及长度超过 255 字节的值必须使用引号。它还会确保以标准化的编码返回 API 中的值。

默认值 unquoted 确保您可以处理值，而无需关心 DNS 的正确引号方式。大多数用户应该使用 unquoted 或 quoted，而不应使用 api。

注意：转换代码假设值为 UTF-8 编码。如果您需要其他编码，请使用 txt_transformation=api 并自行处理编码。

选项

  • "api"

  • "quoted"

  • "unquoted" ← (默认)

类型

字符串

要检索的 DNS 记录类型。

如果 what 为 single_record，则此项为必填。

选项

  • "A"

  • "AAAA"

  • "CAA"

  • "CNAME"

  • "DANE"

  • "DS"

  • "HINFO"

  • "MX"

  • "NS"

  • "RP"

  • "SOA"

  • "SRV"

  • "TLSA"

  • "TXT"

what

字符串

描述是获取单个记录和类型组合、记录的所有类型还是所有记录。默认情况下，将获取单个记录和类型组合。

请注意，返回值结构取决于此选项。

选项

  • "single_record" ← (默认)

  • "all_types_for_record"

  • "all_records"

zone_id

字符串

要修改的 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 中更改的内容）的详细信息。

另请参见

另请参见

community.dns.hetzner_dns_record_set_info

检索 Hetzner DNS 服务中的记录集。

community.dns.hetzner_dns_records 清单插件

从 Hetzner DNS 记录创建清单。

示例

- name: Retrieve the details for the A records of new.foo.com
  community.dns.hetzner_dns_record_info:
    zone: foo.com
    record: new.foo.com
    type: A
    hetzner_token: access_token
  register: rec

- name: Print the A records
  ansible.builtin.debug:
    msg: "{{ rec.records }}"

返回值

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

键

描述

records

列表 / 元素=字典

获取的记录列表。

已返回：成功且 what 不是 single_record

示例： [{"extra": {}, "record": "sample.example.com", "ttl": 3600, "type": "A", "value": "1.2.3.4"}]

extra

字典

记录的额外信息。

已返回：成功

示例： {"created": "2021-07-09T11:18:37Z", "modified": "2021-07-09T11:18:37Z"}

prefix

字符串

记录前缀。

已返回：成功

示例： "sample"

record

字符串

记录名称。

已返回：成功

示例： "sample.example.com"

ttl

整数

TTL。

如果使用区域的默认 TTL，则将返回 none。

已返回：成功

示例： 3600

类型

字符串

DNS 记录类型。

已返回：成功

示例： "A"

value

字符串

DNS 记录的值。

已返回：成功

示例： "1.2.3.4"

zone_id

字符串

区域的 ID。

已返回：成功

示例： "23"

作者

  • Markus Bergholz (@markuman)

  • Felix Fontein (@felixfontein)