ansible.builtin.env – Чтение значения переменных окружения
Примечание
Этот модуль является частью ansible-base и включен во все установки Ansible. В большинстве случаев вы можете использовать короткое имя модуля env, даже не указывая collections: ключевое слово. Тем не менее, мы рекомендуем использовать полное имя класса для удобной ссылки на документацию модуля и для избежания конфликтов с другими коллекциями, которые могут иметь такое же имя модуля.
Новое в версии 0.9: модуля ansible.builtin
Описание
- Позволяет запросить доступные переменные окружения на контроллере во время запуска Ansible.
Параметры
| Параметр | Варианты/Значения по умолчанию | Конфигурация | Комментарии |
|---|---|---|---|
| _terms строка / обязательный | Переменная окружения или список переменных для поиска значений. |
Примечания
Примечание
- Модуль возвращает пустую строку, если переменная окружения не определена. Это затрудняет различие между случаями, когда переменная не определена, и когда она определена, но содержит пустую строку.
- Фильтр
defaultтребует, чтобы второй параметр был установлен вTrue, чтобы установить значение по умолчанию в случае, если переменная не определена (см. примеры).
Примеры
- 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."
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого поиска:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| _list список / элементы=строка | успех | Значения из переменных окружения. |
Авторы
- Jan-Piet Mens (@jpmens) <jpmens(at)gmail.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/env_lookup.html
