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

説明

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

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

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

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

出力は、コマンドが成功したことを示しています。 セッションの状態Opened可用性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 取得することを示しています。 セッションの状態Opened次で、可用性Available.

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

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

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

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

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

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

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

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

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

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

このコマンドレットで、代替 URI へのこの接続のリダイレクトを許可することを示します。

ConnectionURI パラメーターを使用すると、リモート宛先は別の URI にリダイレクトする命令を返すことができます。 既定では、PowerShell は接続をリダイレクトしませんが、このパラメーターを使用して接続のリダイレクトを許可できます。

MaximumConnectionRedirectionCount セッション オプションの値を変更することで、接続がリダイレクトされる回数を制限することもできます。 コマンドレットの MaximumRedirection パラメーターをNew-PSSessionOption使用するか、$PSSessionOption基本設定変数の MaximumConnectionRedirectionCount プロパティを設定します。 既定値は 5 です。

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

切断されたセッションに再接続するためにコマンドでユーザー資格情報を認証するために使用されるメカニズムを指定します。 このパラメーターの有効値は、次のとおりです。

  • Default
  • Basic
  • Credssp
  • Digest
  • Kerberos
  • Negotiate
  • NegotiateWithImplicitCredential

既定値は Default です。

このパラメーターの値の詳細については、「AuthenticationMechanism 列挙型」を参照してください

注意

ユーザーの資格情報が認証されるリモート コンピューターに渡される資格情報セキュリティ サポート プロバイダー (CredSSP) 認証は、リモート ネットワーク共有へのアクセスなど、複数のリソースで認証を必要とするコマンド用に設計されています。 このメカニズムを使用すると、リモート操作のセキュリティ リスクが高まります。 リモート コンピューターのセキュリティが低下している場合は、そのリモート コンピューターに渡される資格情報を使用してネットワーク セッションが制御される場合があります。

Type:AuthenticationMechanism
Accepted values:Default, Basic, Negotiate, NegotiateWithImplicitCredential, Credssp, Digest, Kerberos
Position:Named
Default value:None
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

切断されたセッションが格納されているコンピューターを指定します。 セッションは、サーバー側または接続の受信側にあるコンピューターに格納されます。 既定値はローカル コンピューターです。

コンピューターの NetBIOS 名、IP アドレス、または完全修飾ドメイン名を入力します。 ワイルドカード文字は使用できません。 ローカル コンピューターを指定するには、コンピューター名または localhostドット (.) を入力します。

Type:String[]
Aliases:Cn
Position:Named
Default value:None
Required:True
Accept pipeline input:False
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 パラメーターとポート パラメーターを使用して接続 URI 値を指定できます。

URI のトランスポート セグメントの有効な値は、HTTP と HTTPS です。 トランスポート セグメントで接続 URI を指定したが、ポートを指定しない場合、セッションは標準ポート 80 (HTTP 用と 443 HTTPS 用) で作成されます。 PowerShell リモート処理に既定のポートを使用するには、HTTP または 5986 HTTPS のポート5985を指定します。

宛先コンピューターが接続を別の URI にリダイレクトする場合、コマンドで AllowRedirection パラメーターを使用しない限り、PowerShell はリダイレクトを禁止します。

Type:Uri[]
Aliases:URI, CU
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Credential

切断されたセッションに接続するためのアクセス許可を持つユーザー アカウントを指定します。 既定値は現在のユーザーです。

ユーザー名を入力するか、User01コマンドレットDomain01\User01によってGet-Credential生成された PSCredential オブジェクトを入力します。 ユーザー名を入力すると、パスワードの入力を求められます。

資格情報は 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 は、PSSessionInstanceID プロパティに格納されます。

Type:Guid[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

切断されたセッションのフレンドリ名を指定します。

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

-Port

セッションに再接続するときに使用するリモート コンピューターのネットワーク ポートを指定します。 リモート コンピューターに接続するには、リモート コンピューターで、接続に使用されるポートをリッスンすることが必要です。 既定のポートは 5985、HTTP の WinRM ポートであり 5986、HTTPS の WinRM ポートです。

代替ポートを使用する前に、そのポートでリッスンするようにリモート コンピューター上の 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

-ThrottleLimit

このコマンドを実行するために確立できる最大コンカレント接続数を指定します。 このパラメーターを省略するか、値 0を入力すると、 32既定値である 、が使用されます。

スロットル制限は現在のコマンドのみに適用され、セッションまたはコンピューターには適用されません。

Type:Int32
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:None
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

入力

PSSession

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

出力

PSSession

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

メモ

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

  • Windows の場合:

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

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

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

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

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

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

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

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

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

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

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