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

Sintaxe

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

Descrição

O cmdlet Add-PSSnapin adiciona snap-ins do Windows PowerShell registrados à sessão atual. Depois que os snap-ins forem adicionados, você poderá utilizar os cmdlets e provedores aos quais os snap-ins oferecem suporte 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.

Parâmetros

-Name <string[]>

Especifica o nome do snap-in. (Esse é o Name, não o AssemblyName ou ModuleName.)

Para localizar os nomes dos snap-ins registrados em seu sistema, digite: "Get-PSSnapin -registered".

Necessário?

true

Posição?

1

Valor padrão

Aceitar entrada do pipeline?

true (ByPropertyName)

Aceitar caracteres curinga?

false

-PassThru

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

Necessário?

false

Posição?

named

Valor padrão

Aceitar entrada do pipeline?

false

Aceitar caracteres curinga?

false

<CommonParameters>

Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.

Entradas e saídas

O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.

Entradas

None

Não é possível canalizar objetos para Add-PSSnapin.

Saídas

None ou System.Management.Automation.PSSnapInInfo

Quando você usar o parâmetro PassThru, Add-PSSnapin retornará um objeto PSSnapInInfo que representa o snap-in. Caso contrário, esse cmdlet não gera nenhuma saída.

Observações

Para obter informações detalhadas sobre snap-ins no Windows PowerShell, consulte about_Pssnapins. Para obter informações sobre como criar um snap-in do Windows PowerShell, consulte "How to Create a Windows PowerShell Snap-in" (em inglês) na biblioteca MSDN (Microsoft Developer Network) em https://go.microsoft.com/fwlink/?LinkId=144762.

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

Você poderá adicionar qualquer snap-in do Windows PowerShell que tenha sido registrado usando o utilitário de instalação do Microsoft .NET Framework. Para obter mais informações, consulte "How to Register Cmdlets, Providers, and Host Applications" na biblioteca MSDN em https://go.microsoft.com/fwlink/?LinkID=143619.

Para obter uma lista dos snap-ins registrados em seu computador, digite "Get-PSSnapin -registered".

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

Exemplo 1

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

Descrição
-----------
Esse comando adiciona os snap-ins do Microsoft Exchange e do Active Directory à sessão atual.

Exemplo 2

C:\PS>get-pssnapin -registered | add-pssnapin -passthru

Descrição
-----------
Esse comando adiciona todos os snap-ins registrados do Windows PowerShell à sessão. Ele utiliza 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 o adiciona à sessão. O parâmetro PassThru retorna objetos que representam cada um dos snap-ins adicionados.

Exemplo 3

C:\PS>get-pssnapin

Descrição
-----------
Esse exemplo demonstra o processo de registro de um snap-in no sistema e de sua inclusão na sessão. Ele usa ManagementFeatures, um snap-in fictício implementado em um arquivo chamado ManagementCmdlets.dll.

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

    get-pssnapin


O segundo comando obtém os snap-ins que foram registrados no sistema (incluindo aqueles que já foram adicionados à sessão). Ele não inclui os snap-ins que são instalados com o Windows PowerShell.

    get-pssnapin -registered

 
Nesse caso, o comando não retorna snap-ins. Isso indica que o snap-in ManagementFeatures não foi registrado no sistema.

O terceiro comando cria um alias, "installutil", para o caminho até a ferramenta InstallUtil no .NET Framework.

    set-alias installutil $env:windir\Microsoft.NET\Framework\v2.0.50727\installutil.exe


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

    installutil C:\Dev\Management\ManagementCmdlets.dll


O quinto comando é igual ao segundo. Nesse momento, você o utiliza para verificar se o snap-in ManagementCmdlets está registrado.

    get-pssnapin -registered

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

    add-pssnapin ManagementFeatures

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

    get-command -module ManagementFeatures

Você também pode usar a propriedade PSSnapin do objeto que Get-Command retorna para localizar o snap-in ou o módulo em que um cmdlet foi originado. O oitavo comando usa a notação de ponto para localizar o valor da propriedade PSSnapin do comando Set-Alias. 

    (get-command set-alias).pssnapin

See Also



Sumário