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. | |
| search_regex | Может быть использован для поиска строки в файле. Если state присутствует или запущен, то он будет ждать, пока регулярное выражение найдёт совпадение.Если state отсутствует, то он будет ждать, пока регулярное выражение не найдёт совпадения.По умолчанию используется многострочное регулярное выражение. | |
| sleep | Значение по умолчанию: 1 | Количество секунд ожидания между проверками. |
| state |
| При проверке порта, started гарантирует, что порт открыт, stopped проверит, что он закрыт, а drained проверит активные подключения.При проверке файла или строки поиска present или started гарантируют, что файл или строка присутствуют, absent проверит, что файл или строка отсутствуют или удалены. |
| timeout | Значение по умолчанию: 300 | Максимальное время ожидания в секундах. |
Примеры
- 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
search_regex: process complete
- name: wait until file if 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 float | всегда | Прошедшее время в секундах с начала опроса до завершения модуля. Включает в себя задержку, если она задана. Пример: 2.1406487 |
| wait_attempts int | всегда | Количество попыток опроса файла или порта до завершения модуля. Пример: 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.5/modules/win_wait_for_module.html