diff options
Diffstat (limited to 'lib/ansible/plugins/lookup/env.py')
-rw-r--r-- | lib/ansible/plugins/lookup/env.py | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/lib/ansible/plugins/lookup/env.py b/lib/ansible/plugins/lookup/env.py new file mode 100644 index 0000000..3c37b90 --- /dev/null +++ b/lib/ansible/plugins/lookup/env.py @@ -0,0 +1,79 @@ +# (c) 2012, Jan-Piet Mens <jpmens(at)gmail.com> +# (c) 2017 Ansible Project +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) +from __future__ import (absolute_import, division, print_function) +__metaclass__ = type + +DOCUMENTATION = """ + name: env + author: Jan-Piet Mens (@jpmens) <jpmens(at)gmail.com> + version_added: "0.9" + short_description: Read the value of environment variables + description: + - Allows you to query the environment variables available on the + controller when you invoked Ansible. + options: + _terms: + description: + - Environment variable or list of them to lookup the values for. + required: True + default: + description: What return when the variable is undefined + type: raw + default: '' + version_added: '2.13' + notes: + - You can pass the C(Undefined) object as C(default) to force an undefined error +""" + +EXAMPLES = """ +- name: Basic usage + ansible.builtin.debug: + msg: "'{{ lookup('ansible.builtin.env', 'HOME') }}' is the HOME environment variable." + +- name: Before 2.13, how to set default value if the variable is not defined. + This cannot distinguish between USR undefined and USR=''. + ansible.builtin.debug: + msg: "{{ lookup('ansible.builtin.env', 'USR')|default('nobody', True) }} is the user." + +- name: Example how to set default value if the variable is not defined, ignores USR='' + ansible.builtin.debug: + msg: "{{ lookup('ansible.builtin.env', 'USR', default='nobody') }} is the user." + +- name: Set default value to Undefined, if the variable is not defined + ansible.builtin.debug: + msg: "{{ lookup('ansible.builtin.env', 'USR', default=Undefined) }} is the user." + +- name: Set default value to undef(), if the variable is not defined + ansible.builtin.debug: + msg: "{{ lookup('ansible.builtin.env', 'USR', default=undef()) }} is the user." +""" + +RETURN = """ + _list: + description: + - Values from the environment variables. + type: list +""" + +from jinja2.runtime import Undefined + +from ansible.errors import AnsibleUndefinedVariable +from ansible.plugins.lookup import LookupBase +from ansible.utils import py3compat + + +class LookupModule(LookupBase): + def run(self, terms, variables, **kwargs): + + self.set_options(var_options=variables, direct=kwargs) + + ret = [] + d = self.get_option('default') + for term in terms: + var = term.split()[0] + val = py3compat.environ.get(var, d) + if isinstance(val, Undefined): + raise AnsibleUndefinedVariable('The "env" lookup, found an undefined variable: %s' % var) + ret.append(val) + return ret |