Connect-PSSession

構文

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>]
       [-Name <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>]
       -InstanceId <Guid[]>
       [-Credential <PSCredential>]
       [-Authentication <AuthenticationMechanism>]
       [-CertificateThumbprint <String>]
       [-Port <Int32>]
       [-UseSSL]
       [-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
       [-ConfigurationName <String>]
       [-ConnectionUri] <Uri[]>
       [-AllowRedirection]
       -InstanceId <Guid[]>
       [-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>]

説明

Connect-PSSession コマンドレットは、切断されたユーザー管理の PowerShell セッション (PSSessions) に再接続します。 これは、Invoke-Command コマンドレットの Disconnect-PSSession コマンドレットまたは InDisconnectedSession パラメーターを使用するなど、意図的に切断されたセッションや、一時的なネットワーク停止などによって意図せずに切断されたセッションで機能します。

Connect-PSSession は、同じユーザーによって開始された切断されたセッションに接続できます。 これには、他のコンピューター上の他のセッションによって開始された、または他のセッションから切断されたものが含まれます。

ただし、 Connect-PSSession は、 Enter-PSSession コマンドレットを使用して開始された、壊れたセッションや閉じたセッション、または対話型セッションに接続できません。 このほか、別のユーザーが開始したセッションには接続できません。ただし、そのセッションを作成したユーザーの資格情報がある場合には、このコマンドレットを使用した再接続が可能です。

切断されたセッション機能の詳細については、「 about_Remote_Disconnected_Sessions」を参照してください。

このコマンドレットは、Windows PowerShell 3.0 で導入されました。

例

例 1: セッションに再接続する

Connect-PSSession -ComputerName Server01 -Name ITTask

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

このコマンドは、Server01 コンピューター上の ITTask セッションに再接続します。

出力は、コマンドが成功したことを示しています。 セッションの State が Opened され、 Availability が Availableされます。これは、セッションでコマンドを実行できることを示します。

例 2: 切断と再接続の影響

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 コマンドレットを使用します。 ComputerName パラメーターがないと、コマンドは現在のセッションで作成されたセッションのみを取得します。

出力は、コマンドがローカル コンピューター上の Backups セッションを取得することを示しています。 セッションの State が Opened され、 Availability が Available。

2 番目のコマンドでは、 Get-PSSession コマンドレットを使用して、現在のセッションで作成された PSSession オブジェクトとセッションを切断する Disconnect-PSSession コマンドレットを取得します。 出力は、 Backups セッションが切断されたことを示しています。 セッションの State が Disconnected され、 Availability が None。

3 番目のコマンドでは、 Get-PSSession コマンドレットを使用して、現在のセッションで作成された PSSession オブジェクトと、セッションを再接続するための Connect-PSSession コマンドレットを取得します。 出力は、 Backups セッションが再接続されたことを示しています。 セッションの State が Opened され、 Availability が Available。

切断されていないセッションで Connect-PSSession コマンドレットを使用する場合、コマンドはセッションに影響せず、エラーも生成しません。

例 3: エンタープライズ シナリオでの一連のコマンド

この一連のコマンドは、エンタープライズ シナリオで Connect-PSSession コマンドレットがどのように使用されるかを示しています。 この例では、システム管理者がリモート コンピューター上のセッションで、実行時間の長いジョブを開始します。 管理者はジョブを開始した後、セッションを切断し、帰宅します。 その日の夕方、管理者はホーム コンピューターにログオンし、ジョブが完了するまで実行されたことを確認します。

管理者は、まずリモート コンピューターでセッションを作成し、セッションでスクリプトを実行します。最初のコマンドでは、 New-PSSession コマンドレットを使用して、Server01 リモート コンピューターに ITTask セッションを作成します。 このコマンドでは、 ConfigurationName パラメーターを使用して、 ITTasks セッション構成を指定します。 このコマンドは、セッションを $s 変数に保存します。

2 番目のコマンド Invoke-Command コマンドレットを使用して、 $s 変数内のセッションでバックグラウンド ジョブを開始します。 FilePath パラメーターを使用して、バックグラウンド ジョブでスクリプトを実行します。

3 番目のコマンドでは、 Disconnect-PSSession コマンドレットを使用して、 $s 変数内のセッションから切断します。 このコマンドでは、 OutputBufferingMode パラメーターと値が Drop を使用して、セッションに出力を配信する必要があるため、スクリプトがブロックされないようにします。 IdleTimeoutSec パラメーターを使用して、セッションタイムアウトを 15 時間に延長します。 コマンドが完了すると、管理者はコンピューターをロックし、夕方に家に帰ります。

その夜、管理者はホーム コンピューターを起動し、企業ネットワークにログオンして、PowerShell を起動します。 4 番目のコマンドでは、 Get-PSSession コマンドレットを使用して Server01 コンピューター上のセッションを取得します。 このコマンドは、 ITTask セッションを検索します。 5 番目のコマンドでは、 Connect-PSSession コマンドレットを使用して、 ITTask セッションに接続します。 このコマンドでは、セッションが $s 変数に保存されます。

6 番目のコマンドでは、Invoke-Command コマンドレットを使用して、$s変数内のセッションでGet-Job コマンドを実行します。 出力は、ジョブが正常に完了したことを示しています。7 番目のコマンドでは、Invoke-Command コマンドレットを使用して、セッション内の $s 変数のセッションでReceive-Job コマンドを実行します。 このコマンドは、結果を $BackupSpecs 変数に保存します。8 番目のコマンドでは、 Invoke-Command コマンドレットを使用してセッションで別のスクリプトを実行します。 このコマンドは、セッション内の $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

9 番目のコマンドは、 $s 変数内のセッションから切断されます。管理者は PowerShell を閉じ、コンピューターを閉じます。 次の日にセッションに再接続し、作業コンピューターからスクリプトの状態を確認できます。

パラメーター

-AllowRedirection

-ApplicationName

-Authentication

-CertificateThumbprint

-ComputerName

-ConfigurationName

-Confirm

-ConnectionUri

-Credential

-Id

-InstanceId

-Name

-Port

-Session

-SessionOption

-ThrottleLimit

-UseSSL

-WhatIf

入力

PSSession

セッション (PSSession) をこのコマンドレットにパイプできます。

出力

PSSession

このコマンドレットは、再接続先のセッションを表すオブジェクトを返します。

メモ

Windows PowerShell には、 Connect-PSSessionの次のエイリアスが含まれています。

• cnsn

• このコマンドレットは、Windows プラットフォームでのみ使用できます。

• Connect-PSSession は、 State プロパティの値が Disconnected である、切断されたセッションにのみ再接続します。 Windows PowerShell 3.0 以降のバージョンを実行するコンピューターに接続されている、または終了するセッションのみを切断して再接続できます。

• 切断されていないセッションで Connect-PSSession を使用した場合、コマンドはセッションに影響せず、エラーも生成しません。

• EnableNetworkAccess パラメーターを使用して作成された対話型トークンを使用した切断されたループバック セッションは、セッションが作成されたコンピューターからのみ再接続できます。 この制約は、悪意のあるアクセスからコンピューターを保護するためのものです。

• PSSession の State プロパティの値は、現在のセッションを基準にしています。 したがって、 Disconnected の値は、 PSSession が現在のセッションに接続されていないことを意味します。 ただし、 PSSession がすべてのセッションから切断されているわけではありません。 別のセッションに接続されている可能性があるためです。 セッションに接続できるか再接続できるかを判断するには、 Availability プロパティを使用します。

  Availability値 None は、セッションに接続できることを示します。 [ビジー] の値は、別のセッションに接続されているためPSSession に接続できないことを示します。

  セッションの State プロパティの値の詳細については、「 RunspaceState 列挙型を参照してください。

  セッションの Availability プロパティの値の詳細については、「 RunspaceAvailability 列挙型を参照してください。

• PSSession に接続するときに、PSSessionのアイドル タイムアウト値を変更することはできません。 Connect-PSSession の SessionOption パラメーターは、IdleTimeout 値を持つ SessionOption オブジェクトを受け取ります。 ただし、SessionOption オブジェクトのIdleTimeout値と$PSSessionOption変数のIdleTimeout値は、PSSessionに接続するときに無視されます。

  PSSessionPSSession を作成する場合、New-PSSessionまたはInvoke-Commandコマンドレットを使用してPSSession から切断するときに、アイドルタイムアウトを設定および変更できます。

  PSSession の IdleTimeout プロパティは、切断されたセッションがリモート コンピューターで維持される期間を決定するため、切断されたセッションにとって重要です。 セッションが切断されると、その時点からアイドル状態であると判断されます。これは、そのセッションでコマンドを実行している場合であっても同じです。

関連リンク

• Disconnect-PSSession
• Enter-PSSession
• Exit-PSSession
• Get-PSSession
• Get-PSSessionConfiguration
• New-PSSession
• New-PSSessionOption
• New-PSSessionOption
• Receive-PSSession
• Register-PSSessionConfiguration
• Remove-PSSession