Ubuntu Manpage: pbs_job_attributes

Provided by: torque-client-x11_2.4.16+dfsg-1.5_amd64

NAME

       pbs_job_attributes - pbs job attributes

DESCRIPTION

A batch job has the following public attributes shown in the following list. The attributes marked with
the section symbol § are required by POSIX 1003.2d: If an attribute is unset, the indicated default value
is assumed.

Account_Name §
Used for accounting on some hosts. Format: string; default value: none, not used.

Checkpoint §
If supported by the server implementation and the host operating system, the checkpoint attribute
determines when checkpointing will be performed by PBS on behalf of the job. The legal values for
checkpoint are described under the qalter and qsub commands. Format: the strings "n", "s", "c",
"c=mmmm"; default value: "u", which is unspecified.

depend The type of inter-job dependencies specified by the job owner. Format: "type:jobid[,jobid...]";
default value: no dependencies.

Error_Path §
The final path name for the file containing the job's standard error stream. See the qsub and
qalter command description for more detail. Format: "[hostname:]pathname"; default value:
(job_name).e(job_number).

Execution_Time §
The time after which the job may execute. The time is maintained in seconds since Epoch. If this
time has not yet been reached, the job will not be scheduled for execution and the job is said to
be in wait state. Format: "[[CCwYY]MMDDhhmm[.ss]"; default value: time 0, no delay.

group_list §
A list of group_names@hosts which determines the group under which the job is run on a given host.
[internal type: array of strings] When a job is to be placed into execution, the server will
select a group name according to the following ordered set of rules:

1. Select the group name from the list for which the associated host name matches the name of the
execution host.

2. Select the group name which has no associated host name, the wild card name.

3. Use the login group for the user name under which the job will be run.

Format: "group_name[@host][,group_name[@host]...]".

Hold_Types §
The set of holds currently applied to the job. If the set is not null, the job will not be
scheduled for execution and is said to be in the hold state. Note, the hold state takes
precedence over the wait state. Format: string made up of the letters 'u', 's', 'o'; default
value: no hold.

Job_Name §
The name assigned to the job by the qsub or qalter command. Format: string up to 15 characters,
first character must be alphabetic; default value: the base name of the job script or STDIN.

Join_Path §
If the Join_Paths attribute is {TRUE}, then the job's standard error stream will be merged, inter-
mixed, with the job's standard output stream and placed in the file determined by the Output_Path
attribute. The Error_Path attribute is maintained, but ignored. Format: boolean, values accepted
are "True", "TRUE", "true", "Y", "y", "1", "False", "FALSE", "false", "N", "n", "0"; default
value: false.

Keep_Files §
If Keep_Files contains the values "o" and/or "e" the corresponding streams of the batch job will
be retained on the execution host upon job termination. Keep_Files overrides the Output_Path and
Error_Path attributes. Format: "o", "e", "oe" or "eo"; default value: no keep, return files to
submission host.

Mail_Points §
Identifies at which state changes the server will send mail about the job. Format: string made up
of the letters 'a' for abort, 'b' for beginning, and default value: 'a', send on job abort.

Mail_Users §
The set of users to whom mail may be sent when the job makes certain state changes. Format:
"user@host[,user@host]"; default value: job owner only.

Output_Path §
The final path name for the file containing the job's standard output stream. See the qsub and
qalter command description for more detail. Format: see error_path, default value:
(job_name).o(job_number).

Priority §
The job scheduling priority assigned by the user. Format: "[+|-]nnnnn"; default value: undefined.

Rerunable §
The rerunable flag given by the user. Format: "y" or "n", see Join_Path; default value: y, job is
rerunable.

Resource_List §
The list of resources required by the job. The resource list is a set of name=value strings. The
meaning of name and value is server dependent. The value also establishes the limit of usage of
that resource. If not set, the value for a resource may be determined by a queue or server
default established by the administrator. Default value: no usage or no limit depending on
specific resource.

Shell_Path_List §
A set of absolute paths of the program to process the job's script file. The list is in the
format: "path[@host][,path[@host]...]". If this is null, then the user's login shell on the host
of execution will be used. Default value: null, login shell.

stagein
The list of files to be staged in prior to job execution. Format:
local_path@remote_host:remote_path

stageout
The list of files to be staged out after job execution. Format:
local_path@remote_host:remote_path

