Remove-PSSnapin

  • リファレンス
モジュール:
Microsoft.PowerShell.Core

現在のセッションから 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 パラメーターは、Name プロパティを持つパイプラインのオブジェクトを受け入れます。

例 3: 名前を使用してスナップインを削除する

Remove-PSSnapin -Name *event*

このコマンドは、イベントを含む名前を持つすべての Windows PowerShell スナップインを削除します。

パラメーター

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

現在のセッションから削除する Windows PowerShell スナップインの名前を指定します。 ワイルドカード文字 (*) を使用できます。

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

スナップインを表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

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。