Compartir a través de

Unregister-PSSessionConfiguration

Módulo:
Microsoft.PowerShell.Core Module

Elimina las configuraciones de sesión registradas del equipo.

Sintaxis

Default (Es el valor predeterminado). 

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

Description

Este cmdlet solo está disponible en la plataforma Windows.

El cmdlet Unregister-PSSessionConfiguration elimina las configuraciones de sesión registradas del equipo. Este cmdlet está diseñado para que los administradores del sistema administren configuraciones de sesión personalizadas para los usuarios.

Para que el cambio sea efectivo, Unregister-PSSessionConfiguration reinicia el servicio WinRM. Para evitar el reinicio, especifique el parámetro NoServiceRestart.

Si elimina accidentalmente las configuraciones de sesión predeterminadas de Microsoft.PowerShell o Microsoft.PowerShell32, use el cmdlet Enable-PSRemoting para restaurarlos. Para obtener más información, vea about_Session_Configurations.

Ejemplos

Ejemplo 1: Eliminación de una configuración de sesión

En este ejemplo se elimina la configuración de sesión de MaintenanceShell del equipo.

Unregister-PSSessionConfiguration -Name "MaintenanceShell"

Ejemplo 2: Eliminar una configuración de sesión y reiniciar el servicio WinRM

En este ejemplo, se elimina la configuración de MaintenanceShell y se reinicia el servicio WinRM. El parámetro Force suprime todos los mensajes de usuario para reiniciar el servicio WinRM sin preguntar.

Unregister-PSSessionConfiguration -Name MaintenanceShell -Force

Ejemplo 3: Eliminar todas las configuraciones de sesión

En estos ejemplos se muestran dos maneras de eliminar todas las configuraciones de sesión en el equipo. Ambos comandos tienen el mismo efecto y se pueden usar indistintamente.

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

Ejemplo 4: Anular el registro sin reiniciar

En este ejemplo se muestra el efecto de usar el parámetro NoServiceRestart para evitar un reinicio del servicio que interrumpiría las sesiones del equipo.

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

El Unregister-PSSessionConfiguration elimina la configuración de sesión de MaintenanceShell. Sin embargo, dado que el comando usa el parámetro NoServiceRestart, el servicio WinRM no se reinicia y el cambio aún no es completamente efectivo.

A continuación, el Get-PSSessionConfiguration intenta obtener la sesión de MaintenanceShell. Dado que la sesión se ha quitado de la tabla de recursos WS-Management, Get-PSSessionConfiguration no puede devolverla.

El cmdlet New-PSSession crea una sesión mediante la configuración de MaintenanceShell. El comando se realiza correctamente. A continuación, reiniciamos el servicio WinRM.

Por último, el cmdlet New-PSSession intenta crear una sesión que use la configuración de MaintenanceShell. Esta vez, se produce un error en la sesión porque la configuración de MaintenanceShell se eliminó cuando se reiniciaba el servicio WinRM.

Parámetros

-Confirm

Le pide confirmación antes de ejecutar el cmdlet.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:False
Admite caracteres comodín:False
DontShow:False
Alias:cf

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Force

Indica que el cmdlet no le pide confirmación y reinicia el servicio WinRM sin preguntar. Reiniciar el servicio hace que el cambio de configuración sea efectivo.

Para evitar un reinicio y suprimir el mensaje de reinicio, use el parámetro NoServiceRestart.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Name

Especifica los nombres de las configuraciones de sesión que se van a eliminar. Escriba un nombre de configuración de sesión o un patrón de nombre de configuración. Se permite el uso de caracteres comodín. Este parámetro es obligatorio.

También puede canalizar configuraciones de sesión para Unregister-PSSessionConfiguration.

Propiedades del parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:True
DontShow:False

Conjuntos de parámetros

(All)
Posición:0
Mandatory:True
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-NoServiceRestart

Indica que este cmdlet no reinicia el servicio WinRM y suprime el mensaje para reiniciar el servicio.

De forma predeterminada, al ejecutar un comando Unregister-PSSessionConfiguration, se le pedirá que reinicie el servicio WinRM para que el cambio sea efectivo. Hasta que se reinicie el servicio WinRM, los usuarios todavía pueden usar la configuración de sesión no registrada, aunque Get-PSSessionConfiguration no la encuentre.

Para reiniciar el servicio WinRM sin preguntar, especifique el parámetro Force. Para reiniciar manualmente el servicio WinRM, use el cmdlet Restart-Service.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-WhatIf

Muestra lo que sucedería si el cmdlet se ejecuta. El cmdlet no se ejecuta.

Propiedades del parámetro

Tipo:SwitchParameter
Valor predeterminado:False
Admite caracteres comodín:False
DontShow:False
Alias:Wi

Conjuntos de parámetros

(All)
Posición:Named
Mandatory:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

Microsoft.PowerShell.Commands.PSSessionConfigurationCommands

Puede canalizar un objeto de configuración de sesión a este cmdlet.

Salidas

None

Este cmdlet no devuelve ninguna salida.

Notas

Este cmdlet solo está disponible en plataformas Windows.

Para ejecutar este cmdlet, debe iniciar PowerShell mediante la opción Ejecutar como administrador.