Playbook 关键字

这些是在常见的 playbook 对象上可用的关键字。关键字是配置 Ansible 行为的几种来源之一。有关每个来源的相对优先级的详细信息，请参阅控制 Ansible 行为方式：优先级规则。

注意

请注意

• 此处不反映指令的别名，也不反映可变指令。例如，任务中的action 可以替换为任何 Ansible 模块的名称。

• 关键字目前没有 version_added 信息

• 某些关键字为它们内部的对象设置默认值，而不是为对象本身设置默认值

Play

any_errors_fatal

强制任何主机上任何未处理的任务错误传播到所有主机并结束 play。

become

一个布尔值，控制在Task 执行时是否使用权限提升。由 become 插件实现。请参阅Become 插件。

become_exe

用于提升权限的可执行文件的路径。由 become 插件实现。请参阅Become 插件。

become_flags

当become为 True 时，传递给权限提升程序的标志字符串。

become_method

使用哪种权限提升方法（例如 sudo 或 su）。

become_user

在使用权限提升后，您“成为”的用户。远程/登录用户必须具有成为此用户的权限。

check_mode

一个布尔值，控制任务是否在“检查”模式下执行。请参阅验证任务：检查模式和差异模式。

collections

用于搜索模块、插件和角色的集合命名空间列表。请参阅在 playbook 中使用集合

注意

角色中的任务不会从 play 继承 collections 的值。要让角色搜索集合列表，请在角色内的 meta/main.yml 中使用 collections 关键字。

connection

允许您更改用于在目标上执行任务的连接插件。请参阅使用连接插件。

debugger

根据任务结果的状态启用调试任务。请参阅调试任务。

diff

切换以使任务返回“diff”信息或不返回。

environment

一个字典，会被转换为环境变量，以在执行时提供给任务。这只能与模块一起使用。任何其他类型的插件、Ansible 本身及其配置都不支持此功能，它仅为负责执行任务的代码设置变量。这不是传入机密数据的推荐方法。

fact_path

为由gather_facts控制的事实收集插件设置事实路径选项。

force_handlers

即使主机在 play 期间失败，也会强制执行已通知的主机处理程序。如果 play 本身失败，则不会触发。

gather_facts

一个布尔值，控制 play 是否会自动运行“setup”任务来收集主机的 facts。

gather_subset

允许您将子集选项传递给由gather_facts控制的事实收集插件。

gather_timeout

允许您为由gather_facts控制的事实收集插件设置超时。

handlers

包含被视为处理程序的任务的部分，这些任务通常不会执行，只有在每个任务部分完成后收到通知时才会执行。处理程序的 listen 字段不可模板化。

hosts

组、主机或主机模式的列表，会被转换为 play 的目标主机列表。

ignore_errors

一个布尔值，允许您忽略任务失败并继续执行 play。它不影响连接错误。

ignore_unreachable

一个布尔值，允许您忽略由于主机无法访问而导致的任务失败并继续执行 play。这不影响其他任务错误（请参阅ignore_errors），但对于不稳定的/临时主机组很有用。

max_fail_percentage

可用于在当前批次中给定百分比的主机失败后中止运行。这仅适用于线性或线性派生策略。

module_defaults

为模块指定默认参数值。

name

标识符。可用于文档或任务/处理程序。

no_log

一个布尔值，控制信息披露。

order

控制主机在用于执行 play 时的排序。可能的值为 inventory（默认值）、sorted、reverse_sorted、reverse_inventory 和 shuffle。

port

用于覆盖连接中使用的默认端口。

post_tasks

在tasks部分之后执行的任务列表。

pre_tasks

在roles之前执行的任务列表。

remote_user

用于通过连接插件登录到目标的用户。

roles

要导入到 play 中的角色列表

run_once

一个布尔值，将绕过主机循环，强制任务尝试在第一个可用的主机上执行，然后将任何结果和 facts 应用到同一批次中的所有活动主机。

serial

显式定义 Ansible 如何在 play 的目标上批量执行当前 play。请参阅使用 serial 设置批次大小。

strategy

允许您选择用于 play 的策略插件。请参阅策略插件。

tags

应用于任务或包含的任务的标签，这允许从命令行选择任务的子集。

tasks

在 play 中执行的主要任务列表，它们在roles之后和post_tasks之前运行。

throttle

限制任务、块和 playbook 级别的并发任务运行次数。这与 forks 和 serial 设置无关，但不能设置高于这些限制。例如，如果 forks 设置为 10，throttle 设置为 15，则最多并行操作 10 个主机。

timeout

任务操作执行的时间限制，如果超过，Ansible 将中断进程。超时不包括模板化或循环。

vars

变量的字典/映射

vars_files

包含要在 play 中包含的 vars 的文件列表。

vars_prompt

要提示的变量列表。

角色

any_errors_fatal

强制任何主机上任何未处理的任务错误传播到所有主机并结束 play。

become

一个布尔值，控制在Task 执行时是否使用权限提升。由 become 插件实现。请参阅Become 插件。

become_exe

用于提升权限的可执行文件的路径。由 become 插件实现。请参阅Become 插件。

