Freigeben über

Add-PSSnapin

  • Referenz
Modul:
Microsoft.PowerShell.Core

Fügt der aktuellen Sitzung mindestens ein Windows PowerShell-Snap-In hinzu.

Syntax

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

Beschreibung

Das Cmdlet Add-PSSnapin fügt der aktuellen Sitzung registrierte Windows PowerShell-Snap-Ins hinzu. Nachdem die Snap-Ins hinzugefügt wurden, können Sie die Cmdlets und Anbieter verwenden, die die Snap-Ins in der aktuellen Sitzung unterstützen.

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 werden die Kernbefehle, die in Windows PowerShell enthalten sind, in Module verpackt. Die Ausnahme ist Microsoft.PowerShell.Core, bei dem es sich um ein Snap-In (PSSnapin) handelt. 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

Mit diesem Befehl werden die Microsoft Exchange- und Active Directory-Snap-Ins zur aktuellen Sitzung hinzugefügt.

Beispiel 2: Hinzufügen aller registrierten Snap-Ins

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

Mit diesem Befehl werden der Sitzung alle registrierten Windows PowerShell-Snap-Ins hinzugefügt. 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, wodurch sie der Sitzung hinzugefügt werden. 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 von ManagementCmdlets.dll, dem 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 Cmdlet Add-PSSnapin, um das ManagementFeatures-Snap-In der 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 cmdlet Get-Command 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 Cmdlets Set-Alias 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 das Registrieren eines Snap-Ins auf Ihrem System und anschließendes Hinzufügen zu Ihrer Sitzung veranschaulicht. Es verwendet ManagementFeatures, ein fiktives Snap-In, das in einer Datei implementiert wird, die ManagementCmdlets.dllheißt.

Parameter

-Name

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

Geben Sie Get-PSSnapin -Registeredein, um die Namen der registrierten Snap-Ins auf Ihrem System zu finden.

Typ:String[]
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:True

-PassThru

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

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

None

Objekte können nicht an dieses Cmdlet weitergeleitet 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 generiert dieses Cmdlet keine Ausgabe.

Hinweise

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

  • asnp

Ab Windows PowerShell 3.0 werden die mit Windows PowerShell installierten Kernbefehle in Module verpackt. 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, die immer ein Snap-In ist. Außerdem sind Remotesitzungen, z. B. die vom Cmdlet New-PSSession 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 How to Create a Windows PowerShell Snap-in.

Add-PSSnapin fügt das Snap-In nur der aktuellen Sitzung hinzu. Um das Snap-In allen Windows PowerShell-Sitzungen hinzuzufügen, fügen Sie es 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.

Geben Sie Get-PSSnapin -Registeredein, um eine Liste von Snap-Ins abzurufen, die auf Ihrem Computer registriert sind.

Vor dem Hinzufügen eines Snap-Ins überprüft Add-PSSnapin die Version des Snap-Ins, um zu überprüfen, ob es mit der aktuellen Version von Windows PowerShell kompatibel ist. Wenn das Snap-In die Versionsüberprüfung fehlschlägt, meldet Windows PowerShell einen Fehler.