New in version 2.3.
timeout
seconds.connect_timeout
.sleep
seconds.Parameter | Choices/Defaults | Comments |
---|---|---|
connect_timeout | Default: 5 | Maximum number of seconds to wait for a connection to happen before closing and retrying. |
delay | Default: 0 | Number of seconds to wait before starting to poll. |
sleep | Default: 1 | Number of seconds to sleep between checks. |
timeout | Default: 600 | Maximum number of seconds to wait for. |
Note
- 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:
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
elapsed int | always | The number of seconds that elapsed waiting for the connection to appear. Sample: 23 |
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
This module is flagged as core which means that it is maintained by the Ansible Core Team. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Core Team, see here.
For more information about Red Hat’s support of this module, please refer to this Knowledge Base article
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/wait_for_connection_module.html