include – Include a play or task list

• Synopsis
• Parameters
• Notes
• See Also
• Examples
• Status

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 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.

Parameters

Notes

See Also

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

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Core Team. [core]

Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

Authors

• Ansible Core Team (@ansible)