Ansible 核心文档

ansible.builtin.import_playbook 模块 - 导入剧本

注意

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

概要 

包含一个包含要执行的剧本列表的文件。
包含剧本列表的文件只能在顶层包含。
您不能在剧本中使用此操作。

参数 

参数	注释
自由格式字符串	导入的剧本名称直接指定，没有任何其他选项。

属性 

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

集合链接