| [ Platform Documentation ] | [ Title ] | [ Contents ] | [ Previous ] | [ Next ] | [ Index ] |
badmin
administrative tool for LSF
SYNOPSIS
badmin subcommand
badmin [-h | -V]
SUBCOMMAND LIST
ckconfig [-v]
reconfig [-v] [-f]
mbdrestart [-C comment] [-v] [-f]
qopen [-C comment] [queue_name ... | all]
qclose [-C comment] [queue_name ... | all]
qact [-C comment] [queue_name ... | all]
qinact [-C comment] [queue_name ... | all]
qhist [-t time0,time1] [-f logfile_name] [queue_name ...]
hopen [-C comment] [host_name ... | host_group ... | all]
hclose [-C comment] [host_name ... | host_group ... | all]
hrestart [-f] [host_name ... | all]
hshutdown [-f] [host_name ... | all]
hstartup [-f] [host_name ... | all]
hhist [-t time0,time1] [-f logfile_name] [host_name ...]
mbdhist [-t time0,time1] [-f logfile_name]
hist [-t time0,time1] [-f logfile_name]
help [command ...] | ? [command ...]
mbddebug [-c class_name ...] [-l debug_level] [-f logfile_name] [-o]
mbdtime [-l timing_level] [-f logfile_name] [-o]
sbddebug [-c class_name ...] [-l debug_level] [-f logfile_name] [-o]
[host_name ...]
sbdtime [-l timing_level] [-f logfile_name] [-o] [host_name ...]
schddebug [-c class_name ...] [-l debug_level] [-f logfile_name] [-o]
schdtime [-l timing_level] [-f logfile_name] [-o]
DESCRIPTION
This command can only be used by LSF administrators.
badmin provides a set of commands to control and monitor LSF. If no
subcommands are supplied for badmin, badmin prompts for a command from
standard input.
Commands bqc(8), breconfig(8) and breboot(8) are superceded by
badmin(8).
Information about each command is available through the help command.
The badmin commands consist of a set of privileged commands and a set of
non-privileged commands. Privileged commands can only be invoked by root
or LSF administrators as defined in the configuration file (see
lsf.cluster.cluster(5) for ClusterAdmin). Privileged commands are:
reconfig
mbdrestart
qopen
qclose
qact
qinact
hopen
hclose
hrestart
hshutdown
hstartup
The configuration file lsf.sudoers(5) has to be set in order to use the
privileged command hstartup by a non-root user.
All other commands are non-privileged commands and can be invoked by any
LSF user. If the privileged commands are to be executed by an LSF
administrator, badmin must be installed setuid root, because it needs to
send the request using a privileged port.
For subcommands for which multiple hosts can be specified, do not enclose the host names in quotation marks.
OPTIONS
subcommand
Executes the specified subcommand. See Usage section.
-h
Prints command usage to stderr and exits.
-V
Prints LSF release version to stderr and exits.
USAGE
ckconfig [-v]
Checks LSF configuration files. Configuration files are located in the
LSB_CONFDIR/cluster_name/configdir directory.
The LSB_CONFDIR variable is defined in lsf.conf (see lsf.conf(5)) which
is in LSF_ENVDIR or /etc (if LSF_ENVDIR is not defined).
By default, badmin ckconfig displays only the result of the configuration file
check. If warning errors are found, badmin prompts you to display detailed
messages.
-v
Verbose mode. Displays detailed messages about configuration file
checking to stderr.
reconfig [-v] [-f]
Dynamically reconfigures LSF without restarting mbatchd and mbschd.
Configuration files are checked for errors and the results displayed to stderr.
If no errors are found in the configuration files, a reconfiguration request is
sent to mbatchd and configuration files are reloaded.
With this option, mbatchd and mbschd are not restarted and lsb.events is
not replayed. To restart mbatchd and mbschd, and replay lsb.events, use
badmin mbdrestart.
When you issue this command, mbatchd is available to service requests while
reconfiguration files are reloaded. Configuration changes made since system
boot or the last reconfiguration take effect.
If warning errors are found, badmin prompts you to display detailed messages.
If fatal errors are found, reconfiguration is not performed, and badmin exits.
If you add a host to a queue, the new host will not be recognized by jobs that
were submitted before you reconfigured. If you want the new host to be
recognized, you must use the command badmin mbdrestart.
If you add a host to a host group, the new host will not be recognized by jobs
that were submitted before you reconfigured. If you want the new host to be
recognized, you must use the command badmin mbdrestart.
-v
Verbose mode. Displays detailed messages about the status of the
configuration files. Without this option, the default is to display the
results of configuration file checking. All messages from the
configuration file check are printed to stderr.
-f
Disables interaction and proceeds with reconfiguration if configuration files contain no fatal errors.
mbdrestart [-C comment] [-v] [-f]
Dynamically reconfigures LSF and restarts mbatchd and mbschd.
Configuration files are checked for errors and the results printed to stderr. If
no errors are found, configuration files are reloaded, mbatchd and mbschd are
restarted, and events in lsb.events are replayed to recover the running state
of the last mbatchd. While mbatchd restarts, it is unavailable to service
requests.
If warning errors are found, badmin prompts you to display detailed messages.
If fatal errors are found, mbatchd and mbschd restart is not performed, and
badmin exits.
If lsb.events is large, or many jobs are running, restarting mbatchd can take
several minutes. If you only need to reload the configuration files, use badmin
reconfig.
-C comment
Logs the text of comment as an administrator comment record to
lsb.events. The maximum length of the comment string is 512
characters.
-v
Verbose mode. Displays detailed messages about the status of
configuration files. All messages from configuration checking are
printed to stderr.
-f
Disables interaction and forces reconfiguration and mbatchd restart to
proceed if configuration files contain no fatal errors.
qopen [-C comment] [queue_name ... | all]
Opens specified queues, or all queues if the reserved word all is specified. If
no queue is specified, the system default queue is assumed (see
lsb.queues(5) for DEFAULT_QUEUE). A queue can accept batch jobs only if
it is open.
-C comment
Logs the text of comment as an administrator comment record to
lsb.events. The maximum length of the comment string is 512
characters.
qclose [-C comment] [queue_name ... | all]
Closes specified queues, or all queues if the reserved word all is specified. If
no queue is specified, the system default queue is assumed. A queue will not
accept any job if it is closed.
-C comment
Logs the text of comment as an administrator comment record to
lsb.events. The maximum length of the comment string is 512
characters.
qact [-C comment] [queue_name ... | all]
Activates specified queues, or all queues if the reserved word all is specified.
If no queue is specified, the system default queue is assumed. Jobs in a queue
can be dispatched if the queue is activated.
A queue inactivated by its run windows cannot be reactivated by this
command (see lsb.queues(5) for RUN_WINDOW).
-C comment
Logs the text of comment as an administrator comment record to
lsb.events. The maximum length of the comment string is 512
characters.
qinact [-C comment] [queue_name ... | all]
Inactivates specified queues, or all queues if the reserved word all is
specified. If no queue is specified, the system default queue is assumed. No
job in a queue can be dispatched if the queue is inactivated.
-C comment
Logs the text of comment as an administrator comment record to
lsb.events. The maximum length of the comment string is 512
characters.
qhist [-t time0,time1] [-f logfile_name] [queue_name ...]
Displays historical events for specified queues, or for all queues if no queue is specified. Queue events are queue opening, closing, activating and inactivating.
-t time0,time1
Displays only those events that occurred during the period from time0
to time1. See bhist(1) for the time format. The default is to display
all queue events in the event log file (see below).
-f logfile_name
Specify the file name of the event log file. Either an absolute or a
relative path name may be specified. The default is to use the event log
file currently used by the LSF system:
LSB_SHAREDIR/cluster_name/logdir/lsb.events. Option -f is
useful for offline analysis.
If you specified an administrator comment with the -C option of the queue
control commands qclose, qopen, qact, and qinact, qhist displays the
comment text.
hopen [-C comment] [host_name ... | host_group ... | all]
Opens batch server hosts. Specify the names of any server hosts or host groups
(see bmgroup(1)). All batch server hosts will be opened if the reserved word
all is specified. If no host or host group is specified, the local host is assumed.
A host accepts batch jobs if it is open.
-C comment
Logs the text of comment as an administrator comment record to
lsb.events. The maximum length of the comment string is 512
characters. If you open a host group, each host group member displays
with the same comment string.
hclose [-C comment] [host_name ... | host_group ... | all]
Closes batch server hosts. Specify the names of any server hosts or host groups
(see bmgroup(1)). All batch server hosts will be closed if the reserved word
all is specified. If no argument is specified, the local host is assumed. A closed
host will not accept any new job, but jobs already dispatched to the host will
not be affected. Note that this is different from a host closed by a window; all
jobs on it are suspended in that case.
-C comment
Logs the text of comment as an administrator comment record to
lsb.events. The maximum length of the comment string is 512
characters. If you close a host group, each host group member displays
with the same comment string.
hrestart [-f] [host_name ... | all]
Restarts sbatchd on the specified hosts, or on all server hosts if the reserved
word all is specified. If no host is specified, the local host is assumed.
sbatchd will rerun itself from the beginning. This allows new sbatchd
binaries to be used.
-f
Disables interaction and does not ask for confirmation for restarting
sbatchd.
hshutdown [-f] [host_name ... | all]
Shuts down sbatchd on the specified hosts, or on all batch server hosts if the
reserved word all is specified. If no host is specified, the local host is
assumed. sbatchd will exit upon receiving the request.
-f
Disables interaction and does not ask for confirmation for shutting
down sbatchd.
hstartup [-f] [host_name ... | all]
Starts sbatchd on the specified hosts, or on all batch server hosts if the
reserved word all is specified. Only root and users listed in the file
lsf.sudoers(5) can use the all and -f options. These users must be able
to use rsh or ssh on all LSF hosts without having to type in passwords. If no
host is specified, the local host is assumed.
The shell command specified by LSF_RSH in lsf.conf is used before rsh is
tried.
-f
Disables interaction and does not ask for confirmation for starting
sbatchd.
hhist [-t time0,time1] [-f logfile_name] [host_name ...]
Displays historical events for specified hosts, or for all hosts if no host is
specified. Host events are host opening and closing. Options -t and -f are
exactly the same as those of qhist (see above).
If you specified an administrator comment with the -C option of the host
control commands hclose or hopen, hhist displays the comment text.
mbdhist [-t time0,time1] [-f logfile_name]
Displays historical events for mbatchd. Events describe the starting and exiting
of mbatchd. Options -t and -f are exactly the same as those of qhist (see
above).
If you specified an administrator comment with the -C option of the
mbdrestart command, mbdhist displays the comment text.
hist [-t time0,time1] [-f logfile_name]
Displays historical events for all the queues, hosts and mbatchd. Options -t
and -f are exactly the same as those of qhist (see above).
If you specified an administrator comment with the -C option of the queue,
host, and mbatchd commands, hist displays the comment text.
help [command ...] | ? [command ...]
Displays the syntax and functionality of the specified commands.
quit
Exits the badmin session.
mbddebug [-c class_name ...] [-l debug_level] [-f logfile_name] [-o]
Sets message log level for mbatchd to include additional information in log
files. You must be root or the LSF administrator to use this command.
See sbddebug for an explanation of options.
mbdtime [-l timing_level] [-f logfile_name] [-o]
Sets timing level for mbatchd to include additional timing information in log
files. You must be root or the LSF administrator to use this command.
See sbdtime for an explanation of options.
sbddebug [-c class_name ...] [-l debug_level] [-f logfile_name] [-o] [host_name ...]
Sets the message log level for sbatchd to include additional information in log
files. You must be root or the LSF administrator to use this command.
In MultiCluster, debug levels can only be set for hosts within the same cluster.
For example, you could not set debug or timing levels from a host in clusterA
for a host in clusterB. You need to be on a host in clusterB to set up debug
or timing levels for clusterB hosts.
If the command is used without any options, the following default values are used:
class_name = 0 (no additional classes are logged)
debug_level = 0 (LOG_DEBUG level in parameter LSF_LOG_MASK)
logfile_name = current LSF system log file in the directory specified by
LSF_LOGDIR in the format daemon_name.log.host_name
host_name = local host (host from which command was submitted)
-c class_name ...
Specifies software classes for which debug messages are to be logged.
Format of class_name is the name of a class, or a list of class names
separated by spaces and enclosed in quotation marks. Classes are also
listed in lsf.h.
Possible classes:
LC_AFS - Log AFS messages
LC_AUTH - Log authentication messages
LC_CHKPNT - Log checkpointing messages
LC_COMM - Log communication messages
LC_DCE - Log messages pertaining to DCE support
LC_EEVENTD - Log eeventd messages
LC_EXEC - Log significant steps for job execution
LC_FAIR - Log fairshare policy messages
LC_FILE - Log file transfer messages
LC_HANG - Mark where a program might hang
LC_JLIMIT - Log job slot limit messages
LC_LICENCE - Log license management messages
LC_LOADINDX - Log load index messages
LC_M_LOG - Log multievent logging messages
LC_MPI - Log MPI messages
LC_MULTI - Log messages pertaining to MultiCluster
LC_PEND - Log messages related to job pending reasons
LC_PERFM - Log performance messages
LC_PIM - Log PIM messages
LC_PREEMPT - Log preemption policy messages
LC_SIGNAL - Log messages pertaining to signals
LC_SYS - Log system call messages
LC_TRACE - Log significant program walk steps
LC_XDR - Log everything transferred by XDR
Default: 0 (no additional classes are logged)
-l debug_level
Specifies level of detail in debug messages. The higher the number, the more detail that is logged. Higher levels include all lower levels.
Possible values:
0 LOG_DEBUG level in parameter LSF_LOG_MASK in lsf.conf.
1 LOG_DEBUG1 level for extended logging. A higher level includes
lower logging levels. For example, LOG_DEBUG3 includes
LOG_DEBUG2 LOG_DEBUG1, and LOG_DEBUG levels.
2 LOG_DEBUG2 level for extended logging. A higher level includes
lower logging levels. For example, LOG_DEBUG3 includes
LOG_DEBUG2 LOG_DEBUG1, and LOG_DEBUG levels.
3 LOG_DEBUG3 level for extended logging. A higher level includes
lower logging levels. For example, LOG_DEBUG3 includes
LOG_DEBUG2, LOG_DEBUG1, and LOG_DEBUG levels.
Default: 0 (LOG_DEBUG level in parameter LSF_LOG_MASK)
-f logfile_name
Specify the name of the file into which debugging messages are to be logged. A file name with or without a full path may be specified.
If a file name without a path is specified, the file will be saved in the
directory indicated by the parameter LSF_LOGDIR in lsf.conf.
The name of the file that will be created will have the following format:
logfile_name.daemon_name.log.host_name
On UNIX, if the specified path is not valid, the log file is created in the
/tmp directory.
On Windows, if the specified path is not valid, no log file is created.
If LSF_LOGDIR is not defined, daemons log to the syslog facility.
Default: current LSF system log file in the directory specified by
LSF_LOGDIR in the format daemon_name.log.host_name.
-o
Turns off temporary debug settings and resets them to the daemon starting state. The message log level is reset back to the value of LSF_LOG_MASK and classes are reset to the value of LSB_DEBUG_MBD, LSB_DEBUG_SBD.
The log file is also reset back to the default log file.
host_name ...
Optional. Sets debug settings on the specified host or hosts.
Lists of host names must be separated by spaces and enclosed in quotation marks.
Default: local host (host from which command was submitted)
sbdtime [-l timing_level] [-f logfile_name] [-o] [host_name ...]
Sets the timing level for sbatchd to include additional timing information in
log files. You must be root or the LSF administrator to use this command.
In MultiCluster, timing levels can only be set for hosts within the same cluster.
For example, you could not set debug or timing levels from a host in clusterA
for a host in clusterB. You need to be on a host in clusterB to set up debug
or timing levels for clusterB hosts.
If the command is used without any options, the following default values are used:
timing_level = no timing information is recorded
logfile_name = current LSF system log file in the directory specified by
LSF_LOGDIR in the format daemon_name.log.host_name
host_name = local host (host from which command was submitted)
-l timing_level
Specifies detail of timing information that is included in log files. Timing messages indicate the execution time of functions in the software and are logged in milliseconds.
Valid values: 1 | 2 | 3 | 4 | 5
The higher the number, the more functions in the software that are timed and whose execution time is logged. The lower numbers include more common software functions. Higher levels include all lower levels.
Default: undefined (no timing information is logged)
-f logfile_name
Specify the name of the file into which timing messages are to be logged. A file name with or without a full path may be specified.
If a file name without a path is specified, the file will be saved in the
directory indicated by the parameter LSF_LOGDIR in lsf.conf.
The name of the file that will be created will have the following format:
logfile_name.daemon_name.log.host_name
On UNIX, if the specified path is not valid, the log file is created in the
/tmp directory.
On Windows, if the specified path is not valid, no log file is created.
If LSF_LOGDIR is not defined, daemons log to the syslog facility.
Note: Both timing and debug messages are logged in the same files.
Default: current LSF system log file in the directory specified by
LSF_LOGDIR in the format daemon_name.log.host_name.
-o
Optional. Turn off temporary timing settings and reset them to the daemon starting state. The timing level is reset back to the value of the parameter for the corresponding daemon (LSB_TIME_MBD, LSB_TIME_SBD).
The log file is also reset back to the default log file.
host_name ...
Sets the timing level on the specified host or hosts.
Lists of hosts must be separated by spaces and enclosed in quotation marks.
Default: local host (host from which command was submitted)
schddebug [-c class_name ...] [-l debug_level] [-f logfile_name] [-o]
Sets message log level for mbschd to include additional information in log files.
You must be root or the LSF administrator to use this command.
See sbddebug for an explanation of options.
schdtime [-l timing_level] [-f logfile_name] [-o]
Sets timing level for mbschd to include additional timing information in log
files. You must be root or the LSF administrator to use this command.
See sbdtime for an explanation of options.
SEE ALSO
bqueues(1), bhosts(1), lsb.queues(5), lsb.hosts(5), lsf.conf(5),
lsf.cluster(5), sbatchd(8), mbatchd(8) mbschd(8)
[ Top ]
| [ Platform Documentation ] | [ Title ] | [ Contents ] | [ Previous ] | [ Next ] | [ Index ] |
|
Date Modified: February 24, 2004
Platform Computing: www.platform.com Platform Support: support@platform.com Platform Information Development: doc@platform.com Copyright © 1994-2004 Platform Computing Corporation. All rights reserved. |