1qstat(1B) PBS qstat(1B)
2
6 qstat - show status of pbs batch jobs
7
9 qstat [-f [-1]][-W site_specific] [job_identifier... | destination...]
10 qstat [-a|-i|-r|-e] [-n [-1]] [-s] [-G|-M] [-R] [-u user_list]
12 [job_identifier... | destination...]
13 qstat -Q [-f [-1]][-W site_specific] [destination...]
15 qstat -q [-G|-M] [destination...]
17 qstat -B [-f [-1]][-W site_specific] [server_name...]
19
21 The qstat command is used to request the status of jobs, queues, or a
22 batch server. The requested status is written to standard out.
23 When requesting job status, synopsis format 1 or 2, qstat will output
25 information about each job_identifier or all jobs at each destination.
26 Jobs for which the user does not have status privilege are not dis‐
27 played.
28 When requesting queue or server status, synopsis format 3 through 5,
30 qstat will output information about each destination.
31
33 -f Specifies that a full status display be written to standard
34 out.
35 -a "All" jobs are displayed in the alternative format, see the
37 Standard Output section. If the operand is a destination id,
38 all jobs at that destination are displayed. If the operand
39 is a job id, information about that job is displayed.
40 -e If the operand is a job id or not specified, only jobs in
42 executable queues are displayed. Setting the PBS_QSTAT_EXE‐
43 CONLY environment variable will also enable this option.
44 -i Job status is displayed in the alternative format. For a
46 destination id operand, status for jobs at that destination
47 which are not running are displayed. This includes jobs
48 which are queued, held or waiting. If an operand is a job
49 id, status for that job is displayed regardless of its state.
50 -r If an operand is a job id, status for that job is displayed.
52 For a destination id operand, status for jobs at that desti‐
53 nation which are running are displayed, this includes jobs
54 which are suspended.
55 -n In addition to the basic information, nodes allocated to a
57 job are listed.
58 -1 In combination with -n, the -1 option puts all of the nodes
60 on the same line as the job ID. In combination with -f,
61 attributes are not folded to fit in a terminal window. This
62 is intended to ease the parsing of the qstat output.
63 -s In addition to the basic information, any comment provided by
65 the batch administrator or scheduler is shown.
66 -G Show size information in giga-bytes.
68 -M Show size information, disk or memory in mega-words. A word
70 is considered to be 8 bytes.
71 -R In addition to other information, disk reservation informa‐
73 tion is shown. Not applicable to all systems.
74 -u Job status is displayed in the alternative format. If an op‐
76 erand is a job id, status for that job is displayed. For a
77 destination id operand, status for jobs at that destination
78 which are owned by the user(s) listed in user_list are dis‐
79 played. The syntax of the user_list is:
80 user_name[@host][,user_name[@host],...]
81 Host names may be wild carded on the left end, e.g.
82 "*.nasa.gov". User_name without a "@host" is equivalent to
83 "user_name@*", that is at any host.
84 -Q Specifies that the request is for queue status and that the
86 operands are destination identifiers.
87 -q Specifies that the request is for queue status which should
89 be shown in the alternative format.
90 -B Specifies that the request is for batch server status and
92 that the operands are the names of servers.
93
95 If neither the -Q nor the -B option is given, the operands on the qstat
96 command must be either job identifiers or destinations identifiers.
97 If the operand is a job identifier, it must be in the following form:
99 sequence_number[.server_name][@server]
100 where sequence_number.server_name is the job identifier assigned at
101 submittal time, see qsub. If the .server_name is omitted, the name of
102 the default server will be used. If @server is supplied, the request
103 will be for the job identifier currently at that Server.
104 If the operand is a destination identifier, it is one of the following
106 three forms:
107 queue
108 @server
109 queue@server
110 If queue is specified, the request is for status of all jobs in that
111 queue at the default server. If the @server form is given, the request
112 is for status of all jobs at that server. If a full destination iden‐
113 tifier, queue@server, is given, the request is for status of all jobs
114 in the named queue at the named server.
115 If the -Q option is given, the operands are destination identifiers as
117 specified above. If queue is specified, the status of that queue at
118 the default server will be given. If queue@server is specified, the
119 status of the named queue at the named server will be given. If
120 @server is specified, the status of all queues at the named server will
121 be given. If no destination is specified, the status of all queues at
122 the default server will be given.
123 If the -B option is given, the operand is the name of a server.
125
127 Displaying Job Status
128 If job status is being displayed in the default format and the -f
130 option is not specified, the following items are displayed on a single
131 line, in the specified order, separated by white space:
132 - the job identifier assigned by PBS.
134 - the job name given by the submitter.
136 - the job owner
138 - the CPU time used
140 - the job state:
142 C - Job is completed after having run/
143 E - Job is exiting after having run.
144 H - Job is held.
145 Q - job is queued, eligible to run or routed.
146 R - job is running.
147 T - job is being moved to new location.
148 W - job is waiting for its execution time
149 (-a option) to be reached.
150 S - (Unicos only) job is suspend.
151 - the queue in which the job resides
153 If job status is being displayed and the -f option is specified, the
155 output will depend on whether qstat was compiled to use a Tcl inter‐
156 preter. See the configuration section for details. If Tcl is not
157 being used, full display for each job consists of the header line:
158 Job Id: job identifier
159 Followed by one line per job attribute of the form:
160 attribute_name = value
161 If any of the options -a, -i, -r, -u, -n, -s, -G or -M are provided,
163 the alternative display format for jobs is used. The following items
164 are displayed on a single line, in the specified order, separated by
165 white space:
166 - the job identifier assigned by PBS.
168 - the job owner.
170 - The queue in which the job currently resides.
172 - The job name given by the submitter.
174 - The session id (if the job is running).
176 - The number of nodes requested by the job.
178 - The number of cpus or tasks requested by the job.
180 - The amount of memory requested by the job.
182 - Either the cpu time, if specified, or wall time requested by
184 the job, (hh:mm).
185 - The job's current state.
187 - The amount of cpu time or wall time used by the job (hh:mm).
189 If the -R option is provided, the line contains:
190 - the job identifier assigned by PBS.
192 - the job owner.
194 - The queue in which the job currently resides.
196 - The number of nodes requested by the job.
198 - The number of cpus or tasks requested by the job.
200 - The amount of memory requested by the job.
202 - Either the cpu time or wall time requested by the job.
204 - The job's current state.
206 - The amount of cpu time or wall time used by the job.
208 - The amount of SRFS space requested on the big file system.
210 - The amount of SRFS space requested on the fast file system.
212 - The amount of space requested on the parallel I/O file sys‐
214 tem.
215 The last three fields may not contain useful information at all sites
216 or on all systems.
217 Displaying Queue Status
220 If queue status is being displayed and the -f option was not specified,
222 the following items are displayed on a single line, in the specified
223 order, separated by white space:
224 - the queue name
226 - the maximum number of jobs that may be run in the queue
228 concurrently
229 - the total number of jobs in the queue
231 - the enable or disabled status of the queue
233 - the started or stopped status of the queue
235 - for each job state, the name of the state and the number of
237 jobs in the queue in that state.
238 - the type of queue, execution or routing.
240 If queue status is being displayed and the -f option is specified, the
242 output will depend on whether qstat was compiled to use a Tcl inter‐
243 preter. See the configuration section for details. If Tcl is not
244 being used, the full display for each queue consists of the header
245 line:
246 Queue: queue_name
247 Followed by one line per queue attribute of the form:
248 attribute_name = value
249 If the -q option is specified, queue information is displayed in the
251 alternative format: The following information is displayed on a single
252 line:
253 - the queue name
255 - the maximum amount of memory a job in the queue may request
257 - the maximum amount of cpu time a job in the queue may request
259 - the maximum amount of wall time a job in the queue may
261 request
262 - the maximum amount of nodes a job in the queue may request
264 - the number of jobs in the queue in the running state
266 - the number of jobs in the queue in the queued state
268 - the maximum number (limit) of jobs that may be run in the
270 queue concurrently
271 - the state of the queue given by a pair of letters:
273 - either the letter E if the queue is Enabled or D if Dis‐
274 abled, and
275 - either the letter R if the queue is Running (started) or S
276 if Stopped.
277 Displaying Server Status
280 If batch server status is being displayed and the -f option is not
282 specified, the following items are displayed on a single line, in the
283 specified order, separated by white space:
284 - the server name
286 - the maximum number of jobs that the server may run concur‐
288 rently
289 - the total number of jobs currently managed by the server
291 - the status of the server
293 - for each job state, the name of the state and the number of
295 jobs in the server in that state
296 If server status is being displayed and the -f option is specified, the
298 output will depend on whether qstat was compiled to use a Tcl inter‐
299 preter. See the configuration section for details. If Tcl is not
300 being used, the full display for the server consist of the header line:
301 Server: server name
302 Followed by one line per server attribute of the form:
303 attribute_name = value
304
306 The qstat command will write a diagnostic message to standard error for
307 each error occurrence.
308
310 If qstat is compiled with an option to include a Tcl interpreter, using
311 the -f flag to get a full display causes a check to be made for a
312 script file to use to output the requested information. The first
313 location checked is $HOME/.qstatrc. If this does not exist, the next
314 location checked is administrator configured. If one of these is
315 found, a Tcl interpreter is started and the script file is passed to it
316 along with three global variables. The command line arguments are
317 split into two variable named flags and operands . The status informa‐
318 tion is passed in a variable named objects . All of these variables
319 are Tcl lists. The flags list contains the name of the command (usu‐
320 ally "qstat") as its first element. Any other elements are command
321 line option flags with any options they use, presented in the order
322 given on the command line. They are broken up individually so that if
323 two flags are given together on the command line, they are separated in
324 the list. For example, if the user typed
325 qstat -QfWbigdisplay
327 the flags list would contain
329 qstat -Q -f -W bigdisplay
331 The operands list contains all other command line arguments following
333 the flags. There will always be at least one element in operands
334 because if no operands are typed by the user, the default destination
335 or server name is used. The objects list contains all the information
336 retrieved from the server(s) so the Tcl interpreter can run once to
337 format the entire output. This list has the same number of elements as
338 the operands list. Each element is another list with two elements.
339 The first element is a string giving the type of objects to be found in
340 the second. The string can take the values "server", "queue", "job" or
341 "error". The second element will be a list in which each element is a
342 single batch status object of the type given by the string discussed
343 above. In the case of "error", the list will be empty. Each object is
344 again a list. The first element is the name of the object. The second
345 is a list of attributes. The third element will be the object text.
346 All three of these object elements correspond with fields in the struc‐
347 ture batch_status which is described in detail for each type of object
348 by the man pages for pbs_statjob(3), pbs_statque(3), and pbs_stat‐
349 server(3). Each attribute in the second element list whose elements
350 correspond with the attrl structure. Each will be a list with two ele‐
351 ments. The first will be the attribute name and the second will be the
352 attribute value.
353
355 Upon successful processing of all the operands presented to the qstat
356 command, the exit status will be a value of zero.
357 If the qstat command fails to process any operand, the command exits
359 with a value greater than zero.
360
362 qalter(1B), qsub(1B), pbs_alterjob(3B), pbs_statjob(3B),
363 pbs_statque(3B), pbs_statserver(3B), pbs_submit(3B),
364 pbs_job_attributes(7B), pbs_queue_attributes(7B),
365 pbs_server_attributes(7B), pbs_resources_*(7B) where * is system type,
366 and the PBS ERS.
367Local qstat(1B)