Remove-PSSnapin
現在のセッションから Windows PowerShell スナップインを削除します。
構文
Default (既定)
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 |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Name
現在のセッションから削除する Windows PowerShell スナップインの名前を指定します。
ワイルドカード文字 (*) を使用できます。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-PassThru
スナップインを表すオブジェクトを返します。 既定では、このコマンドレットは出力を生成しません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
PSSnapInInfo
スナップイン オブジェクトをこのコマンドレットにパイプできます。
出力
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」と入力します。