You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

include_tasks - Dynamically include a task list¶

New in version 2.4.

Synopsis
Options
Examples
Notes
- Status
- Maintenance Info

Synopsis ¶

Includes a file with a list of tasks to be executed in the current playbook.

Options ¶

parameter	required	default	choices	comments
free-form	no			The name of the imported file is specified directly without any other option. Unlike import_tasks, most keywords, including loops and conditionals, apply to this statement.

Examples ¶

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

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

    - debug:
        msg: task10

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

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

Notes ¶

Note

This is a core feature of the Ansible, rather than a module, and cannot be overridden like a module.

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance Info ¶

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.