Receive-PSSession
切断されたセッションのコマンドの結果を取得します。
構文
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>]説明
このコマンドレットは、Windows プラットフォームでのみ使用できます。
このコマンドレットは Receive-PSSession 、切断された PowerShell セッション (PSSession) で実行されているコマンドの結果を取得します。 セッションが現在接続されている場合は、 Receive-PSSession セッションが切断されたときに実行されていたコマンドの結果を取得します。 セッションがまだ切断されている場合は、 Receive-PSSession セッションに接続し、中断されたすべてのコマンドを再開し、セッションで実行されているコマンドの結果を取得します。
このコマンドレットは、PowerShell 3.0 で導入されました。
コマンドの他に、またはコマンドの代わりに a をConnect-PSSession使用Receive-PSSessionできます。
Receive-PSSession は、他のセッションまたは他のコンピューターで開始された切断または再接続されたセッションに接続できます。
Receive-PSSessionは、コマンドレットまたはInvoke-Command InDisconnectedSession パラメーターを使用してDisconnect-PSSession意図的に切断された PSSession で動作します。 または、ネットワークの中断によって意図せず切断されました。
コマンドレットを Receive-PSSession 使用して、コマンドが実行または中断されていないセッションに接続する場合は、 Receive-PSSession セッションに接続しますが、出力やエラーは返されません。
切断されたセッション機能の詳細については、「about_Remote_Disconnected_Sessions」を参照してください。
一部の例では、スプラッティングを使用して行の長さを減らし、読みやすさを向上させます。 詳細については、「about_Splatting」を参照してください。
例
例 1: PSSession に接続する
次の使用例は、リモート コンピューター上のセッションに接続し、セッションで実行されているコマンドの結果を取得します。
Receive-PSSession -ComputerName Server01 -Name ITTaskComputerName Receive-PSSession パラメーターを使用してリモート コンピューターを指定します。 Name パラメーターは、Server01 コンピューター上の ITTask セッションを識別します。 この例では、ITTask セッションで実行されていたコマンドの結果を取得します。
コマンドは OutTarget パラメーターを使用しないため、結果はコマンド ラインに表示されます。
例 2: 切断されたセッションのすべてのコマンドの結果を取得する
この例では、2 台のリモート コンピューター上のすべての切断されたセッションで実行されているすべてのコマンドの結果を取得します。
セッションが切断されていない場合、またはコマンドを実行していない場合は、セッションに接続せず、 Receive-PSSession 出力やエラーは返されません。
Get-PSSession -ComputerName Server01, Server02 | Receive-PSSessionGet-PSSessionは ComputerName パラメーターを使用してリモート コンピューターを指定します。 オブジェクトはパイプライン Receive-PSSessionの下に送信されます。
例 3: セッションで実行されているスクリプトの結果を取得する
この例では、コマンドレットを Receive-PSSession 使用して、リモート コンピューターのセッションで実行されていたスクリプトの結果を取得します。
$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 パラメーターと Name パラメーターを使用して、切断されたセッションを識別します。
OutTarget パラメーターと Job の値を使用して、結果をジョブとして返すように指示Receive-PSSessionします。 JobName パラメーターは、再接続されたセッション内のジョブの名前を指定します。
Credential パラメーターは、Receive-PSSessiondoメイン 管理者のアクセス許可を使用してコマンドを実行します。
出力は、現在のセッションでジョブとして結果を返したことを Receive-PSSession 示しています。 ジョブの結果を取得するには、コマンドを Receive-Job 使用します
例 4: ネットワークの停止後に結果を取得する
この例では、 Receive-PSSession ネットワークの停止によってセッション接続が中断された後に、コマンドレットを使用してジョブの結果を取得します。 PowerShell は、次の 4 分間に 1 秒に 1 回セッションの再接続を自動的に試行し、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 、Server01 コンピューター上にセッションを作成し、そのセッションを変数に $s 保存します。 変数には $s 、 状態 が開き、 可用性 が使用可能であることが表示されます。 これらの値は、セッションに接続していること、およびセッションでコマンドを実行できることを示します。
コマンドレットは Invoke-Command 、変数内のセッションでスクリプトを $s 実行します。 スクリプトの実行とデータの返しが開始されますが、セッションを中断するネットワーク障害が発生します。 ユーザーはセッションを終了し、ローカル コンピューターを再起動する必要があります。
コンピューターが再起動すると、ユーザーは PowerShell を起動し、Server01 コンピューターでセッションを取得するコマンドを実行 Get-PSSession します。 出力は、AD セッションが Server01 コンピューターにまだ存在することを示しています。 状態は、AD セッションが切断されていることを示します。 可用性の値 None は、セッションがクライアント セッションに接続されていないことを示します。
コマンドレットは Receive-PSSession AD セッションに再接続し、セッションで実行されたスクリプトの結果を取得します。 このコマンドは OutTarget パラメーターを使用して、ADJob という名前のジョブで結果を要求します。 このコマンドはジョブ オブジェクトを返し、出力はスクリプトがまだ実行されていることを示します。
このGet-PSSessionコマンドレットは、ジョブの状態をチェックするために使用されます。 出力は、コマンドレットが Receive-PSSession AD セッションに再接続されたことを確認します。これで、コマンドが開き、使用できるようになります。 そして、スクリプトは実行を再開し、スクリプトの結果を取得しています。
例 5: 切断されたセッションに再接続する
この例では、コマンドレットを Receive-PSSession 使用して、意図的に切断されたセッションに再接続し、セッションで実行されていたジョブの結果を取得します。
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 、3 台のリモート コンピューターでスクリプトを実行します。 スクリプトは複数のデータベースからデータを収集して集計するため、多くの場合、スクリプトが完了するまでに時間がかかります。 このコマンドでは、スクリプトを 開始し、すぐにセッションを切断する InDisconnectedSession パラメーターを使用します。 SessionOption パラメーターは、切断されたセッションの IdleTimeout 値を拡張します。 切断されたセッションは、切断された時点からアイドル状態と見なされます。 コマンドが完了し、セッションに再接続できるように、アイドルタイムアウトを十分な長さに設定することが重要です。 IdleTimeout は、PSSession を作成し、そこから切断したときにのみ変更する場合にのみ設定できます。 PSSession に接続するとき、またはその結果を受信するときに IdleTimeout 値を変更することはできません。 コマンドを実行すると、ユーザーは PowerShell を終了し、コンピューターを閉じます。
翌日、ユーザーは Windows を再開し、PowerShell を起動し、スクリプトが実行されていたセッションを取得するために使用 Get-PSSession します。 このコマンドは、コンピューター名、セッション名、およびセッション構成の名前によってセッションを識別し、セッションを変数に $s 保存します。 変数の $s 値が表示され、セッションが切断されているがビジー状態になっていないことが示されます。
コマンドレットは Receive-PSSession 変数内 $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 、Server01 コンピューターにテスト セッションを作成します。 このコマンドでは、セッションが $s 変数に保存されます。
コマンドレットは Invoke-Command 、変数内のセッションでコマンドを $s 実行します。 このコマンドでは、AsJob パラメーターを使用してコマンドをジョブとして実行し、現在のセッションにジョブ オブジェクトを作成します。
このコマンドは、変数に保存されているジョブ オブジェクトを $j 返します。 この変数には $j 、ジョブ オブジェクトが表示されます。
変数内の $s セッション オブジェクトがパイプラインの下に Disconnect-PSSession 送信され、セッションが切断されます。
$j変数が表示され、変数内のジョブ オブジェクトを切断した結果が$j表示されます。 ジョブの状態が切断されました。
変数 Receive-Job 内のジョブで $j 実行されます。 出力は、ジョブがセッションの前に出力を返し始め、ジョブが切断されたことを示しています。
コマンドレットは Connect-PSSession 、同じクライアント セッションで実行されます。 このコマンドは、Server01 コンピューター上のテスト セッションに再接続し、そのセッションを変数に $s2 保存します。
このコマンドレットは Receive-PSSession 、セッションで実行されていたジョブの結果を取得します。 コマンドは同じセッションで実行されるため、 Receive-PSSession 既定で結果をジョブとして返し、同じジョブ オブジェクトを再利用します。 このコマンドは、ジョブを変数に $j2 保存します。 コマンドレットは Receive-Job 、変数内のジョブの結果を $j 取得します。
パラメーター
-AllowRedirection
このコマンドレットによって、代替の Uniform Resource Identifier (URI) へのこの接続のリダイレクトが許可されることを示します。
ConnectionURI パラメーターを使用すると、リモート宛先は別の URI にリダイレクトする命令を返すことができます。 既定では、PowerShell は接続をリダイレクトしませんが、このパラメーターを使用して接続をリダイレクトできます。
MaximumConnectionRedirectionCount セッション オプションの値を変更することで、接続がリダイレクトされる回数を制限することもできます。 コマンドレットの MaximumRedirection パラメーターを New-PSSessionOption 使用するか、基本設定変数の MaximumConnectionRedirectionCount プロパティを $PSSessionOption 設定します。 既定値は 5 です。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ApplicationName
アプリケーションを指定します。 このコマンドレットは、指定されたアプリケーションを使用するセッションにのみ接続します。
接続 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
- Digest
- Kerberos
- ネゴシエート
- 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) を指定します。 証明書の拇印を入力します。
証明書は、クライアント証明書ベースの認証で使用されます。 証明書はローカル ユーザー アカウントにのみマップでき、doメイン アカウントでは機能しません。
証明書の拇印を取得するには、PowerShell Cert: ドライブで a またはGet-ChildItemコマンドを使用Get-Itemします。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerName
切断されたセッションが格納されているコンピューターを指定します。 セッションは、サーバー側にあるコンピューター、または接続の受信側に格納されます。 既定値はローカル コンピューターです。
1 台のコンピューターの NetBIOS 名、IP アドレス、または完全修飾 doメイン 名 (FQDN) を入力します。
ワイルドカード文字は使用できません。 ローカル コンピューターを指定するには、コンピューター名、ドット (.) $env:COMPUTERNAME、または localhost を入力します。
| Type: | String |
| Aliases: | Cn |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ConfigurationName
セッション構成の名前を指定します。 このコマンドレットは、指定されたセッション構成を使用するセッションにのみ接続します。
セッション構成の構成名または完全修飾リソース 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
コマンドレットの実行前に確認を求めるメッセージが表示されます。
| 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>
既定値は、次のとおりです。
http://localhost:5985/WSMAN
接続 URI を指定しない場合は、UseSSL、ComputerName、Port、および ApplicationName パラメーターを使用して、接続 URI の値を指定できます。
URI のトランスポート セグメントの有効な値は、HTTP と HTTPS です。 トランスポート セグメントで接続 URI を指定してもポートを指定しない場合、セッションは標準ポート (HTTP の場合は 80、HTTPS の場合は 443) で作成されます。 PowerShell リモート処理に既定のポートを使用するには、HTTP の場合はポート 5985、HTTPS には 5986 を指定します。
宛先コンピューターが接続を別の URI にリダイレクトする場合、コマンドで AllowRedirection パラメーターを使用しない限り、PowerShell はリダイレクトを禁止します。
| 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 や Doメイン01\User01 などのユーザー名を入力するか、コマンドレットによって生成された PSCredential オブジェクトをGet-Credential入力します。 ユーザー名を入力すると、パスワードの入力を求められます。
資格情報は PSCredential オブジェクトに格納され、パスワードは SecureString として格納されます。
Note
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 は、ローカル コンピューターまたはリモート コンピューター上の PSSession を一意に識別する GUID です。 インスタンス ID は、PSSession の InstanceID プロパティに格納されます。
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-JobName
返されるジョブのフレンドリ名を Receive-PSSession 指定します。
Receive-PSSessionは、OutTarget パラメーターの値が Job であるか、切断されたセッションで実行されているジョブが現在のセッションで開始された場合にジョブを返します。
切断されたセッションで実行されているジョブが現在のセッションで開始された場合、PowerShell はセッション内の元のジョブ オブジェクトを再利用し、JobName パラメーターの値を無視します。
切断されたセッションで実行されているジョブが別のセッションで開始された場合、PowerShell は新しいジョブ オブジェクトを作成します。 通常は既定の名前を使用ますが、このパラメータを使用して名前を変更することもできます。
OutTarget パラメーターの既定値または明示的な値が Job でない場合、コマンドは成功しますが、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 パラメーターの既定値は Host です。 切断されたセッションで受信されているコマンドが現在のセッションで開始された場合、OutTarget パラメーターの既定値は、コマンドが開始された形式です。 コマンドがジョブとして開始された場合、既定ではジョブとして返されます。 それ以外の場合は、既定でホスト プログラムに返されます。
ホスト プログラムは通常、返されたオブジェクトを直ちにコマンド ラインに返します。ただし、この動作は変更することができます。
| Type: | OutTarget |
| Accepted values: | Default, Host, Job |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Port
セッションへの再接続に使用するリモート コンピューターのネットワーク ポートを指定します。 リモート コンピューターに接続するには、接続で使用されるポートをリッスンしている必要があります。 既定のポートは、HTTP の WinRM ポートである 5985 と、HTTPS の WinRM ポートである 5986 です。
代替ポートを使用する前に、そのポートをリッスンするようにリモート コンピューター上の WinRM リスナーを構成する必要があります。 リスナーを構成するには、PowerShell プロンプトで次の 2 つのコマンドを入力します。
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
セッションの詳細オプションを指定します。 コマンドレットを使用してNew-PSSessionOption作成した SessionOption オブジェクトや、キーがセッション オプション名で値がセッション オプション値であるハッシュ テーブルを入力します。
オプションの既定値は、設定されている場合、基本設定変数の $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
このコマンドレットが Ssl (Secure Sockets Layer) プロトコルを使用して切断されたセッションに接続することを示します。 既定では、SSL は使用されません。
WS-Management は、ネットワーク経由で送信されるすべての PowerShell コンテンツを暗号化します。 UseSSL は、HTTP 接続ではなく HTTPS 接続を介してデータを送信する追加の保護です。
このパラメーターを使用していて、コマンドに使用されているポートで SSL を使用できない場合、コマンドは失敗します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 コマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
コマンドレットから返されたオブジェクトなど、セッション オブジェクトをこのコマンドレットに Get-PSSession パイプできます。
このコマンドレットにセッション ID をパイプできます。
このコマンドレットでは、セッションのインスタンス ID をパイプ処理できます。
このコマンドレットにセッション名をパイプできます。
出力
OutTarget パラメーターの値または既定値の場合はJob、Receive-PSSessionジョブ オブジェクトを返します。
このコマンドレットは、切断されたセッションで実行されたコマンド (ある場合) の結果を返します。
メモ
PowerShell には、次のエイリアスが Receive-PSSession含まれています。
- すべてのプラットフォーム:
rcsn
このコマンドレットは、Windows プラットフォームでのみ使用できます。
Receive-PSSession は、切断されたセッションからのみ結果を取得します。 切断して再接続できるのは、PowerShell 3.0 以降のバージョンを実行するコンピューターに接続されている、または終了するセッションだけです。
切断されたセッションで実行されていたコマンドで結果が生成されなかった場合、または結果が既に別のセッションに返された場合、 Receive-PSSession 出力は生成されません。
セッションの出力バッファリング モードは、セッションが切断されたときにセッション内のコマンドが出力を管理する方法を決定します。 セッションの OutputBufferingMode オプションの値が Drop で、出力バッファーがいっぱいになると、コマンドは出力の削除を開始します。 Receive-PSSession は、この出力を回復できません。 出力バッファリング モード オプションの詳細については、New-PSSessionOption コマンドレットと New-PSTransportOption コマンドレットのヘルプ記事を参照してください。
PSSession に接続したり、結果を受け取ったりするときに、PSSession のアイドル タイムアウト値を変更することはできません。 の SessionOption パラメーターは、IdleTimeout 値を持つ SessionOption オブジェクトを受け取ります。Receive-PSSession ただし、SessionOption オブジェクトの IdleTimeout 値と変数の $PSSessionOption IdleTimeout 値は、PSSession に接続するとき、または結果を受信するときに無視されます。
- PSSession の作成時、または
Invoke-Commandコマンドレットを使用New-PSSessionして PSSession から切断するときに、PSSession のアイドルタイムアウトを設定および変更できます。 - PSSession の IdleTimeout プロパティは、切断されたセッションがリモート コンピューターメイン保持されている期間を決定するため、切断されたセッションにとって重要です。 セッションが切断されると、その時点からアイドル状態であると判断されます。これは、そのセッションでコマンドを実行している場合であっても同じです。
コマンドレットの AsJob パラメーターInvoke-Commandを使用してリモート セッションでジョブを開始すると、ジョブがリモート セッションで実行されている場合でも、ジョブ オブジェクトが現在のセッションに作成されます。 リモート セッションを切断すると、現在のセッションのジョブ オブジェクトがジョブから切断されます。 ジョブ オブジェクトには、返された結果が含まれていますが、切断されたセッションでジョブから新しい結果を受け取りません。
実行中のジョブを含むセッションに別のクライアントが接続した場合、元のセッションの元のジョブ オブジェクトに配信された結果は、新しく接続されたセッションでは使用できません。 再接続したセッションでは、元のジョブ オブジェクトに配信されなかった結果のみ利用できます。
同様に、セッションでスクリプトを開始してからセッションから切断した場合、切断前にスクリプトがセッションに配信した結果は、セッションに接続する別のクライアントでは使用できません。
切断するセッションでデータが失われるのを防ぐには、コマンドレットの InDisconnectedSession パラメーターを Invoke-Command 使用します。 このパラメーターは現在のセッションに結果が返されないようにするものであるため、セッションに再接続した時点で結果がすべて利用できるようになります。
コマンドレットを使用してリモート セッションでコマンドを Invoke-Command 実行することで、 Start-Job データの損失を防ぐこともできます。 この場合には、リモート セッションでジョブ オブジェクトが作成されます。 コマンドレットを使用してジョブの Receive-PSSession 結果を取得することはできません。 代わりに、コマンドレットを Connect-PSSession 使用してセッションに接続し、コマンドレットを Invoke-Command 使用してセッションでコマンドを Receive-Job 実行します。
実行中のジョブを含むセッションが切断されてから再接続されると、元のジョブ オブジェクトは、ジョブが切断されて同じセッションに再接続され、再接続するコマンドで新しいジョブ名が指定されていない場合にのみ再利用されます。 セッションが別のクライアント セッションに再接続されるか、新しいジョブ名が指定されている場合、PowerShell は新しいセッションの新しいジョブ オブジェクトを作成します。
PSSession を切断すると、セッション状態は切断され、可用性は None になります。
- State プロパティの値は、現在のセッションに対する相対値です。 Disconnected の値は、 PSSession が現在のセッションに接続されていないことを意味します。 ただし、PSSession がすべてのセッションから切断されているわけではありません。 別のセッションに接続されている可能性があるためです。 セッションに接続できるか再接続できるかを確認するには、Availability プロパティを使用します。
- 可用性の値 None は、セッションに接続できることを示します。 [ビジー] の値は、別のセッションに 接続されているため、PSSession に接続できないことを示します。
- セッションの State プロパティの値の詳細については、「RunspaceState」を参照してください。
- セッションの Availability プロパティの値の詳細については、「RunspaceAvailability」を参照してください。
関連リンク
PowerShell
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示