From c01354d12d646dc3f8ebb5d02ba21b679a85803b Mon Sep 17 00:00:00 2001 From: Jan-Piet Mens Date: Tue, 2 Oct 2012 09:56:55 +0200 Subject: [PATCH] attempt at DOCUMENTATION for async_status --- async_status | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/async_status b/async_status index 5eeb09c0b59..dd0e58c6c79 100755 --- a/async_status +++ b/async_status @@ -19,6 +19,34 @@ # along with Ansible. If not, see . # +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 traceback