summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/test/unreachable.yml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/plugins/test/unreachable.yml')
-rw-r--r--lib/ansible/plugins/test/unreachable.yml21
1 files changed, 21 insertions, 0 deletions
diff --git a/lib/ansible/plugins/test/unreachable.yml b/lib/ansible/plugins/test/unreachable.yml
new file mode 100644
index 0000000..ed6c17e
--- /dev/null
+++ b/lib/ansible/plugins/test/unreachable.yml
@@ -0,0 +1,21 @@
+DOCUMENTATION:
+ name: unreachable
+ author: Ansible Core
+ version_added: "1.9"
+ short_description: Did task end due to the host was unreachable
+ description:
+ - Tests if task was not able to reach the host for execution
+ - This test checks for the existance of a C(unreachable) key in the input dictionary and that it's value is C(True)
+ options:
+ _input:
+ description: registered result from an Ansible task
+ type: dictionary
+ required: True
+EXAMPLES: |
+ # test 'status' to know how to respond
+ {{ (taskresults is unreachable }}
+
+RETURN:
+ _value:
+ description: Returns C(True) if the task flagged the host as unreachable, C(False) otherwise.
+ type: boolean