连接插件
连接插件允许 Ansible 连接到目标主机,以便在其上执行任务。Ansible 附带了许多连接插件,但一次只能使用一个插件连接到每个主机。
默认情况下,Ansible 附带几个连接插件。最常用的连接类型是 paramiko SSH、本地 ssh(称为 ssh)和 local。所有这些连接类型都可以在剧本中使用,并与 /usr/bin/ansible 配合使用,以确定如何与远程机器进行通信。如有必要,您可以 创建自定义连接插件。要更改任务的连接插件,可以使用 connection
关键字。
这些连接类型的基本知识在 入门 部分中介绍。
ssh
插件
由于 SSH 是系统管理中使用的默认协议,也是 Ansible 中使用最广泛的协议,因此 SSH 选项包含在命令行工具中。有关详细信息,请参阅 ansible-playbook。
使用连接插件
您可以使用 配置 在全局范围内设置连接插件,或者在命令行(-c
、--connection
)、剧本中的 关键字 或通过设置 变量(通常是在库存中)进行设置。例如,对于 Windows 机器,您可能希望将 winrm 插件设置为库存变量。
大多数连接插件可以在最少的配置下运行。默认情况下,它们使用 库存主机名,并默认为查找目标主机。
插件是自文档化的。每个插件都应记录其配置选项。以下是大多数连接插件通用的连接变量
- ansible_host
要连接到的主机名称,如果与 库存 主机名不同。
- ansible_port
ssh 端口号,对于 ssh 和 paramiko_ssh,默认端口为 22。
- ansible_user
用于登录的默认用户名。大多数插件默认为“运行 Ansible 的当前用户”。
每个插件可能还具有特定版本的变量,该变量会覆盖通用版本。例如,对于 ssh 插件,可以使用 ansible_ssh_host
。
插件列表
您可以使用 ansible-doc -t connection -l
查看可用插件的列表。使用 ansible-doc -t connection <plugin name>
查看特定于插件的文档和示例。