pbs_job_attributes(7B)

πŸ“¦ version 23.06.06-unstable-2026-04, in nixos 26.05, nixpkgs unstable

πŸ¦‹ pbs_job_attributes(7B) πŸ¦‹

okay bestie, welcome to the PBS Professional manual, section 7B: attributes of PBS jobs. This is part 1, and it is literally the character sheet for every job. ✨


πŸ’– NAME πŸ’–

pbs_job_attributes β€” attributes of PBS jobs

✨ DESCRIPTION ✨

Each PBS job has attributes that characterize that job. No cap, every job has its own little attribute stack, and this page is the whole vibe check for part 1.

πŸ“ Account_Name

String used for accounting purposes. Can be used for fairshare.

  • Access: Can be read and set by user, Operator, Manager.
  • Format: String; can contain any character.
  • Python type: str
  • Default: No default

🧚 accounting_id

Accounting ID for tracking accounting data not produced by PBS.

  • Access: Readable by all.
  • Format: String
  • Python type: str

πŸŽ€ accrue_type

Indicates what kind of time the job is accruing.

  • Access: Readable by Manager only.
  • Format: Integer
  • Python type: int
  • Valid values:
    • One of 0 (initial_time), 1 (ineligible_time), 2 (eligible_time), or 3 (run_time).
  • Default: 2 (eligible_time)

πŸ¦‹ alt_id

For a few systems, 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. On Windows, holds PBS home directory.

  • Access: Readable by all; settable by None.
  • Format: String; may contain white spaces.
  • Python type: str
  • Default: No default

🌸 argument_list

Job executable's argument list. Shown if job is submitted with "-- <executable> [<argument list>]".

  • Access: Can be read and set by user, Operator, Manager.
  • Format: JSDL=encoded string
<jsdl-hpcpa:Argument> <1st arg> </jsdl-hpcpa:Argument>
<jsdl-hpcpa:Argument> <2nd arg> </jsdl-hpcpa:Argument>
<jsdl-hpcpa:Argument> <nth arg> </jsdl-hpcpa:Argument>
  • Example: If arguments are "A B":
<jsdl-hpcpa:Argument>A</jsdl-hpcpa:Argument> <jsdl-hpcpa:Argument>B</jsdl-hpcpa:Argument>
  • Python type: str
  • Default: No default

πŸ’… array

Indicates whether this is a job array. Set to True if this is an array job.

  • Access: Can be read and set by user. Can be read by Manager and Operator.
  • Format: Boolean
  • Python type: bool
  • Default: False

🫢 array_id

Applies only to subjobs. Array identifier of subjob.

  • Access: Readable by all; set by PBS.
  • Format: String
  • Python type: str
  • Default: No default

πŸ“ array_index

Applies only to subjobs. Index number of subjob.

  • Access: Readable by all; set by PBS.
  • Format: String
  • Python type: int
  • Default: No default

🌈 array_indices_remaining

Applies only to job arrays. List of indices of subjobs still queued.

  • Access: Readable by all; set by PBS.
  • Format: String
  • Syntax: Range or list of ranges, e.g. 500, 552, 596-1000
  • Python type: str
  • Default: No default

πŸ‘‘ array_indices_submitted

Applies only to job arrays. Complete list of indices of subjobs given at submission time.

  • Access: Can be read and set by user. Can be read by Manager and Operator.
  • Format: String
  • Syntax: Given as range, e.g. 1-100
  • Python type: pbs.range
  • Default: No default

⭐ array_state_count

Applies only to job arrays. Lists number of subjobs in each state.

  • Access: Readable by all; set by PBS.
  • Format: String
  • Python type: pbs.state_count
  • Default: No default

🧚 block

Specifies whether qsub will wait for the job to complete and return the exit value of the job.

For X11 forwarding jobs, and jobs with interactive and block attributes set to True, the job's exit status is not returned.

When block is True, qsub waits for the job to finish.

  • Access: Can be read and set by user. Can be read by Manager and Operator.
  • Format: Boolean
  • Python type: int
  • Default: False

πŸ’– Checkpoint

