.png)
Stop-HpcTestResult
Cancels the specified diagnostic test if it is still running.
Syntax
Stop-HpcTestResult [-Scheduler <string>] -TestResult <HpcTestResult> [-confirm] [-whatif] [<CommonParameters>]
Detailed Description
Cancels the specified diagnostic test if it is still running. You use an HpcTestResult object to cancel the diagnostic test. If the diagnostic test is not running, the Stop-HpcTestResult cmdlet does nothing.
Parameters
-Scheduler <string>
Specifies the host name or IP address of the head node for the cluster on which the diagnostic test is running. The value must be a valid computer name or IP address. If you do not specify the Scheduler parameter, this cmdlet uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies. To set this environment variable, run the following cmdlet:
Set-Content Env:CCP_SCHEDULER <head_node_name>
|
Required? |
false |
|
Position? |
named |
|
Default Value |
%CCP_SCHEDULER% |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-TestResult <HpcTestResult>
Specifies the HpcTestResult object for the running diagnostic test that you want to cancel. Use the Get-HpcTestResult cmdlet to get the HpcTestResult object for a running diagnostic test.
|
Required? |
true |
|
Position? |
named |
|
Default Value |
no default |
|
Accept Pipeline Input? |
true (ByValue) |
|
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 cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.
Input and Return Types
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 emits.
|
Input Type |
An HpcTestResult object. |
|
Return Type |
None. |
Example 1
C:\PS>Get-HpcTestResult -TestState Running | Stop-HpcTestResult
Gets the HpcTestResult objects for all instances of all diagnostic tests that are still running, and cancels all of those tests by redirecting the HpcTestResult objects to the Stop-HpcTestResult cmdlet.
Example 2
C:\PS>Get-HpcTestResult -Name "Pending Software Updates" -TestState Running | Stop-HpcTestResult
Gets the HpcTestResult objects for all instances of the diagnostic tests named Pending Software Updates that are still running, and cancels all of those tests by redirecting the HpcTestResult objects to the Stop-HpcTestResult cmdlet.
Example 3
C:\PS>Get-HpcTestResult -TestState Running | Select-Object -Last 1 | Stop-HpcTestResult
Gets the HpcTestResult object for the last run diagnostic test that is still running, and cancels the test by redirecting the HpcTestResult object to the Stop-HpcTestResult cmdlet.
