summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/mandatory.yml
blob: 5addf15986a474343a1470c496681f74e5dceacf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
DOCUMENTATION:
  name: mandatory
  version_added: "historical"
  short_description: make a variable's existance mandatory
  description:
    - Depending on context undefined variables can be ignored or skipped, this ensures they force an error.
  positional: _input
  options:
    _input:
      description: Mandatory expression.
      type: raw
      required: true
EXAMPLES: |

    # results in a Filter Error
    {{ notdefined | mandatory }}

RETURN:
  _value:
    description: The input if defined, otherwise an error.
    type: raw