qstat(1p)

1QSTAT(P)                   POSIX Programmer's Manual                  QSTAT(P)
2
3
4

NAME

6       qstat - show status of batch jobs
7

SYNOPSIS

9       qstat [-f] job_identifier ...
10
11       qstat -Q [-f] destination ...
12
13       qstat -B [-f] server_name ...
14
15

DESCRIPTION

17       The  status of a batch job, batch queue, or batch server is obtained by
18       a request to the server. The qstat utility is a  user-accessible  batch
19       client  that  requests  the  status  of  one  or more batch jobs, batch
20       queues, or servers, and writes the status information to standard  out‐
21       put.
22
23       For each successfully processed batch job_identifier, the qstat utility
24       shall display information about the corresponding batch job.
25
26       For each successfully processed destination, the  qstat  utility  shall
27       display information about the corresponding batch queue.
28
29       For  each  successfully  processed server name, the qstat utility shall
30       display information about the corresponding server.
31
32       The qstat utility shall acquire batch job status information by sending
33       a  Job  Status  Request  to  a  batch  server.  The qstat utility shall
34       acquire batch queue  status  information  by  sending  a  Queue  Status
35       Request to a batch server.  The qstat utility shall acquire server sta‐
36       tus information by sending a Server Status Request to a batch server.
37

OPTIONS

39       The qstat utility shall conform  to  the  Base  Definitions  volume  of
40       IEEE Std 1003.1-2001, Section 12.2, Utility Syntax Guidelines.
41
42       The following options shall be supported by the implementation:
43
44       -f     Specify that a full display is produced.
45
46       The minimum contents of a full display are specified in the STDOUT sec‐
47       tion.
48
49       Additional contents and format of a full  display  are  implementation-
50       defined.
51
52       -Q     Specify that the operand is a destination.
53
54       The  qstat  utility shall display information about each batch queue at
55       each destination identified as an operand.
56
57       -B     Specify that the operand is a server name.
58
59       The qstat utility shall display information about each  server  identi‐
60       fied as an operand.
61
62

OPERANDS

64       If  the  -Q option is presented to the qstat utility, the utility shall
65       accept one or more operands that conform to the syntax for  a  destina‐
66       tion (see Destination ).
67
68       If  the  -B option is presented to the qstat utility, the utility shall
69       accept one or more server_name operands.
70
71       If neither the -B nor the -Q option is presented to the qstat  utility,
72       the  utility shall accept one or more operands that conform to the syn‐
73       tax for a batch job_identifier (see Batch Job Identifier ).
74

STDIN

76       Not used.
77

INPUT FILES

79       None.
80

ENVIRONMENT VARIABLES

82       The following environment  variables  shall  affect  the  execution  of
83       qstat:
84
85       HOME   Determine the pathname of the user's home directory.
86
87       LANG   Provide  a  default value for the internationalization variables
88              that are unset or null. (See  the  Base  Definitions  volume  of
89              IEEE Std 1003.1-2001,  Section  8.2,  Internationalization Vari‐
90              ables for the precedence of internationalization variables  used
91              to determine the values of locale categories.)
92
93       LC_ALL If  set  to a non-empty string value, override the values of all
94              the other internationalization variables.
95
96       LC_COLLATE
97
98              Determine the locale for the  behavior  of  ranges,  equivalence
99              classes,  and  multi-character collating elements within regular
100              expressions.
101
102       LC_CTYPE
103              Determine the locale for  the  interpretation  of  sequences  of
104              bytes  of  text  data as characters (for example, single-byte as
105              opposed to multi-byte characters in arguments).
106
107       LC_MESSAGES
108              Determine the locale that should be used to  affect  the  format
109              and contents of diagnostic messages written to standard error.
110
111       LC_NUMERIC
112
113              Determine the locale for selecting the radix character used when
114              writing floating-point formatted output.
115
116

ASYNCHRONOUS EVENTS

118       Default.
119

STDOUT

