ansible.builtin.wait_for_connection 模块 – 等待远程系统可访问/可用

注意

此模块是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，即使不指定 collections 关键字，您也可以使用简短的模块名称 wait_for_connection。但是，我们建议您使用完全限定的集合名称 (FQCN) ansible.builtin.wait_for_connection，以便轻松链接到模块文档并避免与可能具有相同模块名称的其他集合冲突。

概要 

等待总共 timeout 秒。
在超时 connect_timeout 后重试传输连接。
每隔 sleep 秒测试一次传输连接。
此模块使用内部 Ansible 传输（和配置）以及 ansible.builtin.ping/ansible.windows.win_ping 模块来保证正确的端到端功能。
此模块也支持 Windows 目标。

注意

此模块具有相应的 action 插件。

参数 

参数	注释
connect_timeout 整数	等待连接建立的最大秒数，超过此时间将关闭并重试。默认值： `5`
delay 整数	开始轮询之前等待的秒数。默认值： `0`
sleep 整数	检查之间休眠的秒数。默认值： `1`
timeout 整数	等待的最大秒数。默认值： `600`

属性 

属性	支持	描述
action	支持：完全支持	指示其具有相应的 action 插件，因此某些选项部分可以在控制器上执行
async	支持：不支持	支持与 `async` 关键字一起使用
bypass_host_loop	支持：不支持	强制执行一个不按主机执行的“全局”任务，这将绕过按主机进行的模板化以及串行、节流和其他循环方面的考虑。条件将按使用 `run_once` 的方式工作，使用的变量将来自第一个可用的主机。此 action 通常无法在锁步策略之外正常工作。
check_mode	支持：不支持	可以在 check_mode 下运行并返回更改状态预测，而无需修改目标，如果不支持，则将跳过该 action。
diff_mode	支持：不支持	在 diff 模式下，将返回有关已更改内容（或可能需要在 check_mode 下更改的内容）的详细信息。
platform	平台：所有只要有连接插件	可以对其进行操作的目标操作系统/系列。

另请参见 

另请参见

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
  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)