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

注意

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

概要

  • 导入要添加到当前剧本中的任务列表,以便随后执行。

参数

参数

注释

file

字符串

在 Ansible 2.7 中添加

指定列出要添加到当前剧本中的任务的文件名称。

自由格式

字符串

直接指定导入文件的名称,不带任何其他选项 - 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

支持:

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

ignore_conditional

支持:

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

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

platform

平台: 全部

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

tags

支持:完全

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

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

until

支持:完全

表示此操作是否遵循 until/retry/poll 关键字

备注

注意

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

另请参阅

另请参阅

ansible.builtin.import_playbook

导入剧本。

ansible.builtin.import_role

将角色导入剧本。

ansible.builtin.include_role

加载并执行角色。

ansible.builtin.include_tasks

动态包含任务列表。

重复使用 Ansible 工件

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

示例

- 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 Core 团队 (@ansible)