Модуль ansible.builtin.wait_for_connection — ожидание достижения доступности удалённой системы

Примечание

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

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

Описание

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

Примечание

Этот модуль имеет соответствующий плагин действий.

Параметры

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

Атрибуты

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

См. также

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
    ansible.builtin.wait_for_connection:
      timeout: 900

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

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

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

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

Авторы

Dag Wieers (@dagwieers)

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

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