Connect-PSSession

参考

模块:: Microsoft.PowerShell.Core

重新连接到已断开连接的会话。

语法

Connect-PSSession
       -Name <String[]>
       [-ThrottleLimit <Int32>]
       [-WhatIf]
       [-Confirm] 
       [<CommonParameters>]

Connect-PSSession
       [-Session] <PSSession[]>
       [-ThrottleLimit <Int32>]
       [-WhatIf]
       [-Confirm] 
       [<CommonParameters>]

Connect-PSSession
       -ComputerName <String[]>
       [-ApplicationName <String>]
       [-ConfigurationName <String>]
        -InstanceId <Guid[]>
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
        [-CertificateThumbprint <String>]
       [-Port <Int32>]
       [-UseSSL]
       [-SessionOption <PSSessionOption>]
        [-ThrottleLimit <Int32>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Connect-PSSession
       -ComputerName <String[]>
       [-ApplicationName <String>]
       [-ConfigurationName <String>]
        [-Name <String[]>]
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
        [-CertificateThumbprint <String>]
       [-Port <Int32>]
       [-UseSSL]
       [-SessionOption <PSSessionOption>]
        [-ThrottleLimit <Int32>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Connect-PSSession
       [-ConfigurationName <String>]
       [-ConnectionUri] <Uri[]>
       [-AllowRedirection]
        -InstanceId <Guid[]>
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
        [-CertificateThumbprint <String>]
       [-SessionOption <PSSessionOption>]
       [-ThrottleLimit <Int32>]
        [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Connect-PSSession
       [-ConfigurationName <String>]
       [-ConnectionUri] <Uri[]>
       [-AllowRedirection]
        [-Name <String[]>]
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
        [-CertificateThumbprint <String>]
       [-SessionOption <PSSessionOption>]
       [-ThrottleLimit <Int32>]
        [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Connect-PSSession
       -InstanceId <Guid[]>
       [-ThrottleLimit <Int32>]
       [-WhatIf]
       [-Confirm] 
       [<CommonParameters>]

Connect-PSSession
       [-ThrottleLimit <Int32>]
       [-Id] <Int32[]>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

说明

cmdlet Connect-PSSession 重新连接到用户管理的 PowerShell 会话 (已断开连接的 PSSession) 。它适用于有意断开连接的会话，例如使用 Disconnect-PSSession cmdlet 或 cmdlet 的 Invoke-CommandInDisconnectedSession 参数，以及意外断开连接的会话，例如临时网络中断。

Connect-PSSession 可以连接到由同一用户启动的任何断开连接的会话。这些会话包括由其他计算机上的其他会话启动或断开连接的会话。

但是， Connect-PSSession 无法连接到已中断或已关闭的会话，或者使用 Enter-PSSession cmdlet 启动的交互式会话。此外，也无法将会话连接到由其他用户启动的会话，除非你能提供创建会话的用户的凭据。

有关断开连接会话的功能的详细信息，请参阅 about_Remote_Disconnected_Sessions。

此 cmdlet 是在 Windows PowerShell 3.0 中引入的。

示例

示例 1：重新连接到会话

PS C:\> Connect-PSSession -ComputerName Server01 -Name ITTask
Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 4 ITTask          Server01        Opened        ITTasks                  Available

此命令重新连接到 Server01 计算机上的 ITTask 会话。

该输出显示此命令已成功。会话 的状态 为“已打开”且 “可用性” 为“可用”，指示可以在会话中运行命令。

示例 2：断开连接和重新连接的效果

PS C:\> Get-PSSession

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 Backups         Localhost       Opened        Microsoft.PowerShell     Available


PS C:\> Get-PSSession | Disconnect-PSSession

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 Backups         Localhost       Disconnected  Microsoft.PowerShell          None


PS C:\> Get-PSSession | Connect-PSSession

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 Backups         Localhost       Opened        Microsoft.PowerShell     Available

此示例显示了断开某一会话的连接又重新连接到该会话的效果。

第一个命令使用 Get-PSSession cmdlet。在没有 ComputerName 参数的情况下，该命令仅获取已在当前会话中创建的会话。

该输出显示此命令可获取本地计算机上的 Backup 会话。会话 的状态 为“已打开”， 可用性 为“可用”。

第二个命令使用 Get-PSSession cmdlet 获取在当前会话中创建的 PSSession 对象，并使用 Disconnect-PSSession cmdlet 来断开会话的连接。该输出显示 Backup 会话已断开连接。会话 的状态 为“已断开连接”， “可用性” 为“无”。

第三个命令使用 Get-PSSession cmdlet 获取在当前会话中创建的 PSSession 对象，并使用 Connect-PSSession cmdlet 重新连接会话。该输出显示 Backup 会话已重新连接。会话 的状态 为“已打开”， 可用性 为“可用”。

如果在未断开连接的会话上使用 Connect-PSSession cmdlet，该命令不会影响会话，也不会生成任何错误。

示例 3：企业方案中的一系列命令

这一系列命令演示了如何在 Connect-PSSession 企业方案中使用 cmdlet。在此示例中，系统管理员将在远程计算机上的会话中启动长时间运行的作业。启动该作业后，管理员将断开与该会话的连接，然后下班回家。当晚晚些时候，管理员登录到她的家庭计算机，并验证作业在完成之前是否运行。

管理员首先在远程计算机上创建会话并在会话中运行脚本。第一个命令使用 New-PSSession cmdlet 在 Server01 远程计算机上创建 ITTask 会话。该命令使用 ConfigurationName 参数来指定 ITTask 会话配置。命令将会话保存在变量中 $s 。

用于在变量的会话中$s启动后台作业的第二个命令 Invoke-Command cmdlet。它使用 FilePath 参数在该后台作业中运行脚本。

第三个 Disconnect-PSSession 命令使用 cmdlet 与变量中的 $s 会话断开连接。该命令使用值为 Drop 的 OutputBufferingMode 参数，以防止脚本因必须向会话传递输出而被阻止。它使用 IdleTimeoutSec 参数将会话超时延长到 15 小时。命令完成后，管理员锁定计算机并回家过夜。

当晚晚些时候，管理员启动她的家庭计算机，登录到公司网络，并启动 PowerShell。第四个命令使用 Get-PSSession cmdlet 获取 Server01 计算机上的会话。命令查找 ITTask 会话。第五个命令使用 Connect-PSSession cmdlet 连接到 ITTask 会话。该命令将该会话保存在 $s 变量中。

第六个Get-Job命令使用 Invoke-Command cmdlet 在变量的会话中$s运行命令。输出显示作业已成功完成。第七个Receive-Job命令使用 Invoke-Command cmdlet 在会话的变量的$s会话中运行命令。命令将结果保存在变量中 $BackupSpecs 。第八个命令使用 Invoke-Command cmdlet 在会话中运行另一个脚本。命令使用会话中变量的值 $BackupSpecs 作为脚本的输入。

PS C:\> $s = New-PSSession -ComputerName Server01 -Name ITTask -ConfigurationName ITTasks
PS C:\> Invoke-Command -Session $s {Start-Job -FilePath \\Server30\Scripts\Backup-SQLDatabase.ps1}

Id     Name            State         HasMoreData     Location             Command
--     ----            -----         -----------     --------             -------
2      Job2            Running       True            Server01             \\Server30\Scripts\Backup...

PS C:\> Disconnect-PSSession -Session $s -OutputBufferingMode Drop -IdleTimeoutSec 60*60*15

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 ITTask          Server01        Disconnected  ITTasks               None

PS C:\> Get-PSSession -ComputerName Server01 -Name ITTask

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 ITTask          Server01        Disconnected  ITTasks               None


PS C:\> $s = Connect-PSSession -ComputerName Server01 -Name ITTask


Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 ITTask          Server01        Opened        ITTasks               Available

PS C:\> Invoke-Command -Session $s {Get-Job}

Id     Name            State         HasMoreData     Location             Command
--     ----            -----         -----------     --------             -------
2      Job2            Completed     True            Server01             \\Server30\Scripts\Backup...

PS C:\> Invoke-Command -Session $s {$BackupSpecs = Receive-Job -JobName Job2}

PS C:\> Invoke-Command -Session $s {\\Server30\Scripts\New-SQLDatabase.ps1 -InitData $BackupSpecs.Initialization}

PS C:\> Disconnect-PSSession -Session $s -OutputBufferingMode Drop -IdleTimeoutSec 60*60*15
Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 ITTask          Server01        Disconnected  ITTasks               None

第九个命令与变量中的 $s 会话断开连接。管理员关闭 PowerShell 并关闭计算机。第二天，她可以通过自己的工作计算机重新连接到该会话，并检查该脚本状态。

参数

-AllowRedirection

指示此 cmdlet 允许将此连接重定向到备用 URI。

使用 ConnectionURI 参数时，远程目标将返回一个指令，以重定向到不同的 URI。默认情况下，PowerShell 不会重定向连接，但你可以使用此参数允许它重定向连接。

你也可以通过更改 MaximumConnectionRedirectionCount 会话选项值，限制重定向连接的次数。使用 cmdlet 的 New-PSSessionOptionMaximumRedirection 参数或设置$PSSessionOption首选项变量的 MaximumConnectionRedirectionCount 属性。默认值为 5。

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

-ApplicationName

指定应用程序的名称。此 cmdlet 仅连接到使用指定应用程序的会话。

输入连接 URI 的应用程序名称段。例如，在以下连接 URI 中，应用程序名称为 WSMan：https://localhost:5985/WSMAN。会话的应用程序名称存储在该会话的 Runspace.ConnectionInfo.AppName 属性中。

此参数的值用于选择和筛选会话。它不会更改会话使用的应用程序。

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

-Authentication

指定用于在命令中对用户凭据进行身份验证以重新连接到断开连接的会话的机制。此参数的可接受值为：

Default
基本
Credssp
摘要
Kerberos
Negotiate
NegotiateWithImplicitCredential

默认值为 Default。

有关此参数的值的详细信息，请参阅 AuthenticationMechanism 枚举。

注意

在凭据安全支持提供程序 (CredSSP) 身份验证中，用户凭据传递到远程计算机中以进行验证，这种验证用于要求对多个资源（例如访问远程网络共享）进行验证的命令。此机制增加了远程操作的安全风险。如果远程计算机的安全受到威胁，则传递给该计算机的凭据可用于控制网络会话。

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

-CertificateThumbprint

指定有权连接到断开连接的会话的用户帐户的数字公钥证书 (X509)。输入证书的证书指纹。

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

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

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

-ComputerName

指定在其中存储断开连接的会话的计算机。会话存储在连接服务器端或接收端的计算机上。默认为本地计算机。

键入计算机的 NetBIOS 名称、IP 地址或完全限定的域名。不允许使用通配符。若要指定本地计算机，请键入计算机名称、localhost 或点 (.)

Type:	String[]
Aliases:	Cn
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ConfigurationName

只连接到使用指定会话配置的会话。

输入会话配置的配置名称或完全限定的资源 URI。如果仅指定配置名称，则会在前面添加以下架构 URI： https://schemas.microsoft.com/powershell。会话的配置名称存储在该会话的 ConfigurationName 属性中。

此参数的值用于选择和筛选会话。它不会更改会话使用的会话配置。

有关会话配置的详细信息，请参阅 about_Session_Configurations。

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

-Confirm

提示你在运行 cmdlet 之前进行确认。

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

-ConnectionUri

指定断开连接的会话的连接终结点的 URI。

URI 必须完全限定。此字符串的格式如下：

<Transport>://<ComputerName>:<Port>/<ApplicationName>

默认值如下：

https://localhost:5985/WSMAN

如果未指定连接 URI，则可以使用 UseSSL 和 Port 参数指定连接 URI 值。

URI 的 Transport 段的有效值为 HTTP 和 HTTPS。如果使用 Transport 段指定连接 URI，但不指定端口，将使用以下标准端口来创建会话：80 用于 HTTP，443 用于 HTTPS。若要使用默认端口进行 PowerShell 远程处理，请为 HTTP 指定端口 5985，为 HTTPS 指定端口 5986。

如果目标计算机将连接重定向到其他 URI，则 PowerShell 会阻止重定向，除非你在命令中使用 AllowRedirection 参数。

Type:	Uri[]
Aliases:	URI, CU
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Credential

指定有权连接到断开连接的会话的用户帐户。默认为当前用户。

键入用户名（如 User01 或 Domain01\User01），或输入 PSCredential cmdlet Get-Credential 生成的对象。如果键入用户名，系统会提示输入密码。

凭据存储在 PSCredential 对象中，密码存储为 SecureString。

注意

有关 SecureString 数据保护的详细信息，请参阅 SecureString 的安全性如何？。

Type:	PSCredential
Position:	Named
Default value:	Current user
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

指定断开连接的会话的 ID。仅当已断开连接的会话以前连接到当前会话时， Id 参数才有效。

如果会话存储在本地计算机上，但未连接到当前会话，则此参数是有效的，但并未生效。

Type:	Int32[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-InstanceId

指定断开连接的会话的实例 ID。

实例 ID 是一个 GUID，用于唯一标识本地或远程计算机上的 PSSession 。

实例 ID 存储在 PSSession 的 InstanceID 属性中。

Type:	Guid[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

指定断开连接的会话的友好名称。

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

-Port

指定远程计算机上用于重新连接到会话的网络端口。若要连接到一台远程计算机，则必须在该连接所用的端口上侦听远程计算机。默认端口为 5985（HTTP 的 WinRM 端口）和 5986（HTTPS 的 WinRM 端口）。

使用备用端口之前，你必须在远程计算机上配置 WinRM 侦听器，才能在该端口上进行侦听。若要配置侦听器，请在 PowerShell 提示符处键入以下两个命令：

Remove-Item -Path WSMan:\Localhost\listener\listener* -Recurse

New-Item -Path WSMan:\Localhost\listener -Transport http -Address * -Port \<port-number\>

除非必要，否则不要使用 Port 参数。在命令中设置的端口适用于运行该命令的所有计算机或会话。备用端口设置可能会阻止在所有计算机上运行该命令。

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

-Session

指定断开连接的会话。输入包含 PSSession 对象的变量或用于创建或获取 PSSession 对象的命令，例如 Get-PSSession 命令。

Type:	PSSession[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-SessionOption

为该会话指定高级选项。输入 SessionOption 对象，例如使用 New-PSSessionOption cmdlet 创建的一个对象，或一个哈希表，其中键是会话选项名称，值是会话选项值。

选项的默认值由首选项变量的值 $PSSessionOption （如果已设置）确定。否则，通过在会话配置中设置的选项创建默认值。

会话选项值优先于首选项变量和会话配置中 $PSSessionOption 设置的会话的默认值。但是，它们不优先于在会话配置中设置的最大值、配额或限制。

有关包含默认值的会话选项的说明，请参阅 New-PSSessionOption。有关 $PSSessionOption 首选项变量的信息，请参阅 about_Preference_Variables。有关会话配置的详细信息，请参阅 about_Session_Configurations。

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

-ThrottleLimit

指定为运行此命令可建立的并发连接的最大数目。如果省略此参数或输入 0 值，则使用默认值 32。

节流限制仅适用于当前命令，而不适用于会话或计算机。

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

-UseSSL

指示此 cmdlet 使用安全套接字层 (SSL) 协议连接到断开连接的会话。默认情况下，不使用 SSL。

WS-Management 加密通过网络传输的所有 PowerShell 内容。 UseSSL 参数是一种额外的保护，用于通过 HTTPS 连接而不是 HTTP 连接发送数据。

如果使用此参数，但 SSL 在用于命令的端口上不可用，则命令将失败。

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

-WhatIf

显示运行该 cmdlet 时会发生什么情况。此 cmdlet 未运行。

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

输入

PSSession

可以通过管道将会话 (PSSession) 传递给此 cmdlet。

输出