xlsbatch - Motif based Graphical User Interface for lsbatch
xlsbatch [standard X11/Motif flags...]
xlsbatch provides a Motif based graphical user interface for the lsbatch system. The xlsbatch program acts as a front end to the various lsbatch commands. It permits the user to query lsbatch for information on jobs (both running and completed), queues, hosts, and users. It also allows new jobs to be submitted, and jobs to be manipulated in various ways. Pending jobs may be moved to the top or bottom of a queue, or moved to a different queue altogether. Running jobs can be stopped, resumed, killed, checkpointed, migrated to another host or sent arbitrary signals, and job output can be viewed. The job run history can also be examined, by host, queue or user.
The main window of xlsbatch consists of a viewing area and a message area. The viewing area displays information about jobs, hosts, queues or users depending on the option selected in the View menu. The default is to display information about jobs. The message area displays any informational or error messages that may result from performing operations through xlsbatch. If jobs are displayed in the viewing area, then several buttons are available between the viewing and message areas, which can be used to select the jobs to be displayed. A timestamp under the viewing area gives the last time the viewing area was updated.
The menu bar for the main window contains the following items: File, View, Job, Host, Queue, User, Options and Help.
File The File menu contains the following items:
Update
Update the contents of the viewing area. For example, if the
viewing area is displaying jobs, then information about the jobs
is refreshed.
Change Current Directory...
Pop up a window to allow the user to change the current working
directory.
Clear Message
Clear the contents in the message area.
Exit Close the xlsbatch window and all subwindows.
View The View menu allows the user to specify what is to be displayed in the viewing area. The menu contains the following items:
Job Display a list of jobs in the viewing area. This list has one line per job, and reports the job ID, the user who submitted it, its current status, the queue to which it was submitted, the host from which it was submitted, the host or hosts to which it was dispatched (if it is no longer pending), its name, and the time of its submission. The jobs to be displayed can be selected using the buttons under the viewing area as follows.
The Jobs button allows the user to select certain subsets of jobs to be displayed including running, done/exit, pending, or suspended jobs. By default, only currently unfinished jobs will be shown.
The Hosts button restricts the displayed jobs to those dispatched to the selected hosts. The default is all hosts.
The Queues button pops up a window allowing the user to specify that only jobs from particular queues are to be displayed. The default is all queues.
The Users button permits the viewing of jobs submitted by users other than the invoker.
Host Display a list of all the hosts in the load sharing cluster in the viewing area. This list has one line per host, reporting the hostname, status, the maximum number of batch jobs allowed on that host, the current number of batch jobs on that host, the number of running jobs, the number of jobs on the host that are suspended by the system, the number of jobs suspended by the user, and the host run window.
Queue
Display a list of all lsbatch queues configured for this load
sharing cluster in the viewing area. This list has one line per
queue, and reports the queue name, its priority, the nice value
that jobs in this queue are run with, a flag indicating whether
or not exclusive jobs can be submitted to this queue, queue
status, the number of jobs in this queue, and its job limit.
User Display a list of all the users and user groups that are defined in the lsbatch configuration, plus all users running lsbatch jobs. The list has one line per user or user group, showing the maximum number of jobs the user or group may have active at any one time, and the current number of jobs that have been started.
Param
Display the configurable system parameters of lsbatch in a
multi-line format with one line per parameter.
Job The Job menu is activated when jobs are being viewed (that is, Job is selected in the View menu). It allows the user to perform various actions on jobs. The menu contains the following items:
Select All
Select all jobs in the viewing area.
Unselect All
Deselect the selected jobs in the viewing area.
Submit...
Pop up the «Job Submission» window to allow the user to specify
and submit a job (see the section «Job Submission Window").
Restart...
Pop up the «Job Restart» window to allow the user to specify and
restart a job.
Signal
Send a arbitrary signal to the job(s) selected in the viewing
area.
Kill Terminate the job(s) selected in the viewing area.
Stop Suspend the execution of the job(s) selected in the viewing area.
Resume
Resume the execution of the job(s) selected in the viewing area.
Checkpoint...
Pop up a dialog window to allow user to specify and checkpoint
the job(s) selected in the viewing area.
Migrate...
Pop up a «Job Migration» window that permits the user to specify
host restrictions and enter start and termination times. Toggle
buttons can be used to specify whether the job(s) will be
requeued and forced to be checkpointed. The job(s) selected in
the viewing area will be migrated by pressing OK button.
Top Cause the selected pending job to be moved to the top of the other pending jobs in the queue. If invoked by a normal user, move the selected job to before the first job submitted by this user to this queue. If invoked by the LSF administrator, move the selected job to the beginning of the queue. The positions of all users' jobs in the queue can be changed by the LSF administrator.
Bottom
Cause the selected pending job to be moved to the bottom of the
other pending jobs in the queue. If invoked by a normal user,
move the selected job to after the last job submitted by this
user to this queue. If invoked by the LSF administrator, move
the selected job to the end of the queue.
Switch
Switch the selected job from one queue to another.
Detail...
Display detailed information about the selected job such as the
options it was submitted with and when it was started. If the job
is currently pending or suspended, then the reason for this is
also displayed.
History...
Display the history of the selected job (that is, all the events
that have happened to it).
Peek...
Display the existing standard output and error of the selected
job.
Host The Host menu is activated when hosts are being viewed in the viewing area (that is, Host is selected in the View menu). The Host menu contains the following items:
Detail...
Cause the Host window to be displayed showing the lsbatch configuration
parameters for the selected host. In the Host window,
the Next and Previous buttons can be used to view the parameters
for other hosts in the cluster, in the order they are displayed
in the viewing area of the xlsbatch main window.
Group...
Cause the «Host Groups» window to be displayed showing host
groups and their member hosts.
Partition...
Cause the «Host Partition» window to be displayed showing host
partitions defined in the lsbatch system.
Queue
The Queue menu is activated when queues are being viewed (that is,
Queue is selected in the View menu). The Queue menu contains the following
item:
Detail...
Cause the Queue window to be displayed showing the lsbatch configuration
parameters for the selected queue. In the Queue window,
the Next and Previous buttons can be used to view the parameters
for other queues in the cluster, in the order they are displayed
in the viewing area of the xlsbatch main window.
User The User menu is activated when users are being viewed in the viewing area. The User menu contains the following item:
Group...
Cause the «User Groups» window to be displayed showing user
groups and their member users.
Param
The Param menu is activated when lsbatch configuration parameters are
being viewed in the viewing area. (that is, the Param button is
selected in the View menu). The Param menu contains the following
item:
Detail...
Cause the System Parameters window to be displayed showing all
configurable parameters of the lsbatch system.
Options
The Options menu allows users to modify the operating behavior of
xlsbatch. The menu contains the following item:
Set Options...
Pop up a dialog box, which contains controls that affect the
xlsbatch's features, including refresh period and print command
options.
Save Options
Save the current settings of the features to the configuration
file ~/.XLsbatch. This file, if available, is read when xlsbatch
is started to obtain the configuration file features.
Restore Options
Restore the settings of the features from the last saved configuration
file ~/.XLsbatch.
Help The Help menu contains the following items:
On Version...
Pop up a message dialog displaying the version, date and product
information for LSF.
On Window...
Pop up on-line Help window to display the information about the
tasks that you can perform with the xlsbatch (see the section
«Help Window").
On Help...
Pop up on-line Help window to display the information about how
to use the on-line help (see the section «Help Window").
Job Submission Window
To submit a job to lsbatch, the Submit option from the Job menu should
be selected. This pops up a window that permits the user to enter the
job command, the shell script file, the login shell, the job name, the
queue name, resource requirements, pre-execution commands, job dependency
conditions, candidate hosts, start and termination times, number
of processors to be used by this job, and input, output and error
files for the command. Blank fields indicate that the default value
should be used. Toggle buttons can be used to specify whether a job is
exclusive or re-runnable and when mail should be sent to the user. By
pressing the Limits button, a popup menu is displayed, which allows
the user to specify CPU and other resource limits. The Signal option
menu can be used to specify what signal will be sent to the job when
its queue's run window expires. By pressing the Transfer Files button,
a dialog window pops up, which allows the user to specify files that
should be copied between the local and remote host (see bsub(1)
).
Using the Checkpoint button, parameters related to automatic job
checkpointing including checkpoint period and directory to store the
checkpoint file(s) may be set. By pressing Exit, the job submission
popup window is dismissed. To submit the job, press Submit button.
Help Window
The Help window displays on-line documentation. It contains a menu
bar, a scrolled hypertext window and Previous, Next and Close push
buttons.
There are highlighted items. By clicking the items the window displays the related parts of text about the items. The highlighted items use a different color and font that can be set in the default file.
A history of the 100 last pages displayed is kept in memory that can be recalled with the Previous and Next buttons.
The menu bar for the Help window contains the following items: File and Help.
File The File menu contains the following items:
Save As...
Pop up a file selection dialog, let user input a text file
name to save the content of the window.
Print
Send the content of the window to the printer. The resource
of xlsbatch for the print command is «printCommand". The
print command can also be set or changed in the Set Options
window.
Exit Close the Help window.
Help The Help menu contains the following items:
On Version...
Pop up a message dialog displaying the version, date and
product information for LSF.
On Help...
Pop up the Help window to display the information about how
to use the on-line help.
The xlsbatch application uses the values in the X default files when you logged in and uses the appropriate resource specification values to customize the appearance of the xlsbatch window. The format for a resource specification in the X default files is:
[name*]resource: value
name specifies the application name or the name string that restricts
the resource assignment to that application or to a component of an
application. If this argument is not specified, the resource assignment
is globally available to all X applications.
resource specifies the resource.
value specifies the value that is to be assigned to the resource.
For xlsbatch, the application class is XLsbatch and the application name is xlsbatch.
In addition to the general resources listed in X(1X) , the resources available for the xlsbatch work area are:
refreshRate
Specify the period of xlsbatch refreshing lsbatch information. The
permissible range of refresh period is 1 to 60 minutes.
printCommand
Specify the command to print xlsbatch on line help. The default command
is «lp".
~/.Xdefaults
XLSF_APPDIR/XLsbatch
~/.XLsbatch
lsbatch(1)
, bsub(1)
, X(1X)
LSF User's Guide