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

注意

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

概要

  • 导入要添加到当前剧本的执行任务列表。

参数

参数

注释

文件

字符串

添加到 Ansible 2.7

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

自由格式

字符串

指定导入文件的名称,没有任何其他选项 - import_tasks: file.yml

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

如果您需要任何这些应用,请使用 ansible.builtin.include_tasks 代替。

属性

属性

支持

描述

操作

支持:

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

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

异步

支持:

支持与 async 关键字一起使用

成为

支持:

可以与 become 关键字一起使用

bypass_host_loop

支持:部分

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

强制执行一个“全局”任务,该任务不会每个主机执行一次,这将绕过每个主机的模板化以及 serial、throttle 和其他循环考虑因素

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

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

bypass_task_loop

支持:部分

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

这些任务忽略 loopwith_ 关键字

检查模式

支持:

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

连接

支持:

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

核心

支持:完全

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

委托

支持:

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

可以与 delegate_to 和相关关键字一起使用

diff_mode

支持:

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

ignore_conditional

支持:

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

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

平台

平台: 全部

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

标签

支持:完全

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

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

直到

支持:完全

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