powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Remove-Module



NAME
Remove-Module

SYNOPSIS
Removes modules from the current session.

SYNTAX
Remove-Module [-ModuleInfo] [-Force] [-Confirm] [-WhatIf] []

Remove-Module [-Name] [-Force] [-Confirm] [-WhatIf] []


DESCRIPTION
The Remove-Module cmdlet removes the members of a module from the current session.

If the module includes an assembly (.dll), all members that are implemented by the assembly are removed, but the as
sembly is not unloaded.


PARAMETERS
-Force []
Removes modules even when their access mode is read-only.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-ModuleInfo
Specifies the module objects to remove. Enter a variable that contains a module object (PSModuleInfo) or a comm
and that gets a module object, such as a Get-Module command. You can also pipe module objects to Remove-Module.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-Name
Specifies the names of modules to remove. Wildcards are permitted. You can also pipe name strings to Remove-Mo
dule.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Confirm []
Prompts you for confirmation before executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf []
Describes what would happen if you executed the command without actually executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
System.String, System.Management.Automation.PSModuleInfo
You can pipe module names (strings) and module objects to Remove-Module.


OUTPUTS
None
Remove-Module does not generate any output.


NOTES


You can also refer to Remove-Module by its alias, "rmo". For more information, see about_Aliases.


-------------------------- EXAMPLE 1 --------------------------

C:\PS>remove-module -name BitsTransfer


Description
-----------
This command removes the BitsTransfer module from the current session.





-------------------------- EXAMPLE 2 --------------------------

C:\PS>get-module | remove-module


Description
-----------
This command removes all modules from the current session.





-------------------------- EXAMPLE 3 --------------------------

C:\PS>"FileTransfer", "PSDiagnostics" | remove-module -verbose

VERBOSE: Performing operation "Remove-Module" on Target "filetransfer (Path: 'C:\Windows\system32\WindowsPowerShell
\v1.0\Modules\f
iletransfer\filetransfer.psd1')".
VERBOSE: Performing operation "Remove-Module" on Target "Microsoft.BackgroundIntelligentTransfer.Management (Path:
'C:\Windows\
assembly\GAC_MSIL\Microsoft.BackgroundIntelligentTransfer.Management\1.0.0.0__31bf3856ad364e35\Microsoft.Background
IntelligentTransfe
r.Management.dll')".
VERBOSE: Performing operation "Remove-Module" on Target "psdiagnostics (Path: 'C:\Windows\system32\WindowsPowerShel
l\v1.0\Modules\
psdiagnostics\psdiagnostics.psd1')".
VERBOSE: Removing imported function 'Start-Trace'.
VERBOSE: Removing imported function 'Stop-Trace'.
VERBOSE: Removing imported function 'Enable-WSManTrace'.
VERBOSE: Removing imported function 'Disable-WSManTrace'.
VERBOSE: Removing imported function 'Enable-PSWSManCombinedTrace'.
VERBOSE: Removing imported function 'Disable-PSWSManCombinedTrace'.
VERBOSE: Removing imported function 'Set-LogProperties'.
VERBOSE: Removing imported function 'Get-LogProperties'.
VERBOSE: Removing imported function 'Enable-PSTrace'.
VERBOSE: Removing imported function 'Disable-PSTrace'.
VERBOSE: Performing operation "Remove-Module" on Target "PSDiagnostics (Path: 'C:\Windows\system32\WindowsPowerShel
l\v1.0\Modules\
psdiagnostics\PSDiagnostics.psm1')".


Description
-----------
This command removes the FileTransfer and PSDiagnostics modules from the current session.

The command uses a pipeline operator (|) to send the module names to Remove-Module. It uses the Verbose common para
meter to get detailed information about the members that are removed.

The Verbose messages show the items that are removed. The messages differ because the BitsTransfer module includes
an assembly that implements its cmdlets and a nested module with its own assembly. The PSDiagnostics module include
s a module script file (.psm1) that exports functions.





-------------------------- EXAMPLE 4 --------------------------

C:\PS>$a = get-module BitsTransfer

C:\PS> remove-module -moduleInfo $a


Description
-----------
This command uses the ModuleInfo parameter to remove the BitsTransfer module.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=141556
Get-Module
Import-Module
about_modules