This is the built-in help made by Microsoft for the command 'Unregister-PSSessionConfiguration', in PowerShell version 2 - as retrieved from
Windows version 'Microsoft® Windows Vista™ Ultimate ' PowerShell help files on 2016-06-23.
For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.
Deletes registered session configurations from the computer.
Unregister-PSSessionConfiguration [-Name] <string> [-Force] [-NoServiceRestart] [-Confirm] [-WhatIf] [<CommonParameters>]
The Unregister-PSSessionConfiguration cmdlet deletes registered session configurations from the computer. This is an advanced cmdlet that is desi
gned to be used by system administrators to manage customized session configurations for their users.
If you accidentally delete the default Microsoft.PowerShell or Microsoft.PowerShell32 session configurations, use the Enable-PSRemoting cmdlet to
restore them.
<
Online version: http://go.microsoft.com/fwlink/?LinkID=144308
about_Session_Configurations
Disable-PSSessionConfiguration
Enable-PSSessionConfiguration
Get-PSSessionConfiguration
Register-PSSessionConfiguration
Set-PSSessionConfiguration
WS-Management
Provider
<
-------------------------- EXAMPLE 1 --------------------------
C:\PS>unregister-pssessionconfiguration -name MaintenanceShell
Description
-----------
This command deletes the MaintenanceShell session configuration from the computer.
-------------------------- EXAMPLE 2 --------------------------
C:\PS>unregister-pssessionconfiguration -maintenanceShell -force
Description
-----------
This command deletes the MaintenanceShell session configuration from the computer. The command uses the Force parameter to suppress all user mess
ages and to restart the WinRM service without prompting.
-------------------------- EXAMPLE 3 --------------------------
C:\PS>unregister-pssessionconfiguration -name *
C:\PS> get-pssessionconfiguration -name * | unregister-pssessionconfiguration
Description
-----------
These commands delete all of the session configurations on the computer. The commands have the same effect and can be used interchangeably.
-------------------------- EXAMPLE 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 resou
rce
URI (http://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
Description
-----------
This example shows the effect of using the NoServiceRestart parameter of Unregister-PSSessionConfiguration. This parameter is designed to prevent
a service restart, which would disrupt any sessions on the computer.
The first command uses the Unregister-PSSessionConfiguration cmdlet to deletes the MaintenanceShell session configuration. However, because the c
ommand uses the NoServiceRestart parameter, the WinRM service is not restarted and the change is not yet completely effective.
The second command uses the Get-PSSessionConfiguration cmdlet to get the MaintenanceShell session. Because the session has been removed from the
WS-Management resource table, Get-PSSession cannot return it.
The third command uses the New-PSSession cmdlet to create a session on the local computer that uses the MaintenanceShell configuration. The comma
nd succeeds.
The fourth command uses the Restart-Service cmdlet to restart the WinRM service.
The fifth command again uses the New-PSSession cmdlet to create a session that uses the MaintenanceShell configuration. This time, the session fa
ils because the MaintenanceShell configuration has been deleted.