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

注意

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

概要

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

参数

参数

注释

文件

字符串

在 Ansible 2.7 中添加

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

自由格式

字符串

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

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

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

属性

属性

支持

描述

操作

支持:

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

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

异步

支持:

支持与 async 关键字一起使用

成为

支持:

可与 become 关键字一起使用

绕过主机循环

支持:部分

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

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

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

此操作在非步调一致策略之外将无法正常工作

绕过任务循环

支持:部分

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

这些任务会忽略 loopwith_ 关键字

检查模式

支持:

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

连接

支持:

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

核心

支持:完全

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

委托

支持:

由于没有连接或事实,因此委托导入没有意义

可与 delegate_to 和相关关键字结合使用

差异模式

支持:

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

忽略条件

支持:

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

操作不受条件执行的影响,因此会忽略 when: 关键字

平台

平台: 全部

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

标签

支持:完全

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

允许使用“标签”关键字控制此操作的选择以进行执行

直到

支持:完全

表示此操作是否遵循 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)