Determines when the job will be checkpointed. An $action script is required to checkpoint the job. See the pbs_mom(8B) man page.

  • Access: Can be read and set by user, Operator, Manager.
  • Format: String, containing description of interval at which to checkpoint.
  • Python type: pbs.checkpoint
  • Valid values:
    • c β€” Checkpoint at intervals, measured in CPU time, set on the job's execution queue. If no interval set at queue, job is not checkpointed.
    • c=<minutes of CPU time> β€” Checkpoint at intervals of the specified number of minutes of job CPU time. This value must be greater than zero. If the interval specified is less than that set on the job's execution queue, the queue's interval is used. Format: Integer
    • w β€” Checkpoint at intervals, measured in walltime, set on job's execution queue. If no interval set at queue, job is not checkpointed.
    • w=<minutes of walltime> β€” Checkpoint at intervals of the specified number of minutes of job walltime. This value must be greater than zero. If the interval specified is less than that set on job's execution queue, the queue's interval is used. Format: Integer
    • n β€” No checkpointing.
    • s β€” Checkpoint only when the server is shut down.
    • u β€” Unset. Defaults to behavior when interval argument is set to s.
  • Default: u

πŸŽ€ comment

Comment about job. Informational only.

  • Access: Can be read by user. Can be read and set by Operator, Manager.
  • Format: String
  • Python type: str
  • Default: No default

🌟 create_resv_from_job

When this attribute is True, when this job is run, immediately creates and confirms a job-specific start reservation on the same resources as the job (including resources inherited by the job), and places the job in the job-specific reservation's queue. Sets the job's create_resv_from_job attribute to True. Sets the job-specific reservation's reserve_job attribute to the ID of the job from which the reservation was created. The new reservation's duration and start time are the same as the job's walltime and start time. If the job is peer scheduled, the job-specific reservation is created in the pulling complex.

  • Access: Readable and settable by all.
  • Format: Boolean
  • Python type: bool
  • Default: False

πŸ¦‹ ctime

Timestamp; time at which the job was created.

  • Access: Readable by all; set by PBS.
  • Format: Integer
  • Syntax: Timestamp. Printed by qstat in human-readable format. Output by hooks as seconds since epoch.
  • Python type: int
  • Default: No default

πŸ’œ depend

Specifies inter-job dependencies. No limit on number of dependencies.

  • Access: Can be read and set by user, Operator, Manager.
  • Format: String
  • Syntax:
"<type>:<job ID>[,<job ID> ...][,<type>:<job ID>[,<job ID> ...] ...]"
Must be enclosed in double quotes if it contains commas.
  • Example: "before:123,456"
  • Python type: pbs.depend
  • Valid values:
    • after:<job ID list> β€” This job may run at any point after all jobs in job ID list have started execution.
    • afterok:<job ID list> β€” This job may run only after all jobs in job ID list have terminated with no errors.
    • afternotok:<job ID list> β€” This job may run only after all jobs in job ID list have terminated with errors.
    • afterany:<job ID list> β€” This job can run after all jobs in job ID list have finished execution, with or without errors. This job will not run if a job in the job ID list was deleted without ever having been run.
    • before:<job ID list> β€” Jobs in job ID list may start once this job has started.
    • beforeok:<job ID list> β€” Jobs in job ID list may start once this job terminates without errors.
    • beforenotok:<job ID list> β€” If this job terminates execution with errors, jobs in job ID list may begin.
    • beforeany:<job id list> β€” Jobs in job ID list may begin execution once this job terminates execution, with or without errors.
    • on:<count> β€” This job may run after count dependencies on other jobs have been satisfied. This type is used with one of the before types listed. Count is an integer greater than 0.
  • Default: No dependencies

🌸 egroup

If the job is queued, this attribute is set to the group name under which the job is to be run.

  • Access: Readable by Manager only.
  • Format: String
  • Python type: str
  • Default: No default

🌈 eligible_time

The amount of wall clock wait time a job has accrued while the job is blocked waiting for resources. For a job currently accruing eligible_time, if we were to add enough of the right type of resources, the job would start immediately.

Viewable via qstat -f.

  • Access: Readable by job owner, Manager and Operator. Settable by Operator or Manager.
  • Format: Duration
  • Python type: pbs.duration
  • Default: Zero

πŸ“ Error_Path

