ansible.builtin.winrm 连接 – 通过 Microsoft 的 WinRM 运行任务
注意
此连接插件是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，您可以使用简短的插件名称 winrm。但是，我们建议您使用完全限定集合名称 (FQCN) ansible.builtin.winrm，以便轻松链接到插件文档并避免与可能具有相同连接插件名称的其他集合冲突。
概要
通过 WinRM 运行命令或执行 put/fetch 操作。
此插件允许传递协议支持但此处未明确定义的额外参数。它们应采用以下模式声明的变量的形式：
ansible_winrm_<option>。
需求
以下需求是在执行此连接的本地控制器节点上需要的。
pywinrm（python 库）
参数
参数 |
注释 |
|---|---|
尽管其名称如此，但它同时设置 WinRM 连接的“操作”和“读取”超时设置。 操作超时属于 WS-Man 层，并在受管 Windows 主机上的 winRM 服务上运行。 读取超时属于底层的 python Request 调用（http 层），并在 Ansible 控制器上运行。 操作超时设置在受管 Windows 主机上运行的 WS-Man “操作超时”。操作超时指定命令在 winRM 服务上运行多长时间后，它会将消息“WinRMOperationTimeoutError”发送回客户端。客户端（静默地）忽略此消息并启动操作超时的新的实例，等待命令完成（长时间运行的命令）。 读取超时设置客户端 HTTP 请求超时，并指定客户端（Ansible 控制器）将等待多长时间才能从服务器获取数据（等待服务器中间消息的超时）。当此计时器到期时，将抛出异常，并且 Ansible 连接将因错误消息“读取超时”而终止。 为了避免抛出上述异常，读取超时将设置为比 WS-Man 操作超时长 10 秒，从而使连接在网络延迟较长和/或服务器和客户端网络之间有很多跃点的网络上更健壮。 将操作和读取超时之间的差值设置为 10 秒使其与 winrm 模块和 PSRP 模块中使用的默认值一致，它们也使用 10 秒（读取超时为 30 秒，操作超时为 20 秒）。 对应于 pywinrm 中的 默认值是在安装的 pywinrm 版本中设置的值。 配置
|
|
用于请求身份验证票证的 Kerberos 命令 默认值： 配置
|
|
Kerberos 使用模式。 受管选项意味着 Ansible 将获取 Kerberos 票证。 而手动选项意味着用户必须已经获得票证。 如果在尝试获取 Kerberos 票证时遇到 Ansible 冻结的问题，您可以将其设置为 选项
配置
|
|
要传递给 默认情况下，除非也设置了 *ansible_winrm_kerberos_delegation*，否则不会将任何额外参数传递到 如果设置，则参数将覆盖 配置
|
|
要传递给 默认情况下，不会传递任何环境变量，并且 此处不能指定环境变量 默认值： 配置
|
|
要连接到的 URI 路径 默认值： 配置
|
|
通过执行许多 Ansible 模块而无需实际的文件传输，流水线操作减少了在远程服务器上执行模块所需的连接操作数量。 启用此功能可以极大地提高性能。 但是，这可能会与权限提升（ 选项
配置
|
|
winrm 在远程目标上连接的端口 默认值为 https (5986) 端口，如果使用 http，则应为 5985 默认值： 配置
|
|
Windows 机器的地址 默认值： 配置
|
|
配置
|
|
要登录到 Windows 机器的用户 配置
|
|
尝试使用的 WinRM 传输方式列表（ssl、plaintext、kerberos 等） 如果为 None（默认值），插件将尝试自动猜测正确的列表。 可用的选项取决于您的 pywinrm 版本。 配置
|