PowerShell Logo Small

Add-PSSnapin



This is the built-in help made by Microsoft for the command 'Add-PSSnapin', in PowerShell version 2 - as retrieved from Windows version 'Microsoft® Windows Vista™ Ultimate ' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Adds one or more Windows PowerShell snap-ins to the current session.

SYNTAX


Add-PSSnapin [-Name] <string[]> [-PassThru] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Add-PSSnapin cmdlet adds registered Windows PowerShell snap-ins to the current session. After the snap-ins are added, you can use the cmdlets
and providers that the snap-ins support in the current session.

To add the snap-in to all future Windows PowerShell sessions, add an Add-PSSnapin command to your Windows PowerShell profile. For more informatio
n, see about_Profiles.



<

RELATED LINKS

Online version: http://go.microsoft.com/fwlink/?LinkID=113281
Get-PSSnapin
Remove-PSSnapin
about_Profiles

REMARKS

<

Examples


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

C:\PS>add-PSSnapIn Microsoft.Exchange, Microsoft.Windows.AD



Description
-----------
This command adds the Microsoft Exchange and Active Directory snap-ins to the current session.








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

C:\PS>get-pssnapin -registered | add-pssnapin -passthru



Description
-----------
This command adds all of the registered Windows PowerShell snap-ins to the session. It uses the Get-PSSnapin cmdlet with the Registered parameter
to get objects representing each of the registered snap-ins. The pipeline operator (|) passes the result to Add-PSSnapin, which adds them to the
session. The PassThru parameter returns objects that represent each of the added snap-ins.








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

C:\PS>get-pssnapin



Description
-----------
This example demonstrates the process of registering a snap-in on your system and then adding it to your session. It uses ManagementFeatures, a f
ictitious snap-in implemented in a file called ManagementCmdlets.dll.

The first command gets snap-ins that have been added to the current session, including the snap-ins that are installed with Windows PowerShell. I
n this example, ManagementFeatures is not returned. This indicates that it has not been added to the session.

get-pssnapin


The second command gets snap-ins that have been registered on your system (including those that have already been added to the session). It does
not include the snap-ins that are installed with Windows PowerShell.

get-pssnapin -registered


In this case, the command does not return any snap-ins. This indicates that the ManagementFeatures snapin has not been registered on the system.

The third command creates an alias, "installutil", for the path to the InstallUtil tool in the .NET Framework.

set-alias installutil $env:windir\Microsoft.NET\Framework\v2.0.50727\installutil.exe


The fourth command uses the InstallUtil tool to register the snap-in. The command specifies the path to ManagementCmdlets.dll, the file name or "
module name" of the snap-in.

installutil C:\Dev\Management\ManagementCmdlets.dll


The fifth command is the same as the second command. This time, you use it to verify that the ManagementCmdlets snap-in is registered.

get-pssnapin -registered

The sixth command uses the Add-PSSnapin cmdlet to add the ManagementFeatures snap-in to the session. It specifies the name of the snap-in, Manage
mentFeatures, not the file name.

add-pssnapin ManagementFeatures

To verify that the snap-in is added to the session, the seventh command uses the Module parameter of the Get-Command cmdlet. It displays the item
s that were added to the session by a snap-in or module.

get-command -module ManagementFeatures

You can also use the PSSnapin property of the object that Get-Command returns to find the snap-in or module in which a cmdlet originated. The eig
hth command uses dot notation to find the value of the PSSnapin property of the Set-Alias command.

(get-command set-alias).pssnapin