about_PSSnapins
簡単な説明
Windows PowerShell スナップインについて説明し、その使用方法と管理方法を示します。
詳細な説明
Windows PowerShell スナップインは、Windows PowerShell プロバイダーとコマンドレットを含むことができる Microsoft .NET Framework アセンブリです。 Windows PowerShell には一連の基本的なスナップインが含まれていますが、他のユーザーが作成または取得するプロバイダーとコマンドレットを含むスナップインを追加することで、Windows PowerShell の機能と価値を拡張できます。
スナップインを追加すると、そのスナップインに含まれるコマンドレットとプロバイダーは、現在のセッションですぐに使用できますが、変更は現在のセッションにのみ影響します。
今後のすべてのセッションにスナップインを追加するには、Windows PowerShell プロファイルに保存します。 Export-Console コマンドレットを使用して、スナップイン名をコンソール ファイルに保存し、その保存された構成を今後のセッションで使用することもできます。
Windows PowerShell 3.0 以降では、PowerShell に付属するコマンドレットはモジュールにパッケージ化されています。 例外は Microsoft.PowerShell.Core です。これは、残りの唯一のスナップインです。 Microsoft.PowerShell.Core スナップインは、既定ですべてのセッションに読み込まれます。 残りのモジュールは、初回使用時に自動的に読み込まれます。 詳細については、「 about_Modules」を参照してください。
スナップインを検索する
コンピューター上の Windows PowerShell スナップインの一覧を取得するには、次のように入力します。
Get-PSSnapin
各 Windows PowerShell プロバイダーのスナップインを取得するには、次のように入力します。
Get-PSProvider | Format-List name, pssnapin
システムに登録されているすべてのスナップインを取得するか、スナップインが登録されていることを確認するには、次のように入力します。
Get-PSSnapin -registered
Windows PowerShell スナップインでコマンドレットの一覧を取得するには、次のように入力します。
Get-Command -Module <snap-in_name>
スナップインをインストールする
組み込みのスナップインはシステムに登録され、Windows PowerShell を起動すると既定のセッションに追加されます。 ただし、他のユーザーから作成または取得したスナップインを登録し、そのスナップインをセッションに追加する必要があります。
現在のセッションにスナップインを追加する
登録されたスナップインを現在のセッションに追加するには、 Add-PsSnapin コマンドレットを使用します。 たとえば、Microsoft SQL Server スナップインをセッションに追加するには、次のように入力します。
Add-PSSnapin sql
コマンドが完了すると、スナップイン内のプロバイダーとコマンドレットをセッションで使用できるようになります。 ただし、保存しない限り、現在のセッションでのみ使用できます。
スナップインを保存する
今後の Windows PowerShell セッションでスナップインを使用するには、 Add-PsSnapin コマンドを Windows PowerShell プロファイルに追加します。 または、スナップイン名をコンソール ファイルにエクスポートします。
プロファイルに Add-PSSnapin コマンドを追加すると、今後のすべての Windows PowerShell セッションで使用できるようになります。 セッションでスナップインの名前をエクスポートする場合は、スナップインが必要な場合にのみエクスポート ファイルを使用できます。
Add-PsSnapin コマンドを Windows PowerShell プロファイルに追加するには、プロファイルを開き、コマンドを貼り付けるか入力して、プロファイルを保存します。 詳細については、「about_Profiles」を参照してください。
セッションのスナップインをコンソール ファイル (.psc1) に保存するには、 Export-Console コマンドレットを使用します。 たとえば、現在のセッション構成のスナップインを現在のディレクトリの NewConsole.psc1 ファイルに保存するには、次のように入力します。
Export-Console NewConsole
詳細については、「 Export-Console」を参照してください。
コンソール ファイルを使用して Windows PowerShell を開く
スナップインを含むコンソール ファイルを使用するには、cmd.exeまたは別の Windows PowerShell セッションでコマンド プロンプトから Windows PowerShell (powershell.exe) を起動します。 PsConsoleFile パラメーターを使用して、スナップインを含むコンソール ファイルを指定します。 たとえば、次のコマンドは、 NewConsole.psc1 コンソール ファイルを使用して Windows PowerShell を起動します。
PowerShell.exe -psconsolefile NewConsole.psc1
スナップインのプロバイダーとコマンドレットをセッションで使用できるようになりました。
スナップインを削除する
現在のセッションから Windows PowerShell スナップインを削除するには、 Remove-PsSnapin コマンドレットを使用します。 たとえば、現在のセッションから SQL Server スナップインを削除するには、次のように入力します。
Remove-PSSnapin sql
このコマンドレットは、セッションからスナップインを削除します。 スナップインは引き続き読み込まれますが、サポートされているプロバイダーとコマンドレットは使用できなくなりました。
スナップイン イベントをログに記録する
Windows PowerShell 3.0 以降では、モジュールとスナップインの LogPipelineExecutionDetails プロパティを $true に設定することで、Windows PowerShell モジュールとスナップインのコマンドレットの実行イベントを記録できます。
詳細については、「 about_EventLogs」を参照してください。
関連項目
PowerShell