剧本关键字

这些是常见剧本对象上可用的关键字。关键字是配置 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

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

environment

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

fact_path

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

force_handlers

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

gather_facts

一个布尔值，用于控制剧本是否会自动运行“setup”任务以收集主机的 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

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

delegate_to

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

diff

切换以使任务返回“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

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

块

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

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

delegate_to

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

diff

切换以使任务返回“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

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

任务

action

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

any_errors_fatal

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

args

将参数添加到任务的次要方法。采用键映射到选项和值的字典。

async

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

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

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

delegate_to

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

diff

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

environment

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

failed_when

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

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相同，但神奇地添加了任何查找插件的输出以生成项目列表。