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

Примечание

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

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

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

Описание

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

Параметры

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

Примечания

Примечание

Это основная функция 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/builtin/include_module.html