1qalter(1B) PBS qalter(1B)
2
6 qalter - alter pbs batch job
7
9 qalter [-a date_time] [-A account_string] [-c interval] [-e path] [-h
10 hold_list] [-j join] [-k keep] [-l resource_list] [-m mail_options] [-M
11 user_list] [-N name] [-o path] [-p priority] [-r c] [-S path] [-u
12 user_list] [-W additional_attributes] job_identifier...
13
15 The qalter command modifies the attributes of the job or jobs specified
16 by job_identifier on the command line. Only those attributes listed as
17 options on the command will be modified. If any of the specified
18 attributes cannot be modified for a job for any reason, none of that
19 job's attributes will be modified.
20 The qalter command accomplishes the modifications by sending a Modify
22 Job batch request to the batch server which owns each job.
23
25 -a date_time
26 Replaces the time at which the job becomes eligible for execu‐
27 tion. The date_time argument syntax is:
28 [[[[CC]YY]MM]DD]hhmm[.SS].
29 If the month, MM, is not specified, it will default to the cur‐
31 rent month if the specified day DD, is in the future. Other‐
32 wise, the month will be set to next month. Likewise, if the
33 day, DD, is not specified, it will default to today if the time
34 hhmm is in the future. Otherwise, the day will be set to
35 tomorrow.
36 This attribute can be altered once the job has begun execution,
38 but it will not take affect until the job is rerun.
39 -A account_string
41 Replaces the the account string associated with the job.
42 This attribute cannot be altered once the job has begun execu‐
44 tion.
45 -c interval
47 Replaces the the interval at which the job will be check‐
48 pointed. If the job executes upon a host which does not sup‐
49 port checkpoint, this option will be ignored.
50 The interval argument is specified as:
52 n No checkpointing is to be performed.
54 s Checkpointing is to be performed only when the server exe‐
56 cuting the job is shutdown.
57 c Checkpointing is to be performed at the default minimum cpu
59 time for the queue from which the job is executing.
60 c=minutes
62 Checkpointing is to be performed at an interval of minutes,
63 which is the integer number of minutes of CPU time used by
64 the job. This value must be greater than zero. If the num‐
65 ber is less than the default checkpoint time, the default
66 time will be used.
67 This attribute can be altered once the job has begun execution,
69 but the new value does not take affect until the job is rerun.
70 -e path Replaces the the path to be used for the standard error stream
72 of the batch job. The path argument is of the form:
73 [hostname:]path_name
74 where hostname is the name of a host to which the file will be
75 returned and path_name is the path name on that host in the
76 syntax recognized by POSIX 1003.1. The argument will be inter‐
77 preted as follows:
78 path_name
80 Where path_name is not an absolute path name, then the
81 qalter command will expand the path name relative to the
82 current working directory of the command. The command
83 will supply the name of the host upon which it is exe‐
84 cuting for the hostname component.
85 hostname:path_name
87 Where path_name is not an absolute path name, then the
88 qalter command will not expand the path name. The exe‐
89 cution server will expand it relative to the home direc‐
90 tory of the user on the system specified by hostname.
91 path_name
93 Where path_name specifies an absolute path name, then
94 qalter will supply the name of the host on which it is
95 executing for the hostname.
96 hostname:path_name
98 Where path_name specifies an absolute path name, the
99 path will be used as specified.
100 This attribute can be altered once the job has begun execution,
102 but it will not take affect until the job is rerun.
103 -h hold_list
105 Updates the the types of holds on the job. The hold_list argu‐
106 ment is a string of one or more of the following characters:
107 u Add the USER type hold.
109 s Add the SYSTEM type hold if the user has the appropriate
111 level of privilege. [Typically reserved to the batch
112 administrator.]
113 o Add the OTHER (or OPERATOR ) type hold if the user has the
115 appropriate level of privilege. [Typically reserved to
116 the batch administrator and batch operator.]
117 n Set to none; that is clear the hold types which could be
119 applied with the users level of privilege.
120 Repetition of characters is permitted, but "n" may not appear
122 in the same option argument with the other three characters.
123 This attribute can be altered once the job has begun execution,
124 but the hold will not take affect until the job is rerun.
125 -j join Declares which standard streams of the job will be merged
127 together. The join argument value may be the characters "oe"
128 and "eo", or the single character "n".
129 A argument value of oe directs that the standard output and
131 standard error streams of the job will be merged, intermixed,
132 and returned as the standard output. A argument value of eo
133 directs that the standard output and standard error streams of
134 the job will be merged, intermixed, and returned as the stan‐
135 dard error.
136 A value of n directs that the two streams will be two separate
138 files. This attribute can be altered once the job has begun
139 execution, but it will not take affect until the job is rerun.
140 -k keep Defines which if either of standard output or standard error of
142 the job will be retained on the execution host. If set for a
143 stream, this option overrides the path name for that stream.
144 The argument is either the single letter "e", "o", or "n", or
146 one or more of the letters "e" and "o" combined in either
147 order.
148 n No streams are to be retained.
150 e The standard error stream is to retained on the execution
152 host. The stream will be placed in the home directory of
153 the user under whose user id the job executed. The file
154 name will be the default file name given by: job_name.ese‐
155 quence where job_name is the name specified for the job,
156 and sequence is the sequence number component of the job
157 identifier.
158 o The standard output stream is to be retained on the execu‐
160 tion host. The stream will be placed in the home direc‐
161 tory of the user under whose user id the job executed.
162 The file name will be the default file name given by:
163 job_name.osequence where job_name is the name specified
164 for the job, and sequence is the sequence number component
165 of the job identifier.
166 eo Both the standard output and standard error streams will
168 be retained.
169 oe Both the standard output and standard error streams will
171 be retained.
172 This attribute cannot be altered once the job has begun execu‐
174 tion.
175 -l resource_list
177 Modifies the list of resources that are required by the job.
178 The Resource_List argument is in the following syntax:
179 resource_name[=[value]][,resource_name[=[value]],...]
180 If a requested modification to a resource would exceed the
182 resource limits for jobs in the current queue, the server will
183 reject the request.
184 If the job is running, only certain, resources can be altered.
186 Which resources can be altered in the run state is system
187 dependent. A user may only lower the limit for those
188 resources.
189 -m mail_options
191 Replaces the set of conditions under which the execution server
192 will send a mail message about the job. The mail_options argu‐
193 ment is a string which consists of the single character "n", or
194 one or more of the characters "a", "b", and "e".
195 If the character "n" is specified, no mail will be sent.
197 For the letters "a", "b", and "e":
199 a mail is sent when the job is aborted by the batch system.
201 b mail is sent when the job begins execution.
203 e mail is sent when the job terminates.
205 -M user_list
207 Replaces the list of users to whom mail is sent by the execu‐
208 tion server when it sends mail about the job.
209 The user_list argument is of the form:
211 user[@host][,user[@host],...]
212 -N name Renames the job. The name specified may be up to and including
214 15 characters in length. It must consist of printable, non
215 white space characters with the first character alphabetic.
216 -o path Replaces the path to be used for the standard output stream of
218 the batch job. The path argument is of the form:
219 [hostname:]path_name
220 where hostname is the name of a host to which the file will be
221 returned and path_name is the path name on that host in the
222 syntax recognized by POSIX. The argument will be interpreted
223 as follows:
224 path_name
226 Where path_name is not an absolute path name, then the
227 qalter command will expand the path name relative to the
228 current working directory of the command. The command
229 will supply the name of the host upon which it is exe‐
230 cuting for the hostname component.
231 hostname:path_name
233 Where path_name is not an absolute path name, then the
234 qalter command will not expand the path name. The exe‐
235 cution server will expand it relative to the home direc‐
236 tory of the user on the system specified by hostname.
237 path_name
239 Where path_name specifies an absolute path name, then
240 the qalter will supply the name of the host on which it
241 is executing for the hostname.
242 hostname:path_name
244 Where path_name specifies an absolute path name, the
245 path will be used as specified.
246 This attribute can be altered once the job has begun execution,
248 but it will not take affect until the job is rerun.
249 -p priority
251 Replaces the priority of the job. The priority argument must
252 be a integer between -1024 and +1023 inclusive.
253 This attribute can be altered once the job has begun execution,
255 but it will not take affect until the job is rerun.
256 -r c Declares whether the job is rerunable. See the qrerun command.
258 The option argument c is a single character. PBS recognizes
259 the following characters: y and n.
260 If the argument is "y", the job is marked rerunable. If the
262 argument is "n", the job is marked as not rerunable.
263 -S path Declares the shell that interprets the job script.
265 The option argument path_list is in the form:
267 path[@host][,path[@host],...]
268 Only one path may be specified for any host named. Only one
269 path may be specified without the corresponding host name. The
270 path selected will be the one with the host name that matched
271 the name of the execution host. If no matching host is found,
272 then if present the path specified without a host will be
273 selected.
274 If the -S option is not specified, the option argument is the
276 null string, or no entry from the path_list is selected, the
277 execution will use the login shell of the user on the execution
278 host.
279 This attribute can be altered once the job has begun execution,
281 but it will not take affect until the job is rerun.
282 -u user_list
284 Replaces the user name under which the job is to run on the
285 execution system.
286 The user_list argument is of the form:
288 user[@host][,user[@host],...]
289 Only one user name may be given for per specified host. Only
290 one of the user specifications may be supplied without the cor‐
291 responding host specification. That user name will be used for
292 execution on any host not named in the argument list.
293 This attribute cannot be altered once the job has begun execu‐
295 tion.
296 -W additional_attributes
298 The -W option allows for the modification of additional job
299 attributes. The general syntax of the -W is in the form:
300 -W attr_name=value[,attr_name=value...]
301 Note if white space occurs anywhere within the option argument
302 string or the equal sign, "=", occurs within an attribute_value
303 string, then the string must be enclosed with either single or
304 double quote marks.
305 PBS currently supports the following attributes within the -W
307 option.
308 depend=dependency_list
310 Redefines the dependencies between this and other jobs. The
311 dependency_list is in the form: type[:argument[:argu‐
312 ment...][,type:argument...].
313 The argument is either a numeric count or a PBS job id accord‐
314 ing to type . If argument is a count, it must be greater than
315 0. If it is a job id and is not fully specified in the form:
316 seq_number.server.name, it will be expanded according to the
317 default server rules. If argument is null (the preceding colon
318 need not be specified), the dependency of the corresponding
319 type is cleared (unset).
320 synccount:count
322 This job is the first in a set of jobs to be executed
323 at the same time. Count is the number of additional
324 jobs in the set.
325 syncwith:jobid
327 This job is an additional member of a set of jobs to be
328 executed at the same time. Jobid is the job identifier
329 of the first job in the set.
330 after:jobid[:jobid...]
332 This job may be scheduled for execution at any point
333 after jobs jobid have started execution.
334 afterok:jobid[:jobid...]
336 This job may be scheduled for execution only after jobs
337 jobid have terminated with no errors.
338 afternotok:jobid[:jobid...]
340 This job may be scheduled for execution only after jobs
341 jobid have terminated with errors.
342 afterany:jobid[:jobid...]
344 This job may be scheduled for execution after jobs
345 jobid have terminated, with or without errors.
346 on:count
348 This job may be scheduled for execution after count
349 dependencies on other jobs have been satisfied. This
350 form is used in conjunction with one of the before
351 forms, see below.
352 before:jobid[:jobid...]
354 When this job has begun execution, then jobs jobid...
355 may begin.
356 beforeok:jobid[:jobid...]
358 If this job terminates execution without errors, then
359 jobs jobid... may begin.
360 beforenotok:jobid[:jobid...]
362 If this job terminates execution with errors, then jobs
363 jobid... may begin.
364 beforeany:jobid[:jobid...]
366 When this job terminates execution, jobs jobid... may
367 begin.
368 If any of the before forms are used, the job referenced
370 by jobid must have been submitted with a dependency
371 type of on.
372 The job specified in any of the before forms must have
374 the same owner as the job being altered.. Otherwise,
375 the dependency will not take effect.
376 Error processing of the existence, state, or condition of
378 the job on which the newly submitted job is a deferred ser‐
379 vice, i.e. the check is performed after the job is queued.
380 If an error is detected, the new job will be deleted by the
381 server. Mail will be sent to the job submitter stating the
382 error.
383 group_list=g_list
385 Alters the group name under which the job is to run on the exe‐
386 cution system.
387 The g_list argument is of the form:
389 group[@host][,group[@host],...]
390 Only one group name may be given per specified host. Only one
391 of the group specifications may be supplied without the corre‐
392 sponding host specification. That group name will used for
393 execution on any host not named in the argument list.
394 stagein=file_list
396 stageout=file_list
397 Alters which files are staged (copied) in before job start or
398 staged out after the job completes execution. The file_list is
399 in the form: local_file@hostname:remote_file[,...]
400 The name local_file is the name on the system where the job
401 executes. It may be an absolute path or a path relative to the
402 home directory of the user. The name remote_file is the desti‐
403 nation name on the host specified by hostname. The name may be
404 absolute or relative to the user's home directory on the desti‐
405 nation host.
406
408 The qalter command accepts one or more job_identifier operands of the
409 form:
410 sequence_number[.server_name][@server]
411
413 Any error condition, either in processing the options or the operands,
414 or any error received in reply to the batch requests will result in a
415 error message being written to standard error.
416
418 Upon successful processing of all the operands presented to the qalter
419 command, the exit status will be a value of zero.
420 If the qalter command fails to process any operand, the command exits
422 with a value greater than zero.
423
425 qsub(1B), qstat(1B), pbs_alterjob(3B), pbs_statjob(3B), pbs_selec‐
426 tjob(3B), pbs_resources_*(7B), where * is system type, and the PBS ERS.
427Local qalter(1B)