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

NAME

6       condor_status - HTCondor Manual
7
8       Display status of the HTCondor pool
9
10

SYNOPSIS

12       condor_status  [-debug  ] [help options ] [query options ] [display op‐
13       tions ] [custom options ] [name ... ]
14

DESCRIPTION

16       condor_status is a versatile tool that may be used to monitor and query
17       the HTCondor pool. The condor_status tool can be used to query resource
18       information, submitter information, checkpoint server information,  and
19       daemon  master  information.  The specific query sent and the resulting
20       information display  is  controlled  by  the  query  options  supplied.
21       Queries and display formats can also be customized.
22
23       The  options  that  may  be  supplied  to  condor_status belong to five
24       groups:
25
26Help options provide information about the condor_status tool.
27
28Query options control the content and presentation of status informa‐
29         tion.
30
31Display options control the display of the queried information.
32
33Custom options allow the user to customize query and display informa‐
34         tion.
35
36Host options specify specific machines to be queried
37
38       At any time, only one help option, one query option and one display op‐
39       tion  may  be  specified. Any number of custom options and host options
40       may be specified.
41

OPTIONS

43          -debug Causes debugging information to be sent to stderr,  based  on
44                 the value of the configuration variable TOOL_DEBUG.
45
46          -help  (Help option) Display usage information.
47
48          -diagnose
49                 (Help  option) Print out ClassAd query without performing the
50                 query.
51
52          -absent
53                 (Query option) Query for and display only absent resources.
54
55          -ads filename
56                 (Query option) Read the set of ClassAds in the file specified
57                 by filename, instead of querying the condor_collector.
58
59          -annex name
60                 (Query  option)  Query  for and display only resources in the
61                 named annex.
62
63          -any   (Query option) Query all ClassAds  and  display  their  type,
64                 target type, and name.
65
66          -avail (Query  option) Query condor_startd ClassAds and identify re‐
67                 sources which are available.
68
69          -ckptsrvr
70                 (Query option) Query condor_ckpt_server ClassAds and  display
71                 checkpoint server attributes.
72
73          -claimed
74                 (Query  option) Query condor_startd ClassAds and print infor‐
75                 mation about claimed resources.
76
77          -cod   (Query option) Display only machine ClassAds  that  have  COD
78                 claims.   Information  displayed  includes  the claim ID, the
79                 owner of the claim, and the state of the COD claim.
80
81          -collector
82                 (Query option) Query condor_collector  ClassAds  and  display
83                 attributes.
84
85          -defrag
86                 (Query option) Query condor_defrag ClassAds.
87
88          -direct hostname
89                 (Query  option) Go directly to the given host name to get the
90                 ClassAds to display. By default,  returns  the  condor_startd
91                 ClassAd.  If  -schedd is also given, return the condor_schedd
92                 ClassAd on that host.
93
94          -java  (Query option) Display only Java-capable resources.
95
96          -license
97                 (Query option) Display license attributes.
98
99          -master
100                 (Query option) Query condor_master ClassAds and display  dae‐
101                 mon master attributes.
102
103          -negotiator
104                 (Query  option)  Query condor_negotiator ClassAds and display
105                 attributes.
106
107          -pool centralmanagerhostname[:portnumber]
108                 (Query option) Query the specified central manager  using  an
109                 optional port number. condor_status queries the machine spec‐
110                 ified by the configuration  variable  COLLECTOR_HOST  by  de‐
111                 fault.
112
113          -run   (Query  option)  Display information about machines currently
114                 running jobs.
115
116          -schedd
117                 (Query option) Query condor_schedd ClassAds and  display  at‐
118                 tributes.
119
120          -server
121                 (Query  option)  Query condor_startd ClassAds and display re‐
122                 source attributes.
123
124          -startd
125                 (Query option) Query condor_startd ClassAds.
126
127          -state (Query option) Query condor_startd ClassAds and  display  re‐
128                 source state information.
129
130          -statistics WhichStatistics
131                 (Query  option)  Can  only  be used if the -direct option has
132                 been specified. Identifies which Statistics attributes to in‐
133                 clude  in the ClassAd. WhichStatistics is specified using the
134                 same syntax as defined for STATISTICS_TO_PUBLISH.  A  defini‐
135                 tion  is  in  the  HTCondor Administrator's manual section on
136                 configuration       (admin-manual/configuration-macros:htcon‐
137                 dor-wide configuration file entries).
138
139          -storage
140                 (Query  option)  Display  attributes of machines with network
141                 storage resources.
142
143          -submitters
144                 (Query option) Query ClassAds sent by submitters and  display
145                 important submitter attributes.
146
147          -subsystem type
148                 (Query  option) If type is one of collector, negotiator, mas‐
149                 ter, schedd, or startd, then behavior  is  the  same  as  the
150                 query  option  without  the  -subsystem  option. For example,
151                 -subsystem collector is the same as -collector.  A  value  of
152                 type  of CkptServer, Machine, DaemonMaster, or Scheduler tar‐
153                 gets that type of ClassAd.
154
155          -vm    (Query option) Query condor_startd ClassAds, and display only
156                 VM-enabled  machines.  Information displayed includes the ma‐
157                 chine name, the virtual machine software version,  the  state
158                 of  machine, the virtual machine memory, and the type of net‐
159                 working.
160
161          -offline
162                 (Query option) Query condor_startd ClassAds, and display, for
163                 each  machine  with at least one offline universe, which uni‐
164                 verses are offline for it.
165
166          -attributes Attr1[,Attr2 ...]
167                 (Display option) Explicitly list the attributes  in  a  comma
168                 separated list which should be displayed when using the -xml,
169                 -json or -long options. Limiting the number of attributes in‐
170                 creases the efficiency of the query.
171
172          -expert
173                 (Display option) Display shortened error messages.
174
175          -long  (Display option) Display entire ClassAds. Implies that totals
176                 will not be displayed.
177
178          -limit num
179                 (Query option) At most num results should be displayed.
180
181          -sort expr
182                 (Display option) Change the display order to be based on  as‐
183                 cending  values  of  an  evaluated  expression given by expr.
184                 Evaluated expressions of a string type are in a case insensi‐
185                 tive  alphabetical  order. If multiple -sort arguments appear
186                 on the command line, the primary sort will be on the leftmost
187                 one  within  the  command  line, and it is numbered 0. A sec‐
188                 ondary sort will be based on the second expression, and it is
189                 numbered  1.  For  informational  or  debugging purposes, the
190                 ClassAd output to be displayed will appear as if the  ClassAd
191                 had two additional attributes.  CondorStatusSortKeyExpr<N> is
192                 the expression, where <N> is replaced by the  number  of  the
193                 sort.  CondorStatusSortKey<N>  gives the result of evaluating
194                 the sort expression that is numbered <N>.
195
196          -total (Display option) Display totals only.
197
198          -xml   (Display option) Display entire ClassAds, in XML format.  The
199                 XML format is fully defined in the reference manual, obtained
200                 from   the   ClassAds   web   page,   with    a    link    at
201                 http://htcondor.org/classad/classad.html.
202
203          -json  (Display option) Display entire ClassAds in JSON format.
204
205          -constraint const
206                 (Custom option) Add constraint expression.
207
208          -compact
209                 (Custom  option)  Show  compact form, rolling up slots into a
210                 single line.
211
212          -format fmt attr
213                 (Custom option) Display attribute or expression attr in  for‐
214                 mat  fmt.  To  display the attribute or expression the format
215                 must contain a single printf(3)-style  conversion  specifier.
216                 Attributes must be from the resource ClassAd. Expressions are
217                 ClassAd expressions and may refer to attributes  in  the  re‐
218                 source  ClassAd.  If  the attribute is not present in a given
219                 ClassAd and cannot be parsed as an expression, then the  for‐
220                 mat  option  will be silently skipped. %r prints the unevalu‐
221                 ated, or raw values. The conversion specifier must match  the
222                 type  of  the  attribute  or  expression.  %s is suitable for
223                 strings such as Name, %d for integers such as  LastHeardFrom,
224                 and %f for floating point numbers such as LoadAvg. %v identi‐
225                 fies the type of the attribute, and then prints the value  in
226                 an  appropriate  format. %V identifies the type of the attri‐
227                 bute, and then prints the value in an appropriate  format  as
228                 it  would  appear in the -long format. As an example, strings
229                 used with %V will have quote marks. An incorrect format  will
230                 result  in  undefined behavior. Do not use more than one con‐
231                 version specifier in a given format. More than one conversion
232                 specifier will result in undefined behavior. To output multi‐
233                 ple attributes repeat the -format option once  for  each  de‐
234                 sired  attribute.  Like  printf(3)-style formats, one may in‐
235                 clude other text that will be reproduced directly.  A  format
236                 without  any  conversion  specifiers may be specified, but an
237                 attribute is still required. Include a backslash followed  by
238                 an 'n' to specify a line break.
239
240          -autoformat[:lhVr,tng]  attr1  [attr2  ...]  or -af[:lhVr,tng] attr1
241          [attr2 ...]
242                 (Output option) Display attribute(s) or expression(s) format‐
243                 ted  in  a default way according to attribute types. This op‐
244                 tion takes an arbitrary number of attribute  names  as  argu‐
245                 ments, and prints out their values, with a space between each
246                 value and a newline character after the  last  value.  It  is
247                 like  the  -format option without format strings. This output
248                 option does not work in conjunction with the -run option.
249
250                 It is assumed that no attribute names begin with a dash char‐
251                 acter,  so  that  the  next word that begins with dash is the
252                 start of the next option. The autoformat option may  be  fol‐
253                 lowed by a colon character and formatting qualifiers to devi‐
254                 ate the output formatting from the default:
255
256                 l label each field,
257
258                 h print column headings before the first line of output,
259
260                 V use %V rather than %v for  formatting  (string  values  are
261                 quoted),
262
263                 r print "raw", or unevaluated values,
264
265                 , add a comma character after each field,
266
267                 t  add  a  tab character before each field instead of the de‐
268                 fault space character,
269
270                 n add a newline character after each field,
271
272                 g add a newline character between ClassAds, and suppress spa‐
273                 ces before each field.
274
275                 Use -af:h to get tabular values with headings.
276
277                 Use -af:lrng to get -long equivalent format.
278
279                 The  newline  and  comma characters may not be used together.
280                 The l and h characters may not be used together.
281
282          -target filename
283                 (Custom option) Where evaluation requires a target ClassAd to
284                 evaluate against, file filename contains the target ClassAd.
285
286          -merge filename
287                 (Custom  option) Ads will be read from filename, which may be
288                 - to indicate standard in, and compared to the  ads  selected
289                 by  the query specified by the remainder of the command line.
290                 Ads will be considered the same if  their  sort  keys  match;
291                 sort  keys  may  be specified with [-sort <key>]. This option
292                 will cause up to three tables to print, in the following  or‐
293                 der,  depending  on where a given ad appeared: first, the ads
294                 which appeared in the query but not in filename; second,  the
295                 ads  which appeared in both the query and in filename; third,
296                 the ads which appeared in filename but not in the query.
297
298                 By default, banners will label each table. If  -xml  is  also
299                 given,  the  same banners will separate three valid XML docu‐
300                 ments, one for each table. If -json is also given,  a  single
301                 JSON  object will be produced, with the usual JSON output for
302                 each table labeled as an element in the object.
303
304                 The -annex option changes this default so  that  the  banners
305                 are  not printed and the tables are formatted differently. In
306                 this case, the ads in filename are expected to have different
307                 contents  from  the ads in the query, so many others will be‐
308                 have strangely.
309

