ansible.builtin.include_role 模块 – 加载并执行角色

注意

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

概要

• 动态加载并执行指定的角色作为任务。

• 只能在允许 Ansible 任务的地方使用 - 在 pre_tasks、tasks 或 post_tasks Play 对象内，或作为角色内的任务。

• 任务级关键字、循环和条件仅适用于 include_role 语句本身。

• 要将关键字应用于角色内的任务，请使用 apply 选项传递它们，或改为使用ansible.builtin.import_role。

• 忽略某些关键字，如 until 和 retries。

• 此模块也支持 Windows 目标。

• 在处理程序中不起作用。

参数

参数	注释
allow_duplicates 布尔值	覆盖角色的元数据设置，以允许使用具有相同参数的角色多次。 选项 false true ← (默认)
apply 字符串 在 Ansible 2.7 中添加	接受任务关键字的哈希值（例如 tags，become），这些关键字将应用于包含角色内的所有任务。
defaults_from 字符串	从角色的 defaults/ 目录加载的文件。 默认值： "main"
handlers_from 字符串 在 Ansible 2.8 中添加	从角色的 handlers/ 目录加载的文件。 默认值： "main"
name 字符串 / 必需	要执行的角色的名称。
public 布尔值 在 Ansible 2.7 中添加	此选项指示是否将角色的 vars 和 defaults 暴露给 Play。如果设置为 true，则这些变量将可用于 include_role 任务之后的任务。此功能与在 roles 标头或 ansible.builtin.import_role下列出的角色的标准变量暴露不同，因为它们在 playbook 解析时暴露给 Play，并且也可用于之前的角色和任务。 选项 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	支持：完全 此操作会解释标签，但不会被包含的任务自动继承，请参阅 apply	允许使用“tags”关键字来控制此操作的执行选择
until	支持：完全	表示此操作是否遵循 until/retry/poll 关键字

备注

注意

• 处理程序可用于整个 Play。

• 在 Ansible 2.4 之后，可以使用ansible.builtin.import_role进行静态行为，并使用此操作进行动态行为。

另请参阅

另请参阅

ansible.builtin.import_playbook

导入 Playbook。

ansible.builtin.import_role

将角色导入 Play。

ansible.builtin.import_tasks

导入任务列表。

ansible.builtin.include_tasks

动态包含任务列表。

重用 Ansible 项目

有关包含和导入 Playbook、角色和任务的更多信息。

示例

- ansible.builtin.include_role:
    name: myrole

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

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

- name: Use role in loop
  ansible.builtin.include_role:
    name: '{{ roleinputvar }}'
  loop:
    - '{{ roleinput1 }}'
    - '{{ roleinput2 }}'
  loop_control:
    loop_var: roleinputvar

- name: Conditional role
  ansible.builtin.include_role:
    name: myrole
  when: not idontwanttorun

- name: Apply tags to tasks within included file
  ansible.builtin.include_role:
    name: install
    apply:
      tags:
        - install
  tags:
    - always

作者

• Ansible Core 团队 (@ansible)

集合链接

• 问题跟踪器
• 仓库（源代码）
• 沟通