Export (0) Print
Expand All

Remove-PSSnapin

Updated: August 9, 2015

Remove-PSSnapin

Removes Windows PowerShell snap-ins from the current session.

Aliases

The following abbreviations are aliases for this cmdlet: 

  • rsnp

Syntax

Parameter Set: Default
Remove-PSSnapin [-Name] <String[]> [-PassThru] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Remove-PSSnapin cmdlet removes a Windows PowerShell snap-in from the current session. You can use it to remove snap-ins that you have added to Windows PowerShell You cannot use this cmdlet to remove the snap-ins that are installed with Windows PowerShell.

After you remove a snap-in from the current session, the snap-in is still loaded, but the cmdlets and providers in the snap-in are no longer available in the session.

Parameters

-Name<String[]>

Specifies the names of Windows PowerShell snap-ins to remove from the current session. Wildcard characters (*) are permitted.


Aliases

none

Required?

true

Position?

1

Default Value

None

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-PassThru

Returns an object that represents the snap-in. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.Management.Automation.PSSnapInInfo

    You can pipe a snap-in object to this cmdlet.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None, System.Management.Automation.PSSnapInInfo

    This cmdlet generates a System.Management.Automation.PSSnapInInfo object that represents the snap-in, if you specify the PassThru parameter. By default, Remove-PSSnapin does not generate any output.


Notes

  • Remove-PSSnapin does not check the version of Windows PowerShell before removing a snap-in from the session. If a snap-in cannot be removed, a warning appears and the command fails.

  • Remove-PSSnapin affects only the current session. If you have added an Add-PSSnapin command to your Windows PowerShell profile, you should delete the command to remove the snap-in from future sessions. For instructions, type Get-Help about_Profiles.

Examples

Example 1: Remove a snap-in

This command removes the Microsoft.Exchange snap-in from the current session. When the command is complete, the cmdlets and providers that the snap-in supported are not available in the session.


PS C:\> remove-pssnapin -Name Microsoft.Exchange

Example 2: Remove snap-ins by using names with the pipeline

This command removes the Windows PowerShell snap-ins that have names that start with smp from the current session.

The command uses the Get-PSSnapin cmdlet to get objects that represent the snap-ins. The pipeline operator (|) sends the results to the Remove-PSSnapin cmdlet, which removes them from the session. The providers and cmdlets that this snap-in supports are no longer available in the session.

When you pipe objects to Remove-PSSnapin, the names of the objects are associated with the Name parameter, which accepts objects from the pipeline that have a Name property.


PS C:\> Get-PSSnapIn smp* | Remove-PSSnapIn

Example 3: Remove snap-ins by using names

This command removes all Windows PowerShell snap-ins that have names that include event.


PS C:\> Remove-PSSnapin -Name *event*

Related topics

Community Additions

ADD
Show:
© 2016 Microsoft