win_wait_for – Ожидание условия перед продолжением
Новое в версии 2.4.
Описание
- Вы можете дождаться определенного промежутка времени
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 строка |
| При проверке порта, started обеспечит открытость порта, stopped проверит его закрытость, а drained проверит наличие активных подключений.При проверке файла или строки поиска present или started обеспечит наличие файла или строки, absent проверит отсутствие или удаление файла или строки поиска. |
| timeout целое число | По умолчанию: 300 | Максимальное время ожидания в секундах. |
См. также
См. также
- wait_for – Ожидание условия перед продолжением
- Официальная документация модуля wait_for.
- win_wait_for_process – Ожидание существования или отсутствия процесса перед продолжением
- Официальная документация модуля win_wait_for_process.
Примеры
- name: Wait 300 seconds for port 8000 to become open on the host, don't start checking for 10 seconds
win_wait_for:
port: 8000
delay: 10
- name: Wait 150 seconds for port 8000 of any IP to close active connections
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
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
win_wait_for:
path: C:\temp\log.txt
- name: Wait until process complete is in the file before continuing
win_wait_for:
path: C:\temp\log.txt
regex: process complete
- name: Wait until file is removed
win_wait_for:
path: C:\temp\log.txt
state: absent
- name: Wait until port 1234 is offline but try every 10 seconds
win_wait_for:
port: 1234
state: absent
sleep: 10
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| elapsed вещественное число | всегда | Прошедшие секунды с момента начала опроса до завершения модуля. Включает в себя значение delay, если оно установлено. Пример: 2.1406487 |
| wait_attempts целое число | всегда | Количество попыток опроса файла или порта до завершения модуля. Пример: 1 |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.9/modules/win_wait_for_module.html
