summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/test/skipped.yml
blob: 808f06704bb9ea075312a8b24ed193d1820dd18a (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: skipped
  author: Ansible Core
  version_added: "1.9"
  short_description: Was task skipped
  aliases: [skip]
  description:
    - Tests if task was skipped
    - This test checks for the existence of a C(skipped) key in the input dictionary and that it is V(True) 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 skipped }}

RETURN:
  _value:
    description: Returns V(True) if the task was skipped, V(False) otherwise.
    type: boolean