Ansible Core 文档

ansible.builtin.import_playbook 模块 – 导入 playbook

注意

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

概要 

包含一个包含要执行的多个剧本的文件。
包含多个剧本的文件只能在顶级包含。
您不能在剧本内使用此操作。

参数 

参数	注释
自由格式字符串	导入的 playbook 名称直接指定，无需其他选项。

属性 

属性	支持	描述
action	支持：不支持虽然此操作在控制器上本地执行，但它不受 action 插件的控制	指示其具有相应的 action 插件，因此某些选项部分可以在控制器上执行
async	支持：不支持	支持与 `async` 关键字一起使用
become	支持：不支持	可与 become 关键字一起使用
bypass_host_loop	支持：部分支持虽然导入可以是特定于主机的，并且每个主机运行一次，但它不处理所有可用的主机变量，对于这些情况，请改用 include	强制执行不按主机执行的“全局”任务，这将绕过按主机的模板化以及串行、节流和其他循环考虑因素条件将按使用 `run_once` 的方式工作，使用的变量将来自第一个可用的主机此操作在非锁步策略之外将无法正常工作
bypass_task_loop	支持：部分支持任务本身不循环，但循环应用于每个导入的任务	这些任务忽略 `loop` 和 `with_` 关键字
check_mode	支持：完全支持	可以在 check_mode 下运行并返回更改状态预测，而无需修改目标，如果不支持，则会跳过该操作。
connection	支持：不支持	使用目标的配置连接信息在其上执行代码
core	支持：完全支持	这是一个“核心引擎”功能，其实现方式与大多数任务操作不同，因此无法通过插件系统以任何方式覆盖。
delegation	支持：不支持由于没有连接或事实，因此委派导入没有意义	可与 delegate_to 和相关关键字结合使用
diff_mode	支持：不支持	在差异模式下，将返回有关已更改内容（或在 check_mode 下可能需要更改的内容）的详细信息
ignore_conditional	支持：不支持虽然操作本身将忽略条件，但它将被导入的任务本身继承	操作不受条件执行的影响，因此它将忽略 `when:` 关键字
platform	平台：所有	可以对其进行操作的目标操作系统/系列
tags	支持：完全支持此操作不会解释标签，它们将应用于导入的任务	允许使用“标签”关键字控制此操作的执行选择
until	支持：完全支持	表示此操作是否遵守 until/retry/poll 关键字

备注 

注意

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

另请参见 

另请参见

ansible.builtin.import_role: 将角色导入剧本。
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)

集合链接