include - include a play or task list.

• Synopsis
• Options
• Examples
• Notes
• This is a Core Module

Synopsis

Loads 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 load time. 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.

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

This is a Core Module

For more information on what this means please read Core Modules

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