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

支持:

当处于 diff 模式时,将返回有关已更改(或可能需要在 check_mode 中更改)的详细信息

ignore_conditional

支持:

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

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

platform

平台: 全部

可以操作的目标操作系统/系列

tags

支持:完全

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

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

until

支持:完全

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

注释

注意

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

另请参阅

另请参阅

ansible.builtin.import_playbook

导入 playbook。

ansible.builtin.import_role

将角色导入剧本。

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