Export-HpcTestResult
Export-HpcTestResult
Exports the test results for the specified diagnostic test run to the specified directory.
Syntax
Parameter Set: RunId
Export-HpcTestResult [-RunId] <Int32> [-Force] [-Path <String> ] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: RunObject
Export-HpcTestResult -Run <HpcTestResult> [-Force] [-Path <String> ] [-Scheduler <String> ] [ <CommonParameters>]
Detailed Description
Exports the test results for the specified diagnostic test run to the specified directory. You can specify the diagnostic test run for which you want to export the test results by specifying the identifier for the test run or the HpcTestResult object for the test run.
The test results can consist of several files, including a Poststep.result file that concatenates the standard output and standard error streams from all of the nodes in the diagnostic test; a PostStepResult.xml file that contains the results of the diagnostic test, which is structured according to the Diagnostic Test Step Result XML Schema; and a Report.html file that contains the results of the diagnostic test that is formatted as an HTML page that HPC Cluster Manager displays on the Result tab for the test results.
Parameters
-Force
This parameter is deprecated. Use -Confirm:$false instead.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
not applicable |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Path<String>
Specifies the directory to which you want to export the test results, including the full or relative path to the directory if the Export-HpcTestResult cmdlet should not save the test results in a subdirectory in the current directory.
This cmdlet creates directories that do not already exist in the path. If the directory already exists and you do not specify the Force parameter, the cmdlet prompts you to confirm whether you want to replace the contents of the directory.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
%CCP_HOME%\bin |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Run<HpcTestResult>
Specifies the test run for which you want to export the results. To get the HpcTestResult object for a test run, use the Get-HpcTestResult cmdlet. You cannot specify both the Run and RunId parameters.
This parameter was named TestResult prior to HPC Pack 2008 R2.
Aliases |
TestResult |
Required? |
true |
Position? |
named |
Default Value |
no default |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-RunId<Int32>
Specifies the identifier of the test run for which you want to export the results. To view the test runs for the HPC cluster, use the Get-HpcTestResult cmdlet. 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 |
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 test results that you want to export. 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 |
<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 HpcTestResult object
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Notes
The Export-HpcTestResult cmdlet can only export one set of test results at a time. If you get more than one test run when you run the Get-HpcTestResult cmdlet and then redirect the multiple HpcTestResult objects to the Export-HpcTestResult cmdlet, the Export-HpcTestResult cmdlet overwrites the test results files each time that the Export-HpcTestResult cmdlet processes a new HpcTestResult object.
The Export-HpcTestResult cmdlet exports a Poststep.result file only when the PostStep phase of the diagnostic test sends text to standard output or standard error.
Prior to HPC Pack 2008 R2, this cmdlet exported a single HTML file.
You must be a cluster administrator to run this cmdlet successfully.
Examples
EXAMPLE 1
Exports the test results of the test run with an identifier of 9 to the C:\TestResults\Run9 directory.
PS C:\>Export-HpcTestResult -RunId 9 -Path C:\TestResults\Run9
EXAMPLE 2
Exports the test results for the last failed run of the ping test to the C:\TestResults\LastPingTestFailure directory.
PS C:\>Export-HpcTestResult -Run (Get-HpcTestResult -Alias ping -Result Failure | Select-Object -Last 1) -Path C:\TestResults\LastPingTestFailure