wait_for_connection: Update the docs to implementation (#22400)

* Update the docs to conform to implementation

Somehow the docs were still mentioning a default timeout of 300 seconds.
Whereas the implementation defaults to 600 seconds.

* Improve examples even more
This commit is contained in:
Dag Wieers 2017-03-09 15:00:36 +01:00 committed by John R Barker
parent c57729944b
commit 654e95ea49

View file

@ -48,18 +48,18 @@ options:
timeout: timeout:
description: description:
- Maximum number of seconds to wait for. - Maximum number of seconds to wait for.
default: 300 default: 600
author: "Dag Wieers (@dagwieers)" author: "Dag Wieers (@dagwieers)"
''' '''
EXAMPLES = r''' EXAMPLES = r'''
- name: Wait 300 seconds for target connection to become reachable/usable - name: Wait 600 seconds for target connection to become reachable/usable
wait_for_connection: wait_for_connection:
- name: Wait 600 seconds, but only start checking after 60 seconds - name: Wait 300 seconds, but only start checking after 60 seconds
wait_for_connection: wait_for_connection:
delay: 60 delay: 60
timeout: 600 timeout: 300
# Wake desktops, wait for them to become ready and continue playbook # Wake desktops, wait for them to become ready and continue playbook
- hosts: all - hosts: all
@ -89,11 +89,12 @@ EXAMPLES = r'''
customization: customization:
hostname: '{{ vm_shortname }}' hostname: '{{ vm_shortname }}'
runonce: runonce:
- powershell.exe -ExecutionPolicy Unrestricted -File C:\Windows\Temp\ConfigureRemotingForAnsible.ps1 -CertValidityDays 3650 -ForceNewSSLCert - powershell.exe -ExecutionPolicy Unrestricted -File C:\Windows\Temp\ConfigureRemotingForAnsible.ps1 -ForceNewSSLCert -EnableCredSSP
delegate_to: localhost delegate_to: localhost
- name: Wait for system to become reachable over WinRM - name: Wait for system to become reachable over WinRM
wait_for_connection: wait_for_connection:
timeout: 900
- name: Gather facts for first time - name: Gather facts for first time
setup: setup: