KAPPA FlexLM Server Protection v5.20.

01

1. Introduction
With a network protection, at run time the program checks the presence and the validity of a license over the
network. A network protection is designed to provide one or several simultaneous users. The licenses are
managed by a license server. The network protection is a protection by software (FlexLM software protection)
through a license file located on the machine running the license server. This type of protection is referred to
as the ‘KAPPA FlexLM Server protection’.

The license server can run on Windows 7, Windows 8.1, Windows 10, Windows Server 2008, Windows Server
2012, Windows Server 2016, Windows Server 2019, 32 or 64-bit platforms.

KAPPA software can combine a network protection and a local protection. For each KAPPA product, the
protection systems to be used are set during software installation according to the user specification.

The following sections of this document provide the step-by-step procedure to set up and manage a FlexLM
protected system:

- Section 2 covers the license server installation,

- Section 3 refers to the client installation,
- Section 4 describes the tools to manage the protected system,
- Section 5 is about the Sentinel HL Pro dongles,
- Section 6 deals with the troubleshooting of the FLEXId dongle installation.

If you already have a FlexLM license server running, we strongly recommend you refer to the following
procedure.

KAPPA FlexLM Server Protection v5.20.01 © KAPPA 1988-2019 Installation instructions - 1/8
2. License server installation
The FlexLM license server is responsible for tracking license usage and processing queries submitted by
protected applications. It has to be started once on the network and can only be started from the machine
identified in the license file.

To install the FlexLM license server, you need to run the FlexLM Server protection installation setup.

2.1. FlexLM Server protection installation setup

The FlexLM Server protection setup is used on the machine designated as the license server machine. It installs
the license server, the administration tools and the documentation.

Warning: please note that running the FlexLM Server protection installation setup is mandatory to use
KAPPA software with a FlexLM network protection.

The setup will install the FlexLM version 11.16.1 (KAPPA FlexLM Server 5.20.01) and the specific KAPPA
vendor daemon (kappa.exe). This file is located in …KAPPA\Flexlm Server. If you have other vendor
products, please refer to section 2.2. The LMTOOLS program will need to be correctly configured referring
to Section 2.4. Once configured, see Section 2.5 to start your server.

Download the KAPPA Flexlm server installation setup from the KAPPA website and run the setup.exe file. Note
that all the files included in the installation zip file need to be extracted and copied on your local drive before
executing the setup.exe. The installation program starts, and you are guided through the setup procedure.
After a welcome and a license agreement screen are displayed, you will need to specify the installation
directory. The default target directory is C:\Program Files (x86)\KAPPA\Flexlm Server.

The next dialog requires the name of the folder to be created in the Windows manager. The installation
proceeds with the actual file transfer. At the end of the installation, the Windows program group is created.
The installation is now complete. To finish your configuration, you will need to perform several operations on
the license server machine itself, then on the client machines. The step-by-step procedure is described in the
following sections.

2.2. Manual Flexlm Server installation

If you already have a FlexLM server configured, please verify the lmgrd.exe version installed on your server.
The minimum required version is v11.16.1 or higher. You can download from our website both the lmgrd.exe
and kappa.exe files. If your Lmgrd version is already compliant, please just download and copy the kappa.exe
file on your server in the directory including the other Vendor lmgrd.exe. Your KAPPA license file will also have
to be saved together with the other vendor license files.

KAPPA FlexLM Server Protection v5.20.01 © KAPPA 1988-2019 Installation instructions - 2/8
2.3. Installing the license file
The FlexLM license server processes the requests from the protected applications by checking the content of
a text file called the license file. The license file is created by KAPPA and installed by the license administrator.
It contains information about the license server node (SERVER line), and the protected applications (FEATURE
line). The SERVER line specifies the host identification information.

The license can be locked on the server itself, on a Sentinel HL Pro dongle (USB) or on a ‘FLEXId’ bitlock
(USB) provided by KAPPA. The use of the physical dongle allows to change the license from one server
to another provided the key is connected to a physical server and the license is copied on the machine, whereas
a license locked on the server itself can only run on that particular server. Note that using a physical key requires
that a USB port is available on your server.

