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 |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместим.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/win_wait_for_module.html
