bctrld

Administrative tool to control LSF daemons.

Synopsis

bctrld subcommand daemon options
bctrld [-h | -V]

Description

The bctrld command runs privileged subcommands to stop, start, and restart the LIM, RES, and sbatchd daemons in the LSF cluster.

If you do not include subcommands, the bctrld 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 bctrld command uses configuration files that are generated by the bconf command.

Important: The bctrld executable file is installed with the setuid flag turned off and this command can be used only by root.

To allow non-root users to run the bctrld command to start the daemons, you must either add the non-root users to the sudo Linux group or enable the setuid flag and configure the non-root users in the lsf.sudoers file.

Description

The bctrld command runs privileged subcommands to stop, start, and restart the LIM, RES, and sbatchd daemons in the LSF cluster.

If you do not include subcommands, the bctrld 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 bctrld command uses configuration files that are generated by the bconf command.

Important: The bctrld executable file is installed with the setuid flag turned off and this command can be used only by root.

To allow non-root users to run the bctrld command to start the daemons, you must either add the non-root users to the sudo Linux group or enable the setuid flag and configure the non-root users in the lsf.sudoers file.

Subcommand synopsis

restart lim [-v] [-f] [host_name ... | all]

restart res [-f] [host_name ... | all]

restart sbd [-f] [host_name ... | all]

start lim [-f] [host_name ... |all]

start res [-f] [host_name ... | all]

start sbd [-f] [host_name ... | all]

stop lim [-f] [host_name ... | all]

stop res [-f] [host_name ... | all]

stop sbd [-f] [host_name ... | all]

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

restart lim [-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.

Use the bctrld restart lim subcommand with care. Do not change the cluster until all the LIMs start. If you run the bctrld restart lim host_name ... subcommand to restart some of the LIMs after you change the configuration files, but other LIMs are still running the old configuration, confusion arises among these LIMs. To avoid this situation, use the lsadmin reconfig subcommand instead of the bctrld restart lim subcommand.
-v
Displays detailed messages about configuration file checking.
-f
Disables user interaction and forces LIM to restart if no unrecoverable errors are found. This option is useful in batch mode. The bctrld restart lim -f all subcommand is the same as the lsadmin reconfig -f subcommand.
restart res [-f] [host_name ... | all]
Restarts RES on the local host if no arguments are specified.

Restarts RES 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 the bctrld restart res subcommand waits 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 RES.
restart sbd [-f] [host_name ... | all]
Restarts the sbatchd daemon 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. The sbatchd daemon reruns itself from the beginning. This rerun allows new sbatchd binary files to be used.
-f
Specify the name of the file into which timing messages are to be logged. A file name with or without a full path can 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 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, 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.

start lim [-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 who are listed in the parameter LSF_STARTUP_USERS in the lsf.sudoers file can use the all and -f options to start LIM as root.

If permission to start LIMs as root is not configured, use the bctrld start lim subcommand to start LIMs as yourself after your confirmation.

-f
Disables interaction and does not ask for confirmation for starting LIMs.
start res [-f] [host_name ... | all]
Starts RES on the local host if no arguments are specified.

Starts RES 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 who are defined by the LSF_STARTUP_USERS parameter in the lsf.sudoers file can use the all and -f options to start RES as root.

-f
Disables interaction and does not ask for confirmation for starting RESs.
start sbd [-f] [host_name ... | all]
Starts the sbatchd daemon on the specified hosts, or on all batch server hosts if the reserved word all is specified. Only root and users who are listed in the lsf.sudoers file can use the all and -f options. If no host is specified, the local host is assumed.
-f
Disables interaction and does not ask for confirmation for starting the sbatchd daemon.
stop lim [-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.

stop res [-f] [host_name ... | all]
Shuts down RES on the local host if no arguments are specified.

Shuts down RES 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 RES.
stop sbd [-f] [host_name ... | all]
Shuts down the sbatchd daemon 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. The sbatchd daemon exits after it receives the request.
-f
Disables interaction and does not ask for confirmation for shutting down sbatchd.
help [subcommand ...] | ? [subcommand ...]
Displays the syntax and functions of the specified subcommands.

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

quit
Exits the bctrld session.

See also

lsf.conf, lsf.sudoers