Connect-WSMan

  • 参考
模块:
Microsoft.WSMan.Management

连接到远程计算机上的 WinRM 服务。

语法

Connect-WSMan
       [-ApplicationName <String>]
       [[-ComputerName] <String>]
       [-OptionSet <Hashtable>]
       [-Port <Int32>]
       [-SessionOption <SessionOption>]
       [-UseSSL]
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
       [-CertificateThumbprint <String>]
       [<CommonParameters>]
Connect-WSMan
       [-ConnectionURI <Uri>]
       [-OptionSet <Hashtable>]
       [-Port <Int32>]
       [-SessionOption <SessionOption>]
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
       [-CertificateThumbprint <String>]
       [<CommonParameters>]

说明

此 cmdlet 仅在 Windows 平台上可用。

Connect-WSMan cmdlet 可连接到远程计算机上的 WinRM 服务，并建立与远程计算机的持续性连接。 你可以在 WSMan 提供程序的上下文中使用此 cmdlet 连接到远程计算机上的 WinRM 服务。 但是，你还可以在更改为 WSMan 提供程序之前，使用此 cmdlet 连接到远程计算机上的 WinRM 服务。 远程计算机将出现在 WSMan 提供程序的根目录下。

当客户端和服务器计算机位于不同的域或工作组中时，需要使用显式凭据。

有关如何断开与远程计算机上 WinRM 服务的连接的详细信息，请参阅 Disconnect-WSMan cmdlet。

示例

示例 1：连接到远程计算机

PS C:\> Connect-WSMan -ComputerName "server01"
PS C:\> cd wsman:
PS WSMan:\>
PS WSMan:\> dir

WSManConfig: Microsoft.WSMan.Management\WSMan::WSMan

ComputerName                                  Type
------------                                  ----
localhost                                     Container
server01                                      Container

此命令创建一个与 server01 远程计算机的连接。

通常在 WSMan 提供程序的上下文中使用 Connect-WSMan cmdlet 连接到远程计算机（在本例中为 server01 计算机）。 但是，你可以在更改为 WSMan 提供程序之前，使用该 cmdlet 建立与远程计算机的连接。 这些连接将出现在 ComputerName 列表中。

示例 2：使用管理员凭据连接到远程计算机

PS C:\> $cred = Get-Credential Administrator
PS C:\> Connect-WSMan -ComputerName "server01" -Credential $cred
PS C:\> cd wsman:
PS WSMan:\>
PS WSMan:\> dir

WSManConfig: Microsoft.WSMan.Management\WSMan::WSMan

ComputerName                                  Type
------------                                  ----
localhost                                     Container
server01                                      Container

此命令使用管理员帐户凭据创建一个与远程系统 server01 的连接。

第一个命令使用 Get-Credential cmdlet 来获取管理员凭据，然后将其存储在 $cred 变量中。 Get-Credential 通过对话框或在命令行上提示输入用户名和密码，具体取决于系统注册表设置。

第二个命令使用 Credential 参数将存储在 $cred 中的凭据传递给 Connect-WSMan。 然后，Connect-WSMan 使用管理员凭据连接到远程系统 server01。

示例 3：通过指定端口连接到远程计算机

PS C:\> Connect-WSMan -ComputerName "server01" -Port 80
PS C:\> cd wsman:
PS WSMan:\>
PS WSMan:\> dir

WSManConfig: Microsoft.WSMan.Management\WSMan::WSMan
ComputerName                                  Type
------------                                  ----
localhost                                     Container
server01                                      Container

此命令通过端口 80 创建一个与 server01 远程计算机的连接。

示例 4：使用连接选项连接到远程计算机

PS C:\> $a = New-WSManSessionOption -OperationTimeout 30000
PS C:\> Connect-WSMan -ComputerName "server01" -SessionOption $a
PS C:\> cd wsman:
PS WSMan:\> dir

WSManConfig: Microsoft.WSMan.Management\WSMan::WSMan
ComputerName                                  Type
------------                                  ----
localhost                                     Container
server01                                      Container

此示例使用 New-WSManSessionOption 命令中定义的连接选项创建与远程计算机 server01 的连接。

第一个命令使用 New-WSManSessionOption 在 $a 变量中存储一组连接设置选项。 在此情况下，这些会话选项将连接超时设置为 30 秒（30,000 毫秒）。

第二个命令使用 SessionOption 参数将存储在 $a 变量中的凭据传递给 Connect-WSMan。 然后，Connect-WSMan 使用指定的会话选项连接到 server01 远程计算机。

参数

-ApplicationName

指定连接中的应用程序名称。 ApplicationName 参数的默认值为 WSMAN。 远程终结点的完整标识符采用以下格式：

<Transport>://<Server>:<Port>/<ApplicationName>

例如：http://server01:8080/WSMAN

托管该会话的 Internet Information Services (IIS) 将带有此终结点的请求转发到指定的应用程序。 默认设置 WSMAN 适用于大多数使用情况。 如果许多计算机建立了与运行 Windows PowerShell 的一台计算机的远程连接，则需要使用此参数。 在此情况下，IIS 将托管 Web Services for Management (WS-Management) 以提高效率。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Authentication

