Remove-HpcTestResultAlert

Remove-HpcTestResultAlert

Clears the alert icon for diagnostic test runs.

Syntax

Parameter Set: RunId
Remove-HpcTestResultAlert [[-RunId] <Int32[]> ] [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [ <CommonParameters>]

Parameter Set: RunObject
Remove-HpcTestResultAlert [-ClusterConnectionString <String[]> ] [-Run <HpcTestResult[]> ] [-Scheduler <String[]> ] [ <CommonParameters>]




Detailed Description

The Remove-HpcTestResultAlert cmdlet clears the alert icon for specified diagnostic test runs, or for all diagnostic test runs if none are specified. You can specify a test run by providing the ID of the test run or by providing an HpcTestResult object for the test run.

The alert icon appears for failed test runs in the list of test runs under Diagnostics in HPC Cluster Manager. Alert icons also appear for the nodes on which the diagnostic test failed under Node Management in HPC Cluster Manager. An alert icon for a node clears only when you clear the alert icons for all of the test runs that failed on that node.

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 an array of test runs for which you want to clear the alerts. Use the Get-HpcTestResult cmdlet to get the HpcTestResult object for a test run.


Aliases

TestResult

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-RunId<Int32[]>

Specifies an array of test IDs for test runs for which you want to clear the alerts. Use the Get-HpcTestResult cmdlet to view a list of test runs and their IDs.


Aliases

Id

Required?

false

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 HPC cluster that includes the diagnostic test runs for which you want to clear the alerts. 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

<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

  • You must be a cluster administrator to run this cmdlet successfully.

  • This cmdlet was introduced in HPC Pack 2008 R2. It is not supported in previous versions.

Examples

Example 1: Remove all alerts

This command clears the alerts for all diagnostic test runs.


PS C:\> Remove-HpcTestResultAlert

Example 2: Remove an alert by ID

This command clears the alert for the diagnostic test run with an ID of 62.


PS C:\> Remove-HpcTestResultAlert -RunId 62

Example 3: Get filtered test results and remove them

This command gets the HpcTestResult objects for all runs of the Ping Test that failed, and it removes the alerts for those test runs by redirecting the HpcTestResult objects to the Remove-HpcTestResultAlert cmdlet.


PS C:\> Get-HpcTestResult –Alias "ping" –Result Failure | Remove-HpcTestResultAlert

Example 4: Select a test result and remove it

This command gets the HpcTestResult object for the most recent run of the Domain Connectivity Test that failed, and it removes the alert for that test run by redirecting the HpcTestResult object to the Remove-HpcTestResultAlert cmdlet.


PS C:\> Get-HpcTestResult –Alias "ad" –Result Failure | Select-Object –Last 1 | Remove-HpcTestResultAlert

Related topics

Community Additions

ADD
Show: