Customize job information output
By default, the bjobs command displays a predefined set of job information. While you can use various bjobs options to display specific job information based on your needs, you can also customize the specific fields that bjobs displays. Customize output to create a specific bjobs output format that shows all the required information so you can easily parse the information by using custom scripts or to display the information in a predefined format.
Use the LSB_BJOBS_FORMAT parameter in lsf.conf or the LSB_BJOBS_FORMAT runtime environment variable to define the default bjobs output format for LSF:
LSB_BJOBS_FORMAT="field_name[:[-][output_width]][:unit_prefix] ... [delimiter='character']"
Use the bjobs -o option to define the custom output at the command level:
bjobs ... -o "field_name[:[-][output_width]][:unit_prefix] ... [delimiter='character']"
The following alternative method of using bjobs -o is recommended for special delimiter characters in a csh environment (for example, $):
bjobs ... -o 'field_name[:[-][output_width]][:unit_prefix] ... [delimiter="character"]'
- Specify which bjobs fields (or aliases instead of the full field names), in which order, and with what width to display.
- Specify only the bjobs field name or alias to set its output to unlimited width and left justification.
- (Available starting in Fix Pack 14) Specify all to display all fields. Specify the colon (:) with an output width that applies to all fields.
- Specify the colon (:) without an output width to set the output width to the recommended width for that field.
- Specify the colon (:) with an output width to set the maximum number of
characters to display for the field. When its value exceeds this width, bjobs
truncates the output:
- For the JOB_NAME field, bjobs removes the header characters and replaces them with an asterisk (*)
- For other fields, bjobs truncates the ending characters
- Specify a hyphen (-) to set right justification when bjobs displays the output for the specific field. If not specified, the default is to set left justification when bjobs displays the output for a field.
- Specify a second colon (:) with a unit to specify
a unit prefix for the output for the following fields: mem,
max_mem, avg_mem,
memlimit, swap,
swaplimit, corelimit,
stacklimit, and hrusage (for
hrusage, the unit prefix is for mem and
swap resources only).
This unit is KB (or K) for kilobytes, MB (or M) for megabytes, GB (or G) for gigabytes, TB (or T) for terabytes, PB (or P) for petabytes, EB (or E) for exabytes, ZB (or Z) for zettabytes), or S to automatically adjust the value to a suitable unit prefix and remove the "bytes" suffix from the unit. The default is to automatically adjust the value to a suitable unit prefix, but keep the "bytes" suffix in the unit.
The display value keeps two decimals but rounds up the third decimal. For example, if the unit prefix is set to G, 10M displays as 0.01G.
The unit prefix specified here overrides the value of the LSB_UNIT_FOR_JOBS_DISPLAY environment variable, which also overrides the value of the LSB_UNIT_FOR_JOBS_DISPLAY parameter in the lsf.conf file.
- Use delimiter= to set the delimiting character to display between different headers and fields. This delimiter must be a single character. By default, the delimiter is a space.
The bjobs -o option overrides the LSB_BJOBS_FORMAT environment variable, which overrides the LSB_BJOBS_FORMAT setting in lsf.conf.
- LSB_BJOBS_FORMAT and bjobs -o both apply to output for the bjobs command with no options, and for bjobs options with short form output that filter information, including the following options: -a, -app, -d, -g, -G, -J, -Jd, -Lp, -m, -P, -q, -r, -sla, -u, -x, -X.
- LSB_BJOBS_FORMAT does not apply to output for bjobs options that use a modified format and filter information, but you can use bjobs -o to customize the output for these options. These options include the following options: -fwd, -N, -p, -s.
- LSB_BJOBS_FORMAT and bjobs -o do not apply to output for bjobs options that use a modified format, including the following options: -A, -aff, -aps, -l, -UF, -ss, -sum, -UF, -w, -W, -WF, -WL, -WP.
The following are the field names used to specify the bjobs fields to display, recommended width, aliases you can use instead of field names, and units of measurement for the displayed field:
Field name | Width | Alias | Unit | Category |
---|---|---|---|---|
jobid | 7 | id | Common | |
jobindex | 8 | |||
stat | 5 | |||
user | 7 | |||
user_group | 15 | ugroup | ||
queue | 10 | |||
job_name | 10 | name | ||
job_description | 17 | description | ||
proj_name | 11 | proj, project | ||
application | 13 | app | ||
service_class | 13 | sla | ||
job_group | 10 | group | ||
job_priority | 12 | priority | ||
rsvid | 40 | |||
esub | 20 | |||
kill_reason | 50 | |||
suspend_reason | 50 | |||
resume_reason | 50 | |||
kill_issue_host | 50 | |||
suspend_issue_host | 50 | |||
resume_issue_host | 50 | |||
dependency | 15 | |||
pend_reason This displays the single key pending reason, including custom messages, regardless of the default pending reason level as specified in the LSB_BJOBS_PENDREASON_LEVEL parameter in the lsf.conf file. |
11 | |||
charged_saap | 50 | saap | ||
command | 15 | cmd | Command | |
pre_exec_command | 16 | pre_cmd | ||
post_exec_command | 17 | post_cmd | ||
resize_notification_command | 27 | resize_cmd | ||
pids | 20 | |||
exit_code | 10 | |||
exit_reason | 50 | |||
interactive | 11 | |||
from_host | 11 | Host | ||
first_host | 11 | |||
exec_host | 11 | |||
nexec_host Note: If the allocated host group or compute unit is condensed, this
field does not display the real number of hosts. Use bjobs -X -o to view the real
number of hosts in these situations.
|
10 | |||
ask_hosts | 30 | |||
alloc_slot | 20 | |||
nalloc_slot | 10 | |||
host_file | 10 | |||
exclusive | 13 | |||
nreq_slot | 10 | |||
submit_time | 15 | time stamp | Time | |
start_time | 15 | time stamp | ||
estimated_start_time | 20 | estart_time | time stamp | |
specified_start_time | 20 | sstart_time | time stamp | |
specified_terminate_time | 24 | sterminate_time | time stamp | |
time_left | 11 | seconds | ||
finish_time | 16 | time stamp | ||
estimated_run_time | 20 | ertime | seconds | |
ru_utime | 12 | seconds | ||
ru_stime | 12 | seconds | ||
%complete | 11 | |||
warning_action | 15 | warn_act | ||
action_warning_time | 19 | warn_time | ||
pendstate (IPEND/EPEND/NOTPEND) | 9 | |||
pend_time | 12 | seconds | ||
ependtime | 12 | seconds | ||
ipendtime | 12 | seconds | ||
estimated_sim_start_time | 24 | esstart_time | time stamp | |
effective_plimit (run with bjobs -p to show information for pending jobs only) | 18 | seconds | ||
plimit_remain (run with bjobs -p to show information for
pending jobs only) A negative number indicates the amount of time in which the job exceeded the pending time limit, while a positive number shows that the time remaining until the pending time limit is reached. |
15 | seconds | ||
effective_eplimit (run with bjobs -p to show information for pending jobs only) | 19 | seconds | ||
eplimit_remain (run with bjobs -p to show information for pending jobs only) | 16 | seconds | ||
cpu_used A negative number indicates the amount of time in which the job exceeded the pending time limit, while a positive number shows that the time remaining until the pending time limit is reached. |
10 | CPU | ||
run_time | 15 | seconds | ||
idle_factor | 11 | |||
exception_status | 16 | except_stat | ||
slots | 5 | |||
mem | 15 | As defined for LSF_UNIT_FOR_LIMITS in lsf.conf. | ||
max_mem | 15 | As defined for LSF_UNIT_FOR_LIMITS in lsf.conf. | ||
avg_mem | 15 | As defined for LSF_UNIT_FOR_LIMITS in lsf.conf. | ||
memlimit | 15 | As defined for LSF_UNIT_FOR_LIMITS in lsf.conf. | ||
swap | 15 | As defined for LSF_UNIT_FOR_LIMITS in lsf.conf. | ||
swaplimit | 15 | As defined for LSF_UNIT_FOR_LIMITS in lsf.conf. | ||
gpu_num | 10 | gnum | GPU | |
gpu_mode | 20 | gmode | ||
j_exclusive | 15 | j_excl | ||
gpu_alloc | 30 | galloc | ||
nthreads | 10 | Resource usage | ||
hrusage | 50 | |||
min_req_proc | 12 | Resource requirement | ||
max_req_proc | 12 | |||
effective_resreq | 17 | eresreq | ||
combined_resreq | 20 | cresreq | ||
network_req | 15 | |||
filelimit | 10 | Resource limits | ||
corelimit | 15 | |||
stacklimit | 15 | |||
processlimit | 12 | |||
runtimelimit | 12 | |||
plimit | 10 | seconds | ||
eplimit | 10 | seconds | ||
input_file | 10 | File | ||
output_file | 11 | |||
error_file | 10 | |||
output_dir | 15 | Directory | ||
sub_cwd | 10 | |||
exec_home | 10 | |||
exec_cwd | 10 | |||
licproject | 20 | License | ||
forward_cluster | 15 | fwd_cluster | MultiCluster | |
forward_time | 15 | fwd_time | time stamp | |
srcjobid | 8 | |||
dstjobid | 8 | |||
source_cluster | 15 | srcluster | ||
energy | Joule | Energy | ||
gpfsio Job disk usage (I/O) data on IBM® Spectrum Scale. |
||||
block (Available starting in Fix Pack 13) |
5 | |||
cpu_peak (Available starting in Fix Pack 13) |
10 | |||
cpu_efficiency (for Fix Pack 13) cpu_peak_efficiency (for Fix Pack 14) |
10 | |||
mem_efficiency (Available starting in Fix Pack 13) |
10 | |||
average_cpu_efficiency
(Available starting in Fix Pack 14) |
10 | |||
cpu_peak_reached_duration (Available starting in Fix Pack 14) |
10 | |||
all (Available starting in Fix Pack 14) |
Specify an output width that applies to all fields |
Field names and aliases are not case-sensitive. Valid values for the output width are any positive integer 1 - 4096. If the jobid field is defined with no output width and LSB_JOBID_DISP_LENGTH is defined in lsf.conf, the LSB_JOBID_DISP_LENGTH value is used for the output width. If jobid is defined with a specified output width, the specified output width overrides the LSB_JOBID_DISP_LENGTH value.
Remove column headings from the job information output
Use the bjobs -noheader option to remove column headings from the bjobs output. When bjobs -noheader is specified, bjobs displays the values of the fields without displaying the names of the fields. This option is useful for script parsing, when column headings are not necessary.
This option applies to output for the bjobs command with no options, and to output for all bjobs options with short form output except for -aff, -l, -UF, -N, -h, and -V.
View customized job information in JSON format
Use the bjobs -json option to view the customized bjobs output in JSON format. Since JSON is a customized output format, you must use the bjobs -json option together with the -o option.