Get-Module

構文

Get-Module
   [[-Name] <String[]>]
   [-FullyQualifiedName <ModuleSpecification[]>]
   [-All]
   [<CommonParameters>]

Get-Module
   [[-Name] <String[]>]
   [-FullyQualifiedName <ModuleSpecification[]>]
   [-All]
   [-ListAvailable]
   [-PSEdition <String>]
   [-Refresh]
   [<CommonParameters>]

Get-Module
   [[-Name] <String[]>]
   [-FullyQualifiedName <ModuleSpecification[]>]
   [-ListAvailable]
   [-PSEdition <String>]
   [-Refresh]
   -PSSession <PSSession>
   [<CommonParameters>]

Get-Module
   [[-Name] <String[]>]
   [-FullyQualifiedName <ModuleSpecification[]>]
   [-ListAvailable]
   [-Refresh]
   -CimSession <CimSession>
   [-CimResourceUri <Uri>]
   [-CimNamespace <String>]
   [<CommonParameters>]

説明

Get-Module コマンドレットは、PowerShell セッションにインポートされた、またはインポートできる PowerShell モジュールを一覧表示します。 パラメーターがない場合、 Get-Module は現在のセッションにインポートされたモジュールを取得します。 ListAvailable パラメーターは、PSModulePath 環境変数 ($env:PSModulePath) で指定されたパスからインポートできるモジュールを一覧表示するために使用されます。

Get-Module返されるモジュール オブジェクトには、モジュールに関する貴重な情報が含まれています。 Import-ModuleコマンドレットやRemove-Moduleコマンドレットなど、他のコマンドレットにモジュール オブジェクトをパイプすることもできます。

Get-Module にはモジュールが一覧表示されますが、インポートされません。 Windows PowerShell 3.0 以降では、モジュールでコマンドを使用するとモジュールが自動的にインポートされますが、 Get-Module コマンドでは自動インポートはトリガーされません。 Import-Module コマンドレットを使用して、セッションにモジュールをインポートすることもできます。

Windows PowerShell 3.0 以降では、リモート セッションからローカル セッションにモジュールを取得してからインポートできます。 この方法では、PowerShell の暗黙的なリモート処理機能を使用し、 Import-PSSession コマンドレットを使用することと同じです。 別のセッションからインポートされたモジュールでコマンドを使用すると、コマンドはリモート セッションで暗黙的に実行されます。 この機能を使用すると、ローカル セッションからリモート コンピューターを管理できます。

また、Windows PowerShell 3.0 以降では、 Get-Module と Import-Module を使用して、Common Information Model (CIM) モジュールを取得およびインポートできます。 CIM モジュールは、コマンドレット定義 XML (CDXML) ファイルでコマンドレットを定義します。 この機能を使用すると、C++ で記述されたコマンドレットなど、非マネージド コード アセンブリに実装されているコマンドレットを使用できます。

暗黙的なリモート処理を使用して、PowerShell リモート処理が有効になっているリモート コンピューターを管理できます。 リモート コンピューターでPSSessionを作成し、Get-Moduleの PSSession パラメーターを使用して、リモート セッションで PowerShell モジュールを取得します。 リモート セッションからモジュールをインポートすると、インポートされたコマンドがリモート コンピューター上のセッションで実行されます。

同様の方法を使用して、PowerShell リモート処理が有効になっていないコンピューターを管理できます。 これには、Windows オペレーティング システムを実行していないコンピューターや、PowerShell を使用しているが PowerShell リモート処理が有効になっていないコンピューターが含まれます。

まず、リモート コンピューターで CIM セッションを作成します。 CIM セッションは、リモート コンピューター上の Windows Management Instrumentation (WMI) への接続です。 次に、Get-Moduleの CIMSession パラメーターを使用して、CIM セッションから CIM モジュールを取得します。 Import-Module コマンドレットを使用して CIM モジュールをインポートし、インポートしたコマンドを実行すると、コマンドはリモート コンピューターで暗黙的に実行されます。 この WMI と CIM の戦略を使用して、リモート コンピューターを管理できます。

例

例 1: 現在のセッションにインポートされたモジュールを取得する

Get-Module

このコマンドは、現在のセッションにインポートされているモジュールを取得します。

例 2: インストールされているモジュールと使用可能なモジュールを取得する

