Commit 022c37ba by John Jarvis

updating docs for wait_for

parent 0e5c49a0
...@@ -56,18 +56,27 @@ options: ...@@ -56,18 +56,27 @@ options:
required: true required: true
state: state:
description: description:
- either C(started), or C(stopped) depending on whether the module should - either C(present), C(started), or C(stopped)
poll for the port being open or closed. - When checking a port C(started) will ensure the port is open, C(stopped) will check that it is closed
choices: [ "started", "stopped" ] - When checking for a file or a search string C(present) will ensure that the file or string is present before continuing
choices: [ "present", "started", "stopped" ]
default: "started" default: "started"
notes: [] notes: []
requirements: [] requirements: []
author: Jeroen Hoekx author: Jeroen Hoekx, John Jarvis
''' '''
EXAMPLES = ''' EXAMPLES = '''
# wait 300 seconds for port 8000 to become open on the host, don't start checking for 10 seconds # wait 300 seconds for port 8000 to become open on the host, don't start checking for 10 seconds
- wait_for: port=8000 delay=10" - wait_for: port=8000 delay=10"
# wait until the file /tmp/foo is present before continuing
- wait_for: path=/tmp/foo state=present
# wait until the string "completed" is in the file /tmp/foo before continuing
- wait_for: path=/tmp/foo search_string=completed state=present
''' '''
def main(): def main():
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment