W3cubDocs

/Ansible 2.10

ansible.builtin.env – Read the value of environment variables

Note

This module is part of ansible-base and included in all Ansible installations. In most cases, you can use the short module name env even without specifying the collections: keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name.

New in version 0.9: of ansible.builtin

Synopsis

  • Allows you to query the environment variables available on the controller when you invoked Ansible.

Parameters

Parameter Choices/Defaults Configuration Comments
_terms
string / required
Environment variable or list of them to lookup the values for.

Notes

Note

  • The module returns an empty string if the environment variable is not defined. This makes it impossbile to differentiate between the case the variable is not defined and the case the variable is defined but it contains an empty string.
  • The 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).

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."

Return Values

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.


Authors

  • Jan-Piet Mens (@jpmens) <jpmens(at)gmail.com>

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/builtin/env_lookup.html