ansible.builtin.import_role – Import a role into a play
Note
This module is part of ansible-base
and included in all Ansible installations. In most cases, you can use the short module name import_role even without specifying the collections:
keyword. Despite that, 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 | Choices/Defaults | Comments |
---|---|---|
allow_duplicates boolean |
| Overrides the role's metadata setting to allow using a role more than once with the same parameters. |
defaults_from string | Default: "main" | File to load from a role's defaults/ directory. |
handlers_from string added in 2.8 of ansible.builtin | Default: "main" | File to load from a role's handlers/ directory. |
name string / required | The name of the role to be executed. | |
rolespec_validate boolean added in 2.11 of ansible.builtin |
| Perform role argument spec validation if an argument spec is defined. |
tasks_from string | Default: "main" | File to load from a role's tasks/ directory. |
vars_from string | Default: "main" | File to load from a role's vars/ directory. |
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)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/import_role_module.html