Get-Module -ListAvailable

このコマンドは、コンピューターにインストールされていて現在のセッションにインポートできるモジュールを取得します。

Get-Module は、 $env:PSModulePath 環境変数で指定されたパスで使用可能なモジュールを探します。 PSModulePathの詳細については、「about_Modulesとabout_Environment_Variables」を参照してください。

例 3: エクスポートされたすべてのファイルを取得する

Get-Module -ListAvailable -All

このコマンドは、すべての利用可能なモジュールのすべてのエクスポートされたファイルを取得します。

例 4: 完全修飾名でモジュールを取得する

$FullyQualifiedName = @{ModuleName="Microsoft.PowerShell.Management";ModuleVersion="3.1.0.0"}
Get-Module -FullyQualifiedName $FullyQualifiedName | Format-Table -Property Name,Version

Name                             Version
----                             -------
Microsoft.PowerShell.Management  3.1.0.0

この例では、FullyQualifiedName パラメーターを使用してモジュールの完全修飾名を指定して、Microsoft.PowerShell.Management モジュールを取得します。 次に、 Format-Table コマンドレットに結果をパイプ処理し、結果を列見出しとして Name および Version を使用してテーブルとして書式設定します。

モジュールの完全修飾名では、値 ModuleVersion は最小バージョンとして機能します。 したがって、この例では、バージョン 3.1.0.0 以上の Microsoft.PowerShell.Management モジュールと一致します。

例 5: モジュールのプロパティを取得する

Get-Module | Get-Member -MemberType Property | Format-Table Name

Name
----
AccessMode
Author
ClrVersion
CompanyName
Copyright
Definition
Description
DotNetFrameworkVersion
ExportedAliases
ExportedCmdlets
ExportedCommands
ExportedFormatFiles
ExportedFunctions
ExportedTypeFiles
ExportedVariables
ExportedWorkflows
FileList
Guid
HelpInfoUri
LogPipelineExecutionDetails
ModuleBase
ModuleList
ModuleType
Name
NestedModules
OnRemove
Path
PowerShellHostName
PowerShellHostVersion
PowerShellVersion
PrivateData
ProcessorArchitecture
RequiredAssemblies
RequiredModules
RootModule
Scripts
SessionState
Version

このコマンドは、Get-Moduleが返すPSModuleInfo オブジェクトのプロパティを取得します。 モジュール ファイルごとに 1 つのオブジェクトがあります。

プロパティを使用して、モジュール オブジェクトを書式設定したり、フィルター処理したりできます。 プロパティの詳細については、「 PSModuleInfo プロパティを参照してください。

出力には、Windows PowerShell 3.0 で導入された Author や CompanyName などの新しいプロパティが含まれます。

例 6: すべてのモジュールを名前でグループ化する

Get-Module -ListAvailable -All | Format-Table -Property Name, Moduletype, Path -Groupby Name

Name: AppLocker

Name      ModuleType Path
----      ---------- ----
AppLocker   Manifest C:\Windows\system32\WindowsPowerShell\v1.0\Modules\AppLocker\AppLocker.psd1


   Name: Appx

Name ModuleType Path
---- ---------- ----
Appx   Manifest C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Appx\en-US\Appx.psd1
Appx   Manifest C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Appx\Appx.psd1
Appx     Script C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Appx\Appx.psm1


   Name: BestPractices

Name          ModuleType Path
----          ---------- ----
BestPractices   Manifest C:\Windows\system32\WindowsPowerShell\v1.0\Modules\BestPractices\BestPractices.psd1


   Name: BitsTransfer

Name         ModuleType Path
----         ---------- ----
BitsTransfer   Manifest C:\Windows\system32\WindowsPowerShell\v1.0\Modules\BitsTransfer\BitsTransfer.psd1

このコマンドは、インポートと使用可能の両方のすべてのモジュール ファイルを取得し、モジュール名でグループ化します。 これにより、それぞれのスクリプトによってエクスポートされるモジュール ファイルを確認できます。

例 7: モジュール マニフェストの内容を表示する

これらのコマンドは、Windows PowerShell BitsTransfer モジュールのモジュール マニフェストの内容を表示します。

