Uninstall-Module
Uninstalls a module.
Syntax
Uninstall-Module
[-Name] <String[]>
[-MinimumVersion <String>]
[-RequiredVersion <String>]
[-MaximumVersion <String>]
[-AllVersions]
[-Force]
[-AllowPrerelease]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Uninstall-Module
[-InputObject] <PSObject[]>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Description
The Uninstall-Module cmdlet uninstalls a specified module from the local computer. You can't
uninstall a module if other modules depend on it or the module wasn't installed with the
Install-Module cmdlet.
This is a proxy cmdlet for the Uninstall-PSResource cmdlet in the
Microsoft.PowerShell.PSResourceGet. For more information, see
Uninstall-PSResource.
Examples
Example 1: Uninstall a module
This example uninstalls a module.
Uninstall-Module -Name SpeculationControlUninstall-Module uses the Name parameter to specify the module to uninstall from the local
computer.
Example 2: Use the pipeline to uninstall a module
In this example, the pipeline is used to uninstall a module.
Get-InstalledModule -Name SpeculationControl | Uninstall-ModuleGet-InstalledModule uses the Name parameter to specify the module. The object is sent down the
pipeline to Uninstall-Module and is uninstalled.
Parameters
-AllowPrerelease
Allows you to uninstall a module marked as a prerelease.
The proxy cmdlet maps this parameter to the Prerelease parameter of Uninstall-PSResource
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AllVersions
Specifies that you want to include all available versions of a module. You can't use the AllVersions parameter with the MinimumVersion, MaximumVersion, or RequiredVersion parameters.
The proxy cmdlet transforms this parameter to -Version * before calling Uninstall-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 the Uninstall-Module.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
The proxy cmdlet ignores this parameter since it's not supported by Uninstall-PSResource.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Accepts a PSRepositoryItemInfo object. For example, output Get-InstalledModule to a variable
and use that variable as the InputObject argument.
| Type: | PSObject[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| 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 Uninstall-PSResource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-MinimumVersion
The proxy cmdlet uses the value of this parameter to create a NuGet version search string for use
with the Version parameter of Uninstall-PSResource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Name
Specifies an array of module names to uninstall.
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| 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 Uninstall-PSResource.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if Uninstall-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[]
PSObject[]
