W3cubDocs

/Ansible

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.
static
 no None
Gives Ansible a hint if this is a 'static' include or not. If static it implies that it won't need templating nor loops nor conditionals and will show included tasks in the --list options.
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

THIS IS EARLY PREVIEW, THINGS MAY CHANGE

Note

Handlers are made available to the whole play.

Note

simple dependencies seem to work fine.

Note

Things not tested (yet): plugin overrides, nesting includes, used as handler, other stuff I did not think of when I wrote this.

This is a Core Module

For more information on what this means please read Core Modules

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

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/include_role_module.html