ansible.builtin.expanduser filter – Returns a path with ~
translation.
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
expanduser
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.
Synopsis
Translates
~
in a path to the proper user’s home directory.
Input
This describes the input of the filter, the value before | ansible.builtin.expanduser
.
Parameter |
Comments |
---|---|
A string that contains a path. |
Examples
# To get '/home/myuser/stuff.txt' from '~/stuff.txt'.
{{ mypath | expanduser }}
Return Value
Key |
Description |
---|---|
The translated path. Returned: success |