Remove-PSSession

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

構文

Id (既定)

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

Session

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

ContainerId

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

VMId

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

VMName

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

InstanceId

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

Name

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

ComputerName

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

説明

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

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

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

例

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

Remove-PSSession -Id 1, 2

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

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

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

これらのコマンドは、現在のセッションのすべての PSSession を削除します。 3 つのコマンド形式は異なって見えますが、同じ効果があります。

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

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

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

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

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

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

例 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 コマンドレットを使用して、現在のセッションの PSSession を 取得します。 パイプライン演算子 (|) を使用して 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

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

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

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

型:

String[]

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

パラメーター セット

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

-Confirm

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

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

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

パラメーター セット

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

-ContainerId

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

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

型:

String[]

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

パラメーター セット

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

-Id

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

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

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

型:

Int32[]

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

パラメーター セット

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

-InstanceId

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

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

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

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

型:

Guid[]

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

パラメーター セット

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

-Name

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

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

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

型:

String[]

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

パラメーター セット

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

-Session

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

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

型:

PSSession[]

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

パラメーター セット

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

-VMId

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

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

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

型:

Guid[]

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

パラメーター セット

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

-VMName

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

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

型:

String[]

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

パラメーター セット

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

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

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

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

パラメーター セット

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

CommonParameters

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

入力

PSSession

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

出力

None

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

メモ

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

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

    • rsn
  • Id パラメーターは必須です。 現在のセッションのすべての PSSession を 削除するには、「 Get-PSSession | Remove-PSSession」と入力します。

  • PSSession は、リモート コンピューターへの永続的な接続を使用します。 PSSession を作成して、データを共有する一連のコマンドを実行します。 詳細については、「 Get-Help about_PSSessions」と入力します。

  • PSSession は 、現在のセッションに固有です。 セッションを終了すると、そのセッションで作成した PSSession が強制的に閉じられます。