Stop-HpcTestResult

Cancels the specified diagnostic test if it is still running.

Syntax

	Copy Code
Parameter Set: RunId Stop-HpcTestResult [-RunId] <Int32> [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: RunObject Stop-HpcTestResult -Run <HpcTestResult> [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Copy Code

Parameter Set: RunId


Stop-HpcTestResult [-RunId] <Int32> [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: RunObject


Stop-HpcTestResult -Run <HpcTestResult> [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

Cancels the specified diagnostic test run if it is still running. You can specify the test run identifier or an HpcTestResult object for the diagnostic test to cancel it. If the diagnostic test run is not running, an error occurs.

Parameters

-Run<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. You cannot specify both the Run and RunId parameters.

This parameter was named TestResult Windows HPC Server 2008.

Aliases	TestResult
Required?	true
Position?	named
Default Value	no default
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-RunId<Int32>

Specifies the identifier for the diagnostic test run that you want to cancel. Use the Get-HpcTestResult cmdlet to see the diagnostic test runs for an HPC cluster. You cannot specify both the RunId and Run parameters.

This parameter is supported only for Windows HPC Server 2008 R2.

Aliases	Id
Required?	true
Position?	1
Default Value	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-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>

Aliases	none
Required?	false
Position?	named
Default Value	%CCP_SCHEDULER%
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 cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

An HpcTestResult object

Outputs

The output type is the type of the objects that the cmdlet emits.

None

Notes

The built-in ConfirmImpact setting for this cmdlet is Medium. If this ConfirmImpact setting is equal to or higher than the value of the $ConfirmPreference variable for your environment, the cmdlet prompts for confirmation unless you specify –Confirm:$false. If this ConfirmImpact setting is lower than the value of the $ConfirmPreference variable for your environment, the cmdlet does not prompt for confirmation unless you specify –Confirm or –Confirm:$true.
You must be a cluster administrator to run this cmdlet successfully.

Examples

EXAMPLE 1

Cancels the diagnostic test run with an identifier of 6.

	Copy Code
Stop-HpcTestResult -RunId 6

EXAMPLE 2

Gets the HpcTestResult object for the most recent run of the Ping Test and cancels that test run if the user confirms the cancellation when prompted.

	Copy Code
Get-HpcTestResult -Alias ping \| Select-Object -Last 1 \| Stop-HpcTestResult -Confirm