lsadmin

administrative tool for LSF

Synopsis

lsadmin subcommand

lsadmin [-h | -V]

Description

CAUTION:

This command can only be used by LSF administrators.

lsadmin is a tool that executes privileged commands to control LIM and RES operations in the LSF cluster.

If no subcommands are supplied for lsadmin, lsadmin prompts for subcommands from the standard input.

For subcommands for which multiple host names or host groups can be specified, do not enclose the multiple names in quotation marks.

When live configuration using bconf is enabled (LSF_LIVE_CONFDIR is defined in lsf.conf) lsadmin uses configuration files generated by bconf.

Subcommand List

ckconfig [-v]

reconfig [-f] [-v]

limstartup [-f] [host_name ... |all]

limshutdown [-f] [host_name ... | all]

limrestart [-v] [-f] [host_name ... | all]

limlock [-l time_seconds]

limunlock

resstartup [-f] [host_name ... | all]

resshutdown [-f] [host_name ... | all]

resrestart [-f] [host_name ... | all]

reslogon [-c cpu_time] [host_name ... | all]

reslogoff [host_name ... | all]

limdebug [-c "class_name ..."] [-l debug_level] [-f logfile_name] [-o] ["host_name ..."]

resdebug [-c "class_name"] [-l debug_level] [-f logfile_name] [-o] ["host_name ..."]

limtime [-l timing_level] [-f logfile_name] [-o] ["host_name ..."]

restime [-l timing_level] [-f logfile_name] [-o] ["host_name ..."]

showconf lim [ host_name ... | all ]

help [subcommand ...] | ? [subcommand ...]

quit

-h

-V

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.

-v: Displays detailed messages about configuration file checking.

reconfig [-f] [-v]

Restarts LIMs on all hosts in the cluster. You should use reconfig after changing configuration files. The configuration files are checked before all LIMs in the cluster are restarted. If the configuration files are not correct, reconfiguration is not initiated.

If LSF_MASTER_LIST is specified in lsf.conf, you are prompted to confirm the reconfiguration for only the master candidate hosts.

-f: Disables user interaction and forces LIM to restart on all hosts in the cluster if no fatal errors are found. This option is useful in batch mode.
-v: Displays detailed messages about configuration file checking.

limstartup [-f] [host_name ... |all]

Starts LIM on the local host if no arguments are specified.

Starts LIMs on the specified hosts or on all hosts in the cluster if the word all is the only argument provided. You are prompted to confirm LIM startup.

Only root and users listed in the parameter LSF_STARTUP_USERS in lsf.sudoers(5) can use the all and -f options to start LIM as root.

If permission to start up LIMs as root is not configured, limstartup starts up LIMs as yourself after your confirmation.

-f: Disables interaction and does not ask for confirmation for starting LIMs.

limshutdown [-f] [host_name ... | all]

Shuts down LIM on the local host if no arguments are supplied.

Shuts down LIMs on the specified hosts or on all hosts in the cluster if the word all is specified. You are prompted to confirm LIM shutdown.

-f: Disables interaction and does not ask for confirmation for shutting down LIMs.

limrestart [-v] [-f] [host_name ... | all]

Restarts LIM on the local host if no arguments are supplied.

Restarts LIMs on the specified hosts or on all hosts in the cluster if the word all is specified. You are prompted to confirm LIM restart.

limrestart should be used with care. Do not make any modifications until all the LIMs have completed the startup process. If you execute limrestart host_name ... to restart some of the LIMs after changing the configuration files, but other LIMs are still running the old configuration, confusion arises among these LIMs. To avoid this situation, use reconfig instead of limrestart.

-v: Displays detailed messages about configuration file checking.
-f: Disables user interaction and forces LIM to restart if no fatal errors are found. This option is useful in batch mode. limrestart -f all is the same as reconfig -f.

limlock [-l time_seconds]

Locks LIM on the local host until it is explicitly unlocked if no time is specified. When a host is locked, LIM’s load status becomes lockU. No job is sent to a locked host by LSF.

-l time_seconds

The host is locked for the specified time in seconds.

LSF suspends all non-exclusive jobs running on the host. This is useful if a machine is running an exclusive job requiring all the available CPU time and/or memory. If LSB_DISABLE_LIMLOCK_EXCL=y (to enable preemption of exclusive jobs, for example) LSF suspends all jobs, including exclusive jobs.

limunlock

Unlocks LIM on the local host.

resstartup [-f] [host_name ... | all]

Starts RES on the local host if no arguments are specified.

Starts RESs on the specified hosts or on all hosts in the cluster if the word all is specified. You are prompted to confirm RES startup.

Only root and users defined by the LSF_STARTUP_USERS parameter in lsf.sudoers(5) can use the all and -f options to start RES as root.

For root installation to work properly, lsadmin must be installed as a setuid to root program.

-f: Disables interaction and does not ask for confirmation for starting RESs.

resshutdown [-f] [host_name ... | all]

Shuts down RES on the local host if no arguments are specified.

Shuts down RESs on the specified hosts or on all hosts in the cluster if the word all is specified. You are prompted to confirm RES shutdown.

If RES is running, it keeps running until all remote tasks exit.

-f: Disables interaction and does not ask for confirmation for shutting down RESs.

resrestart [-f] [host_name ... | all]

Restarts RES on the local host if no arguments are specified.

Restarts RESs on the specified hosts or on all hosts in the cluster if the word all is specified. You are prompted to confirm RES restart.

If RES is running, it keeps running until all remote tasks exit. While waiting for remote tasks to exit, another RES is restarted to serve the new queries.

-f: Disables interaction and does not ask for confirmation for restarting RESs.

reslogon [-c cpu_time] [host_name ... | all]

