剧本关键词

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

注意

请注意

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

• 这些关键词目前没有version_added 信息。

• 某些关键词为其内部的对象设置默认值，而不是为对象本身设置默认值。

剧本 (Play)

any_errors_fatal

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

become

布尔值，控制是否在任务 (Task) 执行时使用权限提升。由 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

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

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

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

pre_tasks

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

remote_user

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

roles

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

run_once

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

serial

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

strategy

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

tags

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

tasks

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

throttle

限制任务、块和剧本级别上并发任务运行的数量。这独立于 forks 和 serial 设置，但不能设置为高于这些限制。例如，如果 forks 设置为 10 且 throttle 设置为 15，则最多将并行操作 10 个主机。

timeout

任务执行的时间限制，如果超过此限制，Ansible 将中断并使任务失败。

vars

变量的字典/映射。

vars_files

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

vars_prompt

要提示输入的变量列表。

角色 (Role)

any_errors_fatal

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

become

布尔值，控制是否在任务 (Task) 执行时使用权限提升。由 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

布尔值，控制是否在任务 (Task) 执行时使用权限提升。由 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

在块 (Block) 中任务的列表，如果主块 (Block) 列表中存在任务错误，则运行这些任务。

run_once

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

tags

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

throttle

限制任务、块和剧本级别上并发任务运行的数量。这独立于 forks 和 serial 设置，但不能设置为高于这些限制。例如，如果 forks 设置为 10 且 throttle 设置为 15，则最多将并行操作 10 个主机。

timeout

任务执行的时间限制，如果超过此限制，Ansible 将中断并使任务失败。

vars

变量的字典/映射。

when

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

任务 (Task)

action

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

any_errors_fatal

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

args

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

async

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

become

布尔值，控制是否在任务 (Task) 执行时使用权限提升。由 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

这里的一些键允许您修改/设置任务中的循环行为。请参阅Adding controls to loops。

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