lsadmin

Administrative tool to control LIM and RES daemon operations in LSF.

Synopsis

lsadmin subcommand

lsadmin [-h | -V]

Description

Important: This command can be used only by LSF administrators.

The lsadmin command runs privileged subcommands to control LIM and RES daemon operations in the LSF cluster.

If you do not include subcommands, the lsadmin command prompts for subcommands from the standard input.

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

When live configuration with the bconf command is enabled (the LSF_LIVE_CONFDIR parameter is defined in the lsf.conf file), the lsadmin command uses configuration files that are generated by the bconf command.

The lsadmin executable file is installed with the setuid flag turned off.

Subcommand synopsis

ckconfig [-v]

reconfig [-f] [-v]

limlock [-l time_seconds]

limunlock

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]

expire host_name1 [:instance_ID1] host_name2 [:instance_ID2] ...

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

quit

-h

-V

Options

subcommand: Runs the specified subcommand. See the 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 LIM on all hosts in the cluster. Use the reconfig subcommand after you change configuration files. The configuration files are checked before all LIM daemons in the cluster are restarted. If the configuration files are not correct, reconfiguration is not started.

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

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

limrestart

This subcommand is obsolete as of Fix Pack 11. Use the bctrld restart lim command instead to restart the LIM daemon.

limshutdown

This subcommand is obsolete as of Fix Pack 11. Use the bctrld stop lim command instead to shut down the LIM daemon.

limstartup

This subcommand is obsolete as of Fix Pack 11. Use the bctrld start lim command instead to start the LIM daemon.

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, the LIM 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 that are running on the host. Locking a host is useful if it is running an exclusive job that required all the available CPU time, memory, or both. If the LSB_DISABLE_LIMLOCK_EXCL=y parameter is set, to enable preemption of exclusive jobs, for example, LSF suspends all jobs, including exclusive jobs.

limunlock

Unlocks LIM on the local host.

resrestart

This subcommand is obsolete in LSF Version 10.1 Fix Pack 11. Use the bctrld restart res command instead to restart the RES daemon.

resshutdown

This subcommand is obsolete in LSF Version 10.1 Fix Pack 11. Use the bctrld stop res command instead to shut down the RES daemon.

resstartup

This subcommand is obsolete as of Fix Pack 11. Use the bctrld start res command instead to start the RES daemon.

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

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

Logs tasks that are run by RES on the specified hosts or on all hosts in the cluster if all is specified.

RES writes the task resource usage information into the log file lsf.acct.host_name. The location of the log file is determined by the LSF_RES_ACCTDIR parameter in the lsf.conf file. If the LSF_RES_ACCTDIR parameter is not defined, or RES cannot access it, the log file is created in the /tmp directory 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_namedaemon_name.log.host_name: 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 the command was submitted.

In LSF multicluster capability, debug levels can be set only for hosts within the same cluster. For example, you cannot 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.

By default, no additional classes are logged (class name 0).

Note: Classes are also listed in the lsf.h header file.

The following classes are supported:

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 all parameters in the lsf.conf and ego.conf files.
LC_DCE and LC2_DCE: Log messages that pertain 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 that pertain to LSF multicluster capability.
LC_PIM and LC2_PIM: Log PIM messages.
LC_SIGNAL and LC2_SIGNAL: Log messages that pertain to signals.
LC_TRACE and LC2_TRACE: Log significant program walk steps.
LC_XDR and LC2_XDR: Log everything that is transferred by XDR.

-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.

The default is 0 (LOG_DEBUG level in parameter LSF_LOG_MASK)

The following values are supported:

0: LOG_DEBUG level for parameter LSF_LOG_MASK in the lsf.conf file. 0 is the default.
1: LOG_DEBUG1 level for extended logging. A higher level includes lower logging levels. For example, LOG_DEBUG1 includes LOG_DEBUG levels.
2: LOG_DEBUG2 level for extended logging. A higher level includes lower logging levels. For example, LOG_DEBUG2 includes 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.

-f logfile_name

Specify the name of the file into which debugging messages are to be logged. You can specify a file name with or without a full path.

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 that is created has the following format:

logfile_name.daemon_name.log.host_name

On UNIX and Linux, 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.

By default, current LSF system log file in the LSF system log file directory is used.

-o

Turns off temporary debug settings and resets them to the daemon start 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_RES, LSB_DEBUG_LIM.

The log file is also reset back to the default log file.

host_name ...

Optional. Sets debug settings on the specified host or hosts.

The default is the local host (the 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 the LIM daemon to include extra 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: The host from which command was submitted.

In LSF multicluster capability, timing levels can be set only for hosts within the same cluster. For example, you cannot 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.

The following values are supported: 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.

By default, no timing information is logged.

-f logfile_name

Specify the name of the file into which timing messages are to be logged. You can specify a file name with or without a full path.

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 that is created has the following format:

logfile_name.daemon_name.log.host_name

On UNIX and Linux, 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.

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

The default is the current LSF system log file in the LSF system log file directory, in the format daemon_name.log.host_name.

-o

Optional. Turn off temporary timing settings and reset them to the daemon start state. The timing level is reset back to the value of the parameter for the corresponding daemon (LSB_TIME_LIM, LSB_TIME_RES).

The log file is also reset back to the default log file.

host_name ...

Sets the timing level on the specified host or hosts.

By default, timing level is set on the 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 extra timing information in log files. You must be the LSF administrator to 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 the lsf.conf or ego.conf file that affect the LIM daemon.

By default, the lsadmin command displays the local LIM parameters. You can optionally specify the host to display the LIM parameters.

In LSF multicluster capability, the lsadmin showconf command displays only the parameters of daemons on the local cluster.

Running the lsadmin showconf command from a management candidate host reaches all server hosts in the cluster. Running the lsadmin showconf command from a server-only host might not be able to reach other server-only hosts.

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

The lsadmin showconf command displays only the values that are used by LSF.

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

For example, if you define the LSF_MASTER_LIST parameter in the lsf.conffile, and the EGO_MASTER_LIST parameter in the ego.conf file, the lsadmin showconf command displays the value of the EGO_MASTER_LIST parameter.

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

expire host_name1 [:instance_ID1] host_name2 [:instance_ID2] ...

(Starting in Fix Pack 14) Allows administrators to mark dynamic hosts, which are no longer available, as expired. Specify the host name, and optionally, the instance ID for that host. Preface the instance ID with a colon (:); for example, lsadmin expire hostA:instance1234. You can also specify a list of hosts, separating each host (or host and instance ID combination), with a blank space; for example, lsadmin expire hostA:instance1234 hostB:instance5678. The instance ID must match the host's value for the instanceID string resource.

Note:

You can mark only dynamic (not static) hosts as expired.
Ensure that the LIM daemon on the host to be expired is no longer alive: run lsadmin limshutdown host before running lsadmin expire host; otherwise, if the LIM daemon is still alive, the expired host can show again later on.

After you have marked a host as expired, running any commands from the expired host will be rejected. You can run the lsload and bhosts commands, on other hosts, to verify that the host no longer shows in the command output. Note that lshosts -s, bhosts -s, and bjobs commands can still show expired hosts before they are cleaned from memory.

Finally, if you have set the LSF_DYNAMIC_HOST_TIMEOUT parameter in the lsf.conf configuration file, LSF automatically removes those marked hosts and cleans up the cluster.

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

Displays the syntax and functions of the specified subcommands.

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

quit

Exits the lsadmin session.