Unregister-PSSessionConfiguration

Suppresses all user prompts, and restarts the WinRM service without prompting. Restarting the service makes the configuration change effective.

To prevent a restart and suppress the restart prompt, use the NoServiceRestart parameter.

Specifies the names of the session configurations to delete. Enter one session configuration name or a configuration name pattern. Wildcards are permitted. This parameter is required.

You can also pipe a session configurations to Unregister-PSSessionConfiguration.

Does not restart the WinRM service, and suppresses the prompt to restart the service.

By default, when you enter an Unregister-PSSessionConfiguration command, you are prompted to restart the WinRM service to make the change effective. Until the WinRM service is restarted, users can still use the unregistered session configuration, even though Get-PSSessionConfiguration does not find it.

To restart the WinRM service without prompting, use the Force parameter. To restart the WinRM service manually, use the Restart-Service cmdlet.

Prompts you for confirmation before running the cmdlet.

Shows what would happen if the cmdlet runs. The cmdlet is not run.

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

This command deletes the MaintenanceShell session configuration from the computer.

PS C:\> unregister-pssessionconfiguration -name MaintenanceShell

This command deletes the MaintenanceShell session configuration from the computer. The command uses the Force parameter to suppress all user messages and to restart the WinRM service without prompting.

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

These commands delete all of the session configurations on the computer. The commands have the same effect and can be used interchangeably.

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

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 command 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 command 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 fails because the MaintenanceShell configuration has been deleted.

PS C:\> unregister-pssessionconfiguration -name maintenanceShell -noServiceRestartPS C:\>get-pssessionconfiguration -name maintenanceShellGet-PSSessionConfiguration -name maintenanceShell : No Session Configuration matches criteria "maintenanceShell".+ CategoryInfo          : NotSpecified: (:) [Write-Error], WriteErrorException+ FullyQualifiedErrorId : Microsoft.PowerShell.Commands.WriteErrorExceptionPS C:\>new-pssession -configurationName MaintenanceShellId Name      ComputerName    State    Configuration         Availability-- ----      ------------    -----    -------------         ------------1 Session1  localhost       Opened   MaintenanceShell      AvailablePS C:\>restart-service winrmPS C:\>new-pssession -configurationName MaintenanceShell[localhost] Connecting to remote server failed with the following error message : The WS-Management service cannot process the request. The resourceURI (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