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