Add-PSSnapin

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

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

構文

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

説明

このコマンドレットは Add-PSSnapin 、登録済みの Windows PowerShell スナップインを現在のセッションに追加します。 スナップインを追加した後、スナップインが現在のセッションでサポートするコマンドレットとプロバイダーを使用できます。

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

Windows PowerShell 3.0 以降、Windows PowerShell に含まれているコア コマンドはモジュールにパッケージ化されています。 ただし 、Microsoft.PowerShell.Core はスナップイン (PSSnapin) です。 既定では、Microsoft.PowerShell.Core スナップインのみがセッションに追加されます。 モジュールは最初の使用時に自動的にインポートされ、Import-Module コマンドレットを使用してインポートできます。

例

例 1: スナップインを追加する

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

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

例 2: 登録されているすべてのスナップインを追加する

PS C:\> Get-PSSnapin -Registered | Add-PSSnapin -Passthru

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

例 3: スナップインを登録して追加する

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

2 番目のコマンドは、既にセッションに追加されているものを含む、システムに登録されているスナップインを取得します。 Windows PowerShell と共にインストールされるスナップインは含まれません。 この場合、このコマンドはスナップインを返しません。これは、ManagementFeatures スナップインがシステムに登録されていないことを示します。

3 番目のコマンドは、.NET Framework の InstallUtil ツールのパスに対して、installutil というエイリアスを作成します。

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

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

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

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

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

PS C:\> Get-PSSnapin
PS C:\> Get-PSSnapin -Registered
PS C:\> Set-Alias installutil $env:windir\Microsoft.NET\Framework\v2.0.50727\installutil.exe
PS C:\> installutil C:\Dev\Management\ManagementCmdlets.dll
PS C:\> Get-PSSnapin -Registered
PS C:\> add-pssnapin ManagementFeatures
PS C:\> Get-Command -Module ManagementFeatures
PS C:\> (Get-Command Set-Alias).pssnapin

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

パラメーター

-Name

スナップインの名前を指定します。 これは名前であり、AssemblyName または ModuleName ではありません。 ワイルドカードを使用できます。

システムに登録されているスナップインの名前を見つけるには、「.」と入力します Get-PSSnapin -Registered。

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

-PassThru

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

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

入力

None

このコマンドレットにパイプを使用してオブジェクトを渡すことはできません。

出力

None or System.Management.Automation.PSSnapInInfo

このコマンドレットは、PassThru パラメーターを指定した場合にスナップインを表す PSSnapInInfo オブジェクトを返します。 それ以外の場合、このコマンドレットによる出力はありません。

メモ

Windows PowerShell には、次のエイリアスが Add-PSSnapin含まれています。

  • asnp

Windows PowerShell 3.0 以降、Windows PowerShell と共にインストールされるコア コマンドはモジュールにパッケージ化されています。 Windows PowerShell 2.0 と、それ以降のバージョンの Windows PowerShell で古いスタイルのセッションを作成するホスト プログラムでは、コア コマンドはスナップイン (PSSnapins) にパッケージ化されています。 ただし、 Microsoft.PowerShell.Core は常にスナップインです。 また、New-PSSession コマンドレットによって開始されたリモート セッションは、コア スナップインを含む古いスタイルのセッションです。

コア モジュールを使用して新しいスタイルのセッションを作成する CreateDefault2 メソッドの詳細については、「CreateDefault2 メソッド」を参照してください。

スナップインの詳細については、「about_PSSnapinsと Windows PowerShell スナップインを作成する方法」を参照してください。

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

Microsoft .NET Framework インストール ユーティリティを使用して登録されている任意のスナップインを追加できます。 詳細については、「コマンドレット、プロバイダー、およびホスト アプリケーションを登録する方法」を参照してください。

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

スナップインを追加する前に、 Add-PSSnapin スナップインのバージョンをチェックして、現在のバージョンの Windows PowerShell と互換性があることを確認します。 スナップインがバージョン チェックに失敗した場合、Windows PowerShell はエラーを報告します。