become_flags

当become为 True 时，传递给权限提升程序的标志字符串。

become_method

使用哪种权限提升方法（例如 sudo 或 su）。

become_user

在使用权限提升后，您“成为”的用户。远程/登录用户必须具有成为此用户的权限。

check_mode

一个布尔值，控制任务是否在“检查”模式下执行。请参阅验证任务：检查模式和差异模式。

collections

用于搜索模块、插件和角色的集合命名空间列表。请参阅在 playbook 中使用集合

注意

角色中的任务不会从 play 继承 collections 的值。要让角色搜索集合列表，请在角色内的 meta/main.yml 中使用 collections 关键字。

connection

允许您更改用于在目标上执行任务的连接插件。请参阅使用连接插件。

debugger

根据任务结果的状态启用调试任务。请参阅调试任务。

delegate_facts

一个布尔值，允许您将 facts 应用于委托主机，而不是 inventory_hostname。

delegate_to

执行任务而不是目标 (inventory_hostname) 的主机。委托主机的连接变量也将用于该任务。

diff

切换以使任务返回“diff”信息或不返回。

environment

一个字典，会被转换为环境变量，以在执行时提供给任务。这只能与模块一起使用。任何其他类型的插件、Ansible 本身及其配置都不支持此功能，它仅为负责执行任务的代码设置变量。这不是传入机密数据的推荐方法。

ignore_errors

一个布尔值，允许您忽略任务失败并继续执行 play。它不影响连接错误。

ignore_unreachable

一个布尔值，允许您忽略由于主机无法访问而导致的任务失败并继续执行 play。这不影响其他任务错误（请参阅ignore_errors），但对于不稳定的/临时主机组很有用。

module_defaults

为模块指定默认参数值。

name

标识符。可用于文档或任务/处理程序。

no_log

一个布尔值，控制信息披露。

port

用于覆盖连接中使用的默认端口。

remote_user

用于通过连接插件登录到目标的用户。

run_once

一个布尔值，将绕过主机循环，强制任务尝试在第一个可用的主机上执行，然后将任何结果和 facts 应用到同一批次中的所有活动主机。

tags

应用于任务或包含的任务的标签，这允许从命令行选择任务的子集。

throttle

限制任务、块和 playbook 级别的并发任务运行次数。这与 forks 和 serial 设置无关，但不能设置高于这些限制。例如，如果 forks 设置为 10，throttle 设置为 15，则最多并行操作 10 个主机。

timeout

任务操作执行的时间限制，如果超过，Ansible 将中断进程。超时不包括模板化或循环。

vars

变量的字典/映射

when

条件表达式，确定是否运行任务的迭代。

块

always

一个块中的任务列表，无论块中是否存在错误，都会执行。

any_errors_fatal

强制任何主机上任何未处理的任务错误传播到所有主机并结束 play。

become

一个布尔值，控制在Task 执行时是否使用权限提升。由 become 插件实现。请参阅Become 插件。

become_exe

用于提升权限的可执行文件的路径。由 become 插件实现。请参阅Become 插件。

become_flags

当become为 True 时，传递给权限提升程序的标志字符串。

become_method

使用哪种权限提升方法（例如 sudo 或 su）。

become_user

在使用权限提升后，您“成为”的用户。远程/登录用户必须具有成为此用户的权限。

block

一个块中的任务列表。

check_mode

一个布尔值，控制任务是否在“检查”模式下执行。请参阅验证任务：检查模式和差异模式。

collections

用于搜索模块、插件和角色的集合命名空间列表。请参阅在 playbook 中使用集合

注意

角色中的任务不会从 play 继承 collections 的值。要让角色搜索集合列表，请在角色内的 meta/main.yml 中使用 collections 关键字。

connection

允许您更改用于在目标上执行任务的连接插件。请参阅使用连接插件。

debugger

根据任务结果的状态启用调试任务。请参阅调试任务。

delegate_facts

一个布尔值，允许您将 facts 应用于委托主机，而不是 inventory_hostname。

delegate_to

执行任务而不是目标 (inventory_hostname) 的主机。委托主机的连接变量也将用于该任务。

diff

切换以使任务返回“diff”信息或不返回。

environment

一个字典，会被转换为环境变量，以在执行时提供给任务。这只能与模块一起使用。任何其他类型的插件、Ansible 本身及其配置都不支持此功能，它仅为负责执行任务的代码设置变量。这不是传入机密数据的推荐方法。

ignore_errors

一个布尔值，允许您忽略任务失败并继续执行 play。它不影响连接错误。

ignore_unreachable

一个布尔值，允许您忽略由于主机无法访问而导致的任务失败并继续执行 play。这不影响其他任务错误（请参阅ignore_errors），但对于不稳定的/临时主机组很有用。

module_defaults

为模块指定默认参数值。

name

标识符。可用于文档或任务/处理程序。

no_log

一个布尔值，控制信息披露。

notify

当任务返回“changed=True”状态时要通知的处理程序列表。

port

用于覆盖连接中使用的默认端口。

remote_user

用于通过连接插件登录到目标的用户。

