Submit-HpcJob
Submits or re-queues jobs to the HPC cluster.
Syntax
job (Default)
Submit-HpcJob
-Job <HpcJob[]>
[-Credential <PSCredential>]
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[<CommonParameters>]
id
Submit-HpcJob
[-Id] <Int32[]>
[-Credential <PSCredential>]
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[<CommonParameters>]
Description
The Submit-HpcJob cmdlet submits or re-queues one or more specified jobs to the HPC cluster that you want to run the jobs. You can use either the job IDs or HpcJob objects to specify the jobs. You can resubmit jobs that have a state of canceled or failed.
Examples
Example 1: Submit a job
PS C:\>Submit-HpcJob -Id 35 -Scheduler "MyHeadNode"
This command submits the job with job ID 35 on the cluster that has a head node named MyHeadNode.
Parameters
-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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
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.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Id
Specifies an array of job IDs for the jobs you want to submit.
Parameter properties
| Type: | Int32[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
id
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Job
Specifies an array of HpcJob objects for the jobs that you want to submit for running on the cluster.
Parameter properties
| Type: | HpcJob[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
job
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Scheduler
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\>
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
HpcJob
Outputs
HpcJob
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.
- In HPC Pack 2012 with Service Pack 1 (SP1), a cluster member added as a job operator can use this cmdlet to requeue (but not submit) a job. However, a job operator cannot modify any job properties at the time that the job is requeued.