ansible.builtin.import_role 模块 - 将角色导入剧本

注意

此模块是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，即使没有指定 collections 关键字，您也可以使用简短的模块名称 import_role。但是，我们建议您使用完全限定的集合名称 (FQCN) ansible.builtin.import_role，以便轻松链接到模块文档并避免与可能具有相同模块名称的其他集合发生冲突。

概要 

类似于 roles: 关键字，此任务加载角色，但允许您控制角色任务在剧本中其他任务之间运行的时间。
大多数关键字、循环和条件语句仅应用于导入的任务，而不是此语句本身。如果你想要相反的行为，请使用 ansible.builtin.include_role。
在处理程序中不起作用。

参数 

参数	注释
allow_duplicates 布尔值	覆盖角色的元数据设置，允许使用具有相同参数的角色多次。选择 `false` `true` ← (默认)
defaults_from 字符串	从角色的 `defaults/` 目录加载的文件。默认： `"main"`
handlers_from 字符串在 Ansible 2.8 中添加	从角色的 `handlers/` 目录加载的文件。默认： `"main"`
name 字符串 / 必需	要执行的角色的名称。
public 布尔值在 ansible-core 2.17 中添加	此选项决定角色的 `vars` 和 `defaults` 是否公开给剧本。变量在剧本解析时公开给剧本，并且与 `include_role` 不同，也可以用于更早的角色和任务。默认值取决于配置选项 :ref:`default_private_role_vars`。选择 `false` `true` ← (默认)
rolespec_validate 布尔值在 ansible-core 2.11 中添加	如果定义了参数规范，则执行角色参数规范验证。选择 `false` `true` ← (默认)
tasks_from 字符串	从角色的 `tasks/` 目录加载的文件。默认： `"main"`
vars_from 字符串	从角色的 `vars/` 目录加载的文件。默认： `"main"`

属性 

属性	支持	描述
action	支持：无虽然此操作在控制器上本地执行，但它不受操作插件的控制	指示此操作具有相应的操作插件，因此选项的某些部分可以在控制器上执行
async	支持：无	支持与 `async` 关键字一起使用
become	支持：无	可与 become 关键字一起使用
bypass_host_loop	支持：部分虽然导入可以是特定于主机的，并且每个主机运行一次，但它并不处理所有可用的主机变量，在这种情况下使用包含操作。	强制执行不按主机执行的“全局”任务，这会绕过按主机进行的模板化、序列化、节流和其他循环考虑因素。条件语句将像使用 `run_once` 一样工作，使用的变量将来自第一个可用的主机。此操作在非锁步策略之外将无法正常工作。
bypass_task_loop	支持：部分任务本身不循环，但循环应用于每个导入的任务。	这些任务忽略 `loop` 和 `with_` 关键字。
check_mode	支持：完全	可以在 check_mode 下运行，并在不修改目标的情况下返回已更改状态预测，如果不受支持，则操作将被跳过。
connection	支持：无	使用目标的配置连接信息在其上执行代码。
core	支持：完全	这是一个“核心引擎”功能，而不是像大多数任务操作一样实现，因此它无法通过插件系统以任何方式被覆盖。
delegation	支持：无由于没有连接或事实，因此将导入委托没有意义。	可与 delegate_to 和相关关键字一起使用。
diff_mode	支持：无	在 diff 模式下，将返回有关已更改内容（或可能需要更改的内容（在 check_mode 中））的详细信息。
ignore_conditional	支持：无虽然操作本身会忽略条件语句，但它将被导入的任务本身继承。	操作不受条件执行的约束，因此它将忽略 `when:` 关键字。
platform	平台：所有	可以对其进行操作的目标操作系统/系列。
tags	支持：完全标签不会针对此操作进行解释，它们会应用于导入的任务。	允许使用“tags”关键字来控制此操作的执行选择。
until	支持：完全	表示此操作是否遵循 until/retry/poll 关键字。

注意 

注意

处理程序可用于整个剧本。
自 Ansible 2.7 以来，在角色的 vars 和 defaults 中定义的变量在剧本解析时公开给剧本。因此，这些变量将可用于在 ansible.builtin.import_role 任务位置之前执行的角色和任务。
与 ansible.builtin.include_role 不同，变量公开不可配置，并且将始终公开。

另请参阅 

另请参阅

ansible.builtin.import_playbook: 导入剧本。
ansible.builtin.import_tasks: 导入任务列表。
ansible.builtin.include_role: 加载并执行角色。
ansible.builtin.include_tasks: 动态包含任务列表。
重复使用 Ansible 工件: 有关包含和导入剧本、角色和任务的更多信息。

示例 

- hosts: all
  tasks:
    - ansible.builtin.import_role:
        name: myrole

    - name: Run tasks/other.yaml instead of 'main'
      ansible.builtin.import_role:
        name: myrole
        tasks_from: other

    - name: Pass variables to role
      ansible.builtin.import_role:
        name: myrole
      vars:
        rolevar1: value from task

    - name: Apply condition to each task in role
      ansible.builtin.import_role:
        name: myrole
      when: not idontwanttorun

作者

Ansible Core 团队 (@ansible)