Add-PSSnapin

1 つまたは複数の Windows PowerShell スナップインを現在のセッションに追加します。

構文

Add-PSSnapin [-Name] <string[]> [-PassThru] [<CommonParameters>]

説明

Add-PSSnapin コマンドレットは、登録されている Windows PowerShell スナップインを現在のセッションに追加します。スナップインが追加されると、そのスナップインが現在のセッションでサポートしているコマンドレットとプロバイダーが使用できるようになります。

将来のすべての Windows PowerShell セッションにスナップインを追加するには、Windows PowerShell プロファイルに Add-PSSnapin コマンドを追加します。詳細については、「about_Profiles」を参照してください。

パラメーター

-Name <string[]>

スナップインの名前を指定します (これは、AssemblyName または ModuleName ではなく、Name です)。

システムに登録されているスナップイン名を参照するには、「get-pssnapin -registered」と入力します。

-PassThru

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

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.

入力と出力

入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。

注

Windows PowerShell のスナップインの詳細については、「about_PSSnapins」を参照してください。Windows PowerShell スナップインの作成方法については、MSDN (Microsoft Developer Network) ライブラリの「How to Create a Windows PowerShell Snap-in (Windows PowerShell スナップインの作成方法)」(https://go.microsoft.com/fwlink/?LinkId=144762) を参照してください。

Add-PSSnapin は、スナップインを現在のセッションにのみ追加します。すべての Windows PowerShell セッションにスナップインを追加するには、Windows PowerShell プロファイルにこのコマンドを追加します。詳細については、「about_Profiles」を参照してください。

Microsoft .NET Framework インストール ユーティリティを使用すると、登録済みの Windows PowerShell スナップインであれば、どれでも追加することができます。詳細については、MSDN ライブラリの「How to Register Cmdlets, Providers, and Host Applications (コマンドレット、プロバイダー、およびホスト アプリケーションの登録方法)」(https://go.microsoft.com/fwlink/?LinkID=143619) を参照してください。

コンピューターに登録されているスナップインの一覧を取得するには、「get-pssnapin -registered」と入力します。

Add-PSSnapin は、スナップインを追加する前にそのバージョンをチェックし、Windows PowerShell の現在のバージョンと互換性があることを確認します。スナップインのバージョンが互換性のないものであった場合は、Windows PowerShell からエラーが報告されます。

例 1

C:\PS>add-PSSnapIn Microsoft.Exchange, Microsoft.Windows.AD

説明
-----------
このコマンドは、Microsoft Exchange と Active Directory のスナップインを現在のセッションに追加します。

例 2

C:\PS>get-pssnapin -registered | add-pssnapin -passthru

説明
-----------
このコマンドは、登録済みのすべての Windows PowerShell スナップインをセッションに追加します。Get-PSSnapin コマンドレットと Registered パラメーターを使用して、登録済みの各スナップインを表すオブジェクトを取得します。結果はパイプライン演算子 (|) によって Add-PSSnapin に渡され、Add-PsSnapin によってセッションに追加されます。PassThru パラメーターを指定すると、追加する各スナップインを表すオブジェクトが返されます。

例 3

C:\PS>get-pssnapin

説明
-----------
この例は、スナップインをシステムに登録し、そのスナップインをセッションに追加するプロセスを示しています。ここでは、ManagementCmdlets.dll というファイルに実装されている架空のスナップイン ManagementFeatures を使用します。

最初のコマンドは、現在のセッションに追加されているスナップインを取得します。これには、Windows PowerShell と同時にインストールされたスナップインが含まれます。この例では、ManagementFeatures は返されません。これは、ManagementFeatures がまだセッションに追加されていないことを示します。

    get-pssnapin


2 番目のコマンドは、既にセッションに追加済みのスナップインを含め、システムに登録されているスナップインを取得します。これには、Windows PowerShell と同時にインストールされたスナップインは含まれません。

    get-pssnapin -registered

 
この場合、コマンドはスナップインを返しません。これは、ManagementFeatures スナップインがまだシステムに登録されていないことを示します。

3 番目のコマンドは、.NET Framework の InstallUtil ツールへのパスを表すエイリアス "installutil" を作成します。

    set-alias installutil $env:windir\Microsoft.NET\Framework\v2.0.50727\installutil.exe


4 番目のコマンドは、InstallUtil ツールを使用してスナップインを登録します。このコマンドは、登録するスナップインのファイル名または「モジュール名」である ManagementCmdlets.dll へのパスを指定します。

    installutil C:\Dev\Management\ManagementCmdlets.dll


5 番目のコマンドは、2 番目のコマンドと同じです。ただし今回は、ManagementCmdlets スナップインが登録されていることを確認します。

    get-pssnapin -registered

6 番目のコマンドは、Add-PSSnapin コマンドレットを使用してセッションに ManagementFeatures スナップインを追加します。このコマンドは、ファイル名ではなく、ManagementFeatures スナップインの名前を指定します。

    add-pssnapin ManagementFeatures

スナップインがセッションに追加されたことを確認するために、7 番目のコマンドは Get-Command コマンドレットの Module パラメーターを使用します。スナップインまたはモジュールによってセッションに追加された項目が表示されます。

    get-command -module ManagementFeatures

コマンドレットの生成元であるスナップインまたはモジュールを検索するために、Get-Command が返すオブジェクトの PSSnapin プロパティを使用することもできます。8 番目のコマンドは、ドット表記を使用して Set-Alias コマンドの PSSnapin プロパティの値を検索します。

    (get-command set-alias).pssnapin

関連項目

概念

Get-PSSnapin
Remove-PSSnapin
about_Profiles