ansible.builtin.include – Включение списка ролей или задач

Примечание

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

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

Описание
Параметры
Примечания
См. также
Примеры

Описание

Включает файл со списком ролей или задач, которые должны быть выполнены в текущем плейбуке.
Файлы со списком ролей можно включать только на верхнем уровне. Списки задач можно включать только там, где задачи обычно выполняются (в плейбуке).
До Ansible 2.0 все включения были «статическими» и выполнялись при компиляции плейбука.
Статические включения не подвергаются воздействию большинства директив. Например, циклы или условные операторы применяются вместо этого к каждой унаследованной задаче.
С Ansible 2.0 включения задач являются динамическими и ведут себя больше как реальные задачи. Это означает, что их можно циклировать, пропускать и использовать переменные из любого источника. Ansible пытается автоматически это определить, но вы можете использовать директиву static (которая была добавлена в Ansible 2.1), чтобы обойти автоматическое обнаружение.
Этот модуль также поддерживается для Windows-целей.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
free-form string		Этот модуль позволяет вам указать имя файла напрямую без каких-либо других опций.

Примечания

Примечание

Это основная функция Ansible, а не модуль, и её нельзя переопределить как модуль.
Включение имеет несколько неинтуитивных особенностей в зависимости от того, работает ли оно в статическом или динамическом режиме в контексте плейбука или ролей. В попытке прояснить поведение, мы переходим к новым наборам модулей (ansible.builtin.include_tasks, ansible.builtin.include_role, ansible.builtin.import_playbook, ansible.builtin.import_tasks), которые имеют хорошо установленные и понятные особенности.
Этот модуль всё ещё будет поддерживаться некоторое время, но мы рассматриваем возможность его устаревания в ближайшем будущем.

См. также

ansible.builtin.import_playbook: Официальная документация по модулю ansible.builtin.import_playbook.
ansible.builtin.import_role: Официальная документация по модулю ansible.builtin.import_role.
ansible.builtin.import_tasks: Официальная документация по модулю ansible.builtin.import_tasks.
ansible.builtin.include_role: Официальная документация по модулю ansible.builtin.include_role.
ansible.builtin.include_tasks: Официальная документация по модулю ansible.builtin.include_tasks.
Включение и импорт: Дополнительная информация по включению и импорту плейбуков, ролей и задач.

Примеры

- hosts: localhost
  tasks:
    - debug:
        msg: play1

- name: Include a play after another play
  include: otherplays.yaml


- hosts: all
  tasks:
    - debug:
        msg: task1

    - name: Include task list in play
      include: stuff.yaml

    - debug:
        msg: task10

- hosts: all
  tasks:
    - debug:
        msg: task1

    - name: Include task list in play only if the condition is true
      include: "{{ hostvar }}.yaml"
      static: no
      when: hostvar is defined

Авторы

Команда Ansible Core (@ansible)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/include_module.html