Freigeben über

Add-PSSnapin

  • Referenz
Modul:
Microsoft.PowerShell.Core

Fügt ein oder mehrere Windows PowerShell-Snap-Ins zur aktuellen Sitzung hinzu.

Syntax

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

Beschreibung

Das Cmdlet Add-PSSnapin fügt der aktuellen Sitzung registrierte Windows PowerShell Snap-Ins hinzu. Nach dem Hinzufügen der Snap-Ins können Sie die von den Snap-Ins unterstützten Cmdlets und Anbieter in der aktuellen Sitzung verwenden.

Um das Snap-In allen zukünftigen Windows PowerShell-Sitzungen hinzuzufügen, fügen Sie Ihrem Windows PowerShell profil einen Add-PSSnapin-Befehl hinzu. Weitere Informationen finden Sie unter „about_Profiles“.

Ab Windows PowerShell 3.0 sind die in Windows PowerShell enthaltenen Hauptbefehle in Module gepackt. Eine Ausnahme ist das Snap-In Microsoft.PowerShell.Core (PSSnapin). Standardmäßig wird nur das Microsoft.PowerShell.Core-Snap-In der Sitzung hinzugefügt. Module werden bei der ersten Verwendung automatisch importiert, und Sie können sie mit dem Cmdlet Import-Module importieren.

Beispiele

Beispiel 1: Hinzufügen von Snap-Ins

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

Dieser Befehl fügt die Microsoft Exchange- und Active Directory-Snap-Ins zur aktuellen Sitzung hinzu.

Beispiel 2: Hinzufügen aller registrierten Snap-Ins

PS C:\> Get-PSSnapin -Registered | Add-PSSnapin -Passthru

Dieser Befehl fügt alle registrierten Windows PowerShell-Snap-Ins zur Sitzung hinzu. Es verwendet das Cmdlet Get-PSSnapin mit dem Parameter Registered , um Objekte abzurufen, die die einzelnen registrierten Snap-Ins darstellen. Der Pipelineoperator (|) übergibt das Ergebnis an Add-PSSnapin, das sie der Sitzung hinzufügt. Der PassThru-Parameter gibt Objekte zurück, die die einzelnen hinzugefügten Snap-Ins darstellen.

Beispiel 3: Registrieren eines Snap-Ins und Hinzufügen des Snap-Ins

The first command gets snap-ins that have been added to the current session that include the snap-ins that are installed with Windows PowerShell. In this example, ManagementFeatures is not returned. This indicates that it has not been added to the session.
PS C:\> Get-PSSnapin

The second command gets snap-ins that have been registered on your system, which includes those that have already been added to the session. It does not include the snap-ins that are installed with Windows PowerShell. In this case, the command does not return any snap-ins. This indicates that the ManagementFeatures snapin has not been registered on the system.
PS C:\> Get-PSSnapin -Registered

The third command creates an alias, installutil, for the path of the InstallUtil tool in .NET Framework.
PS C:\> 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 of ManagementCmdlets.dll, the file name or module name of the snap-in.
PS C:\> 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.
PS C:\> 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, ManagementFeatures, not the file name.
PS C:\> 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 items that were added to the session by a snap-in or module.
PS C:\> Get-Command -Module ManagementFeatures

You can also use the **PSSnapin** property of the object that the **Get-Command** cmdlet returns to find the snap-in or module in which a cmdlet originated. The eighth command uses dot notation to find the value of the PSSnapin property of the Set-Alias cmdlet.
PS C:\> (Get-Command Set-Alias).pssnapin

In diesem Beispiel wird veranschaulicht, wie ein Snap-In im System registriert und dann der Sitzung hinzugefügt wird. Es verwendet ManagementFeatures, ein fiktives Snap-In, das in einer Datei namens ManagementCmdlets.dll implementiert wird.

Parameter

-Name

Gibt den Namen des Snap-Ins an. Dies ist der Name, nicht assemblyName oder ModuleName. Platzhalter sind zulässig.

Um die Namen der registrierten Snap-Ins auf Ihrem System zu ermitteln, geben Sie ein Get-PSSnapin -Registered.

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

-PassThru

Gibt an, dass dieses Cmdlet ein Objekt zurückgibt, das jedes hinzugefügte Snap-In darstellt. Standardmäßig wird von diesem Cmdlet keine Ausgabe generiert.

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

Eingaben

None

Objekte können nicht an dieses Cmdlet weitergereicht werden.

Ausgaben

None or System.Management.Automation.PSSnapInInfo

Dieses Cmdlet gibt ein PSSnapInInfo-Objekt zurück, das das Snap-In darstellt, wenn Sie den PassThru-Parameter angeben. Andernfalls wird von diesem Cmdlet keine Ausgabe generiert.

Hinweise

  • Ab Windows PowerShell 3.0 sind die mit Windows PowerShell installierten Hauptbefehle in Module gepackt. In Windows PowerShell 2.0 und in Hostprogrammen, die Sitzungen im älteren Stil in späteren Versionen von Windows PowerShell erstellen, werden die Kernbefehle in Snap-Ins (PSSnapins) verpackt. Die Ausnahme ist Microsoft.PowerShell.Core, bei der es sich immer um ein Snap-In handelt. Außerdem handelt es sich bei Remotesitzungen, z. B. bei Sitzungen, die vom Cmdlet New-PSSession gestartet werden, um Sitzungen im älteren Stil, die Kern-Snap-Ins enthalten.

    Informationen zur CreateDefault2-Methode , mit der Sitzungen im neueren Stil mit Kernmodulen erstellt werden, finden Sie unter CreateDefault2-Methode in der MSDN Library.

  • Weitere Informationen zu Snap-Ins finden Sie unter about_PSSnapins und Create eines Windows PowerShell Snap-Ins in der MSDN Library.

  • Add-PSSnapin fügt das Snap-In nur der aktuellen Sitzung hinzu. Um das Snap-In zu allen Windows PowerShell-Sitzungen hinzuzufügen, fügen Sie es zu Ihrem Windows PowerShell-Profil hinzu. Weitere Informationen finden Sie unter „about_Profiles“.

  • Sie können jedes snap-In hinzufügen, das mit dem Microsoft .NET Framework Install-Hilfsprogramm registriert wurde. Weitere Informationen finden Sie unter Registrieren von Cmdlets, Anbietern und Hostanwendungen in der MSDN Library.

  • Um eine Liste der Snap-Ins abzurufen, die auf Ihrem Computer registriert sind, geben Sie ein Get-PSSnapin -Registered.

  • Vor dem Hinzufügen eines Snap-Ins überprüft Add-PSSnapin die Version des Snap-Ins, um sicherzustellen, dass es mit der aktuellen Version von Windows PowerShell kompatibel ist. Wenn das Snap-In die Versionsprüfung nicht besteht, meldet Windows PowerShell einen Fehler.