Add-PSSnapin

Referência

Módulo:: Microsoft.PowerShell.Core

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

Syntax

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

Description

O Add-PSSnapin cmdlet adiciona Windows PowerShell snap-ins registados à sessão atual. Após a adição dos snap-ins, pode utilizar os cmdlets e os fornecedores que os snap-ins suportam na sessão atual.

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

A partir de Windows PowerShell 3.0, os comandos centrais que estão incluídos em Windows PowerShell são embalados em módulos. A exceção é Microsoft.PowerShell.Core, que é um snap-in (PSSnapin). Por predefinição, apenas o snap-in Microsoft.PowerShell.Core é adicionado à sessão. Os módulos são importados automaticamente na primeira utilização e pode utilizar o Import-Module cmdlet para os importar.

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 Ative Directory à sessão atual.

Exemplo 2: Adicione todos os snap-ins registados

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

Este comando adiciona todos os encaixes Windows PowerShell registados à sessão. Utiliza o Get-PSSnapin cmdlet com o parâmetro Registado para obter objetos que representem cada um dos encaixes registados. O operador do oleoduto (|) passa o resultado para Add-PSSnapin, o que os adiciona à sessão. O parâmetro PassThru devolve objetos que representam cada um dos encaixes 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 que são instalados com Windows PowerShell. Neste exemplo, a ManagementFeatures não é devolvida. Isto indica que não foi adicionado à sessão.

O segundo comando recebe snap-ins que foram registados no seu sistema, que inclui aqueles que já foram adicionados à sessão. Não inclui os snap-ins instalados com Windows PowerShell. Neste caso, o comando não devolve quaisquer encaixes. Isto indica que o Snapin ManagementFeatures não foi registado no sistema.

O terceiro comando cria um pseudónimo, instalado, para o caminho da ferramenta InstallUtil em .NET Framework.

O quarto comando utiliza a ferramenta InstallUtil para registar o encaixe. O comando especifica o caminho de ManagementCmdlets.dll, o nome de ficheiro ou o nome do módulo do snap-in.

O quinto comando é o mesmo que o segundo comando. Desta vez, utilize-o para verificar se o snap-in ManagementCmdlets está registado.

O sexto comando utiliza o Add-PSSnapin cmdlet para adicionar o encaixe de Gestão à sessão. Especifica o nome do snap-in, ManagementFeatures, não o nome do ficheiro.

Para verificar se o encaixe é adicionado à sessão, o sétimo comando utiliza o parâmetro módulo do Get-Command cmdlet. Exibe os itens adicionados à sessão por um encaixe ou módulo.

Também pode utilizar a propriedade PSSnapin do objeto que o Get-Command cmdlet retorna para encontrar o encaixe ou módulo no qual um cmdlet se originou. O oitavo comando utiliza notação de ponto para encontrar o valor da propriedade PSSnapin do Set-Alias cmdlet.

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 registo de um snap-in no seu sistema e, em seguida, adicioná-lo à sua sessão. Utiliza ManagementFeatures, um snap-in fictício implementado num ficheiro que é nomeado ManagementCmdlets.dll.

Parâmetros

- PassThru

Indica que este cmdlet devolve um objeto que representa cada encaixe adicionado. Por predefinição, este cmdlet não gera quaisquer dados.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Especifica o nome do snap-in. Este é o Nome, não o Nome de Montagem ou Nome do Módulo. Wildcards são permitidos.

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

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

Entradas

Nenhuma

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

Saídas

Nenhum ou System.Management.Automation.PSSnapInfo

Este cmdlet devolve um objeto PSSnapInInfo que representa o snap-in se especificar o parâmetro PassThru . Caso contrário, este cmdlet não gera qualquer saída.

Notas

A partir de Windows PowerShell 3.0, os comandos centrais instalados com Windows PowerShell são embalados em módulos. Em Windows PowerShell 2.0, e em programas de anfitrião que criam sessões de estilo mais antigo em versões posteriores de Windows PowerShell, os comandos centrais são embalados 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 New-PSSession cmdlet, são sessões de estilo mais antigo que incluem snap-ins core.

Para obter informações sobre o método CreateDefault2 que cria sessões de estilo mais recente com módulos centrais, consulte o Método CreateDefault2.
Para obter mais informações sobre snap-ins, consulte about_PSSnapins e Como Criar um Windows PowerShell Snap-in.
Add-PSSnapin adiciona o snap-in apenas à sessão atual. Para adicionar o snap-in a todas as sessões Windows PowerShell, adicione-o ao seu perfil de Windows PowerShell. Para mais informações, consulte about_Profiles.
Pode adicionar qualquer snap-in que tenha sido registado usando o utilitário de instalação microsoft .NET Framework. Para mais informações, consulte Como Registar Cmdlets, Fornecedores e Aplicações de Anfitrião.
Para obter uma lista de snap-ins que estão registados no seu computador, escreva Get-PSSnapin -Registered.
Antes de adicionar um snap-in, Add-PSSnapin verifique a versão do snap-in para verificar se é compatível com a versão atual de Windows PowerShell. Se o snap-in falhar na verificação da versão, Windows PowerShell reporta um erro.