Специальные переменные
Магические
Эти переменные не могут быть заданы пользователем напрямую; Ansible всегда будет перезаписывать их, чтобы отразить внутреннее состояние.
- ansible_check_mode
- Булево значение, указывающее, находимся ли мы в режиме проверки.
- ansible_dependent_role_names
- Имена ролей, в настоящее время импортированных в текущий этап как зависимости других этапов.
- ansible_diff_mode
- Булево значение, указывающее, находимся ли мы в режиме сравнения.
- ansible_forks
- Целое число, отражающее максимальное количество вилок, доступных для этого запуска.
- ansible_inventory_sources
- Список источников, используемых в качестве инвентаризации.
- ansible_limit
- Содержимое параметра
--limitкомандной строки для текущего выполнения Ansible. - ansible_loop
- Словарь/отображение, содержащий расширенную информацию о цикле, когда он включен с помощью
loop_control.extended. - ansible_loop_var
- Имя значения, предоставленного
loop_control.loop_var. Добавлен в2.8. - ansible_play_batch
- Список активных хостов в текущем этапе, ограниченный последовательностью, также известный как «пакет». Отказанные/недоступные хосты не считаются «активными».
- ansible_play_hosts
- То же самое, что и ansible_play_batch.
- ansible_play_hosts_all
- Список всех хостов, которые были целью этапа.
- ansible_play_role_names
- Имена ролей, в настоящее время импортированных в текущий этап. Этот список не содержит имена ролей, которые неявно включаются через зависимости.
- ansible_playbook_python
- Путь к интерпретатору Python, используемому Ansible на контроллере.
- ansible_role_names
- Имена ролей, в настоящее время импортированных в текущий этап, или роли, на которые ссылаются как зависимости импортированных в текущий этап ролей.
- ansible_run_tags
- Содержимое параметра
--tagsкомандной строки, который определяет, какие теги будут включены для текущего запуска. - ansible_search_path
- Текущий путь поиска для плагинов действий и поисков, т. е. место, где мы ищем относительные пути, когда вы делаете
template: src=myfile - ansible_skip_tags
- Содержимое параметра
--skip_tagsкомандной строки, который определяет, какие теги будут пропущены для текущего запуска. - ansible_verbosity
- Текущая настройка уровня подробности Ansible.
- ansible_version
- Словарь/отображение, содержащее информацию о текущей рабочей версии ansible, у него следующие ключи: full, major, minor, revision и string.
- group_names
- Список групп, к которым принадлежит текущий хост.
- groups
- Словарь/отображение со всеми группами в инвентаризации, и каждая группа содержит список хостов, которые ей принадлежат.
- hostvars
- Словарь/отображение со всеми хостами в инвентаризации и переменными, присвоенными им.
- inventory_hostname
- Имя инвентаризации для текущего хоста, по которому итерируется этап.
- inventory_hostname_short
- Сокращенная версия
inventory_hostname - inventory_dir
- Директория источника инвентаризации, в которой
inventory_hostnameбыл первоначально определен. - inventory_file
- Имя файла источника инвентаризации, в котором
inventory_hostnameбыл первоначально определен. - omit
- Специальная переменная, которая позволяет вам «пропустить» параметр в задаче, т. е.
- user: name=bob home={{ bobs_home|default(omit) }} - play_hosts
- Устарело, то же самое, что и ansible_play_batch.
- ansible_play_name
- Имя текущего выполняемого этапа. Добавлен в
2.8. - playbook_dir
- Путь к каталогу плейбука, который был передан команде
ansible-playbook. - role_name
- Имя текущей выполняемой роли.
- role_names
- Устарело, то же самое, что и ansible_play_role_names.
- role_path
- Путь к каталогу текущей выполняемой роли.
Факты
Это переменные, которые содержат информацию, относящуюся к текущему хосту (inventory_hostname). Они доступны только при их предварительном сборе.
- ansible_facts
- Содержит любые собранные или кэшированные факты для
inventory_hostnameФакты обычно собираются модулем setup автоматически в этапе, но любые модули могут возвращать факты. - ansible_local
- Содержит любые собранные или кэшированные «локальные факты» для
inventory_hostname. Доступные ключи зависят от созданных пользовательских фактов. Дополнительные сведения см. в модуле setup.
Переменные подключения
Переменные подключения обычно используются для настройки особенностей выполнения действий на целевом хосте. Большинство из них соответствуют плагинам подключения, но не все из них специфичны для них; обычно участвуют и другие плагины, такие как shell, terminal и become. Описываются только общие, поскольку каждый плагин подключения/become/shell и т. д. может определять собственные переопределения и специфические переменные. См. Управление поведением Ansible: правила приоритета для того, как переменные подключения взаимодействуют с параметрами конфигурации, командными параметрами и ключевыми словами плейбука.
- ansible_become_user
- Пользователь, которым Ansible становится после использования повышения привилегий. Он должен быть доступен для «пользователя входа».
- ansible_connection
- Плагин подключения, фактически используемый для задачи на целевом хосте.
- ansible_host
- IP/имя целевого хоста, которое нужно использовать вместо
inventory_hostname. - ansible_python_interpreter
- Путь к исполняемому файлу Python, который Ansible должен использовать на целевом хосте.
- ansible_user
- Пользователь, под которым Ansible «входит в систему».
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/reference_appendices/special_variables.html