ansible——playbook中的关键字

Posted 2021-03-02 yangmingxianshen

play

any_errors_fatal：强制任何主机上的任何未处理任务错误传播到所有主机并结束播放。
become：布尔值，用于控制是否在任务执行时适用权限提升。
become_flags：当变为True的时候，要传递给权限提升程序的标志。
become_method：适用那种权限升级方法（例如sudo或su）
become_user：
check_mode：布尔值，控制任务是否以check的模式执行
collections
connection
debugger：调试器，根据任务结果的状态启用调试任务
diff
environment：转换未环境变量的字典，在执行时为任务提供。这不会影响Ansible本身及其配置，它只是为负责执行任务的代码设置变量。
fact_path：为gather_facts控制的事实收集插件设置事实路径选项。
force_handlers：即使在播放期间失败，也会强制通知处理程序执行主机
gather_facts
gather_subset：允许您将子集选项传递给gather_facts控制的事实收集插件。
gather_timeout：允许您设置由gather_facts控制的事实收集插件的超时
handlers：处理器，具有被视为处理程序的任务的部分，只有在每个任务部分完成后通知时才会正常执行。
hosts：主机或主机组列表
ignore_errors：布尔值，允许您忽略任务失败并继续执行。它不会影响连接错误。
ignore_unreachable：布尔值，允许您忽略无法访问的主机并继续播放
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：批次执行
strategy：允许您选择用于播放的连接插件。
tags：应用于任务或包含任务的标签，允许从命令行选择任务子集。
tasks：在游戏中执行的任务的主要列表，它们在角色之后和post_tasks之前运行。
vars：变量
vars_files：变量文件
vars_prompt：交互式变量输入

Role

any_errors_fatal：强制任何主机上的任何未处理任务错误传播到所有主机并结束播放。
become：布尔值，用于控制是否在任务执行时使用权限升级。
become_flags：当变为 True 时，要传递给权限提升程序的一串标志。
become_method：使用哪种权限升级方法（例如sudo或su）。
become_user：使用权限升级后您“成为”的用户。远程/登录用户必须具有成为此用户的权限。
check_mode：一个布尔值，用于控制任务是否以“检查”模式执行
collections
connection：允许您更改用于在目标上执行的任务的连接插件。
debugger：根据任务结果的状态启用调试任务
delegate_facts：布尔值，允许您将事实应用于委托主机而不是inventory_hostname。
delegate_to：主机执行任务而不是目标（inventory_hostname）。来自委派主机的连接变量也将用于该任务。
diff：切换以使任务返回‘diff‘信息与否。
environment：转换为环境变量的字典，在执行时为任务提供。这不会影响Ansible本身及其配置，它只是为负责执行任务的代码设置变量。
ignore_errors：布尔值，允许您忽略任务失败并继续播放。它不会影响连接错误。
ignore_unreachable：布尔值，允许您忽略无法访问的主机并继续播放。这不会影响其他任务错误
module_defaults：指定模块的默认参数值。
name：控制信息泄露的布尔值。
no_log：
port：用于覆盖连接中使用的默认端口。
remote_user
run_once
tags
vars
when

Task

action：任务要执行的操作
any_errors_fatal：强制任何主机上的任何未处理任务错误传播到所有主机并结束播放
args：将参数传递到任务的第二种方法。
async：异步
become：是否在执行任务时进行权限升级
become_flags
become_method：适用那种权限升级的方法
become_user：权限升级后变更的用户
changed_when
check_mode
collections
connection：定义连接插件
debugger：调试器
delay：延迟的秒数
delegate_facts：布尔值，允许您将事实应用于委托主机而不是inventory_hostname。
delegate_to：委托
diff：
environment：配置环境信息
failed_when：任务失败的条件表达式
ignore_errors：
ignore_unreachable：布尔值，允许忽略无法访问的主机并继续播放。
local_action：
loop：循环取值的任务列表
loop_control
module_defaults：指定模块的默认参数值。
name
no_log：控制信息泄露的布尔值
notify：当任务返回changed=True状态时要通知处理程序
poll：轮询
port：连接节点的端口
register：寄存器，接收任务的返回值或者状态
remote_user：连接节点的用户
retries：重试次数，与until配合适用
run_once：运行批次中的一台主机，将结果同步给其它主机
tags：应用于任务或包含任务的标签，允许从命令行选择任务子集
until：直到...结束循环
vars：变量
when：条件表达式
with_<lookup_plugin>