Note
This lookup plugin is part of ansible-core
and included in all Ansible installations. In most cases, you can use the short plugin name env
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 lookup plugin name.
New in version 0.9: of ansible.builtin
Parameter | Choices/Defaults | Configuration | Comments |
---|---|---|---|
_terms string / required | Environment variable or list of them to lookup the values for. |
Note
default
filter requires second parameter to be set to True
in order to set a default value in the case the variable is not defined (see examples).- name: Basic usage debug: msg: "'{{ lookup('env', 'HOME') }}' is the HOME environment variable." - name: Example how to set default value if the variable is not defined debug: msg: "'{{ lookup('env', 'USR') | default('nobody', True) }}' is the user."
Common return values are documented here, the following are the fields unique to this lookup:
Key | Returned | Description |
---|---|---|
_list list / elements=string | success | Values from the environment variables. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/builtin/env_lookup.html