Note
This module is part of ansible-core
and included in all Ansible installations. In most cases, you can use the short module name pause
even without specifying the collections:
keyword. However, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name.
New in version 0.8: of ansible.builtin
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
.serial
playbook parameter (as in rolling updates) you are only prompted once for the current group of hosts.Note
This module has a corresponding action plugin.
Parameter | Choices/Defaults | Comments |
---|---|---|
echo boolean added in 2.5 of ansible.builtin |
| Controls whether or not keyboard input is shown when typing. Has no effect if 'seconds' or 'minutes' is set. |
minutes string | A positive number of minutes to pause for. | |
prompt string | Optional text to use for the prompt message. | |
seconds string | A positive number of seconds to pause for. |
Note
- name: Pause for 5 minutes to build app cache pause: minutes: 5 - name: Pause until you can verify updates to an application were successful pause: - name: A helpful reminder of what to look out for post-update pause: prompt: "Make sure org.foo.FooOverload exception is not present" - name: Pause to get some sensitive input pause: prompt: "Enter a secret" echo: no
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
delta string | always | Time paused in seconds Sample: 2 |
echo boolean | always | Value of echo setting Sample: True |
start string | always | Time when started pausing Sample: 2017-02-23 14:35:07.298862 |
stdout string | always | Output of pause module Sample: Paused for 0.04 minutes |
stop string | always | Time when ended pausing Sample: 2017-02-23 14:35:09.552594 |
user_input string | if no waiting time set | User input from interactive console Sample: Example user input |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/builtin/pause_module.html