ansible/docsite/rst/modules/pause.rst
2012-10-08 07:44:38 -04:00

1.8 KiB

pause

0.8

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.

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

        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