Remove-HpcTestResultAlert
Remove-HpcTestResultAlert
Clears the alert icon for the specified diagnostic test runs, or for all diagnostic test runs if none are specified.
Syntax
Parameter Set: RunId
Remove-HpcTestResultAlert [[-RunId] <Int32[]> ] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: RunObject
Remove-HpcTestResultAlert [-Run <HpcTestResult[]> ] [-Scheduler <String> ] [ <CommonParameters>]
Detailed Description
Clears the alert icon for the specified diagnostic test runs, or for all diagnostic test runs if none are specified. You can specify a test run by providing the identifier 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
-Run<HpcTestResult[]>
Specifies a list of one or more 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 |
no default |
Accept Pipeline Input? |
True (ByValue) |
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 |
%CCP_SCHEDULER% |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunId<Int32[]>
Specifies a list of test identifiers for one or more test runs for which you want to clear the alerts. Use the Get-HpcTestResult cmdlet to view a list of test runs and their identifiers.
Aliases |
Id |
Required? |
false |
Position? |
1 |
Default Value |
no default |
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.
- One or more HpcTestResult objects
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
Clears the alerts for all diagnostic test runs.
PS C:\>Remove-HpcTestResultAlert
EXAMPLE 2
Clears the alert for the diagnostic test run with an identifier of 62.
PS C:\>Remove-HpcTestResultAlert -RunId 62
EXAMPLE 3
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
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