job list
Applies To: Microsoft HPC Pack 2012, Microsoft HPC Pack 2012 R2
Lists information about the jobs that match the specified criteria.
For examples of how to use this command, see Examples.
Syntax
job list [/all] [/format:{list|table}]
[/jobname: {<jobname> | jobname_prefix* | *}]
[/jobtemplate:<TemplateName>}] [/pool:{poolname}]
[/project:<ProjectName>] [/scheduler:<name>][{/state:<state1>[,<state2>…] |
/status:<status1>[,<status2>…]}] [/submittime:<days>]
[/user:{<UserId> | *}]
job list {/? | /help}
Parameters
Parameter |
Description |
|---|---|
/all |
Lists all of the jobs in the HPC cluster. If you do not specify the /all parameter, the job list command only lists jobs that have a state of Queued or Running and that belong to the current user, unless you explicitly specify a state or user with the /state or /user parameter. |
/format:{list|table} |
Specifies the format in which the command should display the information. The valid formats are list and table. The default format is table. |
/jobname:<JobName> |
Specifies the name of the job for which you want to display information. |
/jobtemplate:<TemplateName> |
Specifies the name of the job template that is used by the jobs for which you want to display information. |
/project:<ProjectName> |
Specifies the project name for the jobs for which you want to display information. |
/pool: <poolname> |
Specifies the pool name for the jobs for which you want to display information. Note This parameter was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2) and is not supported in previous versions. |
/scheduler:<name> |
Specifies the host name or IP address of the head node for the cluster for which you want to get job information. The value must be a valid computer name or IP address. If you do not specify the /scheduler parameter, this command uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies. |
/state:<state1>[,<state2>…] |
Specifies a list of one or more states for the jobs for which you want to display information. If you specify multiple states, separate them by commas (,), or use a value of All to specify all of the states. The possible states are Configuring, Submitted, Queued, Running, Finished, Failed, Canceled, and All. If you do not specify the /state parameter, the job list command displays information only for jobs that have a state of Queued or Running. |
/status:<status1>[,<status2>…] |
Deprecated. Use the /state parameter instead. |
/submittime:<days> |
Displays only the jobs that were submitted within the last specified number of days. The number of days must be a positive integer. |
/user:{<UserId> | *} |
Specifies the owner of the jobs for which you want to get information, in the <domain>\<user_name> format. To get information about the jobs for all owners, use an asterisk (*) for the value of the /user parameter. |
/? |
Displays Help at the command prompt. |
/help |
Displays Help at the command prompt. |
Remarks
By default, the job list command only displays jobs that have a state of Queued or Running, unless you specify the state of the jobs that you want to display.
Examples
To view information about all of the jobs for the cluster, regardless of the state or owner of the job, use the following command:
job list /all
To view information about all of the jobs that you own, regardless of the state of the job, use the following command:
job list /state:all
To view information about all of the jobs that belong to the project named Experiments, that use the job template named MyJobTemplate, and that are owned by the user with a user name of someone in the CONTOSO domain, use the following command:
job list /project:Experiments /jobtemplate:MyJobTemplate /user:CONTOSO\someone