summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/test/failure.yml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/plugins/test/failure.yml')
-rw-r--r--lib/ansible/plugins/test/failure.yml23
1 files changed, 23 insertions, 0 deletions
diff --git a/lib/ansible/plugins/test/failure.yml b/lib/ansible/plugins/test/failure.yml
new file mode 100644
index 0000000..b8a9b3e
--- /dev/null
+++ b/lib/ansible/plugins/test/failure.yml
@@ -0,0 +1,23 @@
+DOCUMENTATION:
+ name: failed
+ author: Ansible Core
+ version_added: "1.9"
+ short_description: did the task fail
+ aliases: [failure]
+ description:
+ - Tests if task finished in failure, opposite of C(succeeded).
+ - This test checks for the existance of a C(failed) key in the input dictionary and that it is C(True) if present.
+ - Tasks that get skipped or not executed due to other failures (syntax, templating, unreachable host, etc) do not return a 'failed' status.
+ options:
+ _input:
+ description: registered result from an Ansible task
+ type: dictionary
+ required: True
+EXAMPLES: |
+ # test 'status' to know how to respond
+ {{ taskresults is failed }}
+
+RETURN:
+ _value:
+ description: Returns C(True) if the task was failed, C(False) otherwise.
+ type: boolean