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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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` присутствует или задано значение started, модуль будет ждать появления файла. Если `state` отсутствует, модуль будет ждать, пока файл не исчезнет.
port целое число	Номер порта, который нужно проверять на `host`.
regex псевдонимы: search_regex, regexp строка	Можно использовать для поиска строки в файле. Если `state` присутствует или задано значение started, модуль будет ждать совпадения с регулярным выражением. Если `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 for port 8080 on 192.168.1.10 with a increased connection timeout
  ansible.windows.win_wait_for:
    host: 192.168.1.10
    port: 8080
    connect_timeout: 20
    timeout: 60

- 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/ansible/windows/win_wait_for_module.html