Модуль ansible.windows.win_wait_for — ожидание условия перед продолжением

Примечание

Этот модуль является частью коллекции ansible.windows (версия 2.5.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

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

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

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

Описание

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

Параметры

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

См. также

ansible.builtin.wait_for: Ожидание условия перед продолжением.
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/windows/win_wait_for_module.html