Специальные переменные

Магические переменные

Эти переменные не могут быть установлены пользователем напрямую; Ansible всегда будет переопределять их, отражая внутреннее состояние.

ansible_check_mode

Булево значение, указывающее, находимся ли мы в режиме проверки.

ansible_config_file

Полный путь к используемому конфигурационному файлу Ansible.

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_index_var

Имя значения, предоставленного loop_control.index_var. Добавлен в 2.9.

ansible_parent_role_names

Когда текущая роль выполняется с помощью действия include_role или import_role, эта переменная содержит список всех родительских ролей, при этом самая последняя роль (т.е. роль, которая включала/импортировала эту роль) является первым элементом в списке. При нескольких включениях этот список указывает последнюю роль (т.е. роль, которая включала эту роль) как первый элемент в списке. Также возможно, что конкретная роль существует в этом списке более одного раза.

Например: Когда роль A включает роль B, внутри роли B, ansible_parent_role_names будет равно ['A']. Если роль B затем включает роль C, список станет ['B', 'A'].

ansible_parent_role_paths

Когда текущая роль выполняется с помощью действия include_role или import_role, эта переменная содержит список всех родительских ролей, при этом самая последняя роль (т.е. роль, которая включала/импортировала эту роль) является первым элементом в списке. Обратитесь к ansible_parent_role_names для порядка элементов в этом списке.

ansible_play_batch

Список активных хостов в текущем этапе выполнения, ограниченный по параметру serial, т.е. «пакет». Неудачные/ недоступные хосты не считаются «активными».

ansible_play_hosts

Список хостов в текущем этапе выполнения, не ограниченный по параметру serial. Неудачные/ недоступные хосты включены в этот список.

ansible_play_hosts_all

Список всех хостов, которые были целевыми для этапа.

ansible_play_role_names

Имена ролей, которые в данный момент импортированы в текущий этап. Этот список не содержит имена ролей, которые неявно включены через зависимости.

ansible_playbook_python

Путь к интерпретатору Python, используемому Ansible на контроллере.

ansible_role_names

Имена ролей, которые в данный момент импортированы в текущий этап или роли, на которые ссылаются как зависимости импортированных в текущий этап ролей.

ansible_role_name

Полное квалифицированное имя роли коллекции в формате namespace.collection.role_name.

ansible_collection_name

Имя коллекции, к которой принадлежит задача, выполняемая в формате namespace.collection.

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

Путь к каталогу playbook, который был передан команде ansible-playbook.

role_name

Имя роли, которая в настоящее время выполняется.

role_names

Устарело, то же, что и ansible_play_role_names.

role_path

Путь к каталогу текущей выполняемой роли.

Факты

Это переменные, которые содержат информацию, относящуюся к текущему хосту (inventory_hostname). Они доступны только в том случае, если собраны предварительно. Смотрите Изучение переменных: факты и магические переменные для получения дополнительной информации.

ansible_facts

Содержит все собранные или кэшированные факты для inventory_hostname Факты обычно собираются модулем setup автоматически в этапе, но любой модуль может возвращать факты.

ansible_local

Содержит любые собранные или кэшированные «локальные факты» для inventory_hostname Доступные ключи зависят от созданных пользовательских фактов. Обратитесь к модулю setup и facts.d или локальные факты для получения более подробной информации.

Переменные подключения

Переменные подключения обычно используются для задания параметров выполнения действий на целевом узле. Большинство из них соответствуют плагинам подключения, но не все специфичны для них; другие плагины, такие как shell, terminal и become, обычно участвуют. Описываются только общие, поскольку каждый плагин подключения/become/shell/и т. д. может определять собственные переопределения и специфические переменные. См. Управление поведением Ansible: правила приоритета, как переменные подключения взаимодействуют с настройками конфигурации, параметрами командной строки и ключами playbook.

ansible_become_user

Пользователь, которым Ansible становится после использования повышения привилегий. Это должно быть доступно пользователю «логина».

ansible_connection

Плагин подключения, фактически используемый для задачи на целевом узле.

ansible_host

IP/имя целевого хоста для использования вместо inventory_hostname.

ansible_python_interpreter

Путь к исполняемому файлу Python, который Ansible должен использовать на целевом узле.

ansible_user

Пользователь, под которым Ansible «входит в систему».