Remove-HpcTest

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

Syntax

	Copy Code
Parameter Set: TestName Remove-HpcTest [-Alias] <String> [-Company <String> ] [-Force] [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>] Parameter Set: TestObject Remove-HpcTest -Test <HpcTestCase> [-Force] [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Copy Code

Parameter Set: TestName


Remove-HpcTest [-Alias] <String> [-Company <String> ] [-Force] [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: TestObject


Remove-HpcTest -Test <HpcTestCase> [-Force] [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

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	no default
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	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Force

Removes the diagnostic test without prompting for confirmation. Equivalent to specifying -Confirm:$false, and it overrides the Confirm parameter.

Aliases	none
Required?	false
Position?	named
Default Value	not applicable
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	%CCP_SCHEDULER%
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	no default
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before executing the command.

Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Required?	false
Position?	named
Default Value	none
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 HpcTestCase object

Outputs

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

None

Notes

You cannot remove the system tests that Windows HPC Server 2008 R2 provides. These systems tests have System as the company name.
If you remove a diagnostic test for the cluster, Windows HPC Server 2008 R2 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 or -Force. 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 is supported only for Windows HPC Server 2008 R2.

Examples

EXAMPLE 1

Removes the diagnostic test with an alias of diskspace from the HPC cluster.

	Copy Code
Remove-HpcTest -Alias diskspace

EXAMPLE 2

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

	Copy Code
Remove-HpcTest -Alias culturetest -Company "Costoso, Ltd" -Force

EXAMPLE 3

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

	Copy Code
Get-HpcTest -Alias exceltest \| Remove-HpcTest