ansible.windows.quote filter – Quotes argument(s) for various Windows shells
Note
This filter plugin is part of the ansible.windows collection (version 2.5.0).
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install ansible.windows.
To use it in a playbook, specify: ansible.windows.quote.
Synopsis
Quotes argument(s) for the various Windows command line shells.
Defaults to escaping arguments based on the Win32 C argv parsing rules that ansible.windows.win_command uses.
Using shell=’cmd’ or shell=’powershell’ can be set to escape arguments for those respective shells.
Each value is escaped in a way to ensure the process gets the literal argument passed in and meta chars escaped.
Input
This describes the input of the filter, the value before | ansible.windows.quote.
Parameter |
Comments |
|---|---|
The string, list, or dict of values to quote. A string or list of strings will be quoted. When using a dict as the input, the final form will be in |
Keyword parameters
This describes keyword parameters of the filter. These are the values key1=value1, key2=value2 and so on in the following
example: input | ansible.windows.quote(key1=value1, key2=value2, ...)
Parameter |
Comments |
|---|---|
The shell to quote the arguments for. By default no shell is used and the arguments are quoted with the Win32 C quoting rules. Choices:
|
See Also
See also
- ansible.windows.win_command
Executes a command on a remote Windows node.
- ansible.windows.win_shell
Execute shell commands on target hosts.
Examples
- name: Escape an argument for win_command
ansible.windows.win_command:
cmd: my.exe {{ argument1 | ansible.windows.quote }}
- name: Escape an argument for PowerShell
ansible.windows.win_shell: |
$var = {{ argument1 | ansible.windows.quote(shell='powershell') }}
Write-Host $var
Return Value
Key |
Description |
|---|---|
The quoted input value(s) as a single space delimited string. Returned: success |