Submit-HpcJob

Submits or requeues one or more specified jobs to the HPC cluster that you want to run the jobs.

Syntax

	Copy Code
Parameter Set: job Submit-HpcJob -Job <HpcJob[]> [-Credential <PSCredential> ] [-Scheduler <String> ] [ <CommonParameters>] Parameter Set: id Submit-HpcJob [-Id] <Int32[]> [-Credential <PSCredential> ] [-Scheduler <String> ] [ <CommonParameters>]

Copy Code

Parameter Set: job


Submit-HpcJob -Job <HpcJob[]> [-Credential <PSCredential> ] [-Scheduler <String> ] [ <CommonParameters>]

Parameter Set: id


Submit-HpcJob [-Id] <Int32[]> [-Credential <PSCredential> ] [-Scheduler <String> ] [ <CommonParameters>]

Detailed Description

Submits or requeues one or more specified jobs to the HPC cluster that you want to run the jobs. You can use either the job identifiers or HpcJob objects to specify the jobs. You can resubmit jobs that have a state of canceled or failed.

Parameters

-Credential<PSCredential>

Specifies a PSCredential object for the credentials you want to use to submit the jobs. You can use the Get-Credential cmdlet to get a PSCrendential object. If you do not specify this parameter, then the cmdlet submits the jobs with the Windows credentials of the user currently logged in.

Aliases	none
Required?	false
Position?	named
Default Value	the credential of the current user
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Id<Int32[]>

Specifies a list of job identifiers for the jobs you want to submit.

Aliases	none
Required?	true
Position?	1
Default Value	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Job<HpcJob[]>

Specifies a list of HpcJob objects for the jobs that you want to submit for running on the cluster.

Aliases	none
Required?	true
Position?	named
Default Value	no default
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-Scheduler<String>

Specifies the host name or IP address of the head node for the cluster to which you want to submit the jobs. The value must be a valid computer name. 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.

One or more HpcJob objects.

Outputs

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

One or more HpcJob objects.

Notes

After you submit the job, the job scheduler validates the job and enters the job in the job queue. The job scheduler waits to start the job until sufficient resources become available.

Examples

EXAMPLE 1

Submits the job with job identifier 35 on the cluster that has a head node named MyHeadNode.

	Copy Code
Submit-HpcJob -Id 35 -Scheduler MyHeadNode