Get-PSSession

ローカル コンピューターとリモート コンピューター上の PowerShell セッションを取得します。

構文

Name (既定)

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

ComputerName

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

ComputerInstanceId

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

ConnectionUri

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

ConnectionUriInstanceId

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

VMNameInstanceId

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

ContainerId

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

ContainerIdInstanceId

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

VMId

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

VMIdInstanceId

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

VMName

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

InstanceId

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

Id

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

説明

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

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

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

Name、Id、InstanceId、State、ApplicationName、ConfigurationName などのフィルター 処理パラメーターを使用して、Get-PSSession返されるセッションの中から選択します。

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

Note

Windows PowerShell 2.0 では、パラメーターを指定せずに、Get-PSSessionは現在のセッションで作成されたすべてのセッションを取得します。 ComputerName パラメーターは、現在のセッションで作成されたセッションを取得し、指定されたコンピューターに接続します。

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

例

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

Get-PSSession

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

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

Get-PSSession -ComputerName "localhost"

このコマンドは、ローカル コンピューターに接続されている PSSession を取得します。 ローカル コンピューターを示すには、コンピューター名、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 コンピューターに接続されている PSSession を取得します。

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

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

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

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

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

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

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

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 を削除する方法を示します。

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

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

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

例 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 セッションを返したことを示しています。 セッションが切断され、 可用性 が Noneされ、使用されていないことを示します。

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

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

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

Get-PSSession -Id 2

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

パラメーター

-AllowRedirection

このコマンドレットによって、代替の Uniform Resource Identifier (URI) へのこの接続のリダイレクトが許可されることを示します。 既定では、PowerShell は接続をリダイレクトしません。

このパラメーターは、Get-PSSession パラメーターを使用して コマンドを実行するように作成される一時接続を構成します。

このパラメーターは、Windows PowerShell 3.0 で導入されました。

パラメーターのプロパティ

型:SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ConnectionUriInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ConnectionUri
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ApplicationName

アプリケーションの名前を指定します。 このコマンドレットは、指定されたアプリケーションを使用するセッションにのみ接続します。

接続 URI のアプリケーション名セグメントを入力します。 たとえば、次の接続 URI では、アプリケーション名は WSMan: http://localhost:5985/WSMANです。 セッションのアプリケーション名は、セッションの Runspace.ConnectionInfo.AppName プロパティに格納されます。

このパラメーターの値は、セッションの選択とフィルター処理に使用されます。 セッションで使用されるアプリケーションは変更されません。

パラメーターのプロパティ

型:String
規定値:All sessions
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ComputerInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ComputerName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Authentication

Get-PSSession コマンドが実行されるセッションの資格情報を認証するために使用されるメカニズムを指定します。

このパラメーターは、Get-PSSession パラメーターまたは ConnectionUri パラメーターを使用して コマンドを実行するように作成される一時的な接続を構成します。

このパラメーターに使用できる値は次のとおりです。

  • Default
  • Basic
  • CredSSP
  • Digest
  • Kerberos
  • Negotiate
  • NegotiateWithImplicitCredential。

既定値は Default です。

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

Caution

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

このパラメーターは、Windows PowerShell 3.0 で導入されました。

パラメーターのプロパティ

型:AuthenticationMechanism
規定値:Default
指定可能な値:Default, Basic, Negotiate, NegotiateWithImplicitCredential, Credssp, Digest, Kerberos
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ComputerInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ComputerName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ConnectionUriInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ConnectionUri
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-CertificateThumbprint

Get-PSSession コマンドを実行するセッションを作成するアクセス許可を持つユーザー アカウントのデジタル公開キー証明書 (X509) を指定します。 証明書の拇印を入力します。

このパラメーターは、Get-PSSession パラメーターまたは ConnectionUri パラメーターを使用して コマンドを実行するように作成される一時的な接続を構成します。

証明書は、クライアント証明書ベースの認証で使用されます。 これらはローカル ユーザー アカウントにのみマップできます。ドメイン アカウントでは機能しません。

