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-адреса. Для использования всех IP-адресов хоста можно использовать '0.0.0.0'. |
| path путь | Путь к файлу в файловой системе для проверки. Если state присутствует или запущен, то ожидание будет продолжаться до появления файла.Если state отсутствует, то ожидание будет продолжаться до исчезновения файла. | |
| port целое число | Номер порта для опроса в host. | |
| regex строка | Может использоваться для соответствия строки в файле. Если state присутствует или запущен, то ожидание будет продолжаться до соответствия регулярному выражению.Если state отсутствует, то ожидание будет продолжаться до отсутствия соответствия регулярному выражению.По умолчанию используется многострочное регулярное выражение. псевдонимы: search_regex, regexp | |
| sleep целое число | Значение по умолчанию: 1 | Количество секунд ожидания между проверками. |
| state строка |
| При проверке порта, 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/windows/win_wait_for_module.html