LSF on Windows installation parameter quick reference

Use this reference to learn about the installation parameters or dialog windows.

LSF installation parameters

The installation parameters for LSF are configured automatically by the interactive installer. The related interactive installation dialog window name is shown for each parameter.

If you do not use the interactive installer, specify command-line installation options as needed. The syntax is shown for each parameter.

For silent installation with msiexec, the syntax is:

msiexec /i package_file [parameter_value ...] /quiet

For example, to install a server host and specify the installation directory:

msiexec /i \\hostB\download\lsf<version>_win-x64.msi SERVERHOSTS=hostM HOSTTYPE=Server INSTALLDIR=C:\LSF /quiet

For silent uninstall, the msiexec syntax is:

msiexec /x package_file /quiet

Initial configuration template

The installer uses a configuration template to specify initial LSF configuration parameters when the installation is complete. For Windows, the installer specifies the following initial configuration file parameter values based on the default configuration template:

  • lsf.conf (LSF Standard Edition)
    DAEMON_SHUTDOWN_DELAY=180
EGO_ENABLE_AUTO_DAEMON_SHUTDOWN=Y
LSB_DISABLE_LIMLOCK_EXCL=Y
LSB_INDEX_BY_JOB="JOBNAME"
LSB_MOD_ALL_JOBS=Y
LSF_DISABLE_LSRUN=Y
LSF_PIM_SLEEPTIME_UPDATE=Y
LSF_UNIT_FOR_LIMITS=MB
  • lsf.conf (LSF Advanced Edition)
    LSB_DISABLE_LIMLOCK_EXCL=Y
LSB_INDEX_BY_JOB="JOBNAME"
LSF_DISABLE_LSRUN=Y
LSF_PIM_SPEEPTIME_UPDATE=Y
  • lsb.params (LSF Standard Edition)
    ABS_RUNLIMIT=Y
DEFAULT_QUEUE=normal interactive
JOB_ACCEPT_INTERVAL=0
JOB_DEP_LAST_SUB=1
JOB_SCHEDULING_INTERVAL=1
MAX_CONCURRENT_QUERY=100
MAX_JOB_NUM=10000
MBD_SLEEP_TIME=10
NEWJOB_REFRESH=Y
PARALLEL_SCHED_BY_SLOT=Y
SBD_SLEEP_TIME=7
  • lsb.params (LSF Advanced Edition)
    SBD_SLEEP_TIME=7

In addition, for LSF Standard Edition and LSF Advanced Edition, the installer enables fair share scheduling for all queues except owner and license as follows in lsb.queues:

Begin Queue
...
FAIRSHARE=USER_SHARES[[default, 1]]
...
End Queue

Parameter reference

The installer might require the following parameters.

SHAREDIR (Shared Directory window)

Description

Full path to the shared directory. The shared directory contains shared configuration files and is used for management host failover. Management host failover is recommended for production clusters.

Note:

Specify a shared directory when both your management and all management candidate hosts are Windows hosts. You cannot mix Windows and UNIX management and management candidate hosts.

Syntax

SHAREDIR="\\fileserver\path"

Example

SHAREDIR="\\HostF\EGOshare"

Default

No shared directory

ENTITLEMENTFILE

Description

Full path to the LSF entitlement file. LSF uses the entitlement to determine which feature set to enable or disable based on the edition of the product. You must download the entitlement file for the edition of the product you are running, and set ENTITLEMENTFILE to the full path to the entitlement file you downloaded.

LSF on Windows uses the following entitlement files:

  • LSF Standard Edition: lsf_std_entitlement.dat
  • LSF Advanced Edition Advanced Edition: adv_entitlement.dat
Syntax

ENTITLEMENTFILE=path

Default

None

HOSTTYPE (Installation Options window)

Description

The type of host you want to install. Install one of the following kinds of host: LSF management host (new cluster), management candidate, server, or client host.

Syntax

HOSTTYPE= Master | Candidate | Server | Client

Example

HOSTTYPE=Server

Default

LSF management host (new cluster)

The management host always gets full package

SERVICETYPE (SBD and RES Control window)

Description

Set the value to EGO if you want EGO service controller to start LSF res and sbatchd, and restart if they fail.

