Add-PSSnapin

Sintaxe

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

Description

O cmdlet Add-PSSnapin adiciona snap-ins registrados do Windows PowerShell à sessão atual. Depois que os snap-ins forem adicionados, você poderá usar os cmdlets e provedores suportados pelos snap-ins na sessão atual.

Para adicionar o snap-in a todas as sessões futuras do Windows PowerShell, adicione um comando Add-PSSnapin ao seu perfil do Windows PowerShell. Para obter mais informações, consulte about_Profiles.

A partir do Windows PowerShell 3.0, os comandos principais incluídos no Windows PowerShell são empacotados em módulos. A exceção é Microsoft.PowerShell.Core, que é um snap-in (PSSnapin). Por padrão, apenas o snap-in Microsoft.PowerShell.Core é adicionado à sessão. Os módulos são importados automaticamente na primeira utilização e você pode usar o cmdlet Import-Module para importá-los.

Exemplos

Exemplo 1: Adicionar snap-ins

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

Este comando adiciona os snap-ins do Microsoft Exchange e do Ative Directory à sessão atual.

Exemplo 2: Adicionar todos os snap-ins registrados

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

Este comando adiciona todos os snap-ins registrados do Windows PowerShell à sessão. Ele usa o cmdlet Get-PSSnapin com o parâmetro Registered para obter objetos que representam cada um dos snap-ins registrados. O operador de pipeline (|) passa o resultado para Add-PSSnapin, que os adiciona à sessão. O parâmetro PassThru retorna objetos que representam cada um dos snap-ins adicionados.

Exemplo 3: Registar um snap-in e adicioná-lo

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

Este exemplo demonstra o processo de registrar um snap-in em seu sistema e, em seguida, adicioná-lo à sua sessão. Ele usa ManagementFeatures, um snap-in fictício implementado em um arquivo chamado ManagementCmdlets.dll.

Parâmetros

-Name

-PassThru

Entradas

None

Não é possível canalizar objetos para este cmdlet.

Saídas

None or System.Management.Automation.PSSnapInInfo

Este cmdlet retorna um objeto PSSnapInInfo que representa o snap-in se você especificar o parâmetro PassThru. Caso contrário, esse cmdlet não gerará nenhuma saída.

Notas

• A partir do Windows PowerShell 3.0, os comandos principais instalados com o Windows PowerShell são empacotados em módulos. No Windows PowerShell 2.0 e em programas de host que criam sessões de estilo mais antigo em versões posteriores do Windows PowerShell, os comandos principais são empacotados em snap-ins (PSSnapins). A exceção é Microsoft.PowerShell.Core, que é sempre um snap-in. Além disso, as sessões remotas, como as iniciadas pelo cmdlet New-PSSession, são sessões de estilo mais antigo que incluem snap-ins principais.

  Para obter informações sobre o método de CreateDefault2 que cria sessões de estilo mais recente com módulos principais, consulte Método CreateDefault2 na biblioteca MSDN.

• Para obter mais informações sobre snap-ins, consulte about_PSSnapins e Como criar um snap-in do Windows PowerShell na biblioteca MSDN.

• Add-PSSnapin adiciona o snap-in apenas à sessão atual. Para adicionar o snap-in a todas as sessões do Windows PowerShell, adicione-o ao seu perfil do Windows PowerShell. Para obter mais informações, consulte about_Profiles.

• Você pode adicionar qualquer snap-in que tenha sido registrado usando o utilitário de instalação do Microsoft .NET Framework. Para obter mais informações, consulte Como registrar cmdlets, provedores e aplicativos host na biblioteca MSDN.

• Para obter uma lista de snap-ins registados no computador, escreva Get-PSSnapin -Registered.

• Antes de adicionar um snap-in, Add-PSSnapin verifica a versão do snap-in para verificar se ele é compatível com a versão atual do Windows PowerShell. Se o snap-in falhar na verificação de versão, o Windows PowerShell relatará um erro.

Ligações Relacionadas

• Get-PSSnapin
• Remove-PSSnapin
• about_Profiles
• about_PSSnapins