about_PSSnapins

  • Artigo

Breve descrição

Descreve os snap-ins do Windows PowerShell e mostra como usá-los e gerenciá-los.

Descrição longa

Um snap-in do Windows PowerShell é um assembly do Microsoft .NET Framework que pode conter cmdlets e provedores do Windows PowerShell. O Windows PowerShell inclui um conjunto de snap-ins básicos, mas você pode estender o poder e o valor do Windows PowerShell adicionando snap-ins que contêm provedores e cmdlets criados ou obtidos de outras pessoas.

Quando você adiciona um snap-in, os cmdlets e provedores que ele contém ficam imediatamente disponíveis para uso na sessão atual, mas a alteração afeta apenas a sessão atual.

Para adicionar o snap-in a todas as sessões futuras, salve-o em seu perfil do Windows PowerShell. Você também pode usar o Export-Console cmdlet para salvar os nomes dos snap-ins em um arquivo de console e, em seguida, usar essa configuração salva em sessões futuras.

A partir do Windows PowerShell 3.0, os cmdlets fornecidos com o PowerShell são empacotados em módulos. A exceção é Microsoft.PowerShell.Core, que é o único snap-in restante. O snap-in Microsoft.PowerShell.Core é carregado em todas as sessões por padrão. Os módulos restantes são carregados automaticamente na primeira utilização. Para obter mais informações, consulte about_Modules.

Encontre um snap-in

Para obter uma lista dos snap-ins do Windows PowerShell em seu computador, digite:

Get-PSSnapin

Para obter o snap-in para cada provedor do Windows PowerShell, digite:

Get-PSProvider | Format-List name, pssnapin

Para obter todos os snap-ins registrados em seu sistema ou para verificar se um snap-in está registrado, digite:

Get-PSSnapin -registered

Para obter uma lista dos cmdlets em um snap-in do Windows PowerShell, digite:

Get-Command -Module <snap-in_name>

Instalar um snap-in

Os snap-ins internos são registrados no sistema e adicionados à sessão padrão quando você inicia o Windows PowerShell. No entanto, tem de registar os snap-ins que cria ou obtém de outras pessoas e, em seguida, adicionar os snap-ins à sua sessão.

Adicionar um snap-in à sessão atual

Para adicionar um snap-in registrado à sessão atual, use o Add-PsSnapin cmdlet. Por exemplo, para adicionar o snap-in do Microsoft SQL Server à sessão, digite:

Add-PSSnapin sql

Após a conclusão do comando, os provedores e cmdlets no snap-in ficam disponíveis na sessão. No entanto, eles estão disponíveis apenas na sessão atual, a menos que você os salve.

Guardar um snap-in

Para usar um snap-in em futuras sessões do Windows PowerShell, adicione o Add-PsSnapin comando ao seu perfil do Windows PowerShell. Ou exporte os nomes dos snap-ins para um arquivo de console.

Se você adicionar o Add-PSSnapin comando ao seu perfil, ele estará disponível em todas as sessões futuras do Windows PowerShell. Se você exportar os nomes dos snap-ins em sua sessão, poderá usar o arquivo de exportação somente quando precisar dos snap-ins.

Para adicionar o Add-PsSnapin comando ao seu perfil do Windows PowerShell, abra seu perfil, cole ou digite o comando e salve o perfil. Para obter mais informações, consulte about_Profiles.

Para salvar os snap-ins de uma sessão no arquivo de console (.psc1), use o Export-Console cmdlet. Por exemplo, para salvar os snap-ins na configuração da sessão atual no NewConsole.psc1 arquivo no diretório atual, digite:

Export-Console NewConsole

Para obter mais informações, consulte Export-Console.

Abrir o Windows PowerShell usando um arquivo de console

Para usar um arquivo de console que inclua o snap-in, inicie o Windows PowerShell (powershell.exe) no prompt de comando em cmd.exe ou em outra sessão do Windows PowerShell. Use o parâmetro PsConsoleFile para especificar o arquivo de console que inclui o snap-in. Por exemplo, o comando a seguir inicia o Windows PowerShell com o arquivo de NewConsole.psc1 console:

PowerShell.exe -psconsolefile NewConsole.psc1

Os provedores e cmdlets no snap-in agora estão disponíveis para uso na sessão.

Remover um snap-in

Para remover um snap-in do Windows PowerShell da sessão atual, use o Remove-PsSnapin cmdlet. Por exemplo, para remover o snap-in do SQL Server da sessão atual, digite:

Remove-PSSnapin sql

Este cmdlet remove o snap-in da sessão. O snap-in ainda está carregado, mas os provedores e cmdlets aos quais ele oferece suporte não estão mais disponíveis.

Registrar eventos de snap-in

A partir do Windows PowerShell 3.0, você pode registrar eventos de execução para os cmdlets nos módulos e snap-ins do Windows PowerShell definindo a propriedade LogPipelineExecutionDetails dos módulos e snap-ins como $true. Para obter mais informações, consulte about_EventLogs.

Consulte também