ansible.builtin.import_playbook 模块 – 导入剧本

注意

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

概要

  • 包含一个包含要执行的剧本列表的文件。

  • 包含剧本列表的文件只能在顶层包含。

  • 您不能在剧本内部使用此操作。

参数

参数

注释

自由格式

字符串

直接指定导入的剧本名称，无需其他选项。

属性

属性

支持

描述

操作

支持：无

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

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

异步

支持：无

支持与 async 关键字一起使用

成为

支持：无

可与 become 关键字一起使用

bypass_host_loop

支持：部分

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

强制执行一个不按主机执行的“全局”任务，这将绕过按主机进行的模板化、序列化、节流和循环考虑

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

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

bypass_task_loop

支持：部分

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

这些任务会忽略 loop 和 with_ 关键字

检查模式

支持：完整

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

连接

支持：无

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

核心

支持：完整

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

委托

支持：无

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

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

差异模式

支持：无

将返回有关更改内容（或在检查模式下可能需要更改的内容）的详细信息，处于差异模式时

ignore_conditional

支持：无

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

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

平台

平台： 所有

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

标签

支持：完整

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

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

直到

支持：完整

表示此操作是否服从 until/retry/poll 关键字

备注

注意

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

另请参阅

另请参阅

ansible.builtin.import_role

将角色导入剧本。

ansible.builtin.import_tasks

导入任务列表。

ansible.builtin.include_role

加载并执行角色。

ansible.builtin.include_tasks

动态包含任务列表。

重用 Ansible 工件

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

示例

- hosts: localhost
  tasks:
    - ansible.builtin.debug:
        msg: play1

- name: Include a play after another play
  ansible.builtin.import_playbook: otherplays.yaml

- name: Set variables on an imported playbook
  ansible.builtin.import_playbook: otherplays.yml
  vars:
    service: httpd

- name: Include a playbook from a collection
  ansible.builtin.import_playbook: my_namespace.my_collection.my_playbook

- name: This DOES NOT WORK
  hosts: all
  tasks:
    - ansible.builtin.debug:
        msg: task1

    - name: This fails because I'm inside a play already
      ansible.builtin.import_playbook: stuff.yaml

作者

  • Ansible 核心团队 (@ansible)