1QSTAT(1P) POSIX Programmer's Manual QSTAT(1P)
2
6 This manual page is part of the POSIX Programmer's Manual. The Linux
7 implementation of this interface may differ (consult the corresponding
8 Linux manual page for details of Linux behavior), or the interface may
9 not be implemented on Linux.
10
12 qstat - show status of batch jobs
13
15 qstat [-f] job_identifier ...
16 qstat -Q [-f] destination ...
18 qstat -B [-f] server_name ...
20
23 The status of a batch job, batch queue, or batch server is obtained by
24 a request to the server. The qstat utility is a user-accessible batch
25 client that requests the status of one or more batch jobs, batch
26 queues, or servers, and writes the status information to standard out‐
27 put.
28 For each successfully processed batch job_identifier, the qstat utility
30 shall display information about the corresponding batch job.
31 For each successfully processed destination, the qstat utility shall
33 display information about the corresponding batch queue.
34 For each successfully processed server name, the qstat utility shall
36 display information about the corresponding server.
37 The qstat utility shall acquire batch job status information by sending
39 a Job Status Request to a batch server. The qstat utility shall
40 acquire batch queue status information by sending a Queue Status
41 Request to a batch server. The qstat utility shall acquire server sta‐
42 tus information by sending a Server Status Request to a batch server.
43
45 The qstat utility shall conform to the Base Definitions volume of
46 IEEE Std 1003.1-2001, Section 12.2, Utility Syntax Guidelines.
47 The following options shall be supported by the implementation:
49 -f Specify that a full display is produced.
51 The minimum contents of a full display are specified in the STDOUT sec‐
53 tion.
54 Additional contents and format of a full display are implementation-
56 defined.
57 -Q Specify that the operand is a destination.
59 The qstat utility shall display information about each batch queue at
61 each destination identified as an operand.
62 -B Specify that the operand is a server name.
64 The qstat utility shall display information about each server identi‐
66 fied as an operand.
67
70 If the -Q option is presented to the qstat utility, the utility shall
71 accept one or more operands that conform to the syntax for a destina‐
72 tion (see Destination ).
73 If the -B option is presented to the qstat utility, the utility shall
75 accept one or more server_name operands.
76 If neither the -B nor the -Q option is presented to the qstat utility,
78 the utility shall accept one or more operands that conform to the syn‐
79 tax for a batch job_identifier (see Batch Job Identifier ).
80
82 Not used.
83
85 None.
86
88 The following environment variables shall affect the execution of
89 qstat:
90 HOME Determine the pathname of the user's home directory.
92 LANG Provide a default value for the internationalization variables
94 that are unset or null. (See the Base Definitions volume of
95 IEEE Std 1003.1-2001, Section 8.2, Internationalization Vari‐
96 ables for the precedence of internationalization variables used
97 to determine the values of locale categories.)
98 LC_ALL If set to a non-empty string value, override the values of all
100 the other internationalization variables.
101 LC_COLLATE
103 Determine the locale for the behavior of ranges, equivalence
105 classes, and multi-character collating elements within regular
106 expressions.
107 LC_CTYPE
109 Determine the locale for the interpretation of sequences of
110 bytes of text data as characters (for example, single-byte as
111 opposed to multi-byte characters in arguments).
112 LC_MESSAGES
114 Determine the locale that should be used to affect the format
115 and contents of diagnostic messages written to standard error.
116 LC_NUMERIC
118 Determine the locale for selecting the radix character used when
120 writing floating-point formatted output.
121
124 Default.
125
127 If an operand presented to the qstat utility is a batch job_identifier
128 and the -f option is not specified, the qstat utility shall display the
129 following items on a single line, in the stated order, with white space
130 between each item, for each successfully processed operand:
131 * The batch job_identifier
133 * The batch job name
135 * The Job_Owner attribute
137 * The CPU time used by the batch job
139 * The batch job state
141 * The batch job location
143 If an operand presented to the qstat utility is a batch job_identifier
145 and the -f option is specified, the qstat utility shall display the
146 following items for each success fully processed operand:
147 * The batch job_identifier
149 * The batch job name
151 * The Job_Owner attribute
153 * The execution user ID
155 * The CPU time used by the batch job
157 * The batch job state
159 * The batch job location
161 * Additional implementation-defined information, if any, about the
163 batch job or batch queue
164 If an operand presented to the qstat utility is a destination, the -Q
166 option is specified, and the -f option is not specified, the qstat
167 utility shall display the following items on a single line, in the
168 stated order, with white space between each item, for each successfully
169 processed operand:
170 * The batch queue name
172 * The maximum number of batch jobs that shall be run in the batch
174 queue concurrently
175 * The total number of batch jobs in the batch queue
177 * The status of the batch queue
179 * For each state, the number of batch jobs in that state in the batch
181 queue and the name of the state
182 * The type of batch queue (execution or routing)
184 If the operands presented to the qstat utility are destinations, the -Q
186 option is specified, and the -f option is specified, the qstat utility
187 shall display the following items for each successfully processed oper‐
188 and:
189 * The batch queue name
191 * The maximum number of batch jobs that shall be run in the batch
193 queue concurrently
194 * The total number of batch jobs in the batch queue
196 * The status of the batch queue
198 * For each state, the number of batch jobs in that state in the batch
200 queue and the name of the state
201 * The type of batch queue (execution or routing)
203 * Additional implementation-defined information, if any, about the
205 batch queue
206 If the operands presented to the qstat utility are batch server names,
208 the -B option is specified, and the -f option is not specified, the
209 qstat utility shall display the following items on a single line, in
210 the stated order, with white space between each item, for each success‐
211 fully processed operand:
212 * The batch server name
214 * The maximum number of batch jobs that shall be run in the batch
216 queue concurrently
217 * The total number of batch jobs managed by the batch server
219 * The status of the batch server
221 * For each state, the number of batch jobs in that state and the name
223 of the state
224 If the operands presented to the qstat utility are server names, the -B
226 option is specified, and the -f option is specified, the qstat utility
227 shall display the following items for each successfully processed oper‐
228 and:
229 * The server name
231 * The maximum number of batch jobs that shall be run in the batch
233 queue concurrently
234 * The total number of batch jobs managed by the server
236 * The status of the server
238 * For each state, the number of batch jobs in that state and the name
240 of the state
241 * Additional implementation-defined information, if any, about the
243 server
244
246 The standard error shall be used only for diagnostic messages.
247
249 None.
250
252 None.
253
255 The following exit values shall be returned:
256 0 Successful completion.
258 >0 An error occurred.
260
263 In addition to the default behavior, the qstat utility shall not be
264 required to write a diagnostic message to standard error when the error
265 reply received from a batch server indicates that the batch job_identi‐
266 fier does not exist on the server. Whether or not the qstat utility
267 waits to output the diagnostic message while attempting to locate the
268 batch job on other servers is implementation-defined.
269 The following sections are informative.
271
273 None.
274
276 None.
277
279 The qstat utility allows users to display the status of jobs and list
280 the batch jobs in queues.
281 The operands of the qstat utility may be either job identifiers, queues
283 (specified as destination identifiers), or batch server names. The -Q
284 and -B options, or absence thereof, indicate the nature of the oper‐
285 ands.
286 The other options of the qstat utility allow the user to control the
288 amount of information displayed and the format in which it is dis‐
289 played. Should a user wish to display the status of a set of jobs that
290 match a selection criteria, the qselect utility may be used to acquire
291 such a list.
292 The -f option allows users to request a "full" display in an implemen‐
294 tation-defined format.
295 Historically, the qstat utility has been a part of the NQS and its de‐
297 rivatives, the existing practice on which it is based.
298
300 None.
301
303 Batch Environment Services, qselect
304
306 Portions of this text are reprinted and reproduced in electronic form
307 from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
308 -- Portable Operating System Interface (POSIX), The Open Group Base
309 Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
310 Electrical and Electronics Engineers, Inc and The Open Group. In the
311 event of any discrepancy between this version and the original IEEE and
312 The Open Group Standard, the original IEEE and The Open Group Standard
313 is the referee document. The original Standard can be obtained online
314 at http://www.opengroup.org/unix/online.html .
315IEEE/The Open Group 2003 QSTAT(1P)