Ansible Core 文档

ansible.builtin.include_tasks 模块 - 动态包含任务列表

注意

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

概要 

包含一个包含要在当前剧本中执行的任务列表的文件。

参数 

参数	注释
apply 字符串在 Ansible 2.7 中添加	接受任务关键字的哈希值（例如 `tags`、`become`），这些关键字将应用于包含内的任务。
file 字符串在 Ansible 2.7 中添加	指定列出要添加到当前剧本的任务的文件的名称。
自由格式字符串	直接指定导入文件的名称，不带任何其他选项 `- include_tasks: file.yml`。等效于为 `file` 参数指定参数。与 ansible.builtin.import_tasks 不同，大多数关键字（包括循环、with_items 和条件语句）都适用于此语句。不支持 do-until 循环。

属性 

属性	支持	描述
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	支持：无	将在差异模式下返回有关更改内容（或可能需要在 check_mode 下更改内容）的详细信息
ignore_conditional	支持：无	操作不受条件执行的约束，因此将忽略 `when:` 关键字
platform	平台：所有	可以对其进行操作的目标操作系统/系列
tags	支持：完整此操作会解释标签，但不会自动由包含的任务继承，请参阅 `apply`	允许使用“tags”关键字来控制此操作的选择以进行执行
until	支持：完整	表示此操作是否服从 until/retry/poll 关键字

另请参阅 

另请参阅

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

示例 

- hosts: all
  tasks:
    - ansible.builtin.debug:
        msg: task1

    - name: Include task list in play
      ansible.builtin.include_tasks:
        file: stuff.yaml

    - ansible.builtin.debug:
        msg: task10

- hosts: all
  tasks:
    - ansible.builtin.debug:
        msg: task1

    - name: Include task list in play only if the condition is true
      ansible.builtin.include_tasks: "{{ hostvar }}.yaml"
      when: hostvar is defined

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

- name: Apply tags to tasks within included file when using free-form
  ansible.builtin.include_tasks: install.yml
  args:
    apply:
      tags:
        - install
  tags:
    - always

作者

Ansible Core 团队 (@ansible)

集合链接