Модуль community.dns.hosttech_dns_record_sets — пакетная синхронизация наборов записей DNS в службе Hosttech DNS

Примечание

Этот модуль входит в коллекцию community.dns (версия 3.5.5).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.dns. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.dns.hosttech_dns_record_sets.

Добавлено в community.dns 2.0.0

Краткое описание
Требования
Параметры
Атрибуты
См. также
Примеры
Возвращаемые значения

Краткое описание

Пакетная синхронизация наборов записей DNS в службе Hosttech DNS.
Чтобы игнорировать определённые наборы записей, для соответствующего набора можно указать record_sets[].ignore=true.
Модуль позволяет одновременно задавать, изменять и удалять несколько наборов записей DNS.
Этот модуль заменяет hosttech_dns_records из community.dns до версии 2.0.0.
С помощью параметра prune можно также удалять существующие наборы записей, не указанные в параметрах модуля. Это позволяет синхронизировать ожидаемое состояние зоны DNS с заданным состоянием.

Требования

На узле, который выполняет этот модуль, необходимы следующие компоненты.

lxml

Параметры

Параметр	Комментарии
hosttech_password строка	Пароль пользователя API Hosttech. Если указан, необходимо также указать `hosttech_username`. Взаимоисключающий с `hosttech_token`.
hosttech_token псевдонимы: api_token строка добавлено в community.dns 0.2.0	Пароль пользователя API Hosttech. Взаимоисключающий с `hosttech_username` и `hosttech_password`. Начиная с community.dns 1.2.0, можно использовать псевдоним `api_token`.
hosttech_username строка	Имя пользователя API Hosttech. Если указано, необходимо также указать `hosttech_password`. Взаимоисключающий с `hosttech_token`.
prune логическое значение	Если задано значение `true`, удаляются все существующие записи зоны, не перечисленные в `record_sets`. Варианты: `false` ← (по умолчанию) `true`
record_sets псевдонимы: records список / элементы=словарь / обязательный	Записи, которые должны присутствовать в зоне.
ignore логическое значение	Если задано значение `true`, `record_sets[].value` игнорируется. Это полезно, если `prune=true`, но вы не хотите удалять определённые записи и при этом не хотите узнавать их текущие значения. Варианты: `false` ← (по умолчанию) `true`
prefix строка	Префикс записи DNS. Это часть `record_sets[].record` перед `zone_name`. Например, если изменяемая запись — `www.example.com` для зоны `example.com`, префикс — `www`. Если бы запись в этом примере была `example.com`, префиксом было бы `''` (пустая строка). Необходимо указать ровно один из параметров: `record_sets[].record` или `record_sets[].prefix`.
record строка	Полная запись DNS для создания или удаления. Необходимо указать ровно один из параметров: `record_sets[].record` или `record_sets[].prefix`.
ttl целое число	Значение TTL новой записи в секундах. По умолчанию: `3600`
type строка / обязательный	Тип записи DNS для создания или удаления. Варианты: `"A"` `"AAAA"` `"CAA"` `"CNAME"` `"MX"` `"NS"` `"PTR"` `"SPF"` `"SRV"` `"TXT"`
value список / элементы=строка	Новое значение при создании записи DNS. Допускаются списки YAML или несколько значений, разделённых запятыми. При удалении записи необходимо указать все её значения, иначе запись не будет удалена. Обязательно укажите, если `record_sets[].ignore=false`.
txt_character_encoding строка добавлено в community.dns 2.5.0	Определяет, следует ли интерпретировать числовые escape-последовательности (`\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"` ← (по умолчанию)
zone_id целое число	Идентификатор изменяемой зоны DNS. Необходимо указать ровно один из параметров: `zone_name` или `zone_id`.
zone_name псевдонимы: zone строка	Изменяемая зона DNS. Необходимо указать ровно один из параметров: `zone_name` или `zone_id`.

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.dns.hosttech добавлено в community.dns 2.4.0	Используйте `group/community.dns.hosttech` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменений, не изменяя целевую систему.
diff_mode	Поддержка: полная	В режиме сравнения возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).
idempotent	Поддержка: полная	При повторном запуске с теми же аргументами вне режима проверки модуль сообщает об отсутствии изменений. Предполагается, что система, которой управляет модуль или к которой он обращается, не изменилась существенным образом.

См. также

Поддерживаемые записи DNS: Дополнительные сведения о поддерживаемых типах записей DNS.

Примеры

- name: Make sure some records exist and have the expected values
  community.dns.hosttech_dns_record_sets:
    zone_name: foo.com
    records:
      - prefix: new
        type: A
        ttl: 7200
        value:
          - 1.1.1.1
          - 2.2.2.2
      - prefix: new
        type: AAAA
        ttl: 7200
        value:
          - "::1"
      - record: foo.com
        type: TXT
        value:
          - test
    hosttech_token: access_token

- name: Synchronize DNS zone with a fixed set of records
  # If a record exists that is not mentioned here, it will be deleted
  community.dns.hosttech_dns_record_sets:
    zone_id: 23
    purge: true
    records:
      - prefix: ''
        type: A
        value: 127.0.0.1
      - prefix: ''
        type: AAAA
        value: "::1"
      - prefix: ''
        type: NS
        value:
          - ns-1.hoster.com
          - ns-2.hoster.com
          - ns-3.hoster.com
    hosttech_token: access_token

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
zone_id целое число	Идентификатор зоны. Возвращается: success Пример: `23`

Авторы

Felix Fontein (@felixfontein)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/dns/hosttech_dns_record_sets_module.html