モジュールにはマニフェスト ファイルは必要ありません。 マニフェスト ファイルがある場合、マニフェスト ファイルはバージョン番号を含める必要があります。 ただし、マニフェスト ファイルは、多くの場合、モジュール、その要件、およびその内容に関する有用な情報を提供します。

# First command
$m = Get-Module -list -Name BitsTransfer

# Second command
Get-Content $m.Path

@ {
    GUID               = "{8FA5064B-8479-4c5c-86EA-0D311FE48875}"
    Author             = "Microsoft Corporation"
    CompanyName        = "Microsoft Corporation"
    Copyright          = "Microsoft Corporation. All rights reserved."
    ModuleVersion      = "1.0.0.0"
    Description        = "Windows PowerShell File Transfer Module"
    PowerShellVersion  = "2.0"
    CLRVersion         = "2.0"
    NestedModules      = "Microsoft.BackgroundIntelligentTransfer.Management"
    FormatsToProcess   = "FileTransfer.Format.ps1xml"
    RequiredAssemblies = Join-Path $psScriptRoot "Microsoft.BackgroundIntelligentTransfer.Management.Interop.dll"
}

最初のコマンドは、BitsTransfer モジュールを表す PSModuleInfo オブジェクトを取得します。 $m変数にオブジェクトを保存します。

2 番目のコマンドでは、 Get-Content コマンドレットを使用して、指定したパス内のマニフェスト ファイルの内容を取得します。 ドット表記を使用してマニフェスト ファイルへのパスを取得します。マニフェスト ファイルは、オブジェクトの Path プロパティに格納されます。 出力には、モジュール マニフェストの内容が表示されます。

例 8: モジュール ディレクトリ内のファイルを一覧表示する

dir (Get-Module -ListAvailable FileTransfer).ModuleBase

Directory: C:\Windows\system32\WindowsPowerShell\v1.0\Modules\FileTransfer
Mode                LastWriteTime     Length Name
----                -------------     ------ ----
d----        12/16/2008  12:36 PM            en-US
-a---        11/19/2008  11:30 PM      16184 FileTransfer.Format.ps1xml
-a---        11/20/2008  11:30 PM       1044 FileTransfer.psd1
-a---        12/16/2008  12:20 AM     108544 Microsoft.BackgroundIntelligentTransfer.Management.Interop.dll

このコマンドは、モジュールのディレクトリ内のファイルを一覧表示します。 これは、インポートの前にモジュールの内容を確認するためのもう 1 つの方法です。 モジュールによっては、ヘルプ ファイルやモジュールについて記述した ReadMe ファイルが含まれている場合があります。

例 9: コンピューターにインストールされているモジュールを取得する

$s = New-PSSession -ComputerName Server01

Get-Module -PSSession $s -ListAvailable

これらのコマンドは、Server01 コンピューターにインストールされているモジュールを取得します。

最初のコマンドでは、 New-PSSession コマンドレットを使用して、Server01 コンピューターに PSSession を作成します。 このコマンドは、 PSSession を $s 変数に保存します。

2 番目のコマンドでは、Get-Module の PSSession パラメーターと ListAvailable パラメーターを使用して、$s変数の PSSession 内のモジュールを取得します。

他のセッションから Import-Module コマンドレットにモジュールをパイプする場合、 Import-Module 暗黙的なリモート処理機能を使用して、モジュールを現在のセッションにインポートします。 これは、 Import-PSSession コマンドレットの使用と同じです。 現在のセッションに含まれるモジュールのコマンドレットを使用することができますが、これらのコマンドレットを使用するコマンドは、実際にはリモート セッションで実行されます。 詳細については、次のトピックを参照してください。 Import-Module および Import-PSSession

例 10: Windows オペレーティング システムを実行しないコンピューターを管理する

この例のコマンドを使用すると、Windows オペレーティング システムを実行していないリモート コンピューターのストレージ システムを管理できます。 この例では、コンピューターの管理者によってモジュール検出用の WMI プロバイダーがインストールされているため、CIM コマンドでプロバイダー用の既定値を使用できます。

$cs = New-CimSession -ComputerName RSDGF03
Get-Module -CimSession $cs -Name Storage | Import-Module
Get-Command Get-Disk

CommandType     Name                  ModuleName
-----------     ----                  ----------
Function        Get-Disk              Storage

Get-Disk

