Find-Module

Syntax

Find-Module
    [[-Name] <String[]>]
    [-MinimumVersion <Version>]
    [-MaximumVersion <Version>]
    [-RequiredVersion <Version>]
    [-AllVersions]
    [-IncludeDependencies]
    [-Filter <String>]
    [-Tag <String[]>]
    [-Includes <String[]>]
    [-DscResource <String[]>]
    [-RoleCapability <String[]>]
    [-Command <String[]>]
    [-Proxy <Uri>]
    [-ProxyCredential <PSCredential>]
    [-Repository <String[]>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

Description

The Find-Module cmdlet finds modules from the online gallery that match the specified criteria. Find-Module returns a PSGetItemInfo object for each module it finds, which you can be pipe to Install-Module to install.

If the RequiredVersion parameter is not specified, Find-Module returns the latest version of the module that is equal to or greater than the minimum version specified, or the newest version of the module if no minimum version is specified.

If the RequiredVersion parameter is specified, Find-Module only returns the version of the module that exactly matches the specified version. Find-Module searches through all available modules, because name conflicts between sources can occur.

Examples

Example 1: Find a module by name

PS C:\> Find-Module -Name "ContosoServer"

Version       DateUpdated        Name          Description

-------       -----------        ----          -----------

2.0.0.0       5/8/2014 10:30 AM  ContosoServer Cmdlets and DSC resources for managing Contoso Server products.

This command returns a PSGetItemInfo object that represents the ContosoServer module from the online gallery.

Example 2: Find similarly named modules

PS C:\> Find-Module -Name "Contoso*"

This example returns two PSGetItemInfo objects that represent the ContosoServer and ContosoClient modules from the online gallery.

Example 3: Find a module by minimum version

PS C:\> Find-Module -Name ContosoClient -MinimumVersion 3.0.0.0

This example returns a PSGetItemInfo object that represents the newest version of the ContosoClient module that has a minimum version of at least 3.0.0.0. For example, if there is a version 4.0.0.0 ContosoClient module, that is included in the results of this command.

Example 4: Find a module by specific version

PS C:\> Find-Module -Name "ContosoClient" -RequiredVersion 4.5.6.7

This example returns a PSGetItemInfo object that represents version 4.5.6.7 of the ContosoClient module. If the specified version 4.5.6.7 isn't found, an error is returned.

Example 5: Find a module in a specific repository

PS C:\> Find-Module -Name "Contoso" -Repository "myNuGetRepo"

This command returns a PSGetItemInfo object that represents the Contoso module from the myNuGetRepo module source. If the myNuGetRepo source wasn't registered using the Register-PSRepository cmdlet, an error is returned.

Example 6: Find a module in multiple repositories

PS C:\> Register-PSRepository -Name "MySource" -SourceLocation "https://www.myget.org/F/powershellgetdemo/"

PS C:\> Find-Module -Name "Contoso" -Repository "PSGallery","MySource"

Repository    Version   Name                 Description

----------    -------   ----                 -----------

PSGallery     2.0.0.0   ContosoServer        Cmdlets and DSC resources for managing Contoso Server products.

MySource      1.2.0.0   ContosoClient        Cmdlets and DSC resources for managing Contoso Client products.

This command returns PSGetItemInfo objects that represent modules named Contoso found in the PSGallery and the NuGet repository located at https://www.myget.org/F/powershellgetdemo/ .

Example 7: Find a module that contains a DSC resource

PS C:\> Find-Module -Includes "DscResource"

This command returns PSGetItemInfo objects that represent modules that contain DSC resources.

Example 8: Find a module using a filter

PS C:\> Find-Module -Filter "App Domain" -Includes "DscResource"

Repository                Version      Name                                     Description

----------                -------      ----                                     -----------

PSGallery                 1.0.0.0      AppDomainConfig                          Manipulate AppDomain configuration...

This command returns PSGetItemInfo objects that represent modules that contain DSC resources and that match the filter App Domain. Because this example is operating against a NuGet-based repository, the Filter parameter searches through the name, description, and tags for the argument.

Optional Parameters

Outputs

PSGetItemInfo

Notes

• This cmdlet runs on Windows PowerShell 3.0 or later releases of Windows PowerShell, on Windows 7 or Windows 2008 R2 and later releases of Windows.

Related Links

• Install-Module
• Publish-Module
• Save-Module
• Uninstall-Module
• Update-Module