summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/test/finished.yml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/plugins/test/finished.yml')
-rw-r--r--lib/ansible/plugins/test/finished.yml21
1 files changed, 21 insertions, 0 deletions
diff --git a/lib/ansible/plugins/test/finished.yml b/lib/ansible/plugins/test/finished.yml
new file mode 100644
index 0000000..b01b132
--- /dev/null
+++ b/lib/ansible/plugins/test/finished.yml
@@ -0,0 +1,21 @@
+DOCUMENTATION:
+ name: finished
+ author: Ansible Core
+ version_added: "1.9"
+ short_description: Did async task finish
+ description:
+ - Used to test if an async task has finished, it will aslo work with normal tasks but will issue a warning.
+ - This test checks for the existance of a C(finished) key in the input dictionary and that it is C(1) if present
+ options:
+ _input:
+ description: registered result from an Ansible task
+ type: dictionary
+ required: True
+EXAMPLES: |
+ # test 'status' to know how to respond
+ {{ (asynctaskpoll is finished}}
+
+RETURN:
+ _value:
+ description: Returns C(True) if the aysnc task has finished, C(False) otherwise.
+ type: boolean