ansible.builtin.import_tasks 模块 – 导入任务列表

注意

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

摘要

  • 导入要添加到当前 playbook 以供后续执行的任务列表。

参数

参数

注释

file

字符串

在 Ansible 2.7 中添加

指定列出要添加到当前 playbook 的任务的文件名。

自由格式

字符串

直接指定导入文件的名称,无需任何其他选项 - import_tasks: file.yml

大多数关键词,包括循环和条件语句,仅适用于导入的任务,而不适用于此语句本身。

如果您需要应用其中的任何一个,请改用 ansible.builtin.include_tasks

属性

属性

支持

描述

action

支持:不支持

虽然此操作在控制器上本地执行,但它不受操作插件的控制

指示这具有相应的操作插件,因此某些选项部分可以在控制器上执行

async

支持:不支持

支持与 async 关键词一起使用

become

支持:不支持

可与 become 关键词一起使用

bypass_host_loop

支持:部分支持

虽然导入可以是主机特定的并在每个主机上运行,但它并不处理所有可用的主机变量,对于这些情况,请使用 include。

强制执行不按主机执行的“全局”任务,这将绕过按主机的模板化以及串行、节流和其他循环考虑因素。

条件语句将按 run_once 的方式工作,使用的变量将来自第一个可用的主机。

此操作在非锁步策略之外通常无法正常工作。

bypass_task_loop

支持:部分支持

任务本身不循环,但循环应用于每个导入的任务。

这些任务忽略 loopwith_ 关键词。

check_mode

支持:不支持

可以在 check_mode 下运行并返回更改状态预测,而无需修改目标,如果不支持,则操作将被跳过。

connection

支持:不支持

使用目标的配置连接信息在其上执行代码。

core

支持:完全支持

这是一个“核心引擎”功能,其实现方式与大多数任务操作不同,因此无法通过插件系统以任何方式覆盖。

delegation

支持:不支持

由于没有连接也没有事实信息,因此委派导入没有意义。

可与 delegate_to 和相关关键词结合使用。

diff_mode

支持:不支持

在差异模式下,将返回有关已更改内容(或在 check_mode 下可能需要更改的内容)的详细信息。

ignore_conditional

支持:不支持

虽然操作本身将忽略条件,但它将被导入的任务本身继承。

操作不受条件执行的约束,因此将忽略 when: 关键词。

platform

平台:所有

可以对其进行操作的目标操作系统/系列。

tags

支持:完全支持

此操作不解释标签,它们应用于导入的任务。

允许使用“tags”关键词来控制此操作的选择以进行执行。

until

支持:完全支持

表示此操作是否遵守 until/retry/poll 关键词。

备注

注意

  • 这是 Ansible 的核心功能,而不是模块,不能像模块一样被覆盖。

另请参见

另请参见

ansible.builtin.import_playbook

导入 playbook。

ansible.builtin.import_role

将角色导入到 playbook 中。

ansible.builtin.include_role

加载并执行角色。

ansible.builtin.include_tasks

动态包含任务列表。

重用 Ansible 工件

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

示例

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

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

    - ansible.builtin.debug:
        msg: task10

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

    - name: Apply conditional to all imported tasks
      ansible.builtin.import_tasks: stuff.yaml
      when: hostvar is defined

作者

  • Ansible 核心团队 (@ansible)