Spec-Zone.ru › Ansible 2.8

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
Максимальное время ожидания в секундах.

См. также

См. также

wait_for – Ожидание условия перед продолжением
Официальная документация по модулю wait_for.
win_wait_for_process – Ожидание существования или отсутствия процесса перед продолжением
Официальная документация по модулю win_wait_for_process.

Примеры

- 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 is 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.8/modules/win_wait_for_module.html

Spec-Zone.ru

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