HostTech DNS 指南

community.dns 集合提供了多个模块，用于使用 HostTech DNS 服务。这些模块支持旧的基于 WSDL 的 API 和新的基于 JSON REST 的 API。

该集合提供了六个模块，用于使用 HostTech DNS

community.dns.hosttech_dns_record：创建/更新/删除单个 DNS 记录
community.dns.hosttech_dns_record_info：检索有关 DNS 记录的信息
community.dns.hosttech_dns_record_set：创建/更新/删除 DNS 记录集
community.dns.hosttech_dns_record_set_info：检索有关 DNS 记录集的信息
community.dns.hosttech_dns_record_sets：批量同步 DNS 记录集
community.dns.hosttech_dns_zone_info：检索区域信息

它还提供一个清单插件

community.dns.hosttech_dns_records：从 DNS 记录创建清单

使用 DNS 区域 

community.dns.hosttech_dns_zone_info 模块允许查询有关区域的信息。可以通过其名称和 ID（整数）来标识区域

- name: Query zone information by name
  community.dns.hosttech_dns_zone_info:
    zone_name: example.com
  register: result

- name: Query zone information by ID
  community.dns.hosttech_dns_zone_info:
    zone_id: 42
  register: result

该模块返回区域名称和区域 ID，因此该模块可用于从区域 ID 转换为区域名称，反之亦然

- ansible.builtin.debug:
    msg: |
        The zone ID: {{ result.zone_id }}
        The zone name: {{ result.zone_name }}

使用 DNS 记录 

注意

默认情况下，此集合中的模块和插件返回和接受的 TXT 记录值是未加引号的。这意味着您不必添加双引号 ( " )，也不必转义双引号（使用 \" ）和反斜杠（使用 \\ ）。所有处理 DNS 记录的模块和插件都支持 txt_transformation 选项，该选项允许配置此行为。

查询 DNS 记录和记录集 

community.dns.hosttech_dns_record_set_info 模块允许从 API 查询 DNS 记录集。它可用于查询单个记录集。

- name: Query single record
  community.dns.hosttech_dns_record_set_info:
    zone_name: example.com
    type: A  # IPv4 addresses
    what: single_record  # default value
    # Either specify a record name:
    record: www.example.com
    # Or a record prefix ('' is the zone itself):
    prefix: www
  register: result

- name: Show IPv4 addresses if record exists
  ansible.builtin.debug:
    msg: >
      IPv4s are {{ result.set.value | join(', ') }},
      TTL is {{ result.set.ttl }}
  when: result.set

- name: Show that record is not set
  ansible.builtin.debug:
    msg: There is no A record for www.example.com
  when: not result.set

在本节的所有示例中，您可以用 zone_id=42 替换 zone_name=example.com，使用区域的整数 ID。

您还可以查询记录名称或前缀的所有记录集列表。

- name: Query all records for www.example.com
  community.dns.hosttech_dns_record_set_info:
    zone_name: example.com
    what: all_types_for_record
    # Either specify a record name:
    record: www.example.com
    # Or a record prefix ('' is the zone itself):
    prefix: www
  register: result

- name: Show all records for www.example.com
  ansible.builtin.debug:
    msg: >
      {{ item.type }} record with TTL {{ item.ttl }} has
      values {{ item.value | join(', ') }}
  loop: result.sets

最后，您可以查询一个区域的所有记录集。

- name: Query all records for a zone
  community.dns.hosttech_dns_record_set_info:
    zone_name: example.com
    what: all_records
  register: result

- name: Show all records for the example.com zone
  ansible.builtin.debug:
    msg: >
      {{ item.type }} record for {{ item.record }} with
      TTL {{ item.ttl }} has values {{ item.value | join(', ') }}
  loop: result.sets

如果您对单个 DNS 记录（而不是记录集）感兴趣，则应使用 community.dns.hosttech_dns_record_info 模块。它支持与 community.dns.hosttech_dns_record_set_info 模块相同的限制选项。

创建和更新 DNS 记录集 

community.dns.hosttech_dns_record_set 模块允许设置、更新和删除 DNS 记录集。设置和更新可以如下完成。

- name: Make sure record is set to the given value
  community.dns.hosttech_dns_record_set:
    state: present
    zone_name: example.com
    type: A  # IPv4 addresses
    # Either specify a record name:
    record: www.example.com
    # Or a record prefix ('' is the zone itself):
    prefix: www
    value:
      - 1.1.1.1
      - 8.8.8.8

如果您想断言某个记录具有特定值，请设置 on_existing=keep 。使用 keep_and_warn 将在此情况发生时发出警告，而 keep_and_fail 将使模块失败。

要删除值，您可以将值覆盖为 [] ，或使用 state=absent 。

- name: Remove A values for www.example.com
  community.dns.hosttech_dns_record_set:
    state: present
    zone_name: example.com
    type: A  # IPv4 addresses
    record: www.example.com
    value: []

- name: Remove TXT values for www.example.com
  community.dns.hosttech_dns_record_set:
    zone_name: example.com
    type: TXT
    prefix: www
    state: absent

- name: Remove specific AAAA values for www.example.com
  community.dns.hosttech_dns_record_set:
    zone_name: example.com
    type: AAAA  # IPv6 addresses
    prefix: www
    state: absent
    on_existing: keep_and_fail
    ttl: 300
    value:
      - '::1'

在第三个示例中，存在 on_existing=keep_and_fail，并给出了明确的值和 TTL。这使得该模块仅在 www.example.com 存在 AAAA 记录，且当前值为 ::1 且 TTL 为 300 时，才删除当前值。如果设置了另一个值，该模块将不会进行任何更改，但会失败。这对于避免意外删除您不想更改的值非常有用。要发出警告而不是失败，请使用 on_existing=keep_and_warn ，并且要简单地不做任何更改而不提示此情况，请使用 on_existing=keep 。

批量同步 DNS 记录集 

如果您想一次设置/更新多个记录，或者甚至确保您提供的精确记录集存在且没有其他记录，则可以使用 community.dns.hosttech_dns_record_sets 模块。

以下示例展示了一次设置/更新多个记录的方法。

- name: Make sure that multiple records are present
  community.dns.hosttech_dns_record_sets:
    zone_name: example.com
    record_sets:
      - prefix: www
        type: A
        value:
          - 1.1.1.1
          - 8.8.8.8
      - prefix: www
        type: AAAA
        value:
          - '::1'

下一个示例展示了如何确保仅给定记录可用，并且所有其他记录都已删除。请注意，对于 record_sets[].type=NS 记录，我们使用了 record_sets[].ignore=true ，这允许我们跳过该值。它告诉模块不应触及 example.com 的 NS 记录。

- name: Make sure that multiple records are present
  community.dns.hosttech_dns_record_sets:
    zone_name: example.com
    prune: true
    record_sets:
      - prefix: www
        type: A
        value:
          - 1.1.1.1
          - 8.8.8.8
      - prefix: www
        type: AAAA
        value:
          - '::1'
      - prefix: ''
        type: NS
        ignore: true

HostTech DNS 指南

身份验证、要求和 API 

JSON REST API 

WSDL API 

使用 `community.dns.hosttech` 模块默认组 

使用 DNS 区域 

使用 DNS 记录 

查询 DNS 记录和记录集 

创建和更新 DNS 单个记录 

创建和更新 DNS 记录集 

批量同步 DNS 记录集 