Remove-PSSession

リファレンス

モジュール:: Microsoft.PowerShell.Core

1 つ以上の PowerShell セッション (PSSessions) を閉じます。

構文

Remove-PSSession
      [-Id] <Int32[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-PSSession
      [-Session] <PSSession[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-PSSession
      -ContainerId <String[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-PSSession
      -VMId <Guid[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-PSSession
      -VMName <String[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-PSSession
      -InstanceId <Guid[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-PSSession
      -Name <String[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-PSSession
      [-ComputerName] <String[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-PSSession コマンドレットは、現在のセッションの PowerShell セッション (PSSessions) を閉じます。 PSSessions で実行されているコマンドをすべて停止し、PSSessionを終了し、PSSessionが使用していたリソースを解放します。 PSSessionがリモートコンピューターに接続されている場合、このコマンドレットはローカルコンピューターとリモートコンピューター間の接続も閉じます。

PSSessionを削除するには、セッションの Name、ComputerName、ID、または InstanceID を入力します。

PSSessionを変数に保存した場合、セッションオブジェクトは変数に残りますが、PSSession の状態は Closed です。

例

例 1: ID でセッションを削除する

Remove-PSSession -Id 1, 2

このコマンドは、ID が1および2されているPSSessionsを削除します。

例 2: 現在のセッションのすべてのセッションを削除する

Get-PSSession | Remove-PSSession
Remove-PSSession -Session (Get-PSSession)
$s = Get-PSSession
Remove-PSSession -Session $s

これらのコマンドにより、現在のセッションのすべての PSSessions が削除されます。これらの 3 つのコマンドの形式は異なっていますが、効果は同じです。

例 3: 名前でセッションを閉じる

$r = Get-PSSession -ComputerName Serv*
$r | Remove-PSSession

これらのコマンドは、Servで始まる名前を持つコンピューターに接続されているPSSessionsを閉じます。

例 4: ポートに接続されているセッションを閉じる

Get-PSSession | where {$_.port -eq 90} | Remove-PSSession

このコマンドは、ポート 90 に接続されている PSSessions を閉じます。このコマンド形式を使用すると、ComputerName、Name、InstanceID、および ID 以外のプロパティでPSSessionsを識別できます。

例 5: インスタンス ID でセッションを閉じる

Get-PSSession | Format-Table ComputerName, InstanceID  -AutoSize

ComputerName InstanceId
------------ ----------------
Server01     875d231b-2788-4f36-9f67-2e50d63bb82a
localhost    c065ffa0-02c4-406e-84a3-dacb0d677868
Server02     4699cdbc-61d5-4e0d-b916-84f82ebede1f
Server03     4e5a3245-4c63-43e4-88d0-a7798bfc2414
TX-TEST-01   fc4e9dfa-f246-452d-9fa3-1adbdd64ae85

Remove-PSSession -InstanceID fc4e9dfa-f246-452d-9fa3-1adbdd64ae85

これらのコマンドは、インスタンス ID または RemoteRunspaceID に基づいてPSSessionを閉じる方法を示しています。

最初のコマンドでは、 Get-PSSession コマンドレットを使用して、現在のセッションの PSSessions を取得します。パイプライン演算子 (|) を使用して、 PSSessions を Format-Table コマンドレットに送信します。このコマンドレットは、テーブル内の ComputerName および InstanceID プロパティを書式設定します。 AutoSize パラメーターは、表示する列を圧縮します。

結果の表示から、閉じるPSSessionを識別し、そのPSSessionのInstanceIDをコピーして 2 番目のコマンドに貼り付けることができます。

2 番目のコマンドでは、 Remove-PSSession コマンドレットを使用して、指定したインスタンス ID の PSSession を削除します。

例 6: 現在のセッションのすべてのセッションを削除する関数を作成する

Function EndPSS { Get-PSSession | Remove-PSSession }

この関数は、現在のセッションのすべての PSSession を閉じます。この関数を PowerShell プロファイルに追加した後、すべてのセッションを削除するには、「 EndPSS」と入力します。

パラメーター

-ComputerName

コンピューターの名前の配列を指定します。このコマンドレットは、指定したコンピューターに接続されている PSSessions を閉じます。ワイルドカード文字を使用できます。

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

型:	String[]
Aliases:	Cn
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	True

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ContainerId

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

型:	String[]
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Id

セッションの ID の配列を指定します。このコマンドレットは、指定した ID で PSSessions を閉じます。 1 つ以上の ID をコンマで区切って入力するか、範囲演算子 (..) を使用して ID の範囲を指定します。

ID は、現在のセッションの PSSession を一意に識別する整数です。 InstanceIdよりも覚えやすく、入力する方が簡単ですが、現在のセッションでのみ一意です。 PSSessionの ID を見つけるには、パラメーターを指定せずに Get-PSSession コマンドレットを実行します。

型:	Int32[]
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-InstanceId

インスタンス ID の配列を指定します。このコマンドレットは、指定されたインスタンス ID を持つ PSSessions を閉じます。

インスタンス ID は、現在のセッションの PSSession を一意に識別する GUID です。 1 台のコンピューターで複数のセッションが実行されている場合でも、インスタンス ID は一意です。

インスタンス ID は、PSSession を表すオブジェクトの InstanceID プロパティに格納されます。現在のセッションのPSSessionsのInstanceIDを見つけるには、「Get-PSSession | Format-Table Name, ComputerName, InstanceId」と入力します。

型:	Guid[]
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Name

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

PSSessionのフレンドリ名は一意ではない可能性があるため、Name パラメーターを使用する場合は、Remove-PSSession コマンドで WhatIf または Confirm パラメーターも使用することを検討してください。

型:	String[]
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	True

-Session

閉じる PSSessions のセッションオブジェクトを指定します。 PSSessionsを含む変数、またはNew-PSSessionやGet-PSSessionコマンドなど、PSSessionsを作成または取得するコマンドを入力します。また、1 つ以上のセッションオブジェクトをパイプ処理して Remove-PSSessionすることもできます。

型:	PSSession[]
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-VMId

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

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

型:	Guid[]
Aliases:	VMGuid
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-VMName

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

型:	String[]
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	False
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PSSession

セッションオブジェクトをこのコマンドレットにパイプできます。

出力

None

このコマンドレットは、出力を返しません。

メモ

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

すべてのプラットフォーム:
- rsn
Id パラメーターは必須です。現在のセッションのすべての PSSessions を削除するには、「 Get-PSSession | Remove-PSSession」と入力します。
PSSessionは、リモートコンピューターへの永続的な接続を使用します。 PSSessionを作成して、データを共有する一連のコマンドを実行します。詳細を表示するには「Get-Help about_PSSessions」を入力します。
PSSessions は現在のセッションに固有です。セッションを終了すると、そのセッションで作成した PSSessions が強制的に閉じられます。

次の方法で共有

Remove-PSSession

構文

説明

例

例 1: ID でセッションを削除する

例 2: 現在のセッションのすべてのセッションを削除する

例 3: 名前でセッションを閉じる

例 4: ポートに接続されているセッションを閉じる

例 5: インスタンス ID でセッションを閉じる

例 6: 現在のセッションのすべてのセッションを削除する関数を作成する

パラメーター

-ComputerName

-Confirm

-ContainerId

-Id

-InstanceId

-Name

-Session

-VMId

-VMName

-WhatIf

入力

出力

メモ

その他のリソース

次の方法で共有

Remove-PSSession

構文

説明

例

例 1: ID でセッションを削除する

例 2: 現在のセッションのすべてのセッションを削除する

例 3: 名前でセッションを閉じる

例 4: ポートに接続されているセッションを閉じる

例 5: インスタンス ID でセッションを閉じる

例 6: 現在のセッションのすべてのセッションを削除する関数を作成する

パラメーター

-ComputerName

-Confirm

-ContainerId

-Id

-InstanceId

-Name

-Session

-VMId

-VMName

-WhatIf

入力

出力

メモ

関連リンク

その他のリソース