ansible.builtin.import_role – Import a role into a play
Note
This module is part of ansible-core
and included in all Ansible
installations. In most cases, you can use the short
module name
import_role
even without specifying the collections:
keyword.
However, we recommend you use the FQCN for easy linking to the
module documentation and to avoid conflicting with other collections that may have
the same module name.
New in version 2.4: of ansible.builtin
Synopsis
Much like the
roles:
keyword, this task loads a role, but it allows you to control when the role tasks run in between other tasks of the play.Most keywords, loops and conditionals will only be applied to the imported tasks, not to this statement itself. If you want the opposite behavior, use ansible.builtin.include_role instead.
Does not work in handlers.
Parameters
Parameter |
Comments |
---|---|
Overrides the role’s metadata setting to allow using a role more than once with the same parameters. Choices:
|
|
File to load from a role’s Default: “main” |
|
File to load from a role’s Default: “main” |
|
The name of the role to be executed. |
|
Perform role argument spec validation if an argument spec is defined. Choices:
|
|
File to load from a role’s Default: “main” |
|
File to load from a role’s Default: “main” |
Notes
Note
Handlers are made available to the whole play.
Since Ansible 2.7 variables defined in
vars
anddefaults
for the role are exposed to the play at playbook parsing time. Due to this, these variables will be accessible to roles and tasks executed before the location of the ansible.builtin.import_role task.Unlike ansible.builtin.include_role variable exposure is not configurable, and will always be exposed.
See Also
See also
- ansible.builtin.import_playbook
The official documentation on the ansible.builtin.import_playbook module.
- ansible.builtin.import_tasks
The official documentation on the ansible.builtin.import_tasks module.
- ansible.builtin.include_role
The official documentation on the ansible.builtin.include_role module.
- ansible.builtin.include_tasks
The official documentation on the ansible.builtin.include_tasks module.
- Including and importing
More information related to including and importing playbooks, roles and tasks.
Examples
- hosts: all
tasks:
- import_role:
name: myrole
- name: Run tasks/other.yaml instead of 'main'
import_role:
name: myrole
tasks_from: other
- name: Pass variables to role
import_role:
name: myrole
vars:
rolevar1: value from task
- name: Apply condition to each task in role
import_role:
name: myrole
when: not idontwanttorun
Authors
Ansible Core Team (@ansible)