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>]

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

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

ただし、 Connect-PSSession は、壊れたセッションや閉じられたセッション、または Enter-PSSession コマンドレットを使用して開始された対話型セッションに接続できません。 また、セッションを作成したユーザーの資格情報を指定できない限り、他のユーザーが開始したセッションにセッションを接続することはできません。

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

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

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

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

出力は、コマンドが成功したことを示しています。 セッション の状態 は [オープン] で、[ 利用可否の設定 ] は [使用可能] で、セッションでコマンドを実行できることを示します。

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

出力は、コマンドがローカル コンピューター上のバックアップ セッションを取得することを示しています。 セッション の状態 は [オープン] で、[ 可用性 ] は [使用可能] です。

2 番目のコマンドでは、 Get-PSSession コマンドレットを使用して現在のセッションで作成された PSSession オブジェクトを取得し、 Disconnect-PSSession コマンドレットを使用してセッションを切断します。 出力は、バックアップセッションが切断されたことを示しています。 セッション の状態 は [切断] で、[ 可用性 ] は [なし] です。

3 番目のコマンドでは、 Get-PSSession コマンドレットを使用して現在のセッションで作成された PSSession オブジェクトを取得し、 Connect-PSSession コマンドレットを使用してセッションを再接続します。 出力は、バックアップセッションが再接続されたことを示しています。 セッション の状態 は [オープン] で、[ 可用性 ] は [使用可能] です。

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

The administrator starts by creating a sessions on a remote computer and running a script in the session.The first command uses the **New-PSSession** cmdlet to create the ITTask session on the Server01 remote computer. The command uses the *ConfigurationName* parameter to specify the ITTasks session configuration. The command saves the sessions in the $s variable.
PS C:\> $s = New-PSSession -ComputerName Server01 -Name ITTask -ConfigurationName ITTasks

 The second command **Invoke-Command** cmdlet to start a background job in the session in the $s variable. It uses the *FilePath* parameter to run the script in the background job.
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...

The third command uses the Disconnect-PSSession cmdlet to disconnect from the session in the $s variable. The command uses the *OutputBufferingMode* parameter with a value of Drop to prevent the script from being blocked by having to deliver output to the session. It uses the *IdleTimeoutSec* parameter to extend the session time-out to 15 hours.When the command is completed, the administrator locks her computer and goes home for the evening.
PS C:\> Disconnect-PSSession -Session $s -OutputBufferingMode Drop -IdleTimeoutSec 60*60*15
Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 ITTask          Server01        Disconnected  ITTasks               None

Later that evening, the administrator starts her home computer, logs on to the corporate network, and starts Windows PowerShell. The fourth command uses the Get-PSSession cmdlet to get the sessions on the Server01 computer. The command finds the ITTask session.The fifth command uses the **Connect-PSSession** cmdlet to connect to the ITTask session. The command saves the session in the $s variable.
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

The sixth command uses the **Invoke-Command** cmdlet to run a Get-Job command in the session in the $s variable. The output shows that the job finished successfully.The seventh command uses the **Invoke-Command** cmdlet to run a Receive-Job command in the session in the $s variable in the session. The command saves the results in the $BackupSpecs variable.The eighth command uses the **Invoke-Command** cmdlet to runs another script in the session. The command uses the value of the $BackupSpecs variable in the session as input to the script.


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}

The ninth command disconnects from the session in the $s variable.The administrator closes Windows PowerShell and closes the computer. She can reconnect to the session on the next day and check the script status from her work computer.
PS C:\> Disconnect-PSSession -Session $s -OutputBufferingMode Drop -IdleTimeoutSec 60*60*15
Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 1 ITTask          Server01        Disconnected  ITTasks               None

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

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

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

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

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

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

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

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

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

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

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

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

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

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