Get-PSSession

構文

Get-PSSession
   [-Name <String[]>]
   [<CommonParameters>]

Get-PSSession
   [-ComputerName] <String[]>
   [-ApplicationName <String>]
   [-ConfigurationName <String>]
   [-Name <String[]>]
   [-Credential <PSCredential>]
   [-Authentication <AuthenticationMechanism>]
   [-CertificateThumbprint <String>]
   [-Port <Int32>]
   [-UseSSL]
   [-ThrottleLimit <Int32>]
   [-State <SessionFilterState>]
   [-SessionOption <PSSessionOption>]
   [<CommonParameters>]

Get-PSSession
   [-ComputerName] <String[]>
   [-ApplicationName <String>]
   [-ConfigurationName <String>]
   -InstanceId <Guid[]>
   [-Credential <PSCredential>]
   [-Authentication <AuthenticationMechanism>]
   [-CertificateThumbprint <String>]
   [-Port <Int32>]
   [-UseSSL]
   [-ThrottleLimit <Int32>]
   [-State <SessionFilterState>]
   [-SessionOption <PSSessionOption>]
   [<CommonParameters>]

Get-PSSession
   [-ConnectionUri] <Uri[]>
   [-ConfigurationName <String>]
   [-AllowRedirection]
   -InstanceId <Guid[]>
   [-Credential <PSCredential>]
   [-Authentication <AuthenticationMechanism>]
   [-CertificateThumbprint <String>]
   [-ThrottleLimit <Int32>]
   [-State <SessionFilterState>]
   [-SessionOption <PSSessionOption>]
   [<CommonParameters>]

Get-PSSession
   [-ConnectionUri] <Uri[]>
   [-ConfigurationName <String>]
   [-AllowRedirection]
   [-Name <String[]>]
   [-Credential <PSCredential>]
   [-Authentication <AuthenticationMechanism>]
   [-CertificateThumbprint <String>]
   [-ThrottleLimit <Int32>]
   [-State <SessionFilterState>]
   [-SessionOption <PSSessionOption>]
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   [-Name <String[]>]
   [-State <SessionFilterState>]
   -ContainerId <String[]>
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   -InstanceId <Guid[]>
   [-State <SessionFilterState>]
   -ContainerId <String[]>
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   [-Name <String[]>]
   [-State <SessionFilterState>]
   -VMId <Guid[]>
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   -InstanceId <Guid[]>
   [-State <SessionFilterState>]
   -VMId <Guid[]>
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   [-Name <String[]>]
   [-State <SessionFilterState>]
   -VMName <String[]>
   [<CommonParameters>]

Get-PSSession
   [-ConfigurationName <String>]
   -InstanceId <Guid[]>
   [-State <SessionFilterState>]
   -VMName <String[]>
   [<CommonParameters>]

Get-PSSession
   [-InstanceId <Guid[]>]
   [<CommonParameters>]

Get-PSSession
   [-Id] <Int32[]>
   [<CommonParameters>]

説明

Get-PSSession コマンドレットは、ローカル コンピューターとリモート コンピューター上のユーザーが管理する PowerShell セッション (PSSessions) を取得します。

Windows PowerShell 3.0 以降では、セッションは各接続のリモート側のコンピューターに格納されます。 Get-PSSessionの ComputerName または ConnectionUri パラメーターを使用して、ローカル コンピューターまたはリモート コンピューターに接続するセッションを、現在のセッションで作成されていなくても取得できます。

パラメーターがない場合、 Get-PSSession は現在のセッションで作成されたすべてのセッションを取得します。

Name、ID、InstanceID、State、ApplicationName、ConfigurationName などを使用して、Get-PSSessionが返すセッションの中から選択します。

残りのパラメーターを使用して、ComputerName または ConnectionUri パラメーターを使用するときにGet-PSSession コマンドを実行する一時的な接続を構成します。

PowerShell セッションの詳細については、「 about_PSSessions」を参照してください。

例

