Spec-Zone.ru › Ansible

Модуль community.dns.wait_for_txt – ожидание появления записей TXT на всех авторитетных серверах имён

Примечание

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

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

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

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

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

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

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

  • Ожидание появления записей TXT с заданными значениями на всех авторитетных серверах имён для DNS-имени.

Требования

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

  • dnspython >= 1.15.0 (возможно, подойдут и более старые версии)

Параметры

Параметр

Комментарии

always_ask_default_resolver

boolean

Если задано значение true (по умолчанию), для поиска авторитетных серверов имён подзоны будет использоваться резолвер по умолчанию. Сведения о настройке резолвера по умолчанию см. в server.

Если задано значение false, для поиска авторитетных серверов имён подзоны будут использоваться авторитетные серверы имён родительской зоны. Это имеет смысл только в том случае, если серверы имён были недавно изменены и изменения ещё не распространились.

Варианты:

  • false
  • true ← (по умолчанию)

max_sleep

float

Максимальное время ожидания в секундах между двумя циклами проверки записей TXT.

По умолчанию: 10.0

query_retry

integer

Количество повторных попыток при тайм-ауте DNS-запроса.

По умолчанию: 3

query_timeout

float

Тайм-аут каждого DNS-запроса в секундах.

По умолчанию: 10.0

records

list / elements=dictionary / required

Список DNS-имён, для которых нужно ожидать появления записей TXT.

mode

string

Режимы сравнения значений в records[].values.

Если задано значение subset, records[].values должно быть подмножеством (не обязательно собственным) набора значений TXT для DNS-имени.

Если задано значение superset, records[].values должно быть надмножеством (не обязательно собственным) набора значений TXT для DNS-имени. Сюда входит случай, когда записи TXT отсутствуют.

Если задано значение superset_not_empty, records[].values должно быть надмножеством (не обязательно собственным) набора значений TXT для DNS-имени при условии, что присутствует хотя бы одна запись TXT.

Если задано значение equals, records[].values должно совпадать с набором строк, являющихся значениями TXT для DNS-имени (порядок не учитывается).

Если задано значение equals_ordered, records[].values должно совпадать с упорядоченным списком строк, являющихся значениями TXT для DNS-имени.

Варианты:

  • "subset" ← (по умолчанию)
  • "superset"
  • "superset_not_empty"
  • "equals"
  • "equals_ordered"

name

string / required

DNS-имя, например www.example.com.

values

псевдонимы: entries

list / elements=string / required

Значения TXT, которые нужно найти.

Псевдоним records[].entries добавлен в community.dns 3.4.0.

server

list / elements=string

добавлено в community.dns 2.7.0

DNS-серверы, которые будут использоваться для получения результата. Должен быть указан список из одного или нескольких IP-адресов.

По умолчанию используется стандартный системный резолвер.

servfail_retries

integer

добавлено в community.dns 2.6.0

Количество повторных попыток при ошибках SERVFAIL.

По умолчанию: 0

timeout

float

Общий тайм-аут ожидания всех записей в секундах.

Если не задан, ожидание будет бесконечным.

Атрибуты

Атрибут

Поддержка

Описание

check_mode

Поддержка: полная

добавлено в community.dns 2.4.0

Это действие не изменяет состояние.

Может работать в режиме check_mode и возвращать прогноз изменения состояния, не изменяя целевой объект.

diff_mode

Поддержка: Н/Д

Это действие не изменяет состояние.

В режиме diff будут возвращены сведения об изменениях (или о возможных изменениях в check_mode).

idempotent

Поддержка: полная

Это действие не изменяет состояние.

При повторном запуске подряд вне режима check mode с теми же аргументами второй вызов сообщает об отсутствии изменений.

Предполагается, что система, которой управляет модуль или к которой он обращается, не изменилась существенным образом.

Примеры

- name: Wait for a TXT entry to appear
  community.dns.wait_for_txt:
    records:
      # We want that www.example.com has a single TXT record with value 'Hello world!'.
      # There should not be any other TXT record for www.example.com.
      - name: www.example.com
        values: "Hello world!"
        mode: equals
      # We want that example.com has a specific SPF record set.
      # We do not care about other TXT records.
      - name: www.example.com
        values: "v=spf1 a mx -all"
        mode: subset

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

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

Ключ

Описание

completed

integer

Количество выполненных проверок.

Возвращается: всегда

Пример: 3

records

list / elements=dictionary

Результаты запросов записей TXT.

Элементы соответствуют элементам параметра records в соотношении 1:1 и расположены в точно таком же порядке.

Возвращается: всегда

Пример: [{"check_count": 1, "done": true, "entries": ["a", "b", "c"], "name": "example.com"}, {"check_count": 0, "done": false, "name": "foo.example.org"}]

check_count

integer

Количество проверок записей TXT для этого DNS-имени.

Возвращается: всегда

Пример: 3

done

boolean

Указывает, завершена ли проверка.

Возвращается: всегда

Пример: false

entries

dictionary

добавлено в community.dns 3.4.0

Для каждого авторитетного сервера имён DNS-имени перечисляет записи TXT, полученные во время последнего выполненного поиска.

После завершения проверки всех полученных записей TXT проверка записей TXT для этого DNS-имени прекращается.

Если для сервера имён получено несколько записей TXT, они перечислены в порядке, в котором были получены от этого сервера. Этот порядок может отличаться от порядка, указанного в проверке.

Ранее это поле называлось records[].values.

Возвращается: поиск был выполнен хотя бы один раз

Пример: {"ns1.example.com": ["TXT value 1", "TXT value 2"], "ns2.example.com": ["TXT value 2"]}

name

string

DNS-имя, для которого выполняется эта проверка.

Возвращается: всегда

Пример: "example.com"

values

dictionary

Для каждого авторитетного сервера имён DNS-имени перечисляет записи TXT, полученные во время последнего выполненного поиска.

После завершения проверки всех полученных записей TXT проверка записей TXT для этого DNS-имени прекращается.

Если для сервера имён получено несколько записей TXT, они перечислены в порядке, в котором были получены от этого сервера. Этот порядок может отличаться от порядка, указанного в проверке.

В community.dns 3.4.0 поле переименовано в records[].entries. Старое имя будет поддерживаться ещё долго, но рекомендуется использовать новое.

Возвращается: поиск был выполнен хотя бы один раз

Авторы

  • Felix Fontein (@felixfontein)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Задать вопрос (DNS)
  • Сообщить об ошибке
  • Предложить функцию
  • Связь

© 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/wait_for_txt_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API