W3cubDocs

/Ansible

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.

Options

parameter required default choices comments
free-form
 no
This action allows you to specify the name of the file directly w/o any other options.
Unlike import_tasks this action will be affected by most keywords, including loops and conditionals.

Examples

# include task list in play
- hosts: all
  tasks:
    - debug:
        msg: task1

    - include_tasks: stuff.yml

    - debug:
        msg: task10

# dyanmic include task list in play
- hosts: all
  tasks:
    - debug:
        msg: task1

    - include_tasks: "{{ hostvar }}.yml"
      when: hostvar is defined

Notes

Note

  • This is really not a module, this is a feature of the Ansible Engine, as such it cannot be overridden the same way a module can.

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.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/include_tasks_module.html