ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-10-07 17:04:02 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

better wait_for docs on timeout (#28344)

Browse source 
* better waitfor docs on timeout

shippable errors unrelated to docs
This commit is contained in:
Brian Coca 2017-08-29 14:33:12 -04:00 • committed by GitHub
commit d740dfdcb6
2 changed files with 18 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

15
lib/ansible/modules/utilities/logic/pause.py
View file

@ -15,14 +15,13 @@ DOCUMENTATION = '''
module: pause
short_description: Pause playbook execution
description:
- Pauses playbook execution for a set amount of time, or until a prompt is acknowledged. All parameters are optional. The default behavior is to
pause with a prompt.
- >
You can use C(ctrl+c) if you wish to advance a pause earlier than it is set to expire or if you need to abort a playbook run entirely. To continue early:
press C(ctrl+c) and then C(c). To abort a playbook: press C(ctrl+c) and then C(a).
- >
The pause module integrates into async/parallelized playbooks without any special considerations (see also: Rolling Updates). When using pauses with
the C(serial) playbook parameter (as in rolling updates) you are only prompted once for the current group of hosts.
- Pauses playbook execution for a set amount of time, or until a prompt is acknowledged.
All parameters are optional. The default behavior is to pause with a prompt.
- To pause/wait/sleep per host, use the `wait_for` module.
- You can use C(ctrl+c) if you wish to advance a pause earlier than it is set to expire or if you need to abort a playbook run entirely.
To continue early press C(ctrl+c) and then C(c). To abort a playbook press C(ctrl+c) and then C(a).
- The pause module integrates into async/parallelized playbooks without any special considerations (see Rolling Updates).
When using pauses with the C(serial) playbook parameter (as in rolling updates) you are only prompted once for the current group of hosts.
- This module is also supported for Windows targets.
version_added: "0.8"
options: