Compartilhar via

Unregister-PSSessionConfiguration

Módulo:
Microsoft.PowerShell.Core Module

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

Sintaxe

Default (Default) 

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

Description

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

Para tornar a alteração eficaz, Unregister-PSSessionConfiguration reinicia o serviço WinRM. Para impedir 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, excluimos a configuração de 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 solicitação.

Unregister-PSSessionConfiguration -Name MaintenanceShell -Force

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

Esses 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 uma reinicialização

Este exemplo mostra o efeito do uso do parâmetro NoServiceRestart para impedir uma reinicialização de serviço que interromperia as 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 devolvê-la.

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

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

Parâmetros

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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 eficaz.

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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 curinga são permitidos. Este parâmetro é obrigatório.

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:True
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes: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, ao executar um comando Unregister-PSSessionConfiguration, você será solicitado a reiniciar o serviço WinRM para tornar a alteração eficaz. Até que o serviço WinRM seja reiniciado, os usuários ainda poderão 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 do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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 redirecionar um objeto de configuração de sessão para este cmdlet.

Saídas

None

Esse cmdlet não retorna nenhuma saída.

Observações

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