Connect-PSSession

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

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

Connect-PSSession
    -ComputerName <String[]>
    -InstanceId <Guid[]>
    [-ApplicationName <String>]
    [-ConfigurationName <String>]
    [-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
    [-ConnectionUri] <Uri[]>
    -InstanceId <Guid[]>
    [-ConfigurationName <String>]
    [-AllowRedirection]
    [-Credential <PSCredential>]
    [-Authentication <AuthenticationMechanism>]
    [-CertificateThumbprint <String>]
    [-SessionOption <PSSessionOption>]
    [-ThrottleLimit <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Connect-PSSession
    [-ConnectionUri] <Uri[]>
    [-ConfigurationName <String>]
    [-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
    [-Id] <Int32[]>
    [-ThrottleLimit <Int32>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

此 cmdlet 仅在 Windows 平台上可用。

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

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

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

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

此 cmdlet 已在 Windows PowerShell 3.0 中引入。

Connect-PSSession -ComputerName Server01 -Name ITTask

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

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

输出显示命令成功。 会话的状态和Opened可用性Available，指示可以在会话中运行命令。

Get-PSSession

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

Get-PSSession | Disconnect-PSSession

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

Get-PSSession | Connect-PSSession

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

此示例显示断开连接，然后重新连接到会话的效果。

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

输出显示命令获取 Backups 本地计算机上的会话。 会话 的状态 是 Opened 且 可用性 为 Available。

第二个命令使用 Get-PSSession cmdlet 获取在当前会话中创建的 PSSession 对象，以及 Disconnect-PSSession cmdlet 以断开会话的连接。 输出显示 Backups 会话已断开连接。 会话 的状态 是 Disconnected 且 可用性 为 None。

第三个命令使用 Get-PSSession cmdlet 获取在当前会话中创建的 PSSession 对象和 Connect-PSSession cmdlet 以重新连接会话。 输出显示 Backups 会话已重新连接。 会话 的状态 是 Opened 且 可用性 为 Available。

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

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

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

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

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

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

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

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

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

Disconnect-PSSession -Session $s -OutputBufferingMode Drop -IdleTimeoutSec 60*60*15

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

Get-PSSession -ComputerName Server01 -Name ITTask

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

$s = Connect-PSSession -ComputerName Server01 -Name ITTask

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

Invoke-Command -Session $s -ScriptBlock {Get-Job}

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

Invoke-Command -Session $s -ScriptBlock {$BackupSpecs = Receive-Job -JobName Job2}
Invoke-Command -Session $s -ScriptBlock {\\Server30\Scripts\New-SQLDatabase.ps1 -InitData $BackupSpecs.Initialization}
Disconnect-PSSession -Session $s -OutputBufferingMode Drop -IdleTimeoutSec 60*60*15

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

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

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

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

此 cmdlet 返回一个对象，该对象表示其重新连接到的会话。

PowerShell 包含以下与 Connect-PSSession相关的别名：

• 窗户：

  • cnsn

• 此 cmdlet 仅在 Windows 平台上可用。

• Connect-PSSession 仅重新连接到已断开连接的会话，即 具有 State 属性的“已断开连接”值的会话。 只有连接到或结束于运行 Windows PowerShell 3.0 或更高版本的计算机的会话才能断开连接并重新连接。

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

• 使用使用 EnableNetworkAccess 参数创建的交互式令牌的断开连接环回会话只能从创建会话的计算机重新连接。 此限制可保护计算机免受恶意访问。

• PSSession 的 State 属性的值相对于当前会话。 因此，断开连接 值表示 PSSession 未连接到当前会话。 但是，这并不意味着 PSSession 已与所有会话断开连接。 它可能连接到另一个会话。 若要确定是否可以连接或重新连接到会话，请使用 Availability 属性。

  当可用性 的值为“无”时，表示可以连接到会话。 “忙碌”值表示无法连接到 PSSession，因为它已连接到另一个会话。

  有关会话的 State 属性的值的详细信息，请参阅 RunspaceState 枚举。

  有关会话 可用性 属性的值的详细信息，请参阅 RunspaceAvailability 枚举。

• 连接到 PSSession时，无法更改 PSSession 的空闲超时值。 的 Connect-PSSession 参数采用具有 IdleTimeout 值的 SessionOption 对象。 但是，连接到 PSSession 时，将忽略 SessionOption 对象的 IdleTimeout 值和变量的 $PSSessionOptionIdleTimeout 值。

  您可以在创建 PSSession时，或断开与 PSSession的连接时，通过使用 New-PSSession 或 Invoke-Command cmdlet 来设置和更改 PSSession 的空闲超时。

  PSSession 的 IdleTimeout 属性对于断开连接的会话至关重要，因为它确定在远程计算机上维护断开连接的会话的时间。 断开连接的会话从其断开连接的时刻起就被视为空闲，即使命令正在断开连接的会话中运行也是如此。