summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/expandvars.yml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ansible/plugins/filter/expandvars.yml')
-rw-r--r--lib/ansible/plugins/filter/expandvars.yml21
1 files changed, 21 insertions, 0 deletions
diff --git a/lib/ansible/plugins/filter/expandvars.yml b/lib/ansible/plugins/filter/expandvars.yml
new file mode 100644
index 0000000..02c201e
--- /dev/null
+++ b/lib/ansible/plugins/filter/expandvars.yml
@@ -0,0 +1,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