1sprio(1)                        Slurm Commands                        sprio(1)
2
3
4

NAME

6       sprio - view the factors that comprise a job's scheduling priority
7
8

SYNOPSIS

10       sprio [OPTIONS...]
11
12

DESCRIPTION

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
20

OPTIONS

22       --federation
23              Show jobs in federation if a member of one.
24
25
26       -h, --noheader
27              Do not print a header on the output.
28
29
30       --help Print a help message describing all options sprio.
31
32
33       -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
40
41       --local
42              Show  only  jobs local to this cluster. Ignore other clusters in
43              this federation (if any). Overrides --federation.
44
45
46       -l, --long
47              Report more of the available information for the selected jobs.
48
49
50       -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
55
56       -n, --norm
57              Display the normalized priority factors for the selected jobs.
58
59
60       -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
65
66              default        "%.15i %9r %.10Y %.10A %.10F  %.10J  %.10P  %.10Q
67                             %20T"
68
69              -l, --long     "%.15i  %9r  %.8u  %.10Y  %.10A %.10F %.10J %.10P
70                             %.10Q %.6N %20T"
71
72
73              The format of each field is "%[.][size]type".
74
75              size    is the minimum field size.  If  no  size  is  specified,
76                      whatever  is  needed  to  print  the information will be
77                      used.
78
79               .      indicates the  output  should  be  left  justified.   By
80                      default, output is right justified.
81
82
83              Valid type specifications include:
84
85
86              %a  Normalized age priority
87
88              %A  Weighted age priority
89
90              %c  Cluster name. Only applicable for federated clusters
91
92              %f  Normalized fair-share priority
93
94              %F  Weighted fair-share priority
95
96              %i  Job ID
97
98              %j  Normalized job size priority
99
100              %J  Weighted job size priority
101
102              %N  Nice adjustment
103
104              %p  Normalized partition priority
105
106              %P  Weighted partition priority
107
108              %r  Partition name
109
110              %q  Normalized quality of service priority
111
112              %Q  Weighted quality of service priority
113
114              %t  Normalized TRES priorities
115
116              %T  Weighted TRES priorities
117
118              %u  User name for a job
119
120              %Y  Job priority
121
122              %y  Normalized job priority
123
124
125       -p <partition_list>, --partition=<partition_list>
126              Requests  a  comma  separated  list  of  partitions  to display.
127              Defaults to all partitions.
128
129
130       --sibling
131              Show all sibling jobs  on  a  federated  cluster.  Without  this
132              option  in  a federated cluster, each job in each partition will
133              have its priority and its components reported for only one clus‐
134              ter.  Each sibling job on the various clusters in the federation
135              may have different priority, which will not be reported  without
136              using  this  option.  Implicitly adds "%c" (cluster name) to the
137              output format.
138
139
140       -u <user_list>, --user=<user_list>
141              Request jobs from a comma separated list of users.  The list can
142              consist of user names or user id numbers.
143
144
145       --usage
146              Print a brief help message listing the sprio options.
147
148
149       -v, --verbose
150              Report details of sprios actions.
151
152
153       -V , --version
154              Print version information and exit.
155
156
157       -w , --weights Display the configured weights for each
158              factor.  This is for information purposes only.  Actual job data
159              is suppressed.
160
161

ENVIRONMENT VARIABLES

163       If no corresponding commandline option is specified, sprio will use the
164       value of the following environment variables.
165
166       SLURM_CLUSTERS      Same as --clusters
167
168       SLURM_CONF          The location of the Slurm configuration file.
169
170
171       SPRIO_FEDERATION    Same as --federation
172
173
174       SPRIO_LOCAL         Same as --local
175
176
177       SPRIO_SIBLING       Same as --sibling
178
179

EXAMPLES

181       Print the list of all pending jobs with their weighted priorities
182       > sprio
183         JOBID     PRIORITY          AGE    FAIRSHARE      JOBSIZE   PARTITION
184       QOS
185         65539       62664            0        51664         1000        10000
186       0
187         65540        62663            0        51663         1000       10000
188       0
189         65541       62662            0        51662         1000        10000
190       0
191
192       Print the list of all pending jobs with their normalized priorities
193       > sprio -n
194         JOBID PRIORITY   AGE        FAIRSHARE  JOBSIZE    PARTITION  QOS
195         65539   0.00001459   0.0007180    0.5166470    1.0000000    1.0000000
196       0.0000000
197         65540   0.00001459   0.0007180    0.5166370    1.0000000    1.0000000
198       0.0000000
199         65541   0.00001458   0.0007180    0.5166270    1.0000000    1.0000000
200       0.0000000
201
202       Print the job priorities for specific jobs
203       > sprio --jobs=65548,65547
204         JOBID    PRIORITY          AGE    FAIRSHARE      JOBSIZE    PARTITION
205       QOS
206         65547        62078            0        51078         1000       10000
207       0
208         65548       62077            0        51077         1000        10000
209       0
210
211       Print the job priorities for jobs of specific users
212       > sprio --users=fred,sally
213         JOBID      USER   PRIORITY        AGE  FAIRSHARE   JOBSIZE  PARTITION
214       QOS
215         65548     fred     62079         1       51077       1000       10000
216       0
217         65549     sally      62080          1      51078      1000      10000
218       0
219
220       Print the configured weights for each priority component
221       > sprio -w
222         JOBID    PRIORITY          AGE    FAIRSHARE      JOBSIZE    PARTITION
223       QOS
224         Weights                   1000       100000         1000        10000
225       1
226
227

COPYING

229       Copyright (C) 2009 Lawrence Livermore National Security.   Produced  at
230       Lawrence Livermore National Laboratory (cf, DISCLAIMER).
231       Copyright (C) 2010-2017 SchedMD LLC.
232
233       This  file  is  part  of  Slurm,  a  resource  management program.  For
234       details, see <https://slurm.schedmd.com/>.
235
236       Slurm is free software; you can redistribute it and/or modify it  under
237       the  terms  of  the GNU General Public License as published by the Free
238       Software Foundation; either version 2  of  the  License,  or  (at  your
239       option) any later version.
240
241       Slurm  is  distributed  in the hope that it will be useful, but WITHOUT
242       ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY  or
243       FITNESS  FOR  A PARTICULAR PURPOSE.  See the GNU General Public License
244       for more details.
245

SEE ALSO

247       squeue(1), sshare(1)
248
249
250
251March 2017                      Slurm Commands                        sprio(1)
Impressum