habsi/ansible
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

env: update examples for setting default values to variable (#83370)

Browse Source
This commit is contained in:
krescent
2024-07-21 23:12:55 +08:00
committed by GitHub
parent f261a6142f
commit 46ff7594a4
1 changed files with 8 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
lib/ansible/plugins/lookup/env.py
View File

@ -30,22 +30,21 @@ EXAMPLES = """
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=''.
- name: Before 2.13, how to set default value if the variable is not defined
ansible.builtin.debug:
msg: "{{ lookup('ansible.builtin.env', 'USR')|default('nobody', True) }} is the user."
msg: "Hello {{ lookup('ansible.builtin.env', 'UNDEFINED_VARIABLE') | default('World', True) }}"
- name: Example how to set default value if the variable is not defined, ignores USR=''
- name: Example how to set default value if the variable is not defined
ansible.builtin.debug:
msg: "{{ lookup('ansible.builtin.env', 'USR', default='nobody') }} is the user."
msg: "Hello {{ lookup('ansible.builtin.env', 'UNDEFINED_VARIABLE', default='World') }}"
- name: Set default value to Undefined, if the variable is not defined
- name: Fail if the variable is not defined by setting default value to 'Undefined'
ansible.builtin.debug:
msg: "{{ lookup('ansible.builtin.env', 'USR', default=Undefined) }} is the user."
msg: "Hello {{ lookup('ansible.builtin.env', 'UNDEFINED_VARIABLE', default=Undefined) }}"
- name: Set default value to undef(), if the variable is not defined
- name: Fail if the variable is not defined by setting default value to 'undef()'
ansible.builtin.debug:
msg: "{{ lookup('ansible.builtin.env', 'USR', default=undef()) }} is the user."
msg: "Hello {{ lookup('ansible.builtin.env', 'UNDEFINED_VARIABLE', default=undef()) }}"
"""
RETURN = """