rescue

如果主 block 列表中存在任务错误，则在 block 中运行的任务列表。

run_once

一个布尔值，将绕过主机循环，强制任务尝试在第一个可用的主机上执行，然后将任何结果和 facts 应用到同一批次中的所有活动主机。

tags

应用于任务或包含的任务的标签，这允许从命令行选择任务的子集。

throttle

限制任务、块和 playbook 级别的并发任务运行次数。这与 forks 和 serial 设置无关，但不能设置高于这些限制。例如，如果 forks 设置为 10，throttle 设置为 15，则最多并行操作 10 个主机。

timeout

任务操作执行的时间限制，如果超过，Ansible 将中断进程。超时不包括模板化或循环。

vars

变量的字典/映射

when

条件表达式，确定是否运行任务的迭代。

任务

action

要为任务执行的“action”，它通常会转换为 C(模块) 或 action 插件。

any_errors_fatal

强制任何主机上任何未处理的任务错误传播到所有主机并结束 play。

args

向任务添加参数的第二种方法。采用一个字典，其中键映射到选项和值。

async

如果 C(操作) 支持，则异步运行任务；该值为最大运行时长（秒）。

become

一个布尔值，控制在Task 执行时是否使用权限提升。由 become 插件实现。请参阅Become 插件。

become_exe

用于提升权限的可执行文件的路径。由 become 插件实现。请参阅Become 插件。

become_flags

当become为 True 时，传递给权限提升程序的标志字符串。

become_method

使用哪种权限提升方法（例如 sudo 或 su）。

become_user

在使用权限提升后，您“成为”的用户。远程/登录用户必须具有成为此用户的权限。

changed_when

覆盖任务正常 “changed” 状态的条件表达式。

check_mode

一个布尔值，控制任务是否在“检查”模式下执行。请参阅验证任务：检查模式和差异模式。

collections

用于搜索模块、插件和角色的集合命名空间列表。请参阅在 playbook 中使用集合

注意

角色中的任务不会从 play 继承 collections 的值。要让角色搜索集合列表，请在角色内的 meta/main.yml 中使用 collections 关键字。

connection

允许您更改用于在目标上执行任务的连接插件。请参阅使用连接插件。

debugger

根据任务结果的状态启用调试任务。请参阅调试任务。

delay

重试之间延迟的秒数。此设置仅与 until 结合使用。

delegate_facts

一个布尔值，允许您将 facts 应用于委托主机，而不是 inventory_hostname。

delegate_to

执行任务而不是目标 (inventory_hostname) 的主机。委托主机的连接变量也将用于该任务。

diff

切换以使任务返回“diff”信息或不返回。

environment

一个字典，会被转换为环境变量，以在执行时提供给任务。这只能与模块一起使用。任何其他类型的插件、Ansible 本身及其配置都不支持此功能，它仅为负责执行任务的代码设置变量。这不是传入机密数据的推荐方法。

failed_when

覆盖任务正常 “failed” 状态的条件表达式。

ignore_errors

一个布尔值，允许您忽略任务失败并继续执行 play。它不影响连接错误。

ignore_unreachable

一个布尔值，允许您忽略由于主机无法访问而导致的任务失败并继续执行 play。这不影响其他任务错误（请参阅ignore_errors），但对于不稳定的/临时主机组很有用。

local_action

与 action 相同，但同时意味着 delegate_to: localhost

loop

获取任务要迭代的列表，将每个列表元素保存到 item 变量中（可通过 loop_control 配置）

loop_control

此处的几个键允许您修改/设置任务中的循环行为。请参阅 向循环添加控制。

module_defaults

为模块指定默认参数值。

name

标识符。可用于文档或任务/处理程序。

no_log

一个布尔值，控制信息披露。

notify

当任务返回“changed=True”状态时要通知的处理程序列表。

poll

设置异步任务的轮询间隔（以秒为单位）（默认为 10 秒）。

port

用于覆盖连接中使用的默认端口。

register

将包含任务状态和模块返回数据的变量的名称。

remote_user

用于通过连接插件登录到目标的用户。

retries

在 until 循环中放弃之前的重试次数。此设置仅与 until 结合使用。

run_once

一个布尔值，将绕过主机循环，强制任务尝试在第一个可用的主机上执行，然后将任何结果和 facts 应用到同一批次中的所有活动主机。

tags

应用于任务或包含的任务的标签，这允许从命令行选择任务的子集。

throttle

限制任务、块和 playbook 级别的并发任务运行次数。这与 forks 和 serial 设置无关，但不能设置高于这些限制。例如，如果 forks 设置为 10，throttle 设置为 15，则最多并行操作 10 个主机。

timeout

任务操作执行的时间限制，如果超过，Ansible 将中断进程。超时不包括模板化或循环。

until

此关键字意味着一个 “retries 循环”，它将持续到满足此处提供的条件或达到 retries 限制为止。

vars

变量的字典/映射

when

条件表达式，确定是否运行任务的迭代。

with_<lookup_plugin>

与 loop 相同，但神奇地添加任何查找插件的输出以生成项目列表。