A FEATURE line describes the privileges and the maximum number of simultaneous users for the corresponding
application. For a license locked on the server itself (as opposed to a physical dongle), you need to execute on
your license server the ‘Network License Request Tool’ found in …\KAPPA\Flexlm Server\FlexlmTools\Network
License Request Form.

FlexLM Network License Request Form

Fill in your email address and specify the products. The machine identification information is automatically
retrieved. You should note the license server machine HOSTNAME provided in the ‘Computer Identification’
section. This information will be requested during the KAPPA software installation. Once the form is filled-in,
‘Make request’, agree with the conditions, so you can ‘Save form as file’ and send it to KAPPA. Upon receipt of
the Request Form (.kfr file), KAPPA will create the corresponding license file.

KAPPA FlexLM Server Protection v5.20.01 © KAPPA 1988-2019 Installation instructions - 3/8
With a physical dongle, you do not need to execute this program. The Sentinel HL Pro dongles are
driverless and do not require any driver installation. You just need to plug in the key so it is auto-detected on
your computer. Note that with a FLEXId dongle , the appropriate bitlock driver must be installed on the
machine. Execute the ‘haspdinst.exe’ file found in …\KAPPA\Flexlm Server to install the required driver.

When you receive the license file from KAPPA, you must copy it in a sub-directory of the FlexLM Server
installation called ‘FlexlmLicenses’. By default, the FlexLM Server protection elements are installed in
C:\Program Files (x86)\KAPPA\FlexLM Server and the license files in C:\Program Files (x86)\KAPPA\FlexLM
Server\FlexlmLicenses.

It is possible to amend the license file received to specify a port number to FlexLM on the SERVER line and /
or to the KAPPA daemon on the VENDOR line as illustrated below. The default port range used by FlexLM is
between 27000 and 27009, the specified port needs to be available and open on the firewall. If you impose a
port to FlexLM on the SERVER line, please add the same port number on your client machines in the KAPPA-
Workstation ‘Licensing’ dialog or Emeraude ‘Licenses’ tab. You will be able to add this port in the ‘Add a license’
dialog accessed when clicking on and selecting ‘FlexLM network’. Specify your server name and the required
port number in the ‘Port’ field and click on ‘Add’. Once added, select your server line and click on ‘Check’, then
‘Add all’. You can also specify an option file on the VENDOR KAPPA line as shown below.

SERVER THIS_HOST bc206c4d4c22 xxxxx

VENDOR KAPPA options=c:\flexlm\options_dir\option.txt port=xxxx
…

THIS_HOST, if contained on the SERVER line in the license file can be changed to the actual host name.

2.4. Configuring the license server

To configure the license server, use the LMTOOLS program accessed from the Windows Start
menu>Programs>KAPPA>KAPPA FlexLM Server Protection>LMTools. Upon start-up, the following screen is
displayed.

LMTOOLS Configuration mode

KAPPA FlexLM Server Protection v5.20.01 © KAPPA 1988-2019 Installation instructions - 4/8
In the Service/License File tab, verify that the ‘Configuration using Services’ option is activated.
If you encounter problems running your FlexLM server, please enable the option ‘LMTOOLS ignores license file
path environment variables’.

Select the Config Services tab as shown below.

LMTOOLS Configure Services dialog

Configure the FlexLM license server service by specifying the following parameters:

Service name: we suggest ‘Kappa License Manager’ but can be anything else.

Path to the lmgrd.exe file: use the Browse button to point to the lmgrd.exe file in the FlexLM Server
installation directory (C:\Program Files (x86)\KAPPA\FlexLM Server).

Path to the license file: use the Browse button to either point to the license file in the FlexLMLicenses folder
in the FlexLM Server installation directory (C:\Program Files (x86)\KAPPA\FlexLM Server\FlexLMLicenses) if you
have only one license file or point to the ‘FlexLMLicenses’ directory itself if you have several license files and
you would like the system to check them all.

Path to the debug log file: use the Browse button to point to the FlexLM Server installation directory, and
specify the name for a log file, typically ‘flexlm.log’.

Save the settings using the Save Service button.