例 1: 現在のセッションで作成されたセッションを取得する

Get-PSSession

このコマンドは、現在のセッションで作成されたすべての PSSessions を取得します。 このコンピューターに接続しても、他のセッションまたは他のコンピューターで作成された PSSessions は取得されません。

例 2: ローカル コンピューターに接続されているセッションを取得する

Get-PSSession -ComputerName "localhost"

このコマンドは、ローカル コンピューターに接続されている PSSessions を取得します。 ローカル コンピューターを示すには、コンピューター名、localhost、またはドット (.) を入力します。

このコマンドは、別のセッションまたは別のコンピューターで作成された場合でも、ローカル コンピューター上のセッションをすべて返します。

例 3: コンピューターに接続されているセッションを取得する

Get-PSSession -ComputerName "Server02"

Id Name            ComputerName    State         ConfigurationName     Availability
 -- ----            ------------    -----         -----------------     ------------
  2 Session3        Server02       Disconnected  ITTasks                       Busy
  1 ScheduledJobs   Server02       Opened        Microsoft.PowerShell     Available
  3 Test            Server02       Disconnected  Microsoft.PowerShell          Busy

このコマンドは、Server02 コンピューターに接続されている PSSessions を取得します。

このコマンドは、別のセッションまたは別のコンピューターで作成された場合でも、Server02 上のセッションをすべて返します。

出力には、2 つのセッションの Disconnected 状態と Busy 可用性が示されています。 これらのセッション別のセッションで作成されており、現在使用されています。 ScheduledJobs セッション (OpenedおよびAvailable) が現在のセッションに作成されました。

例 4: このコマンドの結果を保存する

New-PSSession -ComputerName Server01, Server02, Server03
$s1, $s2, $s3 = Get-PSSession

この例では、 Get-PSSession コマンドの結果を複数の変数に保存する方法を示します。

最初のコマンドでは、 New-PSSession コマンドレットを使用して、3 台のリモート コンピューターに PSSessions を作成します。

2 番目のコマンドでは、 Get-PSSession コマンドレットを使用して、3 つの PSSessionsionsを取得します。 次に、各 PSSessions を個別の変数に保存します。

PowerShell は、オブジェクトの配列を変数の配列に割り当てると、最初のオブジェクトを最初の変数に、2 番目のオブジェクトを 2 番目の変数に割り当てます。 オブジェクトの数が変数の数よりも多い場合、残りのオブジェクトはすべて配列の最後の変数に割り当てられます。 変数の数がオブジェクトの数よりも多い場合、余分な変数は使用されません。

例 5: インスタンス ID を使用してセッションを削除する

Get-PSSession | Format-Table -Property ComputerName, InstanceID
$s = Get-PSSession -InstanceID a786be29-a6bb-40da-80fb-782c67f7db0f
Remove-PSSession -Session $s

この例では、インスタンス ID を使用して PSSession を取得し、 PSSessionを削除する方法を示します。

最初のコマンドは、現在のセッションで作成されたすべての PSSessions を取得します。 PSSessionsを Format-Table コマンドレットに送信します。このコマンドレットには、各PSSessionの ComputerName プロパティと InstanceID プロパティが表示されます。

2 番目のコマンドでは、Get-PSSession コマンドレットを使用して特定のPSSession を取得し$s変数に保存します。 このコマンドは、 InstanceID パラメーターを使用して、 PSSessionを識別します。

3 番目のコマンドでは、Remove-PSSession コマンドレットを使用して、$s変数のPSSessionを削除します。

例 6: 特定の名前を持つセッションを取得する

この例のコマンドは、特定の名前形式に準拠し、特定のセッション構成を使用するセッションを探して接続します。 このようなコマンドを使用すれば、同僚が開始したタスクのセッションを探して接続し、そのタスクを完了することができます。

Get-PSSession -ComputerName Server02, Server12 -Name BackupJob* -ConfigurationName ITTasks -SessionOption @{OperationTimeout=240000}