GENERAL REMARKS

311       • The default output from condor_status is formatted to be human  read‐
312         able, not script readable. In an effort to make the output fit within
313         80 characters, values in some fields might  be  truncated.   Further‐
314         more,  the  HTCondor  Project can (and does) change the formatting of
315         this default output as we see fit. Therefore, any script that is  at‐
316         tempting  to  parse data from condor_status is strongly encouraged to
317         use the -format option (described above).
318
319       • The information obtained from condor_startd and condor_schedd daemons
320         may  sometimes  appear  to be inconsistent. This is normal since con‐
321         dor_startd and condor_schedd daemons update the HTCondor  manager  at
322         different rates, and since there is a delay as information propagates
323         through the network and the system.
324
325       • Note that the ActivityTime in the Idle state is  not  the  amount  of
326         time that the machine has been idle. See the section on condor_startd
327         states in the  Administrator's  Manual  for  more  information  (/ad‐
328         min-manual/installation-startup-shutdown-reconfiguration).
329
330       • When  using condor_status on a pool with SMP machines, you can either
331         provide the host name, in which case you will  get  back  information
332         about  all  slots  that are represented on that host, or you can list
333         specific slots by name. See the examples below for details.
334
335       • If you specify host names, without domains, HTCondor  will  automati‐
336         cally try to resolve those host names into fully qualified host names
337         for you. This also works when specifying specific nodes of an SMP ma‐
338         chine.  In  this  case, everything after the "@" sign is treated as a
339         host name and that is what is resolved.
340
341       • You can use the -direct option in conjunction with almost  any  other
342         set  of options. However, at this time, the only daemon that will al‐
343         low direct queries for its ad(s) is the condor_startd. So,  the  only
344         options currently not supported with -direct are -schedd and -master.
345         Most other options use startd ads for their information, so they work
346         seamlessly  with  -direct.  The  only other restriction on -direct is
347         that you may only use 1 -direct option at a  time.  If  you  want  to
348         query  information  directly  from  multiple hosts, you must run con‐
349         dor_status multiple times.
350
351       • Unless you use the local host name with -direct,  condor_status  will
352         still have to contact a collector to find the address where the spec‐
353         ified daemon is listening. So, using a -pool  option  in  conjunction
354         with  -direct  just  tells  condor_status which collector to query to
355         find the address of the daemon you  want.  The  information  actually
356         displayed will still be retrieved directly from the daemon you speci‐
357         fied as the argument to -direct.
358

