Partilhar via

Unregister-PSSessionConfiguration

Módulo:
Microsoft.PowerShell.Core Module

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

Sintaxe

Default (Predefinição) 

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

Description

Este cmdlet só está disponível na plataforma Windows.

O cmdlet Unregister-PSSessionConfiguration exclui as configurações de sessão registradas do computador. Este cmdlet foi projetado para administradores de sistema gerenciarem configurações de sessão personalizadas para usuários.

Para tornar a alteração efetiva, Unregister-PSSessionConfiguration reinicia o serviço WinRM. Para evitar a reinicialização, especifique o parâmetro NoServiceRestart.

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. Para obter mais informações, consulte about_Session_Configurations.

Exemplos

Exemplo 1: Excluir uma configuração de sessão

Este exemplo exclui a configuração de sessão MaintenanceShell do computador.

Unregister-PSSessionConfiguration -Name "MaintenanceShell"

Exemplo 2: Excluir uma configuração de sessão e reiniciar o serviço WinRM

Neste exemplo, excluímos a configuração MaintenanceShell e reiniciamos o serviço WinRM. O parâmetro Force suprime todas as mensagens do usuário para reiniciar o serviço WinRM sem solicitar.

Unregister-PSSessionConfiguration -Name MaintenanceShell -Force

Exemplo 3: Excluir todas as configurações de sessão

Estes exemplos mostram duas maneiras de excluir todas as configurações de sessão no computador. Ambos os comandos têm o mesmo efeito e podem ser usados de forma intercambiável.

Unregister-PSSessionConfiguration -Name *
Get-PSSessionConfiguration -Name * | Unregister-PSSessionConfiguration

Exemplo 4: Cancelar o registro sem reiniciar

Este exemplo mostra o efeito do uso do parâmetro NoServiceRestart para impedir uma reinicialização de serviço que interromperia quaisquer sessões no computador.

PS> Unregister-PSSessionConfiguration -Name "MaintenanceShell" -NoServiceRestart
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

PS> New-PSSession -ConfigurationName "MaintenanceShell"

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

PS> Restart-Service winrm
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 (http://schemas.microsoft.com/powershell/MaintenanceShell) was not found in the WS-Management catalog.
 The catalog contains the metadata that describes resources, or logical endpoints.
 For more information, see the about_Remote_Troubleshooting Help topic.
 + CategoryInfo          : OpenError: (System.Manageme....RemoteRunspace:RemoteRunspace) [], PSRemotingTransportException
 + FullyQualifiedErrorId : PSSessionOpenFailed

O Unregister-PSSessionConfiguration exclui a configuração da sessão MaintenanceShell. No entanto, como o comando usa o parâmetro NoServiceRestart, o serviço WinRM não é reiniciado e a alteração ainda não é completamente eficaz.

Em seguida, o Get-PSSessionConfiguration tenta obter a sessão MaintenanceShell. Como a sessão foi removida da tabela de recursos WS-Management, Get-PSSessionConfiguration não pode retorná-la.

O cmdlet New-PSSession cria uma sessão usando a configuração MaintenanceShell. O comando é bem-sucedido. Em seguida, reiniciamos o serviço WinRM.

Finalmente, o cmdlet New-PSSession tenta criar uma sessão que usa a configuração MaintenanceShell. Desta vez, a sessão falha porque a configuração MaintenanceShell foi excluída quando o serviço WinRM foi reiniciado.

Parâmetros

-Confirm

Solicita confirmação antes de executar o cmdlet.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
Suporta carateres universais:False
NãoMostrar:False
Aliases:Cf.

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Force

Indica que o cmdlet não solicita confirmação e reinicia o serviço WinRM sem solicitar. Reiniciar o serviço torna a alteração de configuração efetiva.

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Name

Especifica os nomes das configurações de sessão a serem excluídas. Insira um nome de configuração de sessão ou um padrão de nome de configuração. Caracteres coringa são permitidos. Este parâmetro é obrigatório.

Você também pode canalizar configurações de sessão para Unregister-PSSessionConfiguration.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:True
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-NoServiceRestart

Indica que esse cmdlet não reinicia o serviço WinRM e suprime o prompt para reiniciar o serviço.

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

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

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:False
Suporta carateres universais:False
NãoMostrar:False
Aliases:Wi

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

Microsoft.PowerShell.Commands.PSSessionConfigurationCommands

Você pode canalizar um objeto de configuração de sessão para este cmdlet.

Saídas

None

Este cmdlet não retorna nenhuma saída.

Notas

Este cmdlet só está disponível em plataformas Windows.

Para executar esse cmdlet, você deve iniciar o PowerShell usando a opção Executar como administrador opção.