community.dns.hosttech_dns_record_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_info。

community.dns 2.0.0 中的新功能

概要

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

要求

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

• 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 字符串	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" ← (默认)
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 integer	要修改的 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 此操作不会修改状态。	在 diff 模式下，将返回有关已更改（或可能需要在 check_mode 中更改）的内容的详细信息。

另请参阅

另请参阅

community.dns.hosttech_dns_record_set_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_info:
    zone_name: foo.com
    record: new.foo.com
    type: A
    hosttech_token: access_token
  register: rec

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

返回值

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

键	描述
records list / elements=dictionary	获取的记录列表。 返回：成功且 what 不是 single_record 示例： [{"extra": {}, "record": "sample.example.com", "ttl": 3600, "type": "A", "value": "1.2.3.4"}]
extra dictionary	有关记录的额外信息。 返回：成功 示例： {"comment": ""}
prefix 字符串	记录前缀。 返回：成功 示例： "sample"
record 字符串	记录名称。 返回：成功 示例： "sample.example.com"
ttl integer	TTL。 返回：成功 示例： 3600
type 字符串	DNS 记录类型。 返回：成功 示例： "A"
value 字符串	DNS 记录的值。 返回：成功 示例： "1.2.3.4"
zone_id integer	区域的 ID。 返回：成功 示例： 23

作者

• Felix Fontein (@felixfontein)

集合链接

• 问题跟踪器
• 存储库（来源）
• 寻求帮助 (DNS)
• 提交错误报告
• 请求功能
• 通信