Get-HpcTestDetail

Get-HpcTestDetail

Gets detailed information about a diagnostic test.

Syntax

Parameter Set: TestName
Get-HpcTestDetail [-Alias] <String> [[-Company] <String> ] [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [ <CommonParameters>]

Parameter Set: TestObject
Get-HpcTestDetail -Test <HpcTestCase> [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [ <CommonParameters>]




Detailed Description

The Get-HpcTestDetail cmdlet gets detailed information about a specified diagnostic test, including the metadata, parameters, environment variables, and commands for the test. You can specify the diagnostic test by using the alias for the test or by using an HpcTestCase object for the test. To get an HpcTestCase object for a test, use the Get-HpcTest cmdlet.

Parameters

-Alias<String>

Specifies the alias of the diagnostic test for which you want to get detailed information. You cannot specify both the Alias and Test parameters. To view a list of the diagnostic tests that are available on the HPC cluster, use the Get-HpcTest cmdlet.


Aliases

Name

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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

-Company<String>

Specifies the company that created the diagnostic test for which you want to view detailed information. 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 information for one of the tests. You cannot specify both the Company and Test parameters.


Aliases

none

Required?

false

Position?

2

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 for which you want to view information. 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

-Test<HpcTestCase>

Specifies the HPCTestCase object for the diagnostic test for which you want to view detailed information. Use the Get-HpcTest cmdlet to get an HPCTestCase object for a diagnostic test. You cannot specify the Test parameter if you also specify the Alias or Company parameters.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

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.

  • HpcTestCase

Outputs

The output type is the type of the objects that the cmdlet emits.

  • HpcTestCaseDetail, HpcTestCase<Type>Parameter, HpcVariable, HpcTestCaseStep

    This cmdlet returns an HpcTestCaseDetail object, zero or more HpcTestCase<Type>Parameter objects, zero or more HpcVariable objects, and one to three HpcTestCaseStep objects.


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: Get information about a test

This command gets detailed information about the Ping Test.


PS C:\> Get-HpcTestDetail –Alias "ping"

Example 2: Get information about a test by company

This command gets detailed information about the diagnostic test with an alias of diskspace from the company named Contoso, Ltd.


PS C:\> Get-HpcTestDetail –Alias "diskspace" –Company "Contoso, Ltd"

Example 3: Get a test case and get test details for it

This command gets the HpcTestCase object for the DNS Test, and then gets detailed information about that test by redirecting that object to the input of the Get-HpcTestDetail cmdlet.


PS C:\> Get-HpcTest –Alias "dnstest" | Get-HpcTestDetail

Related topics

Community Additions

ADD
Show: