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

Примечание

Этот модуль является частью ansible-base и включён во все установки Ansible. В большинстве случаев вы можете использовать короткое имя модуля wait_for_connection даже без указания collections: ключевого слова. Несмотря на это, мы рекомендуем использовать FQCN для лёгкой ссылки на документацию модуля и для избежания конфликтов с другими коллекциями, которые могут иметь то же самое имя модуля.

Новое в версии 2.3: of ansible.builtin

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

Описание

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

Примечание

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

Параметры

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

Примечания

Примечание

Этот модуль также поддерживается для целей Windows.

См. также

ansible.builtin.wait_for: Официальная документация модуля ansible.builtin.wait_for.
ansible.windows.win_wait_for: Официальная документация модуля ansible.windows.win_wait_for.
community.windows.win_wait_for_process: Официальная документация модуля community.windows.win_wait_for_process.

Примеры

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

- name: Wait 300 seconds, but only start checking after 60 seconds
  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
    wakeonlan:
      mac: '{{ mac }}'
      broadcast: 192.168.0.255
    delegate_to: localhost

  - name: Wait for system to become reachable
    wait_for_connection:

  - name: Gather facts for first time
    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
    vmware_guest:
      hostname: '{{ vcenter_ipaddress }}'
      name: '{{ inventory_hostname_short }}'
      template: Windows 2012R2
      customization:
        hostname: '{{ vm_shortname }}'
        runonce:
        - powershell.exe -ExecutionPolicy Unrestricted -File C:\Windows\Temp\ConfigureRemotingForAnsible.ps1 -ForceNewSSLCert -EnableCredSSP
    delegate_to: localhost

  - name: Wait for system to become reachable over WinRM
    wait_for_connection:
      timeout: 900

  - name: Gather facts for first time
    setup:

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

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

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

Авторы

Dag Wieers (@dagwieers)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/wait_for_connection_module.html