community.dns.hosttech_dns_record_set_info 模块 – 在 Hosttech DNS 服务中检索记录集

注意

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

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

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

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

community.dns 0.1.0 中的新增功能

概要

要求

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

  • lxml

参数

参数

注释

hosttech_password

字符串

Hosttech API 用户的密码。

如果提供，则还必须提供 hosttech_username。

与 hosttech_token 互斥。

hosttech_token

别名：api_token

字符串

在 community.dns 0.2.0 中添加

Hosttech API 用户的密码。

与 hosttech_username 和 hosttech_password 互斥。

自 community.dns 1.2.0 起，可以使用别名 api_token。

hosttech_username

字符串

Hosttech API 用户的用户名。

如果提供，则还必须提供 hosttech_password。

与 hosttech_token 互斥。

prefix

字符串

在 community.dns 0.2.0 中添加

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

字符串

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

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

unquoted 值会自动转换值，以便您可以传入未加引号的值，并且模块将返回未加引号的值。如果您传入带引号的值，则它们将被双引号括起来。

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

默认值 unquoted 确保您可以使用值而无需关心如何为 DNS 正确地添加引号。大多数用户应该使用 unquoted 或 quoted 中的一个，而不是 api。

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

选项

  • "api"

  • "quoted"

  • "unquoted" ← (默认)

type

字符串

要检索的 DNS 记录类型。

如果 what 为 single_record，则为必需。

选项

  • "A"

  • "AAAA"

  • "CAA"

  • "CNAME"

  • "MX"

  • "NS"

  • "PTR"

  • "SPF"

  • "SRV"

  • "TXT"

what

字符串

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

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

选项

  • "single_record" ← (默认)

  • "all_types_for_record"

  • "all_records"

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.hosttech

在 community.dns 2.4.0 版本中添加

在 module_defaults 中使用 group/community.dns.hosttech 为此模块设置默认值。

check_mode

支持：完全支持

此操作不会修改状态。

可以在 check_mode 下运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持： N/A

此操作不会修改状态。

在差异模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

另请参阅

另请参阅

community.dns.hosttech_dns_record_info

在 Hosttech DNS 服务中检索记录。

community.dns.hosttech_dns_records 清单插件

从 Hosttech DNS 记录创建清单。

示例

- name: Retrieve the details for the A records of new.foo.com
  community.dns.hosttech_dns_record_set_info:
    zone_name: foo.com
    record: new.foo.com
    type: A
    hosttech_token: access_token
  register: rec

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

返回值

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

键

描述

set

字典

获取的记录集。如果记录集不存在，则为空。

返回：成功且 what=single_record

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

prefix

字符串

在 community.dns 0.2.0 中添加

记录前缀。

返回：成功

示例："sample"

record

字符串

记录名称。

返回：成功

示例："sample.example.com"

ttl

整数

TTL。

如果此集合中存在具有不同 TTL 的记录，则此处将显示 TTL 的最小值。

返回：成功

示例：3600

ttls

列表 / 元素=整数

如果此集合中存在具有不同 TTL 值的记录，则此列表将显示记录中出现的 TTL。

每个不同的 TTL 将出现一次，并且 TTL 按升序排列。

返回：当存在多个不同的 TTL 时

示例：[300, 3600]

type

字符串

DNS 记录类型。

返回：成功

示例："A"

value

列表 / 元素=字符串

DNS 记录集的值。

返回：成功

示例：["1.2.3.4", "1.2.3.5"]

sets

列表 / 元素=字典

获取的记录集列表。

返回：成功且 what=single_record

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

prefix

字符串

在 community.dns 0.2.0 中添加

记录前缀。

返回：成功

示例："sample"

record

字符串

记录名称。

返回：成功

示例："sample.example.com"

ttl

整数

TTL。

如果此集合中存在具有不同 TTL 的记录，则此处将显示 TTL 的最小值。

返回：成功

示例：3600

ttls

列表 / 元素=整数

如果此集合中存在具有不同 TTL 值的记录，则此列表将显示记录中出现的 TTL。

每个不同的 TTL 将出现一次，并且 TTL 按升序排列。

返回：当存在多个不同的 TTL 时

示例：[300, 3600]

type

字符串

DNS 记录类型。

返回：成功

示例："A"

value

列表 / 元素=字符串

DNS 记录集的值。

返回：成功

示例：["1.2.3.4", "1.2.3.5"]

zone_id

整数

在 community.dns 0.2.0 中添加

区域的 ID。

返回：成功

示例：23

作者

  • Felix Fontein (@felixfontein)