1CONDOR_USERPRIO(1)              HTCondor Manual             CONDOR_USERPRIO(1)
2
3
4

NAME

6       condor_userprio - HTCondor Manual
7
8       Manage user priorities
9
10

SYNOPSIS

12       condor_userprio -help
13
14       condor_userprio   [-name   negotiatorname]  [-pool  centralmanagerhost‐
15       name[:portnumber]] [Edit option ] | [Display options [username] ] [-in‐
16       putfile filename]
17

DESCRIPTION

19       condor_userprio  either  modifies  priority-related information or dis‐
20       plays priority-related information. Displayed  information  comes  from
21       the  accountant log, where the condor_negotiator daemon stores histori‐
22       cal usage information in the file at $(SPOOL)/Accountantnew.log.  Which
23       fields  are  displayed  changes  based  on command line arguments. con‐
24       dor_userprio with no arguments, lists the active users along with their
25       priorities,  in  increasing priority order. The -all option can be used
26       to display more detailed information about each user,  resulting  in  a
27       rather wide display, and includes the following columns:
28
29          Effective Priority
30                 The  effective  priority  value of the user, which is used to
31                 calculate the user's share when allocating resources. A lower
32                 value means a higher priority, and the minimum value (highest
33                 priority) is 0.5.  The effective priority  is  calculated  by
34                 multiplying the real priority by the priority factor.
35
36          Real Priority
37                 The  value  of the real priority of the user. This value fol‐
38                 lows the user's resource usage.
39
40          Priority Factor
41                 The system administrator can set this value  for  each  user,
42                 thus  controlling  a  user's  effective  priority relative to
43                 other users.  This can be used to create different classes of
44                 users.
45
46          Res Used
47                 The number of resources currently used.
48
49          Accumulated Usage
50                 The  accumulated  number  of  resource-hours used by the user
51                 since the usage start time.
52
53          Usage Start Time
54                 The time since when usage has been  recorded  for  the  user.
55                 This  time is set when a user job runs for the first time. It
56                 is reset to the present time when the usage for the  user  is
57                 reset.
58
59          Last Usage Time
60                 The  most  recent time a resource usage has been recorded for
61                 the user.
62
63       By default only users for whom usage was recorded in the last 24 hours,
64       or whose priority is greater than the minimum are listed.
65
66       The  -pool  option  can  be used to contact a different central manager
67       than the local one (the default).
68
69       Options that do not begin with a - are treated as a  username  and  re‐
70       sults will restricted to users that match the given name. More than one
71       username can be specified.
72
73       For security purposes of authentication and  authorization,  specifying
74       an Edit Option requires the ADMINISTRATOR level of access.
75

OPTIONS

