Sdílet prostřednictvím

Add-PSSnapin

  • Reference
Modul:
Microsoft.PowerShell.Core

Přidá do aktuální relace jeden nebo více modulů snap-in Windows PowerShellu.

Syntaxe

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

Description

Rutina Add-PSSnapin přidá zaregistrované moduly snap-in Windows PowerShellu do aktuální relace. Po přidání modulů snap-in můžete použít rutiny a zprostředkovatele, které moduly snap-in podporují v aktuální relaci.

Pokud chcete přidat modul snap-in do všech budoucích relací Windows PowerShellu, přidejte do profilu Windows PowerShellu příkaz Add-PSSna pin. Další informace najdete v tématu about_Profiles.

Počínaje Windows PowerShellem 3.0 jsou základní příkazy, které jsou součástí Windows PowerShellu, zabalené v modulech. Výjimkou je Microsoft.PowerShell.Core, což je modul snap-in (PSSnapin). Ve výchozím nastavení se do relace přidá jenom modul snap-in Microsoft.PowerShell.Core. Moduly se při prvním použití importují automaticky a můžete je importovat pomocí rutiny Import-Module.

Příklady

Příklad 1: Přidání modulů snap-in

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

Tento příkaz přidá moduly snap-in Microsoft Exchange a Active Directory do aktuální relace.

Příklad 2: Přidání všech registrovaných modulů snap-in

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

Tento příkaz přidá do relace všechny zaregistrované moduly snap-in Windows PowerShellu. Pomocí rutiny Get-PSSnapin s parametrem Registered získá objekty představující každý z registrovaných modulů snap-in. Operátor kanálu (|) předá výsledek Add-PSSnapin, který je přidá do relace. Parametr PassThru vrací objekty, které představují každý z přidaných modulů snap-in.

Příklad 3: Registrace modulu snap-in a jeho přidání

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

Tento příklad ukazuje proces registrace modulu snap-in v systému a jeho přidání do relace. Používá ManagementFeatures, fiktivní modul snap-in implementovaný v souboru s názvem ManagementCmdlets.dll.

Parametry

-Name

Určuje název modulu snap-in. Toto je název, nikoli AssemblyName nebo ModuleName. Jsou povoleny zástupné cardy.

Chcete-li najít názvy registrovaných modulů snap-in v systému, zadejte Get-PSSnapin -Registered.

Typ:String[]
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-PassThru

Označuje, že tato rutina vrátí objekt, který představuje každý přidaný modul snap-in. Ve výchozím nastavení tato rutina negeneruje žádný výstup.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

None

Do této rutiny nelze vést objekty.

Výstupy

None or System.Management.Automation.PSSnapInInfo

Tato rutina vrátí objekt PSSnapInInfo, který představuje modul snap-in, pokud zadáte parametr PassThru. Jinak tato rutina negeneruje žádný výstup.

Poznámky

  • Počínaje Windows PowerShellem 3.0 se základní příkazy nainstalované s Windows PowerShellem zabalí do modulů. V prostředí Windows PowerShell 2.0 a v hostitelských programech, které vytvářejí relace staršího stylu v novějších verzích Windows PowerShellu, se základní příkazy zabalí do modulů snap-in (PSSnapins). Výjimkou je Microsoft.PowerShell.Core, což je vždy modul snap-in. Vzdálené relace, jako jsou relace spuštěné rutinou New-PSSession, jsou také relace ve starším stylu, které zahrnují základní moduly snap-in.

    Informace o CreateDefault2 metoda, která vytváří novější relace se základními moduly, naleznete v tématu CreateDefault2 Metoda v knihovně MSDN.

  • Další informace o snap-inech najdete v tématu about_PSSnapins a Vytvoření modulu snap-in prostředí Windows PowerShell v knihovně MSDN.

  • Doplněk PSSnapin přidá modul snap-in pouze do aktuální relace. Pokud chcete přidat modul snap-in do všech relací Prostředí Windows PowerShell, přidejte ho do profilu Prostředí Windows PowerShell. Další informace najdete v tématu about_Profiles.

  • Pomocí instalačního nástroje Microsoft .NET Framework můžete přidat libovolný modul snap-in, který je zaregistrovaný. Další informace najdete v tématu Postup registrace rutin, poskytovatelů a hostitelských aplikací v knihovně MSDN.

  • Pokud chcete získat seznam modulů snap-in, které jsou zaregistrované v počítači, zadejte Get-PSSnapin -Registered.

  • Před přidáním modulu snap-in Add-PSSnapin zkontroluje verzi modulu snap-in a ověří, jestli je kompatibilní s aktuální verzí Windows PowerShellu. Pokud modul snap-in selže při kontrole verze, Windows PowerShell hlásí chybu.