The final path name for the file containing the job's standard error stream. See the qsub and qalter commands.

  • Access: Can be read and set by user, Operator, Manager.
  • Format: String
  • Python type: str
  • Syntax: [<hostname>:]<path>
  • Valid values:
    • <relative path> β€” Path is relative to the current working directory of command executing on current host.
    • <absolute path> β€” Path is absolute path on current host where command is executing.
    • <hostname>:<relative path> β€” Path is relative to user's home directory on specified host.
    • <hostname>:<absolute path> β€” Path is absolute path on named host.
    • No path β€” Path is current working directory where qsub is executed.

Default: Default path is current working directory where qsub is run. If the output path is specified, but does not include a filename, the default filename is <job ID>.ER. If the path name is not specified, the default filename is <job name>.e<sequence number>. πŸ’–

estimated 🌸

List of estimated values for job. Used to report job's exec_vnode, start_time, and soft_walltime. Can be set in a hook or via qalter, but PBS will overwrite the values.

Format: Format of reported element

Syntax:

estimated.<resource name>=<value>[, estimated.<resource name>=<value> ...]

Python type: pbs.pbs_resource

Syntax:

estimated.<resource name>=<value>

where <resource name> is a resource.

Reported values:

exec_vnode β€” The estimated vnodes used by this job. Readable by all; settable by Manager and Operator. Format: String Python type: pbs.exec_vnode Default: Unset

soft_walltime β€” The estimated soft walltime for this job. Calculated when a job exceeds its soft_walltime resource. Readable by all; settable by Manager. Format: Duration Python type: pbs.duration Default: Unset

start_time β€” The estimated start time for this job. Readable by all; settable by Manager and Operator. Format: start_time is printed by qstat in human-readable format; start_time output in hooks as seconds since epoch. Python type: int Default: Unset

etime πŸ¦‹

Timestamp; time when job became eligible to run, i.e. was enqueued in an execution queue and was in the "Q" state. Reset when a job moves queues, or is held then released. Not affected by qaltering. lowkey important, bestie.

Readable by all; set by PBS. Format: Integer Syntax: Printed by qstat in human-readable format. Output in hooks as seconds since epoch. Python type: int Default: No default

euser πŸŽ€

If the job is queued, this attribute is set to the user name under which the job is to be run.

Readable by Manager only; set by PBS. Format: String Python type: str Default: No default

executable ✨

JSDL-encoded listing of job's executable. Shown if job is submitted with "-- <executable> [<arg list>]".

Can be read and set by user, Operator, Manager. Format: JSDL-encoded string Syntax:

<jsdl-hpcpa:Executable> <name of executable>

Example: If the executable is ping, the string is

<jsdl-hpcpa:Executable>ping</jsdl-hpcpa:Executable>

Python type: str Default: No default

Execution_Time πŸ’…

Timestamp; time after which the job may execute. Before this time, the job remains queued in the (W)ait state. Can be set when stage-in fails and PBS moves job start time out 30 minutes to allow user to fix problem.

Can be read and set by user, Operator, Manager. Format: Datetime Syntax:

