PowerShell Cmdlet - Add-PSSnapin
 記事記号:[mf1907] 初版:2011/Sep/30

この文書は、Windows PowerShellのヘルプ機能で表示される内容を再構成したものです。

名前
    Add-PSSnapin
    
概要
    1 つまたは複数の Windows PowerShell スナップインを現在のセッションに追加しま
    す。
    
構文
    Add-PSSnapin [-Name] <string[]> [-PassThru] [<CommonParameters>]
    
    
説明
    Add-PSSnapin コマンドレットは、登録されている Windows PowerShell スナップイ
    ンを現在のセッションに追加します。スナップインが追加されると、そのスナップイ
    ンが現在のセッションでサポートしているコマンドレットとプロバイダーが使用でき
    るようになります。
    
    将来のすべての Windows PowerShell セッションにスナップインを追加するには、Wi
    ndows PowerShell プロファイルに Add-PSSnapin コマンドを追加します。詳細につ
    いては、「about_Profiles」を参照してください。
    
パラメーター
    -Name <string[]>
        スナップインの名前を指定します (これは、AssemblyName または ModuleName 
        ではなく、Name です)。
        
        システムに登録されているスナップイン名を参照するには、「get-pssnapin -r
        egistered」と入力します。
        
        必須                         true
        位置                         1
        既定値                       
        パイプライン入力を許可する   true (ByPropertyName)
        ワイルドカード文字を許可する false
        
    -PassThru [<SwitchParameter>]
        追加された各スナップインを表すオブジェクトを返します。既定では、このコマ
        ンドレットによる出力はありません。
        
        必須                         false
        位置                         named
        既定値                       
        パイプライン入力を許可する   false
        ワイルドカード文字を許可する false
        
    <CommonParameters>
        このコマンドレットは、次の共通パラメーターをサポートします: Verbose、
        Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、
        OutBuffer、および OutVariable。詳細については、
        「get-help about_commonparameters」と入力してヘルプを参照してください。
    
入力
    None
        パイプを使用してオブジェクトを Add-PSSnapin に渡すことはできません。
    
出力
    None または System.Management.Automation.PSSnapInInfo
        PassThru パラメーターを使用した場合、Add-PSSnapin は、スナップインを表す 
        PSSnapInInfo オブジェクトを返します。それ以外の場合、このコマンドレット
        による出力はありません。
    
メモ
        Windows PowerShell のスナップインの詳細については、「about_PSSnapins」を
        参照してください。Windows PowerShell スナップインの作成方法については、M
        SDN (Microsoft Developer Network) ライブラリの「How to Create a Windows 
        PowerShell Snap-in (Windows PowerShell スナップインの作成方法)」(http://
        go.microsoft.com/fwlink/?LinkId=144762) を参照してください。
        
        Add-PSSnapin は、スナップインを現在のセッションにのみ追加します。すべて
        の Windows PowerShell セッションにスナップインを追加するには、Windows P
        owerShell プロファイルにこのコマンドを追加します。詳細については、「abo
        ut_Profiles」を参照してください。
        
        Microsoft .NET Framework インストール ユーティリティを使用すると、登録
        済みの Windows PowerShell スナップインであれば、どれでも追加することが
        できます。詳細については、MSDN ライブラリの「How to Register Cmdlets, 
        Providers, and Host Applications (コマンドレット、プロバイダー、および
        ホスト アプリケーションの登録方法)」(http://go.microsoft.com/fwlink/?L
        inkID=143619) を参照してください。
        
        コンピューターに登録されているスナップインの一覧を取得するには、「get-
        pssnapin -registered」と入力します。
        
        Add-PSSnapin は、スナップインを追加する前にそのバージョンをチェックし、
        Windows PowerShell の現在のバージョンと互換性があることを確認します。ス
        ナップインのバージョンが互換性のないものであった場合は、Windows PowerSh
        ell からエラーが報告されます。
        
    -------------------------- 例 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 は返されません。これは、ManagementFeature
    s がまだセッションに追加されていないことを示します。
    
        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\ins
        tallutil.exe
    
    4 番目のコマンドは、InstallUtil ツールを使用してスナップインを登録します。こ
    のコマンドは、登録するスナップインのファイル名または「モジュール名」である M
    anagementCmdlets.dll へのパスを指定します。
    
        installutil C:\Dev\Management\ManagementCmdlets.dll
    
    5 番目のコマンドは、2 番目のコマンドと同じです。ただし今回は、ManagementCmdl
    ets スナップインが登録されていることを確認します。
    
        get-pssnapin -registered
    
    6 番目のコマンドは、Add-PSSnapin コマンドレットを使用してセッションに Manage
    mentFeatures スナップインを追加します。このコマンドは、ファイル名ではなく、M
    anagementFeatures スナップインの名前を指定します。
    
        add-pssnapin ManagementFeatures
    
    スナップインがセッションに追加されたことを確認するために、7 番目のコマンドは 
    Get-Command コマンドレットの Module パラメーターを使用します。スナップインま
    たはモジュールによってセッションに追加された項目が表示されます。
    
        get-command -module ManagementFeatures
    
    コマンドレットの生成元であるスナップインまたはモジュールを検索するために、Get
    -Command が返すオブジェクトの PSSnapin プロパティを使用することもできます。8 
    番目のコマンドは、ドット表記を使用して Set-Alias コマンドの PSSnapin プロパテ
    ィの値を検索します。
    
        (get-command set-alias).pssnapin
    
関連するリンク
    Online version: http://go.microsoft.com/fwlink/?LinkID=113281
    Get-PSSnapin 
    Remove-PSSnapin 
    about_Profiles 
    	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、Cmdlet、Add-PSSnapin
ご利用数: 1974593
感想・要望・問い合わせは こちら