77          -help  Display usage information and exit.
78
79          -name negotiatorname
80                 When  querying  ads  from the condor_collector, only retrieve
81                 ads that came from the negotiator with the given name.
82
83          -pool centralmanagerhostname[:portnumber]
84                 Contact the specified centralmanagerhostname with an optional
85                 port  number,  instead of the local central manager. This can
86                 be used to check other pools. NOTE: The host  name  (and  op‐
87                 tional  port)  specified refer to the host name (and port) of
88                 the condor_negotiator to query for user priorities.  This  is
89                 slightly  different  than  most HTCondor tools that support a
90                 -pool option, and instead expect the host name (and port)  of
91                 the condor_collector.
92
93          -inputfile filename
94                 Introduced  for debugging purposes, read priority information
95                 from filename. The contents of filename are  expected  to  be
96                 the  same  as  captured output from running a condor_userprio
97                 -long command.
98
99          -delete username
100                 (Edit option) Remove the specified username  from  HTCondor's
101                 accounting.
102
103          -resetall
104                 (Edit option) Reset the accumulated usage of all the users to
105                 zero.
106
107          -resetusage username
108                 (Edit option) Reset the accumulated usage of the user  speci‐
109                 fied by username to zero.
110
111          -setaccum username value
112                 (Edit option) Set the accumulated usage of the user specified
113                 by username to the specified floating point value.
114
115          -setbegin username value
116                 (Edit option) Set the begin usage time of the user  specified
117                 by username to the specified value.
118
119          -setfactor username value
120                 (Edit  option)  Set the priority factor of the user specified
121                 by username to the specified value.
122
123          -setlast username value
124                 (Edit option) Set the last usage time of the  user  specified
125                 by username to the specified value.
126
127          -setprio username value
128                 (Edit  option) Set the real priority of the user specified by
129                 username to the specified value.
130
131          -setfloor username value
132                 (Edit option) Set the floor for the user specified  by  user‐
133                 name  to  the  specified value.  This value is the sum of the
134                 SlotWeight  (See:  SLOT_WEIGHT   in   admin-manual/configura‐
135                 tion-macros:condor_startd  configuration  file macros) of all
136                 running jobs.  By default, the slot weight of a  running  job
137                 is the number of cores allocated to that job.
138
139          -setceil username value
140                 (Edit option) Set the ceiling for the user specified by user‐
141                 name to the specified value.  This value is the  sum  of  the
142                 SlotWeight   (See:   SLOT_WEIGHT  in  admin-manual/configura‐
143                 tion-macros:condor_startd configuration file macros)  of  all
144                 running  jobs.   By default, the slot weight of a running job
145                 is the number of cores allocated to that job.
146
147          -activefrom month day year
148                 (Display option) Display information for users who have  some
149                 recorded accumulated usage since the specified date.
150
151          -all   (Display  option)  Display  all  available  fields about each
152                 group or user.
153
154          -allusers
155                 (Display option) Display information for all  the  users  who
156                 have some recorded accumulated usage.
157
158          -negotiator
159                 (Display  option) Force the query to come from the negotiator
160                 instead of the collector.
161
162          -autoformat[:jlhVr,tng] attr1 [attr2 ...] or  -af[:jlhVr,tng]  attr1
163          [attr2 ...]
164                 (Display  option)  Display attribute(s) or expression(s) for‐
165                 matted in a default way according to  attribute  types.  This
166                 option  takes an arbitrary number of attribute names as argu‐
167                 ments, and prints out their values, with a space between each
168                 value  and  a  newline  character after the last value. It is
169                 like the -format option without format strings.
170
171                 It is assumed that no attribute names begin with a dash char‐
172                 acter,  so  that  the  next word that begins with dash is the
173                 start of the next option. The autoformat option may  be  fol‐
174                 lowed by a colon character and formatting qualifiers to devi‐
175                 ate the output formatting from the default:
176
177                 j print the job ID as the first field,
178
179                 l label each field,
180
181                 h print column headings before the first line of output,
182
183                 V use %V rather than %v for  formatting  (string  values  are
184                 quoted),
185
186                 r print "raw", or unevaluated values,
187
188                 , add a comma character after each field,
189
190                 t  add  a  tab character before each field instead of the de‐
191                 fault space character,
192
193                 n add a newline character after each field,
194
195                 g add a newline character between ClassAds, and suppress spa‐
196                 ces before each field.
197
198                 Use -af:h to get tabular values with headings.
199
200                 Use -af:lrng to get -long equivalent format.
201
202                 The  newline  and  comma characters may not be used together.
203                 The l and h characters may not be used together.
204
205          -constraint <expr>
206                 (Display option) To be used in  conjunction  with  the  -long
207                 -modular  or  the  -autoformat  options.  Displays  users and
208                 groups that match the <expr>.
209
210          -debug[:<opts>]
211                 (Display option) Without :<opts>  specified,  use  configured
212                 debug  level to send debugging output to stderr. With :<opts>
213                 specified, these options are debug levels that  override  any
214                 configured  debug levels for this command's execution to send
215                 debugging output to stderr.
216
217          -flat  (Display option) Display information such that  users  within
218                 hierarchical groups are not listed with their group.
219
220          -getreslist username
221                 (Display  option)  Display  all the resources currently allo‐
222                 cated to the user specified by username.
223
224          -grouporder
225                 (Display option) Display submitter information with  account‐
226                 ing   group   entries   at  the  top  of  the  list,  and  in
227                 breadth-first order within the group hierarchy tree.
228
229          -grouprollup
230                 (Display option) For hierarchical groups, the  display  shows
231                 sums  as  computed  for  groups,  and  these sums include sub
232                 groups.
233
234          -hierarchical
235                 (Display option) Display information such that  users  within
236                 hierarchical groups are listed with their group.
237
238          -legacy
239                 (Display  option) For use with the -long option, displays at‐
240                 tribute names and values as a single ClassAd.
241
242          -long  (Display option) A verbose output which displays entire Clas‐
243                 sAds.
244
245          -modular
246                 (Display  option)  Modifies  the display when using the -long
247                 option, such that attribute names and  values  are  shown  as
248                 distinct ClassAds.
249
250          -most  (Display  option)  Display  fields  considered to be the most
251                 useful.  This is the default set of fields displayed.
252
253          -priority
254                 (Display option) Display fields with user  priority  informa‐
255                 tion.
256
257          -quotas
258                 (Display  option)  Display  fields  relevant  to hierarchical
259                 group quotas.
260
261          -usage (Display option) Display usage information for each group  or
262                 user.
263

EXAMPLES

