ansible.builtin.expandvars filter – expand environment variables

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 expandvars. However, we recommend you use the Fully Qualified Collection Name (FQCN) ansible.builtin.expandvars for easy linking to the plugin documentation and to avoid conflicting with other collections that may have the same filter plugin name.

Synopsis

  • Will do a shell-like substitution of environment variables on the provided input.

Input

This describes the input of the filter, the value before | ansible.builtin.expandvars.

Parameter

Comments

Input

string / required

A string that contains environment variables.

Examples

# To get '/home/myuser/stuff.txt' from '$HOME/stuff.txt'
{{ mypath | expandvars }}

Return Value

Key

Description

Return value

string

The string with translated environment variable values.

Returned: success

Authors

  • ansible core team

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.