証明書の拇印を取得するには、PowerShell Get-Item ドライブで Get-ChildItem または Cert: コマンドを使用します。

このパラメーターは、Windows PowerShell 3.0 で導入されました。

パラメーターのプロパティ

型:String
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ComputerInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ComputerName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ConnectionUriInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ConnectionUri
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ComputerName

コンピューターの名前の配列を指定します。 指定したコンピューターに接続するセッションを取得します。 ワイルドカード文字は使用できません。 既定値はありません。

Windows PowerShell 3.0 以降では、PSSession オブジェクトは、各接続のリモート 側のコンピューターに格納されます。 指定したコンピューターでセッションを取得するために、PowerShell は各コンピューターへの一時的な接続を作成し、 Get-PSSession コマンドを実行します。

1 台以上のコンピューターの NetBIOS 名、IP アドレス、または完全修飾ドメイン名を入力します。 ローカル コンピューターを指定するには、コンピューター名、localhost、またはドット (.) を入力します。

Note

このパラメーターは、PowerShell 3.0 以降のバージョンの PowerShell Windows実行されているコンピューターからのみセッションを取得します。 以前のバージョンではセッションは格納されません。

パラメーターのプロパティ

型:

String[]

規定値:None
ワイルドカードのサポート:False
DontShow:False
エイリアス:Cn

パラメーター セット

ComputerInstanceId
配置:0
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ComputerName
配置:0
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-ConfigurationName

構成の名前を指定します。 このコマンドレットは、指定されたセッション構成を使用するセッションにのみ取得されます。

セッション構成の構成名または完全修飾リソース URI を入力します。 構成名のみを指定すると、次のスキーマ URI が先頭に付加されます: http://schemas.microsoft.com/powershell。 セッションの構成名は、セッションの ConfigurationName プロパティに格納されます。

このパラメーターの値は、セッションの選択とフィルター処理に使用されます。 セッションで使用されるセッション構成は変更されません。

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

パラメーターのプロパティ

型:String
規定値:All sessions
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ComputerInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ComputerName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ConnectionUriInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ConnectionUri
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ContainerId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ContainerIdInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
VMId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
VMIdInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
VMName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
VMNameInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-ConnectionUri

Get-PSSession コマンドが実行される一時セッションの接続エンドポイントを定義する URI を指定します。 URI は完全修飾されている必要があります。

このパラメーターは、Get-PSSession パラメーターを使用して コマンドを実行するように作成される一時接続を構成します。

この文字列の形式は次のとおりです。

<Transport>://<ComputerName>:<Port\>/<ApplicationName>

既定値は http://localhost:5985/WSMAN です。

ConnectionUri を指定しない場合は、UseSSL、ComputerName、Port、および ApplicationName パラメーターを使用して ConnectionURI 値を指定できます。 URI のトランスポート セグメントの有効な値は、HTTP と HTTPS です。 トランスポート セグメントで接続 URI を指定してもポートを指定しない場合、セッションは標準ポート (HTTP の場合は 80、HTTPS の場合は 443) で作成されます。 PowerShell リモート処理に既定のポートを使用するには、HTTP のポート 5985 または HTTPS の 5986 を指定します。

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

このパラメーターは、Windows PowerShell 3.0 で導入されました。

このパラメーターは、PowerShell 3.0 以降のバージョンの Windows PowerShell Windows実行されているコンピューターからのみセッションを取得します。 以前のバージョンではセッションは格納されません。

パラメーターのプロパティ

型:

Uri[]

規定値:Http://localhost:5985/WSMAN
ワイルドカードのサポート:False
DontShow:False
エイリアス:URI, CU

パラメーター セット

ConnectionUriInstanceId
配置:0
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ConnectionUri
配置:0
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-ContainerId

