summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/quote.yml
blob: 2d621ed065eb9ab4c5c780f091c450601cecdbad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
DOCUMENTATION:
  name: quote
  version_added: "2.10"
  short_description: shell quoting
  description:
    - Quote a string to safely use as in a POSIX shell.
  notes:
    - This is a passthrough to Python's C(shlex.quote).
  positional: _input
  options:
    _input:
      description: String to quote.
      type: str
      required: true

EXAMPLES: |
  - name: Run a shell command
    shell: echo {{ string_value | quote }}

RETURN:
  _value:
    description: Quoted string.
    type: str