ICC Home Privacy and Legal Notice LC User Documents Banner

UCRL-WEB-201386

SLURM Reference Manual


SINFO Options

Delimit all SINFO 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 SINFO's control options alphabetically except for -o, which gets a separate subsection at the end because of its elaborate format-specification language.

HELP OPTIONS.

--help
displays a brief SINFO 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 (and some argument hints).
--usage
displays a MAN-format syntax summary for SINFO (shows option letters but no explanatory clues). For more vebose help, use --help.

CONTROL OPTIONS.

-a (lowercase, --all)
reports on partitions that are configured as hidden and partitions that are unavailable to the user's group (if any). To report on fewer or specific partitions, use -p. To report more output fields (columns), use -l. Option --hide undoes -all.
-d (lowercase, --dead)
reports the count of nonresponding ("dead") nodes for each partition (if there are any; often 0) and includes STATE and NODELIST information only for those (if any).
-e (lowercase, --exact)
(applies only when reporting CPU count, memory size, or disk space using -o or -Nl) does not group node information on multiple nodes unless their configurations are identical. By default (without -e), SINFO may report CPU count, memory size, and disk space for nodes in the same partition and state with a minimum value followed by a plus sign (e.g., "250+").
-h (lowercase, --noheader)
omits the explanatory heads from SINFO's tabular output (for easier reuse of the text).
--hide (no one-character version)
suppresses reports on all partitions declared hidden or not available to the user's group (the default; --all undoes --hide).
-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.
-l (lowercase ell, --long)
displays four more output fields (columns) than in SINFO's default report (JOB_SIZE, ROOT, SHARE, GROUPS), but no more rows (instead try --all). This option is incompatible with -o (--format). Combining -N with -l reports CPU count, memory size, disk space, scheduling weight, and declared features (if any).
-n nodes (lowercase, --nodes=nodes)
reports information only for the specified nodes. For nodes use a quoted full node name (e.g., "mcr224"), a quoted comma-delimited list of full node names (e.g., "mcr224,mcr225"), or a quoted range of nodes specified with brackets (e.g., "mcr[224-227]").
-N (uppercase, --Node)
reports information in a node-oriented format (begins with node list and node count columns). By default, SINFO reports information in a partition-oriented format. This option is incompatible with -o (--format). Combining -N with -l reports CPU count, memory size, disk space, scheduling weight, and declared features (if any).
-r (lowercase, --responding)
reports state information only for responding nodes (omits DOWN or DRAINED nodes).
-R (uppercase, --list-reasons)
reports, for each node that is currently DOWN or DRAINED, its name and the first 35 characters of the "reason field" optionally provided by the SLURM system administrator. All other nodes are omitted (unless you invoke additional options). To explicitly report the STATE as well as the REASON for each troubled node, you must combine -R with -l (or use -o).
-s (lowercase, --summarize)
replaces SINFO's default format (one row for each different STATE in which some nodes fall) with a compressed NODES(A|I|O|T) column that summarizes the count of available|idle|other|total nodes in one string for each partition. This option is incompatible with -o (--format).
-S sortkeys (uppercase, --sort=sortkeys)
sorts the (partition or node) rows in SINFO'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 partitions is --sort="#P,-t" (partitions ordered as configured in /etc/slurm/slurm.conf, then decreasing node state). With -N, the default sort is --sort="N" (increasing node name).
-t statelist (lowercase, --states=statelist)
limits SINFO's report to nodes with the specified states, where statelist is a quoted, comma-delimited list with these possible members (case insensitive):
ALLOC
ALLOCATED
COMP
COMPLETING
DOWN
DRAIN
DRAINED
DRAINING
IDLE
UNK
UNKNOWN.
By default, SINFO reports on nodes in the specified states whether they are responding or not, but you can use -d or -r to filter this report further.
-p pname (lowercase, --partition=pname)
reports information only about the specified (single) partition (lists are not accepted as an argument here).
-v (lowercase, --verbose)
prefixes the node report (table) that SINFO would otherwise generate (based on the other control options that you invoked) with a list of 16 report-control features and the current setting for each (revealing, for example, the limits that you have currently imposed on states, nodes, or output format). The basic report itself is not changed (compare with -l, --long).
-V (uppercase, --version)
displays SINFO's current version number and ends (with no node report).

OUTPUT-FORMAT OPTION.

-o formatspec (lowercase, --format=formatspec)
specifies both the content of SINFO's report (which node 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 SINFO 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 (= node) to the next).
Z
is a single case-sensitive letter that specifies the content (the node property) reported in this column (using the dictionary given below). For example, %.8d uses a right-justified (.) column 8 characters wide to report temporary disk space per node in Mbyte (lowercase d).

The default column specifications for noncustomized SINFO node reports are:
-o "%9P %5a %.9l %.5D %6t %N"

See the SINFO 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):

a   availability of a partition (up/down)
A   (uppercase) node count for (allocated/idle) states,
    see F
c   number of CPUs per node
d   temporary disk space (in Mbyte) per node
D   (uppercase) total number of nodes (per partition)
f   node features specified (if any)
F   (uppercase) node count for (allocated/idle/other/total)
    states, see A
g   groups allowed for listed nodes
h   (yes/no/force) nodes can be shared with other jobs?
l   time limit (days:hours:minutes:seconds or INFINITE)
m   memory size per node (in Mbyte)
N   (uppercase) list of node names
P   (uppercase) node partition name
r   (yes/no) only user root may start jobs?
R   (uppercase) reason if node unavailable
s   allowed nodes/job (range)
t   node state (abbreviated, see later section)
T   (uppercase) node state (spelled out)
w   scheduling weight (an integer)



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