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_playbook, 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 Ansible version 2.0, all includes were ‘static’ and were executed when the play was compiled.
• Static includes are not subject to most directives. For example, loops or conditionals are applied instead to each inherited task.
• Since Ansible 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, but you can use the static directive (which was added in Ansible 2.1) to bypass autodetection.
• This module is also supported for Windows targets.

Options¶

Examples¶

- hosts: localhost
  tasks:
    - debug:
        msg: play1

- name: Include a play after another play
  include: otherplays.yaml


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

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

    - debug:
        msg: task10

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

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

Notes¶

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