Remove-HpcTest

Remove-HpcTest

Removes the diagnostic test with the specified alias from the HPC cluster.

Syntax

Parameter Set: TestName
Remove-HpcTest [-Alias] <String> [-ClusterConnectionString <String[]> ] [-Company <String> ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: TestObject
Remove-HpcTest -Test <HpcTestCase> [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Remove-HpcTest cmdlet removes the diagnostic test with the specified alias from the HPC cluster. You can use an alias or an HPCTestCase object to specify the diagnostic test to remove. Use the Get-HpcTest cmdlet to view the aliases of diagnostic tests on the HPC cluster or to get the HPCTestCase object for a specific test.

Parameters

-Alias<String>

Specifies the alias of the diagnostic test that you want to remove from the HPC cluster. You cannot specify both the Alias and Test parameters. To view a list of the diagnostic tests 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 that you want to remove from the HPC cluster. 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?

named

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 for which you want to remove the diagnostic test. 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 that you want to remove from the HPC cluster. 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

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

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.

  • None

Notes

  • You cannot remove the system tests that Microsoft HPC Pack provides. These system tests have System as the company name.

  • If you remove a diagnostic test for the cluster, HPC Pack does not remove the information about the results of the test runs for that diagnostic test. You can still view the results of those test runs with the Get-HpcTestResult and Get-HpcTestResultDetail cmdlets.

  • The built-in ConfirmImpact setting for this cmdlet is Medium. If this ConfirmImpact setting is equal to or higher than the value of the $ConfirmPreference variable for your environment, the cmdlet prompts for confirmation unless you specify -Confirm:$False. If this ConfirmImpact setting is lower than the value of the $ConfirmPreference variable for your environment, the cmdlet does not prompt for confirmation unless you specify -Confirm or -Confirm:$True.

  • 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: Remove a test by name

This command removes the diagnostic test with an alias of diskspace from the HPC cluster.


PS C:\> Remove-HpcTest -Alias "diskspace"

Example 2: Remove a test with no confirmation

This command removes the diagnostic test with an alias of culturetest from the company Contoso, Ltd. from the HPC cluster without prompting for confirmation.


PS C:\> Remove-HpcTest -Alias "culturetest" -Company "Costoso, Ltd" -Confirm:$False

Example 3: Get a test and remove it

This command gets the HpcTestCase object for the diagnostic test with an alias of exceltest, and then removes that diagnostic test from the HPC cluster by redirecting the HpcTestCase object to the input of the Remove-HpcTest cmdlet.


PS C:\> Get-HpcTest -Alias "exceltest" | Remove-HpcTest

Related topics

Community Additions

ADD
Show: