Unregister-PSSessionConfiguration

Artigo
10/30/2009

Exclui as configurações de sessão registradas do computador.

Sintaxe

Unregister-PSSessionConfiguration [-Name] <string> [-Force] [-NoServiceRestart] [-Confirm] [-WhatIf] [<CommonParameters>]

Descrição

O cmdlet Unregister-PSSessionConfiguration exclui as configurações de sessão registradas do computador. Esse é um cmdlet avançado, projetado para ser usado pelos administradores de sistema para gerenciar as configurações de sessão personalizadas para seus usuários.

Se você excluir acidentalmente as configurações de sessão padrão Microsoft.PowerShell ou Microsoft.PowerShell32, use o cmdlet Enable-PSRemoting para restaurá-las.

Parâmetros

-Force

Suprime todos os avisos de usuário e reinicia o serviço WinRM sem aviso. A reinicialização do serviço torna efetiva a alteração da configuração.

Para impedir a reinicialização e suprimir o aviso de reinicialização, use o parâmetro NoServiceRestart.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Name <string>

Especifica os nomes de configurações de sessão a serem excluídos. Insira um ou mais nomes de configuração. Os caracteres curinga são permitidos. Esse parâmetro é obrigatório.

Você também pode canalizar um objeto de configuração para Unregister-PSSessionConfiguration.

Necessário?	true
Posição?	1
Valor padrão
Aceitar entrada do pipeline?	true (ByPropertyName)
Aceitar caracteres curinga?	false

-NoServiceRestart

Não reinicia o serviço WinRM e suprime o aviso para reiniciar o serviço.

Por padrão, quando você digita um comando Unregister-PSSessionConfiguration, é solicitado para reiniciar o serviço WinRM para tornar a alteração efetiva. Até o serviço WinRM ser reiniciado, os usuários ainda poderão usar a configuração de sessão com registro cancelado, mesmo que Get-PSSessionConfiguration não a encontre.

Para reiniciar o serviço WinRM sem aviso, use o parâmetro Force. Para reiniciar o serviço WinRM manualmente, use o cmdlet Restart-Service.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Confirm

Solicita confirmação antes da execução do comando.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-WhatIf

Descreve o que aconteceria se você executasse o comando, sem executá-lo de fato.

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

Microsoft.PowerShell.Commands.PSSessionConfigurationCommands#PSSessionConfiguration

Você também pode canalizar um objeto de configuração de Get-PSSessionConfiguration para Unregister-PSSessionConfiguration.

Saídas

Nenhum

Este cmdlet não retorna nenhum objeto.

Observações

Para executar esse cmdlet no Windows Vista, no Windows Server 2008 e em versões mais recentes do Windows, inicie o Windows PowerShell com a opção "Executar como administrador".

Exemplo 1

C:\PS>unregister-pssessionconfiguration -name MaintenanceShell

Descrição
-----------
Esse comando exclui a configuração de sessão MaintenanceShell do computador.

Exemplo 2

C:\PS>unregister-pssessionconfiguration -maintenanceShell -force

Descrição
-----------
Esse comando exclui a configuração de sessão MaintenanceShell do computador. O comando usa o parâmetro Force para suprimir todas as mensagens de usuário e para reiniciar o serviço WinRM sem aviso.

Exemplo 3

C:\PS>unregister-pssessionconfiguration -name *

C:\PS> get-pssessionconfiguration -name * | unregister-pssessionconfiguration

Descrição
-----------
Esses comandos excluem todas as configurações de sessão no computador. Os comandos têm o mesmo efeito e podem ser usados de maneira intercambiável.

Exemplo 4

C:\PS>unregister-pssessionconfiguration -name maintenanceShell -noServiceRestart

C:\PS> get-pssessionconfiguration -name maintenanceShell

Get-PSSessionConfiguration -name maintenanceShell : No Session Configuration matches criteria "maintenanceShell".
    + CategoryInfo          : NotSpecified: (:) [Write-Error], WriteErrorException
    + FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorException

C:\PS> new-pssession -configurationName MaintenanceShell

 Id Name      ComputerName    State    Configuration         Availability
 -- ----      ------------    -----    -------------         ------------
  1 Session1  localhost       Opened   MaintenanceShell      Available

C:\PS> restart-service winrm

C:\PS> new-pssession -configurationName MaintenanceShell
[localhost] Connecting to remote server failed with the following error message : The WS-Management service cannot process the request. The resource
URI (https://schemas.microsoft.com/powershell/MaintenanceShell) was not found in the WS-Management catalog. The catalog contains the metadata that describes resour
ces, or logical endpoints. For more information, see the about_Remote_Troubleshooting Help topic.
    + CategoryInfo          : OpenError: (System.Manageme....RemoteRunspace:RemoteRunspace) [], PSRemotingTransportException
    + FullyQualifiedErrorId : PSSessionOpenFailed

Descrição
-----------
Este exemplo mostra o efeito de usar o parâmetro NoServiceRestart de Unregister-PSSessionConfiguration. Esse parâmetro é criado para evitar uma reinicialização do serviço, o que interromperia qualquer sessão no computador.

O primeiro comando usa o cmdlet Unregister-PSSessionConfiguration para excluir a configuração de sessão MaintenanceShell. Entretanto, como o comando usa o parâmetro NoServiceRestart, o serviço WinRM não é reiniciado e a alteração não entra totalmente em vigor.

O segundo comando usa o cmdlet Get-PSSessionConfiguration para obter a sessão MaintenanceShell. Como a sessão foi removida da tabela de recursos WS-Management, Get-PSSession não pode retorná-la.

O terceiro comando usa o cmdlet New-PSSession para criar uma sessão no computador local que usa a configuração MaintenanceShell. O comando obtém êxito.

O quarto comando usa o cmdlet Restart-Service para reiniciar o serviço WinRM. 

O quinto comando novamente usa o cmdlet New-PSSession para criar uma sessão que usa a configuração MaintenanceShell. Desta vez, a sessão falha porque a configuração MaintenanceShell foi excluída.

Consulte também

Conceitos

about_Session_Configurations
Disable-PSSessionConfiguration
Enable-PSSessionConfiguration
Get-PSSessionConfiguration
Register-PSSessionConfiguration
Set-PSSessionConfiguration
WSMan Provider

Compartilhar via