Tests and repairs the secure channel between the local computer and its domain.
Syntax
 Copy Code |
|
|---|---|
Test-ComputerSecureChannel [-Repair] [-Server <string>] [-Confirm] [-WhatIf] [<CommonParameters>] |
|
Description
The Test-ComputerSecureChannel cmdlet verifies that the secure channel between the local computer and its domain is working correctly by checking the status of its trust relationships. If a connection fails, you can use the Repair parameter to try to restore it.
Test-ComputerSecureChannel returns "True" if the secure channel is working correctly and "False" if it is not. This result lets you use the cmdlet in conditional statements in functions and scripts. To get more detailed test results, use the Verbose parameter.
This cmdlet works much like NetDom.exe. Both NetDom and Test-ComputerSecureChannel use the NetLogon service to perform the actions.
Parameters
-Repair
Removes and then rebuilds the secure channel established by the NetLogon service. Use this parameter to try to restore a connection that has failed the test (returned "False".)
To use this parameter, the current user must be a member of the Administrators group on the local computer.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
None |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Server <string>
Uses the specified domain controller to run the command. If this parameter is omitted, Test-ComputerSecureChannel selects a default domain controller for the operation.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
None |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before executing the command.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
|
Required? |
false |
|
Position? |
named |
|
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 You cannot pipe input to this cmdlet. |
|
Outputs |
System.Boolean The cmdlet returns "True" when the connection is working correctly and "False" when it is not. |
Notes
To run a Test-ComputerSecureChannel command on Windows Vista and later versions of Windows, open Windows PowerShell with the "Run as administrator" option.
Test-ComputerSecureChannel is implemented by using the I_NetLogonControl2 function, which controls various aspects of the Netlogon service.
Example 1
| Copy Code |
|
|---|---|
C:\PS>test-computersecurechannel True |
|
Description
-----------
This command tests the secure channel between the local computer and the domain to which it is joined.
Example 2
| Copy Code |
|
|---|---|
C:\PS>test-computersecurechannel -server DCName.fabrikam.com True |
|
Description
-----------
This command specifies a preferred domain controller for the test.
Example 3
| Copy Code |
|
|---|---|
C:\PS>Test-ComputerSecureChannel -repair True |
|
Description
-----------
This command resets the secure channel between the local computer and its domain.
Example 4
| Copy Code |
|
|---|---|
C:\PS>test-computerSecureChannel -verbose VERBOSE: Performing operation "Test-ComputerSecureChannel" on Target "SERVER01". True VERBOSE: "The secure channel between 'SERVER01' and 'net.fabrikam.com' is alive and working correctly." |
|
Description
-----------
This command uses the Verbose common parameter to request detailed messages about the operation. For more information about the Verbose parameter, see about_CommonParameters.
Example 5
| Copy Code |
|
|---|---|
C:\PS>set-alias tcsc test-computersecurechannel
if (!(tcsc))
{write-host "Connection failed. Reconnect and retry."}
else { &(.\get-servers.ps1) }
|
|
Description
-----------
This example shows how to use Test-ComputerSecureChannel to test a connection before running a script that requires the connection.
The first command uses the Set-Alias cmdlet to create an alias for the cmdlet name. This saves space and prevents typing errors.
The If statement checks the value that Test-ComputerSecureChannel returns before running a script.