Share via

Remove-HpcTestCredential

Module:
HPC Module

Clears the cached credentials that the HPC Diagnostics Service uses to run diagnostic tests.

Syntax

Default (Default) 

Remove-HpcTestCredential
    [-ClusterConnectionString <String[]>]
    [-Scheduler <String[]>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Remove-HpcTestCredential cmdlet clears the cached credentials that the HPC Diagnostics Service uses to run diagnostic tests. These credentials are used to run the clusrun commands that run each phase of the diagnostic test if the user does not specify credentials when running the test.

Examples

Example 1: Remove cached credentials

PS C:\>Remove-HpcTestCredential

This command clears the cached credentials that the HPC Diagnostics Service uses to run diagnostics tests.

Parameters

-ClusterConnectionString

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.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Scheduler

Specifies the host name or IP address of the head node for the cluster for which you want to clear the cached credentials that the HPC Diagnostics Service uses to run diagnostic tests. 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\>

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

None

Notes

  • You cannot delete installation credentials. You can only delete credentials for running diagnostic tests, submitting jobs, or creating SOA sessions.
  • After you clear the cached credentials that the HPC Diagnostics Service uses to run diagnostic tests, the cluster administrator is prompted for credentials the next time the cluster administrator runs a diagnostic test and also is asked whether those credentials should be saved.
  • 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.