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  ]  [-inputfile
16       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       For security purposes of authentication and  authorization,  specifying
70       an Edit Option requires the ADMINISTRATOR level of access.
71

OPTIONS

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

EXAMPLES

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

EXIT STATUS

302       condor_userprio will exit with a status value of 0 (zero) upon success,
303       and it will exit with the value 1 (one) upon failure.
304

AUTHOR

306       HTCondor Team
307
309       1990-2022,  Center for High Throughput Computing, Computer Sciences De‐
310       partment, University of Wisconsin-Madison, Madison,  WI,  US.  Licensed
311       under the Apache License, Version 2.0.
312
313
314
315
3168.8                              Jan 19, 2022               CONDOR_USERPRIO(1)
Impressum