Syntax

SERVICETYPE=EGO | LSF

Example

SERVICETYPE=EGO

Default

LSF, res and res are managed as Windows services

CLUSTERNAME (Cluster Name window)

Description

Name of the LSF cluster. Do not use the same name as any LSF host, user, or user group.

Syntax

CLUSTERNAME=cluster_name

Example

CLUSTERNAME=Research

Default

Cluster1

INSTALLDIR (Installation Directory window)

Description

Full path to the top level LSF installation directory.

Syntax

INSTALLDIR=path

Default

C:\LSF_10.1.0

CLUSTERID (Cluster ID window)

Description

This parameter is not required for normal installation of a new cluster. Specify the unique cluster ID of your cluster.

Cluster ID is used to identify different clusters when one host belongs to multiple clusters. It is appended to Windows service names.

Syntax

CLUSTERID=cluster_ID

Example

CLUSTERID=research

Default

Not defined

CLUSTERADMIN (Cluster Administrator window)

Description

Cluster administrator (lsfadmin).

Syntax

CLUSTERADMIN="domain\user_name"

or

CLUSTERADMIN=".\user_name"

Example

CLUSTERADMIN="DOMAIN\lsfadmin"

Default

Windows installation account is the default cluster administrator

ADMINPASSWD (Cluster Administrator window)

Description

Actual password of the cluster administrator account (lsfadmin).

Syntax

ADMINPASSWD="password"

Applies to the management host only

Example

ADMINPASSWD="mypasswd"

Default

None. Required parameter

Configuration Options window

Description

Default (quick installation) or custom configuration. Select default configuration to use default values for all remaining installation options. This dialog window has no corresponding installation parameter.

Default

Default configuration (quick installation)

SERVICEUSERNAME (Windows Service Account window)

Description

Name of the system services execution user OS account. This account is used to run LSF system services.

Syntax

SERVICEUSERNAME="domain\user_name"

or

SERVICEUSERNAME=".\user_name"

Example

SERVICEUSERNAME="DOMAIN\lsfadmin"

Default

The local system account

SERVICEPASSWORD (Windows Service Account window)

Description

Actual password of the system services execution user OS account.

Syntax

SERVICEPASSWORD="password"

Applies to the local server host only

Example

SERVICEPASSWORD="mypasswd"

Default

None. The default systems service execution user OS account is the local system account, which does not require a password

BASEPORT (LSF Ports window)

Description

Base connection port. LSF uses four consecutive ports that start from the base port.

Syntax

BASEPORT=port_number

Example

BASEPORT=7869

Default

7869, which indicates ports 7869-7872

RESPORT (LSF Ports window)

Description

LSF res service port.

Syntax

RESPORT=port_number

Example

RESPORT=6878

Default

6878

SBDPORT (LSF Ports window)

Description

LSF sbatchd service port.

Syntax

SBDPORT=port_number

Example

SBDPORT=6882

Default

6882

MBDPORT (LSF Ports window)

Description

LSF mbatchd port.

Syntax

MBDPORT=port_number

Example

MBDPORT=6881

Default

6881

DYNAMICHOST (Dynamic Hosts window)

Description

Set the value to Yes to enable dynamic hosts in LSF. After installation, configure security for dynamic hosts.

Syntax

DYNAMICHOST=Yes | No

Example

DYNAMICHOST=Yes

Default

No, hosts cannot join the cluster dynamically

STARTUP (Startup window)

Description

Set the value to No to disable automatic startup of LSF after installation.

Syntax

STARTUP=Yes | No

Example

STARTUP=Yes

For management candidates and shared server hosts, specify No.

Default

Yes, start LSF automatically

ENABLEEGO (Enable EGO window)

Description

Set the value to Yes if you want to enable advanced EGO features.

Syntax

ENABLEEGO=Yes | No

Example

ENABLEEGO=Yes

Default

No, disable advanced EGO features

SERVERHOSTS (Server Hosts window)

Description

Define LSF server hosts that this host can contact.

Syntax

SERVERHOSTS=host_name ...

Example

SERVERHOSTS=HostM HostW

Default

None. Optional on management host. Required on the server host for interactive installation