summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/expandvars.yml
blob: 02c201e8f532534562810ab8ac6086b4bbc018e9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
DOCUMENTATION:
  name: expandvars
  author: ansible core team
  version_added: "1.5"
  short_description: expand environment variables
  description:
    - Will do a shell-like substitution of environment variables on the provided input.
  options:
    _input:
      description: A string that contains environment variables.
      type: str
      required: true
EXAMPLES: |

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

RETURN:
  _value:
    description: The string with translated environment variable values.
    type: str