Documentation

include_tasks - Dynamically include a task list

New in version 2.4.

Synopsis

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

Parameters

Parameter
Choices/Defaults
Comments
free-form
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.

Notes

Note

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

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

Status

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

Support

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author

  • Ansible Core Team (@ansible)

Hint

If you notice any issues in this documentation you can edit this document to improve it.