summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/test/successful.yml
blob: 4626f9fe53a31b4bd9eca1a2c29e07d6d9ee510f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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