Set-HpcJobCredential

Sets the credentials for submitting jobs.

Syntax

Copy Code
Parameter Set: Default

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


Detailed Description

Sets the credentials for submitting jobs. The cmdlet stores these credentials in the credential cache of the user who ran the cmdlet.

Parameters

-Credential<PSCredential>

Specifies a PSCredential object that represents the credentials that you want to set for submitting the jobs on the cluster that the Scheduler parameters 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, 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 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>


Aliases

none

Required?

false

Position?

named

Default Value

%CCP_SCHEDULER%

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.

Examples

EXAMPLE 1

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.


  Copy Code
Set-HpcJobCrendential

EXAMPLE 2

Gets a PSCredential object, 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 creates the PSCredential object and passes it to the Set-HpcJobCredential cmdlet.


  Copy Code
$credential = Get-Credential
Set-HpcJobCrendential -Credential $credential

Related topics


Microsoft.ComputeCluster.CCPPSH.Remove-HpcJobCredential
Microsoft.PowerShell.Commands.Get-Credential