ansible.builtin.include_tasks (v2.16.5) — module

Dynamically include a task list

| "added in version" 2.4 of ansible.builtin"

Authors: Ansible Core Team (@ansible)

Install Ansible via pip

Install with pip install ansible-core==2.16.5

Description

Includes a file with a list of tasks to be executed in the current playbook.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: all
  tasks:
    - ansible.builtin.debug:
        msg: task1

    - name: Include task list in play
      ansible.builtin.include_tasks:
        file: stuff.yaml

    - ansible.builtin.debug:
        msg: task10
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: all
  tasks:
    - ansible.builtin.debug:
        msg: task1

    - name: Include task list in play only if the condition is true
      ansible.builtin.include_tasks: "{{ hostvar }}.yaml"
      when: hostvar is defined
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Apply tags to tasks within included file
  ansible.builtin.include_tasks:
    file: install.yml
    apply:
      tags:
        - install
  tags:
    - always
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Apply tags to tasks within included file when using free-form
  ansible.builtin.include_tasks: install.yml
  args:
    apply:
      tags:
        - install
  tags:
    - always

Inputs

    
file:
    description:
    - Specifies the name of the file that lists tasks to add to the current playbook.
    type: str
    version_added: '2.7'
    version_added_collection: ansible.builtin

apply:
    description:
    - Accepts a hash of task keywords (for example C(tags), C(become)) that will be applied
      to the tasks within the include.
    type: str
    version_added: '2.7'
    version_added_collection: ansible.builtin

free-form:
    description:
    - 'Specifies the name of the imported file directly without any other option C(- include_tasks:
      file.yml).

      '
    - Is the equivalent of specifying an argument for the O(file) parameter.
    - Most keywords, including loop, with_items, and conditionals, apply to this statement
      unlike M(ansible.builtin.import_tasks).
    - The do-until loop is not supported.

See also