1qsub(1B) PBS qsub(1B)
2
6 qsub - submit pbs job
7
9 qsub [-a date_time] [-A account_string] [-b secs] [-c check‐
10 point_options] [-C directive_prefix] [-d path] [-D path] [-e path] [-f]
11 [-h] [-I] [-j join] [-k keep] [-l resource_list] [-m mail_options] [-M
12 user_list] [-n node exclusive] [-N name] [-o path] [-p priority] [-P
13 proxy_username[:group]] [-q destination] [-r c] [-S path_list] [-t
14 array_request] [-T prologue/epilogue script_name] [-u user_list] [-v
15 variable_list] [-V] [-w] path [-W additional_attributes] [-x] [-X] [-z]
16 [script]
17
19 To create a job is to submit an executable script to a batch server.
20 The batch server will be the default server unless the -q option is
21 specified. See discussion of PBS_DEFAULT under Environment Variables
22 below. Typically, the script is a shell script which will be executed
23 by a command shell such as sh or csh.
24 Options on the qsub command allow the specification of attributes which
26 affect the behavior of the job.
27 The qsub command will pass certain environment variables in the Vari‐
29 able_List attribute of the job. These variables will be available to
30 the job. The value for the following variables will be taken from the
31 environment of the qsub command: HOME, LANG, LOGNAME, PATH, MAIL,
32 SHELL, and TZ. These values will be assigned to a new name which is
33 the current name prefixed with the string "PBS_O_". For example, the
34 job will have access to an environment variable named PBS_O_HOME which
35 have the value of the variable HOME in the qsub command environment.
36 In addition to the above, the following environment variables will be
38 available to the batch job.
39 PBS_O_HOST
41 the name of the host upon which the qsub command is running.
42 PBS_SERVER
44 the hostname of the pbs_server which qsub submits the job to.
45 PBS_O_QUEUE
47 the name of the original queue to which the job was submitted.
48 PBS_O_WORKDIR
50 the absolute path of the current working directory of the qsub
51 command.
52 PBS_ARRAYID
54 each member of a job array is assigned a unique identifier (see
55 -t)
56 PBS_ENVIRONMENT
58 set to PBS_BATCH to indicate the job is a batch job, or to
59 PBS_INTERACTIVE to indicate the job is a PBS interactive job,
60 see -I option.
61 PBS_JOBID
63 the job identifier assigned to the job by the batch system.
64 PBS_JOBNAME
66 the job name supplied by the user.
67 PBS_NODEFILE
69 the name of the file contain the list of nodes assigned to the
70 job (for parallel and cluster systems).
71 PBS_QUEUE
73 the name of the queue from which the job is executed.
74
76 -a date_time
77 Declares the time after which the job is eligible for execu‐
78 tion.
79 The date_time argument is in the form:
81 [[[[CC]YY]MM]DD]hhmm[.SS]
82 Where CC is the first two digits of the year (the century), YY
84 is the second two digits of the year, MM is the two digits for
85 the month, DD is the day of the month, hh is the hour, mm is
86 the minute, and the optional SS is the seconds.
87 If the month, MM, is not specified, it will default to the cur‐
89 rent month if the specified day DD, is in the future. Other‐
90 wise, the month will be set to next month. Likewise, if the
91 day, DD, is not specified, it will default to today if the time
92 hhmm is in the future. Otherwise, the day will be set to
93 tomorrow. For example, if you submit a job at 11:15am with a
94 time of -a 1110, the job will be eligible to run at 11:10am
95 tomorrow.
96 -A account_string
98 Defines the account string associated with the job. The
99 account_string is an undefined string of characters and is
100 interpreted by the server which executes the job. See section
101 2.7.1 of the PBS ERS.
102 -b seconds
104 Defines the maximum number of seconds qsub will block attempt‐
105 ing to contact pbs_server. If pbs_server is down, or for a
106 variety of communication failures, qsub will continually retry
107 connecting to pbs_server for job submission. This value over‐
108 rides the CLIENTRETRY parameter in torque.cfg. This is a non-
109 portable TORQUE extension. Portability-minded users can use
110 the PBS_CLIENTRETRY environmental variable. A negative value
111 is interpreted as infinity. The default is 0.
112 -c checkpoint_options
114 Defines the options that will apply to the job. If the job
115 executes upon a host which does not support checkpoint, these
116 options will be ignored.
117 Valid checkpoint options are:
119 none
121 No checkpointing is to be performed.
122 enabled
124 Specify that checkpointing is allowed but must be explicitly
125 invoked by either the qhold or qchkpt commands.
126 shutdown
128 Specify that checkpointing is to be done on a job at pbs_mom
129 shutdown.
130 periodic
132 Specify that periodic checkpointing is enabled. The default
133 interval is 10 minutes and can be changed by the $check‐
134 point_interval option in the mom config file or by specify‐
135 ing an interval when the job is submitted
136 interval=minutes
138 Checkpointing is to be performed at an interval of minutes,
139 which is the integer number of minutes of wall time used by
140 the job. This value must be greater than zero.
141 depth=number
143 Specify a number (depth) of checkpoint images to be kept in
144 the checkpoint directory.
145 dir=path
147 Specify a checkpoint directory (default is
148 /var/spool/torque/checkpoint).
149 -C directive_prefix
151 Defines the prefix that declares a directive to the qsub com‐
152 mand within the script file. See the paragraph on script
153 directives in the Extended Description section.
154 If the -C option is presented with a directive_prefix argument
156 that is the null string, qsub will not scan the script file for
157 directives.
158 -d path Defines the working directory path to be used for the job. If
160 the -d option is not specified, the default working directory
161 is the home directory. This option sets the environment vari‐
162 able PBS_O_INITDIR.
163 -D path Defines the root directory to be used for the job. This option
165 sets the environment variable PBS_O_ROOTDIR.
166 -e path Defines the path to be used for the standard error stream of
168 the batch job. The path argument is of the form:
169 [hostname:][path_name]
170 where hostname is the name of a host to which the file will be
171 returned and path_name is the path name on that host in the
172 syntax recognized by POSIX. The argument will be interpreted
173 as follows:
174 path_name
176 Where path_name is not an absolute path name, then the
177 qsub command will expand the path name relative to the
178 current working directory of the command. The command
179 will supply the name of the host upon which it is exe‐
180 cuting for the hostname component.
181 hostname:path_name
183 Where path_name is not an absolute path name, then the
184 qsub command will not expand the path name relative to
185 the current working directory of the command. On deliv‐
186 ery of the standard error, the path name will be
187 expanded relative to the user's home directory on the
188 hostname system.
189 path_name
191 Where path_name specifies an absolute path name, then
192 the qsub will supply the name of the host on which it is
193 executing for the hostname
194 hostname:path_name
196 Where path_name specifies an absolute path name, the
197 path will be used as specified. hostname.
198 hostname:
200 Where hostname specifies the name of the host that the
201 file should be returned to. The path will be the default
202 file name.
203 If the -e option is not specified or the path_name is not spec‐
205 ified or is specified and is a directory, the default file name
206 for the standard error stream will be used. The default name
207 has the following form:
208 job_name.esequence_number
209 where job_name is the name of the job, see -N option, and
210 sequence_number is the job number assigned when the job is sub‐
211 mitted.
212 -f Specifies that the job is fault tolerant. The fault_tolerant
214 attribute will be set to true, which indicates that the job can
215 survive the loss of a mom other than the "mother superior" mom
216 (the first node in the exec hosts )
217 -h Specifies that a user hold be applied to the job at submission
219 time.
220 -I Declares that the job is to be run "interactively". The job
222 will be queued and scheduled as any PBS batch job, but when
223 executed, the standard input, output, and error streams of the
224 job are connected through qsub to the terminal session in which
225 qsub is running. Interactive jobs are forced to not rerunable.
226 See the "Extended Description" paragraph for addition informa‐
227 tion of interactive jobs.
228 -j join Declares if the standard error stream of the job will be merged
230 with the standard output stream of the job.
231 An option argument value of oe directs that the two streams
233 will be merged, intermixed, as standard output. An option
234 argument value of eo directs that the two streams will be
235 merged, intermixed, as standard error.
236 If the join argument is n or the option is not specified, the
238 two streams will be two separate files.
239 -k keep Defines which (if either) of standard output or standard error
241 will be retained on the execution host. If set for a stream,
242 this option overrides the path name for that stream. If not
243 set, neither stream is retained on the execution host.
244 The argument is either the single letter "e" or "o", or the
246 letters "e" and "o" combined in either order. Or the argument
247 is the letter "n".
248 e The standard error stream is to retained on the execution
250 host. The stream will be placed in the home directory of
251 the user under whose user id the job executed. The file
252 name will be the default file name given by: job_name.ese‐
253 quence where job_name is the name specified for the job, and
254 sequence is the sequence number component of the job identi‐
255 fier.
256 o The standard output stream is to retained on the execution
258 host. The stream will be placed in the home directory of
259 the user under whose user id the job executed. The file
260 name will be the default file name given by: job_name.ose‐
261 quence where job_name is the name specified for the job, and
262 sequence is the sequence number component of the job identi‐
263 fier.
264 eo Both the standard output and standard error streams will be
266 retained.
267 oe Both the standard output and standard error streams will be
269 retained.
270 n Neither stream is retained.
272 -l resource_list
274 Defines the resources that are required by the job and estab‐
275 lishes a limit to the amount of resource that can be consumed.
276 If not set for a generally available resource, such as CPU
277 time, the limit is infinite. The resource_list argument is of
278 the form:
279 resource_name[=[value]][,resource_name[=[value]],...]
280 -m mail_options
282 Defines the set of conditions under which the execution server
283 will send a mail message about the job. The mail_options argu‐
284 ment is a string which consists of either the single character
285 "n", or one or more of the characters "a", "b", and "e".
286 If the character "n" is specified, no mail will be sent.
288 For the letters "a", "b", and "e":
290 a mail is sent when the job is aborted by the batch system.
292 b mail is sent when the job begins execution.
294 e mail is sent when the job terminates.
296 If the -m option is not specified, mail will be sent if the job
298 is aborted.
299 -M user_list
301 Declares the list of users to whom mail is sent by the execu‐
302 tion server when it sends mail about the job.
303 The user_list argument is of the form:
305 user[@host][,user[@host],...]
306 If unset, the list defaults to the submitting user at the qsub
307 host, i.e. the job owner.
308 -n Specifies that the job has exclusive access to the nodes it is
310 executing on. This is intended to be used in conjunction with a
311 scheduler that enforces exclusive access, and it tells the
312 cpuset to give the job access to all of that node's resources.
313 -N name Declares a name for the job. The name specified may be up to
315 and including 15 characters in length. It must consist of
316 printable, non white space characters with the first character
317 alphabetic.
318 If the -N option is not specified, the job name will be the
320 base name of the job script file specified on the command line.
321 If no script file name was specified and the script was read
322 from the standard input, then the job name will be set to
323 STDIN.
324 -o path Defines the path to be used for the standard output stream of
326 the batch job. The path argument is of the form:
327 [hostname:][path_name]
328 where hostname is the name of a host to which the file will be
329 returned and path_name is the path name on that host in the
330 syntax recognized by POSIX. The argument will be interpreted
331 as follows:
332 path_name
334 Where path_name is not an absolute path name, then the
335 qsub command will expand the path name relative to the
336 current working directory of the command. The command
337 will supply the name of the host upon which it is exe‐
338 cuting for the hostname component.
339 hostname:path_name
341 Where path_name is not an absolute path name, then the
342 qsub command will not expand the path name relative to
343 the current working directory of the command. On deliv‐
344 ery of the standard output, the path name will be
345 expanded relative to the user's home directory on the
346 hostname system.
347 path_name
349 Where path_name specifies an absolute path name, then
350 the qsub will supply the name of the host on which it is
351 executing for the hostname
352 hostname:path_name
354 Where path_name specifies an absolute path name, the
355 path will be used as specified. hostname.
356 hostname:
358 Where hostname specifies the name of the host that the
359 file should be returned to. The path will be the default
360 file name.
361 If the -o option is not specified or the path_name is not spec‐
363 ified or is specified and is a directory, the default file name
364 for the standard output stream will be used. The default name
365 has the following form:
366 job_name.osequence_number
367 where job_name is the name of the job, see -N option, and
368 sequence_number is the job number assigned when the job is sub‐
369 mitted.
370 -p priority
372 Defines the priority of the job. The priority argument must be
373 a integer between -1024 and +1023 inclusive. The default is no
374 priority which is equivalent to a priority of zero.
375 -P proxy_user[:group]
377 Proxy user for whom the job should be submitted. This option
378 is only available for the super user.
379 -q destination
381 Defines the destination of the job. The destination names a
382 queue, a server, or a queue at a server.
383 The qsub command will submit the script to the server defined
385 by the destination argument. If the destination is a routing
386 queue, the job may be routed by the server to a new destina‐
387 tion.
388 If the -q option is not specified, the qsub command will submit
390 the script to the default server. See PBS_DEFAULT under the
391 Environment Variables section on this man page and the PBS ERS
392 section 2.7.4, "Default Server".
393 If the -q option is specified, it is in one of the following
395 three forms:
396 queue
397 @server
398 queue@server
399 If the destination argument names a queue and does not name a
401 server, the job will be submitted to the named queue at the
402 default server.
403 If the destination argument names a server and does not name a
405 queue, the job will be submitted to the default queue at the
406 named server.
407 If the destination argument names both a queue and a server,
409 the job will be submitted to the named queue at the named
410 server.
411 -r y|n Declares whether the job is rerunable. See the qrerun command.
413 The option argument is a single character, either y or n.
414 If the argument is "y", the job is rerunable. If the argument
416 is "n", the job is not rerunable. The default value is 'y',
417 rerunable.
418 -S path_list
420 Declares the shell that interprets the job script.
421 The option argument path_list is in the form:
423 path[@host][,path[@host],...]
424 Only one path may be specified for any host named. Only one
425 path may be specified without the corresponding host name. The
426 path selected will be the one with the host name that matched
427 the name of the execution host. If no matching host is found,
428 then the path specified without a host will be selected, if
429 present.
430 If the -S option is not specified, the option argument is the
432 null string, or no entry from the path_list is selected, the
433 execution will use the user's login shell on the execution
434 host.
435 -t array_request
437 Specifies the task ids of a job array. Single task arrays are
438 allowed.
439 The array_request argument is an integer id or a range of inte‐
441 gers. Multiple ids or id ranges can be combined in a comma
442 delimted list. Examples : -t 1-100 or -t 1,10,50-100
443 An optional slot limit can be specified to limit the amount of
445 jobs that can run concurrently in the job array. The default
446 value is unlimited. The slot limit must be the last thing spec‐
447 ified in the array_request and is delimited from the array by a
448 percent sign (%).
449 qsub script.sh -t 0-299%5
451 This sets the slot limit to 5. Only 5 jobs from this array can
453 run at the same time.
454 Note: You can use qalter to modify slot limits on an array. The
456 server parameter max_slot_limit can be used to set a global
457 slot limit policy.
458 -T script_name
460 Allows for per job prologue and epilogue scripts. The full
461 script name will be prologue.[name] or epilogue.[name]. For the
462 job submission, only request the name of the prologue or epi‐
463 logue script.
464 Example: qsub -T prescript
466 Specifies to use the script prologue.prescript
467 -u user_list
469 Defines the user name under which the job is to run on the exe‐
470 cution system.
471 The user_list argument is of the form:
473 user[@host][,user[@host],...]
474 Only one user name may be given per specified host. Only one
475 of the user specifications may be supplied without the corre‐
476 sponding host specification. That user name will used for exe‐
477 cution on any host not named in the argument list. If unset,
478 the user list defaults to the user who is running qsub.
479 -v variable_list
481 Expands the list of environment variables that are exported to
482 the job.
483 In addition to the variables described in the "Description"
485 section above, variable_list names environment variables from
486 the qsub command environment which are made available to the
487 job when it executes. The variable_list is a comma separated
488 list of strings of the form variable or variable=value. These
489 variables and their values are passed to the job.
490 -V Declares that all environment variables in the qsub command's
492 environment are to be exported to the batch job.
493 -w path Defines the working directory path to be used for the job. If
495 the -w option is not specified, the default working directory
496 is the current directory. This option sets the environment
497 variable PBS_O_WORKDIR.
498 -W additional_attributes
500 The -W option allows for the specification of additional job
501 attributes. The general syntax of the -W is in the form:
502 -W attr_name=attr_value[,attr_name=attr_value...]
503 Note if white space occurs anywhere within the option argument
504 string or the equal sign, "=", occurs within an attribute_value
505 string, then the string must be enclosed with either single or
506 double quote marks.
507 PBS currently supports the following attributes within the -W
509 option.
510 depend=dependency_list
512 Defines the dependency between this and other jobs. The depen‐
513 dency_list is in the form:
514 type[:argument[:argument...][,type:argument...].
515 The argument is either a numeric count or a PBS job id accord‐
516 ing to type . If argument is a count, it must be greater than
517 0. If it is a job id and not fully specified in the form
518 seq_number.server.name, it will be expanded according to the
519 default server rules which apply to job IDs on most commands.
520 If argument is null (the preceding colon need not be speci‐
521 fied), the dependency of the corresponding type is cleared
522 (unset).
523 synccount:count
525 This job is the first in a set of jobs to be executed
526 at the same time. Count is the number of additional
527 jobs in the set.
528 syncwith:jobid
530 This job is an additional member of a set of jobs to be
531 executed at the same time. In the above and following
532 dependency types, jobid is the job identifier of the
533 first job in the set.
534 after:jobid[:jobid...]
536 This job may be scheduled for execution at any point
537 after jobs jobid have started execution.
538 afterok:jobid[:jobid...]
540 This job may be scheduled for execution only after jobs
541 jobid have terminated with no errors. See the csh
542 warning under "Extended Description".
543 afternotok:jobid[:jobid...]
545 This job may be scheduled for execution only after jobs
546 jobid have terminated with errors. See the csh warning
547 under "Extended Description".
548 afterany:jobid[:jobid...]
550 This job may be scheduled for execution after jobs
551 jobid have terminated, with or without errors.
552 on:count
554 This job may be scheduled for execution after count
555 dependencies on other jobs have been satisfied. This
556 form is used in conjunction with one of the before
557 forms, see below.
558 before:jobid[:jobid...]
560 When this job has begun execution, then jobs jobid...
561 may begin.
562 beforeok:jobid[:jobid...]
564 If this job terminates execution without errors, then
565 jobs jobid... may begin. See the csh warning under
566 "Extended Description".
567 beforenotok:jobid[:jobid...]
569 If this job terminates execution with errors, then jobs
570 jobid... may begin. See the csh warning under
571 "Extended Description".
572 beforeany:jobid[:jobid...]
574 When this job terminates execution, jobs jobid... may
575 begin.
576 If any of the before forms are used, the jobs refer‐
578 enced by jobid must have been submitted with a depen‐
579 dency type of on.
580 Array Dependencies
582 It is now possible to have a job depend on an array.
583 These dependencies are in the form depend=array‐
584 dep:arrayid[num]. If [num] is not present, then the
585 dependencies applies to the entire array. If [num] is
586 present, then num means the number of jobs that must
587 meet the condition for the dependency to be satisfied.
588 afterstartarray:arrayid[count]
590 This job may be scheduled for execution only after jobs
591 in arrayid have started execution.
592 afterokarray:arrayid[count]
594 This job may be scheduled for execution only after jobs
595 in arrayid have terminated with no errors.
596 afternotok:arrayid[count]
598 This job may be scheduled for execution only after jobs
599 in arrayid have terminated with errors.
600 afteranyarray:arrayid[count]
602 This job may be scheduled for execution after jobs in
603 array id have terminated, with or without errors.
604 beforestartarray:arrayid[count]
606 This job may be scheduled for execution only before
607 jobs in arrayid have started execution.
608 beforeokarray:arrayid[count]
610 This job may be scheduled for execution only before
611 jobs in arrayid have terminated with no errors.
612 beforenotok:arrayid[count]
614 This job may be scheduled for execution only before
615 jobs in arrayid have terminated with errors.
616 beforeanyarray:arrayid[count]
618 This job may be scheduled for execution before jobs in
619 array id have terminated, with or without errors.
620 If any of the before forms are used, the jobs refer‐
622 enced by jobid must have the same owner as the job
623 being submitted. Otherwise, the dependency is ignored.
624 Error processing of the existence, state, or condition of
626 the job on which the newly submitted job is a deferred ser‐
627 vice, i.e. the check is performed after the job is queued.
628 If an error is detected, the new job will be deleted by the
629 server. Mail will be sent to the job submitter stating the
630 error.
631 Dependency examples:
633 qsub -W depend=afterok:123.big.iron.com /tmp/script
634 qsub -W depend=before:234.hunk1.com:235.hunk1.com
635 /tmp/script
636 qsub -W depend=afterokarray:21.tom.com[] /tmp/script
637 qsub -W depend=beforenotokarray:22.tom.com[][5] /tmp/script
638 group_list=g_list
640 Defines the group name under which the job is to run on the
641 execution system. The g_list argument is of the form:
642 group[@host][,group[@host],...]
643 Only one group name may be given per specified host. Only one
644 of the group specifications may be supplied without the corre‐
645 sponding host specification. That group name will used for
646 execution on any host not named in the argument list. If not
647 set, the group_list defaults to the primary group of the user
648 under which the job will be run.
649 interactive=true
651 If the interactive attribute is specified, the job is an inter‐
652 active job. The -I option is a alternative method of specify‐
653 ing this attribute.
654 stagein=file_list
656 stageout=file_list
657 Specifies which files are staged (copied) in before job start
658 or staged out after the job completes execution. On completion
659 of the job, all staged-in and staged-out files are removed from
660 the execution system. The file_list is in the form
661 local_file@hostname:remote_file[,...]
662 regardless of the direction of the copy. The name local_file
663 is the name of the file on the system where the job executed.
664 It may be an absolute path or relative to the home directory of
665 the user. The name remote_file is the destination name on the
666 host specified by hostname. The name may be absolute or rela‐
667 tive to the user's home directory on the destination host. The
668 use of wildcards in the file name is not recommended. The file
669 names map to a remote copy program (rcp) call on the execution
670 system in the follow manner:
671 For stagein: rcp hostname:remote_file local_file
672 For stageout: rcp local_file hostname:remote_file
673 Data staging examples:
674 -W stagein=/tmp/input.txt@headnode:/home/user/input.txt
675 -W stageout=/tmp/output.txt@headnode:/home/user/output.txt
676 If TORQUE has been compiled with wordexp support, then vari‐
677 ables can be used in the specified paths. Currently only
678 $PBS_JOBID, $HOME, and $TMPDIR are supported for stagein.
679 umask=XXX
681 Sets umask used to create stdout and stderr spool files in
682 pbs_mom spool directory. Values starting with 0 are treated as
683 octal values, otherwise the value is treated as a decimal umask
684 value.
685 -x When running an interactive job, the -x flag makes it so that
687 the script won't be parsed for PBS directives, but instead will
688 be a command that is launched once the interactive job has
689 started. The job will terminate at the completion of this com‐
690 mand.
691 -X Enables X11 forwarding. The DISPLAY environment variable must
693 be set.
694 -z Directs that the qsub command is not to write the job identi‐
696 fier assigned to the job to the command's standard output.
697
699 The qsub command accepts a script operand that is the path to the
700 script of the job. If the path is relative, it will be expanded rela‐
701 tive to the working directory of the qsub command.
702 If the script operand is not provided or the operand is the single
704 character "-", the qsub command reads the script from standard input.
705 When the script is being read from Standard Input, qsub will copy the
706 file to a temporary file. This temporary file is passed to the library
707 interface routine pbs_submit. The temporary file is removed by qsub
708 after pbs_submit returns or upon the receipt of a signal which would
709 cause qsub to terminate.
710
712 The qsub command reads the script for the job from standard input if
713 the script operand is missing or is the single character "-".
714
716 The script file is read by the qsub command. Qsub acts upon any direc‐
717 tives found in the script.
718 When the job is created, a copy of the script file is made and that
720 copy cannot be modified.
721
723 Unless the -z option is set, the job identifier assigned to the job
724 will be written to standard output if the job is successfully created.
725
727 The qsub command will write a diagnostic message to standard error for
728 each error occurrence.
729
731 The values of some or all of the variables in the qsub command's envi‐
732 ronment are exported with the job, see the -v and -V options.
733 The environment variable PBS_DEFAULT defines the name of the default
735 server. Typically, it corresponds to the system name of the host on
736 which the server is running. If PBS_DEFAULT is not set, the default is
737 defined by an administrator established file.
738 The environment variable PBS_DPREFIX determines the prefix string which
740 identifies directives in the script.
741 The environment variable PBS_CLIENTRETRY defines the maximum number of
743 seconds qsub will block. See the -b option above. Despite the name,
744 currently qsub is the only client that supports this option.
745
747 The torque.cfg file, located in PBS_SERVER_HOME (/var/spool/torque by
748 default) controls the behavior of the qsub command. This file contains
749 a list of parameters and values separated by whitespace
750 QSUBSLEEP takes an integer operand which specifies time to sleep when
752 running qsub command. Used to prevent users from overwhelming the
753 scheduler.
754 SUBMITFILTER specifies the path to the submit filter used to pre-
756 process job submission. The default path is $(libexecdir)/qsub_filter,
757 which falls back to /usr/local/sbin/torque_submitfilter for backwards
758 compatibility. This torque.cfg parameter overrides this default.
759 SERVERHOST specifies the value for the PBS_SERVER environment variable
761 QSUBHOST specifies the hostname for the jobs QSUB_O_HOST variable
763 QSUBSENDUID specifies a uid to use for the jobs PBS_O_UID variable
765 XAUTHPATH specifies the path to xauth
767 CLIENTRETRY specifies the integer seconds between retry attempts to
769 communicate with pbs_server
770 VALIDATEGROUP set this parameter to force qsub to verify the submit‐
772 ter's group id
773 DEFAULTCKPT specifies the default value for the jobs checkpoint
775 attribute. The user overrides this with the -c qsub option.
776 VALIDATEPATH set this parameter to force qsub to validate local exis‐
778 tence of a "-d" working directory
779 RERUNNABLEBYDEFAULT this parameter specifies if a job is rerunnable by
781 default. The default is true, setting this to false causes the
782 rerunnable attribute value to be false unless the users specifies oth‐
783 erwise with the -r option
784 FAULT_TOLERANT_BY_DEFAULT this parameter specifies if a job is fault
786 tolerant by default. The default value for the fault_tolerant job
787 attribute is false, setting this parameter to true causes the default
788 value of the attribute to be true. The user can specify their prefer‐
789 ence with the -f qsub option.
790 For example:
792 QSUBSLEEP 2
793 RERUNNABLEBYDEFAULT false
794
797 Script Processing:
798 A job script may consist of PBS directives, comments and executable
800 statements. A PBS directive provides a way of specifying job
801 attributes in addition to the command line options. For example:
802 :
803 #PBS -N Job_name
804 #PBS -l walltime=10:30,mem=320kb
805 #PBS -m be
806 #
807 step1 arg1 arg2
808 step2 arg3 arg4
809 The qsub command scans the lines of the script file for directives. An
812 initial line in the script that begins with the characters "#!" or the
813 character ":" will be ignored and scanning will start with the next
814 line. Scanning will continue until the first executable line, that is
815 a line that is not blank, not a directive line, nor a line whose first
816 non white space character is "#". If directives occur on subsequent
817 lines, they will be ignored.
818 A line in the script file will be processed as a directive to qsub if
820 and only if the string of characters starting with the first non white
821 space character on the line and of the same length as the directive
822 prefix matches the directive prefix.
823 The remainder of the directive line consists of the options to qsub in
825 the same syntax as they appear on the command line. The option charac‐
826 ter is to be preceded with the "-" character.
827 If an option is present in both a directive and on the command line,
829 that option and its argument, if any, will be ignored in the directive.
830 The command line takes precedence.
831 If an option is present in a directive and not on the command line,
833 that option and its argument, if any, will be processed as if it had
834 occurred on the command line.
835 The directive prefix string will be determined in order of preference
837 from:
838 The value of the -C option argument if the option is specified on
840 the command line.
841 The value of the environment variable PBS_DPREFIX if it is defined.
843 The four character string #PBS.
845 If the -C option is found in a directive in the script file, it will be
847 ignored.
848 User Authorization:
850 When the user submits a job from a system other than the one on which
852 the PBS Server is running, the name under which the job is to be exe‐
853 cuted is selected according to the rules listed under the -u option.
854 The user submitting the job must be authorized to run the job under the
855 execution user name. This authorization is provided if
856 (1) The host on which qsub is run is trusted by the execution
858 host (see /etc/hosts.equiv),
859 (2) The execution user has an .rhosts file naming the submit‐
861 ting user on the submitting host.
862 C-Shell .logout File:
864 The following warning applies for users of the c-shell, csh. If the
866 job is executed under the csh and a .logout file exists in the home
867 directory in which the job executes, the exit status of the job is that
868 of the .logout script, not the job script. This may impact any inter-
869 job dependencies. To preserve the job exit status, either remove the
870 .logout file or place the following line as the first line in the
871 .logout file
872 set EXITVAL = $status
873 and the following line as the last executable line in .logout
874 exit $EXITVAL
875 Interactive Jobs:
877 If the -I option is specified on the command line or in a script direc‐
879 tive, or if the "interactive" job attribute declared true via the -W
880 option, -W interactive=true, either on the command line or in a script
881 directive, the job is an interactive job. The script will be processed
882 for directives, but will not be included with the job. When the job
883 begins execution, all input to the job is from the terminal session in
884 which qsub is running.
885 When an interactive job is submitted, the qsub command will not termi‐
887 nate when the job is submitted. Qsub will remain running until the job
888 terminates, is aborted, or the user interrupts qsub with an SIGINT (the
889 control-C key). If qsub is interrupted prior to job start, it will
890 query if the user wishes to exit. If the user response "yes", qsub
891 exits and the job is aborted.
892 Once the interactive job has started execution, input to and output
894 from the job pass through qsub. Keyboard generated interrupts are
895 passed to the job. Lines entered that begin with the tilde ('~') char‐
896 acter and contain special sequences are escaped by qsub. The recog‐
897 nized escape sequences are:
898 ~. Qsub terminates execution. The batch job is also termi‐
900 nated.
901 ~susp Suspend the qsub program if running under the C shell.
903 "susp" is the suspend character, usually CNTL-Z.
904 ~asusp Suspend the input half of qsub (terminal to job), but
906 allow output to continue to be displayed. Only works
907 under the C shell. "asusp" is the auxiliary suspend
908 character, usually CNTL-Y.
909
911 Upon successful processing, the qsub exit status will be a value of
912 zero.
913 If the qsub command fails, the command exits with a value greater than
915 zero.
916
918 qalter(1B), qdel(1B), qhold(1B), qmove(1B), qmsg(1B), qrerun(1B),
919 qrls(1B), qselect(1B), qsig(1B), qstat(1B), pbs_connect(3B),
920 pbs_job_attributes(7B), pbs_queue_attributes(7B),
921 pbs_resources_irix5(7B), pbs_resources_sp2(7B),
922 pbs_resources_sunos4(7B), pbs_resources_unicos8(7B),
923 pbs_server_attributes(7B), and pbs_server(8B)
924Local qsub(1B)