pbs_queue_attributes.7B 29 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499
  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 pbs_queue_attributes 7B "24 April 2018" Local "PBS Professional"
  37. .SH NAME
  38. pbs_queue_attributes
  39. \- Attributes of PBS queues
  40. .SH DESCRIPTION
  41. Queues have the following attributes:
  42. .IP acl_group_enable 8
  43. Controls whether group access to the queue obeys the access control list defined in
  44. the
  45. .I acl_groups
  46. queue attribute.
  47. .br
  48. Applies to routing and execution queues.
  49. .br
  50. Readable by all; settable by Operator and Manager.
  51. .br
  52. Format:
  53. .I Boolean
  54. .br
  55. Python type:
  56. .I bool
  57. .br
  58. Behavior:
  59. .RS
  60. .IP True 3
  61. Group access to the queue is limited according to the group access control list.
  62. .IP False 3
  63. All groups are allowed access.
  64. .RE
  65. .IP
  66. Default:
  67. .I False
  68. .IP acl_groups 8
  69. List of groups which are allowed or denied access to this queue. The
  70. groups in the list are groups on the server host, not submitting
  71. hosts. List is evaluated left-to-right; first match in list is used.
  72. .br
  73. Applies to routing and execution queues.
  74. .br
  75. Readable by all; settable by Operator and Manager.
  76. .br
  77. Format:
  78. .I String
  79. .br
  80. Syntax: "[+|-]<group name>[, ...]"
  81. .br
  82. Python type:
  83. .I pbs.acl
  84. .br
  85. Default: No default
  86. .IP acl_host_enable 8
  87. Controls whether host access to the queue obeys the access control list defined in
  88. the
  89. .I acl_hosts
  90. queue attribute.
  91. .br
  92. Applies to routing and execution queues.
  93. .br
  94. Readable by all; settable by Operator and Manager.
  95. .br
  96. Format:
  97. .I Boolean
  98. .br
  99. Python type:
  100. .I bool
  101. .br
  102. Behavior:
  103. .RS
  104. .IP True 3
  105. Host access to the queue is limited according to the host access control list.
  106. .IP False 3
  107. All hosts are allowed access.
  108. .RE
  109. .IP
  110. Default:
  111. .I False
  112. .IP acl_hosts 8
  113. List of hosts from which jobs may be submitted to this queue. List is
  114. evaluated left-to-right; first match in list is used.
  115. .br
  116. Applies to routing and execution queues.
  117. .br
  118. Readable by all; settable by Operator and Manager.
  119. .br
  120. Format:
  121. .I String
  122. .br
  123. Syntax: "[+|-]<hostname>[, ...]"
  124. .br
  125. Python type:
  126. .I pbs.acl
  127. .br
  128. Default: No default
  129. .IP acl_user_enable 8
  130. Controls whether user access to the queue obeys the access control list defined in
  131. the
  132. .I acl_users
  133. queue attribute.
  134. .br
  135. Applies to routing and execution queues.
  136. .br
  137. Readable by all; settable by Operator and Manager.
  138. .br
  139. Format:
  140. .I Boolean
  141. .br
  142. Python type:
  143. .I bool
  144. .br
  145. Behavior:
  146. .RS
  147. .IP True 3
  148. User access to the queue is limited according to the user access control list.
  149. .IP False 3
  150. All users are allowed access.
  151. .RE
  152. .IP
  153. Default:
  154. .I False
  155. .IP acl_users 8
  156. List of users which are allowed or denied access to this queue.
  157. List is evaluated left-to-right; first match in list is used.
  158. .br
  159. Applies to routing and execution queues.
  160. .br
  161. Readable by all; settable by Operator and Manager.
  162. .br
  163. Format:
  164. .I String
  165. .br
  166. Syntax: "[+|-]<username>[, ...]"
  167. .br
  168. Python type:
  169. .I pbs.acl
  170. .br
  171. Default: No default
  172. .IP alt_router 8
  173. No longer used.
  174. .IP backfill_depth 8
  175. Modifies backfilling behavior for this queue. Sets the number of jobs
  176. to be backfilled around in this queue. Overrides
  177. .I backfill_depth
  178. server attribute.
  179. .br
  180. Recommendation: set this to less than
  181. .I 100.
  182. .br
  183. Applies to execution queues.
  184. .br
  185. Readable by all; settable by all.
  186. .br
  187. Format:
  188. .I Integer
  189. .br
  190. Valid values: Must be >=0
  191. .br
  192. Behavior:
  193. .RS
  194. .IP ">= 0" 3
  195. PBS backfills around the specified number of jobs.
  196. .IP "Unset" 3
  197. Backfill depth is set to
  198. .I 1.
  199. .RE
  200. .IP
  201. Python type:
  202. .I int
  203. .br
  204. Default: Unset (backfill depth is 1)
  205. .IP checkpoint_min 8
  206. Minimum number of minutes of CPU time or walltime allowed
  207. between checkpoints of a job.
  208. If a user specifies a time less than this
  209. value, this value is used instead. The value given in
  210. .I checkpoint_min
  211. is used for both CPU minutes and walltime minutes.
  212. .br
  213. Applies to execution queues.
  214. .br
  215. Readable by all; settable by Operator and Manager.
  216. .br
  217. Format:
  218. .I Integer
  219. .br
  220. Python type:
  221. .I pbs.duration
  222. .br
  223. Default: No default
  224. .IP default_chunk 8
  225. The list of resources which will be inserted into each chunk of a job's select
  226. specification if the corresponding resource is not specified by the user.
  227. This provides a means for a site to be sure a given resource is properly
  228. accounted for even if not specified by the user.
  229. .br
  230. Applies to execution queues.
  231. .br
  232. Readable by all; settable by Operator and Manager.
  233. .br
  234. Format:
  235. .I String
  236. .br
  237. Syntax:
  238. .RS 11
  239. .nf
  240. .I default_chunk.<resource name>=<value>
  241. .I [, default_chunk.<resource name>=<value>, ...]
  242. .fi
  243. .RE
  244. .IP
  245. Python type:
  246. .I pbs.pbs_resource
  247. .br
  248. Syntax:
  249. .RS 11
  250. default_chunk["<resource name>"]=<value>
  251. .br
  252. where
  253. .I resource name
  254. is any built-in or custom resource
  255. .RE
  256. .IP
  257. Default: No default
  258. .IP enabled 8
  259. Specifies whether this queue accepts new jobs.
  260. .br
  261. Applies to routing and execution queues.
  262. .br
  263. Readable by all; settable by Operator and Manager.
  264. .br
  265. Format:
  266. .I Boolean
  267. .br
  268. Python type:
  269. .I bool
  270. .br
  271. Behavior:
  272. .RS
  273. .IP True 3
  274. This queue is enabled. This queue accepts new jobs; new jobs can be enqueued.
  275. .IP False 3
  276. This queue does not accept new jobs.
  277. .RE
  278. .IP
  279. Default:
  280. .I False
  281. (disabled)
  282. .IP from_route_only 8
  283. Specifies whether this queue accepts jobs only from routing queues, or
  284. from both execution and routing queues.
  285. .br
  286. Applies to routing and execution queues.
  287. .br
  288. Readable by all; settable by Manager.
  289. .br
  290. Format:
  291. .I Boolean
  292. .br
  293. Python type:
  294. .I bool
  295. .br
  296. Behavior:
  297. .RS
  298. .IP True 3
  299. This queue accepts jobs only from routing queues.
  300. .IP False 3
  301. This queue accepts jobs from both execution and routing queues,
  302. as well as directly from submitter.
  303. .RE
  304. .IP
  305. Default:
  306. .I False
  307. .IP hasnodes 8
  308. Indicates whether vnodes are associated with this queue.
  309. .br
  310. Applies to execution queues.
  311. .br
  312. Readable by all; set by PBS.
  313. .br
  314. Format:
  315. .I Boolean
  316. .br
  317. Python type:
  318. .I bool
  319. .br
  320. Behavior:
  321. .RS 11
  322. When
  323. .I True,
  324. there are vnodes associated with this queue.
  325. .RE
  326. .IP
  327. Default:
  328. .I False
  329. .IP kill_delay 8
  330. The time delay between sending SIGTERM and SIGKILL when a qdel command
  331. is issued against a running job.
  332. .br
  333. Applies to execution queues.
  334. .br
  335. Readable by all; settable by Operator and Manager.
  336. .br
  337. Format:
  338. .I Integer
  339. .br
  340. Units:
  341. .I Seconds
  342. .br
  343. Python type:
  344. .I pbs.duration
  345. .br
  346. Valid values: Must be >= 0
  347. .br
  348. Default:
  349. .I 10 seconds
  350. .IP max_array_size 8
  351. The maximum number of subjobs that are allowed in an array job.
  352. .br
  353. Applies to routing and execution queues.
  354. .br
  355. Readable by all; settable by Operator and Manager.
  356. .br
  357. Format:
  358. .I Integer
  359. .br
  360. Python type:
  361. .I int
  362. .br
  363. Default: No default
  364. .IP max_group_res 8
  365. Old limit attribute. Incompatible with new limit attributes.
  366. The maximum amount of the specified resource that any single group may consume
  367. in a complex.
  368. .br
  369. Applies to execution queues.
  370. .br
  371. Readable by all; settable by Operator and Manager.
  372. .br
  373. Format:
  374. .I String
  375. .br
  376. Syntax:
  377. .I max_group_res.<resource name>=<value>
  378. .br
  379. Python type:
  380. .I pbs.pbs_resource
  381. .br
  382. Syntax:
  383. .RS 11
  384. max_group_res["<resource name>"]=<value>
  385. .br
  386. where
  387. .I resource name
  388. is any built-in or custom resource
  389. .RE
  390. .IP
  391. Valid values: Any PBS resource, e.g. "ncpus", "mem", "pmem"
  392. .br
  393. Example:
  394. .I set server max_group_res.ncpus=6
  395. .br
  396. Default: No default
  397. .IP max_group_res_soft 8
  398. Old limit attribute. Incompatible with new limit attributes.
  399. The soft limit on the amount of the specified resource that any single group may consume
  400. in a complex.
  401. If a group is consuming more than this amount of the specified resource,
  402. their jobs are eligible to be preempted by jobs from groups who are not over
  403. their soft limit.
  404. .br
  405. Applies to execution queues.
  406. .br
  407. Readable by all; settable by Operator and Manager.
  408. .br
  409. Format:
  410. .I String
  411. .br
  412. Syntax:
  413. .I max_group_res_soft.<resource name>=<value>
  414. .br
  415. Python type:
  416. .I pbs.pbs_resource
  417. .br
  418. Syntax:
  419. .RS 11
  420. max_group_res_soft["<resource name>"]=<value>
  421. .br
  422. where
  423. .I resource name
  424. is any built-in or custom resource
  425. .RE
  426. .IP
  427. Valid values: Any PBS resource, e.g. "ncpus", "mem", "pmem"
  428. .br
  429. Example:
  430. .I set queue workq max_group_res_soft.ncpus=3
  431. .br
  432. Default: No default
  433. .IP max_group_run 8
  434. Old limit attribute. Incompatible with new limit attributes.
  435. The maximum number of jobs owned by a group that are
  436. allowed to be running from this queue at one time.
  437. .br
  438. Applies to execution queues.
  439. .br
  440. Readable by all; settable by Operator and Manager.
  441. .br
  442. Format:
  443. .I Integer
  444. .br
  445. Python type:
  446. .I int
  447. .br
  448. Default: No default
  449. .IP max_group_run_soft 8
  450. Old limit attribute. Incompatible with new limit attributes.
  451. The maximum number of jobs owned by users in a single group that are
  452. allowed to be running from this queue at one time.
  453. If a group has more than this number of jobs
  454. running, their jobs are eligible to be preempted by jobs from groups who are not over
  455. their soft limit.
  456. .br
  457. Applies to execution queues.
  458. .br
  459. Readable by all; settable by Operator and Manager.
  460. .br
  461. Format:
  462. .I Integer
  463. .br
  464. Python type:
  465. .I int
  466. .br
  467. Default: No default
  468. .IP max_queuable 8
  469. Old limit attribute. Incompatible with new limit attributes.
  470. The maximum number of jobs allowed to reside in this queue at any given time.
  471. .br
  472. Applies to routing and execution queues.
  473. .br
  474. Readable by all; settable by Operator and Manager.
  475. .br
  476. Format:
  477. .I Integer
  478. .br
  479. Python type:
  480. .I int
  481. .br
  482. Default: No default (no limit)
  483. .IP max_queued 8
  484. Limit attribute. The maximum number of jobs allowed to be queued
  485. in or running from this queue. Can be specified for projects, users, groups, or all.
  486. Cannot be used with old limit attributes.
  487. .br
  488. Applies to routing and execution queues.
  489. .br
  490. Readable by all; settable by Operator and Manager.
  491. .br
  492. .br
  493. Format:
  494. .I Limit specification.
  495. See
  496. .B FORMATS.
  497. .br
  498. Python type:
  499. .I pbs.pbs_resource
  500. .br
  501. Syntax:
  502. .RS 11
  503. max_queued["<resource name>"]=<value>
  504. .br
  505. where
  506. .I resource name
  507. is any built-in or custom resource
  508. .RE
  509. .IP
  510. Default: No default
  511. .IP max_queued_res 8
  512. Limit attribute. The maximum amount of the specified resource
  513. allowed to be allocated to jobs queued in or running from this queue.
  514. Can be specified for projects, users, groups, or all.
  515. Cannot be used with old limit attributes.
  516. .br
  517. Applies to routing and execution queues.
  518. .br
  519. Readable by all; settable by Operator and Manager.
  520. .br
  521. Format:
  522. .I Limit specification.
  523. See
  524. .B FORMATS.
  525. .br
  526. Syntax:
  527. .I max_queued_res.<resource name>=<value>
  528. .br
  529. Python type:
  530. .I pbs.pbs_resource
  531. .br
  532. Syntax:
  533. .RS 11
  534. max_queued_res["<resource name>"]=<value>
  535. .br
  536. where
  537. .I resource name
  538. is any built-in or custom resource
  539. .RE
  540. .IP
  541. Valid values: Any PBS resource, e.g. "ncpus", "mem", "pmem"
  542. .br
  543. Example:
  544. .I set queue workq max_queued_res.ncpus=4
  545. .br
  546. Default: No default
  547. .IP max_run 8
  548. Limit attribute. The maximum number of jobs allowed to be running
  549. from this queue. Can be specified for projects, users, groups, or all.
  550. Cannot be used with old limit attributes.
  551. .br
  552. Applies to routing and execution queues.
  553. .br
  554. Readable by all; settable by Operator and Manager.
  555. .br
  556. Format:
  557. .I Limit specification.
  558. See
  559. .B FORMATS.
  560. .br
  561. Python type:
  562. .I pbs.pbs_resource
  563. .br
  564. Syntax:
  565. .RS 11
  566. max_run["<resource name>"]=<value>
  567. .br
  568. where
  569. .I resource name
  570. is any built-in or custom resource
  571. .RE
  572. .IP
  573. Default: No default
  574. .IP max_run_res 8
  575. Limit attribute. The maximum amount of the specified resource
  576. allowed to be allocated to jobs running from this queue.
  577. Can be specified for projects, users, groups, or all.
  578. Cannot be used with old limit attributes.
  579. .br
  580. Applies to execution queues.
  581. .br
  582. Readable by all; settable by Operator and Manager.
  583. .br
  584. Format:
  585. .I Limit specification.
  586. See
  587. .B FORMATS.
  588. .br
  589. Syntax:
  590. .I max_run_res.<resource name>=<value>
  591. .br
  592. Python type:
  593. .I pbs.pbs_resource
  594. .br
  595. Syntax:
  596. .RS 11
  597. max_run_res["<resource name>"]=<value>
  598. .br
  599. where
  600. .I resource name
  601. is any built-in or custom resource
  602. .RE
  603. .IP
  604. Valid values: Any PBS resource, e.g. "ncpus", "mem", "pmem"
  605. .br
  606. Example:
  607. .I set queue workq max_run_res.ncpus=4
  608. .br
  609. Default: No default
  610. .IP max_run_res_soft 8
  611. Limit attribute. Soft limit on the amount of the specified resource
  612. allowed to be allocated to jobs running from this queue.
  613. Can be specified for projects, users, groups, or all.
  614. Cannot be used with old limit attributes.
  615. .br
  616. Applies to execution queues.
  617. .br
  618. Readable by all; settable by Operator and Manager.
  619. .br
  620. Format:
  621. .I Limit specification.
  622. See
  623. .B FORMATS.
  624. .br
  625. Syntax:
  626. .I max_run_res_soft.<resource name>=<value>
  627. .br
  628. Python type:
  629. .I pbs.pbs_resource
  630. .br
  631. Syntax:
  632. .RS 11
  633. max_run_res_soft["<resource name>"]=<value>
  634. .br
  635. where
  636. .I resource name
  637. is any built-in or custom resource
  638. .RE
  639. .IP
  640. Valid values: Any PBS resource, e.g. "ncpus", "mem", "pmem"
  641. .br
  642. Example:
  643. .I set queue workq max_run_res_soft.ncpus=2
  644. .br
  645. Default: No default
  646. .IP max_run_soft 8
  647. Limit attribute. Soft limit on the number of jobs allowed to be running
  648. from this queue. Can be specified for projects, users, groups, or all.
  649. Cannot be used with old limit attributes.
  650. .br
  651. Applies to execution queues.
  652. .br
  653. Readable by all; settable by Operator and Manager.
  654. .br
  655. Format:
  656. .I Limit specification.
  657. See
  658. .B FORMATS.
  659. .br
  660. Python type:
  661. .I pbs.pbs_resource
  662. .br
  663. Syntax:
  664. .RS 11
  665. max_run_soft["<resource name>"]=<value>
  666. .br
  667. where
  668. .I resource name
  669. is any built-in or custom resource
  670. .RE
  671. .IP
  672. Default: No default
  673. .IP max_running 8
  674. Old limit attribute. Incompatible with new limit attributes.
  675. For an execution queue, this is the largest number of jobs allowed to
  676. be running at any given time. For a routing queue, this is the largest
  677. number of jobs allowed to be transiting from this queue at any given
  678. time.
  679. .br
  680. Applies to routing and execution queues.
  681. .br
  682. Readable by all; settable by Operator and Manager.
  683. .br
  684. Format:
  685. .I Integer
  686. .br
  687. Python type:
  688. .I int
  689. .br
  690. Default: No default
  691. .IP max_user_res 8
  692. Old limit attribute. Incompatible with new limit attributes.
  693. The maximum amount of the specified resource that any single user may consume.
  694. .br
  695. Applies to execution queues.
  696. .br
  697. Readable by all; settable by Operator and Manager.
  698. .br
  699. Format:
  700. .I String
  701. .br
  702. Syntax:
  703. .I max_user_res.<resource name>=<value>
  704. .br
  705. Python type:
  706. .I pbs.pbs_resource
  707. .br
  708. Syntax:
  709. .RS 11
  710. max_user_res["<resource name>"]=<value>
  711. .br
  712. where
  713. .I resource name
  714. is any built-in or custom resource
  715. .RE
  716. .IP
  717. Valid values: Any PBS resource, e.g. "ncpus", "mem", "pmem"
  718. .br
  719. Example:
  720. .I set queue workq max_user_res.ncpus=2
  721. .br
  722. Default: No default
  723. .IP max_user_res_soft 8
  724. Old limit attribute. Incompatible with new limit attributes.
  725. The soft limit on the amount of the specified resource that any single user may consume.
  726. If a user is consuming more than this amount of the specified resource,
  727. their jobs are eligible to be preempted by jobs from users who are not over
  728. their soft limit.
  729. .br
  730. Applies to execution queues.
  731. .br
  732. Readable by all; settable by Operator and Manager.
  733. .br
  734. Format:
  735. .I String
  736. .br
  737. Syntax:
  738. .I max_user_res_soft.<resource name>=<value>
  739. .br
  740. Python type:
  741. .I pbs.pbs_resource
  742. .br
  743. Syntax:
  744. .RS 11
  745. max_user_res_soft["<resource name>"]=<value>
  746. .br
  747. where
  748. .I resource name
  749. is any built-in or custom resource
  750. .RE
  751. .IP
  752. Valid values: Any PBS resource, e.g. "ncpus", "mem", "pmem"
  753. .br
  754. Example:
  755. .I set queue workq max_user_res_soft.ncpus=2
  756. .br
  757. Default: No default
  758. .IP max_user_run 8
  759. Old limit attribute. Incompatible with new limit attributes.
  760. The maximum number of jobs owned by a single user that are allowed to be
  761. running from this queue at one time.
  762. .br
  763. Applies to execution queues.
  764. .br
  765. Readable by all; settable by Operator and Manager.
  766. .br
  767. Format:
  768. .I Integer
  769. .br
  770. Python type:
  771. .I int
  772. .br
  773. Default: No default
  774. .IP max_user_run_soft 8
  775. Old limit attribute. Incompatible with new limit attributes.
  776. The soft limit on the number of jobs owned by any single user that are allowed to be
  777. running from this queue at one time. If a user has more than this number of jobs
  778. running, their jobs are eligible to be preempted by jobs from users who are not over
  779. their soft limit.
  780. .br
  781. Applies to execution queues.
  782. .br
  783. Readable by all; settable by Operator and Manager.
  784. .br
  785. Format:
  786. .I Integer
  787. .br
  788. Python type:
  789. .I int
  790. .br
  791. Default: No default
  792. .IP node_group_key 8
  793. Specifies the resources to use for placement sets. Overrides server's
  794. .I node_group_key
  795. attribute. Specified resources must be of type
  796. .I string_array.
  797. .br
  798. Applies to routing and execution queues.
  799. .br
  800. Readable by all; settable by Operator and Manager.
  801. .br
  802. Format:
  803. .I string_array
  804. .br
  805. Syntax:
  806. .RS 11
  807. .I Comma-separated list of resource names.
  808. .br
  809. When specifying multiple resources, enclose value in double quotes.
  810. .RE
  811. .IP
  812. Python type:
  813. .I pbs.node_group_key
  814. .br
  815. Example:
  816. .RS 11
  817. Qmgr> set queue workq node_group_key=<resource name>
  818. .RE
  819. .IP
  820. Default: No default
  821. .IP partition 8
  822. Name of partition to which this queue is assigned. Cannot be set for
  823. routing queue. An execution queue cannot be changed to a routing
  824. queue while this attribute is set.
  825. .br
  826. Applies to execution queues.
  827. .br
  828. Readable by all; settable by Manager.
  829. .br
  830. Format:
  831. .I String
  832. .br
  833. Python type:
  834. .I str
  835. .br
  836. Default: No default
  837. .IP Priority 8
  838. The priority of this queue compared to other queues of the same type
  839. in this PBS complex. Priority can define a queue as an express queue. See
  840. .I preempt_queue_prio
  841. in the pbs_sched(8B) man page. Used for execution queues only; the value
  842. of
  843. .I Priority
  844. has no meaning for routing queues.
  845. .br
  846. Applies to execution queues.
  847. .br
  848. Readable by all; settable by Operator and Manager.
  849. .br
  850. Format:
  851. .I Integer
  852. .br
  853. Valid values: -1024 to 1023
  854. .br
  855. Python type:
  856. .I int
  857. .br
  858. Default: No default
  859. .IP queued_jobs_threshold 8
  860. Limit attribute. The maximum number of jobs allowed
  861. to be queued in this queue. Can be specified for
  862. projects, users, groups, or all. Cannot be used with old limit
  863. attributes.
  864. .br
  865. Applies to routing and execution queues.
  866. .br
  867. Readable by all; settable by Operator and Manager.
  868. .br
  869. Format:
  870. .I Limit specification;
  871. See
  872. .B LIMITS
  873. .br
  874. Python type:
  875. .I pbs.pbs_resource
  876. .br
  877. Syntax:
  878. .RS 11
  879. queued_jobs_threshold["<resource name>"]=<value>
  880. .br
  881. where
  882. .I resource name
  883. is any built-in or custom resource
  884. .RE
  885. .IP
  886. Default: No default
  887. .IP queued_jobs_threshold_res 8
  888. Limit attribute. The maximum amount of the specified resource allowed
  889. to be allocated to jobs queued in this queue. Can be specified for
  890. projects, users, groups, or all. Cannot be used with old limit
  891. attributes.
  892. .br
  893. Applies to routing and execution queues.
  894. .br
  895. Readable by all; settable by Operator and Manager.
  896. .br
  897. Format:
  898. .I limit specification.
  899. See
  900. .B LIMITS
  901. .br
  902. Syntax:
  903. .I queued_jobs_threshold_res.<resource name>=<value>
  904. .br
  905. Python type:
  906. .I pbs.pbs_resource
  907. .br
  908. Syntax:
  909. .RS 11
  910. queued_jobs_threshold_res_["<resource name>"]=<value>
  911. .br
  912. where
  913. .I resource name
  914. is any built-in or custom resource
  915. .RE
  916. .IP
  917. Valid values: Any PBS resource, e.g. "ncpus", "mem", "pmem"
  918. .br
  919. Example:
  920. .I set queue workq queued_jobs_threshold_res.ncpus=8
  921. .br
  922. Default: No default
  923. .IP queue_type 8
  924. The type of the queue. This attribute must be explicitly set
  925. at queue creation.
  926. .br
  927. Applies to routing and execution queues.
  928. .br
  929. Readable by all; settable by Operator and Manager.
  930. .br
  931. Format:
  932. .I String
  933. .br
  934. Python type:
  935. .RS 11
  936. PBS queue type constant:
  937. .I pbs.QUEUETYPE_EXECUTION
  938. or
  939. .I pbs.QUEUETYPE_ROUTE
  940. .RE
  941. .IP
  942. Valid values: "e", "execution", "r", "route"
  943. .br
  944. Default: No default
  945. .IP require_cred 8
  946. Specifies the credential type required. All jobs submitted to the named
  947. queue without the specified credential will be rejected.
  948. .br
  949. Not supported under Windows.
  950. .br
  951. Applies to routing and execution queues.
  952. .br
  953. Readable by all; settable by Manager.
  954. .br
  955. Format:
  956. .I String
  957. .br
  958. Python type:
  959. .I str
  960. .br
  961. Valid values:
  962. .I krb5
  963. or
  964. .I dce
  965. .br
  966. Default: Unset
  967. .IP require_cred_enable 8
  968. Specifies whether the credential authentication method specified in the
  969. .I require_cred
  970. queue attribute is required for this queue.
  971. .br
  972. Not supported under Windows.
  973. .br
  974. Applies to routing and execution queues.
  975. .br
  976. Readable by all; settable by Manager.
  977. .br
  978. Format:
  979. .I Boolean
  980. .br
  981. Python type:
  982. .I bool
  983. .br
  984. Behavior:
  985. .RS 11
  986. When set to
  987. .I True,
  988. the credential authentication method is required.
  989. .RE
  990. .IP
  991. Default:
  992. .I False
  993. .IP resources_assigned 8
  994. The total for each kind of resource allocated to running and
  995. exiting jobs in this queue.
  996. .br
  997. Applies to execution queues.
  998. .br
  999. Readable by all; set by PBS.
  1000. .br
  1001. Format:
  1002. .I String
  1003. .br
  1004. Syntax:
  1005. .RS 11
  1006. .nf
  1007. .I resources_assigned.<resource name>=<value><newline>
  1008. .I resources_assigned.<resource name>=<value><newline> ...
  1009. .fi
  1010. .RE
  1011. .IP
  1012. Python type:
  1013. .I pbs.pbs_resource
  1014. .br
  1015. Syntax:
  1016. .RS 11
  1017. resources_assigned["<resource name>"]=<value>
  1018. .br
  1019. where
  1020. .I resource name
  1021. is any built-in or custom resource
  1022. .RE
  1023. .IP
  1024. Default value: No default
  1025. .IP resources_available 8
  1026. The list of resources and amounts available to jobs running in this
  1027. queue. The sum of the resource of each type used by all jobs running
  1028. from this queue cannot exceed the total amount listed here. See the
  1029. .I qmgr(1B)
  1030. man page.
  1031. .br
  1032. Applies to execution queues.
  1033. .br
  1034. Readable by all; settable by Operator and Manager.
  1035. .br
  1036. Format:
  1037. .I String
  1038. .br
  1039. Syntax:
  1040. .RS 11
  1041. .nf
  1042. .I resources_available.<resource name>=<value><newline>
  1043. .I resources_available.<resource name>=<value><newline> ...
  1044. .fi
  1045. .RE
  1046. .IP
  1047. Python type:
  1048. .I pbs.pbs_resource
  1049. .br
  1050. Syntax:
  1051. .RS 11
  1052. resources_available["<resource name>"]=<value>
  1053. .br
  1054. where
  1055. .I resource name
  1056. is any built-in or custom resource
  1057. .RE
  1058. .IP
  1059. Default value: No default
  1060. .IP resources_default 8
  1061. The list of default resource values which are set as limits for a job
  1062. residing in this queue and for which the job did not specify a limit.
  1063. If not explicitly set, the default limit for a job is determined by
  1064. the first of the following attributes which is set: server's
  1065. .I resources_default,
  1066. queue's
  1067. .I resources_max,
  1068. server's
  1069. .I resources_max.
  1070. If none of these is set, the job gets unlimited resource usage.
  1071. .br
  1072. Applies to routing and execution queues.
  1073. .br
  1074. Readable by all; settable by Operator and Manager.
  1075. .br
  1076. Format:
  1077. .I String
  1078. .br
  1079. Syntax:
  1080. .RS 11
  1081. .nf
  1082. .I resources_default.<resource name>=<value>,
  1083. .I resources_default.<resource name>=<value>, ...
  1084. .fi
  1085. .RE
  1086. .IP
  1087. Python type:
  1088. .I pbs.pbs_resource
  1089. .br
  1090. Syntax:
  1091. .RS 11
  1092. resources_default["<resource name>"]=<value>
  1093. .br
  1094. where
  1095. .I resource name
  1096. is any built-in or custom resource
  1097. .RE
  1098. .IP
  1099. Default value: No default
  1100. .IP resources_max 8
  1101. The maximum amount of each resource that can be requested by a single job
  1102. in this queue. The queue value supersedes any server wide maximum limit.
  1103. .br
  1104. Applies to routing and execution queues.
  1105. .br
  1106. Readable by all; settable by Operator and Manager.
  1107. .br
  1108. Format:
  1109. .I String
  1110. .br
  1111. Syntax:
  1112. .RS 11
  1113. .nf
  1114. .I resources_max.<resource name>=<value>,
  1115. .I resources_max.<resource name>=<value>, ...
  1116. .fi
  1117. .RE
  1118. .IP
  1119. Python type:
  1120. .I pbs.pbs_resource
  1121. .br
  1122. Syntax:
  1123. .RS 11
  1124. resources_max["<resource name>"]=<value>
  1125. .br
  1126. where
  1127. .I resource name
  1128. is any built-in or custom resource
  1129. .RE
  1130. .IP
  1131. Default value: No default (infinite usage)
  1132. .IP resources_min 8
  1133. The minimum amount of each resource that can be requested by a single job
  1134. in this queue.
  1135. .br
  1136. Applies to routing and execution queues.
  1137. .br
  1138. Readable by all; settable by Operator and Manager.
  1139. .br
  1140. Format:
  1141. .I String
  1142. .br
  1143. Syntax:
  1144. .RS 11
  1145. .nf
  1146. .I resources_min.<resource name>=<value>,
  1147. .I resources_min.<resource name>=<value>, ...
  1148. .fi
  1149. .RE
  1150. .IP
  1151. Python type:
  1152. .I pbs.pbs_resource
  1153. .br
  1154. Syntax:
  1155. .RS 11
  1156. resources_min["<resource name>"]=<value>
  1157. .br
  1158. where
  1159. .I resource name
  1160. is any built-in or custom resource
  1161. .RE
  1162. .IP
  1163. Default value: No default (zero usage)
  1164. .IP route_destinations 8
  1165. The list of destinations to which jobs may be routed.
  1166. .br
  1167. Must be set to at least one valid destination.
  1168. .br
  1169. Applies to routing queues.
  1170. .br
  1171. Readable by all; settable by Manager.
  1172. .br
  1173. Format:
  1174. .I String
  1175. .br
  1176. Syntax:
  1177. .RS 11
  1178. List of comma-separated strings:
  1179. .br
  1180. .I <queue name>[@<server host>[:<port>]]
  1181. .RE
  1182. .IP
  1183. Python type:
  1184. .I pbs.route_destinations
  1185. .br
  1186. Example:
  1187. .I Q1,Q2@remote,Q3@remote:15501
  1188. .br
  1189. Default: No default
  1190. .IP route_held_jobs 8
  1191. Specifies whether jobs in the
  1192. .I held
  1193. state can be routed from this queue.
  1194. .br
  1195. Applies to routing queues.
  1196. .br
  1197. Readable by all; settable by Operator and Manager.
  1198. .br
  1199. Format:
  1200. .I Boolean
  1201. .br
  1202. Python type:
  1203. .I bool
  1204. .br
  1205. Behavior:
  1206. .RS 11
  1207. When
  1208. .I True,
  1209. jobs with a hold can be routed from this queue.
  1210. .RE
  1211. .IP
  1212. Default:
  1213. .I False
  1214. .IP route_lifetime 8
  1215. The maximum time a job is allowed to reside in this routing queue. If a job
  1216. cannot be routed in this amount of time, the job is aborted.
  1217. .br
  1218. Applies to routing queues.
  1219. .br
  1220. Readable by all; settable by Operator and Manager.
  1221. .br
  1222. Format:
  1223. .I Integer
  1224. .br
  1225. Units:
  1226. .I Seconds
  1227. .br
  1228. Python type:
  1229. .I pbs.duration
  1230. .br
  1231. Behavior:
  1232. .RS
  1233. .IP >0 3
  1234. Jobs can reside for specified number of seconds
  1235. .IP "0 or unset" 3
  1236. Jobs can reside for infinite time
  1237. .RE
  1238. .IP
  1239. Default: Unset
  1240. .IP route_retry_time 8
  1241. Time delay between routing retries. Typically used when the network between
  1242. servers is down.
  1243. .br
  1244. Applies to routing queues.
  1245. .br
  1246. Readable by all; settable by Operator and Manager.
  1247. .br
  1248. Format:
  1249. .I Integer
  1250. .br
  1251. Units:
  1252. .I Seconds
  1253. .br
  1254. Python type:
  1255. .I pbs.duration
  1256. .br
  1257. Default:
  1258. .I 30 seconds
  1259. .IP route_waiting_jobs 8
  1260. Specifies whether jobs whose
  1261. .I Execution_Time
  1262. attribute value is in the future can be routed from this queue.
  1263. .br
  1264. Applies to routing queues.
  1265. .br
  1266. Readable by all; settable by Operator and Manager.
  1267. .br
  1268. Format:
  1269. .I Boolean
  1270. .br
  1271. Python type:
  1272. .I bool
  1273. Behavior:
  1274. .RS 11
  1275. When
  1276. .I True,
  1277. jobs with a future
  1278. .I Execution_Time
  1279. can be routed from this queue.
  1280. .RE
  1281. .IP
  1282. Default:
  1283. .I False
  1284. .IP started 8
  1285. Specifies whether jobs in this queue can be scheduled for execution.
  1286. .br
  1287. Applies to routing and execution queues.
  1288. .br
  1289. Readable by all; settable by Operator and Manager.
  1290. .br
  1291. Format:
  1292. .I Boolean
  1293. .br
  1294. Python type:
  1295. .I bool
  1296. .br
  1297. Behavior: When
  1298. .I True,
  1299. jobs in this queue can run.
  1300. .br
  1301. Default:
  1302. .I False
  1303. .IP state_count 8
  1304. The total number of jobs in each state currently residing in this queue.
  1305. .br
  1306. Applies to routing and execution queues.
  1307. .br
  1308. Readable by all; set by PBS.
  1309. .br
  1310. Format:
  1311. .I String
  1312. .br
  1313. Syntax:
  1314. .I transiting=<value>,exiting=<value>, ...
  1315. .br
  1316. Python type:
  1317. .I pbs.state_count
  1318. .br
  1319. Default: No default
  1320. .IP total_jobs 8
  1321. The number of jobs currently residing in this queue.
  1322. .br
  1323. Applies to routing and execution queues.
  1324. .br
  1325. Readable by all; set by PBS.
  1326. .br
  1327. Format:
  1328. .I Integer
  1329. .br
  1330. Python type:
  1331. .I int
  1332. .br
  1333. Default: No default
  1334. .SH FORMATS
  1335. .IP "Limit specification" 8
  1336. Limit attributes can be set, added to, or removed from.
  1337. Format for setting a limit specification:
  1338. .RS 11
  1339. .nf
  1340. set server <limit attribute> = "<limit specification>=<limit>[, <limit specification>=<limit>] ..."
  1341. .fi
  1342. .RE
  1343. .IP
  1344. Format for adding to a limit specification:
  1345. .RS 11
  1346. .nf
  1347. set server <limit attribute> += "<limit specification>=<limit>[, <limit specification>=<limit>] ..."
  1348. .fi
  1349. .RE
  1350. .IP
  1351. Format for removing from a limit specification:
  1352. .RS 11
  1353. .nf
  1354. set server <limit attribute> -= "<limit specification>=<limit>[, [<limit specification>=<limit>] ..."
  1355. .br
  1356. or
  1357. .br
  1358. set server <limit attribute> -= "<limit specification>[, <limit specification>] ..."
  1359. .fi
  1360. .RE
  1361. .IP
  1362. Where
  1363. .I limit specification
  1364. is
  1365. .RS 11
  1366. o:PBS_ALL Overall limit
  1367. .br
  1368. u:PBS_GENERIC Generic users
  1369. .br
  1370. u:<username> A specific user
  1371. .br
  1372. g:PBS_GENERIC Generic groups
  1373. .br
  1374. g:<group name> A specific group
  1375. .br
  1376. p:PBS_GENERIC Generic projects
  1377. .br
  1378. p:<project name> A specific project
  1379. .RE
  1380. .IP
  1381. The
  1382. .I limit specification
  1383. can contain spaces anywhere except after the colon
  1384. (":").
  1385. .br
  1386. If there are comma-separated
  1387. .I limit specifications,
  1388. the entire string must be enclosed in double quotes.
  1389. .br
  1390. A username, groupname, or project name containing spaces must be
  1391. enclosed in quotes.
  1392. .br
  1393. If a username, groupname, or project name is quoted using double
  1394. quotes, and the entire string requires quotes, the outer enclosing
  1395. quotes must be single quotes. Similarly, if the inner quotes are
  1396. single quotes, the outer quotes must be double quotes.
  1397. .br
  1398. .I PBS_ALL
  1399. is a keyword which indicates that this limit applies to the usage total.
  1400. .br
  1401. .I PBS_GENERIC
  1402. is a keyword which indicates that this limit applies to
  1403. generic users, groups, or projects.
  1404. .br
  1405. When removing a limit, the
  1406. .I limit value
  1407. does not need to be specified.
  1408. .br
  1409. For example, to set the
  1410. .I max_queued
  1411. limit on QueueA to 5 for total usage, and to limit user bill to 3:
  1412. .RS 11
  1413. s q QueueA max_queued = "[o:PBS_ALL=5], [u:bill =3]"
  1414. .RE
  1415. .IP
  1416. Examples of setting, adding, and removing:
  1417. .br
  1418. .RS 11
  1419. set server max_run="[u:PBS_GENERIC=2], [g:group1=10], [o:PBS_ALL = 100]"
  1420. .br
  1421. set server max_run+="[u:user1=3], [g:PBS_GENERIC=8]"
  1422. .br
  1423. set server max_run-="[u:user2], [g:group3]"
  1424. .br
  1425. set server max_run_res.ncpus="[u:PBS_GENERIC=2], [g:group1=8], [o:PBS_ALL = 64]"
  1426. .RE
  1427. .IP
  1428. See the
  1429. .I PBS Professional Administrator's Guide.
  1430. .SH Incompatible Limit Attributes
  1431. The old and new limit attributes are incompatible.
  1432. If any of one kind is set, none of the other kind can be set.
  1433. All of one kind must be unset in order to set any of the other kind.
  1434. .br
  1435. .SH SEE ALSO
  1436. The
  1437. .I PBS Professional Administrator's Guide,
  1438. qmgr(1B)