Get-HpcTestResult
Get-HpcTestResult
Gets the test runs for the specified diagnostic test that meet the specified criteria.
Syntax
Parameter Set: TestName
Get-HpcTestResult [[-Alias] <String> ] [[-Company] <String> ] [-LastRunTime <DateTime> ] [-NeedReview <Boolean> ] [-Result <DiagnosticResult> ] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: TestObject
Get-HpcTestResult -Test <HpcTestCase> [-LastRunTime <DateTime> ] [-NeedReview <Boolean> ] [-Result <DiagnosticResult> ] [-Scheduler <String> ] [ <CommonParameters>]
Detailed Description
Gets the test runs for the specified diagnostic test that meet the specified criteria. You can use either the alias or an HpcTestCase object for a diagnostic test to specify it.
If you do not specify a diagnostic test but do specify other criteria, the cmdlet gets the test runs for all of the diagnostic tests that meet the specified criteria. If you specify a diagnostic test without specifying other criteria, the cmdlet gets all of the test runs for the specified diagnostic test. If you specify neither a diagnostic test nor any other criteria, the cmdlet gets all test runs for all diagnostic tests for the HPC cluster.
Parameters
-Alias<String>
Specifies the alias of the diagnostic test for which you want to get test runs. Use the Get-HpcTest cmdlet to see the diagnostic tests available for the cluster. You cannot specify both the Alias and Test parameters.
In HPC Pack 2008 R2 this parameter replaced the Name parameter.
Aliases |
Name |
Required? |
false |
Position? |
1 |
Default Value |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Company<String>
Specifies the company that created the diagnostic test for which you want to get test runs. If you specify the Company parameter, you must also specify the Alias parameter. Specify the company if your HPC cluster includes two diagnostic tests with the same alias from different companies and you only want test runs for one of the tests. You cannot specify both the Company and Test parameters.
This parameter was introduced in HPC Pack 2008 R2. It is not available in previous versions.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-LastRunTime<DateTime>
Specifies a DateTime object or equivalent string for the date and time at or after which a user ran the diagnostic test that generated the test runs that you want to get. You can use the Get-Date cmdlet to get a DateTime object. If you specify the LastRunTime parameter, the Get-HpcTestResult cmdlet gets only the test results for diagnostic tests that ran at or after the specified date and time.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NeedReview<Boolean>
Specifies whether to get test runs that have an alert that has not been cleared. A value of $true indicates that the cmdlet should get test runs that have an alert that has not been cleared. A value of $false indicates that the cmdlet should get test runs that do not have an alert or for which the alert has been cleared. To clear an alert for a test run, use the Remove-HpcTestResultAlert cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Result<DiagnosticResult>
Specifies the type of result for which you want to get test runs. The possible values for Result are NoResult, Success, Warning, Failure, FailedToRun, Complete, and Canceled.
In HPC Pack 2008 R2 this parameter replaced the TestState parameter.
Aliases |
TestState |
Required? |
false |
Position? |
named |
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 that includes the diagnostic tests and test runs. 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 |
-Test<HpcTestCase>
Specifies the HpcTestCase object for the diagnostic test for which you want to get test runs. Use the Get-HpcTest cmdlet to get the HpcTestCase object for a diagnostic test. You can either save that HpcTestCase object in a variable that you specify for the Test parameter, or redirect the output of a command or an expression that gets an HpcTestCase object to the Get-HpcTestResult cmdlet by using the object pipeline.
You cannot specify both the Test parameter and either the Alias or Company parameter.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
no default |
Accept Pipeline Input? |
True (ByValue) |
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 HpcTestCase object.
Outputs
The output type is the type of the objects that the cmdlet emits.
- One or more HpcTestResult objects.
Notes
The databases in the HPC cluster store information about test runs for only the number of days that the TtlCompletedJobs configuration parameter specifies, which is 5 by default. The Get-HpcTestResult cmdlet cannot get information about older test runs. To view the value of the TtlCompletedJobs configuration parameters, use the Get-HpcClusterProperty cmdlet.
You must be a cluster administrator to run this cmdlet successfully.
The FailedNode and Suite parameters that this cmdlet had before HPC Pack 2008 R2 are no longer supported.
Examples
EXAMPLE 1
Gets all of the test runs for all diagnostic tests for the cluster.
PS C:\>Get-HpcTestResult
EXAMPLE 2
Gets all of the test runs for the Ping Test that ran after midnight on 5/18/2010 and failed.
PS C:\>Get-HpcTestResult -Alias ping -Result Failure -LastRunTime "5/18/2010 12:00:00 AM"
EXAMPLE 3
Gets the HpcTestCase object for the DNS Test and redirects that object to the input of the Get-HpcTestResult cmdlet to get all test runs for the DNS Test that have alerts that have not been cleared.
PS C:\>Get-HpcTest -Alias dnstest | Get-HpcTestResult -NeedReview $true