[[CCwYY]MMDDhhmm[.ss]

Python type: int Default: Unset (no delay)

exec_host πŸ”₯

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

Can be read by user, Operator, Manager. Format: String Syntax:

<hostname>/N[*C][+...],

where N is task slot number, starting with 0, on that vnode, and C is the number of CPUs allocated to the job. *C does not appear if C has a value of 1.

Python type: pbs.exec_host Default: No default

exec_vnode 🫢

List of chunks for the job. Each chunk shows the name of the vnode(s) from which it is taken, along with the host-level, consumable resources allocated from that vnode, and any AOE provisioned on this vnode for this job.

If a vnode is allocated to the job but no resources from the vnode are used by the job, the vnode name appears alone.

If a chunk is split across vnodes, the name of each vnode and its resources appear inside one pair of parentheses, joined with a plus sign ("+").

Can be read by user. Can be read and set by Manager, Operator. Format: String Syntax: Each chunk is enclosed in parentheses, and chunks are connected by plus signs.

Example: For a job which requested two chunks that were satisfied by resources from three vnodes, exec_vnode is

(vnodeA:ncpus=N:mem=X)+(vnodeB:ncpus=P:mem=Y+vnodeC:mem=Z)

For a job which requested one chunk and exclusive use of a 2-vnode host, where the chunk was satisfied by resources from one vnode, exec_vnode is

(vnodeA:ncpus=N:mem=X)+(vnodeB)

Python type: pbs.exec_vnode Default: No default

Exit_status 😭

Exit status of job. Set to zero for successful execution. If any subjob of an array job has non-zero exit status, the array job has non-zero exit status.

Readable by all; set by PBS. Format: Integer Python type: int Default: No default

Contains the X authorization cookie.

Readable by all; set by PBS. Format: String Python type: int Default: No default

forward_x11_port 🌈

Contains the number of the port being listened to by the port forwarder on the submission host.

Readable by all; set by PBS. Format: Integer Python type: int Default: No default

group_list πŸ‘‘

A list of group names used to determine the group under which the job runs. When a job runs, the server selects a group name from the list according to the following ordered set of rules:

  1. Select the group name for which the associated host name matches the name of the server host.
  2. Select the group name which has no associated host name.
  3. Use the login group for the user name under which the job will be run.

Can be read and set by user, Operator, Manager. Format: String Syntax:

<group name>[@<hostname>] [,<group name>[@<hostname>] ...]

Must be enclosed in double quotes if it contains commas.

Python type: pbs.group_list Default: No default

hashname πŸ’€

No longer used. that's it, that's the entry. 🫠

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 held state. The held state takes precedence over the wait state.

Can be read and set by user, Operator, Manager. Format: String, made up of the letters 'n', 'o', 'p', 's', 'u'

Hold types:

  • n β€” No hold
  • o β€” Other hold
  • p β€” Bad password
  • s β€” System hold
  • u β€” User hold

Python type: pbs.hold_types Default: n (no hold)

interactive πŸ¦„

Specifies whether the job is interactive.

When both this attribute and the block attribute are True, no exit status is returned. For X11 forwarding jobs, the job's exit status is not returned.

Cannot be set using a PBS directive.

🚨 No cap: Job arrays cannot be interactive.

Can be set, but not altered, by unprivileged user. Can be read by Operator, Manager. Format: Boolean Python type: int Default: False

jobdir πŸ’œ

Path of the job's staging and execution directory on the primary execution host. Either user's home, or private sandbox. Depends on value of sandbox attribute. Viewable via qstat -f.

Readable by all; set by PBS. Format: String Python type: str Default: No default

Job_Name 🌟

The job name. See the qsub and qalter commands.

Can be read and set by user, Operator, Manager. Format: String up to 236 characters, first character must be alphabetic or numeric Python type: str Default: Base name of job script, or STDIN

Job_Owner 🎯

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

Readable by all; set by PBS. Format: String Python type: str Default: No default

job_state πŸ’«

The state of the job.

Readable by all. Can be set indirectly by all. Format: Character

Job states:

  • B β€” Begun. Job arrays only. The job array has begun execution. Python type: PBS job state constant pbs.JOB_STATE_BEGUN
  • E β€” Exiting. The job has finished, with or without errors, and PBS is cleaning up post-execution. Python type: PBS job state constant pbs.JOB_STATE_EXITING
  • F β€” Finished. Job is finished. Job has completed execution, job failed during execution, or job was deleted. Python type: PBS job state constant pbs.JOB_STATE_FINISHED
  • H β€” Held. The job is held. Python type: PBS job state constant pbs.JOB_STATE_HELD
  • M β€” Moved. Job has been moved to another server. Python type: PBS job state constant pbs.JOB_STATE_MOVED
  • Q β€” Queued. The job resides in an execution or routing queue pending execution or routing. It is not in held or waiting state. Python type: PBS job state constant pbs.JOB_STATE_QUEUED
  • R β€” Running. The job is in an execution queue and is running. Python type: PBS job state constant pbs.JOB_STATE_RUNNING
  • S β€” Suspended. The job was executing and has been suspended. The job does not use CPU cycles or walltime. Python type: PBS job state constant pbs.JOB_STATE_SUSPEND
  • T β€” Transiting. The job is being routed or moved to a new destination. Python type: PBS job state constant pbs.JOB_STATE_TRANSIT
  • U β€” User suspended. The job was running on a workstation set up for cycle harvesting, and the keyboard/mouse is busy right now. The job stays suspended until the workstation has been idle for a configured amount of time. Python type: PBS job state constant pbs.JOB_STATE_SUSPEND_USERACTIVE
  • W β€” Waiting. The Execution_Time attribute holds a time in the future. This can get set when stage-in fails and PBS pushes the job's start time out 30 minutes so you can go fix the problem. Python type: PBS job state constant pbs.JOB_STATE_WAIITING
  • X β€” Expired. Subjobs only, bestie. The subjob is finished (expired). Python type: PBS job state constant pbs.JOB_STATE_EXPIRED

🌸 Join_Path 🌸

Tells you whether the job's standard error and standard output streams get merged together and dropped into the file named in the Output_Path job attribute.

When it's set to True, the job's standard error and standard output streams are merged. Slay.

Can be read and set by user, Operator, Manager.

Format: String

Behavior:

  • eo β€” Standard output and standard error are merged, intermixed, into a single stream, which becomes standard error.
  • oe β€” Standard output and standard error are merged, intermixed, into a single stream, which becomes standard output.
  • n β€” Standard output and standard error are not merged.

Python type: pbs.join_path Default: False

πŸŽ€ Keep_Files πŸŽ€

Specifies whether the standard output and/or standard error streams are retained on the execution host β€” in the job's staging and execution directory β€” after the job has executed. Otherwise these files get returned to the submission host. Heads up: Keep_Files overrides the Output_Path and Error_Path attributes.

Readable and settable by all.

Format: String Python type: pbs.keep_files Valid values: Can be one of the following:

  • o β€” The standard output stream is retained. The filename is: <job name>.o<sequence number>
  • e β€” The standard error stream is retained. The filename is: <job name>.e<sequence number>
  • eo, oe β€” Both standard output and standard error streams are retained.
  • d β€” Output and error are written directly to their final destination
  • n β€” Neither stream is retained. Files are returned to submission host.

Default: n (neither stream is retained, and files are returned to submission host.)

πŸ’Œ Mail_Points πŸ’Œ

Specifies which state changes make the server send mail about the job. Your inbox said what it said.

Can be read and set by user, Operator, Manager.

Format: String Python type: pbs.mail_points Valid values: Combination of a, b, and e, with optional j, or n by itself.

  • a β€” Mail is sent when job is aborted
  • b β€” Mail is sent at beginning of job
  • e β€” Mail is sent when job ends
  • j β€” Mail is sent for subjobs. Must be combined with one or more of the a, b, and e options.
  • n β€” No mail is sent. Cannot be combined with other options.

Default: a

🫢 Mail_Users 🫢

The set of users who get mailed when the job makes state changes specified in the Mail_Points job attribute.

Can be read and set by user, Operator, Manager.

Format: String Syntax: "<username>@<hostname>[,<username>@<hostname>]" Python type: pbs.email_list Default: Job owner only

πŸ”₯ max_run_subjobs πŸ”₯

Sets a limit on the number of subjobs that can be running at one time. Can be set using qsub -J <range> [%<max subjobs>] or qalter -Wmax_run_subjobs=<new value> <job ID>.

⭐ mtime ⭐

Timestamp; the time that the job was last modified, changed state, or changed locations.

Format: Integer. Syntax: Timestamp. Printed by qstat in human-readable format; output in hooks as seconds since epoch.

Python type: int Default: No default

πŸ’€ no_stdio_sockets πŸ’€

Not used. That's it. That's the whole vibe. Nothing to see here.

πŸ¦‹ Output_Path πŸ¦‹

The final path name for the file containing the job's standard output stream. See the qsub and qalter commands.

Can be read and set by user, Operator, Manager.

Format: String Python type: str Syntax: [<hostname>:]<path>

Valid values:

  • <relative path> β€” Path is relative to the current working directory of the command executing on current host.
  • <absolute path> β€” Path is absolute path on current host where the command is executing.
  • <hostname>:<relative path> β€” Path is relative to user's home directory on the specified host.
  • <hostname>:<absolute path> β€” Path is absolute path on the named host.
  • No path β€” Path is the current working directory where qsub is executed.

Default: Default path is the current working directory where qsub is run. If the output path is specified, but does not include a filename, the default filename is <job ID>.OU. If the path name is not specified, the default filename is <job name>.o<sequence number>.

⚑ pcap_accelerator ⚑

Power attribute. Power cap for an accleerator. Corresponds to Cray capmc set_power_cap --accel setting. See capmc documentation.

Readable and settable by all.

Format: Integer Units: Watts Python type: int Default: Unset

πŸ”Œ pcap_node πŸ”Œ

Power attribute. Power cap for a node. Corresponds to Cray capmc set_power_cap --node setting. See capmc documentation.

Readable and settable by all.

Format: Integer Units: Watts Python type: int Default: Unset

🌈 pgov 🌈

Power attribute. Cray ALPS reservation setting for CPU throttling corresponding to p-governor. See BASIL 1.4 documentation.

Bestie, we do not recommend using this attribute. Like, at all. Consider this your warning.

Readable and settable by all.

Format: String Python type: str Default: Unset

πŸ‘‘ Priority πŸ‘‘

The scheduling priority for the job. Higher value indicates higher priority. Main character energy, quantified.

Can be read and set by user, Operator, Manager.

Format: Integer Syntax: [+|-]nnnnn Valid values: [-1024, +1023] inclusive Python type: int Default: Unset

πŸ“ project πŸ“

The job's project. A project is a way to tag jobs. Each job can belong to at most one project.

Readable and settable by user, Operator, Manager.

Format: String Can contain any characters except for the following: Slash ("/"), left bracket ("["), right bracket ("]"), double quote ("""), semicolon (";"), colon (":"), vertical bar ("|"), left angle bracket ("<"), right angle bracket (">"), plus ("+"), comma (","), question mark ("?"), and asterisk ("*").

Python type: str Default: "_pbs_project_default"

🧚 pset 🧚

Deprecated. Name of the placement set used by the job.

Can be read by user, Operator. Can be read and set by Manager.

Format: String Python type: str Default: No default

πŸ’œ pstate πŸ’œ

Power attribute. Cray ALPS reservation setting for CPU frequency corresponding to p-state. See BASIL 1.4 documentation.

Readable and settable by all.

Format: String Units: Hertz Python type: str Default: Unset

⏰ qtime ⏰

Timestamp; the time that the job entered the current queue.

Readable by all; settable only by PBS.

Format: Integer Syntax: Timestamp. Printed by qstat in human-readable format; output in hooks as seconds since epoch.

Python type: int Default: No default

🎯 queue 🎯

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

Readable by all; settable only by PBS.

Format: String Python type: pbs.queue Default: No default

πŸ”’ queue_rank πŸ”’

A number indicating the job's position within the queue. Only used internally by PBS.

Readable by Manager only.

Format: Integer Python type: int Default: No default

πŸ“Š queue_type πŸ“Š

The type of queue in which the job is currently residing.

Readable by Manager only.

Format: Character Valid values: One of E or R

  • E β€” Execution queue Python type: PBS job state constant pbs.QUEUE_TYPE_EXECUTION
  • R β€” Routing queue Python type: PBS job state constant pbs.QUEUE_TYPE_EXECUTION

Default: No default

πŸ‡ release_nodes_on_stageout πŸ‡

Controls whether job vnodes are released when stageout begins.

Cannot be used with vnodes tied to Cray X* series systems.

When cgroups is enabled and this is used with some but not all vnodes from one MoM, resources on those vnodes that are part of a cgroup are not released until the entire cgroup is released.

The job's stageout attribute must be set for the release_nodes_on_stageout attribute to take effect.

When set to True, all of the job's vnodes not on the primary execution host are released when stageout begins.

When set to False, the job's vnodes are released when the job finishes and MoM cleans up the job.

Readable and settable by all.

Format: Boolean Python type: bool Default: False

πŸ—‘οΈ Remove_Files πŸ—‘οΈ

Specifies whether standard output and/or standard error files are automatically removed upon job completion. Cleanup era.

Readable and settable by all.

Format: String Python type: str Valid values: "e", "o", "eo", "oe", or unset

  • e β€” Standard error is removed upon job completion.
  • o β€” Standard output is removed upon job completion.
  • eo, oe β€” Standard output and standard error are removed upon job completion.
  • unset β€” Neither is removed.

Default: Unset

Rerunable

okay so this one's just a yes/no on whether the job is allowed to be rerun ✨. Heads up tho β€” it does not affect how a job is treated if the job couldn't even begin execution. And bestie, Job arrays are required to be rerunnable, and they're rerunnable by default (no cap, they just are).

  • Readable and settable by all.
  • Format: Character
  • Syntax: One of y or n
  • Python type: bool
  • Default: y (job is rerunnable)

Resource_List

The whole shopping list of resources the job needs πŸ›’. List is a set of <resource name>=<value> strings. What name and value actually mean depends on the defined resources β€” each value establishes the limit of usage of that resource. If it's not set, the value for a resource may be determined by a queue or server default established by the administrator.

  • Readable and settable by all.
  • Format: String
  • Syntax:
Resource_List.<resource name>=<value>[,
Resource_List.<resource name>=<value>, ...]
  • Python type: pbs.pbs_resource
  • Syntax: Resource_List["<resource name>"]=<value> where <resource name> is any built-in or custom resource
  • Default: No default

resources_released

Listed by vnode β€” these are the consumable resources that got released when the job was suspended 🫢. Only populated when the restrict_res_to_release_on_suspend server attribute is set.

  • Readable by all. Set by server.
  • Format: String
  • Syntax:
(<vnode>:<resource name>=<value>: <resource
name>=<value>:...)+ (<vnode>:<resource name>=<value>:...)
  • Python type: str
  • Default: No default

resource_release_list

The sum of each consumable resource the job asked for that was released when the job was suspended πŸ’œ. Populated only when the restrict_res_to_release_on_suspend server attribute is set.

  • Readable by Manager and Operator. Set by server.
  • Format: String
  • Syntax:
resource_released_list.<resource name>=<value>,
resource_released_list.<resource name>=<value>, ...
  • Python type: pbs.pbs_resource
  • Default: No default

resources_used

How much of each resource the job actually used πŸ“Š.

  • Readable by all; set by PBS.
  • Format: String
  • Syntax: List of resources_used.<resource name>=<value>,resources_used.<resource name>=<value> pairs.
  • Example: resources_used.mem=2mb
  • Python type: pbs.pbs_resource
  • Syntax: resources_used["<resource name>"]=<value> where <resource name> is any built-in or custom resource
  • Default: No default

run_count

How many times the server thinks the job has been executed πŸ‘€. Starts at zero, and the job gets held after 21 tries β€” so yeah, 21 strikes and you're out.

  • Can be set via qsub, qalter, or a hook.
  • Can be read and set by Manager and Operator.
  • Format: Integer; must be greater than or equal to zero.
  • Python type: int
  • Default: Zero

run_version

Used internally by PBS to track the instance of the job. Set by PBS, and it's a Manager-only situation β€” visible to Manager only πŸ”’.

  • Format: Integer
  • Python type: int
  • Default: No default

sandbox

Specifies the type of location PBS uses for job staging and execution πŸ“¦.

  • User-settable via qsub -Wsandbox=<value> or via a PBS directive.
  • See the $jobdir_root MoM configuration option in pbs_mom.8B.
  • Can be read and set by user, Operator, Manager.
  • Format: String
  • Valid values: PRIVATE, HOME, unset
    • PRIVATE β€” when set to PRIVATE, PBS creates job-specific staging and execution directories under the directory specified in the $jobdir_root MoM configuration option.
    • HOME or unset β€” PBS uses the job owner's home directory for staging and execution.
  • Python type: str
  • Default: Unset

schedselect

The union of the select specification of the job, plus the queue and server defaults for resources in a chunk 🧩.

  • Can be read by PBS Manager only.
  • Format: String
  • Python type: pbs.select
  • Default: No default

sched_hint

No longer used. πŸ’€ That's it, that's the whole vibe.


security_context

Holds the security context of the job submitter πŸ”. PBS sets it to the security context of the job submitter at the time of job submission. If it's not present when a request is submitted, an error occurs, a server message is logged, and the request is rejected β€” so like, don't forget it.

  • Readable by all; set by PBS.
  • Format: String in SELinux format
  • Default: Unset

server

The name of the server that's currently managing the job πŸ‘‘. When the secondary server is running during failover, it shows the name of the primary server. After a job is moved to another server β€” either via qmove or peer scheduling β€” it shows the name of the new server.

  • Readable by all; set by PBS.
  • Format: String
  • Python type: pbs.server
  • Default: No default

session_id

If the job is running, this is set to the session ID of the first executing task 🌸.

  • Readable by all; set by PBS.
  • Format: Integer
  • Python type: int
  • Default: No default

Shell_Path_List

One or more absolute paths to the program(s) that process the job's script file 🐚.

  • Can be read and set by user, Operator, Manager.
  • Format: String
  • Syntax:
"<path>[@<hostname>][,<path>[@<hostname>]...]"

Must be enclosed in double quotes if it contains commas.

  • Python type: pbs.path_list
  • Default: User's login shell on execution host

stagein

The list of files to be staged in prior to job execution πŸ“₯.

  • Can be read and set by user, Operator, Manager.
  • Format: String
  • Syntax:
"<execution path>@<storage host>:<storage path> [, <execution
path>@<storage host>:<storage path>, ...]"
  • Python type: pbs.staging_list
  • Default: No default

stageout

The list of files to be staged out after job execution πŸ“€.

  • Can be read and set by user, Operator, Manager.
  • Format: String
  • Syntax:
"<execution path>@<storage host>:<storage path> [, <execution
path>@<storage host>:<storage path>, ...]"
  • Python type: pbs.staging_list
  • Default: No default

Stageout_status

Status of the stageout βœ…. If stageout succeeded, this is set to 1. If stageout failed, this is set to 0. Displayed only if set. If stageout fails for any subjob of an array job, the value of Stageout_status is zero for the array job. Available only for finished jobs (so no peeking mid-run, bestie).

  • Readable by all; set by PBS.
  • Format: Integer
  • Python type: int
  • Default: No default

stime

Timestamp β€” the time when the job started execution ⏰. Changes when the job is restarted.

  • Readable by all; set by PBS.
  • Format: Integer
  • Syntax: Timestamp. Printed by qstat in human-readable format; output in hooks as seconds since epoch.
  • Python type: int
  • Default: No default

Submit_arguments

The job submission arguments you gave on the qsub command line πŸ“. Available for all jobs.

  • Can be read and set by user, Operator, Manager.
  • Format: String
  • Python type: str
  • Default: No default

substate

The substate of the job. Used internally by PBS β€” main character energy behind the scenes 🎬.

  • Readable by all; set by PBS.
  • Format: Integer
  • Python type: int
  • Default: No default

sw_index

No longer used. πŸ’€ (yes, another one. we love a deprecated icon.)


tobjob_ineligible

Lets administrators mark this job as ineligible to be a top job πŸš«πŸ‘‘. When True, this job is not eligible to be the top job.

  • Can be read and set by Manager.
  • Format: Boolean
  • Python type: bool
  • Default: False

umask

The initial umask of the job gets set to the value of this attribute when the job is created πŸŽ€. That said, it may be changed by umask commands in the shell initialization files such as .profile or .cshrc.

  • Can be read and set by user, Operator, Manager.
  • Format: Decimal integer
  • Python type: int
  • Default: 077

User_List

The list of users that determines the user name the job runs under on a given host 🫢. No length limit, live your truth.

When a job is to be executed, the server selects a user name from the list according to this ordered set of rules:

  1. Select the user name from the list for which the associated host name matches the name of the server.
  2. Select the user name which has no associated host name; the wild card name.
  3. Use the value of Job_Owner as the user name.
  • Readable and settable by all.
  • Format: String
  • Syntax:
"<username>@<hostname> [,<username>@<hostname>...]"

Must be enclosed in double quotes if it contains commas. May be up to 256 characters in length.

  • Python type: pbs.user_list
  • Default: Value of Job_Owner job attribute

Variable_List

List of environment variables set in the job's execution environment 🌈. See the qsub(1B) command.

  • Readable and settable by all.
  • Format: String
  • Syntax:
"<variable name>=<value> [,<variable name>=<value>...]"

Must be enclosed in double quotes if it contains commas.

  • Python type: pbs.pbs_resource
  • Syntax: Variable_List["<variable name>"]=<value>
  • Default: No default

πŸ¦‹ SEE ALSO πŸ¦‹

  • qsub(1B)
  • qalter(1B)
  • qhold(1B)
  • qrls(1B)
  • pbs_resources(7B)

okay and that's a wrap on the whole attributes saga, bestie πŸ’…βœ¨ this last bit shipped out as the Local version, dated 4 March 2021, and it belongs to pbs_job_attributes(7B) β€” go forth and configure responsibly πŸŽ€πŸ’–

πŸ“¦ where this page comes from