ansible.builtin.include_tasks – Dynamically include a task list
Note
This module is part of ansible-core
and included in all Ansible
installations. In most cases, you can use the short
module name
include_tasks
even without specifying the collections:
keyword.
However, we recommend you use the FQCN for easy linking to the
module documentation and to avoid conflicting with other collections that may have
the same module name.
New in version 2.4: of ansible.builtin
Parameters
Parameter |
Comments |
---|---|
Accepts a hash of task keywords (e.g. |
|
The name of the imported file is specified directly without any other option. Unlike ansible.builtin.import_tasks, most keywords, including loop, with_items, and conditionals, apply to this statement. The do until loop is not supported on ansible.builtin.include_tasks. |
|
|
Notes
Note
This is a core feature of the Ansible, rather than a module, and cannot be overridden like a module.
See Also
See also
- ansible.builtin.import_playbook
The official documentation on the ansible.builtin.import_playbook module.
- ansible.builtin.import_role
The official documentation on the ansible.builtin.import_role module.
- ansible.builtin.import_tasks
The official documentation on the ansible.builtin.import_tasks module.
- ansible.builtin.include_role
The official documentation on the ansible.builtin.include_role module.
- Including and importing
More information related to including and importing playbooks, roles and tasks.
Examples
- hosts: all
tasks:
- debug:
msg: task1
- name: Include task list in play
include_tasks: stuff.yaml
- debug:
msg: task10
- hosts: all
tasks:
- debug:
msg: task1
- name: Include task list in play only if the condition is true
include_tasks: "{{ hostvar }}.yaml"
when: hostvar is defined
- name: Apply tags to tasks within included file
include_tasks:
file: install.yml
apply:
tags:
- install
tags:
- always
- name: Apply tags to tasks within included file when using free-form
include_tasks: install.yml
args:
apply:
tags:
- install
tags:
- always
Authors
Ansible Core Team (@ansible)