mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
52 lines
No EOL
1.8 KiB
JSON
52 lines
No EOL
1.8 KiB
JSON
{
|
|
"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."
|
|
],
|
|
"module": "pause",
|
|
"examples": [
|
|
{
|
|
"code": "pause minutes=5",
|
|
"description": "Pause for 5 minutes to build app cache."
|
|
},
|
|
{
|
|
"code": "pause",
|
|
"description": "Pause until you can verify updates to an application were successful."
|
|
},
|
|
{
|
|
"code": "pause prompt=Make sure org.foo.FooOverload exception is not present",
|
|
"description": "A helpful reminder of what to look out for post-update."
|
|
}
|
|
],
|
|
"docuri": "pause",
|
|
"author": "Tim Bielawa",
|
|
"filename": "library/pause",
|
|
"version_added": 0.8,
|
|
"short_description": "Pause playbook execution",
|
|
"now_date": "2012-10-09",
|
|
"options": {
|
|
"seconds": {
|
|
"default": null,
|
|
"required": false,
|
|
"description": [
|
|
"Number of minutes to pause for."
|
|
]
|
|
},
|
|
"minutes": {
|
|
"default": null,
|
|
"required": false,
|
|
"description": [
|
|
"Number of minutes to pause for."
|
|
]
|
|
},
|
|
"prompt": {
|
|
"default": null,
|
|
"required": false,
|
|
"description": [
|
|
"Optional text to use for the prompt message."
|
|
]
|
|
}
|
|
},
|
|
"ansible_version": "0.8"
|
|
} |