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