Update-Module

Syntax

Update-Module
      [[-Name] <String[]>]
      [-RequiredVersion <String>]
      [-MaximumVersion <String>]
      [-Credential <PSCredential>]
      [-Scope <String>]
      [-Proxy <Uri>]
      [-ProxyCredential <PSCredential>]
      [-Force]
      [-AllowPrerelease]
      [-AcceptLicense]
      [-PassThru]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-Module cmdlet installs a module's newest version from an online gallery. You're prompted to confirm the update before it's installed. Updates are installed only for modules that were installed on the local computer with Install-Module. Update-Module searches $env:PSModulePath for installed modules.

Update-Module with no parameters specified updates all installed modules. To specify a module to update, use the Name parameter. You can update to a module's specific version using the RequiredVersion parameter.

The parameters that take module version numbers expect strings formatted as version numbers.

• Standard version numbers have a format of x.y.z where x, y, and z are numbers
• Prerelease versions have a format of x.y.z-<prerelease_label> where the <prerelease_label> is arbitrary string assigned to that release.

If an installed module is already the newest version, the module isn't updated. If the module isn't found in $env:PSModulePath, an error is displayed.

To display the installed modules, use Get-InstalledModule.

Examples

Example 1: Update all modules

This example updates all installed modules to the newest version in an online gallery.

Update-Module

Example 2: Update a module by name

This example updates a specific module to the newest version in an online gallery.

Update-Module -Name SpeculationControl

Update-Module uses the Name parameter to update a specific module, SpeculationControl.

Example 3: View what-if Update-Module runs

This example does a what-if scenario to show what happens if Update-Module is run. The command isn't run.

Update-Module -WhatIf

What if: Performing the operation "Update-Module" on target "Version '2.8.0' of module
  'Carbon', updating to version '2.8.1'".
What if: Performing the operation "Update-Module" on target "Version '1.0.10' of module
  'SpeculationControl', updating to version '1.0.14'".

Update-Module uses the WhatIf parameter display what would happen if Update-Module were run.

Example 4: Update a module to a specified version

In this example, a module is updated to a specific version. The version must exist in the online gallery or an error is displayed.

Update-Module -Name SpeculationControl -RequiredVersion 1.0.14

Update-Module uses the Name parameter to specify the module, SpeculationControl. The RequiredVersion parameter specifies the version, 1.0.14.

Example 5: Update a module without confirmation

This example doesn't request confirmation to update the module to the newest version from an online gallery. If the module is already installed, the Force parameter reinstalls the module.

Update-Module -Name SpeculationControl -Force

Update-Module uses the Name parameter to specify the module, SpeculationControl. The Force parameter updates the module without requesting user confirmation.

Parameters

-AcceptLicense

-AllowPrerelease

-Confirm

-Credential

-Force

-MaximumVersion

-Name

-PassThru

-Proxy

-ProxyCredential

-RequiredVersion

-Scope

-WhatIf

Inputs

String[]

String

PSCredential

Uri

Outputs

Object

Notes

PowerShell includes the following aliases for Update-Module:

• All platforms:
  • upmo

For PowerShell version 6.0 and above, the default installation scope is always CurrentUser. Module updates for CurrentUser, $HOME\Documents\PowerShell\Modules, don't need elevated permissions. Module updates for AllUsers, $env:ProgramFiles\PowerShell\Modules, need elevated permissions.

Update-Module runs on PowerShell 3.0 or later releases of PowerShell, on Windows 7 or Windows 2008 R2 and later releases of Windows.

If the module that you specify with the Name parameter wasn't installed using Install-Module, an error occurs.

You can only run Update-Module on modules that you installed from the online gallery by running Install-Module.

If Update-Module attempts to update binaries that are in use, Update-Module returns an error that identifies the problem processes. The user is informed to retry Update-Module after the processes are stopped.

Related Links

• Find-Module
• Get-InstalledModule
• Install-Module
• Publish-Module
• Uninstall-Module