Id Name            ComputerName    State         ConfigurationName     Availability
 -- ----            ------------    -----         -----------------     ------------
  3 BackupJob04     Server02        Disconnected        ITTasks                  None

$s = Get-PSSession -ComputerName Server02 -Name BackupJob04 -ConfigurationName ITTasks | Connect-PSSession
$s

Id Name            ComputerName    State         ConfigurationName     Availability
-- ----            ------------    -----         -----------------     ------------
 5 BackupJob04     Server02        Opened        ITTasks                  Available

最初のコマンドは、 BackupJob で始まる名前を持つ Server02 および Server12 リモート コンピューター上のセッションを取得し、 ITTasks セッション構成を使用します。このコマンドでは、 Name パラメーターを使用して名前パターンを指定し、 ConfigurationName パラメーターを使用してセッション構成を指定します。 SessionOption パラメーターの値は、OperationTimeout の値を 240000 ミリ秒 (4 分) に設定するハッシュ テーブルです。 この設定により、コマンドの完了時間が長くなります。 ConfigurationName パラメーターと SessionOption パラメーターを使用して、 Get-PSSession コマンドレットが各コンピューターで実行される一時的なセッションを構成します。出力は、コマンドが BackupJob04 セッションを返したことを示しています。 セッションが切断され、 Availability が Noneされます。これは、セッションが使用されていないことを示します。

2 番目のコマンドでは、 Get-PSSession コマンドレットを使用して BackupJob04 セッションにアクセスし、 Connect-PSSession コマンドレットを使用してセッションに接続します。 このコマンドでは、セッションが $s 変数に保存されます。

3 番目のコマンドは、 $s 変数内のセッションを取得します。 出力は、 Connect-PSSession コマンドが成功したことを示しています。 セッションは Opened 状態であり、使用できます。

例 7: その ID を使用してセッションを取得する

Get-PSSession -Id 2

このコマンドは、ID 2を持つPSSessionを取得します。 ID プロパティの値は現在のセッションでのみ一意であるため、Id パラメーターはローカル コマンドでのみ有効です。

パラメーター

-AllowRedirection

-ApplicationName

-Authentication

-CertificateThumbprint

-ComputerName

-ConfigurationName

-ConnectionUri

-ContainerId

-Credential

-Id

-InstanceId

-Name

-Port

-SessionOption

-State

-ThrottleLimit

-UseSSL

-VMId

-VMName

入力

None

このコマンドレットにオブジェクトをパイプすることはできません。

出力

PSSession

メモ

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

• gsn

• このコマンドレットは、New-PSSession、Enter-PSSession、Invoke-Command コマンドレットを使用して作成されたユーザー管理セッションPSSession オブジェクトなど) を取得します。 PowerShell の起動時に作成されるシステム管理セッションは取得されません。

• Windows PowerShell 3.0 以降では、 PSSession オブジェクトは、サーバー側または接続の受信側にあるコンピューターに格納されます。 ローカル コンピューターまたはリモート コンピューターに格納されているセッションを取得するために、PowerShell は指定されたコンピューターへの一時的なセッションを確立し、セッションでクエリ コマンドを実行します。

• リモート コンピューターに接続するセッションを取得するには、 ComputerName または ConnectionUri パラメーターを使用してリモート コンピューターを指定します。 Get-PSSessionが取得するセッションをフィルター処理するには、Name、ID、InstanceID、および State パラメーターを使用します。 残りのパラメーターを使用して、 Get-PSSession 使用する一時セッションを構成します。

• ComputerName または ConnectionUri パラメーターを使用すると、Get-PSSessionは Windows PowerShell 3.0 以降のバージョンの PowerShell を実行しているコンピューターからのセッションのみを取得します。

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

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

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

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

関連リンク

• Connect-PSSession
• Disconnect-PSSession
• Receive-PSSession
• Enter-PSSession
• Exit-PSSession
• Invoke-Command
• New-PSSession
• Remove-PSSession
• about_PSSessions
• about_Remote