cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

added docs to show wait_for default timeout settings

Browse source 
Fixes #400
This commit is contained in:
Brian Coca 2015-04-06 20:41:57 -04:00
parent 4d9ce9cf2c
commit 1d6d3fece7
1 changed files with 7 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
utilities/logic/wait_for.py
View file

@ -38,15 +38,15 @@ DOCUMENTATION = '''
module: wait_for module: wait_for
short_description: Waits for a condition before continuing. short_description: Waits for a condition before continuing.
description: description:
- You can wait for a set amount of time C(timeout), this is the default if nothing is specified.
- Waiting for a port to become available is useful for when services - Waiting for a port to become available is useful for when services
are not immediately available after their init scripts return - are not immediately available after their init scripts return
which is true of certain Java application servers. It is also which is true of certain Java application servers. It is also
useful when starting guests with the M(virt) module and useful when starting guests with the M(virt) module and
needing to pause until they are ready. needing to pause until they are ready.
- This module can also be used to wait for a regex match a string to be present in a file. - This module can also be used to wait for a regex match a string to be present in a file.
- In 1.6 and later, this module can - In 1.6 and later, this module can also be used to wait for a file to be available or
also be used to wait for a file to be available or absent on the absent on the filesystem.
filesystem.
- In 1.8 and later, this module can also be used to wait for active - In 1.8 and later, this module can also be used to wait for active
connections to be closed before continuing, useful if a node connections to be closed before continuing, useful if a node
is being rotated out of a load balancer pool. is being rotated out of a load balancer pool.
@ -57,7 +57,6 @@ options:
- A resolvable hostname or IP address to wait for - A resolvable hostname or IP address to wait for
required: false required: false
default: "127.0.0.1" default: "127.0.0.1"
aliases: []
timeout: timeout:
description: description:
- maximum number of seconds to wait for - maximum number of seconds to wait for