Add-PSSnapin

  • Reference
Modul:
Microsoft.PowerShell.Core

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

Syntax

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 Add-PSSnapin příkaz. 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 registrovaným parametrem 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í

První příkaz získá moduly snap-in, které byly přidány do aktuální relace, které zahrnují moduly snap-in, které jsou nainstalovány pomocí Windows PowerShellu. V tomto příkladu se funkce ManagementFeatures nevrátí. To znamená, že nebyla přidána do relace.

Druhý příkaz získá moduly snap-in, které jsou zaregistrované ve vašem systému, včetně těch, které už byly přidány do relace. Nezahrnuje moduly snap-in, které jsou nainstalované v prostředí Windows PowerShell. V tomto případě příkaz nevrací žádné moduly snap-in. To znamená, že modul snapin ManagementFeatures nebyl v systému zaregistrovaný.

Třetí příkaz vytvoří alias installutil pro cestu nástroje InstallUtil v rozhraní .NET Framework.

Čtvrtý příkaz používá nástroj InstallUtil k registraci modulu snap-in. Příkaz určuje cestu ManagementCmdlets.dll, název souboru nebo modulu.

Pátý příkaz je stejný jako druhý příkaz. Tentokrát ho použijete k ověření registrace modulu snap-in ManagementCmdlets.

Šestý příkaz pomocí Add-PSSnapin rutiny přidá modul snap-in ManagementFeatures do relace. Určuje název modulu snap-in ManagementFeatures, nikoli název souboru.

K ověření přidání modulu snap-in do relace používá sedmý příkaz parametr Module rutiny Get-Command. Zobrazí položky přidané do relace modulem snap-in nebo modulem.

Můžete také použít vlastnost PSSnapin objektu, který Get-Command rutina vrací, a najít modul snap-in nebo modul, ze kterého rutina pochází. Osmý příkaz pomocí zápisu tečky vyhledá hodnotu vlastnosti PSSnapin rutiny Set-Alias.

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

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.

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

-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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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

Windows PowerShell obsahuje následující aliasy pro Add-PSSnapin:

  • asnp

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, například relace spouštěné rutinou New-PSSession, jsou také relace ve starším stylu, které zahrnují základní moduly snap-in.

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

Další informace o snap-inech najdete v tématu about_PSSnapins a jak vytvořit modul snap-in Prostředí Windows PowerShell.

Add-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 naleznete v tématu Postup registrace rutin, poskytovatelů a hostitelských aplikací.

Chcete-li získat seznam modulů snap-in, které jsou registrovány v počítači, zadejte Get-PSSnapin -Registered.

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