Remove-PSSnapin

モジュール:

Microsoft.PowerShell.Core

現在のセッションから Windows PowerShell スナップインを削除します。

構文

Remove-PSSnapin
      [-Name] <String[]>
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-PSSnapin コマンドレットは、現在のセッションからWindows PowerShell スナップインを削除します。 これを使用して、Windows PowerShellに追加したスナップインを削除できます。このコマンドレットを使用して、Windows PowerShellと共にインストールされているスナップインを削除することはできません。

現在のセッションからスナップインを削除しても、スナップインは読み込まれますが、スナップインのコマンドレットとプロバイダーはセッションで使用できなくなります。

例

例 1: スナップインを削除する

PS C:\> remove-pssnapin -Name Microsoft.Exchange

このコマンドは、現在のセッションから Microsoft.Exchange スナップインを削除します。 コマンドが完了すると、スナップインがサポートしていたコマンドレットとプロバイダーは、セッションで使用できなくなります。

例 2: パイプラインで名前を使用してスナップインを削除する

PS C:\> Get-PSSnapIn smp* | Remove-PSSnapIn

このコマンドは、smp で始まる名前を持つWindows PowerShell スナップインを現在のセッションから削除します。

このコマンドでは 、Get-PSSnapin コマンドレットを使用して、スナップインを表すオブジェクトを取得します。パイプライン演算子 (|) は、結果を Remove-PSSnapin コマンドレットに送信し、セッションから削除します。 このスナップインがサポートするプロバイダーとコマンドレットは、セッションで使用できなくなります。

オブジェクトを Remove-PSSnapin にパイプすると、オブジェクトの名前が Name パラメーターに関連付けられます。Name パラメーターは、Name プロパティを持つパイプラインのオブジェクトを受け入れます。

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

PS C:\> 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 は出力を生成しません。

メモ

• Remove-PSSnapin では、セッションからスナップインを削除する前に、Windows PowerShellのバージョンは確認されません。 スナップインを削除できない場合は、警告が表示され、コマンドは失敗します。
• Remove-PSSnapin は、現在のセッションにのみ影響します。 Add-PSSnapin コマンドを Windows PowerShell プロファイルに追加した場合は、コマンドを削除して、それ以降のセッションからスナップインを削除する必要があります。 手順については、「.」と入力します Get-Help about_Profiles。

関連リンク

• Add-PSSnapin
• Get-PSSnapin
• about_Profiles