Removes modules from the current session. (Remove-Module)
NAMERemove-ModuleSYNOPSISRemoves modules from the current session.SYNTAXRemove-Module [-ModuleInfo] <PSModuleInfo[]> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>] Remove-Module [-Name] <string[]> [-Force] [-Confirm] [-WhatIf] [<CommonParameters>]DESCRIPTIONThe 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 assembly is not unloaded.PARAMETERS-Force [<SwitchParameter>] 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 <PSModuleInfo[]> 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. Required? true Position? 1 Default value Accept pipeline input? true (ByValue) Accept wildcard characters? false -Name <string[]> Specifies the names of modules to remove. Wildcards are permitted. You can also pipe name strings to Remove-Module. Required? true Position? 1 Default value Accept pipeline input? true (ByValue) Accept wildcard characters? true -Confirm [<SwitchParameter>] Prompts you for confirmation before executing the command. Required? false Position? named Default value Accept pipeline input? false Accept wildcard characters? false -WhatIf [<SwitchParameter>] 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 <CommonParameters> This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer and OutVariable. For more information, type, "get-help about_commonparameters".INPUTSSystem.String, System.Management.Automation.PSModuleInfo You can pipe module names (strings) and module objects to Remove-Module.OUTPUTSNone Remove-Module does not generate any output.NOTESYou can also refer to Remove-Module by its alias, "rmo". For more information, see about_Aliases.Examples
EXAMPLE 1C:\PS>remove-module -name BitsTransferDescription----------- This command removes the BitsTransfer module from the current session.EXAMPLE 2C:\PS>get-module | remove-moduleDescription----------- This command removes all modules from the current session.EXAMPLE 3C:\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.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')".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 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 4C:\PS>$a = get-module BitsTransfer C:\PS> remove-module -moduleInfo $aDescription----------- 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 C:\Windows>powershell get-help New-ModuleManifest -full
Microsoft Windows [Version 10.0.19045.3693]
Copyright (c) 2023 Microsoft Corporation.
ColorConsole [Version 3.7.1000] PowerShell 2.0-Export