This chapter describes the procedure for installing and/or configuring the license file for LSF on UNIX platforms. If you are preparing to execute the procedures in this section, you should have already installed the LSF software.
If you received a DEMO license key, you can proceed directly with the installation. To get a permanent license from your LSF vendor, see the Release Notes or `Getting License Key Information' on page 34. You can install LSF with a DEMO license key and change to a permanent license later with no interruption in service.
Store the license key in a file. lsfsetup automatically finds your license key if you store the license key in a file named license.dat in the distribution directory. Otherwise, you must enter the path name of the file during the installation.
LSF Suite 3.2 includes the following products: LSF Base, LSF Batch, LSF JobScheduler, LSF MultiCluster, LSF Make, LSF Analyzer, and LSF Parallel. LSF Base is a prerequisite for all other LSF products.
Because all products are packaged in the same distribution file, LSF's installation program (lsfsetup) requires you to specify which products you want to install. By default, LSF Batch and LSF Base are installed.
Changes to enable a particular product in a cluster are handled automatically by lsfsetup based on your input during the installation process. You can always subsequently modify the environment to reflect a new product license.
An LSF client host is independent of the products that run on the LSF server hosts. That is, there is no difference, for example, between a client for LSF Batch and a client for LSF JobScheduler.
Each of these products is licensed independently. Individual hosts can be configured to run as LSF Batch servers or LSF JobScheduler servers within the same cluster. LSF MultiCluster is licensed on a cluster-wide basis, that is, the entire cluster is either enabled or disabled for multicluster operation. LSF JobScheduler has an additional scheduler license for the master server, which does the scheduling, in addition to serving licenses for the job execution servers.
The license file used to serve the cluster must have the corresponding products. A host will show as unlicensed if the license for the product it was configured to run is unavailable. For example, if a cluster is configured to run LSF JobScheduler on all hosts, and the license file does not contain the LSF JobScheduler product, then the hosts will be unlicensed, even if there are licenses for LSF Base or LSF Batch.
This section explains in detail how to get the information necessary to acquire a permanent license key for LSF. You do not need to read this section if you:
lsfsetup command
LSF uses the FLEXlm license management software from Globetrotter Software. FLEXlm supports file-based DEMO licenses and server-based permanent licenses.
You must have a license key to run LSF. If you are installing LSF for a limited time evaluation, you should have received a DEMO key from your software vendor. If you are installing LSF for permanent use, you must get a permanent license key from your vendor. You can use a DEMO key to install LSF and get it running, and switch to the permanent license later.
Permanent licenses use a license server daemon running on one or more hosts in your network. The license server counts the number of licenses in use. For more information on how FLEXlm works and for examples of license keys, see `LSF License Management' on page 109.
The FLEXlm license key and license server are independent of LSF clusters and LSF server hosts. You can organize your hosts into clusters any way you choose. The license server counts only the total number of hosts running LSF; these hosts can belong to any cluster in your network. As long as all your hosts can contact each other on the network, you should request a single license key that covers all the hosts on which you plan to run LSF.
If you are already running FLEXlm to support other software licenses, you can add your LSF license key to the existing FLEXlm license file. If you are not already using FLEXlm, you must choose a host or hosts to run the license server daemon.
FLEXlm normally runs the license server daemon on one host. LSF tolerates failure of the license server daemon for up to 60 hours, as long as the LSF Load Information Manager (LIM) on the master host is not restarted or shutdown. In spite of this, if you are concerned about reliability, you can run the license server daemon on three hosts. Software licenses are available as long as two of the three license servers are available.
You should run the license server on the host that is the NFS server for the LSF software. That way the licenses are available whenever the software is. However, it is not recommended that you make the license server host the same as the master host for the cluster. If you do this, and the master host goes down, the backup master that takes over will not be able to check license tokens out from the license server on the original master, which has failed.
To create a permanent license key, your software vendor needs a hardware host name and host identifier for each license server host. LSF comes with a script to help collect this information.
./lsfsetup command.
If you already have FLEXlm installed, lsfsetup asks whether
you want to use the same license server hosts.
If you answer yes,
lsfsetupuses the server host IDs from your existing FLEXlm license file. Otherwise,lsfsetupasks for a host name and tries to get the host ID for that host.If
lsfsetupis unable to get the host ID, it prompts you to run thelmhostidcommand on each license server host and enter the host IDs for those hosts.
lsfsetupcreates a file namedlicense.info. Follow the instructions provided in your software Release Notes to send the contents of thelicense.infofile to your LSF vendor.If you receive your license key by electronic mail or download from Platform's WWW or FTP sites, copy the file you receive into the distribution directory and name the file
license.dat. If you receive your license key by paper mail or FAX, use a text editor to create alicense.datfile containing your key.
If you have already set up your license key, you do not need to read this section, as it contains detailed descriptions of the procedures for setting up LSF software license keys.
Before performing this step you must get a license key. If you do not have a license key, see `Getting License Key Information' on page 34. If you plan to install a permanent license and are waiting for your permanent license key, you can install a DEMO license and switch to the permanent license later on.
Both the license server daemons and the LIM on every host must have access to the license key. For a temporary DEMO license key, you can ensure this by:
For a permanent license key, you can use either of these methods, or you can save the license file on the host where the license server is running, and set the LSF_LICENSE_FILE variable in the lsf.conf files on all other hosts to port@host.
If you are installing a DEMO license, follow the procedure in `Installing a DEMO License' on page 37.
If you are installing a permanent license or switching from a DEMO license to a permanent license, and you are not running FLEXlm license server daemons for any other software licenses, follow the procedure in `Installing a New Permanent License' on page 38.
If you are installing a new LSF permanent license and you already have license servers running for other software licenses, or if you are upgrading your LSF license, follow the procedure in `Adding a Permanent License' on page 40.
If you are installing LSF with a DEMO license, you do not need to run the license server daemons. Each LSF host reads the license file directly, and LSF runs, without trying to contact the server, until the license expires.
For the DEMO license, you should install the license key in a file named license.dat in the LSF configuration directory LSF_CONFDIR, as defined in the lsf.conf file. Because the configuration directory is normally shared by all hosts in the LSF cluster, you do not need to copy the license.dat file to every host.
./lsfsetup command.
The command looks for your vendor-supplied license
key in the license.dat file in the current directory and the
parent directory. If the license.dat file is not found, lsfsetup
asks you to enter the full path name of the license.dat file
containing your DEMO license key.
The license manager checks your license.dat file to confirm
the licensed products. It then prompts you for permission to enter appropriate
products in the `PRODUCTS=...' line in the lsf.cluster.cluster
file.
The lsfsetup script installs your key
in an existing license file, or creates the file if necessary. The lsfsetup
program updates the LSF_LICENSE_FILE variable in the lsf.conf
file so that it is equal to the full path name of the license file.
If you change the location of the installed license key file, you must make sure that the LSF_LICENSE_FILE variable in the lsf.conf file is updated for all hosts in the cluster.
Follow this procedure if you are installing an LSF permanent license in a network with no FLEXlm servers, switching from a DEMO license to a permanent license, or setting up a separate FLEXlm server for the LSF license. If you are adding an LSF license to a FLEXlm license key file that contains other licenses or upgrading an existing LSF permanent license, follow the procedure in `Adding a Permanent License' on page 40.
The permanent license must be installed on the license server host. If you are using multiple FLEXlm servers, follow this procedure on any one of the license server hosts to set up the license key file, and then start the license server daemons by hand on the other license server hosts.
license.dat.
./lsfsetup command. Choose option 4, `License Management'.
Next choose option 2, `Install a New License'. From the next menu choose option
2, `Set up permanent (floating) license'. The command looks for the LSF license.dat
file provided by your vendor. If the license.dat file is not
found in the current directory or the parent directory, the command prompts
you to enter the file name.
lsfsetup asks whether you are installing a permanent license
key for the first time. This procedure is for setting up a new license, so
select option 1, `First installation of a permanent license'.
license.dat file in the LSF configuration directory, choose
option 2. Otherwise, choose option 3, and enter the full path name where you
want the license file to be installed.
A copy of the old license file is left in the license.dat.old
file in the same directory as your installed license.dat file.
LSF_LOGDIR parameter in the installation procedure,
the license setup puts the FLEXlm log in the file LSF_LOGDIR/license.log.
Otherwise, you must enter the full path name of a log file to store the FLEXlm
log messages. Put the FLEXlm log in the same directory as your other system
logs, or in the /tmp directory.
lsfsetup script asks if you want to start the license server
daemons now. Enter `y'. The daemons are automatically started on the host
where lsfsetup is running. If you are using three license server
hosts, start the license server daemons by hand on the other two hosts.
To start the daemons by hand, log in as root, change directory to the distribution directory, and run the startup script lsf_license:
# ./lsf_license start
Follow this procedure if you are adding LSF licenses to an existing FLEXlm license key file. This procedure applies if you have already configured FLEXlm to manage licenses for a different product, or if you have already installed FLEXlm to manage an LSF permanent license and you have received a new license key, for example to support a larger number of hosts.
If you are switching from a DEMO license to a permanent license, follow the instructions in `Installing a New Permanent License' on page 38.
license.dat.
LSF_SERVERDIR/lsfsetup. Select option 4, `License Management', and then option 2, `Install a New License'. If your new license information is not in the file ./license.dat or ../license.dat, enter the full path name when prompted.
/usr/local/flexlm/licenses/license.dat, choose option 1. If your license key file is LSF_CONFDIR/license.dat, choose option 2. Otherwise, choose option 3 and enter the full path name of the license file. lsfsetup adds your new license keys to the existing license file.
lsfsetup tells the license server daemons to reread the license file, and checks to make sure your LSF license is available.
If you purchase additional licenses to use LSF products on more hosts in your LSF cluster, you may be provided with an INCREMENT license key instead of a new FEATURE line.
To install an LSF INCREMENT license key:
license.dat file using a text editor like vi or emacs.
license.dat
file.
lmreread -c <LSF_LICENSE_FILE>
The lmreread program is found in your LSF_SERVERDIR.
Both variables are defined in your lsf.conf file. See `LSF
Variables' on page 5 for more detailed information.
lsadmin reconfig
The license file is reread and the changes accepted by LSF.
You must add the lsf_license startup script to the appropriate place on the license server hosts.
For BSD-based systems, add the path of lsf_license to the end of the /etc/rc.local file.
For HP-UX 9.x systems, you may have a BSD-style /etc/rc.local file, or you may need to add lsf_license to the /etc/rc file.
For IBM AIX systems, you may have a BSD-style /etc/rc.local, or you may need to copy the lsf_license script to the LSF_SERVERDIR directory and use smit to add $LSF_SERVERDIR/lsf_license to the list of commands run at startup time.
For System V-based systems including Sun Solaris 2 and SGI IRIX, move the lsf_license file to /etc/init.d/lsf_license and add links from the /etc/rc2.d and /etc/rc1.d directories:
# cp lsf_license /etc/init.d/lsf_license # ln /etc/init.d/lsf_license /etc/rc2.d/S90lsf_license
On Digital UNIX and HP-UX 10.x, the instructions are similar to those for System V, but the directory names are different:
# cp lsf_license /sbin/init.d/lsf_license # ln /sbin/init.d/lsf_license /sbin/rc3.d/S90lsf_license
You should ensure that the lsf_license script runs after any NFS server scripts but before the lsf_daemons script in the system boot procedure.
If you are running multiple license server hosts, configure the system startup routines to start the license server daemons on each host, and then start the daemons by hand on the backup server hosts.
The lmstat program can be used to check the status of the license server and determine how many licenses are available. The lmstat program requires you to give it the path to the server's license file using the -c option.
The following is a sample of what you can expect to see when you use lmstat.
% lmstat -a -c /usr/local/mnt/lsf/conf/license.dat lmstat - Copyright © 1989-1997 Globetrotter Software, Inc.
Flexible License Manager status on Fri 10/24/1997 11:13 License server status: 1700@hostA License file(s) on hostA: /usr/local/mnt/lsf/conf/license.dat: hostA: license server UP (MASTER) v5.12 Vendor daemon status (on hostA): lsf_ld: UP v4.1 Feature usage info: Users of lsf_base: (Total of 1140 licenses available) "lsf_base" v3.100, vendor: lsf_ld
floating license root hostB /dev/tty (v3.1) (hostA/1700 706), start Fri 10/24 10:21, 140 licenses Users of lsf_batch: (Total of 1150 licenses available) "lsf_batch" v3.100, vendor: lsf_ld
floating license root hostB /dev/tty (v3.1) (hostA/1700 806), start Fri 10/24 10:21, 138 licenses root hostC.platform.com /dev/tty (v3.1) (hostA/1700 1301), start Fri 10/24 10:37, 18 licenses Users of lsf_jobscheduler: (Total of 1140 licenses available) "lsf_jobscheduler" v3.100, vendor: lsf_ld
floating license root hostB /dev/tty (v3.1) (hostA/1700 906), start Fri 10/24 10:21, 138 licenses Users of lsf_jobscheduler_server: (Total of 1140 licenses available) "lsf_jobscheduler_server" v3.100, vendor: lsf_ld
floating license root hostB /dev/tty (v3.1) (hostA/1700 1006), start Fri 10/24 10:21, 138 licenses Users of lsf_multicluster: (Total of 1140 licenses available) "lsf_multicluster" v3.100, vendor: lsf_ld
floating license root hostB /dev/tty (v3.1) (hostA/1700 1106), start Fri 10/24 10:21, 138 licenses
The output gives the status of the license server together with the vendor daemon. The usage information for each product in the license file is provided.
Software licenses are stored in a text file. The default location for this license file is:
/usr/local/flexlm/licenses/license.dat*
This may be different at your site, depending on what decisions were made when FLEXlm was initially installed.
The license file must be accessible from every host that runs licensed software. Normally, it is most convenient to place the license file in a shared directory. The variable LSF_LICENSE_FILE in the lsf.conf file should point to this location, allowing LSF to locate the license file.
An alternative to specifying a file path name in the LSF_LICENSE_FILE variable is to use "port@host" notation to indicate the name of the license server host and port being used by the lmgrd daemon. For example:
LSF_LICENSE_FILE="1700@hostD, 1700@hostC, 1700@hostB"
The port number must be the same as that specified in the license file.