Set-HpcTestCredential
Set-HpcTestCredential
Sets the credentials for running diagnostic tests.
Syntax
Parameter Set: password
Set-HpcTestCredential -Credential <PSCredential> [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: softcard
Set-HpcTestCredential -SoftCard [-Scheduler <String> ] [-Thumbprint <String> ] [ <CommonParameters>]
Detailed Description
Sets the credentials for running diagnostic tests. The cmdlet stores these credentials in the credential cache of the user who ran the cmdlet. 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.
Parameters
-Credential<PSCredential>
Specifies a PSCredential object that represents the credentials that you want to set for running diagnostic tests on the cluster that the Scheduler parameter specifies. This cmdlet sets these credentials in the credential cache of the user who ran the cmdlet.
You can use the Get-Credential cmdlet to get a PsCredential object. Save that object in a variable, and then use that variable with this parameter.
Aliases |
none |
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 for which you want to set the credentials for running 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>
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
%CCP_SCHEDLER% |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SoftCard
Uploads an HPC SoftCard to the HPC Scheduler service to be used for diagnostic tests. The certificate must be in the user’s personal store on the local system and will be exported from it along with the corresponding key pair. It will be encrypted and transmitted to the scheduler. If an HPC SoftCard already exists on the Head Node, it will be replaced with this SoftCard.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Thumbprint<String>
Specifies a certificate thumbprint that can be used to identify the proper certificate if multiple HPC certificates are present. If multiple HPC certificates are present and the thumbprint is not present, or if the thumbprint does not match a certificate in the user’s personal store, then an error is returned.
Aliases |
none |
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.
- A PsCredential object
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
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
Sets the credentials for running diagnostic tests on the cluster. When the Set-HpcTestCredential cmdlet runs, a dialog box appears that requests a user name and password. After you enter this information, the Set-HpcTestCredential cmdlet sets the credentials for running diagnostic tests on the cluster to the credentials that you supplied.
PS C:\>Set-HpcTestCrendential
EXAMPLE 2
Gets a PSCredential object, then sets the credentials for running diagnostics tests on the cluster to the credentials that the PSCredential object represents. When the Get-Credential cmdlet runs, a dialog box appears that requests a user name and password. After you enter this information, the Get-Credential cmdlet creates the PSCredential object and passes it to the Set-HpcTestCredential cmdlet.
PS C:\>$credential = Get-Credential
Set-HpcTestCrendential -Credential $credential