ansible.builtin.import_playbook 模块 – 导入 playbook

注意

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

摘要

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

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

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

参数

参数

注释

自由格式

字符串

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

属性

属性

支持

描述

操作

支持：无

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

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

异步

支持：无

支持与 async 关键词一起使用

成为

支持：无

可与 become 关键词一起使用

绕过主机循环

支持：部分

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

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

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

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

绕过任务循环

支持：部分

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

这些任务忽略 loop 和 with_ 关键词

检查模式

支持：完全

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

连接

支持：无

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

核心

支持：完全

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

委派

支持：无

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

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

差异模式

支持：无

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

忽略条件

支持：无

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

操作不受条件执行的影响，因此它将忽略 when: 关键词

平台

平台： 所有

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

标签

支持：完全

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

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

直到

支持：完全

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

注释

注意

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

另请参阅

另请参阅

ansible.builtin.import_role

将角色导入 playbook。

ansible.builtin.import_tasks

导入任务列表。

ansible.builtin.include_role

加载并执行角色。

ansible.builtin.include_tasks

动态包含任务列表。

重新使用 Ansible 工件

与包含和导入 playbook、角色和任务相关的更多信息。

示例

- 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 Core 团队（@ansible）