ansible.builtin.include_role (v2.6.20) — module

Install Ansible via pip

Install with pip install ansible==2.6.20

Description

Loads and executes a role as a task dynamically. This frees roles from the `roles:` directive and allows them to be treated more as tasks.

Unlike M(import_role), most keywords, including loops and conditionals, apply to this statement.

This module is also supported for Windows targets.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- include_role:
    name: myrole

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Run tasks/other.yaml instead of 'main'
  include_role:
    name: myrole
    tasks_from: other

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Pass variables to role
  include_role:
    name: myrole
  vars:
    rolevar1: value from task

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Use role in loop
  include_role:
    name: myrole
  with_items:
    - '{{ roleinput1 }}'
    - '{{ roleinput2 }}'
  loop_control:
    loop_var: roleinputvar

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Conditional role
  include_role:
    name: myrole
  when: not idontwanttorun

Inputs

    
name:
    description:
    - The name of the role to be executed.
    required: true

private:
    default: 'no'
    description:
    - This option is a no op, and the functionality described in previous versions was
      not implemented. This option will be removed in Ansible v2.8.
    type: bool

vars_from:
    default: main
    description:
    - File to load from a role's C(vars/) directory.

tasks_from:
    default: main
    description:
    - File to load from a role's C(tasks/) directory.

defaults_from:
    default: main
    description:
    - File to load from a role's C(defaults/) directory.

allow_duplicates:
    default: 'yes'
    description:
    - Overrides the role's metadata setting to allow using a role more than once with
      the same parameters.
    type: bool