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 Add-PSSnapin Cmdlet 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. Die Ausnahme ist Microsoft.PowerShell.Core, ein Snap-In (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 das Cmdlet Import-Module verwenden, um sie zu 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 jedes der 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 jedes der hinzugefügten Snap-Ins darstellen.

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

Der erste Befehl ruft Snap-Ins ab, die der aktuellen Sitzung hinzugefügt wurden, die die Mit Windows PowerShell installierten Snap-Ins enthalten. In diesem Beispiel wird "ManagementFeatures" nicht zurückgegeben. Dies gibt an, dass sie der Sitzung nicht hinzugefügt wurde.

Der zweite Befehl ruft Snap-Ins ab, die auf Ihrem System registriert wurden, einschließlich derjenigen, die der Sitzung bereits hinzugefügt wurden. Sie enthält nicht die Snap-Ins, die mit Windows PowerShell installiert sind. In diesem Fall gibt der Befehl keine Snap-Ins zurück. Dies gibt an, dass das ManagementFeatures-Snapin nicht im System registriert wurde.

Der dritte Befehl erstellt einen Alias, installutil, für den Pfad des InstallUtil-Tools in .NET Framework.

Der vierte Befehl verwendet das InstallUtil-Tool, um das Snap-In zu registrieren. Der Befehl gibt den Pfad ManagementCmdlets.dll, den Dateinamen oder modulnamen des Snap-Ins an.

Der fünfte Befehl ist identisch mit dem zweiten Befehl. Dieses Mal verwenden Sie es, um zu überprüfen, ob das ManagementCmdlets-Snap-In registriert ist.

Der sechste Befehl verwendet das Add-PSSnapin Cmdlet, um das ManagementFeatures-Snap-In zur Sitzung hinzuzufügen. Er gibt den Namen des Snap-Ins,ManagementFeatures und nicht den Dateinamen an.

Um zu überprüfen, ob das Snap-In der Sitzung hinzugefügt wird, verwendet der siebte Befehl den Parameter "Module " des Cmdlets "Get-Command". Es zeigt die Elemente an, die der Sitzung durch ein Snap-In oder Modul hinzugefügt wurden.

Sie können auch die PSSnapin-Eigenschaft des Objekts verwenden, das das Get-Command Cmdlet zurückgibt, um das Snap-In oder Modul zu finden, in dem ein Cmdlet stammt. Der achte Befehl verwendet die Punktnotation, um den Wert der PSSnapin-Eigenschaft des Set-Alias-Cmdlets zu ermitteln.

PS C:\> Get-PSSnapin
PS C:\> Get-PSSnapin -Registered
PS C:\> Set-Alias installutil $env:windir\Microsoft.NET\Framework\v2.0.50727\installutil.exe
PS C:\> installutil C:\Dev\Management\ManagementCmdlets.dll
PS C:\> Get-PSSnapin -Registered
PS C:\> add-pssnapin ManagementFeatures
PS C:\> Get-Command -Module ManagementFeatures
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 implementiert wird, die ManagementCmdlets.dll heißt.

Parameter

-Name

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

Geben Sie die Namen der registrierten Snap-Ins in Ihrem System ein.Get-PSSnapin -Registered

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

-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

Windows PowerShell enthält die folgenden Aliase für Add-PSSnapin:

  • asnp

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

Informationen zur CreateDefault2-Methode , die neuere Sitzungen mit Kernmodulen erstellt, finden Sie unter CreateDefault2-Methode.

Weitere Informationen zu Snap-Ins finden Sie unter about_PSSnapins und Erstellen eines Windows PowerShell-Snap-Ins.

Add-PSSnapin Fügt das Snap-In nur zur 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 ein beliebiges Snap-In hinzufügen, das mit dem Microsoft .NET Framework-Installationsprogramm registriert wurde. Weitere Informationen finden Sie unter Registrieren von Cmdlets, Anbietern und Hostanwendungen.

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

Überprüfen Sie vor dem Hinzufügen eines Snap-Ins die Version des Snap-Ins, Add-PSSnapin 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.