ansible.builtin.import_role (v2.6.10) — module

Install Ansible via pip

Install with pip install ansible==2.6.10

Description

Much like the `roles:` keyword, this task loads a role, but it allows you to control it 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 M(include_role) instead. To better understand the difference you can read the L(Including and Importing Guide,../user_guide/playbooks_reuse_includes.html).

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
name:
    description:
    - The name of the role to be executed.
    required: true

private:
    default: 'no'
    description:
    - This option is a no op, and the functionality described in previous versions was
      not implemented. This option will be removed in Ansible v2.8.
    type: bool

vars_from:
    default: main
    description:
    - File to load from a role's C(vars/) directory.

tasks_from:
    default: main
    description:
    - File to load from a role's C(tasks/) directory.

defaults_from:
    default: main
    description:
    - File to load from a role's C(defaults/) directory.

allow_duplicates:
    default: 'yes'
    description:
    - Overrides the role's metadata setting to allow using a role more than once with
      the same parameters.
    type: bool