ansible.builtin.env – Чтение значения переменных среды
Примечание
Этот модуль является частью ansible-base и включён во все установки Ansible. В большинстве случаев вы можете использовать короткое имя модуля env, даже не указывая ключевое слово collections:. Несмотря на это, мы рекомендуем использовать FQCN для лёгкой ссылки на документацию модуля и для предотвращения конфликтов с другими коллекциями, которые могут иметь то же имя модуля.
Добавлена в версии 0.9: of 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–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
