bread

Reads messages and attached data files from a job.

Synopsis

bread [-i message_index] [-a file_name] [-N] [-w]job_ID | "job_ID[index]" | -J job_name
bread [-h | -V]

Description

Reads messages and data posted to an unfinished job with the bpost command.

By default, displays the message description text of the job. By default, operates on the message with index 0.

You can read messages and data from a job until it is cleaned from the system. You cannot read messages and data from done or exited jobs.

If you specify a job ID, you can take the following actions:
  • You can get read messages of jobs submitted by other users, but you cannot read data files that are attached to jobs submitted by other users.
  • You can read only data files that are attached to your own jobs.
  • Root and LSF administrators can read messages of jobs that are submitted by other users.
  • Root and LSF administrators cannot read data files that are attached to jobs submitted by other users.

Job names are not unique; if you specify the -J job_name option the following actions are supported:

  • You can read messages and data only from your own jobs.
  • You cannot read messages and data from jobs that are submitted by other users.
  • Root and the LSF administrators can read messages and data only from their own jobs.
The bstatus command is equivalent to the following command:
bread -i 0

Options

-a file_name
Gets the text message and copies the data file attached to the specified message index of the job to the file specified by file_name. Data files cannot be attached to LSF multicluster capability jobs.

If you do not specify a message index, copies the attachment of message index 0 to the file. The job must have an attachment, and you must specify a name for the file you are copying the attachment to. If the file exists, the -a option overwrites it with the new file.

By default, the -a option gets the attachment file from the directory that is specified by the JOB_ATTA_DIR parameter. If the JOB_ATTA_DIR parameter is not specified, job message attachments are saved in the LSB_SHAREDIR/info/ directory.

-i message_index
Specifies the message index to be retrieved.

The default message_index is 0.

-N
Displays the NOTIFICATION field to indicate whether the message was sent to LSF Application Center Notifications. A hyphen (-) indicates that this was not sent to LSF Application Center Notifications (either because it is a normal message that was sent without the -N option or the LSF_AC_PNC_URL parameter is not configured correctly in the lsf.conf file).
-w
Wide format. Displays information without truncating fields.
job_ID | "job_ID[index]" | -J job_name
Required. Specify the job to operate on.

The job name can be up to 4094 characters long. Job names are not unique.

The wildcard character (*) can be used anywhere within a job name, but it cannot appear within an array index. For example, the pattern job* returns jobA and jobarray[1]. The *AAA*[1] pattern returns the first element in job arrays with names that contain AAA. However, the pattern job1[*] does not return anything since the wildcard is within the array index.

-h
Prints command usage to stderr and exits.
-V
Prints LSF release version to stderr and exits.

Example

bpost -i 1 -N INFO -d "step 1" -a step1.out 2500

bread -i 1 -N -a step2.in 2500
JOBID      MSG_ID FROM      POST_TIME      DESCRIPTION  NOTIFICATION
2500       1      user1     May 19 13:59   step 1       SENT

Displays the message description text step 1 for message index 1 of job 2500, displays whether the message is sent to LSF Application Center Notifications, and copies the data in the file step1.out attached to message 1 to the file step2.in.

See also

bpost, bstatus, bsub, JOB_ATTA_DIR.