< Back

Uninstall-Module

Wed Jan 30, 2019 5:57 pm

NAME Uninstall-Module



SYNOPSIS

Uninstalls a module.





SYNTAX

Uninstall-Module [-Name] <String[]> [-AllVersions] [-Confirm] [-Force] [-MaximumVersion <Version>] [-MinimumVersion <Version>] [-RequiredVersion

<Version>] [-WhatIf] [<CommonParameters>]



Uninstall-Module [-InputObject] <PSObject[]> [-Confirm] [-Force] [-WhatIf] [<CommonParameters>]





DESCRIPTION

The Uninstall-Module cmdlet uninstalls the specified module from the local computer. You cannot uninstall a module if it has other modules as

dependencies.





PARAMETERS

-AllVersions [<SwitchParameter>]

Specifies that you want to include all available versions of a module. You cannot use the AllVersions parameter with the MinimumVersion ,

MaximumVersion , or RequiredVersion parameters.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Force [<SwitchParameter>]

Forces the command to run without asking for user confirmation.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-InputObject <PSObject[]>

{{Fill InputObject Description}}



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-MaximumVersion <Version>

Specifies the maximum, or newest, version of the module to uninstall. The MaximumVersion and RequiredVersion parameters are mutually exclusive; you

cannot use both parameters in the same command.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-MinimumVersion <Version>

Specifies the minimum version of the script to uninstall. The MinimumVersion and RequiredVersion parameters are mutually exclusive; you cannot use

both parameters in the same command.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Name <String[]>

Specifies an array of names of modules to uninstall.



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-RequiredVersion <Version>

Specifies the exact version number of the module to uninstall.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES









Example 1: Get a module and uninstall it



PS C:\\>Get-InstalledModule -Name "xPSDesiredStateConfiguration" -RequiredVersion 3.6.0.0 | Uninstall-Module



This command gets version 3.6.0.0 of the module named xPSDesiredStateConfiguration, and then uses the pipeline operator to pass it to the

Uninstall-Module cmdlet, which uninstalls it.



RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=821673

Find-Module

Get-InstalledModule

Publish-Module

Save-Module

Update-Module