Install-Module

Syntax

Install-Module
       [-Name] <String[]>
       [-MinimumVersion <Version>]
       [-MaximumVersion <Version>]
       [-RequiredVersion <Version>]
       [-Repository <String[]>]
       [-Credential <PSCredential>]
       [-Scope <String>]
       [-Proxy <Uri>]
       [-ProxyCredential <PSCredential>]
       [-AllowClobber]
       [-SkipPublisherCheck]
       [-Force]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Install-Module
       -InputObject <PSObject[]>
       [-Credential <PSCredential>]
       [-Scope <String>]
       [-Proxy <Uri>]
       [-ProxyCredential <PSCredential>]
       [-AllowClobber]
       [-SkipPublisherCheck]
       [-Force]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

The Install-Module cmdlet gets one or more modules that meet specified criteria from an online gallery, verifies that search results are valid modules, and copies module folders to the installation location.

When no scope is defined, or when the value of the Scope parameter is AllUsers, the module is installed to %systemdrive%:\Program Files\WindowsPowerShell\Modules. When the value of Scope is CurrentUser, the module is installed to $home\Documents\WindowsPowerShell\Modules.

You can filter your results based on minimum and exact versions of specified modules.

Examples

Example 1: Find a module and install it

PS C:\> Find-Module -Name "MyDSC*" | Install-Module

In this example, modules with a name that starts with MyDSC that are found by Find-Module in the online gallery are installed to the default folder, C:\ProgramFiles\WindowsPowerShell\Modules.

Example 2: Install a module by name

PS C:\> Install-Module -Name "MyDscModule"

In this example, the newest version of the module MyDscModule from the online gallery is installed to the default folder, Program Files.

If no module named MyDscModule exists, an error occurs.

Example 3: Install a module using its minimum version

PS C:\> Install-Module -Name "ContosoServer" -MinimumVersion 1.0

In this example, the most current version of the module ContosoServer is installed that matches the specified minimum version. If the most current version of the module is a lower number than 1.0, the command returns errors.

Example 4: Install a specific version of a module

PS C:\> Install-Module -Name "ContosoServer" -RequiredVersion 1.1.3

This example installs version 1.1.3 of the module ContosoServer to the Program Files folder. If version 1.1.3 is not available, an error occurs.

Example 5: Install the current version of a module

PS C:\> Install-Module -Name "ContosoServer" -Scope "CurrentUser"

This example installs the newest version of the module ContosoServer to $home\Documents\WindowsPowerShell\Modules.

Required Parameters

Optional Parameters

Inputs

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.

  If an installed module cannot be imported (that is, if it does not have a .psm1, .psd1, or .dll of the same name within the folder), installation fails unless you add the Force parameter to your command.

  If a version of the module on the computer matches the value specified for the Name parameter, and you have not added the MinimumVersion or RequiredVersion parameter, Install-Module silently continues without installing that module. If the MinimumVersion or RequiredVersion parameters are specified, and the existing module does not match the values in that parameter, then an error occurs. To be more specific: if the version of the currently-installed module is either lower than the value of the MinimumVersion parameter, or not equal to the value of the RequiredVersion parameter, an error occurs. If the version of the installed module is greater than the value of the MinimumVersion parameter, or equal to the value of the RequiredVersion parameter, Install-Module silently continues without installing that module.

  Install-Module returns an error if no module exists in the online gallery that matches the specified name.

  To install multiple modules, specify an array of the module names, separated by commas. You cannot add MinimumVersion or RequiredVersion if you specify multiple module names.

  By default, modules are installed to the Program Files folder, to prevent confusion when you are installing Windows PowerShell Desired State Configuration (DSC) resources.You can pipe multiple PSGetItemInfo objects to Install-Module; this is another way of specifying multiple modules to install in a single command.

  To help prevent running modules that contain malicious code, installed modules are not automatically imported by installation. As a security best practice, evaluate module code before running any cmdlets or functions in a module for the first time.

Related Links

• Find-Module
• Publish-Module
• Uninstall-Module
• Update-Module