Spec-Zone.ru › Ansible 2.7

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
-
    Варианты:
  • absent
  • drained
  • present
  • started ←
  • stopped
При проверке порта, 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
вещественное число
всегда
Прошедшие секунды между началом опроса и окончанием модуля. Это включает задержку, если параметр установлен.

Пример:
2.1406487
wait_attempts
целое число
всегда
Количество попыток опроса файла или порта перед завершением модуля.

Пример:
1


Статус

  • Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом 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.7/modules/win_wait_for_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API