summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/test/success.yml
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:04:21 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:04:21 +0000
commit8a754e0858d922e955e71b253c139e071ecec432 (patch)
tree527d16e74bfd1840c85efd675fdecad056c54107 /lib/ansible/plugins/test/success.yml
parentInitial commit. (diff)
downloadansible-core-8a754e0858d922e955e71b253c139e071ecec432.tar.xz
ansible-core-8a754e0858d922e955e71b253c139e071ecec432.zip
Adding upstream version 2.14.3.upstream/2.14.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'lib/ansible/plugins/test/success.yml')
-rw-r--r--lib/ansible/plugins/test/success.yml22
1 files changed, 22 insertions, 0 deletions
diff --git a/lib/ansible/plugins/test/success.yml b/lib/ansible/plugins/test/success.yml
new file mode 100644
index 0000000..4626f9f
--- /dev/null
+++ b/lib/ansible/plugins/test/success.yml
@@ -0,0 +1,22 @@
+DOCUMENTATION:
+ name: success
+ author: Ansible Core
+ version_added: "1.9"
+ short_description: check task success
+ aliases: [succeeded, successful]
+ description:
+ - Tests if task finished successfully, opposite of C(failed).
+ - This test checks for the existance of a C(failed) key in the input dictionary and that it is C(False) if present
+ options:
+ _input:
+ description: registered result from an Ansible task
+ type: dictionary
+ required: True
+EXAMPLES: |
+ # test 'status' to know how to respond
+ {{ (taskresults is success }}
+
+RETURN:
+ _value:
+ description: Returns C(True) if the task was successfully completed, C(False) otherwise.
+ type: boolean