Table of contents
- 1. Synopsis
- 2. Syntax
- 3. Related Commands
- 4. Detailed Description
- 5. Parameters
- 5.1.1. -Name [<string[]>]
- 5.1.2. -Registered [<SwitchParameter>]
- 5.2. Input Type
- 5.3. Return Type
- 6. Notes
- 7. Examples
Synopsis
Gets the Windows PowerShell snap-ins on the computer.
Syntax
Get-PSSnapin [[-Name] <string[]>] [-Registered] [<CommonParameters>]
Detailed Description
The Get-PSSnapin cmdlet gets the Windows PowerShell snap-ins that have been added to the current session or that have been registered on the system. The snap-ins are listed in the order in which they are detected. Get-PSSnapin gets only registered snap-ins. To register a Windows PowerShell snap-in, use the InstallUtil tool included with the Microsoft .NET Framework 2.0. For more information, see "How to Register Cmdlets, Providers, and Host Applications" in the MSDN (Microsoft Developer Network) library at http://go.microsoft.com/fwlink/?LinkId=143619.Parameters
-Name [<string[]>]
Gets only the specified Windows PowerShell snap-ins. Enter the names of one or more Windows PowerShell snap-ins. Wildcards are permitted.
The parameter name ("Name") is optional.
| Required? | false |
|---|---|
| Position? | 1 |
| Default value? | |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
-Registered [<SwitchParameter>]
Gets the Windows PowerShell snap-ins that have been registered on the system (even if they have not yet been added to the session).
The snap-ins that are installed with Windows PowerShell do not appear in this list.
Without this parameter, Get-PSSnapin gets the Windows PowerShell snap-ins that have been added to the session.
| Required? | false |
|---|---|
| Position? | named |
| Default value? | |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
Input Type
None
You cannot pipe input to Get-PSSnapin.
Return Type
System.Management.Automation.PSSnapInInfo
Get-PSSnapin returns an object for each snap-in that it gets.
Notes
You can refer to Get-PSSnapin by its built-in alias, "psnp". For more information, see about_Aliases.
Examples
EXAMPLE 1
C:\PS> get-PSSnapIn
This command gets the Windows PowerShell snap-ins that are currently loaded in the session. This includes the snap-ins that are installed with Windows PowerShell and those that have been added to the session.
EXAMPLE 2
C:\PS> get-PSSnapIn -registered
This command gets the Windows PowerShell snap-ins that have been registered on the computer, including those that have already been added to the session. The output does not include snap-ins that are installed with Windows PowerShell or Windows PowerShell snap-in dynamic-link libraries (DLLs) that have not yet been registered on the system.
EXAMPLE 3
C:\PS> get-PSSnapIn smp*
This command gets the Windows PowerShell snap-ins in the current session that have names that begin with "smp".
Comments