Disable-WSManCredSSP
Applies To: Windows PowerShell 2.0
Disables Credential Security Service Provider (CredSSP) authentication on a client computer.
Syntax
Disable-WSManCredSSP [-Role] <string> [<CommonParameters>]
Description
The Disable-WSManCredSPP cmdlet disables CredSSP authentication on a client or on a server computer. When CredSSP authentication is used, the user's credentials are passed to a remote computer to be authenticated. This type of authentication is designed for commands that create a remote session from within another remote session. For example, you use this type of authentication if you want to run a background job on a remote computer.
The cmdlet is used to disable CredSSP on the client by specifying Client in the Role parameter. The cmdlet then performs the following:
- Disables CredSSP on the client. The WS-Management setting <localhost|computername>\Client\Auth\CredSSP is set to false.
- Removes any WSMan/* setting from the Windows CredSSP policy AllowFreshCredentials on the client.
The cmdlet is used to disable CredSSP on the server by specifying Server in the Role parameter. The cmdlet then performs the following:
- Disables CredSSP on the server. The WS-Management setting <localhost|computername>\Service\Auth\CredSSP is set to false.
Caution: CredSSP authentication delegates the user's credentials from the local computer to a remote computer. This practice increases the security risk of the remote operation. If the remote computer is compromised, when credentials are passed to it, the credentials can be used to control the network session.
To disable CredSSP authentication, use the Disable-WSManCredSSP cmdlet.
Note: Disable-WSManCredSSP runs only on Windows 7, Windows Server 2008 R2, and later versions of Windows.
Parameters
-Role <string>
Accepts one of two possible values: Client or Server. These values specify whether CredSSP should be disabled as a client or as a server.
If the cmdlet is used to disable CredSSP on the client by specifying Client in the Role parameter, then the cmdlet performs the following:
- Disables CredSSP on the client. The WS-Management setting <localhost|computername>\Client\Auth\CredSSP is set to false.
- Removes any WSMan/* setting from the Windows CredSSP policy AllowFreshCredentials on the client.
If the cmdlet is used to disable CredSSP on the server by specifying Server in the Role parameter, the cmdlet performs the following:
- Disables CredSSP on the server. The WS-Management setting <localhost|computername>\Service\Auth\CredSSP is set to false.
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This command supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see about_CommonParameters.
Inputs and Outputs
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet returns.
Inputs |
None This cmdlet does not accept any input. |
Outputs |
None This cmdlet does not generate any output. |
Notes
To enable CredSSP authentication, use the Enable-WSManCredSSP cmdlet.
Example 1
C:\PS>Disable-WSManCredSSP -Role Client
Description
-----------
This command disables CredSSP on the client, which prevents delegation to servers.
Example 2
C:\PS>Disable-WSManCredSSP -Role Server
Description
-----------
This command disables CredSSP on the server, which prevents delegation from clients.
See Also
Concepts
Connect-WSMan
Disconnect-WSMan
Enable-WSManCredSSP
Get-WSManCredSSP
Get-WSManInstance
Invoke-WSManAction
New-WSManInstance
New-WSManSessionOption
Remove-WSManInstance
Set-WSManInstance
Set-WSManQuickConfig
Test-WSMan