Partilhar via

Add-PSSnapin

  • Referência
Módulo:
Microsoft.PowerShell.Core

Adiciona um ou mais snap-ins do Windows PowerShell à sessão atual.

Sintaxe

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

Description

O Add-PSSnapin cmdlet 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 Add-PSSnapin comando 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

O primeiro comando obtém snap-ins que foram adicionados à sessão atual que incluem os snap-ins instalados com o Windows PowerShell. Neste exemplo, ManagementFeatures não é retornado. Isso indica que ele não foi adicionado à sessão.

O segundo comando obtém snap-ins que foram registrados em seu sistema, o que inclui aqueles que já foram adicionados à sessão. Ele não inclui os snap-ins instalados com o Windows PowerShell. Nesse caso, o comando não retorna nenhum snap-ins. Isso indica que o snapin ManagementFeatures não foi registrado no sistema.

O terceiro comando cria um alias, installutil, para o caminho da ferramenta InstallUtil no .NET Framework.

O quarto comando usa a ferramenta InstallUtil para registrar o snap-in. O comando especifica o caminho do ManagementCmdlets.dll, o nome do arquivo ou o nome do módulo do snap-in.

O quinto comando é o mesmo que o segundo comando. Desta vez, você o usa para verificar se o snap-in ManagementCmdlets está registrado.

O sexto comando usa o Add-PSSnapin cmdlet para adicionar o snap-in ManagementFeatures à sessão. Ele especifica o nome do snap-in, ManagementFeatures, não o nome do arquivo.

Para verificar se o snap-in foi adicionado à sessão, o sétimo comando usa o parâmetro Module do cmdlet Get-Command. Ele exibe os itens que foram adicionados à sessão por um snap-in ou módulo.

Você também pode usar a propriedade PSSnapin do objeto que o Get-Command cmdlet retorna para localizar o snap-in ou módulo no qual um cmdlet se originou. O oitavo comando usa notação de ponto para localizar o valor da propriedade PSSnapin do cmdlet 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

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

Especifica o nome do snap-in. Este é o Name, não o AssemblyName ou ModuleName. Curingas são permitidos.

Para encontrar os nomes dos snap-ins registados no seu sistema, escreva Get-PSSnapin -Registered.

Tipo:String[]
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:True

-PassThru

Indica que esse cmdlet retorna um objeto que representa cada snap-in adicionado. Por padrão, esse cmdlet não gera nenhuma saída.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

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

O Windows PowerShell inclui os seguintes aliases para Add-PSSnapin:

  • asnp

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, 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 CreateDefault2 que cria sessões de estilo mais recente com módulos principais, consulte Método CreateDefault2.

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

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.

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

Antes de adicionar um snap-in, Add-PSSnapin verifique 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.