Update-Module
Downloads and installs the newest version of specified modules from an online gallery to the local computer.
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.
This is a proxy cmdlet for the Update-PSResource cmdlet in the
Microsoft.PowerShell.PSResourceGet. For more information, see
Update-PSResource.
Examples
Example 1: Update all modules
This example updates all installed modules to the newest version in an online gallery.
Update-ModuleExample 2: Update a module by name
This example updates a specific module to the newest version in an online gallery.
Update-Module -Name SpeculationControlUpdate-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.14Update-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 -ForceUpdate-Module uses the Name parameter to specify the module, SpeculationControl. The
Force parameter updates the module without requesting user confirmation.
Parameters
-AcceptLicense
Automatically accept the license agreement during installation if the package requires it.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllowPrerelease
Allows you to update a module with the newer module marked as a prerelease.
The proxy cmdlet maps this parameter to the Prerelease parameter of Update-PSResource.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running Update-Module.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Specifies a user account that has permission to update a module.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Force
Forces an update of each specified module without a prompt to request confirmation. If the module is already installed, Force reinstalls the module.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaximumVersion
The proxy cmdlet uses the value of this parameter to create a NuGet version search string for use
with the Version parameter of Update-PSResource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies the names of one or more modules to update. Update-Module searches $env:PSModulePath
for the modules to update. If no matches are found in $env:PSModulePath for the specified module
name, an error occurs.
Wildcards are accepted in module names. If you add wildcard characters to the specified name and no matches are found, no error occurs.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Proxy
The proxy cmdlet ignores this parameter since it's not supported by Update-PSResource.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ProxyCredential
The proxy cmdlet ignores this parameter since it's not supported by Update-PSResource.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-RequiredVersion
The proxy cmdlet uses the value of this parameter to create a NuGet version search string for use
with the Version parameter of Update-PSResource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Scope
Specifies the installation scope of the module. The acceptable values for this parameter are AllUsers and CurrentUser. If Scope isn't specified, the update is installed in the CurrentUser scope.
The AllUsers scope requires elevated permissions and installs modules in a location that is accessible to all users of the computer:
$env:ProgramFiles\PowerShell\Modules
The CurrentUser doesn't require elevated permissions and installs modules in a location that is accessible only to the current user of the computer:
$HOME\Documents\PowerShell\Modules
When no Scope is defined, the default is set based on the PowerShellGet version.
- In PowerShellGet versions 2.0.0 and above, the default is CurrentUser, which does not require elevation for install.
- In PowerShellGet 1.x versions, the default is AllUsers, which requires elevation for install.
| Type: | String |
| Accepted values: | CurrentUser, AllUsers |
| Position: | Named |
| Default value: | CurrentUser |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if Update-Module runs. The cmdlet isn't run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
String[]
Outputs
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.
The PowerShell Gallery no longer supports Transport Layer Security (TLS) versions 1.0 and 1.1. You must use TLS 1.2 or higher. Use the following command to ensure you are using TLS 1.2:
[Net.ServicePointManager]::SecurityProtocol = [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12
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.
