mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-06 05:12:45 +00:00
Unified document generator and make to generate JSON and JS files
This commit is contained in:
committed by
Michael DeHaan
parent
85fb83a5db
commit
ee679c0190
52
docs/json/pause.json
Normal file
52
docs/json/pause.json
Normal file
@@ -0,0 +1,52 @@
|
||||
{
|
||||
"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"
|
||||
}
|
||||
Reference in New Issue
Block a user