Модуль ansible.builtin.wait_for_connection — Ожидает, пока удалённая система станет доступной/работоспособной

Примечание

Этот модуль входит в состав ansible-core и включён во все установки Ansible. В большинстве случаев можно использовать короткое имя модуля wait_for_connection, не указывая ключевое слово collections. Тем не менее мы рекомендуем использовать полное имя коллекции (FQCN) ansible.builtin.wait_for_connection, чтобы упростить переход к документации модуля и избежать конфликтов с другими коллекциями, в которых может быть модуль с таким же именем.

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

Краткое описание

Ожидает в общей сложности timeout секунд.
Повторяет попытку подключения через транспорт после тайм-аута connect_timeout.
Проверяет подключение через транспорт каждые sleep секунд.
Этот модуль использует внутренний транспорт Ansible (и конфигурацию), а также модули ansible.builtin.ping/ansible.windows.win_ping, чтобы гарантировать корректную работу от начала до конца.
Этот модуль также поддерживается для целевых систем Windows.

Примечание

Для этого модуля также предусмотрен соответствующий модуль действий.

Параметры

Параметр	Комментарии
connect_timeout integer	Максимальное количество секунд ожидания установления подключения до его закрытия и повторной попытки. По умолчанию: `5`
delay integer	Количество секунд ожидания перед началом опроса. По умолчанию: `0`
sleep integer	Количество секунд ожидания между проверками. По умолчанию: `1`
timeout integer	Максимальное время ожидания в секундах. По умолчанию: `600`

Атрибуты

Атрибут	Поддержка	Описание
action	Поддержка: full	Указывает, что для этого модуля предусмотрен соответствующий модуль действий, поэтому некоторые параметры могут выполняться на контроллере
async	Поддержка: none	Поддерживает использование с ключевым словом `async`
bypass_host_loop	Поддержка: none	Принудительно запускает «глобальную» задачу, которая выполняется не для каждого узла; при этом обходятся шаблонизация для каждого узла, параметры serial и throttle, а также другие особенности циклов Условия будут работать так, как если бы использовался `run_once`; переменные будут взяты с первого доступного узла Это действие не будет нормально работать вне стратегий с синхронным выполнением
check_mode	Поддержка: none	Может выполняться в режиме check_mode и возвращать прогноз изменения статуса, не изменяя целевую систему. Если режим не поддерживается, действие будет пропущено.
diff_mode	Поддержка: none	В режиме diff возвращает подробные сведения об изменениях (или о возможных изменениях в режиме check_mode)
platform	Платформы: all При наличии модуля подключения	Целевые ОС/семейства ОС, для которых можно выполнять операции

См. также

ansible.builtin.wait_for: Ожидает выполнения условия, прежде чем продолжить.
ansible.windows.win_wait_for: Ожидает выполнения условия, прежде чем продолжить.
community.windows.win_wait_for_process: Ожидает появления или завершения процесса, прежде чем продолжить.

Примеры

- name: Wait 600 seconds for target connection to become reachable/usable
  ansible.builtin.wait_for_connection:

- name: Wait 300 seconds, but only start checking after 60 seconds
  ansible.builtin.wait_for_connection:
    delay: 60
    timeout: 300

# Wake desktops, wait for them to become ready and continue playbook
- hosts: all
  gather_facts: no
  tasks:
  - name: Send magic Wake-On-Lan packet to turn on individual systems
    community.general.wakeonlan:
      mac: '{{ mac }}'
      broadcast: 192.168.0.255
    delegate_to: localhost

  - name: Wait for system to become reachable
    ansible.builtin.wait_for_connection:

  - name: Gather facts for first time
    ansible.builtin.setup:

# Build a new VM, wait for it to become ready and continue playbook
- hosts: all
  gather_facts: no
  tasks:
  - name: Clone new VM, if missing
    community.vmware.vmware_guest:
      hostname: '{{ vcenter_ipaddress }}'
      name: '{{ inventory_hostname_short }}'
      template: Windows 2012R2
      customization:
        hostname: '{{ vm_shortname }}'
        runonce:
        - cmd.exe /c winrm.cmd quickconfig -quiet -force
    delegate_to: localhost

  - name: Wait for system to become reachable over WinRM, polling every 10 seconds
    ansible.builtin.wait_for_connection:
      timeout: 900
      sleep: 10

  - name: Gather facts for first time
    ansible.builtin.setup:

Возвращаемые значения

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

Ключ	Описание
elapsed float	Количество секунд, прошедших в ожидании подключения. Возвращается: всегда Пример: `23.1`

Авторы

Dag Wieers (@dagwieers)

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

© 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/builtin/wait_for_connection_module.html