Documentation

include - include a play or task list.

DEPRECATED

The include action was too confusing, dealing with both plays and tasks, being both dynamic and static. This module will be removed in version 2.8. As alternatives use include_tasks, import_plays, import_tasks.

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 2.0 all includes were ‘static’, executed at play compile time.
  • Static includes are not subject to most directives, for example, loops or conditionals, they are applied instead to each inherited task.
  • Since 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, use the static directive (new in 2.1) to bypass autodetection.
  • This module is also supported for Windows targets.

Options

parameter required default choices comments
free-form
no
This module allows you to specify the name of the file directly w/o any other options.

Examples

# include a play after another play
- hosts: localhost
  tasks:
    - debug:
        msg: "play1"

- include: otherplays.yml


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

    - include: stuff.yml

    - debug:
        msg: task10

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

    - include: "{{ hostvar }}.yml"
      static: no
      when: hostvar is defined

Notes

Note

  • This is really not a module, though it appears as such, this is a feature of the Ansible Engine, as such it cannot be overridden the same way a module can.
  • This module is also supported for Windows targets.

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