qstat.1B 25 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085
  1. .\" Copyright (C) 1994-2018 Altair Engineering, Inc.
  2. .\" For more information, contact Altair at www.altair.com.
  3. .\"
  4. .\" This file is part of the PBS Professional ("PBS Pro") software.
  5. .\"
  6. .\" Open Source License Information:
  7. .\"
  8. .\" PBS Pro is free software. You can redistribute it and/or modify it under the
  9. .\" terms of the GNU Affero General Public License as published by the Free
  10. .\" Software Foundation, either version 3 of the License, or (at your option) any
  11. .\" later version.
  12. .\"
  13. .\" PBS Pro is distributed in the hope that it will be useful, but WITHOUT ANY
  14. .\" WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15. .\" FOR A PARTICULAR PURPOSE.
  16. .\" See the GNU Affero General Public License for more details.
  17. .\"
  18. .\" You should have received a copy of the GNU Affero General Public License
  19. .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. .\"
  21. .\" Commercial License Information:
  22. .\"
  23. .\" For a copy of the commercial license terms and conditions,
  24. .\" go to: (http://www.pbspro.com/UserArea/agreement.html)
  25. .\" or contact the Altair Legal Department.
  26. .\"
  27. .\" Altair’s dual-license business model allows companies, individuals, and
  28. .\" organizations to create proprietary derivative works of PBS Pro and
  29. .\" distribute them - whether embedded or bundled with other software -
  30. .\" under a commercial license agreement.
  31. .\"
  32. .\" Use of Altair’s trademarks, including but not limited to "PBS™",
  33. .\" "PBS Professional®", and "PBS Pro™" and Altair’s logos is subject to Altair's
  34. .\" trademark licensing policies.
  35. .\"
  36. .TH qstat 1B "23 April 2018" Local "PBS Professional"
  37. .SH NAME
  38. .B qstat
  39. - display status of PBS jobs, queues, or servers
  40. .SH SYNOPSIS
  41. .RE
  42. .B Displaying Job Status
  43. .RS 7
  44. Default format:
  45. .br
  46. .B qstat
  47. [-E] [-J] [-p] [-t] [-x] [[<job ID> | <destination>] ...]
  48. .sp
  49. Long format:
  50. .br
  51. .B qstat
  52. -f [-F json | dsv [-D <delimiter>]] [-E] [-J] [-p]
  53. [-t] [-w]
  54. .RS 6
  55. [-x] [[<job ID> | <destination>] ...]
  56. .RE
  57. .sp
  58. Alternate format:
  59. .br
  60. .B qstat
  61. [-a [-w]| -H | -i | -r ] [-E] [-G | -M] [-J] [-n [-1][-w]]
  62. .RS 6
  63. [-s [-1][-w]] [-t] [-T [-w]] [-u <user list>]
  64. .br
  65. [[<job ID> | <destination>] ...]
  66. .RE
  67. .RE
  68. .B Displaying Queue Status
  69. .RS 7
  70. Default format:
  71. .br
  72. .B qstat
  73. -Q [<destination> ...]
  74. .sp
  75. Long format:
  76. .br
  77. .B qstat
  78. -Q -f [-F json | dsv [-D <delimiter>]] [-w] [<destination> ...]
  79. .sp
  80. Alternate format:
  81. .br
  82. .B qstat
  83. -q [-G | -M] [<destination> ...]
  84. .RE
  85. .B Displaying Server Status
  86. .RS 7
  87. Default format:
  88. .br
  89. .B qstat
  90. -B [<server> ...]
  91. .sp
  92. Long format:
  93. .br
  94. .B qstat
  95. -B -f [-F json | dsv [-D <delimiter>]] [-w] [<server> ...]
  96. .B Version Information
  97. .br
  98. .B qstat
  99. --version
  100. .SH DESCRIPTION
  101. The
  102. .B qstat
  103. command displays the status of jobs, queues, or servers, writing
  104. the status information to standard output.
  105. .LP
  106. When displaying job status information, the
  107. .B qstat
  108. command displays status information about all specified jobs, job
  109. arrays, and subjobs. You can specify jobs by ID, or by destination,
  110. for example all jobs at a specified queue or server.
  111. .B Display Formats
  112. .br
  113. You can use particular options to display status information in a
  114. default format, an alternate format, or a long format. Default and
  115. alternate formats display all status information for a job, queue, or
  116. server with one line per object, in columns. Long formats display
  117. status information showing all attributes, one attribute to a line.
  118. .B Displaying Information for Finished and Moved Jobs
  119. .br
  120. You can display status information for finished and moved jobs by
  121. using the
  122. .I -x
  123. and
  124. .I -H
  125. options.
  126. If your job has been moved to another server through peer scheduling,
  127. give the job ID as an argument to
  128. .B qstat.
  129. If you do not specify the job ID, your job will not appear to exist.
  130. For example, your job 123.ServerA is moved to ServerB. In this case, you can use
  131. .br
  132. .B \ \ \ qstat 123
  133. .br
  134. or
  135. .br
  136. .B \ \ \ qstat 123.ServerA
  137. Specifying the full job name, including the server, avoids the possibility
  138. that
  139. .B qstat
  140. will report on a job named 123.ServerB that was moved to ServerA.
  141. To list all jobs at ServerB, you can use:
  142. .br
  143. .B \ \ \ qstat @ServerB
  144. .B Required Privilege
  145. .br
  146. Users without Manager or Operator privilege cannot view
  147. resources or attributes that are invisible to unprivileged users.
  148. .SH DISPLAYING JOB STATUS
  149. .B Job Status in Default Format
  150. .br
  151. Triggers: any of the
  152. .I -J, -p, -t,
  153. or
  154. .I -x
  155. options.
  156. The
  157. .B qstat
  158. command displays job status in default format when you specify any
  159. of the
  160. .I -J, -p, -t,
  161. or
  162. .I -x,
  163. options.
  164. Jobs are displayed one to a line, with these column headers:
  165. .sp
  166. Job id Name User Time Use S Queue
  167. .br
  168. -------- ---------- --------- -------- - -----
  169. .sp
  170. Description of columns:
  171. .IP "Job id" 10
  172. The job ID assigned by PBS
  173. .IP "Name" 10
  174. Job name specified by submitter
  175. .IP "User" 10
  176. Username of job owner
  177. .IP "Time Use" 10
  178. The CPU time used by the job. Before the application has actually
  179. started running, for example during stage-in, this field is "0". At
  180. the point where the application starts accumulating cput, this field
  181. changes to "00:00:00". After that, every time the MoM polls for
  182. resource usage, the field is updated.
  183. The MoM on each execution host polls for the usage of all
  184. processes on her host belonging to the job. Usage is summed. The
  185. polling interval is short when a job first starts running and
  186. lengthens to a maximum of 2 minutes.
  187. .LP
  188. .IP "S" 10
  189. The job's state:
  190. .RS
  191. .IP "B" 3
  192. Array job has at least one subjob running
  193. .IP "E" 3
  194. Job is exiting after having run
  195. .IP "F" 3
  196. Job is finished
  197. .IP "H" 3
  198. Job is held
  199. .IP "M" 3
  200. Job was moved to another server
  201. .IP "Q" 3
  202. Job is queued
  203. .IP "R" 3
  204. Job is running
  205. .IP "S" 3
  206. Job is suspended
  207. .IP "T" 3
  208. Job is being moved to new location
  209. .IP "U" 3
  210. Cycle-harvesting job is suspended due to
  211. keyboard activity
  212. .IP "W" 3
  213. Job is waiting for its submitter-assigned start
  214. time to be reached
  215. .IP "X" 3
  216. Subjob has completed execution or has been deleted
  217. .RE
  218. .IP "Queue" 10
  219. The queue in which the job resides
  220. .LP
  221. .B Job Status in Long Format
  222. .br
  223. Trigger: the
  224. .I -f
  225. option.
  226. .br
  227. If you specify the
  228. .I -f
  229. (full) option, full job status information for each job is displayed
  230. in this order:
  231. .RS 5
  232. The job ID
  233. .br
  234. Each job attribute, one to a line
  235. .br
  236. The job's submission arguments
  237. .br
  238. The job's executable, in JSDL format
  239. .br
  240. The executable's argument list, in JSDL format
  241. .RE
  242. The job attributes are listed
  243. as
  244. .I <name> = <value>
  245. pairs. This includes the
  246. .I exec_host
  247. and
  248. .I exec_vnode
  249. strings.
  250. The full output can be very large.
  251. .sp
  252. The
  253. .I exec_host
  254. string has the format:
  255. .br
  256. .I <host1>/<T1>*<P1>[+<host2>/<T2>*<P2>+...]
  257. .br
  258. where
  259. .br
  260. .I T1
  261. is the task slot number (the index) of the job on hostA.
  262. .br
  263. .I P1
  264. is the number of processors allocated to the job from host1. The
  265. number of processors allocated does not appear if it is 1.
  266. The
  267. .I exec_vnode
  268. string has the format:
  269. .br
  270. .I (<vnode1>:ncpus=<N1>:mem=<M1>)[+(<vnode2>:ncpus=<N2>:mem=<M2>)+...]
  271. .br
  272. where
  273. .br
  274. N1 is the number of CPUs allocated to that job on vnode1.
  275. .br
  276. M1 is the amount of memory allocated to that job on vnode1.
  277. .B Job Status in Alternate Format
  278. .br
  279. Triggers: any of the
  280. .I -a, -i, -G, -H, -M, -n, -r, -s,
  281. or
  282. .I -u <user list>
  283. options.
  284. .br
  285. The
  286. .B qstat
  287. command displays job status in the alternate format if you specify any of the
  288. .I -a, -i, -G, -H, -M, -n, -r, -s,
  289. or
  290. .I -u <user list>
  291. options.
  292. Jobs are displayed one to a line. If jobs are running and the -n
  293. option is specified, or if jobs are finished or moved and the -H and
  294. -n options are specified, there is a second line for the
  295. .I exec_host
  296. string.
  297. .sp
  298. Column headers:
  299. .sp
  300. Req'd Req'd Elap
  301. .br
  302. Job ID Username Queue Jobname SessID NDS TSK Memory Time S Time
  303. .br
  304. ------ -------- ----- ------- ------ --- --- ------ ----- - ----
  305. .sp
  306. Description of columns:
  307. .sp
  308. .IP "Job ID" 15
  309. The job ID assigned by PBS
  310. .IP "Username" 15
  311. Username of job owner
  312. .IP "Queue" 15
  313. Queue in which the job resides
  314. .IP "Jobname"
  315. Job name specified by submitter
  316. .IP "SessID" 15
  317. Session ID. Appears only if the job is running.
  318. .IP "NDS" 15
  319. Number of chunks or vnodes requested by the job
  320. .IP "TSK" 15
  321. Number of CPUs requested by the job
  322. .IP "Req'd Memory" 15
  323. Amount of memory requested by the job
  324. .IP "Req'd Time" 15
  325. If CPU time is requested, this shows CPU time. Otherwise, shows walltime
  326. .IP "S" 15
  327. The job's state. (See listing above)
  328. .IP "Elap Time" 15
  329. If CPU time is requested, this shows CPU time. Otherwise, shows walltime
  330. .SH Grouping Jobs and Sorting by ID
  331. Trigger: the
  332. .I -E
  333. option.
  334. .br
  335. You can use the
  336. .I -E
  337. option to sort and group jobs in the output of
  338. .B qstat.
  339. The
  340. .I -E
  341. option groups jobs by server and displays each group by ascending ID.
  342. This option also improves
  343. .B qstat
  344. performance. The following table shows how the
  345. .I -E
  346. option affects the behavior of
  347. .B qstat:
  348. .B How qstat is Used \ \ Result Without -E \ \ \ \ \ \ \ \ \ Result With -E
  349. .br
  350. -----------------------------------------------------------------------
  351. .br
  352. qstat (no job ID Queries the default server No change in behavior;
  353. .br
  354. specified) and displays result same as without
  355. .I -E
  356. .br
  357. option
  358. .br
  359. -----------------------------------------------------------------------
  360. .br
  361. qstat <list of job Displays results in the Displays results in
  362. .br
  363. IDs from single order specified ascending ID order
  364. .br
  365. server>
  366. .br
  367. -----------------------------------------------------------------------
  368. .br
  369. qstat <job IDs at Displays results in the Groups jobs by server.
  370. .br
  371. multiple servers> order they are specified Displays each group in
  372. .br
  373. ascending order
  374. .br
  375. -----------------------------------------------------------------------
  376. .SH DISPLAYING QUEUE STATUS
  377. .B Queue Status in Default Format
  378. .br
  379. Trigger: the
  380. .I -Q
  381. option by itself.
  382. .br
  383. The
  384. .B qstat
  385. command displays queue status in the default format if
  386. the only option is
  387. .I -Q.
  388. Queue status is displayed one queue to a line, with these column headers:
  389. .nf
  390. Queue Max Tot Ena Str Que Run Hld Wat Trn Ext Type
  391. ----- ---- ---- ---- --- ---- ---- ---- ---- ---- ---- ----
  392. .fi
  393. Description of columns:
  394. .IP "Queue" 15
  395. Queue name
  396. .IP "Max" 15
  397. Maximum number of jobs allowed to run concurrently in this queue
  398. .IP "Tot" 15
  399. Total number of jobs in the queue
  400. .IP "Ena" 15
  401. Whether the queue is
  402. enabled
  403. or
  404. disabled
  405. .IP "Str" 15
  406. Whether the queue is
  407. started
  408. or
  409. stopped
  410. .IP "Que" 15
  411. Number of queued jobs
  412. .IP "Run" 15
  413. Number of running jobs
  414. .IP "Hld" 15
  415. Number of held jobs
  416. .IP "Wat" 15
  417. Number of waiting jobs
  418. .IP "Trn" 15
  419. Number of jobs being moved (transiting)
  420. .IP "Ext" 15
  421. Number of exiting jobs
  422. .IP "Type" 15
  423. Type of queue: execution or routing
  424. .sp
  425. .LP
  426. .B Queue Status in Long Format
  427. .br
  428. Trigger: the
  429. .I -q
  430. and
  431. .I -f
  432. options together.
  433. .br
  434. If you specify the
  435. .I -f
  436. (full) option with the
  437. .I -q
  438. option, full queue status information for each queue is displayed
  439. starting with the queue name, followed by each attribute, one to a line,
  440. as
  441. .I <name> = <value>
  442. pairs.
  443. .sp
  444. .B Queue Status: Alternate Format
  445. .br
  446. Triggers: any of the
  447. .I -q, -G,
  448. or
  449. .I -M
  450. options.
  451. .br
  452. The
  453. .B qstat
  454. command displays queue status in the alternate format if you
  455. specify any of the
  456. .I -q, -G,
  457. or
  458. .I -M
  459. options.
  460. Queue status is displayed one queue to a line, and the lowest line
  461. contains totals for some columns.
  462. These are the alternate format queue status column headers:
  463. .nf
  464. Queue Memory CPU Time Walltime Node Run Que Lm State
  465. ----- ------ -------- -------- ---- --- --- -- -----
  466. .fi
  467. Description of columns:
  468. .IP "Queue" 15
  469. Queue name
  470. .IP "Memory" 15
  471. Maximum amount of memory that can be requested by a job in this queue
  472. .IP "CPU Time" 15
  473. Maximum amount of CPU time that can be requested by a job in this queue
  474. .IP "Walltime" 15
  475. Maximum amount of walltime that can be requested by a job in this queue
  476. .IP "Node" 15
  477. Maximum number of vnodes that can be requested by a job in this queue
  478. .IP "Run" 15
  479. Number of running and suspended jobs. Lowest row is total number of
  480. running and suspended jobs in all the queues shown
  481. .IP "Que" 15
  482. Number of queued, waiting, and held jobs. Lowest row is total number
  483. of queued, waiting, and held jobs in all the queues shown
  484. .IP "Lm" 15
  485. Maximum number of jobs allowed to run concurrently in this queue
  486. .IP "State" 15
  487. State of this queue:
  488. .I E
  489. (enabled) or
  490. .I D
  491. (disabled),
  492. and
  493. .I R
  494. (running) or
  495. .I S
  496. (stopped)
  497. .sp
  498. .SH DISPLAYING SERVER STATUS
  499. .B Server Status in Default Format:
  500. .br
  501. Trigger: the
  502. .I -B
  503. option.
  504. .br
  505. The
  506. .B qstat
  507. command displays server status if the only option given is
  508. .I -B.
  509. .sp
  510. Column headers for default server status output:
  511. .nf
  512. Server Max Tot Que Run Hld Wat Trn Ext Status
  513. ------ --- --- --- --- --- --- --- --- ------
  514. .fi
  515. Description of columns:
  516. .IP "Server" 15
  517. Name of server
  518. .IP "Max" 15
  519. Maximum number of jobs allowed to be running concurrently
  520. on the server
  521. .IP "Tot" 15
  522. Total number of jobs currently managed by the server
  523. .IP "Que" 15
  524. Number of queued jobs
  525. .IP "Run" 15
  526. Number of running jobs
  527. .IP "Hld" 15
  528. Number of held jobs
  529. .IP "Wat" 15
  530. Number of waiting jobs
  531. .IP "Trn" 15
  532. Number of transiting jobs
  533. .IP "Ext" 15
  534. Number of exiting jobs
  535. .IP "Status" 15
  536. Status of the server
  537. .RE
  538. .B Server Status in Long Format
  539. .br
  540. Trigger: the
  541. .I -f
  542. option.
  543. .br
  544. If you specify the
  545. .I -f
  546. (full) option, displays full server status information
  547. starting with the server name, followed by each server attribute,
  548. one to a line, as
  549. .I <name> = <value>
  550. pairs. Includes PBS version information.
  551. .sp
  552. .SH OPTIONS
  553. .B Generic Job Status Options
  554. .IP "-E" 10
  555. Groups jobs by server and displays jobs sorted by ascending ID. When
  556. .B qstat
  557. is presented with a list of jobs, jobs are grouped by server and each
  558. group is displayed by ascending ID. This option also improves
  559. .B qstat
  560. performance.
  561. .LP
  562. .B Default Job Status Options
  563. .IP "-J" 10
  564. Prints status information for job arrays (not subjobs).
  565. .IP "-t" 10
  566. Displays status information for jobs, job arrays, and subjobs.
  567. When used with
  568. .I -J
  569. option, prints status information for subjobs only.
  570. .IP "-p" 10
  571. The
  572. .I Time Use
  573. column is replaced with the percentage completed for the job. For an
  574. array job this is the percentage of subjobs completed. For a normal
  575. job, it is the percentage of allocated CPU time used.
  576. .IP "-x" 10
  577. Displays status information for finished and moved jobs in
  578. addition to queued and running jobs.
  579. .LP
  580. .B Alternate Job Status Options
  581. .IP "-a" 10
  582. All queued and running jobs are displayed.
  583. If a
  584. .I destination
  585. is specified, information for all jobs at that
  586. .I destination
  587. is displayed.
  588. If a
  589. .I job ID
  590. is specified, information about that job is displayed.
  591. Always specify this option before the
  592. .I -n
  593. or
  594. .I -s
  595. options, otherwise they will not take effect.
  596. .IP "-H" 10
  597. Without a job identifier, displays information for all finished or moved jobs.
  598. If a
  599. .I job ID
  600. is given, displays information for that job regardless of
  601. its state. If a
  602. .I destination
  603. is specified, displays information for finished or moved jobs, or
  604. specified job(s), at
  605. .I destination.
  606. .IP "-i" 10
  607. If a
  608. .I destination
  609. is given, information for queued, held or waiting jobs at that
  610. .I destination
  611. is displayed.
  612. If a
  613. .I job ID
  614. is given, information about that job is displayed regardless
  615. of its state.
  616. .IP "-n" 10
  617. The
  618. .I exec_host
  619. string is listed on the line below the basic information.
  620. If the
  621. .I -1
  622. option is given, the
  623. .I exec_host
  624. string is listed on the end of the same line.
  625. If using the
  626. .I -a
  627. option, always specify the
  628. .I -n
  629. option after
  630. .I -a,
  631. otherwise the
  632. .I -n
  633. option does not take effect.
  634. .IP "-r" 10
  635. If a
  636. .I destination
  637. is given, information for running or suspended jobs at that
  638. .I destination
  639. is displayed.
  640. If a
  641. .I job ID
  642. is given, information about that job is displayed regardless of its state.
  643. .IP "-s" 10
  644. Any comment added by the administrator or scheduler is shown on the line below the basic information.
  645. If the
  646. .I -1
  647. option is given, the comment string is listed on the end of the same line.
  648. If using the
  649. .I -a
  650. option, always specify the
  651. .I -s
  652. option after
  653. .I -a,
  654. otherwise the
  655. .I -s
  656. option does not take effect.
  657. .IP "-T" 10
  658. Displays estimated start time for queued jobs, replacing the
  659. .I Elap Time
  660. field with the
  661. .I Est Start Time
  662. field. Jobs with earlier estimated start
  663. times are displayed before those with later estimated start times.
  664. Running jobs are displayed before other jobs. Running jobs are sorted
  665. by their
  666. .I stime
  667. attribute (start time).
  668. Queued jobs whose estimated start times are unset
  669. (estimated.start_time = unset) are displayed after those with
  670. estimated start times, with estimated start time shown as a double dash
  671. ("--"). Queued jobs with estimated start times in the past are treated
  672. as if their estimated start times are unset.
  673. If a job's estimated start time cannot be calculated, the start time
  674. is shown as a question mark ("?").
  675. Time displayed is local to the qstat command. Current week begins on
  676. Sunday.
  677. The following table shows the format for the
  678. .I Est Start Time
  679. field when the
  680. .I -w
  681. option is not used:
  682. .IP " " 10
  683. .nf
  684. .B Format\ \ \ \ \ \ \ \ \ Job's Estimated Start Time\ \ \ \ \ \ \ \ \ \ \ \ \ Example
  685. -------------------------------------------------------------
  686. <HH>:<MM> Today 15:34
  687. -------------------------------------------------------------
  688. <2-letter Within 7 days, but after today We 15
  689. weekday> <HH>
  690. -------------------------------------------------------------
  691. <3-letter This calendar year, but after this Feb
  692. month name> week
  693. -------------------------------------------------------------
  694. <YYYY> Less than or equal to 5 years from 2018
  695. today, after this year
  696. -------------------------------------------------------------
  697. >5yrs More than 5 years from today >5yrs
  698. -------------------------------------------------------------
  699. .fi
  700. .IP " " 10
  701. The following table shows the format for the
  702. .I Est Start Time
  703. field when the
  704. .I -w
  705. option is used:
  706. .IP " " 10
  707. .nf
  708. .B Format\ \ \ \ \ \ \ \ \ \ \ \ \ \ Job Est Start Time\ \ Example
  709. -------------------------------------------------------------
  710. Today <HH>:<MM> Today Today 13:34
  711. -------------------------------------------------------------
  712. <Day> <HH>:<MM> This week, but Wed 15:34
  713. after today
  714. -------------------------------------------------------------
  715. <Day> <Month> This year, but Wed Feb 10 15:34
  716. <Daynum> <HH>:<MM> after this week
  717. -------------------------------------------------------------
  718. <Day> <Month> After this year Wed Feb 10 2018 15:34
  719. <Daynum> <YYYY>
  720. <HH>:<MM>
  721. -------------------------------------------------------------
  722. .fi
  723. .IP " " 10
  724. When used with the
  725. .I -f
  726. option, prints the full timezone-qualified start time.
  727. Estimated start time information can be made unavailable to unprivileged
  728. users; in this case, the estimated start time appears to be unset.
  729. .IP "-u <user list>" 10
  730. If a
  731. .I destination
  732. is given, status for jobs at that
  733. .I destination
  734. owned by users in
  735. .I <user list>
  736. is displayed.
  737. If a
  738. .I job ID
  739. is given, status information for that job is displayed regardless of the job's
  740. ownership.
  741. .sp
  742. Format:
  743. .I <username>[@<hostname>][, <username>[@<hostname>], ...]
  744. in comma-separated list.
  745. Hostnames may be wildcarded, but not domain names.
  746. When no hostname is specified, username is for any host.
  747. .IP "-w" 10
  748. Allows display of wider fields up to 120 characters. The
  749. .I JobID
  750. column
  751. can be up to 30 characters wide.
  752. .I Username, Queue,
  753. and
  754. .I Jobname
  755. can be
  756. up to 15 characters wide.
  757. .I SessID
  758. can be up to 8 characters wide
  759. and
  760. .I NDS
  761. can be up to 4 characters wide.
  762. .I TSK
  763. can be up to 5 characters wide.
  764. .I Req'd Memory
  765. can be 6 characters,
  766. .I Elap Time
  767. can be 5 characters, and
  768. .I S
  769. can be only 1 character wide.
  770. Can be used only in conjunction with the
  771. .I -a, -n,
  772. or
  773. .I -s
  774. options. This
  775. option is different from the
  776. .I -w
  777. option used with
  778. .I -f.
  779. .IP "-1" 10
  780. Reformats
  781. .B qstat
  782. output to a single line. Can be used only in conjunction with the
  783. .I -n
  784. and/or
  785. .I -s
  786. options.
  787. .LP
  788. .B Queue Status Options
  789. .IP "-Q" 10
  790. Displays queue status in default format.
  791. Operands must be
  792. .I destinations.
  793. .IP "-q" 10
  794. Displays queue status in alternate format.
  795. Operands must be
  796. .I destinations.
  797. .LP
  798. .B Server Status Options
  799. .IP "-B" 10
  800. Display server status.
  801. Operands must be names of servers.
  802. .LP
  803. .B Job, Queue, and Server Status Options
  804. .IP "-f [-w]" 10
  805. Full display. Job, queue or server attributes displayed one to a line.
  806. .br
  807. JSON output: PBS reports
  808. .I resources_used
  809. values for resources that are created or set in a hook as JSON strings
  810. in the output of
  811. .B qstat -f.
  812. If MoM returns a JSON object (a Python dictionary), PBS reports the
  813. value as a string in single quotes:
  814. .br
  815. .I resources_used.<resource_name> = '{ <mom_JSON_item_value>,
  816. .I <mom_JSON_item_value>, <mom_JSON_item_value>, ..}'
  817. .br
  818. Example: MoM returns { "a":1, "b":2, "c":1,"d": 4} for
  819. .I resources_used.foo_str.
  820. We get:
  821. .br
  822. resources_used.foo_str='{"a": 1, "b": 2, "c":1,"d": 4}'
  823. If MoM returns a value that is
  824. not a valid JSON object, the value is reported verbatim.
  825. .br
  826. Example: MoM returns "hello" for
  827. .I resources_used.foo_str.
  828. We get:
  829. .br
  830. resources_used.foo_str="hello"
  831. .br
  832. Optional
  833. .I -w
  834. prints each attribute on one unbroken line. Feed characters are converted:
  835. .RS 13
  836. Newline is converted to backslash concatenated with "n", resulting in "\\n"
  837. .br
  838. Form feed is converted to backslash concatenated with "f", resulting in "\\f"
  839. .RE
  840. .RS 10
  841. This
  842. .I -w
  843. is independent of the
  844. .I -w
  845. job alternate output option.
  846. .RE
  847. .IP "-F dsv [-D <delimiter>]" 10
  848. Prints output in delimiter-separated value format. The default
  849. .I delimiter
  850. is a pipe ("|"). You can specify a character or a string
  851. delimiter using the
  852. .I -D
  853. argument to the
  854. .I -F dsv
  855. option. For example, to use a comma as the delimeter:
  856. .RS 13
  857. .B qstat -f -F dsv -D,
  858. .RE
  859. .RS 10
  860. If the delimiter itself appears in a value, it is escaped:
  861. .RS 3
  862. On Linux, the delimiter is escaped with a backslash ("\\").
  863. .br
  864. On Windows, the delimiter is escaped with a caret ("^").
  865. .RE
  866. .RE
  867. .RS 10
  868. .sp
  869. Feed characters are converted:
  870. .RS 3
  871. Newline is converted to backslash concatenated with "n", resulting in "\\n"
  872. .br
  873. Form feed is converted to backslash concatenated with "f", resulting in "\\f"
  874. .RE
  875. A newline separates each job from the next. Using newline as the
  876. delimiter leads to undefined behavior.
  877. .br
  878. Example of getting output in delimiter-separated value format:
  879. .RS 3
  880. .B qstat -f -Fdsv
  881. Job Id: 1.vbox|Job_Name = STDIN|Job_Owner = root@vbox|job_state = Q|queue = workq|server = vbox|Checkpoint = u|ctime = Fri Nov 11 17:57:05 2016|Error_Path = ...
  882. .RE
  883. .RE
  884. .IP "-F json" 10
  885. Prints output in JSON format (http://www.json.org/).
  886. Attribute output is preceded by timestamp, PBS version, and PBS server hostname.
  887. Example:
  888. .RS 13
  889. .B qstat -F json
  890. {
  891. "timestamp":1479277336,
  892. "pbs_version":"14.1",
  893. "pbs_server":"vbox",
  894. "Jobs":{
  895. "1.vbox":{
  896. "Job_Name":"STDIN",
  897. "Job_Owner":"root@vbox",
  898. "job_state":"Q",
  899. ...
  900. .RE
  901. .IP "-G" 10
  902. Shows size in gigabytes. Triggers alternate format.
  903. .IP "-M" 10
  904. Shows size in megawords. A word is considered to be 8 bytes.
  905. Triggers alternate format.
  906. .LP
  907. .B Version Information
  908. .IP "--version" 8
  909. The
  910. .B qstat
  911. command returns its PBS version information and exits.
  912. This option can only be used alone.
  913. .SH OPERANDS
  914. .B Job Identifier Operands
  915. .br
  916. The
  917. .I job ID
  918. is assigned by PBS at submission.
  919. Job IDs are used only with job status requests.
  920. Status information for specified job(s) is displayed.
  921. Formats:
  922. .IP Job 15
  923. .I <sequence number>[.<server>][@<server>]
  924. .IP "Job array" 15
  925. .I <sequence number>[][.<server>][@<server>]
  926. .IP Subjob 15
  927. .I <sequence number>[<index>][.<server>][@<server>]
  928. .IP "Range of subjobs" 15
  929. .I <sequence number>[<start>-<end>][.<server>][@<server>]
  930. .LP
  931. Note that some shells require that you enclose a job array identifier in
  932. double quotes.
  933. .RE
  934. .LP
  935. .B Destination Operands
  936. .br
  937. Name of queue, name of server, or name of queue at a specific server.
  938. Formats:
  939. .IP "queue name" 15
  940. Specifies name of queue for job or queue display.
  941. .RS 18
  942. When displaying job status, PBS displays status for all jobs in the
  943. specified queue at the default server.
  944. .br
  945. When displaying queue status, PBS displays status for the specified
  946. queue at the default server.
  947. .RE
  948. .IP "queue name@server name" 15
  949. Specifies name of queue at server for job or queue display.
  950. .RS 18
  951. When displaying job status, PBS displays status for all jobs in the
  952. specified queue at the specified server.
  953. .br
  954. When displaying queue status, PBS displays status for the specified
  955. queue at the specified server.
  956. .RE
  957. .IP "@server name" 15
  958. Specifies server name for job or queue display.
  959. .RS 18
  960. When displaying job status, PBS displays status for all jobs at all
  961. queues at the specified server.
  962. .br
  963. When displaying queue status, PBS displays status for all queues at
  964. the specified server.
  965. .RE
  966. .IP "server name"
  967. Specifies server name for server display.
  968. .RS 18
  969. When displaying server status (with the -B option) PBS displays status
  970. for the specified server.
  971. .RE
  972. .LP
  973. .SH STANDARD ERROR
  974. The
  975. .B qstat
  976. command writes a diagnostic message to standard error for
  977. each error occurrence.
  978. .SH EXIT STATUS
  979. .IP Zero 15
  980. Upon successful processing of all operands
  981. .IP "Greater than zero" 15
  982. If any operands could not be processed
  983. .SH SEE ALSO
  984. The
  985. .I PBS Professional User's Guide,
  986. the
  987. .I PBS Professional Administrator's Guide,
  988. .br
  989. qalter(1B), qsub(1B), pbs_alterjob(3B), pbs_statjob(3B), pbs_statque(3B),
  990. pbs_statserver(3B), pbs_submit(3B),
  991. pbs_job_attributes(7B), pbs_queue_attributes(7B), pbs_server_attributes(7B),
  992. pbs_resources(7B)