Merge pull request #1190 from jpmens/asy1
attempt at DOCUMENTATION for async_status
This commit is contained in:
commit
7779da264d
1 changed files with 28 additions and 0 deletions
|
@ -19,6 +19,34 @@
|
||||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||||
#
|
#
|
||||||
|
|
||||||
|
DOCUMENTATION = '''
|
||||||
|
---
|
||||||
|
module: async_status
|
||||||
|
short_description: Obtain status of asynchronous task
|
||||||
|
description:
|
||||||
|
- "This module gets the status of an asynchronous task. See:
|
||||||
|
U(http://ansible.cc/docs/playbooks2.html#asynchronous-actions-and-polling)"
|
||||||
|
version_added: "0.5"
|
||||||
|
options:
|
||||||
|
jid:
|
||||||
|
description:
|
||||||
|
- Job or task identifier
|
||||||
|
required: true
|
||||||
|
default: null
|
||||||
|
aliases: []
|
||||||
|
mode:
|
||||||
|
description:
|
||||||
|
- if C(status), obtain the status; if C(cleanup), clean up the async job cache
|
||||||
|
located in C(~/.ansible_async/) for the specified job I(jid).
|
||||||
|
required: false
|
||||||
|
choices: [ "status", "cleanup" ]
|
||||||
|
default: "status"
|
||||||
|
notes:
|
||||||
|
- See U(http://ansible.cc/docs/playbooks2.html#asynchronous-actions-and-polling)
|
||||||
|
requirements: []
|
||||||
|
author: Michael DeHaan
|
||||||
|
'''
|
||||||
|
|
||||||
import datetime
|
import datetime
|
||||||
import traceback
|
import traceback
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue