Модуль community.windows.win_wait_for_process — Ожидание существования или несуществования процесса перед продолжением.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.windows.

Чтобы использовать её в книге задач, укажите: community.windows.win_wait_for_process.

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

Описание

Ожидание запуска или остановки процесса.
Это полезно в случае некорректного поведения служб Windows, которые не перечисляют внешние зависимости в своём манифесте.

Параметры

Параметр	Комментарии
owner строка	Владелец процесса. Требуется версия PowerShell 4.0 или новее.
pid целое число	Идентификатор процесса (PID). По умолчанию: `0`
post_wait_delay целое число	Секунды ожидания после проверки процессов. По умолчанию: `0`
pre_wait_delay целое число	Секунды ожидания перед проверкой процессов. По умолчанию: `0`
process_min_count целое число	Минимальное количество процессов, соответствующих заданному шаблону, для выполнения условия `present`. Применимо только к `present`. По умолчанию: `1`
process_name_exact список / элементы=строка	Имя процесса(ов) для ожидания. Имя процесса(ов) не должно содержать расширение файла.
process_name_pattern строка	Шаблон RegEx для поиска нужного процесса(ов).
sleep целое число	Количество секунд ожидания между проверками. Применимо только при ожидании запуска процесса. Ожидание запуска процесса не имеет встроенного механизма, отличного от опроса. Ожидание остановки использует встроенный PowerShell и не требует опроса. По умолчанию: `1`
state строка	При проверке запущенного процесса `present`, выполнение заблокируется до существования процесса или достижения таймаута. `absent`, выполнение заблокируется до исчезновения процесса или достижения таймаута. При ожидании `present`, модуль вернёт changed только если процесс отсутствовал при начальной проверке, но появился в последующих. Если во время ожидания `absent`, запускаются новые процессы, соответствующие заданному шаблону, эти новые процессы не будут включены в действие. Варианты: `"absent"` `"present"` ← (по умолчанию)
timeout целое число	Максимальное время ожидания запуска или остановки процесса в секундах перед ошибкой. По умолчанию: `300`

См. также

ansible.builtin.wait_for: Ожидание условия перед продолжением.
ansible.windows.win_wait_for: Ожидание условия перед продолжением.

Примеры

- name: Wait 300 seconds for all Oracle VirtualBox processes to stop. (VBoxHeadless, VirtualBox, VBoxSVC)
  community.windows.win_wait_for_process:
    process_name_pattern: 'v(irtual)?box(headless|svc)?'
    state: absent
    timeout: 500

- name: Wait 300 seconds for 3 instances of cmd to start, waiting 5 seconds between each check
  community.windows.win_wait_for_process:
    process_name_exact: cmd
    state: present
    timeout: 500
    sleep: 5
    process_min_count: 3

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
elapsed float	Прошедшие секунды между началом опроса и окончанием модуля. Возвращается: всегда Пример: `3.14159265`
matched_processes complex	Список сопоставленных процессов (остановленных или запущенных). Возвращается: всегда
name string	Имя сопоставленного процесса. Возвращается: всегда Пример: `"svchost"`
owner string	Владелец сопоставленного процесса. Возвращается: при поддержке PowerShell Пример: `"NT AUTHORITY\\SYSTEM"`
pid integer	Идентификатор процесса (PID) сопоставленного процесса. Возвращается: всегда Пример: `7908`

Авторы

Charles Crossan (@crossan007)

Ссылки на коллекцию

© 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/community/windows/win_wait_for_process_module.html