Number Friendly Name              OperationalStatus          Total Size Partition Style
------ -------------              -----------------          ---------- ---------------
0      Virtual HD ATA Device      Online                          40 GB MBR

最初のコマンドでは、 New-CimSession コマンドレットを使用して、RSDGF03リモート コンピューターにセッションを作成します。 セッションは、リモート コンピューター上の WMI に接続します。 このコマンドは、CIM セッションを $cs 変数に保存します。

2 番目のコマンドでは、 $cs 変数の CIM セッションを使用して、RSDGF03 コンピューターで Get-Module コマンドを実行します。 このコマンドでは、 Name パラメーターを使用して Storage モジュールを指定します。 このコマンドでは、パイプライン 演算子 (|) を使用して Storage モジュールを Import-Module コマンドレットに送信し、ローカル セッションにインポートします。

3 番目のコマンドは、Storage モジュールの Get-Disk コマンドで Get-Command コマンドレットを実行します。 CIM モジュールをローカル セッションにインポートすると、PowerShell は CIM モジュールを表す CDXML ファイルを PowerShell スクリプトに変換します。これは、ローカル セッションの関数として表示されます。

4 番目のコマンドは、 Get-Disk コマンドを実行します。 コマンドはローカル セッションで入力されますが、インポート元のリモート コンピューターで暗黙的に実行されます。 このコマンドは、リモート コンピューターからオブジェクトを取得し、ローカル セッションに返します。

パラメーター

-All

-CimNamespace

-CimResourceUri

-CimSession

-FullyQualifiedName

-ListAvailable

-Name

-PSEdition

-PSSession

-Refresh

入力

String

このコマンドレットにモジュール名をパイプできます。

出力

PSModuleInfo

このコマンドレットは、モジュールを表すオブジェクトを返します。 ListAvailable パラメーターを指定すると、Get-Moduleは同じプロパティとメソッドを持つ PSModuleInfo オブジェクトの型である ModuleInfoGrouping オブジェクトを返します。

メモ

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

• gmo

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

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

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

• Get-Module は、 PSModulePath 環境変数 ($env:PSModulePath) の値に格納されている場所のモジュールのみを取得します。 Import-Module コマンドレットは他の場所にモジュールをインポートできますが、Get-Module コマンドレットを使用してモジュールを取得することはできません。

• また、PowerShell 3.0 以降では、 Get-Module 返されるオブジェクトに新しいプロパティが追加され、モジュールがインポートされる前でも簡単に理解できるようになりました。 インポートする前に、すべてのプロパティが設定されます。 これには、 ExportedCommands、 ExportedCmdlets モジュールがエクスポートするコマンドを一覧表示する ExportedFunctions プロパティが含まれます。

• ListAvailable パラメーターは、整形式のモジュール、つまり、基本名がモジュール フォルダーの名前と同じ 1 つ以上のファイルを含むフォルダーのみを取得します。 ベース名は、ファイル名拡張子のない名前です。 異なる名前のファイルを含むフォルダーはコンテナーと見なされますが、モジュールと見なされません。

  DLL ファイルとして実装されているが、モジュール フォルダーに囲まれていないモジュールを取得するには、 ListAvailable パラメーターと All パラメーターの両方を指定します。

• CIM セッション機能を使用するには、リモート コンピューターにおいて、WS-Management リモート処理と Common Information Model (CIM) 標準の Microsoft 実装である Windows Management Instrumentation (WMI) が必要です。 さらに、モジュール検出用の WMI プロバイダーまたは同じ基本機能を備えた代替 WMI プロバイダーもコンピューターに必要です。

  CIM セッション機能は、Windows オペレーティング システムを実行していないコンピューターと、PowerShell が有効になっているが PowerShell リモート処理が有効になっていない Windows コンピューターで使用できます。

  CIM パラメーターを使用して、PowerShell リモート処理が有効になっているコンピューターから CIM モジュールを取得することもできます。 これには、ローカル コンピューターが含まれます。 ローカル コンピューターで CIM セッションを作成すると、PowerShell は WMI ではなく DCOM を使用してセッションを作成します。

関連リンク

• Get-CimSession
• New-CimSession
• about_Modules
• Get-PSSession
• Import-Module
• Import-PSSession
• New-PSSession
• Remove-Module