ansible.builtin.include_tasks (v2.11.12) — 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.11.12

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:
    - debug:
        msg: task1

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

    - debug:
        msg: task10
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Apply tags to tasks within included file
  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
  include_tasks: install.yml
  args:
    apply:
      tags:
        - install
  tags:
    - always

Inputs

    
file:
    description:
    - The name of the imported file is specified directly without any other option.
    - Unlike M(ansible.builtin.import_tasks), most keywords, including loop, with_items,
      and conditionals, apply to this statement.
    - The do until loop is not supported on M(ansible.builtin.include_tasks).
    type: str
    version_added: '2.7'
    version_added_collection: ansible.builtin

apply:
    description:
    - Accepts a hash of task keywords (e.g. 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:
    - 'Supplying a file name via free-form C(- include_tasks: file.yml) of a file to be
      included is the equivalent

      of specifying an argument of I(file).

      '

See also