ansible.windows.win_wait_for – Ожидание условия перед продолжением

Примечание

Этот плагин входит в коллекцию ansible.windows (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install ansible.windows.

Для использования в плейбуке укажите: ansible.windows.win_wait_for.

Описание
Параметры
См. также
Примеры
Возвращаемые значения

Описание

Можно ожидать определённое количество времени timeout, это значение по умолчанию, если ничего не указано.
Ожидание доступности порта полезно, когда сервисы не становятся доступными сразу после возврата скриптов инициализации, что характерно для некоторых серверов приложений Java.
Можно ожидать существования или отсутствия файла в файловой системе.
Этот модуль также может использоваться для ожидания совпадения строки с регулярным выражением в файле.
Можно ожидать закрытия активных соединений на локальном порту перед продолжением.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
connect_timeout целое число	По умолчанию: 5	Максимальное время ожидания соединения в секундах, после чего соединение закрывается и попытка повторяется.
delay целое число		Количество секунд ожидания перед началом опроса.
exclude_hosts список / элементы=строка		Список хостов или IP-адресов, которые следует игнорировать при поиске активных TCP-соединений, когда `state=drained`.
host строка	По умолчанию: "127.0.0.1"	Разрешаемый хост или IP-адрес для ожидания. Если `state=drained`, то проверка будет проводиться только для указанного IP-адреса, можно использовать '0.0.0.0' для использования всех IP-адресов хоста.
path путь		Путь к файлу в файловой системе для проверки. Если `state` присутствует или запущен, то будет ожидание до появления файла. Если `state` отсутствует, то будет ожидание до исчезновения файла.
port целое число		Номер порта для опроса `host`.
regex строка		Можно использовать для соответствия строки в файле. Если `state` присутствует или запущен, то будет ожидание до совпадения с регулярным выражением. Если `state` отсутствует, то будет ожидание до отсутствия совпадения с регулярным выражением. По умолчанию используется многострочное регулярное выражение. псевдонимы: search_regex, regexp
sleep целое число	По умолчанию: 1	Количество секунд ожидания между проверками.
state строка	Варианты: absent drained present started ← stopped	При проверке порта, `started` обеспечит открытость порта, `stopped` проверит закрытость, и `drained` проверит активные соединения. При проверке файла или строки поиска, `present` или `started` обеспечат наличие файла или строки, `absent` проверит отсутствие файла или строки.
timeout целое число	По умолчанию: 300	Максимальное время ожидания в секундах.

См. также

ansible.builtin.wait_for: Официальная документация модуля ansible.builtin.wait_for.
community.windows.win_wait_for_process: Официальная документация модуля community.windows.win_wait_for_process.

Примеры

- name: Wait 300 seconds for port 8000 to become open on the host, don't start checking for 10 seconds
  ansible.windows.win_wait_for:
    port: 8000
    delay: 10

- name: Wait 150 seconds for port 8000 of any IP to close active connections
  ansible.windows.win_wait_for:
    host: 0.0.0.0
    port: 8000
    state: drained
    timeout: 150

- name: Wait for port 8000 of any IP to close active connection, ignoring certain hosts
  ansible.windows.win_wait_for:
    host: 0.0.0.0
    port: 8000
    state: drained
    exclude_hosts: ['10.2.1.2', '10.2.1.3']

- name: Wait for file C:\temp\log.txt to exist before continuing
  ansible.windows.win_wait_for:
    path: C:\temp\log.txt

- name: Wait until process complete is in the file before continuing
  ansible.windows.win_wait_for:
    path: C:\temp\log.txt
    regex: process complete

- name: Wait until file is removed
  ansible.windows.win_wait_for:
    path: C:\temp\log.txt
    state: absent

- name: Wait until port 1234 is offline but try every 10 seconds
  ansible.windows.win_wait_for:
    port: 1234
    state: absent
    sleep: 10

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

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

Ключ	Возвращаемое значение	Описание
elapsed вещественное число	всегда	Прошедшее время в секундах с момента начала опроса до завершения модуля. Включает время ожидания, если опция установлена. Пример: 2.1406487
wait_attempts целое число	всегда	Количество попыток опроса файла или порта перед завершением модуля. Пример: 1

Авторы

Jordan Borean (@jborean93)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/windows/win_wait_for_module.html