Documentation

pause - Pause playbook execution

Synopsis

  • 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 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 ctrl+c and then c. To abort a playbook: press ctrl+c and then a.
  • The pause module integrates into async/parallelized playbooks without any special considerations (see also: Rolling Updates). When using pauses with the serial playbook parameter (as in rolling updates) you are only prompted once for the current group of hosts.

Options

parameter required default choices comments
minutes
no
A positive number of minutes to pause for.
prompt
no
Optional text to use for the prompt message.
seconds
no
A positive number of seconds to pause for.

Examples

# Pause for 5 minutes to build app cache.
- pause:
    minutes: 5

# Pause until you can verify updates to an application were successful.
- pause:

# A helpful reminder of what to look out for post-update.
- pause:
    prompt: "Make sure org.foo.FooOverload exception is not present"

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
start Time when started pausing always string 2017-02-23 14:35:07.298862
user_input User input from interactive console if no waiting time set string Example user input
delta Time paused in seconds always string 2
stop Time when ended pausing always string 2017-02-23 14:35:09.552594
stdout Output of pause module always string Paused for 0.04 minutes


Notes

Note

  • Starting in 2.2, if you specify 0 or negative for minutes or seconds, it will wait for 1 second, previously it would wait indefinitely.

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Support

This module is maintained by those with core commit privileges

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.