コンテナーの ID の配列を指定します。 このコマンドレットは、指定された各コンテナーとの対話型セッションを開始します。 docker ps コマンドを使用して、コンテナー ID の一覧を取得します。 詳細については、docker ps コマンドのヘルプを参照してください。

パラメーターのプロパティ

型:

String[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ContainerId
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ContainerIdInstanceId
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Credential

ユーザー資格情報を指定します。 このコマンドレットは、指定したユーザーのアクセス許可を持つコマンドを実行します。 リモート コンピューターに接続し、 Get-PSSession コマンドを実行するアクセス許可を持つユーザー アカウントを指定します。 既定値は現在のユーザーです。

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

資格情報は PSCredential オブジェクトに格納され、パスワードは SecureStringとして格納されます。

Note

SecureString データ保護についての詳細は、「SecureString はどのくらい安全ですか? 」を参照してください。.

このパラメーターは、Get-PSSession パラメーターまたは ConnectionUri パラメーターを使用して コマンドを実行するように作成された一時接続に対して構成します。

このパラメーターは、Windows PowerShell 3.0 で導入されました。

パラメーターのプロパティ

型:PSCredential
規定値:Current user
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ComputerInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ComputerName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ConnectionUriInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ConnectionUri
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Id

セッション ID の配列を指定します。 このコマンドレットは、指定された ID を持つセッションのみを取得します。 1 つ以上の ID をコンマで区切って入力するか、範囲演算子 (..) を使用して ID の範囲を指定します。 Id パラメーターを ComputerName パラメーターと共に使用することはできません。

ID は、現在のセッションのユーザー管理セッションを一意に識別する整数です。 InstanceId よりも覚えて入力する方が簡単ですが、現在のセッション内でのみ一意です。 セッションの ID は、セッションの Id プロパティに格納されます。

パラメーターのプロパティ

型:

Int32[]

規定値:All sessions
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

Id
配置:0
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-InstanceId

セッションのインスタンス ID の配列を指定します。 このコマンドレットは、指定されたインスタンス ID を持つセッションのみを取得します。

インスタンス ID は、ローカル コンピューターまたはリモート コンピューター上のセッションを一意に識別する GUID です。 PowerShell で複数のセッションが実行されている場合でも、 InstanceId は一意です。

セッションのインスタンス ID は、セッションの InstanceId プロパティに格納されます。

パラメーターのプロパティ

型:

Guid[]

規定値:All sessions
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ComputerInstanceId
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ConnectionUriInstanceId
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ContainerIdInstanceId
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
VMIdInstanceId
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
VMNameInstanceId
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
InstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Name

セッション名の配列を指定します。 このコマンドレットは、指定されたフレンドリ名を持つセッションのみを取得します。 ワイルドカード文字を使用できます。

セッションのフレンドリ名は、セッションの Name プロパティに格納されます。

パラメーターのプロパティ

型:

String[]

規定値:All sessions
ワイルドカードのサポート:True
DontShow:False

パラメーター セット

Name
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ComputerName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ConnectionUri
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
ContainerId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
VMId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
VMName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-Port

Get-PSSession コマンドを実行する一時的な接続に使用される、指定したネットワーク ポートを指定します。 リモートコンピューターに接続するには、接続に使用するポートでリモートコンピューターが待機している必要があります。 既定のポートは 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\>

このパラメーターは、Get-PSSession パラメーターまたは ConnectionUri パラメーターを使用して コマンドを実行するように作成された一時接続に対して構成します。

必要な場合を除き、Port パラメーターは使用しないでください。 コマンドで設定された ポート は、コマンドを実行するすべてのコンピューターまたはセッションに適用されます。 代替ポート設定により、コマンドがすべてのコンピューターで実行できなくなる可能性があります。

このパラメーターは、Windows PowerShell 3.0 で導入されました。

パラメーターのプロパティ

型:Int32
規定値:5985, 5986
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ComputerInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ComputerName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-SessionOption

セッションの詳細オプションを指定します。 コマンドレットを使用して作成するなど、New-PSSessionOption オブジェクトを入力するか、キーがセッション オプション名で値がセッション オプション値であるハッシュ テーブルを入力します。

オプションの既定値は、$PSSessionOption 基本設定変数の値 (設定されている場合) によって決まります。 それ以外の場合、既定値はセッション構成で設定されたオプションによって確立されます。

セッション オプションの値は、$PSSessionOption 基本設定変数およびセッション構成で設定されたセッションの既定値よりも優先されます。 ただし、セッション構成で設定された最大値、クォータ、または制限よりも優先されません。

デフォルト値を含むセッション・オプションの説明については、New-PSSessionOptionを参照してください。 $PSSessionOption 基本設定変数の詳細については、about_Preference_Variablesを参照してください。 セッション構成の詳細については、「about_Session_Configurations」を参照してください。

パラメーターのプロパティ

型:PSSessionOption
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ComputerInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ComputerName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ConnectionUriInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ConnectionUri
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-State

セッションの状態を指定します。 このコマンドレットは、指定された状態のセッションのみを取得します。 このパラメーターに使用できる値は、 All、 Opened、 Disconnected、 Closed、および Brokenです。 既定値は All です。

セッション状態の値は、現在のセッションに対する相対値です。 現在のセッションで作成されておらず、現在のセッションに接続されていないセッションは、別のセッションに接続されている場合でも Disconnected 状態になります。

セッションの状態は、セッションの State プロパティに格納されます。

このパラメーターは、Windows PowerShell 3.0 で導入されました。

パラメーターのプロパティ

型:SessionFilterState
規定値:All
指定可能な値:All, Opened, Disconnected, Closed, Broken
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ComputerInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ComputerName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ConnectionUriInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ConnectionUri
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ContainerId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ContainerIdInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
VMId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
VMIdInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
VMName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
VMNameInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ThrottleLimit

Get-PSSession コマンドを実行するために確立できる同時接続の最大数を指定します。 このパラメーターを省略するか、0 (ゼロ) の値を入力すると、既定値の 32が使用されます。 スロットル制限は、セッションまたはコンピューターではなく、現在のコマンドにのみ適用されます。

このパラメーターは、Windows PowerShell 3.0 で導入されました。

パラメーターのプロパティ

型:Int32
規定値:32
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ComputerInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ComputerName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ConnectionUriInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ConnectionUri
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-UseSSL

このコマンドレットが Secure Sockets Layer (SSL) プロトコルを使用して、 Get-PSSession コマンドを実行する接続を確立することを示します。 既定では、SSL は使用されません。 コマンドに使用するポートで SSL が使用できない場合に、このパラメーターを指定すると、コマンドは失敗します。

このパラメーターは、Get-PSSession パラメーターを使用して コマンドを実行するように作成される一時接続を構成します。

このパラメーターは、Windows PowerShell 3.0 で導入されました。

パラメーターのプロパティ

型:SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

ComputerInstanceId
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False
ComputerName
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-VMId

仮想マシンの ID の配列を指定します。 このコマンドレットは、指定された各仮想マシンとの対話型セッションを開始します。 使用可能な仮想マシンを表示するには、次のコマンドを使用します。

Get-VM | Select-Object -Property Name, ID

パラメーターのプロパティ

型:

Guid[]

規定値:None
ワイルドカードのサポート:False
DontShow:False
エイリアス:VMGuid

パラメーター セット

VMId
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
VMIdInstanceId
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-VMName

仮想マシンの名前の配列を指定します。 このコマンドレットは、指定された各仮想マシンとの対話型セッションを開始します。 使用可能な仮想マシンを表示するには、 Get-VM コマンドレットを使用します。

パラメーターのプロパティ

型:

String[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

VMName
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False
VMNameInstanceId
配置:Named
必須:True
パイプラインからの値:False
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

CommonParameters

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

入力

None

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

出力

PSSession

メモ

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

  • すべてのプラットフォーム:

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

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

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

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

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

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

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

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