ICC Home Privacy and Legal Notice LC User Documents Banner

UCRL-WEB-201386

SLURM Reference Manual


SQUEUE Options

Delimit all SQUEUE options with spaces (blanks), but delimit items in option-argument lists with commas unless otherwise noted (-o requires space-delimited arguments, for example). Enclose all argument lists in quotes (") for greater reliability. This section lists SQUEUE's control options alphabetically except for -o, which gets a separate subsection at the end because of its elaborate format-specification language.

CONTROL OPTIONS.

-? (--help)
displays a brief SQUEUE options summary, one line per option, giving both the single-character and Linux-syntax versions of each option along with a very short note on its role (but no argument details). The -? version fails on some machines, so prefer --help.
-h (lowercase, --noheader)
omits the explanatory heads from SQUEUE's tabular output (for easier reuse of the text).
-i sec (lowercase, --iterate=sec)
repeatedly gathers and reports the status information (as specified by other options) every sec seconds. Use CTRL-C to stop this iterated display.
-j jlist (lowercase, --jobs=jlist)
limits the SQUEUE report to only the jobs specified in jlist, a comma-delimited list of numerical SRUN job IDs (for example, --jobs="1235,1237,1239"). The default report covers all current jobs. You cannot change the order in which SQUEUE reports on jobs by using this option (instead, use -S or --sort).
-l (lowercase ell, --long)
adds to SQUEUE's default report another column (TIMELIMIT, which may contain numerical values or the strings NOT_SET or UNLIMITED) and uses full words (such as RUNNING) rather than abbreviations (such as R, see later section) to report job states. (Compare with -v, --verbose below.)
-p plist (lowercase, --partition=plist)
limits SQUEUE's report to jobs in the partitions specified by plist, a comma-delimited list of partition names (such as "debug" or "pbatch").
-s slist (lowercase, --steps=slist)
limits the SQUEUE report to only the steps specified in slist, a comma-delimited list of numerical SRUN job-step IDs (for example, --steps="6543.1,6555.3"). The default report covers all current job steps. SQUEUE does not support job steps on BlueGene/L.
-S sortkeys (uppercase, --sort=sortkeys)
sorts the (job) rows in SQUEUE's report using the sort keys specified in sortkeys, a comma-delimited list of the same field (column) specifiers used for and explained in the -o (--format) option below. The default order is ascending; prefix each field specifier with minus (-) for descending order. The default sort for jobs is --sort="P,t,-p" (increasing partition names, then increasing job states, then decreasing job priority). The default sort for job steps is --sort="P,i" (increasing partition names, then increasing job-step IDs). SQUEUE does not support job steps on BlueGene/L.
-t statelist (lowercase, --states=statelist)
limits SQUEUE's report to jobs with the specified states (statuses), where statelist is a comma-delimited list with these possible members: ALL, PENDING, RUNNING, COMPLETE. The default report includes only PENDING and RUNNING jobs. See the Job States section below for an explanatory list of all SQUEUE job-state codes.
-u ulist (lowercase, --users=ulist)
limits SQUEUE's report to jobs belonging to the users specified in ulist, a comma-delimited list of user names on the system where you run SQUEUE.
-v (lowercase, --verbose)
prefixes the job report (table) that SQUEUE would otherwise generate (based on the other control options that you invoked) with a list of 12 report-control features and the current setting for each (for example, the limits that you have currently imposed on states, users, or output format). The job report itself is not changed (compare with -l, --long).
-V (uppercase, --version)
displays SQUEUE's current version number and ends (with no job report).

OUTPUT-FORMAT OPTION.

-o formatspec (lowercase, --format=formatspec)
specifies both the content of SQUEUE's report (which job properties to include as report columns) and the layout (the left-to-right order of those columns, the size of each column in characters, and whether the data is left- or right-justified within each column). Here formatspec is a quoted, space (not comma) delimited list of "field specifications," one for each column that you want SQUEUE to report, and each with this syntax: %.wZ
%
is the [required] field specification flag, marking the start of each column's separate specification.
.(dot)
requests right justification of this column's data (the default omits the dot and uses left justification of the reported data).
w
is an integer specifying the width of this column in characters (omitting w uses just as much space as the data requires, which usually means that there is no column alignment from one row (=job) to the next).
Z
is a single case-sensitive letter that specifies the content (the job property) reported in this column (using the dictionary given below). For example, %.8j uses a right-justified (.) column 8 characters wide to report job name (lowercase j).

The default column specifications for noncustomized SQUEUE job reports are:
-o "%.7i %.9P %.8j %.8u %.2t %.9M %.6D %N"
See the SQUEUE example section below for a sample default report and a sample column-customized report built using the -o option.

Available one-letter case-sensitive content specifiers (Z) for use in %.wZ field specifications are (in alphabetical order):

b   time when this job started executing
c   minimum number of CPUs requested
C   (uppercase) actual number of CPUs allocated
d   minimum temp disk space (in Mbyte) requested
D   (uppercase) minimum number of nodes requested (if pending),
    or, actual number of nodes allocated (if running)
e   time when job ended (or is predicted to end)
f   node features required by this job
h   (yes/no) allocated nodes can be shared with other jobs?
i   job ID or job-step ID (numeric)
j   job name (alphanumeric)
l   time limit (days:hours:minutes:seconds)
    or NOT_SET yet, or UNLIMITED
m   minimum requested memory size (in Mbyte)
M   (uppercase) time used (days:hours:minutes:seconds)
n   list of requested node names
N   (uppercase) list of allocated node names
o   minimum number of nodes requested
O   (uppercase) (yes/no) are contiguous nodes requested?
p   job priority (0.0 .GE. p .LE. 1.0)
P   (uppercase) job partition
S   (uppercase) job start time
t   job state (abbreviated, see later section)
T   (uppercase) job state (spelled out)
u   user name (alphanumeric)
U   (uppercase) user ID (numeric)



Navigation Links: [ Document List ] [ HPC Home ] [ Next ]