Logs all tasks executed by RES on the local host if no arguments are specified.

Logs tasks executed by RESs on the specified hosts or on all hosts in the cluster if all is specified.

RES writes the task’s resource usage information into the log file lsf.acct.host_name. The location of the log file is determined by LSF_RES_ACCTDIR defined in lsf.conf. If LSF_RES_ACCTDIR is not defined, or RES cannot access it, the log file is created in /tmp instead.

-c cpu_time: Logs only tasks that use more than the specified amount of CPU time. The amount of CPU time is specified by cpu_time in milliseconds.

reslogoff [host_name ... | all]

Turns off RES task logging on the specified hosts or on all hosts in the cluster if all is specified.

If no arguments are specified, turns off RES task logging on the local host.

limdebug [-c "class_name ..."] [-l debug_level] [-f logfile_name] [-o] ["host_name ..."]

Sets the message log level for LIM to include additional information in log files. You must be root or the LSF administrator to use this command.

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 LSF system log file directory, in the format daemon_name.log.host_name

host_name= local host (host from which command was submitted)

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.

-c "class_name ..."

Specify software classes for which debug messages are to be logged. If a list of classes is specified, they must be enclosed in quotation marks and separated by spaces.

Possible classes:

LC_AFS and LC2_AFS: Log AFS messages

LC_AUTH and LC2_AUTH: Log authentication messages

LC_CHKPNT - log checkpointing messages

LC_COMM and LC2_COMM: Log communication messages

LC_CONF - Print out all parameters in lsf.conf (and ego.conf)

LC_DCE and LC2_DCE: Log messages pertaining to DCE support

LC_EXEC and LC2_EXEC: Log significant steps for job execution

LC_FILE and LC2_FILE: Log file transfer messages

LC_HANG and LC2_HANG: Mark where a program might hang

LC_MULTI and LC2_MULTI: Log messages pertaining to MultiCluster

LC_PIM and LC2_PIM: Log PIM messages

LC_SIGNAL and LC2_SIGNAL: Log messages pertaining to signals

LC_TRACE and LC2_TRACE: Log significant program walk steps

LC_XDR and LC2_XDR: Log everything transferred by XDR

Default: 0 (no additional classes are logged)

Note: Classes are also listed in lsf.h.

-l debug_level

Specify 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 is saved in the LSF system log file directory.

The name of the file created has 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, no log file is created.

Default: current LSF system log file in the LSF system log file directory, in the format daemon_name.log.host_name.

-o

Turns off temporary debug settings and reset 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 LSF_DEBUG_RES, LSF_DEBUG_LIM.

Log file is reset back to the default log file.

"host_name ..."

Sets debug settings on the specified host or hosts.

Default: local host (host from which command was submitted)

resdebug [-c "class_name"] [-l debug_level] [-f logfile_name] [-o] ["host_name ..."]

Sets the message log level for RES to include additional information in log files. You must be the LSF administrator to use this command, not root.

See description of limdebug for an explanation of options.

limtime [-l timing_level] [-f logfile_name] [-o] ["host_name ..."]

Sets timing level for LIM to include additional timing information in log files. You must be root or the LSF administrator to use this command.

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 LSF system log file directory, in the format daemon_name.log.host_name

host_name=local host (host from which command was submitted)

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.

-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 is saved in the LSF system log file directory.

The name of the file created has 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, no log file is created.

Note:

Both timing and debug messages are logged in the same files.

Default: current LSF system log file in the LSF system log file directory, in the format daemon_name.log.host_name.

-o

Turns off temporary timing settings and resets them to the daemon starting state. The timing level is reset back to the value of the parameter for the corresponding daemon (LSF_TIME_LIM, LSF_TIME_RES).

Log file is reset back to the default log file.

"host_name ..."

Sets the timing level on the specified host or hosts.

Default: local host (host from which command was submitted)

restime [-l timing_level] [-f logfile_name] [-o] ["host_name ..."]

Sets timing level for RES to include additional timing information in log files. You must be the LSF administrator can use this command, not root.

See description of limtime for an explanation of options.

showconf lim [host_name ... | all]

Displays all configured parameters and their values set in lsf.conf or ego.conf that affect lim.

Use lsadmin showconf lim to display the parameters configured in lsf.conf and ego.conf that apply to root LIM. By default, lsadmin displays the local LIM parameters. You can optionally specify the host to display the LIM parameters.

In a MultiCluster environment, lsadmin showconf only displays the parameters of daemons on the local cluster.

Running lsadmin showconf from a master candidate host reaches all server hosts in the cluster. Running lsadmin showconf from a slave-only host may not be able to reach other slave-only hosts.

You cannot run lsadmin showconf lim from client hosts. lsadmin shows only server host configuration, not client host configuration.

lsadmin showconf only displays the values used by LSF.

LIM reads EGO_MASTER_LIST from wherever it is defined. You can define either LSF_MASTER_LIST in lsf.conf or EGO_MASTER_LIST in ego.conf. LIM reads lsf.conf first, and ego.conf if EGO is enabled in the LSF cluster. LIM only takes the value of LSF_MASTER_LIST if EGO_MASTER_LIST is not defined at all in ego.conf.

For example, if EGO is enabled in the LSF cluster, and you define LSF_MASTER_LIST in lsf.conf, and EGO_MASTER_LIST in ego.conf, lsadmin showconf displays the value of EGO_MASTER_LIST in ego.conf.

If EGO is disabled, ego.conf not loaded, so whatever is defined in lsf.conf is displayed.

help [subcommand ...] | ? [subcommand ...]

Displays the syntax and functionality of the specified commands. The commands must be explicit to lsadmin.

From the command prompt, you may use help or ?.

quit