Set-HpcJobCredential

Reference

Module:: HPCPack2016

Sets the credentials for submitting jobs.

Syntax

Set-HpcJobCredential
   -Credential <PSCredential>
   [-ExtendedData <String>]
   [-ClusterConnectionString <String[]>]
   [-Scheduler <String[]>]
   [<CommonParameters>]

Set-HpcJobCredential
   [-SoftCard]
   [-Thumbprint <String>]
   [-ExtendedData <String>]
   [-ClusterConnectionString <String[]>]
   [-Scheduler <String[]>]
   [<CommonParameters>]

Set-HpcJobCredential
   [-ExtendedData <String>]
   [-AadUser]
   [-ClusterConnectionString <String[]>]
   [-Scheduler <String[]>]
   [<CommonParameters>]

Description

The Set-HpcJobCredential cmdlet sets the credentials for submitting jobs. The cmdlet stores these credentials in the credential cache of the user who ran the cmdlet.

Examples

Example 1: Set credentials to submit jobs

PS C:\>Set-HpcJobCrendential

This command sets the credentials for submitting jobs on the cluster. When the Set-HpcJobCredential cmdlet runs, a dialog box appears requesting a user name and password. After you enter this information, the Set-HpcJobCredential cmdlet sets the credentials for submitting jobs on the cluster to the credentials you supplied.

Example 2: Get credentials and set them to submit jobs

PS C:\>$Credential = Get-Credential
PS C:\> Set-HpcJobCrendential -Credential $Credential

This command gets a PSCredential object, and then sets the credentials for submitting jobs on the cluster to the credentials that the PSCredential object represents. When the Get-Credential cmdlet runs, a dialog box appears requesting a user name and password. After you enter this information, the Get-Credential cmdlet creates the PSCredential object and passes it to the Set-HpcJobCredential cmdlet.

Parameters

-AadUser

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-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.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Credential

Specifies a PSCredential object that represents the credentials that you want to set for submitting the jobs 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.

Type:	PSCredential
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ExtendedData

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Scheduler

Specifies the host name or IP address of the head node for the cluster that contains jobs for which you want to set the credentials. 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\>

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SoftCard

Indicates that this operation caches the HPC soft card on the cluster. If an HPC soft card for that user is already cached, it is replaced.

This parameter was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2). It is not supported in previous versions.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Thumbprint

Specifies the certificate thumbprint toused to identify the proper certificate if multiple HPC soft card 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.