Remove-PSSnapin
現在のセッションから Windows PowerShell スナップインを削除します。
構文
Remove-PSSnapin
[-Name] <String[]>
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Remove-PSSnapin
コマンドレットは、現在のセッションから Windows PowerShell スナップインを削除します。 これを使用して、Windows PowerShell に追加したスナップインを削除できます。このコマンドレットを使用して、Windows PowerShell にインストールされているスナップインを削除することはできません。
現在のセッションからスナップインを削除しても、スナップインは読み込まれますが、スナップイン内のコマンドレットとプロバイダーはセッションで使用できなくなります。
例
例 1: スナップインを削除する
Remove-PSSnapin -Name Microsoft.Exchange
このコマンドは、現在のセッションから Microsoft.Exchange スナップインを削除します。 コマンドが完了すると、スナップインがサポートしていたコマンドレットとプロバイダーは、セッションで使用できなくなります。
例 2: パイプラインで名前を使用してスナップインを削除する
Get-PSSnapIn smp* | Remove-PSSnapIn
このコマンドは、smp で始まる名前を持つ Windows PowerShell スナップインを現在のセッションから削除します。
このコマンドでは、 Get-PSSnapin
コマンドレットを使用して、スナップインを表すオブジェクトを取得します。パイプライン演算子 (|
) は結果を Remove-PSSnapin
コマンドレットに送信し、セッションから削除します。 このスナップインがサポートするプロバイダーとコマンドレットは、セッションで使用できなくなります。
Remove-PSSnapin
にオブジェクトをパイプする場合、オブジェクトの名前は Name パラメーターに関連付けられます。このパラメーターは、Name プロパティを持つパイプラインのオブジェクトを受け入れます。
例 3: 名前を使用してスナップインを削除する
Remove-PSSnapin -Name *event*
このコマンドは、イベントを含む名前を持つすべての Windows PowerShell スナップインを削除します。
パラメーター
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Name
現在のセッションから削除する Windows PowerShell スナップインの名前を指定します。
ワイルドカード文字 (*
) を使用できます。
型: | String[] |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-PassThru
スナップインを表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
スナップイン オブジェクトをこのコマンドレットにパイプできます。
出力
None, System.Management.Automation.PSSnapInInfo
このコマンドレットは、PassThru パラメーターを指定すると、スナップインを表すSystem.Management.Automation.PSSnapInInfo オブジェクトを生成します。 既定では、 Remove-PSSnapin
は出力を生成しません。
メモ
Windows PowerShell には、 Remove-PSSnapin
の次のエイリアスが含まれています。
rsnp
Remove-PSSnapin
は、セッションからスナップインを削除する前に Windows PowerShell のバージョンを確認しません。 スナップインを削除できない場合は、警告が表示され、コマンドは失敗します。
Remove-PSSnapin
は、現在のセッションにのみ影響します。 windows PowerShell プロファイルに Add-PSSnapin
コマンドを追加した場合は、コマンドを削除して、今後のセッションからスナップインを削除する必要があります。 手順については、「 Get-Help about_Profiles
」と入力します。
関連リンク
PowerShell