1sprio(1) Slurm Commands sprio(1)
2
6 sprio - view the factors that comprise a job's scheduling priority
7
10 sprio [OPTIONS...]
11
14 sprio is used to view the components of a job's scheduling priority
15 when the multi-factor priority plugin is installed. sprio is a read-
16 only utility that extracts information from the multi-factor priority
17 plugin. By default, sprio returns information for all pending jobs.
18 Options exist to display specific jobs by job ID and user name.
19
22 --federation
23 Show jobs in federation if a member of one.
24 -h, --noheader
27 Do not print a header on the output.
28 --help Print a help message describing all options sprio.
31 -j <job_id_list>, --jobs=<job_id_list>
34 Requests a comma separated list of job ids to display. Defaults
35 to all jobs. Since this option's argument is optional, for
36 proper parsing the single letter option must be followed immedi‐
37 ately with the value and not include a space between them. For
38 example "-j1008,1009" and not "-j 1008,1009".
39 --local
42 Show only jobs local to this cluster. Ignore other clusters in
43 this federation (if any). Overrides --federation.
44 -l, --long
47 Report more of the available information for the selected jobs.
48 -M, --clusters=<string>
51 The cluster to issue commands to. Only one cluster name may be
52 specified. Note that the SlurmDBD must be up for this option to
53 work properly. This option implicitly sets the --local option.
54 -n, --norm
57 Display the normalized priority factors for the selected jobs.
58 -o <output_format>, --format=<output_format>
61 Specify the information to be displayed, its size and position
62 (right or left justified). The default formats when all factors
63 have been assigned non-zero weights are
64 default "%.15i %9r %.10Y %.10S %.10A %.10B %.10F %.10J
67 %.10P %.10Q %20T"
68 -l, --long "%.15i %9r %.8u %.10Y %.10S %.10A %.10B %.10F
70 %.10J %.10P %.10Q %.11N %.20T";
71 The format of each field is "%[.][size]type".
74 size is the minimum field size. If no size is specified,
76 whatever is needed to print the information will be
77 used.
78 . indicates the output should be left justified. By de‐
80 fault, output is right justified.
81 Valid type specifications include:
84 %a Normalized age priority
87 %A Weighted age priority
89 %b Normalized association priority
91 %B Weighted association priority
93 %c Cluster name. Only applicable for federated clusters
95 %f Normalized fair-share priority
97 %F Weighted fair-share priority
99 %i Job ID
101 %j Normalized job size priority
103 %J Weighted job size priority
105 %N Nice adjustment
107 %p Normalized partition priority
109 %P Weighted partition priority
111 %q Normalized quality of service priority
113 %Q Weighted quality of service priority
115 %r Partition name
117 %S Weighted admin priority.
119 %t Normalized TRES priorities
121 %T Weighted TRES priorities
123 %u User name for a job
125 %Y Job priority
127 %y Normalized job priority
129 -S <sort_list>, --sort=<sort_list>
132 Specification of the order in which jobs should be reported.
133 This uses the same field specification as <output_format>. Mul‐
134 tiple sorts may be performed by listing multiple sort fields
135 separated by commas. The field specifications may be preceded by
136 "+" or "-" for ascending (default) or descending respectively.
137 For example, a <sort_list> of "u,r,-y" will sort the job prior‐
138 ity reports by username, partition name, and descending job pri‐
139 ority, in that order. The default <sort_list> is "i" (ascending
140 job id).
141 -p <partition_list>, --partition=<partition_list>
144 Requests a comma separated list of partitions to display. De‐
145 faults to all partitions.
146 --sibling
149 Show all sibling jobs on a federated cluster. Without this op‐
150 tion in a federated cluster, each job in each partition will
151 have its priority and its components reported for only one clus‐
152 ter. Each sibling job on the various clusters in the federation
153 may have different priority, which will not be reported without
154 using this option. Implicitly adds "%c" (cluster name) to the
155 output format.
156 -u <user_list>, --user=<user_list>
159 Request jobs from a comma separated list of users. The list can
160 consist of user names or user id numbers.
161 --usage
164 Print a brief help message listing the sprio options.
165 -v, --verbose
168 Report details of sprios actions.
169 -V , --version
172 Print version information and exit.
173 -w , --weights
176 Display the configured weights for each factor. This is for in‐
177 formation purposes only. Actual job data is suppressed.
178
181 Executing sprio sends a remote procedure call to slurmctld. If enough
182 calls from sprio or other Slurm client commands that send remote proce‐
183 dure calls to the slurmctld daemon come in at once, it can result in a
184 degradation of performance of the slurmctld daemon, possibly resulting
185 in a denial of service.
186 Do not run sprio or other Slurm client commands that send remote proce‐
188 dure calls to slurmctld from loops in shell scripts or other programs.
189 Ensure that programs limit calls to sprio to the minimum necessary for
190 the information you are trying to gather.
191
194 If no corresponding commandline option is specified, sprio will use the
195 value of the following environment variables.
196 SLURM_CLUSTERS Same as --clusters
198 SLURM_CONF The location of the Slurm configuration file.
201 SPRIO_FEDERATION Same as --federation
204 SPRIO_FORMAT Same as -o <output_format>, --format=<output_for‐
207 mat>
208 SPRIO_LOCAL Same as --local
211 SPRIO_SIBLING Same as --sibling
214
217 Print the list of all pending jobs with their weighted priorities
218 $ sprio
220 JOBID PRIORITY AGE FAIRSHARE JOBSIZE PARTITION QOS
221 65539 62664 0 51664 1000 10000 0
222 65540 62663 0 51663 1000 10000 0
223 65541 62662 0 51662 1000 10000 0
224 Print the list of all pending jobs with their normalized priorities
227 $ sprio -n
229 JOBID PRIORITY AGE FAIRSHARE JOBSIZE PARTITION QOS
230 65539 0.00001459 0.0007180 0.5166470 1.0000000 1.0000000 0.0000000
231 65540 0.00001459 0.0007180 0.5166370 1.0000000 1.0000000 0.0000000
232 65541 0.00001458 0.0007180 0.5166270 1.0000000 1.0000000 0.0000000
233 Print the job priorities for specific jobs
236 $ sprio --jobs=65548,65547
238 JOBID PRIORITY AGE FAIRSHARE JOBSIZE PARTITION QOS
239 65547 62078 0 51078 1000 10000 0
240 65548 62077 0 51077 1000 10000 0
241 Print the job priorities for jobs of specific users
244 $ sprio --users=fred,sally
246 JOBID USER PRIORITY AGE FAIRSHARE JOBSIZE PARTITION QOS
247 65548 fred 62079 1 51077 1000 10000 0
248 65549 sally 62080 1 51078 1000 10000 0
249 Print the configured weights for each priority component
252 $ sprio -w
254 JOBID PRIORITY AGE FAIRSHARE JOBSIZE PARTITION QOS
255 Weights 1000 100000 1000 10000 1
256
259 Copyright (C) 2009 Lawrence Livermore National Security. Produced at
260 Lawrence Livermore National Laboratory (cf, DISCLAIMER).
261 Copyright (C) 2010-2017 SchedMD LLC.
262 This file is part of Slurm, a resource management program. For de‐
264 tails, see <https://slurm.schedmd.com/>.
265 Slurm is free software; you can redistribute it and/or modify it under
267 the terms of the GNU General Public License as published by the Free
268 Software Foundation; either version 2 of the License, or (at your op‐
269 tion) any later version.
270 Slurm is distributed in the hope that it will be useful, but WITHOUT
272 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
273 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
274 for more details.
275
277 squeue(1), sshare(1)
278April 2021 Slurm Commands sprio(1)