include_vars – Загрузка переменных из файлов динамически внутри задачи

Описание
Параметры
Примечания
См. также
Примеры
Возвращаемые значения
Статус

Описание

Динамически загружает переменные YAML/JSON из файла или каталога рекурсивно во время выполнения задачи.
При загрузке каталога файлы сортируются в алфавитном порядке перед загрузкой.
Этот модуль также поддерживается для целей Windows.
Для назначения включённых переменных другому хосту, чем inventory_hostname, используйте delegate_to и задайте delegate_facts=yes.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
depth целое число добавлен в 2.2	Значение по умолчанию: 0	При использовании `dir`, этот модуль по умолчанию рекурсивно проходит по всем подкаталогам и загружает переменные. Установив глубину явно, этот модуль пройдёт только до указанной глубины.
dir путь добавлен в 2.2		Имя каталога, из которого должны быть загружены переменные. Если путь относительный, а задача находится внутри роли, поиск будет осуществляться в подкаталоге vars/ роли. Если путь относительный и не находится внутри роли, он будет обработан относительно playbook.
extensions список добавлен в 2.3	Значение по умолчанию: ["json", "yaml", "yml"]	Список расширений файлов для чтения при использовании `dir`.
file путь добавлен в 2.2		Имя файла, из которого должны быть загружены переменные. Если путь относительный, то файл будет искаться в подкаталоге vars/ роли или относительно playbook.
files_matching строка добавлен в 2.2		Ограничение файлов, загружаемых в любом каталоге, с помощью регулярного выражения.
free-form -		Этот модуль позволяет указать опцию 'file' напрямую без других опций. Опции 'free-form' нет, это просто индикатор, см. пример ниже.
ignore_files список добавлен в 2.2		Список имён файлов для игнорирования.
ignore_unknown_extensions логическое значение добавлен в 2.7	Варианты: нет ← да	Игнорировать неизвестные расширения файлов в каталоге. Это позволяет пользователям указывать каталог, содержащий файлы vars, перемешанные с файлами без расширений vars (например, каталог с README и файлами vars).
name строка добавлен в 2.2		Имя переменной, в которую присваиваются включённые vars. Если опущено (null), они станут переменными верхнего уровня.

Примечания

Примечание

Этот модуль также поддерживается для целей Windows.

См. также

set_fact – Установка фактов хоста из задачи: Официальная документация модуля set_fact.
Делегирование, обновление и локальные действия: Дополнительная информация о делегировании задач.

Примеры

- name: Include vars of stuff.yaml into the 'stuff' variable (2.2).
  include_vars:
    file: stuff.yaml
    name: stuff

- name: Conditionally decide to load in variables into 'plans' when x is 0, otherwise do not. (2.2)
  include_vars:
    file: contingency_plan.yaml
    name: plans
  when: x == 0

- name: Load a variable file based on the OS type, or a default if not found. Using free-form to specify the file.
  include_vars: "{{ lookup('first_found', possible_files) }}"
  vars:
    possible_files:
      - "{{ ansible_distribution }}.yaml"
      - "{{ ansible_os_family }}.yaml"
      - default.yaml

- name: Bare include (free-form)
  include_vars: myvars.yaml

- name: Include all .json and .jsn files in vars/all and all nested directories (2.3)
  include_vars:
    dir: vars/all
    extensions:
        - json
        - jsn

- name: Include all default extension files in vars/all and all nested directories and save the output in test. (2.2)
  include_vars:
    dir: vars/all
    name: test

- name: Include default extension files in vars/services (2.2)
  include_vars:
    dir: vars/services
    depth: 1

- name: Include only files matching bastion.yaml (2.2)
  include_vars:
    dir: vars
    files_matching: bastion.yaml

- name: Include all .yaml files except bastion.yaml (2.3)
  include_vars:
    dir: vars
    ignore_files: [bastion.yaml]
    extensions: [yaml]

- name: Ignore warnings raised for files with unknown extensions while loading (2.7)
  include_vars:
    dir: vars
    ignore_unknown_extensions: True
    extensions: ['', 'yaml', 'yml', 'json']

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращено	Описание
ansible_included_var_files список добавлен в 2.4	успех	Список файлов, которые были успешно включены Пример: ['/path/to/file.json', '/path/to/file.yaml']

Статус

Гарантируется, что в этом модуле не будет изменений в обратной совместимости. [stableinterface]
Этот модуль поддерживается командой Ansible Core. [core]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat можно найти в статье Базы знаний Red Hat.

Авторы

Allen Sanabria (@linuxdynasty)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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/modules/include_vars_module.html