Stop-HpcTestResult

Stop-HpcTestResult

Cancels a diagnostic test if it is still running.

Syntax

Parameter Set: RunId
Stop-HpcTestResult [-RunId] <Int32> [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: RunObject
Stop-HpcTestResult -Run <HpcTestResult> [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




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

Parameters

-ClusterConnectionString<String[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

TestResult

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-RunId<Int32>

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.


Aliases

Id

Required?

true

Position?

1

Default Value

none

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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

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

  • HpcTestResult

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: Cancel a test by ID

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


PS C:\> Stop-HpcTestResult -RunId 6

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

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.


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

Related topics

Community Additions

ADD
Show: