Remove-Module

Module:: Microsoft.PowerShell.Core

Removes modules from the current session.

Syntax

Remove-Module
      [-Name] <String[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-Module
      [-FullyQualifiedName] <ModuleSpecification[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Remove-Module
      [-ModuleInfo] <PSModuleInfo[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-Module cmdlet removes the members of a module, such as cmdlets and functions, from the current session.

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

This cmdlet does not uninstall the module or delete it from the computer. It affects only the current Windows PowerShell session.

Examples

Example 1: Remove a module

PS C:\> Remove-Module -Name "BitsTransfer"

This command removes the BitsTransfer module from the current session.

Example 2: Remove all modules

PS C:\> Get-Module | Remove-Module

This command removes all modules from the current session.

Example 3: Remove modules by using the pipeline

PS C:\> "FileTransfer", "PSDiagnostics" | Remove-Module -Verbose

VERBOSE: Performing operation "Remove-Module" on Target "filetransfer (Path: 'C:\Windows\system32\WindowsPowerShell\v1.0\Modules\filetransfer\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.BackgroundIntelligentTransfe

r.Management.dll')".

VERBOSE: Performing operation "Remove-Module" on Target "psdiagnostics (Path: 'C:\Windows\system32\WindowsPowerShell\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\WindowsPowerShell\v1.0\Modules\psdiagnostics\PSDiagnostics.psm1')".

This command removes the BitsTransfer 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 parameter 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 includes a module script file (.psm1) that exports functions.

Example 4: Remove a module by using ModuleInfo

PS C:\> $a = Get-Module BitsTransfer

PS C:\> Remove-Module -ModuleInfo $a

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

Required Parameters

-FullyQualifiedName

Specifies the fully qualified names of modules to remove.

Type:	ModuleSpecification[]
Position:	0
Default value:	None
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-ModuleInfo

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

Type:	PSModuleInfo[]
Position:	0
Default value:	None
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-Name

Specifies the names of modules to remove. Wildcard characters are permitted. You can also pipe name strings to Remove-Module .

Type:	String[]
Position:	0
Default value:	None
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Indicates that this cmdlet removes read-only modules. By default, Remove-Module removes only read-write modules.

The ReadOnly and ReadWrite values are stored in AccessMode property of a module.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

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

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

System.String, System.Management.Automation.PSModuleInfo

You can pipe module names and module objects to Remove-Module .

Outputs

None

This cmdlet does not generate any output.

Notes

When removing a module, there is an event on the module that will execute. This event allows a module to react to being removed and perform some cleanup such as freeing up resources. Example:

$OnRemoveScript = {

# perform cleanup

$cachedSessions | Remove-PSSession

}

$ExecutionContext.SessionState.Module.OnRemove += $OnRemoveScript

For full consistency, it might be also useful to react to the closing of the PowerShell process: