ansible.builtin.import_tasks – Import 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 import_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

Synopsis

  • Imports a list of tasks to be added to the current playbook for subsequent execution.

Parameters

Parameter Choices/Defaults Comments
free-form
string
The name of the imported file is specified directly without any other option.
Most keywords, including loops and conditionals, only applied to the imported tasks, not to this statement itself.
If you need any of those to apply, use ansible.builtin.include_tasks instead.

Notes

Note

  • This is a core feature of 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.include_role

The official documentation on the ansible.builtin.include_role module.

ansible.builtin.include_tasks

The official documentation on the ansible.builtin.include_tasks 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
      import_tasks: stuff.yaml

    - debug:
        msg: task10

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

    - name: Apply conditional to all imported tasks
      import_tasks: stuff.yaml
      when: hostvar is defined

Authors

  • Ansible Core Team (@ansible)