W3cubDocs

/Ansible

ansible.builtin.include – Include a play or task list

Note

This module is part of ansible-core and included in all Ansible installations. In most cases, you can use the short module name include even without specifying the collections: keyword. However, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module name.

New in version 0.6: of ansible.builtin

Synopsis
Parameters
Notes
See Also
Examples

Synopsis

Includes a file with a list of plays or tasks to be executed in the current playbook.
Files with a list of plays can only be included at the top level. Lists of tasks can only be included where tasks normally run (in play).
Before Ansible 2.0, all includes were ‘static’ and were executed when the play was compiled.
Static includes are not subject to most directives. For example, loops or conditionals are applied instead to each inherited task.
Since Ansible 2.0, task includes are dynamic and behave more like real tasks. This means they can be looped, skipped and use variables from any source. Ansible tries to auto detect this, but you can use the static directive (which was added in Ansible 2.1) to bypass autodetection.
This module is also supported for Windows targets.

Parameters

Parameter	Choices/Defaults	Comments
free-form string		This module allows you to specify the name of the file directly without any other options.

Notes

Note

This is a core feature of Ansible, rather than a module, and cannot be overridden like a module.
Include has some unintuitive behaviours depending on if it is running in a static or dynamic in play or in playbook context, in an effort to clarify behaviours we are moving to a new set modules (ansible.builtin.include_tasks, ansible.builtin.include_role, ansible.builtin.import_playbook, ansible.builtin.import_tasks) that have well established and clear behaviours.
This module will still be supported for some time but we are looking at deprecating it in the near future.

Examples

- 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

Authors

Ansible Core Team (@ansible)

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