ansible.builtin.quote filter – shell quoting
Note
This filter plugin is part of ansible-core
and included in all Ansible
installations. In most cases, you can use the short
plugin name
quote
even without specifying the collections:
keyword.
However, we recommend you use the FQCN for easy linking to the
plugin documentation and to avoid conflicting with other collections that may have
the same filter plugin name.
New in ansible-base 2.10
Synopsis
Quote a string to safely use as in a POSIX shell.
Input
This describes the input of the filter, the value before | ansible.builtin.quote
.
Parameter |
Comments |
---|---|
String to quote. |
Notes
Note
This is a passthrough to Python’s
shlex.quote
.
Examples
- name: Run a shell command
shell: echo {{ string_value | quote }}
Return Value
Key |
Description |
---|---|
Quoted string. Returned: success |
Hint
Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.