include_role – Load and execute a role

• Synopsis
• Parameters
• Notes
• See Also
• Examples
• Status

Synopsis

• Dynamically loads and executes a specified role as a task.
• May be used only where Ansible tasks are allowed - inside pre_tasks, tasks, or post_tasks playbook objects, or as a task inside a role.
• Task-level keywords, loops, and conditionals apply only to the include_role statement itself.
• To apply keywords to the tasks within the role, pass them using the apply option or use import_role instead.
• Ignores some keywords, like until and retries.
• This module is also supported for Windows targets.

Parameters

Notes

See Also

Examples

- include_role:
    name: myrole

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

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

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

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

- name: Apply tags to tasks within included file
  include_role:
    name: install
    apply:
      tags:
        - install
  tags:
    - always

Status

• This module is guaranteed to have no backward incompatible interface changes going forward. [stableinterface]
• This module is maintained by the Ansible Core Team. [core]

Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

Authors

• Ansible Core Team (@ansible)