Export (0) Print
Expand All

Submit-HpcJob

Submits or requeues one or more specified jobs to run the jobs.

Syntax

Submit-HpcJob [-Credential <PSCredential>] [-Scheduler <string>] [-Id] <int[]> [<CommonParameters>]

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

Detailed Description

Submits or requeues one or more specified jobs to a cluster 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.

 

Required?

false

Position?

named

Default Value

the credential of the current user

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Id <int[]>

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

 

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.

 

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>

 

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.

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

 

Input Type

One or more HpcJob objects.

Return Type

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.

Example 1

C:\PS>Submit-HpcJob -Id 35 -Scheduler MyHeadNode

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

See Also

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft