Receive-PSSession

模块:

Microsoft.PowerShell.Core

获取断开连接的会话中的命令的结果

语法

Receive-PSSession
       [-Session] <PSSession>
       [-OutTarget <OutTarget>]
       [-JobName <String>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Receive-PSSession
       [-Id] <Int32>
       [-OutTarget <OutTarget>]
       [-JobName <String>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

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

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

Receive-PSSession
       [-ConfigurationName <String>]
       [-ConnectionUri] <Uri>
       [-AllowRedirection]
       -Name <String>
       [-OutTarget <OutTarget>]
       [-JobName <String>]
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
       [-CertificateThumbprint <String>]
       [-SessionOption <PSSessionOption>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Receive-PSSession
       [-ConfigurationName <String>]
       [-ConnectionUri] <Uri>
       [-AllowRedirection]
       -InstanceId <Guid>
       [-OutTarget <OutTarget>]
       [-JobName <String>]
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
       [-CertificateThumbprint <String>]
       [-SessionOption <PSSessionOption>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Receive-PSSession
       -InstanceId <Guid>
       [-OutTarget <OutTarget>]
       [-JobName <String>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Receive-PSSession
       -Name <String>
       [-OutTarget <OutTarget>]
       [-JobName <String>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

说明

此 cmdlet 仅在 Windows 平台上可用。

Receive-PSSession cmdlet 获取在 PowerShell 会话（PSSession）中运行的命令的结果，这些命令已断开连接。 如果会话当前已连接，Receive-PSSession 获取会话断开连接时正在运行的命令的结果。 如果会话仍处于断开连接的状态，则 Receive-PSSession 连接到会话，恢复挂起的任何命令，并获取会话中运行的命令的结果。

此 cmdlet 是在 PowerShell 3.0 中引入的。

除了或不使用 Connect-PSSession 命令外，还可以使用 Receive-PSSession。 Receive-PSSession 可以连接到在其他会话或其他计算机上启动的任何断开连接或重新连接的会话。

Receive-PSSession 适用于有意使用 Disconnect-PSSessioncmdlet 或Invoke-Command InDisconnectedSession 参数断开连接的 PSSession。 或者无意中因网络中断而断开连接。

如果使用 Receive-PSSessioncmdlet 连接到没有运行或挂起命令的会话，Receive-PSSession 将连接到会话，但不会返回任何输出或错误。

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

一些示例使用展开来减少行长并提高可读性。 有关详细信息，请参阅 about_Splatting。

示例

示例 1：连接到 PSSession

此示例连接到远程计算机上的会话，并获取在会话中运行的命令的结果。

Receive-PSSession -ComputerName Server01 -Name ITTask

Receive-PSSession 使用 ComputerName 参数指定远程计算机。 名称参数标识 Server01 计算机上的 ITTask 会话。 该示例获取 ITTask 会话中运行的命令的结果。

由于该命令不使用 OutTarget 参数，因此结果将显示在命令行中。

示例 2：获取断开连接会话上所有命令的结果

此示例获取两台远程计算机上所有断开连接会话中运行的所有命令的结果。

如果任何会话未断开连接或未运行命令，则 Receive-PSSession 不会连接到会话，也不会返回任何输出或错误。

Get-PSSession -ComputerName Server01, Server02 | Receive-PSSession

Get-PSSession 使用 ComputerName 参数指定远程计算机。 对象沿管道向下发送到Receive-PSSession。

示例 3：获取会话中运行的脚本的结果

此示例使用 Receive-PSSession cmdlet 获取远程计算机会话中运行的脚本的结果。

$parms = @{
  ComputerName = "Server01"
  Name = "ITTask"
  OutTarget = "Job"
  JobName = "ITTaskJob01"
  Credential = "Domain01\Admin01"
}
Receive-PSSession @parms

Id     Name            State         HasMoreData     Location
--     ----            -----         -----------     --------
16     ITTaskJob01     Running       True            Server01

该命令使用 ComputerName 和名称参数来标识断开连接的会话。 它使用具有 Job 值的 OutTarget 参数来指示 Receive-PSSession 以作业的形式返回结果。 JobName 参数指定重新连接会话中作业的名称。 凭据参数使用域管理员的权限运行 Receive-PSSession 命令。

输出显示，Receive-PSSession 在当前会话中以作业的形式返回结果。 若要获取作业结果，请使用 Receive-Job 命令

示例 4：在网络中断后获取结果

此示例使用 Receive-PSSession cmdlet，以在由于网络故障而中断了会话连接后获取作业的结果。 在接下来的 4 分钟内，Windows PowerShell 将每隔一秒自动尝试重新连接该会话一次，而且仅在 4 分钟的时间间隔内所有尝试都失败才失放弃努力。

PS> $s = New-PSSession -ComputerName Server01 -Name AD -ConfigurationName ADEndpoint
PS> $s

Id  Name   ComputerName    State        ConfigurationName     Availability
--  ----   ------------    -----        -----------------     ------------
8   AD      Server01       Opened       ADEndpoint               Available


PS> Invoke-Command -Session $s -FilePath \\Server12\Scripts\SharedScripts\New-ADResolve.ps1

Running "New-ADResolve.ps1"

# Network outage
# Restart local computer
# Network access is not re-established within 4 minutes


PS> Get-PSSession -ComputerName Server01

Id  Name   ComputerName    State          ConfigurationName      Availability
--  ----   ------------    -----          -----------------      ------------
1  Backup  Server01        Disconnected   Microsoft.PowerShell           None
8  AD      Server01        Disconnected   ADEndpoint                     None


PS> Receive-PSSession -ComputerName Server01 -Name AD -OutTarget Job -JobName AD

Job Id   Name      State         HasMoreData     Location
--       ----      -----         -----------     --------
16       ADJob     Running       True            Server01


PS> Get-PSSession -ComputerName Server01

Id  Name    ComputerName    State         ConfigurationName     Availability
--  ----    ------------    -----         -----------------     ------------
1  Backup   Server01        Disconnected  Microsoft.PowerShell          Busy
8  AD       Server01        Opened        ADEndpoint               Available

New-PSSession cmdlet 在 Server01 计算机上创建会话，并将会话保存在 $s 变量中。 $s 变量显示状态已打开，可用性可用。 这些值指示已连接到会话，并且可以在会话中运行命令。

Invoke-Command cmdlet 在 $s 变量的会话中运行脚本。 该脚本开始运行并返回数据，但如果出现网络故障，可能会中断该会话。 用户必须退出该会话并重新启动本地计算机。

计算机重启时，用户启动 PowerShell 并运行 Get-PSSession 命令，以获取 Server01 计算机上的会话。 输出显示 Server01 计算机上仍然存在 AD 会话。 状态指示 AD 会话已断开连接。 可用性值为“无”，指示会话未连接到任何客户端会话。

Receive-PSSession cmdlet 重新连接到 AD 会话，并获取在会话中运行的脚本的结果。 该命令使用OutTarget参数在名为ADJob的作业中请求结果。 该命令返回作业对象，输出指示脚本仍在运行。

Get-PSSession cmdlet 用于检查作业状态。 输出确认 Receive-PSSession cmdlet 已重新连接到 AD 会话，该会话现已打开，可用于命令。 并且，脚本恢复执行，正在获取脚本结果。

示例 5：重新连接到断开连接的会话

此示例使用 Receive-PSSession cmdlet，以重新连接到有意断开连接的会话，并获取已在这些会话中运行的作业的结果。

PS> $parms = @{
      InDisconnectedSession = $True
      ComputerName = "Server01", "Server02", "Server30"
      FilePath = "\\Server12\Scripts\SharedScripts\Get-BugStatus.ps1"
      Name = "BugStatus"
      SessionOption = @{IdleTimeout = 86400000}
      ConfigurationName = "ITTasks"
    }
PS> Invoke-Command @parms
PS> Exit


PS> $s = Get-PSSession -ComputerName Server01, Server02, Server30 -Name BugStatus
PS> $s

Id  Name   ComputerName    State         ConfigurationName     Availability
--  ----   ------------    -----         -----------------     ------------
1  ITTask  Server01        Disconnected  ITTasks                       None
8  ITTask  Server02        Disconnected  ITTasks                       None
2  ITTask  Server30        Disconnected  ITTasks                       None


PS> $Results = Receive-PSSession -Session $s
PS> $s

Id  Name   ComputerName    State         ConfigurationName     Availability
--  ----   ------------    -----         -----------------     ------------
1  ITTask  Server01        Opened        ITTasks                  Available
8  ITTask  Server02        Opened        ITTasks                  Available
2  ITTask  Server30        Opened        ITTasks                  Available


PS> $Results

Bug Report - Domain 01
----------------------
ComputerName          BugCount          LastUpdated
--------------        ---------         ------------
Server01              121               Friday, December 30, 2011 5:03:34 PM

Invoke-Command cmdlet 在三台远程计算机上运行脚本。 由于脚本从多个数据库收集和汇总数据，因此脚本通常需要较长时间才能完成。 该命令使用 InDisconnectedSession 参数来启动脚本，然后立即断开会话的连接。 SessionOption 参数扩展断开连接会话的 IdleTimeout 值。 断开连接的会话从断开连接的那一刻起被视为空闲。 必须设置足够长的时间空闲超时，以便命令可以完成，并且可以重新连接到会话。 仅当创建 PSSession 时，才能设置 IdleTimeout，并且仅在与 PSSession 断开连接时才可以更改它。 连接到 PSSession 或接收其结果时，无法更改 IdleTimeout 值。 运行该命令后，用户将退出 Windows PowerShell 并关闭计算机。

第二天，用户恢复 Windows，启动 PowerShell，并使用 Get-PSSession 获取运行脚本的会话。 该命令按计算机名称、会话名称和会话配置的名称标识会话，并将会话保存在 $s 变量中。 将显示 $s 变量的值，并显示会话已断开连接，但不忙。

Receive-PSSession cmdlet 连接到 $s 变量中的会话并获取其结果。 该命令将结果保存在 $Results 变量中。 将显示 $s 变量，并显示会话已连接并可用于命令。

脚本结果 $Results 变量显示在 PowerShell 控制台中。 如果出现任何意外结果，用户可以在这些会话中运行命令以调查根本原因。

示例 6：在断开连接的会话中运行作业

此示例显示在断开连接的会话中运行的作业会发生的情况。

PS> $s = New-PSSession -ComputerName Server01 -Name Test
PS> $j = Invoke-Command -Session $s { 1..1500 | Foreach-Object {"Return $_"; sleep 30}} -AsJob
PS> $j

Id     Name           State         HasMoreData     Location
--     ----           -----         -----------     --------
16     Job1           Running       True            Server01


PS> $s | Disconnect-PSSession

Id Name   ComputerName    State         ConfigurationName     Availability
-- ----   ------------    -----         -----------------     ------------
1  Test   Server01        Disconnected  Microsoft.PowerShell          None


PS> $j

Id     Name           State         HasMoreData     Location
--     ----           -----         -----------     --------
16     Job1           Disconnected  True            Server01


PS> Receive-Job $j -Keep

Return 1
Return 2


PS> $s2 = Connect-PSSession -ComputerName Server01 -Name Test
PS> $j2 = Receive-PSSession -ComputerName Server01 -Name Test
PS> Receive-Job $j

Return 3
Return 4

New-PSSession cmdlet 在 Server01 计算机上创建测试会话。 该命令将该会话保存在 $s 变量中。

Invoke-Command cmdlet 在 $s 变量中的会话中运行命令。 该命令使用 AsJob 参数将命令作为作业运行，并在当前会话中创建作业对象。 该命令返回保存在 $j 变量中的作业对象。 $j 变量显示作业对象。

$s 变量中的会话对象沿管道向下发送到 Disconnect-PSSession，会话断开连接。

将显示 $j 变量，并显示断开 $j 变量中作业对象断开连接的效果。 现在，该作业状态为“已断开连接”。

Receive-Job 在 $j 变量中的作业上运行。 输出显示作业在会话之前开始返回输出，作业已断开连接。

Connect-PSSession cmdlet 在同一客户端会话中运行。 该命令重新连接到 Server01 计算机上的测试会话，并将会话保存在 $s2 变量中。

Receive-PSSession cmdlet 获取在会话中运行的作业的结果。 由于该命令在同一会话中运行，因此默认情况下 Receive-PSSession 以作业的形式返回结果，并重复使用相同的作业对象。 该命令将作业保存在 $j2 变量中。 Receive-Job cmdlet 将获取 $j 变量中作业的结果。

参数

-AllowRedirection

指示此 cmdlet 允许将此连接重定向到备用统一资源标识符 (URI)。

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

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

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

-ApplicationName

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

输入连接 URI 的应用程序名称段。 例如，在以下连接 URI 中，WSMan 是应用程序名称：http://localhost:5985/WSMAN。

会话的应用程序名称存储在该会话的 Runspace.ConnectionInfo.AppName 属性中。

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

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

-Authentication

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

• 默认值
• 基本
• Credssp
• 摘要
• Kerberos
• Negotiate
• NegotiateWithImplicitCredential

默认值为 Default。

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

注意

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

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

-CertificateThumbprint

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

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

若要获取证书指纹，请使用 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 地址或完全限定的域名 (FQDN)。 不允许使用通配符。 若要指定本地计算机，请键入计算机名称、点（.）、$env:COMPUTERNAME 或 localhost。

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

-ConfigurationName

指定会话配置的名称。 此 cmdlet 仅连接到使用指定会话配置的会话。

输入会话配置的配置名称或完全限定的资源 URI。 如果仅指定配置名称，则前面有以下架构 URI：

http://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 定义用于重新连接到断开连接的会话的连接终结点。

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

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

默认值如下：

http://localhost:5985/WSMAN

如果未指定连接 URI，则可以使用 UseSSL、ComputerName、端口和 ApplicationName 参数来指定连接 URI 值。

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

如果目标计算机将连接重定向到另一个 URI，PowerShell 将阻止重定向，除非在命令中使用 AllowRedirection 参数。

Type:	Uri
Aliases:	URI, CU
Position:	0
Default value:	http://localhost:5985/WSMAN
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Credential

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

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

凭据存储在 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

-JobName

指定 Receive-PSSession 返回的作业的友好名称。

当 OutTarget 参数的值为“作业”或当前会话中正在运行的作业时，Receive-PSSession 返回作业。

如果在当前会话中启动在断开连接会话中运行的作业，PowerShell 将重用会话中的原始作业对象，并忽略 JobName 参数的值。

如果断开连接的会话中正在运行的作业已在其他会话中启动，PowerShell 将创建一个新的作业对象。 它使用默认名称，但你可以使用此参数来更改名称。

如果 OutTarget 参数的默认值或显式值不是“作业”，则命令成功执行，但 JobName 参数不起作用。

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

-Name

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

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

-OutTarget

确定如何返回会话结果。 此参数的可接受值为：

• 作业。 在作业对象中异步返回结果。 可以使用 JobName 参数指定作业的名称或新名称。
• 主机。 将结果返回到命令行（同步）。 如果正在恢复该命令或者结果由大量对象组成，则可能会延迟响应。

OutTarget 参数的默认值为“主机”。 如果在当前会话中启动在断开连接的会话中收到的命令，则 OutTarget 参数的默认值的形式是启动该命令时的形式。 如果命令作为作业启动，则默认情况下，该命令将作为作业返回。 否则，默认情况下，它将默认返回到主机程序。

通常，主机程序会立即在命令行中显示返回的对象，但是此行为会有所不同。

Type:	OutTarget
Accepted values:	Default, Host, Job
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\>

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

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

-UseSSL

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

WS-Management 对通过网络传输的所有 PowerShell 内容进行加密。 UseSSL 是一种额外的保护措施，它通过 HTTPS 连接而不是 HTTP 连接来发送数据。

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

Type:	SwitchParameter
Position:	Named
Default value:	False
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

可以通过管道将会话对象传递给此 cmdlet，例如 Get-PSSession cmdlet 返回的对象。

Int32

可以通过管道将会话 ID 传递给此 cmdlet。

Guid

可以通过管道传递此 cmdlet 的会话实例 ID。

String

可以通过管道将会话 ID 传递给此 cmdlet。

输出

Job

如果 OutTarget 参数的值或默认值为 Job，则 Receive-PSSession 返回作业对象。

PSObject

此 cmdlet 返回在断开连接的会话中运行的命令的结果（如果有）。

备注

PowerShell 包含以下 Receive-PSSession 别名：

• 所有平台：
  • rcsn

此 cmdlet 仅在 Windows 平台上可用。

Receive-PSSession 仅从断开连接的会话获取结果。 只有连接到或终止运行 PowerShell 3.0 或更高版本的计算机的会话才能断开连接并重新连接。

如果在断开连接的会话中运行的命令未生成结果，或者结果已返回到另一个会话，则 Receive-PSSession 不会生成任何输出。

会话的输出缓冲模式确定在该会话断开连接时会话中的命令将如何管理输出。 当会话的 OutputBufferingMode 选项的值为 Drop 且输出缓冲区已满时，命令将开始删除输出。 Receive-PSSession 无法恢复此输出。 有关输出缓冲模式选项的详细信息，请参阅有关 New-PSSessionOption 和 New-PSTransportOption cmdlet 的帮助文章。

连接到 PSSession 或接收结果时，无法更改 PSSession 的空闲超时值。 Receive-PSSession 的 SessionOption 参数采用具有 IdleTimeout 值的 SessionOption 对象。 但是，当连接到 PSSession 或接收结果时，将忽略 SessionOption 对象的 IdleTimeout 值和 $PSSessionOption 变量的 IdleTimeout 值。

• 通过使用 New-PSSession 或 Invoke-Command cmdlet，以及断开与 PSSession 的连接，可以在创建 PSSession 时设置和更改 PSSession 的空闲超时。
• PSSession 的 IdleTimeout 属性对于断开连接的会话至关重要，因为它确定在远程计算机上维护断开连接的会话的时间。 断开连接的会话从其断开连接的时刻起就被视为空闲，即使命令正在断开连接的会话中运行也是如此。

如果使用 Invoke-Command cmdlet 的 AsJob 参数在远程会话中启动作业，则会在当前会话中创建作业对象，即使作业在远程会话中运行也是如此。 如果断开与远程会话的连接，则当前会话中的作业对象将立即断开与该作业的连接。 该作业对象仍包含返回到其中的所有结果，但它不接收断开连接的会话中该作业的新结果。

如果其他客户端连接到包含正在运行的作业的会话，则已传递给原始会话中的原始作业对象的结果在新连接的会话中不可用。 在重新连接的会话中只能使用未传递给原始作业对象的结果。

同样，如果在会话中启动脚本，然后断开与该会话的连接，则该脚本在断开连接之前传递给该会话的所有结果在连接到该会话的其他客户端上都不可用。

若要防止要断开连接的会话中数据丢失，请使用 Invoke-Command cmdlet 的 InDisconnectedSession 参数。 由于此参数会阻止结果返回到当前会话，因此在重新连接该会话后所有结果均可用。

还可以通过使用 Invoke-Command cmdlet 在远程会话中运行 Start-Job 命令来防止数据丢失。 在此情况下，将在远程会话中创建作业对象。 不能使用 Receive-PSSession cmdlet 获取作业结果。 请改用 Connect-PSSession cmdlet 连接到会话，然后使用 Invoke-Command cmdlet 在会话中运行 Receive-Job 命令。

如果包含正在运行的作业的会话断开连接后又重新连接，则原始作业对象仅在作业断开连接后又重新连接到同一会话时才可重新使用，而且用于重新连接的命令将不指定新的作业名称。 如果会话重新连接到其他客户端会话或者指定了新的作业名称，PowerShell 将为新会话创建一个新的作业对象。

断开 PSSession 时，会话状态为“已断开连接”，可用性为“无”。

• 状态属性的值相对于当前会话。 “已断开连接”的值表示 PSSession 未连接到当前会话。 但是，这并不意味着 PSSession 已与所有会话断开连接。 它可能连接到另一个会话。 若要确定是否可以连接或重新连接到该会话，请使用 Disconnected 属性。
• 可用性的值为“无”，指示可连接会话。 “忙碌”值表示无法连接到 PSSession，因为它已连接到另一个会话。
• 有关会话状态属性的值的详细信息，请参阅 RunspaceState。
• 有关会话可用性属性的值的详细信息，请参阅RunspaceAvailability。

相关链接

• about_PSSessions
• about_Remote
• about_Remote_Disconnected_Sessions
• about_Session_Configurations
• Connect-PSSession
• Enter-PSSession
• Exit-PSSession
• Get-PSSession
• Invoke-Command
• New-PSSession
• New-PSSessionOption
• New-PSTransportOption
• Remove-PSSession