指定服务器上要使用的身份验证机制。 此参数的可接受值为：

  • Basic - Basic 是一种将用户名和密码以明文形式发送到服务器或代理的方案。
  • Default - 使用由 WS-Management 协议实现的身份验证方法。 这是默认情况。
  • Digest - Digest 是一种质询响应方案，该方案将服务器指定的数据字符串用于质询。
  • Kerberos - 客户端计算机和服务器通过使用 Kerberos 证书相互进行身份验证。
  • Negotiate - Negotiate 是一种质询响应方案，该方案与服务器或代理进行协商来确定要用于身份验证的方案。 例如，此参数值允许协商以确定是使用 Kerberos 协议还是 NTLM。
  • CredSSP - 使用凭据安全支持提供程序 (CredSSP) 身份验证，它允许用户委派凭据。 此选项专门用于这样的命令：在一台远程计算机上运行，但从其他远程计算机收集数据或在其他远程计算机上运行其他命令。

注意

CredSSP 将用户的凭据从本地计算机委派给远程计算机。 此做法增加了远程操作的安全风险。 如果远程计算机的安全受到威胁，则在向该计算机传递凭据时，可使用这些凭据来控制网络会话。

Type:AuthenticationMechanism
Aliases:auth, am
Accepted values:None, Default, Digest, Negotiate, Basic, Kerberos, ClientCertificate, Credssp
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CertificateThumbprint

指定有权执行此操作的用户帐户的数字公钥证书 (X509)。 输入证书的证书指纹。

在基于客户端证书的身份验证中使用证书。 证书只能映射到本地用户帐户，而不适用于域帐户。

若要获取证书指纹，请在 Windows PowerShell Cert: 驱动器中使用 Get-Item 或 Get-ChildItem 命令。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

指定要对其运行管理操作的计算机。 该值可以是完全限定的域名、NetBIOS 名称或 IP 地址。 可使用本地计算机名称、localhost 或点 (.) 指定本地计算机。 默认值为本地计算机。 当远程计算机与用户位于不同的域时，必须使用完全限定的域名。 可以通过管道将此参数的值传递给 cmdle。

Type:String
Aliases:cn
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionURI

指定连接终结点。 此字符串的格式如下：

<Transport>://<Server>:<Port>/<ApplicationName>

以下字符串是此参数的格式正确的值：

http://Server01:8080/WSMAN

URI 必须完全限定。

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

指定有权执行此操作的用户帐户。 默认为当前用户。 键入用户名，例如 User01、Domain01\User01 或 User@Domain.com。 或者，输入 PSCredential 对象，例如 Get-Credential cmdlet 返回的对象。 键入用户名时，此 cmdlet 会提示输入密码。

Type:PSCredential
Aliases:cred, c
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-OptionSet

将一组开关指定到某个服务以修改或优化请求的性质。 这些开关类似于命令行 shell 中使用的开关，因为它们也特定于服务。 可以指定任何数量的选项。

以下示例演示为 a、b 和 c 参数传递值 1、2 和 3 的语法：

-OptionSet @{a=1;b=2;c=3}

Type:Hashtable
Aliases:os
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Port

指定要在客户端连接到 WinRM 服务时使用的端口。 当传输为 HTTP 时，默认端口为 80。 当传输为 HTTPS 时，默认端口为 443。

使用 HTTPS 作为传输协议时，ComputerName 参数的值必须与服务器的证书公用名 (CN) 匹配。 但是，如果将 SkipCNCheck 参数指定为 SessionOption 参数的一部分，则服务器的证书公用名无需与服务器的主机名匹配。 SkipCNCheck 参数应仅用于受信任的计算机。

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SessionOption

为 WS-Management 会话指定扩展选项。 输入使用 New-WSManSessionOption cmdlet 创建的 SessionOption 对象。 有关可用选项的详细信息，请键入 Get-Help New-WSManSessionOption。

Type:SessionOption
Aliases:so
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UseSSL

指定使用安全套接字层 (SSL) 协议来建立与远程计算机的连接。 默认情况下，不使用 SSL。

WS-Management 对通过网络传输的所有 Windows PowerShell 内容进行加密。 可以使用 UseSSL 参数指定 HTTPS（而非 HTTP）的额外保护措施。 如果 SSL 在用于连接的端口上不可用，并且指定了此参数，则命令将失败。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

输入

None

不能通过管道将对象传递给此 cmdlet。

输出

None

此 cmdlet 不返回任何输出。

备注

你可以在远程计算机上运行管理命令或查询管理数据，而无需创建 WS-Management 会话。 可以使用 Invoke-WSManAction 和 Get-WSManInstance 的 ComputerName 参数来执行此操作。 当你使用 ComputerName 参数时，Windows PowerShell 将创建一个用于单个命令的临时连接。 在命令运行完后，该连接即会关闭。