EXAMPLES

360       Example 1 To view information from all nodes of  an  SMP  machine,  use
361       only the host name. For example, if you had a 4-CPU machine, named vul‐
362       ture.cs.wisc.edu, you might see
363
364          % condor_status vulture
365
366          Name               OpSys      Arch   State     Activity LoadAv Mem   ActvtyTime
367
368          slot1@vulture.cs.w LINUX      INTEL  Claimed   Busy     1.050   512  0+01:47:42
369          slot2@vulture.cs.w LINUX      INTEL  Claimed   Busy     1.000   512  0+01:48:19
370          slot3@vulture.cs.w LINUX      INTEL  Unclaimed Idle     0.070   512  1+11:05:32
371          slot4@vulture.cs.w LINUX      INTEL  Unclaimed Idle     0.000   512  1+11:05:34
372
373                               Total Owner Claimed Unclaimed Matched Preempting Backfill
374
375                   INTEL/LINUX     4     0       2         2       0          0        0
376
377                         Total     4     0       2         2       0          0        0
378
379       Example 2 To view information from a specific nodes of an SMP  machine,
380       specify  the  node  directly.  You do this by providing the name of the
381       slot. This has the form slot#@hostname. For example:
382
383          % condor_status slot3@vulture
384
385          Name               OpSys      Arch   State     Activity LoadAv Mem   ActvtyTime
386
387          slot3@vulture.cs.w LINUX      INTEL  Unclaimed Idle     0.070   512  1+11:10:32
388
389                               Total Owner Claimed Unclaimed Matched Preempting Backfill
390
391                   INTEL/LINUX     1     0       0         1       0          0        0
392
393                         Total     1     0       0         1       0          0        0
394
395       Constraint option examples
396
397       The Unix command to use the constraint option to see all machines  with
398       the OpSys of "LINUX":
399
400          % condor_status -constraint OpSys==\"LINUX\"
401
402       Note that quotation marks must be escaped with the backslash characters
403       for most shells.
404
405       The Windows command to do the same thing:
406
407          >condor_status -constraint " OpSys==""LINUX"" "
408
409       Note that quotation marks are used to delimit the single argument which
410       is  the  expression,  and  the quotation marks that identify the string
411       must be escaped by using a set of two double quote  marks  without  any
412       intervening spaces.
413
414       To see all machines that are currently in the Idle state, the Unix com‐
415       mand is
416
417          % condor_status -constraint State==\"Idle\"
418
419       To see all machines that are bench marked to have a MIPS rating of more
420       than 750, the Unix command is
421
422          % condor_status -constraint 'Mips>750'
423
424       -cod option example
425
426       The -cod option displays the status of COD claims within a given HTCon‐
427       dor pool.
428
429          Name        ID   ClaimState TimeInState RemoteUser JobId Keyword
430          astro.cs.wi COD1 Idle        0+00:00:04 wright
431          chopin.cs.w COD1 Running     0+00:02:05 wright     3.0   fractgen
432          chopin.cs.w COD2 Suspended   0+00:10:21 wright     4.0   fractgen
433
434                         Total  Idle  Running  Suspended  Vacating  Killing
435           INTEL/LINUX       3     1        1          1         0        0
436                 Total       3     1        1          1         0        0
437
438       -format option example To display the name  and  memory  attributes  of
439       each job ClassAd in a format that is easily parsable by other tools:
440
441          % condor_status -format "%s " Name -format "%d\n" Memory
442
443       To do the same with the autoformat option, run
444
445          % condor_status -autoformat Name Memory
446

EXIT STATUS

448       condor_status  will  exit with a status value of 0 (zero) upon success,
449       and it will exit with the value 1 (one) upon failure.
450

AUTHOR

452       HTCondor Team
453
455       1990-2021, Center for High Throughput Computing, Computer Sciences  De‐
456       partment,  University  of  Wisconsin-Madison, Madison, WI, US. Licensed
457       under the Apache License, Version 2.0.
458
459
460
461
4628.8                              Aug 23, 2021                 CONDOR_STATUS(1)
Impressum