Export (0) Print
Expand All

Export-HpcTestResult

Exports the test result of a specified diagnostic test run to an HTML file.

Syntax

Export-HpcTestResult [-Force] [-Scheduler <string>] [-TestResult <HpcTestResult>] -Path <string> [<CommonParameters>]

Detailed Description

Exports the test result of a specified diagnostic test run to an HTML file. You specify the test results that you want to export with a HpcTestResult object that you get by running the Get-HpcTestResult cmdlet.

Parameters

-Force

Replaces the HTML file for the test result if the file already exists, without prompting the user.

 

Required?

false

Position?

named

Default Value

not applicable

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Path <string>

Specifies the file name for the HTML file to which you want to export the test result, including the full or relative path to the file if the Export-HpcTestResult cmdlet should not save the file in the current directory.

This cmdlet creates any directories that do not already exist in that path. If the file already exists and you do not specify the Force parameter, the cmdlet prompts you to confirm whether you want to replace the file.

 

Required?

true

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 test result. 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>

 

Required?

false

Position?

named

Default Value

%CCP_SCHEDULER%

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TestResult <HpcTestResult>

Specifies an HpcTestResult object for the test result that you want to export. Use the Get-HpcTestResult object to get an HpcTestResult object for a single test result. The Export-HpcTestResult cmdlet can export only a single test result.

 

Required?

false

Position?

named

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.

Input and Return Types

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

 

Input Type

An HpcTestResult object.

Return Type

None.

Notes

The Export-HpcTestResult cmdlet can only export one test result at a time. If you get more than one test result when you run the Get-HpcTestResult cmdlet and then redirect the multiple HpcTestResult objects to the Export-HpcTestResult cmdlet, the Export-HpcTestResult cmdlet overwrites or prompts you to overwrite the HTML file each time that the cmdlet processes a new HpcTestResult object.

Example 1

C:\PS>Export-HpcTestResult -TestResult (Get-HpcTestResult -Name "Domain Connectivity" -TestState Success | Select-Object -Last 1) -Path C:\TestResults\DomainTest.html

Exports the test result for the last successful run of the diagnostic test named Domain Connectivity to the HTML file at C:\TestResults\DomainTest.html.

See Also

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft