Documentation

include_role - Load and execute a role

New in version 2.2.

Synopsis

  • Loads and executes a role as a task, this frees roles from the role: directive and allows them to be treated more as tasks.

Options

parameter required default choices comments
allow_duplicates
 no True
Overrides the role's metadata setting to allow using a role more than once with the same parameters.
defaults_from
 no main
File to load from a Role's defaults/ directory.
name
 yes
The name of the role to be executed.
private
 no None
If True the variables from defaults/ and vars/ in a role will not be made available to the rest of the play.
tasks_from
 no main
File to load from a Role's tasks/ directory.
vars_from
 no main
File to load from a Role's vars/ directory.

Examples

- include_role:
    name: myrole

- name: Run tasks/other.yml 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: myrole
  with_items:
    - '{{ roleinput1 }}'
    - '{{ roleinput2 }}'
  loop_control:
    loop_var: roleinputvar

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

Notes

Note

  • Handlers are made available to the whole play.
  • simple dependencies seem to work fine.
  • As with include this task can be static or dynamic, If static it implies that it won’t need templating nor loops nor conditionals and will show included tasks in the –list options. Ansible will try to autodetect what is needed, but you can set static to yes or no at task level to control this.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is maintained by those with core commit privileges

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.