Windows PowerShell スナップインを現在のセッションから削除します。
構文
Remove-PSSnapin [-Name] <string[]> [-PassThru] [-確認] [-WhatIf] [<CommonParameters>]
説明
Remove-PSSnapin コマンドレットは、Windows PowerShell スナップインを現在のセッションから削除します。Windows PowerShell に追加したスナップインは削除できますが、Windows PowerShell と同時にインストールされたスナップインの削除には使用できません。
スナップインは、現在のセッションから削除した後も読み込まれた状態のままですが、そのスナップインのコマンドレットおよびプロバイダーはそのセッションで利用できなくなります。
パラメーター
-Name <string[]>
現在のセッションから削除する Windows PowerShell スナップインの名前を指定します。パラメーター名 ("Name") は省略可能で、値にはワイルドカード文字 (*) を使用できます。
|
必須 |
true |
|
位置 |
1 |
|
既定値 |
なし |
|
パイプライン入力を許可する |
true (ByPropertyName) |
|
ワイルドカード文字を許可する |
true |
-PassThru
スナップインを表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
|
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
-確認
コマンドを実行する前に確認メッセージを表示します。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
|
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
-WhatIf
実際にコマンドを実行せずに、コマンドを実行すると何が起きるかを出力します。
|
必須 |
false |
|
位置 |
named |
|
既定値 |
|
|
パイプライン入力を許可する |
false |
|
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。Ô”¼š¤Ë¤Ä¤¤¤Æ¤Ï¡¢次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
|
入力 |
System.Management.Automation.PSSnapInInfo パイプを使用してスナップイン オブジェクトを Remove-PSSnapin に渡すことができます。 |
|
出力 |
None または System.Management.Automation.PSSnapInInfo 既定では、Remove-PsSnapin は出力を生成しません。ただし、PassThru パラメーターを使用した場合は、スナップインを表す System.Management.Automation.PSSnapInInfo オブジェクトが生成されます。 |
注
Remove-PSSnapin は、組み込みエイリアスである "rsnp" で参照することもできます。詳細については、「about_Aliases」を参照してください。
Remove-PSSnapin は、Windows PowerShell のバージョンを確認せずにスナップインをセッションから削除します。スナップインを削除できない場合は警告が表示され、コマンドが失敗します。
Remove-PSSnapin は、現在のセッションにのみ影響します。Add-PSSnapin コマンドを Windows PowerShell プロファイルに追加している場合、今後のセッションからスナップインを削除するには、そのコマンドも削除する必要があります。方法については、「about_Profiles」を参照してください。
例 1
C:\PS>remove-pssnapin -name Microsoft.Exchange 説明 ----------- このコマンドは、Microsoft.Exchange スナップインを現在のセッションから削除します。コマンドが完了すると、そのスナップインでサポートしていたコマンドレットとプロバイダーは現在のセッションで使用できなくなります。
例 2
C:\PS>get-PSSnapIn smp* | remove-PSSnapIn 説明 ----------- このコマンドは、名前が "smp" で始まる Windows PowerShell スナップインを現在のセッションから削除します。 このコマンドは、Get-PSSnapin コマンドレットを使用して、スナップインを表すオブジェクトを取得します。結果はパイプライン演算子 (|) によって Remove-PSSnapin コマンドレットに渡され、セッションから削除されます。このスナップインでサポートするコマンドレットとプロバイダーはこのセッションで使用できなくなります。 パイプを使用してオブジェクトを Remove-PSSnapin に渡すと、そのオブジェクト名が Name パラメーターと関連付けられます。この Remove-PsSnapin は Name プロパティを持つオブジェクトをパイプラインから受け取ります。
例 3
C:\PS>remove-pssnapin -name *event* 説明 ----------- このコマンドは、名前に "event" が含まれるすべての Windows PowerShell スナップインを削除します。このコマンドでは、"Name" パラメーター名を指定していますが、このパラメーター名は省略可能です。
関連項目