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

注意

此模块是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，即使不指定 集合关键字，您也可以使用简短的模块名称 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	支持: 部分 虽然导入可以是主机特定的并且每个主机运行，但它不处理所有可用的主机变量，在这些情况下请改用 include	强制执行不针对每个主机执行的“全局”任务，这会绕过每个主机的模板化和串行、限制以及其他循环考虑事项 条件语句的工作方式与使用 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)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 交流