Stop-HpcTestResult

Cancels a diagnostic test if it is still running.

Syntax

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

Description

The Stop-HpcTestResult cmdlet cancels the specified diagnostic test run if it is still running. You can specify the test run ID or an HpcTestResult object for the diagnostic test to cancel it. If the diagnostic test run is not running, an error occurs.

Examples

Example 1: Cancel a test by ID

PS C:\>Stop-HpcTestResult -RunId 6

This command cancels the diagnostic test run with an ID of 6.

Example 2: Get a test result and cancel the test if the user confirms

PS C:\>Get-HpcTestResult -Alias "ping" | Select-Object -Last 1 | Stop-HpcTestResult -Confirm

This command 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.

Required Parameters

-Run

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 in HPC Pack 2008.

Type:HpcTestResult
Aliases:TestResult
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-RunId

Specifies the ID 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 was introduced in HPC Pack 2008 R2. It is not supported in previous versions.

Type:Int32
Aliases:Id
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-ClusterConnectionString

Specifies an array of cluster connection strings for the cluster to which you want to add the device drivers. The value format is host1,host2,host3. If you do not specify the ClusterConnectionString parameter, this cmdlet uses the connection string on the head node that the CCP_CONNECTIONSTRING environment variable specifies. To set this environment variable, run the following cmdlet: Set-Content Env: CCP_CONNECTIONSTRING \<head_node_name\>.

This parameter was introduced in HPC Pack 2016.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Scheduler

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

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

HpcTestResult

Outputs

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.