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

Примечание

Этот модуль является частью ansible-base и включён во все установки Ansible. В большинстве случаев, вы можете использовать короткое имя модуля include_vars даже без указания ключевого слова collections:. Несмотря на это, мы рекомендуем использовать полное имя класса (FQCN) для удобной ссылки на документацию модуля и для избежания конфликтов с другими коллекциями, которые могут иметь то же самое имя модуля.

Новое в версии 1.4: of ansible.builtin

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

Описание

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

Примечание

Этот модуль имеет соответствующий плагин действия.

Параметры

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

Примечания

Примечание

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

См. также

ansible.builtin.set_fact: Официальная документация модуля ansible.builtin.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', params) }}"
  vars:
    params:
      files:
        - '{{ansible_distribution}}.yaml'
        - '{{ansible_os_family}}.yaml'
        - default.yaml
      paths:
        - 'vars'

- 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 версии ansible.builtin	успех	Список файлов, которые были успешно включены Пример: ['/path/to/file.json', '/path/to/file.yaml']

Авторы

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.10/collections/ansible/builtin/include_vars_module.html