265       Example  1  Since the output varies due to command line arguments, here
266       is an example of the default output for a pool that does not use  Hier‐
267       archical  Group  Quotas.  This default output is the same as given with
268       the -most Display option.
269
270          Last Priority Update:  1/19 13:14
271                                  Effective   Priority   Res   Total Usage  Time Since
272          User Name                Priority    Factor   In Use (wghted-hrs) Last Usage
273          ---------------------- ------------ --------- ------ ------------ ----------
274          www-cndr@cs.wisc.edu           0.56      1.00      0    591998.44    0+16:30
275          joey@cs.wisc.edu               1.00      1.00      1       990.15 <now>
276          suzy@cs.wisc.edu               1.53      1.00      0       261.78    0+09:31
277          leon@cs.wisc.edu               1.63      1.00      2     12597.82 <now>
278          raj@cs.wisc.edu                3.34      1.00      0      8049.48    0+01:39
279          jose@cs.wisc.edu               3.62      1.00      4     58137.63 <now>
280          betsy@cs.wisc.edu             13.47      1.00      0      1475.31    0+22:46
281          petra@cs.wisc.edu            266.02    500.00      1    288082.03 <now>
282          carmen@cs.wisc.edu           329.87     10.00    634   2685305.25 <now>
283          carlos@cs.wisc.edu           687.36     10.00      0     76555.13    0+14:31
284          ali@proj1.wisc.edu          5000.00  10000.00      0      1315.56    0+03:33
285          apu@nnland.edu              5000.00  10000.00      0       482.63    0+09:56
286          pop@proj1.wisc.edu         26688.11  10000.00      1     49560.88 <now>
287          franz@cs.wisc.edu          29352.06    500.00    109    600277.88 <now>
288          martha@nnland.edu          58030.94  10000.00      0     48212.79    0+12:32
289          izzi@nnland.edu            62106.40  10000.00      0      6569.75    0+02:26
290          marta@cs.wisc.edu          62577.84    500.00     29    193706.30 <now>
291          kris@proj1.wisc.edu       100597.94  10000.00      0     20814.24    0+04:26
292          boss@proj1.wisc.edu       318229.25  10000.00      3    324680.47 <now>
293          ---------------------- ------------ --------- ------ ------------ ----------
294          Number of users: 19                              784   4969073.00    0+23:59
295
296       Example 2 This is an example of the default output for a pool that uses
297       hierarchical  groups,  and  the  groups accept surplus. This leads to a
298       very wide display.
299
300          $ condor_userprio -pool crane.cs.wisc.edu -allusers
301          Last Priority Update:  1/19 13:18
302          Group                                 Config     Use    Effective   Priority   Res   Total Usage  Time Since
303            User Name                            Quota   Surplus   Priority    Factor   In Use (wghted-hrs) Last Usage
304          ------------------------------------ --------- ------- ------------ --------- ------ ------------ ----------
305          <none>                                    0.00     yes                   1.00      0         6.78    9+03:52
306            johnsm@crane.cs.wisc.edu                                     0.50      1.00      0         6.62    9+19:42
307            John.Smith@crane.cs.wisc.edu                                 0.50      1.00      0         0.02    9+03:52
308            Sedge@crane.cs.wisc.edu                                      0.50      1.00      0         0.05   13+03:03
309            Duck@crane.cs.wisc.edu                                       0.50      1.00      0         0.02   31+00:28
310            other@crane.cs.wisc.edu                                      0.50      1.00      0         0.04   16+03:42
311          Duck                                      2.00      no                   1.00      0         0.02   13+02:57
312            goose@crane.cs.wisc.edu                                      0.50      1.00      0         0.02   13+02:57
313          Sedge                                     4.00      no                   1.00      0         0.17    9+03:07
314            johnsm@crane.cs.wisc.edu                                     0.50      1.00      0         0.13    9+03:08
315            Half@crane.cs.wisc.edu                                       0.50      1.00      0         0.02   31+00:02
316            John.Smith@crane.cs.wisc.edu                                 0.50      1.00      0         0.05    9+03:07
317            other@crane.cs.wisc.edu                                      0.50      1.00      0         0.01   28+19:34
318          ------------------------------------ --------- ------- ------------ --------- ------ ------------ ----------
319          Number of users: 10                            ByQuota                             0         6.97
320

EXIT STATUS

322       condor_userprio will exit with a status value of 0 (zero) upon success,
323       and it will exit with the value 1 (one) upon failure.
324

AUTHOR

326       HTCondor Team
327
329       1990-2023,  Center for High Throughput Computing, Computer Sciences De‐
330       partment, University of Wisconsin-Madison, Madison,  WI,  US.  Licensed
331       under the Apache License, Version 2.0.
332
333
334
335
336                                 Oct 02, 2023               CONDOR_USERPRIO(1)
Impressum