1pbs_job_attributes(7B) PBS pbs_job_attributes(7B)
2
6 pbs_job_attributes - pbs job attributes
7
9 A batch job has the following public attributes shown in the following
10 list. The attributes marked with the section symbol § are required by
11 POSIX 1003.2d: If an attribute is unset, the indicated default value is
12 assumed.
13 Account_Name §
15 Used for accounting on some hosts. Format: string; default
16 value: none, not used.
17 Checkpoint §
19 If supported by the server implementation and the host operating
20 system, the checkpoint attribute determines when checkpointing
21 will be performed by PBS on behalf of the job. The legal values
22 for checkpoint are described under the qalter and qsub commands.
23 Format: the strings "n", "s", "c", "c=mmmm"; default value: "u",
24 which is unspecified.
25 depend The type of inter-job dependencies specified by the job owner.
27 Format: "type:jobid[,jobid...]"; default value: no dependencies.
28 Error_Path §
30 The final path name for the file containing the job's standard
31 error stream. See the qsub and qalter command description for
32 more detail. Format: "[hostname:]pathname"; default value:
33 (job_name).e(job_number).
34 Execution_Time §
36 The time after which the job may execute. The time is main‐
37 tained in seconds since Epoch. If this time has not yet been
38 reached, the job will not be scheduled for execution and the job
39 is said to be in wait state. Format: "[[CCwYY]MMDDhhmm[.ss]";
40 default value: time 0, no delay.
41 group_list §
43 A list of group_names@hosts which determines the group under
44 which the job is run on a given host. [internal type: array of
45 strings] When a job is to be placed into execution, the server
46 will select a group name according to the following ordered set
47 of rules:
48 1. Select the group name from the list for which the associated
50 host name matches the name of the execution host.
51 2. Select the group name which has no associated host name, the
53 wild card name.
54 3. Use the login group for the user name under which the job
56 will be run.
57 Format: "group_name[@host][,group_name[@host]...]".
59 Hold_Types §
61 The set of holds currently applied to the job. If the set is
62 not null, the job will not be scheduled for execution and is
63 said to be in the hold state. Note, the hold state takes
64 precedence over the wait state. Format: string made up of the
65 letters 'u', 's', 'o'; default value: no hold.
66 Job_Name §
68 The name assigned to the job by the qsub or qalter command.
69 Format: string up to 15 characters, first character must be
70 alphabetic; default value: the base name of the job script or
71 STDIN.
72 Join_Path §
74 If the Join_Paths attribute is {TRUE}, then the job's standard
75 error stream will be merged, inter-mixed, with the job's stan‐
76 dard output stream and placed in the file determined by the Out‐
77 put_Path attribute. The Error_Path attribute is maintained, but
78 ignored. Format: boolean, values accepted are "True", "TRUE",
79 "true", "Y", "y", "1", "False", "FALSE", "false", "N", "n", "0";
80 default value: false.
81 Keep_Files §
83 If Keep_Files contains the values "o" and/or "e" the correspond‐
84 ing streams of the batch job will be retained on the execution
85 host upon job termination. Keep_Files overrides the Output_Path
86 and Error_Path attributes. Format: "o", "e", "oe" or "eo";
87 default value: no keep, return files to submission host.
88 Mail_Points §
90 Identifies at which state changes the server will send mail
91 about the job. Format: string made up of the letters 'a' for
92 abort, 'b' for beginning, and default value: 'a', send on job
93 abort.
94 Mail_Users §
96 The set of users to whom mail may be sent when the job makes
97 certain state changes. Format: "user@host[,user@host]";
98 default value: job owner only.
99 Output_Path §
101 The final path name for the file containing the job's standard
102 output stream. See the qsub and qalter command description for
103 more detail. Format: see error_path, default value:
104 (job_name).o(job_number).
105 Priority §
107 The job scheduling priority assigned by the user. Format:
108 "[+|-]nnnnn"; default value: undefined.
109 Rerunable §
111 The rerunable flag given by the user. Format: "y" or "n", see
112 Join_Path; default value: y, job is rerunable.
113 Resource_List §
115 The list of resources required by the job. The resource list is
116 a set of name=value strings. The meaning of name and value is
117 server dependent. The value also establishes the limit of usage
118 of that resource. If not set, the value for a resource may be
119 determined by a queue or server default established by the
120 administrator. Default value: no usage or no limit depending on
121 specific resource.
122 Shell_Path_List §
124 A set of absolute paths of the program to process the job's
125 script file. The list is in the format:
126 "path[@host][,path[@host]...]". If this is null, then the
127 user's login shell on the host of execution will be used.
128 Default value: null, login shell.
129 stagein
131 The list of files to be staged in prior to job execution. For‐
132 mat: local_path@remote_host:remote_path
133 stageout
135 The list of files to be staged out after job execution. Format:
136 local_path@remote_host:remote_path
137 User_List §
139 The list of user@hosts which determines the user name under
140 which the job is run on a given host. [internal type: array of
141 strings] When a job is to be placed into execution, the server
142 will select a user name from the list according to the following
143 ordered set of rules:
144 1. Select the user name from the list for which the associated
146 host name matches the name of the execution host.
147 2. Select the user name which has no associated host name, the
149 wild card name.
150 3. Use the Job_Owner as the user name.
152 Default value: job owner name.
154 Variable_List §
156 This is the list of environment variables passed with the Queue
157 Job batch request. Format: "name=value[,name=value...]".
158 The following attributes require system, manager, or operator privilege
160 to set. They are visible to clients depending on privilege as noted.
161 comment
163 An attribute for displaying comments about the job from the sys‐
164 tem. Visible to any client. Format: any string; default value:
165 none.
166 sched_hint
168 This attribute is present when the job is a member of a synchro‐
169 nous dependency set. It is set when the hold is released on the
170 job. The value is {SYNC_SCHED_HINT_FIRST} [22m(1) when the first
171 job of the set is released for scheduling. This is a hint that
172 may be used by the scheduler to decrease the priority of the
173 job. This keeps a user from attempting to game the scheduler.
174 The attribute is set to {SYNC_SCHED_HINT_OTHER} [22m(2) for all
175 other jobs in the set as they become schedulable. This should
176 be taken as a hint by the scheduler to increase their priority
177 to insure they will run at the same time as the earlier sched‐
178 uled jobs in the set. [This attribute is viewable only by the
179 batch administrator.] [type: integer]
180 The following attributes are read-only, they are established by the
182 server and are visible to the client but cannot be set by a client.
183 Certain ones are only visible to privileged clients (those run by the
184 batch administrator).
185 alt_id For a few systems, such as Irix 6.x running Array Services, the
187 session id is insufficient to track which processes belong to
188 the job. Where a different identifier is required, it is
189 recorded in this attribute. If set, it will also be recorded
190 in the end-of-job accounting record.
191 For Irix 6.x running Array Services, the alt_id attribute is set
193 to the Array Session Handle (ASH) assigned to the job.
194 ctime The time that the job was created.
196 etime The time that the job became eligible to run, i.e. in a queued
198 state while residing in an execution queue.
199 exec_host
201 If the job is running, this is set to the name of the host on
202 which the job is executing.
203 exit_status
205 The exit status of the job. This is only set on receipt of a
206 job obituary notice from MOM, and probably only useful if the
207 "keep_completed" server attribute is set. Note that negative
208 values are generated internally by PBS to indicate system errors
209 and are listed as the JOB_EXEC_* defines in pbs_job.h. Positive
210 values are returned from the user script and cannot be inter‐
211 preted by PBS.
212 egroup If the job is queued in an execution queue, this attribute is
214 set to the group name under which the job is to be run. [This
215 attribute is available only to the batch administrator.]
216 euser If the job is queued in an execution queue, this attribute is
218 set to the user name under which the job is to be run. [This
219 attribute is available only to the batch administrator.]
220 hashname
222 The name used as a basename for various files, such as the job
223 file, script file, and the standard output and error of the job.
224 [This attribute is available only to the batch administrator.]
225 interactive
227 True if the job is an interactive PBS job. Format: boolean, see
228 Join_Paths; default value: false.
229 Job_Owner §
231 The login name on the submitting host of the user who submitted
232 the batch job.
233 job_state
235 The state of the job.
236 E for exiting, the job has completed execution, with or
238 without errors, and the batch system is doing post-execu‐
239 tion clean-up.
240 H for Held, one or more holds have been applied to the job.
242 Q for Queued, the job resides in a execution or routing
244 queue pending execution or routing. It is not in held or
245 waiting state.
246 R for Running, the job resides in a execution queue and has
248 been placed into execution.
249 S for Suspend (Job running on Unicos only), the job was
251 executing and has been suspended. The job retains its
252 assigned resources but does not use cpu cycle or wall‐
253 time.
254 T for Transiting, the job is in process of being routed or
256 moved to a new destination.
257 W for Waiting, the job is not held but the Execution_Time
259 attribute contains a time which has not yet been reached.
260 mtime The time that the job was last modified, changed state, or
262 changed locations.
263 qtime The time that the job entered the current queue.
265 queue The name of the queue in which the job currently resides.
267 queue_rank
269 An ordered, non-sequential number indicating the job's position
270 with in the queue. This is provided as an aid to the scheduler.
271 [This attribute is available to the batch manager only.]
272 queue_type
274 An identification of the the type of queue in which the job is
275 currently residing. This is provided as an aid to the sched‐
276 uler. [This attribute is available to the batch manager only.]
277 Format: The letter E or the letter r.
278 resources_used §
280 The amount of resources used by the job. This is provided as
281 part of job status information if the job is running.
282 server
284 The name of the server which is currently managing the job.
285 session_id
287 If the job is running, this is set to the session id of the
288 first executing task.
289 substate
291 A numerical indicator of the substate of the job. The substate
292 is used by the PBS job server internally. The attribute is
293 visible to privileged clients, such as the scheduler. Format:
294 integer.
295
297 PBS ERS, qsub(1B), qalter(1B), pbs_resources(7B)
298Local pbs_job_attributes(7B)