Note: We recommend to check the ‘Start Server at Power Up’ and the ‘Use Services’ options. The ‘Start
Server at Power Up’ functionality allows the automatic start-up of the license server at power up. The
‘Use Services’ functionality, only available on Windows machines, will register the license server as a
service.

KAPPA FlexLM Server Protection v5.20.01 © KAPPA 1988-2019 Installation instructions - 5/8
2.5. Starting the license server
To start the server, use the Start/Stop/Reread tab.

The list of the FlexLM license services installed is displayed. Make sure your newly created ‘KAPPA License
Manager’ service is selected, and click on the Start Server button.

If required, you can select the service either in the Service/License File or in the Config Services tab.

LMTOOLS Starting the license server

If your license server does not start, please set in Services the account used for the ‘Kappa License Manager’
service to ‘Local System account’ and then start your license server using the LMTOOLS program.

KAPPA FlexLM Server Protection v5.20.01 © KAPPA 1988-2019 Installation instructions - 6/8
To verify the status of the server, use the Server Status tab to perform a status inquiry as illustrated below.

LMTOOLS Server Status

Once the license server is up and running, the next step is to configure the clients.

3. Configuring the clients

3.1. Installation of the software on the clients

Before proceeding with the protected software installation, the FlexLM administrator should provide each client
with the host name of the FlexLM server. This information is retrievable in the ‘Your Identification’ section by
running the ‘Network License Request Form’ program on the FlexLM server. Each client must then proceed
with the installation of the protected application. After indicating that the software is FlexLM network
protected, a dialog is displayed requesting the license server host name.

For further information on the installation procedure, please refer to the installation manual of the protected
applications.

3.2. Starting the protected software

The software can now be executed from the client workstation. Upon start-up of the protected software, FlexLM
will check the Flexlm server host name specified during the client installation. It will directly send a message to
the server requesting a license. Upon receipt, the FlexLM license server will search for the license file, pointed
to by its own registry key variable. If the license file contains a valid license for the requested feature, and if the
maximum number of allowed simultaneous users is not reached, it will allocate a license to the requested client.

KAPPA FlexLM Server Protection v5.20.01 © KAPPA 1988-2019 Installation instructions - 7/8
4. Management Tools and documentation
The preceding sections described the step-by-step procedure to set up your environment for FlexLM Server
protected applications. After the initial configuration, it is possible to make modifications on the client
machines through the ‘Licensing’ dialog, please refer to the online help for further details.

To modify your server configuration, you can use the LMTOOLS program. It is briefly described in the previous
section. For additional information, please refer to the ‘fnp_LicAdmin.pdf’ guide installed in the FlexLM Server
folder.

5. Sentinel HL Pro dongles

The Sentinel HL Pro dongles are driverless and do not require any driver installation. You just need to
plug in the key so it is auto-detected on your computer.

This key model will be listed as a pendrive in the Device Manager and will not be displayed in the LMTOOLS
‘System Settings’ tab as opposed to the FLEXId dongles.

If the dongle is connected but not detected, verify that it is seen in the Sentinel Admin Control Centre
(http://localhost:1947). It implies that the driver installation package «Sentinel HASP LDK – Windows GUI Run-
time installer» https://sentinelcustomer.gemalto.com/sentineldownloads/# is installed on the machine. Select
the ‘Sentinel Keys’ option at the top left of the page to see the Sentinel HL Pro key listed.

6. Troubleshooting the FLEXId dongle installation

When using a FLEXId dongle if you are unable to start your license server and if the log file reports the
error message below, it means that the FLEXId key is not recognized.

11:36:22 (KAPPA) EXITING DUE TO SIGNAL 25 Exit reason 2

11:36:27 (lmgrd) KAPPA exited with status 25 (Invalid host)

Verify in the LMTOOLS program that the FLEXId dongle is listed in the ‘System Settings’ tab. If not detected,
please make sure the haspsrm_win32.dll file is present in C:\Windows\syswow64. This file is automatically
copied to this folder by the installation setup.

Ensure also that the FLEXId driver is installed. If required you can execute with Administrator privileges the
‘haspdinst.exe’ file found by default in …\KAPPA\Flexlm Server.

KAPPA FlexLM Server Protection v5.20.01 © KAPPA 1988-2019 Installation instructions - 8/8