Playbook 关键字
这些是在通用 playbook 对象上可用的关键字。关键字是配置 Ansible 行为的几种来源之一。有关每个来源相对优先级的详细信息，请参阅控制 Ansible 的行为：优先级规则。
注意
请注意
指令的别名以及可变指令不在此处反映。例如，任务中的 action 可以替换为任何 Ansible 模块的名称。
关键字目前没有
version_added信息某些关键字为它们内部的对象设置默认值，而不是为对象本身设置默认值
Play
- any_errors_fatal
强制将任何主机上任何未处理的任务错误传播到所有主机并结束 play。
- 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
切换以使任务返回“差异”信息或不返回。
- 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
一个布尔值，将绕过主机循环，强制任务尝试在第一个可用的主机上执行，然后将任何结果和事实应用于同一批次中的所有活动主机。
- 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_prompt
要提示输入的变量列表。
Role
- any_errors_fatal
强制将任何主机上任何未处理的任务错误传播到所有主机并结束 play。
- 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
一个布尔值，允许您将事实应用于委托的主机，而不是 inventory_hostname。
- delegate_to
要执行任务而不是目标（inventory_hostname）的主机。委托主机的连接变量也将用于该任务。
- diff
切换以使任务返回“差异”信息或不返回。
- environment
一个字典，它被转换为环境变量，以便在执行时提供给任务。这只能与模块一起使用。任何其他类型的插件、Ansible 本身及其配置都不支持此功能，它只是为负责执行任务的代码设置变量。这不是传递机密数据的推荐方式。
- ignore_errors
一个布尔值，允许您忽略任务失败并继续 play。它不会影响连接错误。
- ignore_unreachable
一个布尔值，允许您忽略由于主机无法访问而导致的任务失败并继续 play。这不会影响其他任务错误（请参阅 ignore_errors），但对于易失/临时主机组很有用。
- module_defaults
指定模块的默认参数值。
- name
标识符。可用于文档或任务/处理程序中。
- no_log
一个控制信息披露的布尔值。
- port
用于覆盖连接中使用的默认端口。
- remote_user
用于通过连接插件登录到目标的用户。
- run_once
一个布尔值，将绕过主机循环，强制任务尝试在第一个可用的主机上执行，然后将任何结果和事实应用于同一批次中的所有活动主机。
- tags
应用于任务或包含任务的标签，这允许从命令行选择任务的子集。
- throttle
限制在任务、块和 playbook 级别上并发运行的任务数。这与 forks 和 serial 设置无关，但不能设置高于这些限制。例如，如果 forks 设置为 10，而 throttle 设置为 15，则最多并行操作 10 个主机。
- timeout
任务操作执行的时间限制，如果超出此限制，Ansible 将中断该过程。超时不包括模板或循环。
- vars
变量的字典/映射
- when
条件表达式，确定是否运行任务的迭代。
Block
- always
一个块中无论该块中是否有错误都执行的任务列表。
- any_errors_fatal
强制将任何主机上任何未处理的任务错误传播到所有主机并结束 play。
- 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
一个布尔值，允许您将事实应用于委托的主机，而不是 inventory_hostname。
- delegate_to
要执行任务而不是目标（inventory_hostname）的主机。委托主机的连接变量也将用于该任务。
- diff
切换以使任务返回“差异”信息或不返回。
- environment
一个字典，它被转换为环境变量，以便在执行时提供给任务。这只能与模块一起使用。任何其他类型的插件、Ansible 本身及其配置都不支持此功能，它只是为负责执行任务的代码设置变量。这不是传递机密数据的推荐方式。
- ignore_errors
一个布尔值，允许您忽略任务失败并继续 play。它不会影响连接错误。
- ignore_unreachable
一个布尔值，允许您忽略由于主机无法访问而导致的任务失败并继续 play。这不会影响其他任务错误（请参阅 ignore_errors），但对于易失/临时主机组很有用。
- module_defaults
指定模块的默认参数值。
- name
标识符。可用于文档或任务/处理程序中。
- no_log
一个控制信息披露的布尔值。
- notify
当任务返回“changed=True”状态时要通知的处理程序列表。
- port
用于覆盖连接中使用的默认端口。
- remote_user
用于通过连接插件登录到目标的用户。
- rescue
- run_once
一个布尔值，将绕过主机循环，强制任务尝试在第一个可用的主机上执行，然后将任何结果和事实应用于同一批次中的所有活动主机。
- tags
应用于任务或包含任务的标签，这允许从命令行选择任务的子集。
- throttle
限制在任务、块和 playbook 级别上并发运行的任务数。这与 forks 和 serial 设置无关，但不能设置高于这些限制。例如，如果 forks 设置为 10，而 throttle 设置为 15，则最多并行操作 10 个主机。
- timeout
任务操作执行的时间限制，如果超出此限制，Ansible 将中断该过程。超时不包括模板或循环。
- vars
变量的字典/映射
- when
条件表达式，确定是否运行任务的迭代。
Task
- action
要为任务执行的“action”，它通常转换为 C(模块)或 action 插件。
- any_errors_fatal
强制将任何主机上任何未处理的任务错误传播到所有主机并结束 play。
- args
向任务添加参数的第二种方法。采用字典，其中键映射到选项和值。
- async
如果 C(动作) 支持异步，则异步运行任务；该值是以秒为单位的最大运行时长。
- 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
一个布尔值，允许您将事实应用于委托的主机，而不是 inventory_hostname。
- delegate_to
要执行任务而不是目标（inventory_hostname）的主机。委托主机的连接变量也将用于该任务。
- 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
- run_once
一个布尔值，将绕过主机循环，强制任务尝试在第一个可用的主机上执行，然后将任何结果和事实应用于同一批次中的所有活动主机。
- tags
应用于任务或包含任务的标签，这允许从命令行选择任务的子集。
- throttle
限制在任务、块和 playbook 级别上并发运行的任务数。这与 forks 和 serial 设置无关，但不能设置高于这些限制。例如，如果 forks 设置为 10，而 throttle 设置为 15，则最多并行操作 10 个主机。
- timeout
任务操作执行的时间限制，如果超出此限制，Ansible 将中断该过程。超时不包括模板或循环。
- until
- vars
变量的字典/映射
- when
条件表达式，确定是否运行任务的迭代。
- with_<lookup_plugin>
与
loop相同，但神奇地添加任何查找插件的输出以生成项目列表。