剧本关键字

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

注意

请注意

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

• 关键字目前没有 version_added 信息

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

剧本

any_errors_fatal

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

become

布尔值，控制在 任务 执行时是否使用特权升级。由 become 插件实现。参见 Become 插件。

become_exe

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

become_flags

当 become 为 True 时传递给特权升级程序的一系列标志。

become_method

要使用的特权升级方法（例如 sudo 或 su）。

become_user

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

check_mode

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

collections

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

注意

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

connection

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

debugger

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

diff

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

environment

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

fact_path

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

force_handlers

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

gather_facts

布尔值，控制剧本是否会自动运行“设置”任务以收集主机的facts。

gather_subset

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

gather_timeout

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

handlers

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

hosts

一个组、主机或主机模式的列表，它转换为作为剧本目标的主机列表。

ignore_errors

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

ignore_unreachable

布尔值，允许您忽略由于主机无法访问而导致的任务失败并继续执行剧本。这不会影响其他任务错误（参见 ignore_errors），但对于易变的/短暂的主机组非常有用。

max_fail_percentage

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

module_defaults

指定模块的默认参数值。

name

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

no_log

布尔值，控制信息披露。

order

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

port

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

post_tasks

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

pre_tasks

在 角色 之前执行的任务列表。

remote_user

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

roles

要导入到剧本中的角色列表

run_once

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

serial

明确定义 Ansible 如何在剧本目标上批处理当前剧本的执行。参见 使用 serial 设置批次大小。

strategy

允许您选择用于剧本的策略插件。参见 策略插件。

tags

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

tasks

在剧本中执行的主要任务列表，它们在 角色 之后和 post_tasks 之前运行。

throttle

限制在任务、块和剧本级别同时运行的任务数量。这与 forks 和 serial 设置无关，但不能设置高于这些限制。例如，如果 forks 设置为 10，而 throttle 设置为 15，那么最多将有 10 个主机同时运行。

timeout

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

vars

变量的字典/映射

vars_files

包含要包含在剧本中的变量的文件列表。

vars_prompt

要提示输入的变量列表。

角色

any_errors_fatal

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

become

布尔值，控制在 任务 执行时是否使用特权升级。由 become 插件实现。参见 Become 插件。

become_exe

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

become_flags

当 become 为 True 时传递给特权升级程序的一系列标志。

become_method

要使用的特权升级方法（例如 sudo 或 su）。

become_user

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

check_mode

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

collections

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

注意

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

connection

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

debugger

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

ignore_errors

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

ignore_unreachable

布尔值，允许您忽略由于主机无法访问而导致的任务失败并继续执行剧本。这不会影响其他任务错误（参见 ignore_errors），但对于易变的/短暂的主机组非常有用。

module_defaults

指定模块的默认参数值。

name

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

no_log

布尔值，控制信息披露。

port

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

remote_user

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

run_once

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

tags

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

throttle

限制在任务、块和剧本级别同时运行的任务数量。这与 forks 和 serial 设置无关，但不能设置高于这些限制。例如，如果 forks 设置为 10，而 throttle 设置为 15，那么最多将有 10 个主机同时运行。

timeout

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

vars

变量的字典/映射

when

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

Block

always

块中的一组任务，无论块中是否发生错误，这些任务都会执行。

any_errors_fatal

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

become

布尔值，控制在 任务 执行时是否使用特权升级。由 become 插件实现。参见 Become 插件。

become_exe

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

become_flags

当 become 为 True 时传递给特权升级程序的一系列标志。

become_method

要使用的特权升级方法（例如 sudo 或 su）。

become_user

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

block

块中的一组任务。

check_mode

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

collections

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

注意

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

connection

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

debugger

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

delegate_facts

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

delegate_to

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

diff

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

environment

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

ignore_errors

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

ignore_unreachable

布尔值，允许您忽略由于主机无法访问而导致的任务失败并继续执行剧本。这不会影响其他任务错误（参见 ignore_errors），但对于易变的/短暂的主机组非常有用。

module_defaults

指定模块的默认参数值。

name

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

no_log

布尔值，控制信息披露。

notify

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

port

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

remote_user

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

rescue

在块中的一组任务，如果主块列表中发生任务错误，则运行这些任务。

run_once

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

tags

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

throttle

限制在任务、块和剧本级别同时运行的任务数量。这与 forks 和 serial 设置无关，但不能设置高于这些限制。例如，如果 forks 设置为 10，而 throttle 设置为 15，那么最多将有 10 个主机同时运行。

timeout

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

vars

变量的字典/映射

when

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

Task

action

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

any_errors_fatal

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

args

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

async

如果 C(操作) 支持，则异步运行任务；值为以秒为单位的最大运行时间。

become

布尔值，控制在 任务 执行时是否使用特权升级。由 become 插件实现。参见 Become 插件。

become_exe

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

become_flags

当 become 为 True 时传递给特权升级程序的一系列标志。

become_method

要使用的特权升级方法（例如 sudo 或 su）。

become_user

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

changed_when

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

check_mode

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

collections

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

注意

角色中的任务不会从剧本中继承 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

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

ignore_unreachable

布尔值，允许您忽略由于主机无法访问而导致的任务失败并继续执行剧本。这不会影响其他任务错误（参见 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

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

tags

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

throttle

限制在任务、块和剧本级别同时运行的任务数量。这与 forks 和 serial 设置无关，但不能设置高于这些限制。例如，如果 forks 设置为 10，而 throttle 设置为 15，那么最多将有 10 个主机同时运行。

timeout

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

until

此关键字意味着一个“retries 循环”，该循环将一直持续到满足这里提供的条件或达到 retries 限制。

vars

变量的字典/映射

when

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

with_<lookup_plugin>

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