User_List §
The list of user@hosts which determines the user name under which the job is run on a given host.
[internal type: array of strings] When a job is to be placed into execution, the server will
select a user name from the list according to the following ordered set of rules:

1. Select the user name from the list for which the associated host name matches the name of the
execution host.

2. Select the user name which has no associated host name, the wild card name.

3. Use the Job_Owner as the user name.

Default value: job owner name.

Variable_List §
This is the list of environment variables passed with the Queue Job batch request. Format:
"name=value[,name=value...]".

The following attributes require system, manager, or operator privilege to set. They are visible to
clients depending on privilege as noted.

comment
An attribute for displaying comments about the job from the system. Visible to any client.
Format: any string; default value: none.

sched_hint
This attribute is present when the job is a member of a synchronous dependency set. It is set
when the hold is released on the job. The value is {SYNC_SCHED_HINT_FIRST} (1) when the first job
of the set is released for scheduling. This is a hint that may be used by the scheduler to
decrease the priority of the job. This keeps a user from attempting to game the scheduler. The
attribute is set to {SYNC_SCHED_HINT_OTHER} (2) for all other jobs in the set as they become
schedulable. This should be taken as a hint by the scheduler to increase their priority to insure
they will run at the same time as the earlier scheduled jobs in the set. [This attribute is
viewable only by the batch administrator.] [type: integer]

The following attributes are read-only, they are established by the server and are visible to the client
but cannot be set by a client. Certain ones are only visible to privileged clients (those run by the
batch administrator).

alt_id For a few systems, such as Irix 6.x running Array Services, the session id is insufficient to
track which processes belong to the job. Where a different identifier is required, it is recorded
in this attribute. If set, it will also be recorded in the end-of-job accounting record.

For Irix 6.x running Array Services, the alt_id attribute is set to the Array Session Handle (ASH)
assigned to the job.

ctime The time that the job was created.

etime The time that the job became eligible to run, i.e. in a queued state while residing in an
execution queue.

exec_host
If the job is running, this is set to the name of the host on which the job is executing.

exit_status
The exit status of the job. This is only set on receipt of a job obituary notice from MOM, and
probably only useful if the "keep_completed" server attribute is set. Note that negative values
are generated internally by PBS to indicate system errors and are listed as the JOB_EXEC_* defines
in pbs_job.h. Positive values are returned from the user script and cannot be interpreted by PBS.

egroup If the job is queued in an execution queue, this attribute is set to the group name under which
the job is to be run. [This attribute is available only to the batch administrator.]

euser If the job is queued in an execution queue, this attribute is set to the user name under which the
job is to be run. [This attribute is available only to the batch administrator.]

hashname
The name used as a basename for various files, such as the job file, script file, and the standard
output and error of the job. [This attribute is available only to the batch administrator.]

interactive
True if the job is an interactive PBS job. Format: boolean, see Join_Paths; default value: false.

Job_Owner §
The login name on the submitting host of the user who submitted the batch job.

job_state
The state of the job.

E for exiting, the job has completed execution, with or without errors, and the batch system
is doing post-execution clean-up.

H for Held, one or more holds have been applied to the job.

Q for Queued, the job resides in a execution or routing queue pending execution or routing.
It is not in held or waiting state.

R for Running, the job resides in a execution queue and has been placed into execution.

S for Suspend (Job running on Unicos only), the job was executing and has been suspended.
The job retains its assigned resources but does not use cpu cycle or walltime.

T for Transiting, the job is in process of being routed or moved to a new destination.

W for Waiting, the job is not held but the Execution_Time attribute contains a time which has
not yet been reached.

mtime The time that the job was last modified, changed state, or changed locations.

qtime The time that the job entered the current queue.

queue The name of the queue in which the job currently resides.

queue_rank
An ordered, non-sequential number indicating the job's position with in the queue. This is
provided as an aid to the scheduler. [This attribute is available to the batch manager only.]

queue_type
An identification of the the type of queue in which the job is currently residing. This is
provided as an aid to the scheduler. [This attribute is available to the batch manager only.]
Format: The letter E or the letter r.

resources_used §
The amount of resources used by the job. This is provided as part of job status information if
the job is running.

server
The name of the server which is currently managing the job.

session_id
If the job is running, this is set to the session id of the first executing task.

substate
A numerical indicator of the substate of the job. The substate is used by the PBS job server
internally. The attribute is visible to privileged clients, such as the scheduler. Format:
integer.

NAME

DESCRIPTION

SEE ALSO