summaryrefslogtreecommitdiff
path: root/lib/ansible/plugins/test/unreachable.yml
blob: 52e2730c90f78f991e16ac182c26c53a9ac99d7d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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 V(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 V(True) if the task flagged the host as unreachable, V(False) otherwise.
    type: boolean