1pbs_server_attributes(7B) PBS pbs_server_attributes(7B)
2
6 pbs_server_attributes - pbs server attributes
7
9 Server attributes can be read by any client; privilege is not required.
10 Most server attributes are alterable by a privileged client, run by a
11 user with administrator or operator privilege. Certain attributes
12 require the user to have full administrator privilege. The following
13 is a list of the server attributes.
14 acl_group_sloppy
16 This is a default value for the queue attribute of the same
17 name. Format: boolean, "TRUE", "True", "true", "Y", "y", "1",
18 "FALSE", "False", "false", "N", "n", "0"; default value: false
19 = disabled.
20 acl_host_enable
22 Attribute which when true directs the server to use the
23 acl_hosts access control lists. Requires full manager privi‐
24 lege to set or alter. Format: boolean, "TRUE", "True",
25 "true", "Y", "y", "1", "FALSE", "False", "false", "N", "n",
26 "0"; default value: false = disabled.
27 acl_hosts
29 List of hosts which may request services from this server.
30 This list contains the network name of the hosts. Local
31 requests, i.e. from the server's host itself, are aways
32 accepted even if the host is not included in the list. See
33 section 10.1, Authorization, in the PBS External Reference
34 Specification. Requires full manager privilege to set or
35 alter. Format: "[+|-]hostname.domain[,...]"; default value:
36 all hosts.
37 acl_logic_or
39 This is a default value for the queue attribute of the same
40 name. Format: boolean, "TRUE", "True", "true", "Y", "y", "1",
41 "FALSE", "False", "false", "N", "n", "0"; default value: false
42 = disabled.
43 acl_user_enable
45 Attribute which when true directs the server to use the server
46 level acl_users access list. Requires full manager privilege
47 to set or alter. Format: boolean (see acl_group_enable);
48 default value: disabled.
49 acl_users
51 List of users allowed or denied the ability to make any
52 requests of this server. See section 10.1, Authorization, in
53 the PBS External Reference Specification. If acl_user_enable
54 is set to true, only users listed in acl_users may submit to
55 or execute jobs in the queue. Requires full manager privilege
56 to set or alter. Format: "[+|-]user[@host][,...]"; default
57 value: all users allowed.
58 acl_roots
60 List of super users who may submit to and execute jobs at this
61 server. If the job execution id would be zero (0), then the
62 job owner, root@host, must be listed in this access control
63 list or the job is rejected. Format:
64 "[+|-]user[@host][,...]"; default value: no root jobs allowed.
65 allow_node_submit
67 Allow job submissions from compute nodes regardless of
68 ruserok(). Requires full manager privilege to set or alter.
69 Format: boolean; default value: disabled.
70 auto_node_np
72 Automatically configure a node's np value based on the ncpus
73 value from the status update. Requires full manager privilege
74 to set or alter. Format: boolean; default value: disabled.
75 comment
77 A text string which may be set by the scheduler or other priv‐
78 ileged client to provide information to the batch system
79 users. Format: any string; default value: none.
80 default_node
82 A node specification to use if there is no other supplied
83 specification. This attribute is only used by servers where a
84 nodes file exist in the server_priv directory providing a list
85 of nodes to the server. If the nodes file does not exist,
86 this attribute is not set by default and is ignored if set.
87 The default value allows for jobs to share a single node.
88 Format: a node specification string; default value: 1#shared.
89 default_queue
91 The queue which is the target queue when a request does not
92 specify a queue name. Format: a queue name; default value:
93 none, must be set to an existing queue.
94 down_on_error
96 Set a node's state to "down" if MOM reports a message begin‐
97 ning with the string "ERROR". This might interfere with
98 moab's node error handling. See the HEALTH CHECK section in
99 pbs_mom(8B). This is an EXPERIMENTAL feature and may be
100 removed in the future. Format: boolean; default value: false.
101 extra_resc
103 Add additional string-type job resources. They have no effect
104 within TORQUE and are only advisible to the scheduler. They
105 can not be used for resources_default/min/max. Format: list;
106 default value: none.
107 job_nanny
109 Enables the "job deletion nanny" feature. All job cancels
110 will create a repeating task that will resend KILL signals if
111 the initial job cancel failed. Further job cancels will be
112 rejected with the message "job cancel in progress." This is
113 useful for temporary failures with a job's execution node dur‐
114 ing a job delete request. It is possible that the job nanny
115 might interfere with job restarts, migrations, and checkpoint‐
116 ing. Format: boolean; default value: false.
117 job_start_timeout
119 Specifies the pbs_server to pbs_mom TCP socket timeout in sec‐
120 onds that is used when the pbs_server sends a job start to the
121 pbs_mom. It is useful when the mom has extra overhead
122 involved in starting jobs. If not specified then the
123 tcp_timeout value is used.
124 job_stat_rate
126 Moderates how often job stat requests will be issued from
127 pbs_server to the MOM daemons. If poll_jobs is unset or
128 false, then all jobs that haven't been updated in
129 job_stat_rate seconds will trigger a stat request. If
130 poll_jobs is true, then all jobs will be updated every
131 job_stat_rate.
132 (see poll_jobs) On active clusters, 60 or 120 might be rea‐
133 sonable. Default value: 45 seconds (PBS_RESTAT_JOB in
134 server_limits.h) Minimum value: 4 seconds (PBS_JOBSTAT_MIN in
135 server_limits.h)
136 keep_completed
138 Number of seconds to retain completed jobs in the C state.
139 This is overridden by the execution queue attribute of the
140 same name. Format: integer; default value: 0.
141 kill_delay
143 The amount of the time delay between the sending of SIGTERM
144 and SIGKILL when a qdel command is issued against a running
145 job. This is overridden by the execution queue attribute of
146 the same name. Format: integer seconds; default value: 2 sec‐
147 onds.
148 log_events
150 A bit string which specifies the type of events which are
151 logged, see the section on Event Logging in chapter 3 of the
152 ERS. Format: integer; default value: 511, all events.
153 log_file_max_size
155 If this is set to a value > 0 then pbs_server will roll the
156 current log file to logfile.1 when its size is greater than or
157 equal to the value of log_file_max_size. This value is inter‐
158 preted as kilobytes.
159 log_file_roll_depth
161 If this is set to a value >=1 and log_file_max_size is set
162 then pbs_server will continue rolling the log files to log‐
163 file.log_file_roll_depth.
164 log_level
166 Controls the verbosity of server logs. This value ranges from
167 0 to 7 with 7 representing maximum verbosity. Format: inte‐
168 ger; default value: 0, minimum verbosity.
169 mail_body_fmt
171 Override the default format for the body of outgoing mail mes‐
172 sages. A number of printf-like format specifiers and escape
173 sequences can be used:
174 \n new line
176 \t horizontal tab
178 \\ backslash
180 \' single quote
182 \" double quote
184 %d details concerning the message
186 %h PBS host name
188 %i PBS job identifier
190 %j PBS job name
192 %m long reason for message
194 %r short reason for message
196 %% a single %
198 Format: a printf-like format string; Default value: "PBS Job Id:
200 %i\nJob Name: %j\nExec host: %h\n%m\n%d\n".
201 mail_domain
203 Override the default domain for outgoing mail messages. If
204 set, emails will be addressed to "euser@mail_domain". If
205 unset, the job's Job_Owner attribute will be used. Format: a
206 domain name; Default value: none.
207 mail_subject_fmt
209 Override the default format for the subject of outgoing mail
210 messages. A number of printf-like format specifiers and escape
211 sequences can be used:
212 \n new line
214 \t horizontal tab
216 \\ backslash
218 \' single quote
220 \" double quote
222 %d details concerning the message
224 %h PBS host name
226 %i PBS job identifier
228 %j PBS job name
230 %m long reason for message
232 %r short reason for message
234 %% a single %
236 Format: a printf-like format string; Default value: "PBS JOB %i".
238 mail_uid
240 The uid from which server generated mail is sent to users.
241 Format: integer uid; default value: 0 for root.
242 managers
244 List of users granted batch administrator privileges. Format:
245 user@host.sub.domain[,user@host.sub.domain...]. The host,
246 sub-domain, or domain name may be wild carded by the use of an
247 * character, see the description of user access control lists
248 in chapter 10.1.1 of the ERS. Requires full manager privilege
249 to set or alter. Default value: root on the local host.
250 max_running
252 The maximum number of jobs allowed to be selected for execu‐
253 tion at any given time. Advisory to the Scheduler, not
254 enforced by the server. Format: integer.
255 max_user_run
257 The maximum number of jobs owned by a single user that are
258 allowed to be running from this queue at one time. This
259 attribute is advisory to the Scheduler, it is not enforced by
260 the server. Format: integer; default value: none.
261 max_group_run
263 The maximum number of jobs owned by any users in a single
264 group that are allowed to be running from this queue at one
265 time. This attribute is advisory to the Scheduler, it is not
266 enforced by the server. Format: integer; default value: none.
267 mom_job_sync
269 Enables the "job sync on MOM" feature. When MOMs send a sta‐
270 tus update, and it includes a list of jobs, server will issue
271 job deletes for any jobs that don't actually exist. Format:
272 boolean; default value: true.
273 next_job_number
275 This hidden attribute is used to allow a manager to set the
276 value of the next job ID via qmgr. This attribute should
277 rarely be modified. Some sites may find it useful if they need
278 to recreate their pbs_server database (perhaps due to a format
279 change between major TORQUE versions) and they keep a database
280 of job information indexed by the job ID. The manager should
281 be careful to avoid setting the value to something that would
282 allow the next job number to conflict with a job already
283 queued, however Torque will handle this in a sane manner: the
284 job submission will be rejected and the next job number will
285 be incremented.
286 net_counter
288 Lists the 3 numbers representing the number of connections in
289 the last 5 seconds, 30 seconds, and 60 seconds. This is a
290 read-only attribute. Format: string; default value: none.
291 node_check_rate
293 In OpenPBS, this was the rate at which pbs_server would poll
294 each node. In TORQUE, nodes periodically send updates without
295 solicitation from pbs_server; this attribute is now used as
296 the maximum number of seconds allowed without an update before
297 pbs_server will consider the node down. Format: integer;
298 default value: 150
299 node_pack
301 Controls how multiple processor nodes are allocated to jobs.
302 If this attribute is set to true, jobs will be assigned to the
303 multiple processor nodes with the fewest free processors.
304 This packs jobs into the fewest possible nodes leaving multi‐
305 ple processor nodes free for jobs which need many processors
306 on a node. If set to false, jobs will be scattered across
307 nodes reducing conflicts over memory between jobs. If unset,
308 the jobs are packed on nodes in the order that the nodes are
309 declared to the server (in the nodes file). Default value:
310 unset - assigned to nodes as nodes in order that were
311 declared.
312 operators
314 List of users granted batch operator privileges. Format of
315 the list is identical with managers above. Requires full man‐
316 ager privilege to set or alter. Default value: root on the
317 local host.
318 poll_jobs
320 Controls how pbs_server will send job status requests to MOMs.
321 When unset or false, statjob requests from clients (ie:
322 qstat(1B) or the scheduler) may trigger job status requests to
323 MOMs and and must wait until the MOMs have replied; this is
324 suitable for small to medium sized clusters. When set to
325 true, pbs_server will send periodic job status requests; this
326 is suitable for busy clusters with lots of jobs, lots of
327 clients, qstat(1B) is too slow, or your scheduler times out.
328 (see job_stat_rate) Default value: TRUE
329 query_other_jobs
331 The setting of this attribute controls if general users, other
332 than the job owner, are allowed to query the status of or
333 select the job. Format: boolean (see acl_host_enable);
334 Requires full manager privilege to set or alter. default
335 value: false - users may not query or select jobs owned by
336 other users.
337 resources_available
339 The list of resource and amounts available to jobs run by this
340 server. The sum of the resource of each type used by all jobs
341 running by this server cannot exceed the total amount listed
342 here. Advisory to the Scheduler, not enforced by the server.
343 Format: "resources_available.resource_name=value[,...]".
344 resources_cost
346 The cost factors of various types of resources. These values
347 are used in determining the order of releasing members of syn‐
348 chronous job sets, see the section on Synchronize Job Starts.
349 For the most part, these value are purely arbitrary and have
350 meaning only in the relative values between systems. The cost
351 of the resources requested by a job is the sum of the products
352 of the various resources_cost s and the amount of each
353 resource requested by the job. It is not necessary to assign
354 a cost for each possible resource, only those which the site
355 wishes to be considered in synchronous job scheduling. For‐
356 mat: "resources_cost.resource_name=value[,...]"; default
357 value: none, cost of resource is not computed.
358 resources_default
360 The list of default resource values that are set as limits for
361 a job executing on this server when the job does not specify a
362 limit, and there is no queue default. Format:
363 "resources_default.resource_name=value[,...]"; default value:
364 no limit.
365 resources_max
367 The maximum amount of each resource which can be requested by
368 a single job executing on this server if there is not a
369 resources_max valued defined for the queue in which the job
370 resides. Format: "resources_max.resource_name=value[,...]";
371 default value: infinite usage.
372 sched_version
374 A string specifying the scheduler version. Schedulers should
375 check this string when starting and not become active if the
376 wrong string is found. This is ignored by pbs_server.
377 scheduler_iteration
379 The time, in seconds, between iterations of attempts by the
380 batch server to schedule jobs. On each iteration, the server
381 examines the available resources and runnable jobs to see if a
382 job can be initiated. This examination also occurs whenever a
383 running batch job terminates or a new job is placed in the
384 queued state in an execution queue. Format: integer seconds;
385 default value: 10 minutes, set by {PBS_SCHEDULE_CYCLE} in
386 server_limits.h.
387 scheduling
389 Controls if the server will request job scheduling by the PBS
390 job scheduler. If true, the scheduler will be called as
391 required; if false, the scheduler will not be called and no
392 job will be placed into execution unless the server is
393 directed to do so by an operator or administrator. Setting or
394 resetting this attribute to true results in an immediate call
395 to the scheduler. For more information, see the section
396 Scheduler - Server Interaction in the PBS Administrator Guide.
397 Format: boolean (see acl_host_enable); default value: value of
398 -a option when server is invoked, if -a is not specified, the
399 value is recovered from the prior server run. If it has never
400 been set, the value is "false".
401 server_name
403 The name of the server which is the same as the host name. If
404 the hostname resolves to an external IP address, then set this
405 to a name that resolves to the internal IP.
406 submit_hosts
408 A list of hostnames allowed to submit jobs to this batch
409 server regardless of ruserok().
410 system_cost
412 An arbitrary value factored into the resource cost of any job
413 managed by this server for the purpose of selecting which mem‐
414 ber of synchronous set is released first, see resources_cost
415 and section 3.2.2, Synchronize Job Starts. [default value:
416 none, cost of resource is not computed]
417 tcp_timeout
419 Specifies the pbs_server to pbs_mom TCP socket timeout in sec‐
420 onds. Format: integer; default value: 6.
421 The following attributes are read-only, they are maintained by the
423 server and cannot be changed by a client.
424 resources_assigned
426 The total amount of certain types of resources allocated to
427 running jobs.
428 server_state
430 The current state of the server:
431 Active The server is running and will invoke the job scheduler
433 as required to schedule jobs for execution.
434 Idle The server is running but will not invoke the job
436 scheduler.
437 Scheduling
439 The server is running and there is an outstanding
440 request to the job scheduler.
441 Terminating
443 The server is terminating. No additional jobs will be
444 scheduled.
445 Terminating, Delayed
447 The server is terminating in delayed mode. The server
448 will not run any new jobs and will shutdown when the
449 last currently executing job completes.
450 state_count
452 The total number of jobs managed by the server currently in
453 each state.
454 total_jobs
456 The total number of jobs currently managed by the server.
457 PBS_version
459 The release version number of the server.
460
462 the PBS ERS, qmgr(1B), pbs_resources(7B)
463Local pbs_server_attributes(7B)