121       If an operand presented to the qstat utility is a batch  job_identifier
122       and the -f option is not specified, the qstat utility shall display the
123       following items on a single line, in the stated order, with white space
124       between each item, for each successfully processed operand:
125
126        * The batch job_identifier
127
128        * The batch job name
129
130        * The Job_Owner attribute
131
132        * The CPU time used by the batch job
133
134        * The batch job state
135
136        * The batch job location
137
138       If  an operand presented to the qstat utility is a batch job_identifier
139       and the -f option is specified, the qstat  utility  shall  display  the
140       following items for each success fully processed operand:
141
142        * The batch job_identifier
143
144        * The batch job name
145
146        * The Job_Owner attribute
147
148        * The execution user ID
149
150        * The CPU time used by the batch job
151
152        * The batch job state
153
154        * The batch job location
155
156        * Additional  implementation-defined  information,  if  any, about the
157          batch job or batch queue
158
159       If an operand presented to the qstat utility is a destination,  the  -Q
160       option  is  specified,  and  the  -f option is not specified, the qstat
161       utility shall display the following items on  a  single  line,  in  the
162       stated order, with white space between each item, for each successfully
163       processed operand:
164
165        * The batch queue name
166
167        * The maximum number of batch jobs that shall  be  run  in  the  batch
168          queue concurrently
169
170        * The total number of batch jobs in the batch queue
171
172        * The status of the batch queue
173
174        * For  each state, the number of batch jobs in that state in the batch
175          queue and the name of the state
176
177        * The type of batch queue (execution or routing)
178
179       If the operands presented to the qstat utility are destinations, the -Q
180       option  is specified, and the -f option is specified, the qstat utility
181       shall display the following items for each successfully processed oper‐
182       and:
183
184        * The batch queue name
185
186        * The  maximum  number  of  batch  jobs that shall be run in the batch
187          queue concurrently
188
189        * The total number of batch jobs in the batch queue
190
191        * The status of the batch queue
192
193        * For each state, the number of batch jobs in that state in the  batch
194          queue and the name of the state
195
196        * The type of batch queue (execution or routing)
197
198        * Additional  implementation-defined  information,  if  any, about the
199          batch queue
200
201       If the operands presented to the qstat utility are batch server  names,
202       the  -B  option  is  specified, and the -f option is not specified, the
203       qstat utility shall display the following items on a  single  line,  in
204       the stated order, with white space between each item, for each success‐
205       fully processed operand:
206
207        * The batch server name
208
209        * The maximum number of batch jobs that shall  be  run  in  the  batch
210          queue concurrently
211
212        * The total number of batch jobs managed by the batch server
213
214        * The status of the batch server
215
216        * For  each state, the number of batch jobs in that state and the name
217          of the state
218
219       If the operands presented to the qstat utility are server names, the -B
220       option  is specified, and the -f option is specified, the qstat utility
221       shall display the following items for each successfully processed oper‐
222       and:
223
224        * The server name
225
226        * The  maximum  number  of  batch  jobs that shall be run in the batch
227          queue concurrently
228
229        * The total number of batch jobs managed by the server
230
231        * The status of the server
232
233        * For each state, the number of batch jobs in that state and the  name
234          of the state
235
236        * Additional  implementation-defined  information,  if  any, about the
237          server
238

STDERR

240       The standard error shall be used only for diagnostic messages.
241

OUTPUT FILES

243       None.
244

EXTENDED DESCRIPTION

246       None.
247

EXIT STATUS

249       The following exit values shall be returned:
250
251        0     Successful completion.
252
253       >0     An error occurred.
254
255

CONSEQUENCES OF ERRORS

257       In addition to the default behavior, the qstat  utility  shall  not  be
258       required to write a diagnostic message to standard error when the error
259       reply received from a batch server indicates that the batch job_identi‐
260       fier  does  not  exist  on the server. Whether or not the qstat utility
261       waits to output the diagnostic message while attempting to  locate  the
262       batch job on other servers is implementation-defined.
263
264       The following sections are informative.
265

APPLICATION USAGE

267       None.
268

EXAMPLES

270       None.
271

RATIONALE

273       The  qstat  utility allows users to display the status of jobs and list
274       the batch jobs in queues.
275
276       The operands of the qstat utility may be either job identifiers, queues
277       (specified  as  destination identifiers), or batch server names. The -Q
278       and -B options, or absence thereof, indicate the nature  of  the  oper‐
279       ands.
280
281       The  other  options  of the qstat utility allow the user to control the
282       amount of information displayed and the format  in  which  it  is  dis‐
283       played.  Should a user wish to display the status of a set of jobs that
284       match a selection criteria, the qselect utility may be used to  acquire
285       such a list.
286
287       The  -f option allows users to request a "full" display in an implemen‐
288       tation-defined format.
289
290       Historically, the qstat utility has been a part of the NQS and its  de‐
291       rivatives, the existing practice on which it is based.
292

FUTURE DIRECTIONS

294       None.
295

COPYRIGHT

300       Portions  of  this text are reprinted and reproduced in electronic form
301       from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
302       --  Portable  Operating  System  Interface (POSIX), The Open Group Base
303       Specifications Issue 6, Copyright (C) 2001-2003  by  the  Institute  of
304       Electrical  and  Electronics  Engineers, Inc and The Open Group. In the
305       event of any discrepancy between this version and the original IEEE and
306       The  Open Group Standard, the original IEEE and The Open Group Standard
307       is the referee document. The original Standard can be  obtained  online
308       at http://www.opengroup.org/unix/online.html .
309
310
311
312IEEE/The Open Group                  2003                             QSTAT(P)