advertisement
FLEXNET LICENSING
END USER GUIDE
Version 10.8
Legal Notices
Copyright Notice
Copyright © 1996-2005 Macrovision Europe Ltd. and/or Macrovision Corporation . All
Rights Reserved.
The information contained herein contains confidential information and proprietary trade secrets and is the property of Macrovision Corporation. Any use, copy, publication, distribution, display, modification, or transmission of the information in whole or in part in any form or by any means without the prior express written permission of Macrovision Corporation is strictly prohibited. Except when expressly provided by Macrovision Corporation in writing, possession of this information shall not be construed to confer any license or rights under any of Macrovision Corporation’s intellectual property rights, whether by estoppel, implication, or otherwise.
ALL COPIES OF THE INFORMATION, IF ALLOWED BY MACROVISION CORPORATION,
MUST DISPLAY THIS NOTICE OF COPYRIGHT AND OWNERSHIP IN FULL.
FLEXnet Licensing incorporates software developed by others and redistributed according to
license agreement. See “Third Party License Agreements” for further details.
Trademarks
Macrovision
®
, Globetrotter
®,
SafeCast
®
, FLEXlm
®
, FLEXnet ™ , FLEXnet Publisher ™ ,
FLEXnet Manager ™ , FLEXnet Connector ™ , FLEXenabled ™ , and FLEXnet Certified ™ are registered trademarks or trademarks of Macrovision Corporation in the United States of
America and/or other countries.
All other brand and product names mentioned herein are the trademarks and registered trademarks of their respective owners.
Restricted Rights Legend
The software and documentation are "commercial items," as that term is defined at 48 C.F.R.
§2.101, consisting of "commercial computer software" and "commercial computer software documentation," as such terms are used in 48 C.F.R. §12.212 or 48 C.F.R. §227.2702, as applicable. Consistent with 48 C.F.R. §12.212 or 48 C.F.R. §227.2702-1 through 227.7202-4, as applicable, the commercial computer software and commercial computer software documentation are being licensed to U.S. government end users (A) only as commercial items and (B) with only those rights as are granted to all other end users pursuant to the terms and conditions set forth in the Macrovision Corporation standard commercial agreement for this software. Unpublished rights reserved under the copyright laws of the United States of
America.
Printed in the USA.
July 2005
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Chapter 1
Introduction and Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Chapter 2
License File Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Chapter 3 Managing Licenses from Multiple Vendors . . . . . . . . . . . . . . . . . . . . . . . . 29
FLEXnet Licensing End User Guide
iii
Chapter 4
Selecting License Server Machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Chapter 5
The Options File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
iv
FLEXnet Licensing End User Guide
Chapter 6
The License Server Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Chapter 7
License Administration Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
FLEXnet Licensing End User Guide
v
Chapter 8
Mobile Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Appendix A Hostids for FLEXnet Licensing-Supported Platforms . . . . . . . . . . . . . . . .101
Appendix B License File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105
Appendix C Troubleshooting Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .121
Appendix D FLEXnet Licensing Environment Variables . . . . . . . . . . . . . . . . . . . . . . . .125
vi
FLEXnet Licensing End User Guide
Appendix E FLEXnet Licensing Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Appendix F The Report Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139
Appendix GThe Debug Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141
Appendix HIPv6 Support in FLEXnet Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
Appendix I FLEXnet Licensing Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161
FLEXnet Licensing End User Guide
vii
viii
FLEXnet Licensing End User Guide
Preface
Welcome to FLEXnet Licensing, the de facto standard network licensing system used by over
2000 leading software vendors to control the use of their software products. FLEXnet Licensing is a part of FLEXnet Publisher. If you are a system administrator or end user, chances are one or more of the products currently on your network is FLEXenabled.
About This Manual
This manual explains FLEXnet Licensing for administrators and end users and describes how to use the tools which are part of the standard FLEXnet Licensing distribution kit from your vendor.
Keep in mind that certain topics (such as password encryption) are vendor-specific and proprietary so they are not documented in any detail. Also, because FLEXnet Licensing does not enforce a particular licensing strategy, each vendor’s implementation has subtle differences.
If you do not find out what you need to know here, contact your vendor’s technical support group.
Versions of FLEXnet Licensing
This manual covers features of interest to license administrators and end users of FLEXnet
Licensing v10.8 and FLEXlm versions 5.0 through 9.3. The text presents FLEXnet Licensing v10.8 behavior and functionality. Differing behavior and functionality, if any, between the current and past versions for a particular feature is noted at the end of the its section.
Additionally,
Appendix I, “FLEXnet Licensing Versions,”
covers version differences in detail.
Related Documents from Macrovision
The FLEXnet Licensing Programming and Reference Guide is for programmers responsible for incorporating FLEXnet Licensing into their products.
FLEXnet Licensing End User Guide ix
Typographic Conventions
Typographic Conventions
The following typographic conventions are used in this manual:
• The first time a new term is used it is presented in italics.
• Commands and path, file, and environment variable names are presented in a fixed_font .
• Other variable names are in an italic_fixed_font .
• API function calls are in a sans-serif font.
x FLEXnet Licensing End User Guide
Chapter 1
Introduction and Overview
1
This chapter explains the basics of floating (network) licensing and gives a quick overview of the FLEXnet Licensing components. It explains where license administrators have control and
where end users have control. “Getting Started Checklist”
tells both license administrators and end users how to start managing FLEXnet Licensing.
Introduction to FLEXnet Licensing
FLEXnet Licensing is a member of the FLEXnet Publisher family of products. It is the most popular licensing system used in the software industry. FLEXnet Licensing is best known for its ability to allow software licenses to be available (or float) anywhere on a network, instead of being tied to specific machines. Floating licensing benefits both users and license administrators. Users make more efficient use of fewer licenses by sharing them on the network. License administrators control who uses the FLEXenabled application and the
machine(s) where the licenses are available. See “Types of License Files”
for details about the different licensing models supported by FLEXnet Licensing.
How to Use This Manual
This manual is written for two different audiences:
• Administrators of FLEXnet licenses and license server systems
• End users of FLEXenabled applications
License Administrator
If you are a license administrator, read these chapters:
Chapter: Explains:
Overview of this manual.
FLEXnet Licensing basics: license server manager and vendor daemons; the license file; configuring
FLEXnet Licensing; the license request process.
FLEXnet Licensing End User Guide 11
Chapter 1 - Introduction and Overview
How to Use This Manual
Chapter: Explains:
Chapter 2, “License File Basics”
License file basics; setting the path at start-up; different types of licensing policies.
Chapter 3, “Managing Licenses from Multiple Vendors”
Using license files from multiple software vendors.
Resources required by the servers; multiple servers; quorums; redundant license server systems.
Creating and editing the options file.
Chapter 6, “The License Server
Using the license server manager, lmgrd .
Managing FLEXnet Licensing using Macrovisionsupplied utilities.
Licensing to allow working on a computer disconnected from the license server system.
In addition, refer to:
•
Appendix B, “License File Format”
•
Appendix C, “Troubleshooting Guide”
End User
If you are an end user, read these chapters:
Chapter: Explains:
Overview of this manual.
FLEXnet Licensing basics: license and vendor daemons; the license file; the license request process.
Chapter 2, “License File Basics”
License file basics; setting the path at start-up; different types of licensing policies.
Licensing to allow working on a computer disconnected from the license server system.
In addition, refer to:
•
Appendix C, “Troubleshooting Guide”
12 FLEXnet Licensing End User Guide
Chapter 1 - Introduction and Overview
FLEXnet Licensing Components
FLEXnet Licensing Components
FLEXnet Licensing components are organized based on the license model used by your software vendor. License models are classified according to their requirement for a license server system:
• Licenses are served by a license server system. This is commonly referred to as a served license model. License files supplied by your software vendor that include SERVER,
VENDOR, and optionally, USER_SERVER lines require a license server system. See
“Served Licenses” for details.
• Licenses are not served by a license server system but are available directly to the application. This is commonly referred to as an uncounted, or unserved license model. See
for details.
Served Licenses
For served licenses, there are four required FLEXnet Licensing components:
•
The FLEXenabled Application , with the FLEXnet Licensing static client library linked
into it.
•
The License Server Manager (lmgrd) .
•
The Vendor Daemon , which, along with the license server manager,
lmgrd , comprises the license server system.
•
.
In addition to these four FLEXnet Licensing components, there are three optional components:
•
Debug Log File — created and written by
lmgrd .
•
Report Log File — created and written by the vendor daemon for use by FLEXnet
Manager.
•
End-User Administration Options File — file created and maintained by the end user.
FLEXnet Licensing End User Guide 13
Chapter 1 - Introduction and Overview
FLEXnet Licensing Components
shows the relationship these FLEXnet Licensing components have to one another.
for a description of each component.
FLEXenabled
Application
Your
Application
Code
License Server System Components
TCP/IP
License Server System
FLEXnet
License Server
Manager
Debug
Log
File
Vendor Daemon
Administration
Options
File
License
File(s)
Report
Log
File
Figure 1-1: FLEXnet Served License Component Model
Typically, the license server system components reside on a machine in the network but can optionally reside on the same machine as the FLEXenabled application.
The three optional files: Debug Log, Administration Options, and Usage Log files are configured by the end user.
Unserved Licenses
License models that do not need a license server system have two FLEXnet Licensing components:
•
The FLEXenabled Application , with the FLEXnet Licensing static client library linked
into it.
•
.
14 FLEXnet Licensing End User Guide
Chapter 1 - Introduction and Overview
FLEXnet Licensing Components
Figure 1-2 shows this model. See “Component Overview”
for a description of each component.
FLEXenabled
Application
Your
Application
Code
License
File(s)
Figure 1-2: FLEXnet Unserved License Component Model
The FLEXenabled application and license certificate reside on the same machine.
Component Overview
The License Server Manager (lmgrd)
The license server manager ( lmgrd ) handles the initial contact with the FLEXenabled applications, passing the connection on to the appropriate vendor daemon. It also starts and restarts the vendor daemons.
Chapter 6, “The License Server Manager,”
contains information for configuring and starting the license server manager in your environment.
The Vendor Daemon
In FLEXnet Licensing, counted (floating) licenses are granted by processes running on the system. There is one process for each vendor who has a FLEXenabled product on the network.
This process is called the vendor daemon. The vendor daemon keeps track of how many licenses are checked out, and who has them.
FLEXenabled applications communicate with the vendor daemon, through TCP/IP network communications. The FLEXenabled application and the daemon processes (the license server
system) can run on separate machines on your network, across any size wide-area network.
Also, the format of the traffic between the FLEXenabled application and the vendor daemon is machine independent, allowing for heterogeneous networks. This means the license server system and the computer running an application can be either different hardware platforms or even different operating systems (Windows and UNIX, for example).
FLEXnet Licensing End User Guide 15
Chapter 1 - Introduction and Overview
FLEXnet Licensing Components
If the vendor daemon terminates for any reason, all users lose their licenses (though this does not mean the applications suddenly stop running). Users normally regain their license automatically when lmgrd restarts the vendor daemon, though they may exit if the vendor daemon remains unavailable. This behavior is defined by the vendor in the FLEXenabled application.
The License File
Licensing data is stored in a text file called the license file. The license file is created by the software vendor, and edited and installed by the license administrator. It contains information about the server machines and vendor daemons, and at least one line of data (called FEATURE or INCREMENT lines) for each FLEXenabled product. Each FEATURE line contains a license key or signature based on the data in that line, the hostids specified in the SERVER line(s), and other vendor-specific data. FLEXenabled applications that are licensed with a node-locked, uncounted license need only read a valid license file to run—they do not need a license server system.
Most applications have an expected location for the license file, documented by that application. Override this location by setting the environment variable LM_LICENSE_FILE to point elsewhere, or by following instructions supplied with the FLEXenabled application. If your site has software from multiple vendors with incompatible license files (due to different sets of servers), keep the data in separate files and set the LM_LICENSE_FILE variable to reference multiple files.
It is recommended that you keep a link (on UNIX), a shortcut (on Windows), or copy of the license file in the vendor’s expected license location, so that users do not need to set
LM_LICENSE_FILE to run their applications. For license files containing counted (floating) licenses, it is recommended to place a USE_SERVER line directly after the SERVER line. For details, see
Appendix B, “License File Format.” See also
Appendix D, “FLEXnet Licensing
The FLEXenabled Application
The FLEXenabled application is linked with the program module (called the FLEXnet
Licensing client library) that provides the communication with the license server system.
During execution, the FLEXenabled application communicates with the vendor daemon to request a license.
Debug Log File
The debug log file contains status and error messages useful for debugging the license server system. Some of the debug log output describes events specific to lmgrd and some of the debug log output describes events specific to each vendor daemon. See
File,” for more information about this file.
16 FLEXnet Licensing End User Guide
Chapter 1 - Introduction and Overview
FLEXnet Licensing Components
End-User Administration Options File
The end-user administration options file allows the end-user license administrator to control various operating parameters of FLEXnet Licensing that remain within the license rights granted to them by the vendor. Specifically, the license administrator can:
• Allow the use of features
• Deny the use of features
• Reserve licenses
• Restrict the number of licenses available
• Control the amount of debugging information logged about license usage
• Enable a report log file
See Chapter 5, “The Options File.” for details on how to create this file.
Report Log File
The report log file contains feature usage information and is generated by the vendor daemon.
Use Macrovision's software license administration solution, FLEXnet Manager, to gain exceptional visibility into license usage data and to create insightful reports on critical information like license availability and usage. See
Appendix F, “The Report Log File,”
details regarding this file.
FLEXnet Licensing Components Shipped by Your Vendor
This section provides a list of FLEXnet Licensing components that may be supplied to you by
your software vendor along with the FLEXenabled application. Table 1-1
provides a general list and may differ from that actually supplied. Your vendor is the definitive source for the list of FLEXnet Licensing components that are shipped.
Table 1-1: FLEXnet Licensing Components for End-User Distribution
Component Description
Windows and UNIX Common Components lmgrd.exe
lmgrd (UNIX) vendor .exe
vendor (UNIX)
Required for served license models. The license server manager and vendor daemons, where vendor is the name of your vendor.
lmutil.exe
lmutil (UNIX)
Optional component. FLEXnet Licensing utilities program. Used for license server system management and administration. Also available from www.macrovision.com
.
FLEXnet Licensing End User Guide 17
Chapter 1 - Introduction and Overview
The License Request Process
Table 1-1: FLEXnet Licensing Components for End-User Distribution
Component
FLEXidInstaller.exe
aksusbd-redhat-1.5-1.i386.rpm
aksusbd-suse-1.7-2.i386.rpm
Description
Required if vendor supports FLEXid hostids on
Windows platforms
Required if vendor supports FLEXid hostids on Red
Hat Linux version 8 and 9 platforms.
Required if vendor supports FLEXid hostids on
SuSE Linux platforms.
HDD_Linux.tar.gz
Required if vendor supports FLEXid hostids on Red
Hat Linux 7 platforms.
HDD_Unified_Installer_sit.hqx
Required if vendor supports FLEXid hostids on Mac
OS X platforms.
Additional Windows Components lmtools.exe
Optional component. Graphical user interface for
FLEXnet Licensing utilities, lmutil.exe
. Also available from www.macrovision.com
.
lmgr10.dll
Required if the FLEXenabled application is dynamically linked.This library provides the standard FLEXnet Licensing client library routines.
The License Request Process
When you run a counted FLEXenabled application, the following occurs:
1. The license module in the FLEXenabled application finds the license file, which includes the host name of the license server machine and TCP/IP port number of the license server manager, lmgrd .
2. The FLEXenabled application establishes a connection with the license server manager
( lmgrd ) and tells it what vendor daemon it needs to talk to.
3.
lmgrd determines which machine and TCP/IP port correspond to the master vendor daemon and sends that information back to the FLEXenabled application.
4. The FLEXenabled application establishes a connection with the specified vendor daemon and sends its request for a license.
5. The vendor daemon checks in its memory to see if any licenses are available and sends a grant or denial back to the FLEXenabled application.
6. The license module in the application grants or denies use of the feature, as appropriate.
18 FLEXnet Licensing End User Guide
Chapter 1 - Introduction and Overview
Configuring FLEXnet Licensing
Uncounted features (where the license count is 0) do not require a license server system, and the FLEXnet Licensing client library routines in the application grant or deny usage based solely upon the contents of the license file.
Configuring FLEXnet Licensing
Most of the parameters of FLEXnet Licensing are configurable by the license administrator.
The license administrator can set the:
• Location of the license file (though it’s recommended that a copy or link of the license remains at the location where the application expects it)
• Location of all executables
• Location of all log files
• TCP/IP port number used by the license server manager, lmgrd
In addition, the license administrator can reserve licenses for specific users, machines, or groups, and control other license-related options. Changing parameters is discussed in
Note Refer to your vendor’s documentation before attempting to change file names, locations, or contents.
Getting Started Checklist
The following sections provide a quick overview of how to set up and use licensing for
FLEXenabled products.
Installing FLEXenabled Software
As a license administrator you are responsible for setting up licensing on your system or network. This section tells you how to do that. If you are an end user of the application and you are not involved in installing it, then go to
The installation guide for your application software is the final word on installing and configuring FLEXnet Licensing. Generally, however, installing FLEXnet Licensing requires the following steps:
1. Select your license server machines and get their hostids. See Chapter 4, “Selecting License
and Appendix A, “Hostids for FLEXnet Licensing-Supported
2. Give the hostids to your software vendor and get a license file (or the data to enter in the license file) in return.
3. Consider how to manage license files from multiple vendors. See Chapter 3, “Managing
Licenses from Multiple Vendors.”
FLEXnet Licensing End User Guide 19
Chapter 1 - Introduction and Overview
Getting Started Checklist
4. Determine if an options file is desired, and if so, set it up.
5. Determine where to install the FLEXnet Licensing utility programs such as lmgrd and lmutil ( lmstat / lmdown /etc.) and install them, unless your vendor’s installation script does so for you.
6. Start lmgrd (the license server manager) manually; you may also want to set it up to start
automatically at boot time. See Chapter 6, “The License Server Manager.”
These steps are discussed briefly below.
License Server Machine and Hostids
Before running any FLEXenabled application using floating licenses, you first need to set up your license server machine (or machines). You must select which machine or machines to run your license server systems on and provide the hostids of those machines to your software vendor. For pointers on selecting your server machine, see
Chapter 4, “Selecting License Server
Get the hostid of the server machine by running FLEXnet Licensing’s lmhostid utility on that machine. If you don’t have lmhostid , get the hostid of your machine by using the appropriate
command as described in Appendix A, “Hostids for FLEXnet Licensing-Supported Platforms.”
Using the hostid of your server machines, your vendor issues a license file to you that enables the application software.
License Files and lmgrd
Once you have received a license file from your vendor, you must install it on your system and start up the license server manager, lmgrd .
• Your software vendor may have selected a default location for your license file. If not, use
any location you wish. For more details, see Chapter 2, “License File Basics.”
• To start lmgrd automatically at boot time, you have to modify your system files (UNIX)
or use LMTOOLS (Windows). For details, see “License File Format Overview.”
Administration Tools
Macrovision supplies administration tools to your software vendor. The vendor usually includes these utilities with their product. Download the latest version from www.macrovision.com
. See Chapter 7, “License Administration Tools,” for more information
about how to use the FLEXnet Licensing utilities.
Options Files
The options file controls various options such as reservations and timeouts of licenses. Most users run without an options file, but you may decide you want to use some options. For example, many administrators use an option to limit the quantity and content of logged
messages. To set up an options file, see Chapter 5, “The Options File.”
20 FLEXnet Licensing End User Guide
Chapter 1 - Introduction and Overview
Getting Started Checklist
Notes for End Users
As a user of a FLEXenabled application, you may need to know a few things to use the system effectively. The main things you need to know are:
• How to tell an application which license file to use
• How to query the system to find out who is using a license
How to Specify a License File Location
The license file determines what features are available to a FLEXenabled application. It also contains information telling the application how to connect to the license server system.
For information about the standard way of specifying the location of a license file for an
application, see Chapter 2, “License File Basics.”
Getting Information About Licenses
To find out who is using a license run lmstat
, described in Chapter 7, “License Administration
FLEXnet Licensing End User Guide 21
Chapter 1 - Introduction and Overview
Getting Started Checklist
22 FLEXnet Licensing End User Guide
Chapter 2
License File Basics
2
The license file contains information required by FLEXnet Licensing to manage licenses for a
FLEXenabled application. This information includes:
• License server system names and hostids
• Vendor names and paths to vendor daemon executables
• Feature information
In general, the license file, or a copy of it, must be accessible to every machine that runs a
FLEXenabled application, and to each machine designated as a license server machine.
Specifying Location of the License File
Software vendors often recommend a specific location for your license file. If you are running the application on multiple machines, you have these options for making your licenses available on all the machines:
• Place the license file in a partition which is available to all machines in the network that need the license file.
• Copy the license file to all of the machines where it is needed.
• Set the LM_LICENSE_FILE or VENDOR_LICENSE_FILE (where VENDOR is the vendor daemon name) environment variable to port@host , where host and port come from the
SERVER line in the license file. Alternatively, if the license file SERVER line specifies a
TCP/IP port in the default port range (27000-27009) or does not specify a port (thereby allowing the system to choose one from the default range), use the shortcut specification,
@host .
For three-server redundant server configurations, use a comma separated list of three port@host specifiers denoting the three-server redundant configuration. For example,
FLEXnet Licensing End User Guide 23
Chapter 2 - License File Basics
Specifying Location of the License File port1@host1,port2@host2,port3@host3 specifies the three-server redundant configuration composed of host1 , host2 , and host3 .
shows some examples of LM_LICENSE_FILE and VENDOR_LICENSE_FILE environment variable settings.
Table 2-1: Environment Variable Specification Examples
SERVER Line
SERVER myserver 17007ea8 40000 where:
• host = myserver
• port = 40000
SERVER myserver 17007ea8 27001 where:
• host = myserver
• port = 27001 , within the default range
SERVER myserver 17007ea8 where:
• host = myserver
• port = none specified, uses a default TCP/IP port number in the range of 27000-27009
LM_LICENSE_FILE or
VENDOR_LICENSE_FILE
Setting
40000@myserver
@myserver
@myserver
• On Windows, if the application cannot find the license file, the user is presented with a dialog that asks the user to specify the license file location, the license server system, or license fulfillment from the internet.
Since the vendor daemon keeps track of license usage, and since the license file contains encrypted data to protect it against modification, you may move and copy the license file as much as necessary.
For counted licenses, no matter which option you choose, you must first copy lmgrd and the vendor daemon to a location accessible by the FLEXenabled application.
Setting the Path with an Environment Variable
Most applications specify a location where they expect to find the license file and install it automatically. However, you can change the license file location by setting the
LM_LICENSE_FILE environment variable to a license_file_list. Wherever license_file_list is specified it can consist of the following components:
24 FLEXnet Licensing End User Guide
Chapter 2 - License File Basics
License File Format Overview
• the full path to the license file
• a directory containing one or more license files with a .lic
extension
• a port@host setting, where port and host are the TCP/IP port number and host name from the SERVER line in the license file. Alternatively, use the shortcut specification,
@host , if the license file SERVER line uses a default TCP/IP port or specifies a port in the default port range (27000-27009).
• A comma separated list of three port@host specifiers denoting a three-server redundant configuration. For example, port1@host1,port2@host2,port3@host3 specifies the three-server redundant configuration composed of host1 , host2 , and host3 .
Applications accept an environment variable (or Windows Registry) named
VENDOR_LICENSE_FILE , where VENDOR is the vendor daemon name, e.g.,
GSI_LICENSE_FILE . This environment variable’s scope is limited to just those applications from vendor VENDOR . On UNIX, the license-file list components are separated by colons; on
Windows, the components are separated by semi-colons.
With lmgrd and lmutil ( lmstat , lmdown , etc.), the -c option overrides the setting of the
LM_LICENSE_FILE environment variable.
Note Some applications do not recognize the LM_LICENSE_FILE environment variable.
FLEXenabled Java applications, in particular, do not recognize it.
See Also
•
“Managing Multiple License Files” for more information about
LM_LICENSE_FILE .
•
Appendix D, “FLEXnet Licensing Environment Variables”
FLEX NET L ICENSING V ERSION N OTES
• Default TCP/IP port number range introduced in v6.0 of lmgrd .
• License file location dialog introduced in v6.0 of the client library.
License File Format Overview
License files usually begin with a SERVER line (or three lines for three-server redundant servers) followed by one or more VENDOR lines, followed by one or more FEATURE or
INCREMENT lines. In some cases the license file requires no SERVER line and no VENDOR line.
You can modify these elements in the license file:
• Host names on the SERVER line(s)
FLEXnet Licensing End User Guide 25
Chapter 2 - License File Basics
Types of License Files
• TCP/IP port numbers on the SERVER line(s)
• Paths on the VENDOR line(s)
• Options file paths on the VENDOR line(s)
• Optional TCP/IP port numbers on the VENDOR line(s) (for firewall support only)
• USE_SERVER line
• Values in keyword=value pairs on FEATURE lines, if keyword is specified in lowercase
See Also
•
“Redundant License Server Systems”
•
“Counted vs. Uncounted Licenses”
•
Appendix B, “License File Format,”
for details on each one of these components.
FLEX
NET
L
ICENSING
V
ERSION
N
OTES
• USE_SERVER introduced in the v5.0 client library.
• VENDOR lines are known as DAEMON lines in the pre-v6.0 lmgrd and vendor daemon.
Types of License Files
License files are created by the software vendor. License files specify floating (concurrent) usage, node-locked (both counted and uncounted), or any combination of floating, counted, and uncounted.
Floating (Concurrent) Licenses
A floating license means anyone on the network can use the FLEXenabled application, up to the limit specified in the license file (also referred to as concurrent usage or network licensing).
Floating licenses have no hostids on the individual FEATURE lines. Floating licenses requires an lmgrd and a vendor daemon to be running to count the concurrent usage of the licenses.
An example of a license file that provides floating licenses is:
SERVER lulu 17007ea8
VENDOR sampled
FEATURE f1 sampled 1.00 1-jan-2005 2 SIGN= signature1
FEATURE f2 sampled 1.00 1-jan-2005 6 SIGN=signature2
FEATURE f3 sampled 1.00 1-jan-2005 1 SIGN=signature3
This license file specifies that two licenses for feature “f1,” six licenses for feature “f2,” and one license for feature “f3” are available anywhere on the network that can access the license server machine “lulu.” lmgrd uses one of the default FLEXnet Licensing TCP/IP ports.
26 FLEXnet Licensing End User Guide
Chapter 2 - License File Basics
Types of License Files
Node-Locked Licenses
Node-locking means the FLEXenabled software can only be used on one machine or a set of machines. A node-locked license has a hostid on any FEATURE line that is node-locked to a particular host. There are two types of node-locked licenses; uncounted and counted.
If the number of licenses is set to 0 (or uncounted ), then the license is uncounted and unlimited use is permitted on the specified machine. This configuration does not require an lmgrd or a vendor daemon because it is not going to count the concurrent usage of the features.
The following license file allows unlimited usage of feature “f1” on the machines with hostids of “17007ea8” and “1700ab12”:
FEATURE f1 sampled 1.000 1-jan-2005 uncounted SIGN=signature1 \
HOSTID=17007ea8
FEATURE f1 sampled 1.000 1-jan-2005 uncounted SIGN=signature2 \
HOSTID=1700ab12
Alternately, these two FEATURE lines could have been issued by your software vendor with a
hostid list:
FEATURE f1 sampled 1.000 1-jan-2005 uncounted SIGN=signature \
HOSTID="17007ea8 1700ab12"
If these were the only FEATURE lines in this license file, no lmgrd daemon is necessary and you do not need to start one.
The following license file provides three licenses for feature “f1”, locked to the machine with hostid “1300ab43.” Since the license server system and licenses are locked to the same machine, the daemons run on the same machine that runs the FLEXenabled application.
SERVER lulu 1300ab43 1700
VENDOR sampled /etc/sampled
FEATURE f1 sampled 1.00 1-jan-2005 3 SIGN=signature \
HOSTID=1300ab43
Mixed Node-Locked and Floating Licenses
Uncounted node-locked and concurrent usage licenses can be mixed in the same license file.
The following license file allows unlimited use of feature “f1” on machines “17007ea8” and
“1700ab12,” while allowing two other licenses for feature “f1” to be used anywhere else on the network:
SERVER lulu 17001234 1700
VENDOR sampled C:\flexlm\sampled.exe
FEATURE f1 sampled 1.00 1-jan-2005 uncounted SIGN=signature1 \
HOSTID= 17007ea8
FEATURE f1 sampled 1.00 1-jan-2005 uncounted SIGN=signature2 \
HOSTID= 1700ab12
FEATURE f1 sampled 1.00 1-jan-2005 2 SIGN=signature3
FLEXnet Licensing End User Guide 27
Chapter 2 - License File Basics
Types of License Files
This configuration requires an lmgrd and a vendor daemon because the concurrent usage of the two licenses on the third FEATURE line is counted.
28 FLEXnet Licensing End User Guide
Chapter 3
Managing Licenses from Multiple Vendors
3
Since more than 2500 vendors have chosen FLEXnet Licensing for their licensing management, chances are good that you have to administer FLEXnet Licensing licenses from more than one vendor.
Overview of Multiple License Management Strategies
When you are running FLEXenabled products from multiple vendors, you may need to take steps to prevent licensing conflicts during installation. There are several strategies to accomplish this, of which three are presented here:
• Multiple machines, each running one lmgrd , one vendor daemon, and using one license file.
• One license server machine running multiple lmgrd s, each of which running one vendor daemon and using one license file.
• One license server machine running one lmgrd , multiple vendor daemons each of which using its own license file. License files share a common directory.
These strategies are ordered from most to least independence among vendors. In the first option mentioned above, you have the most license server machines to monitor; in the third option you have only one server and one license file to administer. Each of these three strategies is
described in detail in the following sections. Variations are mentioned in “Additional
FLEXnet Licensing End User Guide 29
Chapter 3 - Managing Licenses from Multiple Vendors
Multiple Machines
Multiple Machines
In this scenario, each distinct vendor daemon and its associated license file or files is located on a separate server machine. Each machine serves licenses just for its vendor daemon and runs its own local copy of lmgrd
. Figure 3-1 shows this arrangement.
lmgrd
Vendor
ABC
Daemon lmgrd
Vendor
DEF
Daemon lmgrd
Vendor
XYZ
Daemon
Vendor ABC’s
License File(s)
Vendor DEF’s
License File(s)
Vendor XYZ’s
License File(s)
Server Machine1 Server Machine2...
...Server Machine n
Figure 3-1: Multiple Server System Machines
Advantages
• The license files for each vendor are independent from one another.
• Machines are maintained separately. If one machine goes down, the other machines continue to serve licenses for their vendors.
• Each server has its own debug log.
• Licensing load is distributed.
Disadvantages
• Administrative overhead is the highest.
• If one machine goes down, licensing for the vendor’s product associated with that machine is down.
Starting the License Server System
Invoke the license server manager on each machine: lmgrd -c server_machine_n_license_list
Where server_machine_n_license_list
is a license-file list as described in “Managing
Each lmgrd starts the vendor daemon referred to in its license file(s).
30 FLEXnet Licensing End User Guide
Chapter 3 - Managing Licenses from Multiple Vendors
One Machine with Multiple License Server Systems
One Machine with Multiple License Server Systems
In this model, each vendor daemon and its associated license file or files is served by its own lmgrd process, and everything is contained in one server machine.
depicts this scheme.
lmgrd
Vendor
ABC
Daemon lmgrd
Vendor
DEF
Daemon lmgrd
Vendor
XYZ
Daemon
Vendor ABC’s
License Files
Vendor DEF’s
License Files
Vendor XYZ’s
License Files
Figure 3-2: Multiple lmgrds, Multiple License Files
When maintaining separate license server systems on the same machine, keep in mind:
• If the TCP/IP port number is specified on the SERVER line, it must be different for each license server system. Use a standard text editor to change the TCP/IP port number in each license file so that they are all different. If you are running 10 license server systems or less, you can omit all port numbers and lmgrd will choose unique ones for you within the default range of 27000-27009.
• You must make sure that you are using a compatible version of lmgrd for each particular license file. This is done by using an explicit path to lmgrd . See
• The number of license server systems is limited only by the CPU memory and networking of the machine.
Advantages
• The license files for each vendor are independent from one another.
• License server systems are maintained separately. If one server goes down, the other servers continue to serve licenses for their vendors.
• Each server has its own debug log.
Disadvantages
• Administrative overhead is high.
• If the machine goes down, all licensing is disabled.
FLEXnet Licensing End User Guide 31
Chapter 3 - Managing Licenses from Multiple Vendors
One Machine with One License Server System and Multiple License Files
• Licensing load is concentrated to one machine.
Starting the License Server System
Invoke each license server system:
• For Server 1: lmgrd -c vendor_ABC_license_dir_list
• For Server 2: lmgrd -c vendor_DEF_license_dir_list
• For Server 3: lmgrd -c vendor_XYZ_license_dir_list
Where vendor_nnn_license_list
is a license-file list as described in
Each lmgrd starts the vendor daemon referred to in its license file(s).
One Machine with One License Server System and Multiple
License Files
In this scenario, one lmgrd process runs on the server machine and serves one or more vendor daemons, each with one or more license files; the license files usually are in the same directory.
The standard filename extension for license files is .lic
. The number of vendor daemons is not limited by FLEXnet Licensing.
illustrates this scenario.
Vendor
ABC
Daemon lmgrd
Vendor
DEF
Daemon
Vendor
XYZ
Daemon
Vendor ABC’s
License File: abc.lic
Vendor DEF’s
License File: def.lic
Vendor XYZ’s
License File: xyz.lic
32
Figure 3-3: One lmgrd, Multiple License Files
Advantages
• The license files can be maintained separately.
• Reduced administrative overhead.
Disadvantages
• One lmgrd serves all vendor daemons. If lmgrd goes down, all licensing is disabled.
• If the machine goes down, all licensing is disabled.
FLEXnet Licensing End User Guide
Chapter 3 - Managing Licenses from Multiple Vendors
Managing Multiple License Files
• Output from all vendor daemons goes into one common debug log unless separate debug logs are specified with DEBUGLOG in each vendor’s options file. Having one common debug log makes it harder to debug a single vendor daemon’s problem.
• Maximizes licensing load to one machine and one lmgrd process.
Starting the License Server System
Invoke the license server manager once on the server machine.
lmgrd -c common_license_directory lmgrd processes all files with the .lic
extension in common_license_directory and starts all vendor daemons referred to in those files; so, there is no need to enumerate each license file name on the lmgrd command line.
See Also
•
“Managing Multiple License Files”
•
“Capturing Debug Log Output for a Particular Vendor Daemon”
FLEX NET L ICENSING V ERSION N OTES
• Ability for one lmgrd to process multiple license files introduced in v6.0 lmgrd .
Managing Multiple License Files
You can manage multiple license files that are on the same server machine via a license-file list.
A license-file list is specified two ways:
• By using the -c option to lmgrd lmgrd -c license_file_list [other lmgrd options]
• By defining the LM_LICENSE_FILE environment variable within the scope of the lmgrd process’ environment.
Install the license files in convenient locations on the server machine and then define the license_file_list .
Wherever license_file_list is specified it consists of a list of one or more of the following components:
• the full path to the license file
• a directory containing one or more license files with a .lic
extension
• a port@host setting, where port and host are the TCP/IP port number and host name from the SERVER line in the license file. Alternatively, use the shortcut specification,
@host , if the license file SERVER line uses a default TCP/IP port or specifies a port in the default port range (27000-27009).
FLEXnet Licensing End User Guide 33
Chapter 3 - Managing Licenses from Multiple Vendors
Additional Considerations
• A comma separated list of three port@host specifiers denoting a three-server redundant configuration. For example, port1@host1,port2@host2,port3@host3 specifies the three-server redundant configuration composed of host1 , host2 , and host3 .
Note Use a colon (“ : ”) to separate the license file names on UNIX and on Windows use a semicolon
(“ ; ”).
lmgrd builds up an internal license-file list when it starts up by parsing each license-file list component in the order listed.
Some scenarios where a license-file list is used include those described in “Multiple Machines”
“One Machine with Multiple License Server Systems”
or “One Machine with One License
Server System and Multiple License Files.”
:
See Also
•
“Setting the Path with an Environment Variable”
•
“Redundancy via License-File List”
•
Appendix D, “FLEXnet Licensing Environment Variables”
Additional Considerations
Combining license files
If you have two or more products whose licenses are intended for the same machine, as specified by their SERVER lines, you may be able to combine the license files into a single license file. The license files for the models described in
“One Machine with Multiple License
“One Machine with One License Server System and Multiple License
Files” could be combined if they met certain criteria. See
“Criteria for Combining License
34 FLEXnet Licensing End User Guide
Chapter 3 - Managing Licenses from Multiple Vendors
Additional Considerations
Figure 3-4 shows one possible scenario using a combined license file.
Vendor
ABC
Daemon lmgrd
Vendor
DEF
Daemon
Vendor
XYZ
Daemon
Combined
License File
Figure 3-4: One lmgrd, One License File
Advantages
• A single license file to administer.
• Once the files are combined, there is low administrative overhead.
Disadvantage
• Careful planning must be given in combining license lines from multiple vendors into one file, initially and over time.
Starting the License Server System
Invoke the license server manager once on the server machine.
lmgrd -c combined_license_file
Criteria for Combining License Files
Your product’s license file(s) define the license server machine(s) by host name and hostid in the SERVER line(s) in the license file. License files are candidates for combining under the following conditions:
• The number of SERVER lines in each file is the same.
• The hostid field of each SERVER line in one file exactly matches the hostid field of each
SERVER line in the other file.
Some possible reasons license files may not be compatible are:
• License files are set up to run on different server machines, so hostids are different.
• One file is set up for a single server system (has only one SERVER line), the other is set up for a three-server redundant license server configuration (has multiple SERVER lines).
FLEXnet Licensing End User Guide 35
Chapter 3 - Managing Licenses from Multiple Vendors
Additional Considerations
• Hostids for the same machine use different hostid types. For example, the SERVER line in one license file uses INTERNET= for its hostid type and the other file uses the ethernet
MAC address for its hostid type.
If your license files are compatible as described above, then you have the option of combining license files as summarized in
“How to Combine License Files.” Note
that you are not required to combine compatible license files. There is no performance or system-load penalty for not combining the files.
How to Combine License Files
If your license files are compatible, use any text editor to combine them. To combine license files, read all of the compatible license files into one file, then edit out the extra SERVER lines so that only one set of SERVER lines remains. Save the resulting data, and you have your combined license file.
Figure 3-5 shows an example of combining license files.
Vendor ABC’s License File
SERVER alpha 17007ea8
VENDOR ABC
INCREMENT f1 ABC...
INCREMENT f2 ABC...
Vendor DEF’s License File
SERVER alpha 17007ea8
VENDOR DEF
INCREMENT f3 DEF...
INCREMENT f4 DEF...
Vendor XYZ’s License FIle
SERVER alpha 17007ea8
VENDOR XYZ
INCREMENT f5 XYZ...
INCREMENT f6 XYZ...
Combined License File
SERVER alpha 17007ea8
VENDOR ABC
VENDOR DEF
VENDOR XYZ
INCREMENT f1 ABC...
INCREMENT f2 ABC...
INCREMENT f3 DEF...
INCREMENT f4 DEF...
INCREMENT f5 XYZ...
INCREMENT f6 XYZ...
Vendor GHI’s License File
SERVER tao 13004dfa
VENDOR GHI
INCREMENT f5 GHI...
INCREMENT f6 GHI...
Vendor JKL’s License File
SERVER alpha INTERNET=10.10.10.*
VENDOR JKL
INCREMENT f5 GHI...
INCREMENT f6 GHI...
This license file cannot be combined with the ones above because its server is different.
This license file cannot be combined with the ones above for server “alpha” because the host id is a different type even though the server name is the same.
36 FLEXnet Licensing End User Guide
Chapter 3 - Managing Licenses from Multiple Vendors
Additional Considerations
Figure 3-5: Combining License Files
Version Component Compatibility
When one lmgrd process manages multiple vendor daemons, it may be the case that those vendor daemons do not use the same version of FLEXnet Licensing. By observing the FLEXnet
Licensing version compatibility rules described in
“Version Compatibility with FLEXnet
you are assured that all of your FLEXnet Licensing components are compatible.
For specific FLEXenabled applications, use either the new or the old version (of course, the vendor daemon for that application must be at least as new as the application itself).
FLEXnet Licensing End User Guide 37
Chapter 3 - Managing Licenses from Multiple Vendors
Additional Considerations
38 FLEXnet Licensing End User Guide
Chapter 4
Selecting License Server Machines
4
This chapter helps you decide which machines to use as license server machines.
Resources Used by the Server
This section discusses the resources used by the license server system. When you select a server machine, you may need to take into account the system limits on these resources. For small numbers of licenses (under about 100), most of these system limits are not a problem on any workstation.
Sockets
When using TCP/IP ports, each FLEXenabled application connected to a license server system uses one or more sockets. The number of sockets any one FLEXenabled application requires is dependant on FLEXnet Licensing implementation details; consult your vendor for this information. The number of sockets available to the license server system is defined by the perprocess system limit for file descriptors. The total number of sockets used by the license server system is slightly larger than the total number needed by the FLEXenabled applications which are served by it.
If the number of sockets required by the license server system on a single machine becomes excessive, then it’s probably good to split the license file into more than one file, onto different servers, to lighten the networking traffic (which requires the vendor to agree to issue new licenses). FLEXenabled applications then check out licenses from multiple servers using a license-file list via the LM_LICENSE_FILE environment variable.
CPU Time
For small numbers of clients, the license server systems use very little CPU time. The servers might have only a few seconds of CPU time after many days.
For a large number of clients (who are each exchanging heartbeat messages with the server), or for high checkout/checkin activity levels (hundreds per second), the amount of CPU time consumed by the server may start to become significant, although, even here, CPU usage is normally not high. In this case, you may need to ensure that the server machine you select has enough CPU cycles to spare.
FLEXnet Licensing End User Guide 39
Chapter 4 - Selecting License Server Machines
Remote Mounted Disks
Disk Space
The only output files created by the license server systems are the debug and report log files.
The report log files are used to generate accurate usage reports by FLEXnet Manager. If you have a lot of license activity, these log files grow very large. You need to consider where to put these files and how often to rotate and archive them. The license administrator has the option to suppress log file output if disk space is at a premium.
It is recommended that the log files are local files on the server machine(s) to avoid networking dependencies.
See Also
•
“Setting the Path with an Environment Variable”
•
“Starting the License Server Manager on UNIX Platforms”
•
Appendix F, “The Report Log File”
•
Appendix G, “The Debug Log File”
Memory
The FLEXnet license server system uses little memory. On SunOS, lmgrd uses approximately2 MB and the vendor daemons use approximately 2 MB each, although memory usage increases in the vendor daemon with the size of the license file, size of the options file, and the number of concurrent users.
Network Bandwidth
FLEXnet Licensing sends relatively small amounts of data across the network. Each transaction, such as a checkout or checkin, is typically satisfied with less than 1 KB of data transferred. This means that FLEXnet Licensing can be effectively run over slow networks
(such as dial-up SLIP lines) for small numbers of clients.
For a large number of FLEXenabled applications (hundreds), each of which exchange heartbeat messages with the vendor daemon, the network bandwidth used may start to become significant. In this case, run the FLEXenabled application and server on the same local area network, which may require splitting licenses between two files for two servers. Users can use a license-file list in the LM_LICENSE_FILE environment variable to have effective access to both servers.
See Also
•
“Specifying Location of the License File”
Remote Mounted Disks
Macrovision recommends that you do not use remote mounted disks when you run the license server system. In other words, it is recommended that lmgrd , the vendor daemons, the license file, and the debug and report log files are all on locally mounted disks. If any of these files is
40 FLEXnet Licensing End User Guide
Chapter 4 - Selecting License Server Machines
Redundant License Server Systems on a remote mounted disk, you double the points of failure which could lead to a temporary loss of all of your licenses. When all files are mounted locally, the licenses are available as long as the server machine is up; but when the files are on a different machine, then the loss of either the license server machine or the file server machine causes the licenses to be unavailable.
Redundant License Server Systems
If you wish to use redundant license server systems, select stable machines; in other words, do not pick machines that are frequently rebooted or shut down for one reason or another.
Redundant license server machines are any that support a license server system.
FLEXnet Licensing supports two methods of redundancy:
• via a license-file list in the LM_LICENSE_FILE environment variable
• via a set of three redundant license server systems
With LM_LICENSE_FILE list redundancy, each one of a group of license server systems serves a subset of the total licenses. The end user sets LM_LICENSE_FILE to a list of license files, where each license file refers to one of the license server systems. The application then tries each server in the list, in order, until it succeeds or gets to the end of the list.
With three-server redundancy, if any two of the three license server systems are up and running
(two out of three license server systems is referred to as a quorum), the system is functional and serves its total complement of licenses.
See Also
•
“Managing Multiple License Files.”
Redundancy via License-File List
This is best explained by example. If ten licenses are desired for both “f1” and “f2,” the vendor issues two sets of licenses with a count of 5 for each of “f1” and “f2.” The server machines
(unlike three-server redundancy) can be physically distant.
The license files look like:
License 1 for “chicago”
SERVER chicago 17007ea8 1700
VENDOR sampled /etc/mydaemon
FEATURE f1 sampled 1.000 01-jan-2005 5 26C7DD9C0186
FEATURE f2 sampled 1.000 01-jan-2005 5 8CE46C57041D
License 2 for “tokyo”
SERVER tokyo 17a07e08 1700
VENDOR sampled /etc/mydaemon
FEATURE f1 sampled 1.000 01-jan-2005 5 16BE40E1D98D
FEATURE f2 sampled 1.000 01-jan-2005 5 6DB6F3E402DF
FLEXnet Licensing End User Guide 41
Chapter 4 - Selecting License Server Machines
Redundant License Server Systems
The user in Chicago could set LM_LICENSE_FILE to:
1700@chicago:1700@tokyo
The user in Tokyo could set LM_LICENSE_FILE to:
1700@tokyo:1700@chicago
Remember to separate the license file names with a colon (“ : ”) on UNIX and with a semicolon
(“ ; ”) on Windows. The application attempts the first server in the list, and if that fails for any reason, the second server is tried.
Three-Server Redundancy
The machines that comprise a three-server redundant configuration are required to have excellent communications. This form of redundancy requires that the servers exchange heartbeats periodically, and poor communications can cause poor performance. Avoid configuring redundant servers with slow communications or dial-up links.
Three-server redundancy is designed to provide hardware fail-over protection only and does not provide load-balancing. Use LM_LICENSE_FILE list, instead, if load-balancing is desired. This is because with three-server redundancy, only one of the three servers is “master,” capable of issuing licenses. Since all clients must contact the “master,” all clients must have reliable networking to a single machine. For more details, see
Comparing Three-Server to License-File List
Are there any drawbacks to using the license-file list for redundancy?
Yes. By default, once a FLEXenabled application has successfully checked out a license from a given license server system, all subsequent license requests from the same application must be satisfied from the same server system. In the event that the application makes subsequent license requests and no more licenses are available from that server system, the license request is denied even though licenses may exist on another server. An application can bypass this restriction if it is coded with the use of multiple FLEXnet license jobs. Only your publisher knows if their application is programmed in this manner.
If the application supports license queueing, all licenses are queued only from the first license server system on the list rather than the request moving to another server on the list.
Finally, if one server becomes unavailable, some licenses are unavailable.
When is it recommended to use a license-file list for redundancy rather than three-server redundant servers?
• When there’s less system administration available to monitor license server systems.
• When load-balancing is needed for FLEXenabled applications located far apart, e.g.,
London and Tokyo, make servers available locally, with remote servers available as backup.
42 FLEXnet Licensing End User Guide
Chapter 4 - Selecting License Server Machines
Counted vs. Uncounted Licenses
• License-file list is more forgiving if you lose quorum.
• License-file list is not limited to three servers (any number work).
• Clients do not require reliable networking to a single machine with license-file list, so this is recommended where networking itself requires redundancy.
Counted vs. Uncounted Licenses
The license file determines whether a license server system is needed. If all the FEATURE (or
INCREMENT) lines have a license count of 0 (unlimited) or “uncounted”, then no server is needed. This type of license is called uncounted. Alternatively, if any FEATURE lines have a non-zero license count, then a server is required to count those licenses. If a vendor wants to use FLEXnet Licensing without a server, they must issue uncounted licenses.
The license server system is able to serve uncounted licenses as well. This is done so that:
• transactions can be logged into the report log for all license requests, which can then be reported on by FLEXnet Manager
• options file constraints can be applied to the licenses
To have uncounted licenses served, include a SERVER line in the license file, and put the
USE_SERVER line immediately after the SERVER line. The vendor daemon serves the uncounted licenses, and the USE_SERVER line indicates to applications that requests must go to the license server system for authorization.
FLEX NET L ICENSING V ERSION N OTES
• “uncounted” keyword introduced in v6 FLEXnet Licensing client library.
FLEXnet Licensing End User Guide 43
Chapter 4 - Selecting License Server Machines
44 FLEXnet Licensing End User Guide
Chapter 5
The Options File
5
The options file allows the license administrator to control various operating parameters of
FLEXnet Licensing. Users are identified by their user name, host name, display, IP address, or
PROJECT (which is set with the LM_PROJECT environment variable).
Specifically, the license administrator can:
• Allow the use of features
• Deny the use of features
• Reserve licenses
• Restrict the number of licenses available
• Control the amount of information logged about license usage
• Enable a report log file
Options files allow you, as the license administrator, to be as secure or open with licenses as you like.
Lines in the options file are limited to 2048 characters. The “\” character is a continuation character in options file lines.
FLEX NET L ICENSING V ERSION N OTES
• PROJECT identification (set by LM_PROJECT ) in options file introduced in v7.0 vendor daemon.
Creating an Options File
To create an options file:
1. Use the appropriate options listed in
to create the options file using any text editor.
2. Locate the options file anywhere; however, it is recommended that the options file be placed in the same directory as the license file.
FLEXnet Licensing End User Guide 45
Chapter 5 - The Options File
Options File Syntax
3. Add the path to the options file in the license file as the fourth field on the VENDOR line for the application’s vendor daemon. For example:
VENDOR sampled /etc/sampled \
[options=]/sample_app/sampled/licenses/sampled.opt
enables the sampled vendor daemon to look at the specified options file.
If the path is omitted, the vendor daemon automatically looks for a file according to the following criteria:
• the name of the file is vendor.opt
, where vendor is the vendor daemon name
• it is placed it in the same directory as the license used by lmgrd , it is automatically used at server startup
FLEX NET L ICENSING V ERSION N OTES
• The default options file name, vendor.opt
, introduced in v6 vendor daemon.
Options File Syntax
Below is an overview of the options file syntax. See “Options File Examples” for examples and
additional information.
Each line of the file controls one option. Table 5-1 lists the option keywords.
Table 5-1: Option Keywords
Option Keyword
Description
Set the number of BORROW licenses that cannot be borrowed.
Writes debug log information for this vendor daemon to the specified file (v8.0+ vendor daemon).
Deny a user access to a feature.
Deny a user the ability to borrow BORROW licenses.
Deny a user access to all features served by this vendor daemon.
Sets the level of host name matching.
Define a group of users for use with any options.
46 FLEXnet Licensing End User Guide
Chapter 5 - The Options File
Options File Syntax
Table 5-1: Option Keywords (cont.)
Option Keyword
Description
Sets case sensitivity for user and host lists specified in
GROUP and HOST_GROUP keywords.
Define a group of hosts for use with any options (v4.0+).
Allow a user to use a feature.
Allow a user to borrow BORROW licenses.
Allow a user to use all features served by this vendor daemon.
Allow a user to extend the linger time for a feature beyond its checkin.
Limit usage for a particular feature/group—prioritizes usage among users.
Changes the maximum borrow period for the specified feature.
Limit overdraft usage to less than the amount specified in the license.
Turn off logging of certain items in the debug log file.
Specify that a report log file suitable for use by the
FLEXnet Manager license usage reporting tool be written.
Reserve licenses for a user or group of users/hosts.
Specify idle timeout for a feature, returning it to the free pool for use by another user.
Set timeout on all features.
FLEX NET L ICENSING V ERSION N OTES
• BORROW_LOWWATER options keyword introduced in v8.0 vendor daemon.
• EXCLUDE_BORROW options keyword introduced in v8.0 vendor daemon.
• INCLUDE_BORROW options keyword introduced in v8.0 vendor daemon.
FLEXnet Licensing End User Guide 47
Chapter 5 - The Options File
Options File Syntax
Comments
Include comments in your options file by starting each comment line with a pound sign “#.”
Feature Specification
The feature name can be modified with an optional keyword-value pair to fully qualify it. This notation is used for distinguishing a particular group of licenses when there are multiple
FEATURE lines for a single feature. The following syntax is used:
feature:keyword=value
For example: f1:VERSION=2.0
specifies the version 2.0 pool of licenses for feature “f1”.
Note A colon (:) is a valid feature name character. If colons are in your feature names, specify a group of licenses with the following alternative syntax using quotation marks and spaces:
"feature keyword=value"
The following option keywords are used as feature name modifiers to denote a specific group of licenses:
• VERSION=
• HOSTID=
• EXPDATE=
• KEY=
• SIGN=
• ISSUER=
• NOTICE=
• VENDOR_STRING= (if configured by the vendor as a pooling component)
• dist_info=
• user_info=
• asset_info=
If the USER_BASED or HOST_BASED keywords appear in a feature line, this feature specification syntax must be used to qualify the feature.
Using a package name in place of a feature name applies the option to all of the components in the package.
48 FLEXnet Licensing End User Guide
Chapter 5 - The Options File
Options File Syntax
Type Specification
The following option keywords restrict who may use licenses or where licenses may be used:
EXCLUDE, EXCLUDEALL, EXCLUDE_BORROW, INCLUDE, INCLUDEALL,
INCLUDE_BORROW, MAX, and RESERVE. These options take a type argument, which specifies whether the restriction is based on USER, HOST, DISPLAY, INTERNET, or
PROJECT:
• USER— user name of the user executing the FLEXenabled application. User names are case sensitive.
• HOST—machine host name or IP address where the application is executing. Host names are case sensitive.
The IP-address can contain wildcard characters.
• DISPLAY—display where the application is displayed
On UNIX, DISPLAY is /dev/ttyxx (which is always /dev/tty when an application is run in the background) or the X-Display name. On Windows, it is the system name or, in the case of a terminal server environment, the terminal server client name. Display names are case sensitive.
• INTERNET—IP address of the machine where the application is executing (wildcard characters can be used in the IP address)
• PROJECT— LM_PROJECT environment variable set by the user who is executing the
FLEXenabled application. Project names are case sensitive.
On Windows (without terminal server), the HOST and DISPLAY names are both set to the
Window’s system name. For licenses that allow checkouts from a terminal server (TS_OK keyword in the feature line), the USER, HOST, and DISPLAY names can be different from one another.
The types listed above take a single member. For example:
EXCLUDE coolsoft USER joe
To specify a list of users or hosts, first define the list using the GROUP or HOST_GROUP option lines, then use the GROUP or HOST_GROUP type to specify the group name. For example:
GROUP stars joe barbara susan
EXCLUDE coolsoft GROUP stars
FLEX
NET
L
ICENSING
V
ERSION
N
OTES
• IP address as a HOST specification introduced in v8 vendor daemon.
• LM_PROJECT environment variable introduced in V5 client library and vendor daemon.
• Colons in feature names introduced in v8 vendor daemon.
FLEXnet Licensing End User Guide 49
Chapter 5 - The Options File
Options File Syntax
BORROW_LOWWATER
BORROW_LOWWATER feature[:keyword=value] n
Sets the number of licenses for a BORROW feature that cannot be borrowed. feature keyword=value n
Name of feature being affected.
Feature name modifier to denote a group of licenses. See
for details.
Number of licenses that cannot be borrowed via license borrowing.
For example, if a feature “f1” has a count of 10 and borrowing is enabled in the application and on the FEATURE line:
FEATURE f1 ... 10 ... BORROW SIGN=...
the following line in the options file allows only 7 licenses to be borrowed.
BORROW_LOWWATER f1 3
DEBUGLOG
DEBUGLOG [+]debug_log_path
Specifies a location for the debug log output from the vendor daemon associated with this options file. Preceding the debug_log_path with a + character appends logging entries, otherwise the file is overwritten each time the daemon is started. Note that this affects output from only the vendor daemon associated with this options file. The debug log output of lmgrd and any other vendor daemons in the same license file is not captured in this file.
On Windows, pathnames which include spaces have to be enclosed in double quotes. If lmgrd is started as a service, the default location for the report log file is the c:\winnt\System32 folder unless a fully qualified path is specified.
See Also:
•
“Configuring the License Server Manager as a Windows Service”
•
•
Appendix G, “The Debug Log File”
FLEX NET L ICENSING V ERSION N OTES
• Debug log output restricted to that of just the vendor daemon introduced in V8 vendor daemon.
50 FLEXnet Licensing End User Guide
Chapter 5 - The Options File
Options File Syntax
EXCLUDE
EXCLUDE feature[:keyword=value] type {name | group_name}
Excludes a user or pre-defined group of users, etc., from the list of who is allowed to use the feature. EXCLUDE supersedes INCLUDE; conflicts between the EXCLUDE list and the
INCLUDE list are resolved by the EXCLUDE taking precedence.
feature keyword=value type name group_name
Name of the feature being affected.
Feature name modifier to denote a group of licenses. See
for details.
One of USER, HOST, DISPLAY, INTERNET, PROJECT,
GROUP, or HOST_GROUP. See
for details.
Name of an item of type type for which license usage is excluded.
Name of the group to exclude.
To exclude the user “hank” from the list of users able to use feature “f1”:
EXCLUDE f1 USER hank
EXCLUDE_BORROW
EXCLUDE_BORROW feature[:keyword=value] type \
{name | group_name}
Excludes a user or pre-defined group of users, etc., from the list of who is allowed to borrow licenses for this BORROW feature. EXCLUDE_BORROW supersedes
INCLUDE_BORROW; conflicts between the EXCLUDE_BORROW list and the
INCLUDE_BORROW list are resolved by the EXCLUDE_BORROW taking precedence.
feature keyword=value type name
Name of the feature being affected.
Feature name modifier to denote a group of licenses. See
for details.
One of USER, HOST, DISPLAY, INTERNET, PROJECT,
GROUP, or HOST_GROUP. See
for details.
Name of an item of type type for which license borrowing is excluded.
FLEXnet Licensing End User Guide 51
Chapter 5 - The Options File
Options File Syntax group_name Name of the group to exclude from borrowing.
To exclude the user “fred” from the list of users able to borrow feature “f1” assuming the feature has the BORROW attribute:
EXCLUDE_BORROW f1 USER fred
EXCLUDEALL
EXCLUDEALL type {name | group_name}
Excludes a user or pre-defined group of users, etc., from the list of who is allowed to use all features served by this vendor daemon.
type name group_name
One of USER, HOST, DISPLAY, INTERNET, PROJECT,
GROUP, or HOST_GROUP. See
details.
Name of an item of type type for which license usage is excluded.
Name of the group to exclude.
To exclude any user on the machine “chaos” from using all features served by this vendor daemon:
EXCLUDEALL HOST chaos
FQDN_MATCHING
FQDN_MATCHING exact | lenient
Sets the level to which host names used in HOST type-specifiers must match the host name sent by the FLEXenabled application. The application is configured to send either its host name or its fully qualified domain name (FQDN) to the vendor daemon for validation with HOST typespecifiers. Check with your vendor to determine fully qualified domain name support.
exact lenient
The host name in the HOST type specifier must match in content and format to that sent by the application. This is the default setting.
The host name sent by the application needs match to the extent supplied in the HOST type specifier or by the application, which ever is less restrictive.
Only the last FQDN_MATCHING keyword in the options file has effect; all others are ignored.
52 FLEXnet Licensing End User Guide
Chapter 5 - The Options File
Options File Syntax
shows the outcome of matching attempts between HOST type-specifiers in the options file and host names sent by the application.
Table 5-2: Host Name Matching Matrix
FQDN_MATCHING exact
FQDN_MATCHING lenient
HOST myhost
HOST myhost.abc.c
om
HOST myhost
HOST myhost.abc.c
om
Application configured for
FQDN — sends.
myhost.abc.com
no yes yes yes
Application not configured for
FQDN — sends myhost yes no yes yes
Examples
Consider the following example that demonstrates restrictive host name matching:
INCLUDE f1 HOST myhost.abc.com
FQDN_MATCHING exact
This includes myhost.abc.com
on the list of hosts able to use feature “f1.” Furthermore, the host name sent by the application must be a fully qualified domain name that matches myhost.abc.com
exactly.
In contrast, consider this example, which is less restrictive:
INCLUDE f2 HOST myhost.abc.com
FQDN_MATCHING lenient
This includes myhost.abc.com
on the list of hosts able to use feature “f2.” Host names sent such as: myhost.abc.com
or simply, myhost match; but myhost.xyz.com
, yourhost, or yourhost.abc.com
do not match.
FLEXnet Licensing End User Guide 53
Chapter 5 - The Options File
Options File Syntax
The example below is even more lenient:
INCLUDE f2 HOST myhost
FQDN_MATCHING lenient
This includes the host name, myhost, on the list of hosts for feature “f3.” Since lenient matching is specified, host names such as myhost , myhost.abc.com
, and myhost.xyz.com
match. Whereas, yourhost or yourhost.abc.com
do not match.
See Also
•
FLEX
NET
L
ICENSING
V
ERSION
N
OTES
• FQDN_MATCHING introduced in v9.3 client library and vendor daemon.
GROUP
GROUP group_name user_list
Defines a group of users for use in INCLUDE, INCLUDEALL, EXCLUDE, EXCLUDEALL, and RESERVE option lines.
group_name Name of the group being defined. Group names are case sensitive.
user_list List of user names in that group. Names are case sensitive. Set the
GROUPCASEINSENSITIVE options file keyword to turn on case insensitivity. See
To define the group “Hackers” consisting of “bob,” “howard,” and “james”:
GROUP Hackers bob howard james
Multiple GROUP lines for the same group name add all the specified users into the group.
Note USER_GROUP is an alias for GROUP.
54
GROUPCASEINSENSITIVE
GROUPCASEINSENSITIVE OFF|ON
If set to ON , user names and host names specified with the options file GROUP and
HOST_GROUP keywords, respectively, are treated as case insensitive.
By default GROUPCASEINSENSITIVE is OFF ; user names and host names are treated as case sensitive.
FLEXnet Licensing End User Guide
Chapter 5 - The Options File
Options File Syntax
HOST_GROUP
HOST_GROUP group_name host_list
Defines a group of hosts for use in INCLUDE, INCLUDEALL, EXCLUDE, EXCLUDEALL, and RESERVE option lines. Multiple HOST_GROUP lines add all the specified hosts into the group.
group_name host_list
Name of the group being defined. Host group names are case sensitive.
List of host names in that group. Names are case sensitive. Set the
GROUPCASEINSENSITIVE options file keyword to turn on case insensitivity. See
To define the host group “Pacific” consisting of “tokyo,” “seattle,” and “auckland”:
HOST_GROUP Pacific tokyo seattle auckland
Anywhere a host name can be used in an options file, an IP-address can be used instead.
INCLUDE
INCLUDE feature[:keyword=value] type {name | group_name}
Includes a user or pre-defined group of users, etc., in the list of who is allowed to use licenses for this feature. Anyone not in an INCLUDE statement is not allowed to use that feature.
EXCLUDE supersedes INCLUDE; conflicts between the EXCLUDE list and the INCLUDE list are resolved by the EXCLUDE taking precedence. feature keyword=value type name group_name
Name of the feature being affected.
Feature name modifier to denote a group of licenses. See
for details.
One of USER, HOST, DISPLAY, INTERNET, PROJECT,
GROUP, or HOST_GROUP. See
details.
Name of an item of type type for which license usage is included.
Name of the group for which license usage is included.
To include user “bob” in the list of users able to use feature “f1”:
INCLUDE f1 USER bob
FLEXnet Licensing End User Guide 55
Chapter 5 - The Options File
Options File Syntax
Note INCLUDE is required for USER_BASED or HOST_BASED features. The system administrator specifies which users are allowed to use the product, via INCLUDE, and the license limits the number of users that are INCLUDEd.
INCLUDE_BORROW
INCLUDE_BORROW feature[:keyword=value] type {name | group_name}
Includes a user or pre-defined group of users, etc., in the list of who is allowed to borrow the
BORROW feature. Anyone not in an INCLUDE_BORROW statement is not allowed to borrow licenses. EXCLUDE_BORROW supersedes INCLUDE_BORROW; conflicts between the EXCLUDE_BORROW list and the INCLUDE_BORROW list are resolved by the
EXCLUDE_BORROW taking precedence. feature keyword=value type name group_name
Name of the feature being affected.
Feature name modifier to denote a group of licenses. See
for details.
One of USER, HOST, DISPLAY, INTERNET, PROJECT,
GROUP, or HOST_GROUP. See
details.
Name of an item of type type for which license borrowing is included.
Name of the group for which license borrowing is included.
To include user “tom” in the list of users able to borrow feature “f1”:
INCLUDE_BORROW f1 USER tom
INCLUDEALL
INCLUDEALL type {name | group_name}
Includes a user or pre-defined group of users, etc. in the list of who is allowed to use all features served by this vendor daemon. Anyone not in an INCLUDEALL statement is not allowed to use these features.
type One of USER, HOST, DISPLAY, INTERNET, PROJECT,
GROUP, or HOST_GROUP. See
details.
56 FLEXnet Licensing End User Guide
name group_name
Chapter 5 - The Options File
Options File Syntax
Name of an item of type type for which license usage is included.
Name of the group to include.
To allow the user “jane” to use all features served by this vendor daemon:
INCLUDEALL USER jane
LINGER
LINGER feature[:keyword=value] seconds
A lingering license stays checked out for a specified period of time beyond its checkin or
FLEXenabled application exit, whichever comes first. This option extends the default linger time configured by the vendor in the FLEXenabled application.
Note The vendor must have enabled this feature in the FLEXenabled application for it to work.
Contact your software vendor to find out if this feature is implemented. feature Name of the feature.
keyword=value Feature name modifier to denote a group of licenses. See
seconds Number of seconds the license lingers. The vendor sets a minimum value. If you specify a value for seconds that is smaller than the vendor’s minimum, the minimum is used.
To set the linger value for feature “ f1 ” to one hour (3600 seconds):
LINGER f1 3600
The actual linger time varies somewhat since the vendor daemon checks all lingering licenses just once per minute. If, however, a new license request is made that would otherwise be denied, a check of the lingering licenses is made immediately to attempt to satisfy the new request.
MAX
MAX num_lic feature[:keyword=value] type {name | group_name}
Limits usage for a group or user.
num_lic Usage limit for this user or group.
FLEXnet Licensing End User Guide 57
Chapter 5 - The Options File
Options File Syntax feature keyword=value type name group_name
Feature this limit applies to.
Feature name modifier to denote a group of licenses. See
“Feature Specification” for details.
One of USER, HOST, DISPLAY, INTERNET, PROJECT,
GROUP, or HOST_GROUP. See “Type Specification” for
details.
Name of an item of type type for which usage is limited.
Name of the group to limit.
For example, to limit the user jan to 5 licenses for feature “ f1 ,” include the following line in the option file:
MAX 5 f1 USER jan
MAX_BORROW_HOURS
MAX_BORROW_HOURS feature[:keyword=value] num_hours
Changes the maximum period a license can be borrowed from that specified in the license certificate for feature. The new period must be less than that in the license certificate. If multiple MAX_BORROW_HOURS keywords appear in the options file, only the last one is applied to feature.
feature keyword=value num_hours
Feature this borrow period applies to. The license certificate for feature must have BORROW enabled.
Feature name modifier to denote a group of licenses. See
“Feature Specification” for details.
Number of hours in the new borrow period. This value must be less than that specified in the license certificate for feature
(the default, if not specified, is 168 hours).
MAX_OVERDRAFT
MAX_OVERDRAFT feature[:keyword=value] num_lic
Limits OVERDRAFT license usage below the OVERDRAFT allowed by the license file.
feature Feature this limit applies to.
58 FLEXnet Licensing End User Guide
keyword=value num_lic
Chapter 5 - The Options File
Options File Syntax
Feature name modifier to denote a group of licenses. See
“Feature Specification” for details.
Usage limit for this user or group.
NOLOG
NOLOG { IN | OUT | DENIED | QUEUED }
Suppresses logging the selected type of event in the debug log file.
To turn off logging of checkins:
NOLOG IN
To turn off logging of checkouts and queued requests two separate NOLOG lines are required:
NOLOG DENIED
NOLOG QUEUED
Note License administrators use this option to reduce the size of the debug log file. However, it can reduce the usefulness of the debug log in debugging license server system problems.
REPORTLOG
REPORTLOG [+]report_log_path
REPORTLOG specifies the report log file for this vendor daemon. It is recommended preceding the report_log_path with a + character to append logging entries, otherwise the file is overwritten each time the daemon is started.
On Windows, pathnames which include spaces have to be enclosed in double quotes. If lmgrd is started as a service, the default location for the report log file is the c:\winnt\System32 folder unless a fully qualified path is specified.
Note FLEXnet Manager, a separate product available from Macrovision, is used to process FLEXnet
Licensing report log files. FLEXnet Manager processes only report log files, not debug log files.
Reporting on Projects with LM_PROJECT
The FLEXnet Manager report writer reports on “projects.” A project is set up by having all users working on the same project set their LM_PROJECT environment variable (or registry on
Windows) to a string that describes the project. FLEXnet Manager groups usage by project, as defined by what LM_PROJECT was set to when the application was run.
FLEXnet Licensing End User Guide 59
Chapter 5 - The Options File
Options File Syntax
See Also
•
“Configuring the License Server Manager as a Windows Service”
•
Appendix D, “FLEXnet Licensing Environment Variables”
•
Appendix F, “The Report Log File”
RESERVE
RESERVE num_lic feature[:keyword=value] type {name | group_name}
Reserves licenses for a specific user.
num_lic feature keyword=value type name group_name
Number of license to reserve for this user or group.
Feature or package this reservation applies to.
Feature name modifier to denote a group of licenses. See
for details.
One of USER, HOST, DISPLAY, INTERNET, PROJECT,
GROUP, or HOST_GROUP. See
details.
Name of an item of type type for which license usage is reserved.
Name of group for which license usage is reserved.
To reserve one license of feature “f1” for user “mel”:
RESERVE 1 f1 USER mel
If you want to reserve a license for each of several users or groups, you must use a separate
RESERVE line for each user or group. If a package name is specified, all components that comprise the package are reserved.
Note Any licenses reserved for a user are dedicated to that user. Even when that user is not actively using the license it is unavailable to other users. However, a RESERVEd license does not cause usage to be reported by FLEXnet Manager if the license is not actually in use.
60 FLEXnet Licensing End User Guide
Chapter 5 - The Options File
How the Vendor Daemon Uses the Options File
TIMEOUT
TIMEOUT feature[:keyword=value] seconds
Sets the time after which an inactive license is freed and reclaimed by the vendor daemon.
Note The vendor must have enabled this feature in the FLEXenabled application for it to work.
Contact your software vendor to find out if this feature is implemented. feature Name of the feature.
keyword=value Feature name modifier to denote a group of licenses. See
seconds Number of seconds after which inactive license is reclaimed. The vendor sets a minimum value.If you specify a value for seconds that is smaller than the vendor’s minimum, the minimum is used.
To set the timeout for feature “f1” to one hour (3600 seconds):
TIMEOUT f1 3600
TIMEOUT checks in the licenses if the FLEXenabled application has been inactive for a period longer than the specified time period. The daemon declares a process inactive when it has not received heartbeats from it; whereas, an active FLEXenabled application sends heartbeats.
A TIMEOUT line must be present in the options file in order to take advantage of the vendorenabled timeout feature.
TIMEOUTALL
TIMEOUTALL seconds
Same as TIMEOUT, but applies to all features.
How the Vendor Daemon Uses the Options File
When the vendor daemon is started by lmgrd , the vendor daemon reads its options file. There is only one options file per vendor daemon and each vendor daemon needs its own options file.
For any changes in an options file to take effect, the vendor daemon must read its options file.
The lmreread utility causes the vendor daemon to reread its options file.
FLEXnet Licensing End User Guide 61
Chapter 5 - The Options File
Rules of Precedence in Options Files
FLEX NET L ICENSING V ERSION N OTES
• The lmreread utility enhanced in v8.0 vendor daemon so that it causes the vendor daemon to reread the options file. If you are using earlier versions, the vendor daemon must be stopped and restarted in order for the options file to be reread.
Rules of Precedence in Options Files
Rules of precedence take effect when INCLUDE and EXCLUDE statements are combined in the same options file and control access to the same features. The following define the precedence when both types of statements appear together:
• If there is only an EXCLUDE list, everyone who is not on the list is allowed to use the feature.
• If there is only an INCLUDE list, only those users on the list is allowed to use the feature.
• If neither list exists, everyone is allowed to use the feature.
• The EXCLUDE list is checked before the INCLUDE list; someone who is on both lists is not allowed to use the feature.
Once you create an INCLUDE or EXCLUDE list, everyone else is implicitly outside the group.
This feature allows you, as an administrator, the ability to control licenses without having to
explicitly list each user that you wish to allow or deny access to. In other words, there are two approaches; you either:
• Give most users access and list only the exceptions, or
• Severely limit access and list only the those users that have access privileges
Options File Examples
The following information gives some examples of options files intended to illustrate ways to effectively control access to your licenses.
Simple Options File Example
RESERVE 1 compile USER robert
RESERVE 3 compile HOST mainline
EXCLUDE compile USER lori
NOLOG QUEUED
This options file:
• Reserves one license for the feature “compile” for the user “robert.”
• Reserves three licenses for the feature “compile” for anyone on the system with the host name “mainline.”
62 FLEXnet Licensing End User Guide
Chapter 5 - The Options File
Options File Examples
• Prevents the user “lori” from using the “compile” feature on any machine on the network.
• Causes QUEUED messages to be omitted from the debug log file.
The sum total of the licenses reserved must be less than or equal to the number of licenses specified in the FEATURE line. In the example above, there must be a minimum of four licenses on the “compile” FEATURE line. If fewer licenses are available, only the first set of reservations (up to the license limit) is used.
If this data were in file /a/b/sampled/licenses/sampled.opt
, then modify the license file VENDOR line as follows:
VENDOR sampled /etc/sampled /sample_app/sampled/licenses/sampled.opt
Limiting Access for Multiple Users
Each INCLUDE, INCLUDEALL, INCLUDE_BORROW, EXCLUDE, EXCLUDEALL,
EXCLUDE_BORROW, MAX, and RESERVE line must have a single user name (or group) listed. To affect more than one user name create a GROUP. For example to exclude
“bob,” “howard,” and “james” from using the feature called “toothbrush,” create the following options file:
EXCLUDE toothbrush USER bob
EXCLUDE toothbrush USER howard
EXCLUDE toothbrush USER james
However, there is an easier way. Create a GROUP and exclude the list of users from using the feature. Like the previous example, the following options file excludes “bob,” “howard,” and
“james” from using the feature called “toothbrush”:
# First define the group "Hackers"
GROUP Hackers bob howard james
# Then exclude the group
EXCLUDE toothbrush GROUP Hackers
Now when you want to allow or deny access to any feature to that group, you have an alias list to make it simple.
Use HOST_GROUP to allow, deny, or reserve licenses for multiple hosts. For example, to exclude all users logged in on the hosts “fred” and “barney” from using a feature called “f1,” add these lines to your options file:
HOST_GROUP writers fred barney
EXCLUDE f1 HOST_GROUP writers
See Also
•
for more information about defining groups
FLEXnet Licensing End User Guide 63
Chapter 5 - The Options File
Options File Examples
EXCLUDE Example
#First Define the group "painters"
GROUP painters picasso mondrian klee
EXCLUDE spell GROUP painters
EXCLUDE spell USER bob
EXCLUDE spell INTERNET 123.123.123.*
This options file:
• Prevents the users “picasso,” “mondrian,” and “klee” from using the feature “spell” on any machine on the network.
• Prevents the user “bob” from using the feature “spell” on any machine on the network.
• Prevents any user logged into a host with an IP address in the range 123.123.123.0 through
123.123.123.255 from using the feature “spell.”
• Allows any other user, as long as they are not on the excluded IP addresses, and they are not a member of the “painters” GROUP, and they are not “bob,” to use feature “spell” (by implication).
Note that “bob” could have been added to the group “painters.” However, “painters” might be used for some other purpose in the future so the license administrator chose to handle “bob” as a special case here. In this case, the two EXCLUDE statements concatenate to create a list of four users.
INCLUDE Example
INCLUDE paint USER picasso
INCLUDE paint USER mondrian
INCLUDE paint HOST bigbrush
This options file:
• Allows the user “picasso” to use the feature “paint” on any machine on the network.
• Allows the user “mondrian” to use the feature “paint” on any machine on the network.
• Allows any user, as long as they are on the host “bigbrush,” to use feature “paint.”
• Denies access to the feature “paint” to anyone except “picasso,” “mondrian,” or anyone from the host “bigbrush” (by implication).
64 FLEXnet Licensing End User Guide
Chapter 6
The License Server Manager
6
The license server manager, lmgrd , is one of two FLEXnet Licensing components which comprise a license server system (the other being the vendor daemon). It handles the initial contact with FLEXenabled applications, passing the connection on to the appropriate vendor daemon. The purpose of the license server manager, lmgrd , is to:
• Start and maintain all the vendor daemons listed in the VENDOR lines of the license file.
• Refer application checkout (or other) requests to the correct vendor daemon.
A newer lmgrd can be used with an older vendor daemon or FLEXenabled application, but a newer vendor daemon or FLEXenabled application might not work properly with an older lmgrd . Always use the newest version of lmgrd as possible; it is available for download from www.macrovision.com
.
lmgrd Command-Line Syntax
lmgrd is the main daemon for FLEXnet Licensing. When you invoke lmgrd , it looks for a license file which contains information about vendors and features and starts those vendor daemons.
Usage is: lmgrd [-c license_file_list] [-l [+]debug_log_path]
[-2 -p] [-local] [-x lmdown] [-x lmremove] [-z ] [-v] [-help] where:
-c license_file_list
-l [+] debug_log_path
Use the specified license file(s).
Write debugging information to file debug_log_path . This option uses the letter l , not the numeral 1. Prepending debug_log_path with the
+ character appends logging entries. See
for more information on this file.
FLEXnet Licensing End User Guide 65
Chapter 6 - The License Server Manager
Starting the License Server Manager on UNIX Platforms
-2 -p
-local
-x lmdown
-x lmremove
-z
-v
Restricts usage of lmdown , lmreread , and lmremove to a FLEXnet Licensing administrator who is by default root. If there a UNIX group called “lmadmin,” then use is restricted to only members of that group. If root is not a member of this group, then root does not have permission to use any of the above utilities. If -2
-p is used when starting lmgrd , no user on Windows can shut down the license server system with lmdown .
Restricts the lmdown and lmreread commands to be run only from the same machine where lmgrd is running.
Disable the lmdown command (no user can run lmdown ). If lmdown is disabled, stop lmgrd via kill pid (UNIX) or stop the lmgrd and vendor daemon processes through the Windows Task Manager or
Windows service. On UNIX, be sure the kill command does not have a -9 argument.
Disable the lmremove command (no user can run lmremove ).
Run in foreground. The default behavior is to run in the background. If -l debug_log_path is present, then no windows are used, but if no -l argument specified, separate windows are used for lmgrd and each vendor daemon.
Displays lmgrd version number and copyright and exits.
Displays usage information and exits.
-help
Starting the License Server Manager on UNIX Platforms
If any licenses in the license file are counted (license count > 0), the license server manager, and hence the license server system, must be started before the FLEXenabled application can be used.
The license server manager, lmgrd, is started either manually on the command line or automatically at system startup. Both methods are discussed in the following sections.
66 FLEXnet Licensing End User Guide
Chapter 6 - The License Server Manager
Starting the License Server Manager on UNIX Platforms
Note Start lmgrd only on the server machine specified on the SERVER line in the license file.
If you are running three-server redundant license server systems, maintain an identical copy of the license file (as well as the lmgrd and the vendor daemons binaries) locally on each server machine rather than on a file server. If you do not do this, you lose all the advantages of having redundant servers, since the file server holding these files becomes a single point of failure.
Manually
Start lmgrd from the UNIX command line using the following syntax: lmgrd -c license_file_list -L [+]debug_log_path where
• license_file_list is one or more of the following:
- the full path to a single license file
- a directory, where all files named *.lic
in that directory are used
• debug_log_path is the full path to the debug log file
Prepending debug_log_path with the + character appends logging entries.
Start lmgrd by a user other than “root”, since processes started by root can introduce security risks. If lmgrd must be started by the root user, use the su command to run lmgrd as a nonprivileged user: su username -c "lmgrd -c license_file_list -l debug_log_path" where username is a non-privileged user. You must ensure that the vendor daemons listed in the license file have execute permissions for username . The paths to all the vendor daemons in the license file are listed on each VENDOR line.
Automatically
On UNIX, edit the appropriate boot script, which may be /etc/rc.boot
, /etc/rc.local
,
/etc/rc2.d/Sxxx , /sbin/rc2.d/Sxxxx , etc. Include commands similar to the following.
See the notes following for a full explanation.
/bin/su daniel -c 'echo starting lmgrd > \
/home/flexlm/v5.12/hp700_u9/boot.log'
/bin/nohup /bin/su daniel -c 'umask 022; \
/home/flexlm/v5.12/hp700_u9/lmgrd -c \
/home/flexlm/v5.12/hp700_u9/license.dat >> \
/home/flexlm/v5.12/hp700_u9/boot.log'
/bin/su daniel -c 'echo sleep 5 >> \
/home/flexlm/v5.12/hp700_u9/boot.log'
/bin/sleep 5
FLEXnet Licensing End User Guide 67
Chapter 6 - The License Server Manager
Starting the License Server Manager on Windows
/bin/su daniel -c 'echo lmdiag >>\
/home/flexlm/v5.12/hp700_u9/boot.log'
/bin/su daniel -c '/home/flexlm/v5.12/hp700_u9/lmdiag -n -c\
/home/flexlm/v5.12/hp700_u9/license.dat >> \
/home/flexlm/v5.12/hp700_u9/boot.log'
/bin/su daniel -c 'echo exiting >>\
/home/flexlm/v5.12/hp700_u9/boot.log'
Please note the following about how this script was written:
• All paths are specified in full, because no paths are assumed at boot time.
• Because no paths are assumed, the vendor daemon must be in the same directory as lmgrd , or the VENDOR lines in the license file must be edited to include the full path to the vendor daemon.
• The su command is used to run lmgrd as a non-root user, “daniel.” It is recommended that lmgrd not be run as “root,” since it is a security risk to run any program as “root” that does not require root permissions. lmgrd does not require root permissions.
• Daniel has a csh login, so all commands executed as “daniel” must be in csh syntax. All commands not executed as “daniel” must be in /bin/sh syntax, since that is what is used by the boot scripts.
• The use of nohup and sleep are required on some operating systems, notably HP-UX and
Digital UNIX. These are not needed on Solaris and some other operating systems, but are safe to use on all.
• lmdiag is used as a diagnostic tool to verify that the server is running and serving licenses.
Note This does not start the daemon until you reboot your license server machine.
Starting the License Server Manager on Windows
Manually from the Command Line
Start lmgrd as an application from a Windows command shell using the following syntax:
C:\flexlm> lmgrd -c license_file_list -L [+]debug_log_path where
• license_file_list is one or more of the following:
- the full path to a single license file
- a directory, where all files named *.lic
in that directory are used
• debug_log_path is the full path to the debug log file
Prepending debug_log_path with the + character appends logging entries.
68 FLEXnet Licensing End User Guide
Chapter 6 - The License Server Manager
Starting the License Server Manager on Windows
Spaces in pathnames require double quotes around the path.
On Windows, lmgrd can be installed as a service to allow it to be started and stopped through a user interface and run in the background.
Configuring the License Server Manager as a Windows Service
To configure a license server system as a service, you must have Administrator privileges:
1. Run LMTOOLS.
2. Click the Configuration using Services radio button, then click the Config Services tab.
3. In the Service Name , type the name of the service that you want to define, for example,
Myvendor License Manager.
4. In the Path to the lmgrd.exe file field, enter or browse to lmgrd.exe
for this license server system.
5. In the Path to the license file field, enter or browse to the license file for this license server system.
6. In the Path to the debug log file , enter or browse to the debug log file that this license server system writes. Prepending the debug log file name with the + character appends logging entries. The default location for the debug log file is the c:\winnt\System32 folder. To specify a different location, make sure you specify a fully qualified path.
7. To save the new Myvendor License Manager service, click the Save Service button.
Manually from LMTOOLS
A graphical user interface to the license server manager tools is provided called LMTOOLS.
Some of the functions LMTOOLS performs include:
FLEXnet Licensing End User Guide 69
Chapter 6 - The License Server Manager
Starting the License Server Manager on Windows
• starting, stopping, and configuring FLEXnet license server systems
• getting system information, including hostids
• getting server status
In order to control the operation of lmgrd from the LMTOOLS user interface, you first must
configure it as a license server manager service. Follow the procedure in “Configuring the
License Server Manager as a Windows Service”
before proceeding.
Once the license server manager service is configured, lmgrd is started by starting the service from the LMTOOLS interface:
1. Start LMTOOLS.
70
LMTOOLS appears with the Service/License File tab open.
2. Click the Configuration using Services radio button.
3. Select the service name from the list presented in the selection box. In this example, the service name is Myvendor License Manager .
FLEXnet Licensing End User Guide
4. Click the Start/Stop/Reread tab.
Chapter 6 - The License Server Manager
Starting the License Server Manager on Windows
5. Start Myvendor License Manager by clicking the Start Server button.
Myvendor License Manager license server system starts and writes its debug log output to c:\flexlm\lmgrd.dl
.
Automatically at System Start Up
In order for lmgrd, and hence the license server system, to start up automatically at system start up time, you first must configure it as a license server manager service. Follow the procedure
in “Configuring the License Server Manager as a Windows Service” before proceeding. Then
continue:
FLEXnet Licensing End User Guide 71
Chapter 6 - The License Server Manager
Starting the License Server Manager on Windows
1. With LMTOOLS started and the desired service name selected, click the Config Services tab.
Step 3 Step 2
2. Make this license server manager a Windows service: check the Use Services check box
(otherwise, it becomes a FLEXnet Licensing service).
3. Configure it to start at system startup time by checking the Start Server at Power Up check box.
From now on, when the machine is rebooted, this license server manager starts automatically as a Windows service.
72 FLEXnet Licensing End User Guide
Chapter 7
License Administration Tools
7
FLEXnet Licensing provides utilities for the license administrator to help manage the licensing activities on the network. Always use the newest version of the utilities as possible; they are available for download from www.macrovision.com
.
lists these utilities.
Table 7-1: License Administration Utilities
Utility
Description
Supports license borrowing.
Diagnoses license checkout problems.
Gracefully shuts down selected license daemons (both lmgrd and all vendor daemons) on the license server machine (or on all three machines in the case of three-server redundant servers).
Reports the hostid of a system.
Converts license files between different formats.
Moves existing report log information to a new file name and starts a new report log file with existing file name.
Allows users direct control over license file path settings.
Releases a hung license to the pool of free licenses.
Causes the license daemon to reread the license file and start any new vendor daemons.
Displays the status of a license server system.
Controls debug log location and size.
Switches the report log to a new file name.
Reports the FLEXnet Licensing version of a library or binary file.
FLEXnet Licensing End User Guide 73
Chapter 7 - License Administration Tools
Running Administration Tools
FLEX NET L ICENSING V ERSION N OTES
• The lmpath utility introduced in the v7.0 utilities.
• The lmborrow utility introduced in the v8.0 utilities.
• The lmswitch utility introduced in v8.0 vendor daemon.
• The lmswitchr utility introduced in v8.0 vendor daemon.
Running Administration Tools
All FLEXnet Licensing utilities are packaged as a single executable called lmutil . lmutil is either installed as individual commands (either by creating links to the individual command names, or making copies of lmutil as the individual command names), or as a wrapper that runs the individual command as lmutil command . For example, lmutil lmstat , or lmutil lmdown .
On Windows systems, the lmutil command form of the commands are available. There is also a graphical user interface available for these commands —see
Universal lmutil Arguments
The following are valid arguments for most lmutil utilities:
74
-c license_file_path Most lmutil utilities need to know the path to the license file. This is specified with a -c license_file_path argument, or by setting the
LM_LICENSE_FILE environment variable. Otherwise, the default location is used. The utilities also honor all
VENDOR_LICENSE_FILE environment variables. Some utilities take more than one license file path in a licensefile list separated by colons on UNIX and semi-colons on Windows.
Pathnames which include spaces have to be enclosed in double quotes.
-help Displays usage information and exits.
-v
-verbose
Displays the FLEXnet Licensing version of the utility and exits.
Displays longer description for all errors found.
FLEXnet Licensing End User Guide
Chapter 7 - License Administration Tools lmborrow
FLEX NET L ICENSING V ERSION N OTES
• VENDOR_LICENSE_FILE environment variable honored in utilities starting with v7.0 utilities.
• -verbose option introduced in v6.0 of the utilities.
lmborrow
lmborrow supports borrowing of licenses that contain the BORROW attribute. It must be run on the machine where licenses are borrowed. It is used to perform the following:
• Initiating borrowing by setting the borrow period
• Clearing the borrow period
• Determining borrow status
• Returning a borrowed license early
Initiating Borrowing
To initiate borrowing, the user sets the borrow period by running lmborrow from the command line or through LMTOOLS: lmborrow {vendor | all} enddate [time] where: vendor enddate [ time ]
The vendor daemon name that serves the licenses to be borrowed, or all specifies all vendor daemons in that license server system.
Date the license is to be returned in dd-mmm-yyyy format. time is optional and is specified in 24-hour format ( hh:mm ) in the FLEXenabled application’s local time. If time is unspecified, the checkout lasts until the end of the given end date.
For example: lmborrow sampled 20-aug-2001 13:00
This has the effect of setting LM_BORROW with the borrow period in either the registry
(Windows) or in $HOME/.flexlmborrow
(UNIX).
FLEXnet Licensing End User Guide 75
Chapter 7 - License Administration Tools lmborrow
To borrow licenses for the desired vendor, on the same day and the same machine that the user runs lmborrow , run the application(s) to check out the license(s). If you run the application(s) more than once that day, no duplicate licenses are borrowed. No licenses are borrowed if the application is run on a day different than the date borrowing is initiated.
In addition to the lmborrow utility, there are other ways to initiate borrowing:
• Using the borrowing interface in application, if provided in the application.
• Setting the LM_BORROW environment variable directly.
See “Initiating License Borrowing”
for more information on these other ways.
Clearing the Borrowed License Setting
To clear the LM_BORROW setting in the registry or $HOME/.flexlmborrow
, issue the command: lmborrow -clear
Clearing the LM_BORROW setting stops licenses from being borrowed until borrowing is initiated again. A user might run lmborrow -clear after he has borrowed licenses for features that are used offline if—before disconnecting from the network—he wants to run an application that checks out additional features, served by vendor, that are not meant to be borrowed. Clearing
LM_BORROW does not change the status for already-borrowed licenses.
Determining Borrowed License Status
To print information about borrowed features, issue the following command on the machine from which they are borrowed: lmborrow -status
The borrowing system does not have to be connected to the network to determine the status.
Returning a Borrowed License Early
To return a borrowed license early, first reconnect the borrowing system back to the network and then, from the same machine that initiated the borrowing, issue the command: lmborrow -return [-fqdn][-c license_file_list] [-c display] feature where:
-fqdn Directs lmborrow to access the borrowing system using its fully qualified host name. Use this option if the license was borrowed based on the fully qualified host name, rather than the relative distinguished name.
Use lmstat to determine the format of the host name used when the license was borrowed.
76 FLEXnet Licensing End User Guide
Chapter 7 - License Administration Tools lmborrow
-c license_file_list
-d display feature
Use the specified license file(s). In some configurations, the license file needs to be specified in order to return the license file early.
Used to specify the display from which the borrow was initiated. Required if your current display is different than what was used to initiate the borrow.
On Windows, it is the system name or, in the case of a terminal server environment, the terminal server client name. On UNIX, it is in the form /dev/ttyxx or the
X-Display name.
The name of the borrowed feature to be returned early.
Use lmborrow -status to get a list of borrowed feature names.
Returning the license early has the effect of clearing the LM_BORROW setting for the vendor daemon that serves the returned license.
If the borrowing system is not placed back on the network before attempting the early return, the license is not returned and LM_BORROW is kept intact. Additionally, an error message is issued to the end user with notification that the system needs to be connected to the network.
FLEX NET L ICENSING V ERSION N OTES
• Early borrowed-license return introduced in v8.3 utilities.
FLEXnet Licensing End User Guide 77
Chapter 7 - License Administration Tools lmdiag
lmdiag
lmdiag allows you to diagnose problems when you cannot check out a license.
Usage is: lmdiag [-c license_file_list] [-n] [feature[:keyword=value]] where:
-c license_file_list
-n feature keyword=value
Diagnose the specified file(s).
Run in non-interactive mode; lmdiag does not prompt for any input in this mode. In this mode, extended connection diagnostics are not available.
Diagnose this feature only.
If a license file contains multiple lines for a particular feature, select a particular line for lmdiag to report on. For example: lmdiag f1:HOSTID=12345678 attempts a checkout on the line with the hostid
“12345678.” keyword is one of the following:
VERSION, HOSTID, EXPDATE, KEY,
VENDOR_STRING, ISSUER
If no feature is specified, lmdiag operates on all features in the license file(s) in your list. lmdiag first prints information about the license, then attempts to check out each license. If the checkout succeeds, lmdiag indicates this. If the checkout fails, lmdiag gives you the reason for the failure. If the checkout fails because lmdiag cannot connect to the license server system, then you have the option of running “extended connection diagnostics.”
These extended diagnostics attempt to connect to each TCP/IP port on the license server machine, and detects if the port number in the license file is incorrect. lmdiag indicates each
TCP/IP port number that is listening, and if it is an lmgrd process, lmdiag indicates this as well. If lmdiag finds the vendor daemon for the feature being tested, then it indicates the correct port number for the license file to correct the problem.
See Also
•
78 FLEXnet Licensing End User Guide
Chapter 7 - License Administration Tools lmdown
lmdown
The lmdown utility allows for the graceful shutdown of selected license daemons (both lmgrd and selected vendor daemons) on all machines.
Usage is: lmdown -c license_file_list [-vendor vendor_daemon] [-q] [-all] [-force] where:
-c license_file_list
-vendor vendor_daemon
-q
-all
-force
Use the specified license file(s). Note that specifying -c license_file_list is always recommended with lmdown
Shut down only this vendor daemon. lmgrd continues running. Requires v6.0 lmdown and lmgrd .
Don’t prompt or print a header. Otherwise lmdown asks
“Are you sure? [y/n]: .”
If multiple servers are specified, automatically shuts down all of them. -q is implied with -all .
If licenses are borrowed, lmdown runs only from the machine where the license server system is running, and then only if the user adds -force .
If lmdown encounters more than one server (for example if -c specifies a directory with many
*.lic
files) and all is not specified, a choice of license server systems to shut down is presented.
Note On UNIX, do not use kill -9 to shut down license server systems. On Windows, if you must use the Task Manager to kill the FLEXnet Licensing service, be sure to end the lmgrd process first, then all the vendor daemon processes.
When shutting down a three-server redundant license server system, there is a one-minute delay before the servers shut down. lmdown shuts down all three license server systems of a set of redundant license server systems. If you need to shut down one of a set of redundant license server systems (not recommended because you are left with two points of failure), you must kill both the lmgrd and vendor daemon processes on that license server machine.
You can protect the unauthorized execution of lmdown when you start up the license server manager, lmgrd. Shutting down the servers causes users to lose their licenses.
FLEXnet Licensing End User Guide 79
Chapter 7 - License Administration Tools lmhostid
See Also
•
for details about securing access to lmdown
•
FLEX NET L ICENSING V ERSION N OTES
• all option introduced in the v7.0 lmdown utility.
• -force option introduced in the v8.0 lmdown utility.
lmhostid
The lmhostid utility returns the FLEXnet Licensing hostid of the current platform. Invoked without any arguments, lmhostid displays the default hostid type for current platform.
Otherwise, the hostid corresponding to the requested type is displayed, if supported on the current platform.
Usage is: lmhostid [-n] [type] [-utf8]
Where:
-n
type
Only the hostid, itself, is returned as a string, which is appropriate to use with HOSTID= in the license file. Header text is suppressed.
One of the following hostid types.
If not specified, the default hostid for the current platform is displayed.
See
Appendix A, “Hostids for FLEXnet Licensing-Supported Platforms,”
for a list of the default types.
Platform Dependent Hostids
-ether Ethernet address.
-string
-vsn
String id.
Volume serial number. (Windows platforms only)
-flexid
-long
Parallel or USB FLEXid dongle identification. This is applicable only for those platforms that support
FLEXid dongles. See
“FLEXnet Licensing Hostids” for
a complete list.
32-bit hostid.
80 FLEXnet Licensing End User Guide
-utf8
Chapter 7 - License Administration Tools lminstall
Platform Independent Hostids
-user
-display
-hostname
Current user name.
Current display name. On Windows, it is the system name or, in the case of a terminal server environment, the terminal server client name. On UNIX, it is in the form /dev/ttyxx or the X-Display name.
Current host name.
-internet IP address of current platform in the form
###.###.###.### .
The hostid is output as a UTF-8 encoded string rather than an ASCII string. If your hostid contains characters other than ASCII A through Z, a through z, or 0 through 9, use this option with lmhostid. To view a correct representation of the resulting hostid, use a utility, such as Notepad, that can display UTF-8 encoded strings.
The output of this command looks as follows: lmhostid - Copyright (c) 1989, 2002 Macrovision Corporation
The FLEXlm hostid of this machine is "69021c89"
See Also
•
Appendix A, “Hostids for FLEXnet Licensing-Supported Platforms.”
lminstall
Introduced in v6.0, lminstall is designed primarily for typing in decimal format licenses to generate a readable format license file.
Usage is: lminstall [-i in_lic_file ] [-maxlen n] [-e err_file] [-o out_lic_file] \
[-overfmt {2 | 3 | 4 | 5 | 5.1 | 6 | 7 | 7.1 | 8}] [-odecimal]
Normally, to convert from decimal to readable format, lminstall is used with no arguments; you are prompted for the name of the output license file. The default file name is today’s date in yyyymmdd.lic
format. Move this file to the application’s default license file directory, if specified by the software vendor. Otherwise, use the LM_LICENSE_FILE or
VENDOR_LICENSE_FILE environment variables to specify the directory where the *.lic
files are located.
To finish entering, type q on a line by itself or enter two blank lines.
FLEXnet Licensing End User Guide 81
Chapter 7 - License Administration Tools lmnewlog
When an input file is specified with no output file specified, output goes to stdout; if neither input nor output file is specified, lminstall assumes that input comes from stdin and prompts the user for an output file name. lminstall is also used to convert licenses from readable to decimal format, and between different versions of FLEXnet license formats.
To convert from readable to decimal: lminstall -i in_lic_file -o out_lic_file -odecimal
To convert to v5.1 format: lminstall -i in_lic_file -o out_lic_file -overfmt 5.1
To enforce a maximum line length of, for example, 50 characters: lminstall -maxlen 50
Conversion errors are reported as necessary and can be written to a file by specifying -e err_file . lminstall has a limit of 1000 lines of input.
lmnewlog
The lmnewlog utility switches the report log file by moving the existing report log information to a new file, then starting a new report log with the original report log file name. If you rotate report logs with lmnewlog instead of lmswitchr , you do not have to change the file name in the REPORTLOG line of the vendor’s options file. Requires a v7.1+ vendor daemon.
Usage is: lmnewlog [-c license_file_list] feature renamed_report_log or: lmnewlog [-c license_file_list] vendor renamed_report_log where:
-c license_file_list feature vendor renamed_report_log
Use the specified license file(s).
Any feature in this license file.
Vendor daemon in this license file.
New file path where existing report log information is to be moved.
82 FLEXnet Licensing End User Guide
Chapter 7 - License Administration Tools lmpath
lmpath
The lmpath utility allows direct control over FLEXnet license path settings. It is used to add to, override, or get the current license path settings.
Usage is: lmpath {-add | -override} {vendor | all} license_file_list where:
-add
-override vendor all license_file_li st
Prepends license_file_list to the current license-file list or creates the license-file list, if it doesn’t exist, initializing it to license_file_list . Duplicates are discarded.
Overrides the existing license-file list with license_file_list . If license_file_list is the null string, "" , the specified list is deleted.
• lmpath -override all ""
Deletes the value of LM_LICENSE_FILE.
• lmpath -override vendor ""
Deletes the value of VENDOR_LICENSE_FILE.
A vendor daemon name. Effects the value of
VENDOR_LICENSE_FILE.
Refers to all vendor daemons. Effects the value of
LM_LICENSE_FILE.
A colon-separated list on UNIX and a semi-colon-separated list on Windows. If license_file_list is the null string, "" , then the specified entry is deleted.
Note lmpath works by setting the FLEXnet Licensing registry entry on Windows or
$HOME/.flexlmrc
on UNIX.
To display the current license path settings, use: lmpath -status
The following is displayed: lmpath - Copyright (C) 1989-2002 Macrovision Corporation
Known Vendors:
_____________ demo: ./counted.lic:./uncounted.lic
_____________
FLEXnet Licensing End User Guide 83
Chapter 7 - License Administration Tools lmremove
Other Vendors:
______________
/usr/local/flexlm/licenses/license.lic
Note that where the path is set to a directory, all the *.lic
files are listed separately.
lmremove
The lmremove utility allows you to remove a single user’s license for a specified feature. If the application is active, it re-checks out the license shortly after it is freed by lmremove .
Usage is: lmremove [-c license_file_list] feature user user_host display or lmremove [-c license_file_list] -h feature server_host port handle where:
-c license_file_list Specify license file(s).
feature Name of the feature checked out by the user.
user user_host
Name of the user whose license you are removing, as reported by lmstat -a .
Name of the host the user is logged into, as reported by lmstat -a .
display server_host port handle
Name of the display where the user is working, as reported by lmstat -a .
Name of the host on which the license server system is running.
TCP/IP port number where the license server system is running, as reported by lmstat -a .
License handle, as reported by lmstat -a .
84
The user , user_host , display , server_host, port , and handle information must be obtained from the output of lmstat -a .
lmremove removes all instances of user on user_host and display from usage of feature . If the optional -c license_file_list is specified, the indicated file(s) is used as the license file.
FLEXnet Licensing End User Guide
Chapter 7 - License Administration Tools lmreread
The -h variation uses the server_host , port , and license handle , as reported by lmstat
-a . Consider this example lmstat -a output: joe nirvana /dev/ttyp5 (v1.000) (cloud9/7654 102), start Fri 10/29 18:40
In this example, the user is “joe,” the user host is “nirvana,” the display is “/dev/typp5,” the server host is “cloud9,” the TCP/IP port is “7654,” and the license handle is “102.”
To remove this license, issue one of the following commands: lmremove f1 joe nirvana /dev/ttyp5 or lmremove -h f1 cloud9 7654 102
When removing by handle, if licenses are grouped as duplicates, all duplicate licenses are also removed. If license lingering is set and lmremove is used to reclaim the license, lmremove starts, but does not override, the license’s linger time.
You can protect the unauthorized execution of lmremove when you start up the license server manager, lmgrd, because removing a user’s license is disruptive.
See Also
•
for details about securing access to lmremove
lmreread
The lmreread utility causes the license server manager to reread the license file and start any new vendor daemons that have been added. In addition, all currently running vendor daemons are signaled to reread the license file and their end-user options files for changes in feature licensing information or option settings. If report logging is enabled, any report log data still in the vendor daemon’s internal data buffer is flushed. lmreread recognizes changes to server machine host names, but cannot be used to change server TCP/IP port numbers.
If the optional vendor daemon name is specified, only the named daemon rereads the license file and its end-user options file (in this case, lmgrd does not reread the license file).
Usage is: lmreread [-c license_file_list] [-vendor vendor] [-all] where:
-c license_file_list
-vendor vendor
Use the specified license file(s).
Only vendor daemon vendor rereads the license file and its options file. Additionally, lmgrd restarts vendor if necessary.
FLEXnet Licensing End User Guide 85
Chapter 7 - License Administration Tools lmstat
-all If more than one lmgrd is specified, instructs all lmgrd s to reread.
Note If you use the -c license_file_list option, the license file(s) specified are read by lmreread , not by lmgrd ; lmgrd rereads the file it read originally.
You can protect the unauthorized execution of lmreread when you start up the license server manager, lmgrd.
See Also
•
for details about securing access to lmreread
FLEX NET L ICENSING V ERSION N OTES
• Ability for vendor daemon to participate in rereading of its option file introduced in v8.0 vendor daemon
lmstat
The lmstat utility helps you monitor the status of all network licensing activities, including:
• Daemons that are running
• License files
• Users of individual features
• Users of features served by a specific vendor daemon
• BORROW licenses borrowed lmstat prints information that it receives from the license server system; therefore, it does not report on unserved licenses such as uncounted licenses. To report on an uncounted license, the license must be added to a served license file and the application must be directed to use the license server system for that license file (via @host , port@host or USE_SERVER). Queued users and licenses shared due to duplicate grouping are also not returned by lmstat .
Usage is: lmstat [-a] [-c license_file_list] [-f [feature]] [-i [feature] [-s[server]
[-S [vendor]] [-t timeout_value] where:
-a Displays all information.
86 FLEXnet Licensing End User Guide
Chapter 7 - License Administration Tools lmstat
-c license_file_list
-f [feature ]
-i [
-s [ server ]
-S [
-t feature ] vendor ] timeout_value
Uses the specified license file(s).
Displays users of feature . If feature is not specified, usage information for all features is displayed.
Displays information from the
FEATURE/INCREMENT line for the specified feature , or all features if feature is not specified.
Displays status of all license files listed in
$VENDOR_LICENSE_FILE or $LM_LICENSE_FILE on server , or on all servers if server is not specified.
Lists all users of vendor ’s features.
Sets connection timeout to timeout_value . This limits the amount of time lmstat spends attempting to connect to server
.
The output of lmstat -a looks similar to:
License server system status: 27000@myhost1
License file(s) on myhost: install_dir/flexlm/v9.3/sun4_u5/counted.lic: myhost: license server system UP (MASTER) v9.3
Vendor daemon status (on myhost1): demo: UP v9.3
Feature usage info:
Users of f1: (Total of 4 licenses issued; Total of 1 license in use)
"f1" v1.0, vendor: demo floating license daniel myhost2 19.36.18.26 (v1.0) (myhost1/27000 102), start Fri
5/3 7:29 where: daniel myhost2
19.36.18.26
v1.0
myhost1 user user_host display version server_host
User name.
Host where user is running.
Display where user is running.
Version of feature.
Host where license server system is running.
FLEXnet Licensing End User Guide 87
Chapter 7 - License Administration Tools lmswitch
27000
102 port handle
TCP/IP port on server_host where license server system is running.
License handle.
start Fri 5/3 7:29 checkout_time Time that this license was checked out.
The user , user_host , display , server_host, port , and handle information is used when removing licenses with lmremove .
Note lmstat -a is a potentially expensive command. With many active users, this command generates a lot of network activity.
FLEX NET L ICENSING V ERSION N OTES
• Ability to list all active users, using the -A option, available in lmstat utility, v8.3 and earlier.
lmswitch
The lmswitch utility switches the debug log file written by a particular vendor daemon by closing the existing debug log for that vendor daemon and starting a new debug log for that vendor daemon with a new file name. It also starts a new debug log file written by that vendor daemon if one does not already exist.
Usage is: lmswitch [-c license_file_list] vendor new_debug_log where:
-c license_file_list vendor new_debug_log
Use the specified license file(s).
Vendor daemon in this license file.
Path to new debug log file.
By default, debug log output from lmgrd and all vendor daemons started by that lmgrd get written into the same debug file. lmswitch allows companies to keep separate log files for different vendors and control the size of their debug log file.
88 FLEXnet Licensing End User Guide
Chapter 7 - License Administration Tools lmswitchr
If debug log output is not already directed to a separate file for this vendor daemon, lmswitch tells the vendor daemon to start writing its debug log output to a file, new_debug_log . If this vendor daemon is already writing to its own debug log, lmswitch tells the vendor daemon to close its current debug log file and start writing its debug log output to new_debug_log .
Note The effect of lmswitch continues only until the vendor daemon is shut down or its options file is reread via lmreread . When the vendor daemon is restarted or its options file is reread, it looks for a DEBUGLOG line in the options file to determine whether or not to write its debug log output into its own file and, if so, what file to write.
See Also:
•
•
•
Appendix G, “The Debug Log File”
lmswitchr
The lmswitchr utility switches the report log file by closing the existing report log and starting a new report log with a new file name. It also starts a new report log file if one does not already exist.
Usage is: lmswitchr [-c license_file_list] feature new_report_log or with v5.0+ vendor daemon: lmswitchr [-c license_file_list] vendor new_report_log where:
-c license_file_list feature vendor new_report_log
Use the specified license file(s).
Any feature in this license file.
Vendor daemon in this license file.
Path to new report log file.
If report logging is not enabled for the vendor daemon, lmswitchr tells it to start writing its report log output to new_report_log . If report logging is already enabled for the vendor daemon, lmswitchr tells the vendor daemon to close its report log file and start writing its new report log output to new_report_log .
FLEXnet Licensing End User Guide 89
Chapter 7 - License Administration Tools lmver
Note The effect of lmswitchr continues only until the vendor daemon is shut down or its options file is reread via lmreread . When the vendor daemon is restarted or its options file is reread, it looks for a REPORTLOG line in the options file to determine whether or not to write report log output to a file and, if so, what file to write.
See Also:
•
•
•
•
Appendix F, “The Report Log File”
lmver
The lmver utility reports the FLEXnet Licensing version of a library or binary file.
Usage is: lmver filename where filename is one of the following:
• the name of an executable file built with FLEXnet Licensing
• lmgrd
• a license administration tool
• a vendor daemon
For example if you have an application called “spell,” type: lmver spell
License Administration Tools—LMTOOLS for Windows
For the 32-bit Windows platforms, a graphical user interface to the license server manager tools is provided called LMTOOLS. Always use the newest version of LMTOOLS as possible; it is available for download from www.macrovision.com
.
Some of the functions LMTOOLS performs include:
• starting, stopping, and configuring FLEXnet license server systems
• getting system information, including hostids
• getting server status
LMTOOLS has two modes in which to configure a license server system:
• Configuration using a license file
• Configuration using services
90 FLEXnet Licensing End User Guide
Chapter 7 - License Administration Tools
License Administration Tools—LMTOOLS for Windows
Configuration Using License File
Operations are performed on a particular license file. The file can be either local or remote. In this mode, you cannot start the lmgrd process, but you can do everything else. To configure this mode, perform the following:
1. Invoke LMTOOLS.
2. Click the Configuration using License File radio button.
3. Enter one or more the license file names or port@host specifications.
Configuration Using Services
Operations are performed on a service, which allows starting lmgrd processes local to the system on which LMTOOLS is running. For details on configuring services, see
“Configuring the License Server Manager as a Windows Service.”
FLEXnet Licensing End User Guide 91
Chapter 7 - License Administration Tools
License Administration Tools—LMTOOLS for Windows
92 FLEXnet Licensing End User Guide
Chapter 8
Mobile Licensing
8
End users often want to use applications on computers that do not have a continuous connection to a FLEXnet license server system. These situations include:
• Working on a laptop
• Using a computer both at work and at home
• Working from several different computers not connected to a license server system
FLEXnet Licensing supports licenses that allow one of several kinds of mobile licensing:
• Node-locked to a laptop
• Node-locked to a FLEXid (Windows only)
• Node-locked to a FLEXid with FLOAT_OK keyword (Windows only)
• License borrowing with BORROW keyword
• Node-locked to a user name
• Fulfilled from a prepaid license pool
License rehosting is the consequence of an end user wanting to move a license without using one of these methods. This means a new node-locked license file is generated by the vendor for each new client computer. Rehosting incurs administrative overhead because the vendor is involved for each move.
Node-Locked to a Laptop Computer
If a license is to be used exclusively on one laptop computer, that license is simply node-locked to an address associated with that computer. The license file resides on the laptop computer.
Node-locked to a FLEXid (Windows Only)
If a license is to be moved between different Windows machines, it is node-locked to a FLEXid
(a dongle that connects to a parallel or USB port). This license is moved between machines by installing a copy of the license file on each machine and moving the FLEXid from one machine to another. Since the license is tied to the FLEXid, only the machine with the FLEXid has use of the license.
FLEXnet Licensing End User Guide 93
Chapter 8 - Mobile Licensing
Node-Locked to a FLEXid with FLOAT_OK (Windows Only)
Node-Locked to a FLEXid with FLOAT_OK (Windows Only)
This method of license mobility has an advantage over simply using a license node-locked to a
FLEXid, because the FLEXid is attached to a license server machine and its license floats on the network. Licenses with a FLOAT_OK keyword that are node-locked to a FLEXid are supported only where both the FLEXenabled application and the license server system are running on Windows.
A vendor issues a license file with a FEATURE line node-locked to a FLEXid and containing the FLOAT_OK keyword and a FLEXid for that FEATURE line. One FEATURE line containing the FLOAT_OK keyword and one FLEXid is needed for each instance of a license that is mobile. When the FLEXid is attached to a license server machine, the license floats on the network. When the FLEXid is removed from the license server machine, the license is available only on the standalone computer.
This method supports parallel or USB FLEXids. Because it is simpler to attach multiple USB dongles to a computer, USB FLEXids may be preferable.
Initiating FLEXid with FLOAT_OK
A vendor issues the end user a FLEXid, a FLEXid driver installer, and a license file that contains a FEATURE line node-locked to that FLEXid containing the FLOAT_OK keyword.
An end user then:
1. Installs the license file on the license server machine
2. Attaches all of the FLEXids to the license server machine
3. Installs the FLEXid driver on the license server machine
4. Starts the license server system or rereads the license file
While the FLEXids are attached to the license server machine, the node-locked licenses associated with them float on the network. Each of the FLOAT_OK uncounted node-locked
FEATURE lines has a count of one while it is available on the network.
To transfer a license from the pool of floating licenses to a disconnected computer, the end user:
1. Copies the license file containing the FLOAT_OK node-locked FEATURE line from the license file on the license server machine to a license file on the client computer in the location where the FLEXenabled application expects to find its license file.
2. Moves the FLEXid matching the node-locked FEATURE line from the license server machine to the client computer. When the FLEXid is removed from the license server machine, this license is unavailable on the network.
3. Installs the FLEXid drivers on the client computer, if they are not already installed.
4. Disconnects the client computer from the network. Now the license is available on the computer with the FLEXid, even though that computer is disconnected from the network.
94 FLEXnet Licensing End User Guide
Chapter 8 - Mobile Licensing
Node-Locked to a FLEXid with FLOAT_OK (Windows Only)
Returning a FLEXid with FLOAT_OK License
To return the license to the license server machine so it floats on the network again, the end user:
1. Removes the FLEXid from the client machine and replaces it on the license server machine.
2. Rereads the license file for the license server system that serves the floating version of the license by running lmreread . When the FLEXid is returned to the license server machine, the FLOAT_OK license does not float on the network again until lmreread is run.
FLEXid with FLOAT_OK Example
The following is a sample license file issued to a end-user site. It is shipped with two FLEXids:
FLEXID=7-b28520b9
and
FLEXID=7-b2857678
.
SERVER myhost ANY
VENDOR sampled
FEATURE f1 sampled 1.0 permanent uncounted FLOAT_OK \
HOSTID=FLEXID=7-b28520b9 SIGN=123456789012
FEATURE f1 sampled 1.0 permanent uncounted FLOAT_OK \
HOSTID=FLEXID=7-b2857678 SIGN=ABCDEF123456
The end user installs the license file and the two FLEXids on the license server machine. When attached to the license server machine, each uncounted FLOAT_OK license floats on the network and allows a single use. Therefore, up to two users can use “f1” on the end user’s network, except on the license server machine itself, where the license use is disallowed.
If an end user wants to work at home, the end user installs a license file that contains the
FEATURE line node-locked to
FLEXID=7-b28520b9
(this only needs to be done once), transfers the FLEXid
FLEXID=7-b28520b9
from the license server machine to the client computer, and installs the FLEXid driver on the client computer (this also only needs to be done once). The end user disconnects the client computer from the network and uses the transferred
FLOAT_OK license on the client computer. The license server system allows only the single remaining FLOAT_OK license to float on the network.
After returning the FLEXid to the license server machine, the end user (or the system administrator) runs lmreread so the returned license can float again.
FLEX NET L ICENSING V ERSION N OTES
• FLOAT_OK keyword introduced in v8.0 client library, license server manager, and vendor daemon. All components must be v8.0+ in order to use FLOAT_OK.
FLEXnet Licensing End User Guide 95
Chapter 8 - Mobile Licensing
License Borrowing with BORROW
License Borrowing with BORROW
If a license is to be used on a computer that is intermittently connected to a license server system, that license can be issued as a floating license with the BORROW keyword. A
BORROW license can be borrowed from a license server system via a special checkout and used later to run an application on a computer that is no longer connected to the license server system. License borrowing must be enabled by a vendor before an end user can borrow licenses.
With license borrowing, a vendor issues a floating license with a FEATURE line that contains the BORROW keyword. An end user specifies the expiration date a borrowed license is to be returned and runs the application while connected to the network which writes borrowing information on the client computer. The license server system keeps the borrowed license checked out. The FLEXenabled application automatically uses the local borrowing data to do checkouts during the borrow period. If enabled by the vendor, borrowed licenses can be returned early, that is, before the borrow period expires. Upon the earlier of either the expiration of the borrow period or the early return of a borrowed license, the local borrowing data no longer authorizes checkouts and the license server system returns the borrowed license to the pool of available licenses. No clock synchronization is required between the license server machine and the machine running the FLEXenabled application.
Initiating License Borrowing
If a vendor has enabled license borrowing by issuing a license file that contains a FEATURE line with the BORROW keyword, an end user initiates license borrowing in one of three ways:
• Using the borrowing interface in application, if provided in the application
• Running the lmborrow utility to set LM_BORROW
• Setting the LM_BORROW environment variable directly
Application Interface
The user initiates license borrowing this way only if the application provides a borrowing interface. Information about this is supplied by the vendor.
Running the lmborrow Utility
lmborrow is one of the lmutil /LMTOOLS utilities. To initiate borrowing, the user runs lmborrow from the command line or through LMTOOLS: lmborrow {vendor|all} enddate [time] where vendor is the vendor daemon that serves the licenses to be borrowed, or all specifies all vendor daemons in the license server system. enddate is the date the license is to be returned in dd-mmm-yyyy format. time is optional and is specified in 24-hour format ( hh:mm ) in the FLEXenabled application’s local time. If time is unspecified, the checkout lasts until the end of the given end date.
For example: lmborrow sampled 20-aug-2001 13:00
96 FLEXnet Licensing End User Guide
Chapter 8 - Mobile Licensing
License Borrowing with BORROW
Setting the LM_BORROW Environment Variable Directly
The lmborrow utility is a user interface to set LM_BORROW in either the registry (Windows) or in $HOME/.flexlmborrow
(UNIX). LM_BORROW can also be set directly as an environment variable:
today:{vendor|all}:enddate[:time] where: today vendor enddate time
Today’s date in dd-mmm-yyyy format. Any checkouts done on this date create local borrow information. If a checkout is done on a different date than this date, no local borrowing information is created.
Vendor daemon that serves the licenses to be borrowed, or all specifies all vendor daemons in the license server system.
Date the license is to be returned in dd-mmm-yyyy format.
Optional. time is specified in 24-hour format ( hh:mm ) in the
FLEXenabled application’s local time. If time is unspecified, the checkout lasts until the end of the given end date.
For example:
LM_BORROW=15-aug-2001:sampled:20-aug-2001:13:00
In this example, one or more licenses served by the sampled vendor daemon are borrowed on
August 15, 2001, and are scheduled to be returned at 1 pm on August 20, 2001.
Borrowing a License
To borrow a license for a desired feature, on the same day and the same machine that the end user runs lmborrow or sets LM_BORROW (and while still connected to the network), the end user runs the application to check out and borrow the license. If the end user runs the application more than once that day, no duplicate license is borrowed. No license is borrowed if the application is run on a day different than the date borrowing was set to be initiated.
For example, say that today you want to borrow a license for the PageWizard feature for a week.
The PageWizard feature is served by the sampled vendor daemon. Today, while you are connected to the network, run lmborrow or set LM_BORROW directly. For example: lmborrow sampled enddate
Today, after you run lmborrow , while you are connected to the network, run the application that checks out a license for the PageWizard feature. After the license is checked out, close the application and disconnect your machine from the network. The license that you just checked
FLEXnet Licensing End User Guide 97
Chapter 8 - Mobile Licensing
License Borrowing with BORROW out stays checked out from the license server system until the borrow period expires—that license now is used on your disconnected machine until the borrow period expires. Once checked out, it remains checked out for the full borrow period. The borrow period cannot be renewed until the period has expired.
Clearing the Borrow Period
Once you have borrowed all the licenses that you need for the current borrow period (defined by the LM_BORROW environment variable), prevent licenses for any additional features from being borrowed by running lmborrow -clear . This clears the LM_BORROW setting in the registry (Windows) or $HOME/.flexlmborrow
(UNIX). lmborrow -clear does not clear the local information about licenses you have already borrowed.
Checking Borrow Status
To print information about borrowed features, issue the following command on the machine from which they are borrowed: lmborrow -status
The borrowing system does not have to be connected to the network to determine the status.
Returning a Borrowed License Early
To return a borrowed license before the borrow period expires, first reconnect the borrowing system back to the network and then, from the same machine that initiated the borrowing, issue the command: lmborrow -return [-c license_file_list] feature
This option may or may not be allowed by your vendor. Check directly with your vendor to determine if early borrowed-license return is supported.
Returning the license early has the effect of clearing the LM_BORROW setting for the vendor daemon that serves the returned license.
Support for License Borrowing
See the following sections for more information about the utilities and end-user options that support license borrowing:
•
•
•
•
•
•
98 FLEXnet Licensing End User Guide
Chapter 8 - Mobile Licensing
Node-locked to a User Name
FLEX NET L ICENSING V ERSION N OTES
• BORROW keyword introduced in v8.0 client library, license server manager, and vendor daemon. All components must be v8.0+ in order to use BORROW.
Node-locked to a User Name
If a license is to be used exclusively by one user on different machines, that license can be nodelocked to the user’s user name. The license file is copied to the different machines on which the user might work; the user’s user name must be identical on each machine. For this method to be useful, individual user names in an organization need to be unique.
Fulfilled from a Prepaid License Pool
In this method, the end user buys a prepaid number of license-days from the vendor. The end user can then fulfill a license using a partial amount of the total license-days for the given borrow period, node-locked to a particular machine. For example, in preparation for a business trip (or even during a business trip), the end user fulfills a license that expires in 5 days that is node-locked to their laptop. Each fulfillment can be node-locked to a different machine (or even multiple times to the same machine), thus allowing mobility of license usage within the prepaid number of license-days.
This model is like pay-per-use because each fulfillment is made from a decreasing number license-days. It is different than other pay-per-use models because, once node-locked to a machine, that machine is allowed unlimited use of the application until the license expires. This short-term license cannot be returned early; once fulfilled, those license-days cannot be refunded. Other pay-per-use models charge based on the number of times the application is used.
FLEXnet Licensing End User Guide 99
Chapter 8 - Mobile Licensing
Fulfilled from a Prepaid License Pool
100 FLEXnet Licensing End User Guide
Appendix A
Hostids for FLEXnet Licensing-Supported
Platforms
A
FLEXnet Licensing uses different machine identifications for different machine architectures.
For example, all Sun Microsystems machines have a unique hostid, whereas all DEC machines do not. For this reason, the ethernet address is used on some machine architectures as the hostid.
An ethernet address is a 6-byte quantity, with each byte specified as two hexadecimal digits.
Specify all twelve hex digits when using an ethernet address as a hostid. For example, if the ethernet address is “8:0:20:0:5:ac,” specify “0800200005ac” as the hostid.
Hostid Formats
Numeric, 32-bit hostids are normally used in hexadecimal format. On some systems, the system command returns the ID in decimal format. Use a “#” before the hostid to indicate a decimal number. For example, if the system command returns “2005771344,” FLEXnet Licensing accepts “#2005771344.” Alternatively, convert the decimal value to hexadecimal.
FLEXnet Licensing Hostids
The lmhostid utility prints the exact hostid that FLEXnet Licensing expects to use on any given machine. If your hostid contains characters other than ASCII A through Z, a through z, or 0 through 9, use the -utf8 option with lmhostid. To view a correct representation of the resulting hostid, use a utility, such as Notepad, that can display UTF-8 encoded strings.
The following table lists alternate methods to obtain the required hostid for each machine architecture. FLEXnet Licensing also supports a group of special hostids and vendor-defined hostids.
Hardware Platform Hostid Type this command on the license server system:
AIX (RS/6000, PPC) 32-bit hostid uname -m (returns
000276513100), then remove last two digits, and use remaining last eight digits
DEC Alpha ethernet address netstat -i
Example
02765131
080020005532
FLEXnet Licensing End User Guide 101
Appendix A - Hostids for FLEXnet Licensing-Supported Platforms
FLEXnet Licensing Hostids
Hardware Platform Hostid
HP
(32-bit and 64-bit platforms, non-
Itanium)
HP
(64-bit
Itanium machine identification
Type this command on the license server system: getconf \
CS_PARTITION_
IDENT then prefix with
“ID_STRING=”
Example
32-bit hostid uname -i and convert to hex, or prepend with #
778DA450 or
#2005771344
ID_STRING=9c766319db72-d411-af62-
0060b05e4c05
Mac OS X ethernet address
/sbin/ifconfig eth0 and remove colons from ether value
000A277EA17E
Linux
SCO
SGI
SUN
FLEXid USB port dongle lmhostid -flexid ethernet address
/sbin/ifconfig eth0 and remove colons from HWaddr
FLEXID=9-b28520b9
00400516E525
FLEXid USB port dongle lmhostid -flexid lmhostid -ether
FLEXID=9-b28520b9
Hostid String uname -x (Serial is
SCO00354), then prefix with
“ID_STRING=”
ID_STRING=SCO00354
32-bit hostid /etc/sysinfo -s , convert to hex, or prefix #
69064C3C or
#1762020412
32-bit hostid hostid 170a3472 ethernet address
00400516E525
102 FLEXnet Licensing End User Guide
Appendix A - Hostids for FLEXnet Licensing-Supported Platforms
Special FLEXnet Licensing Hostids
Hardware Platform Hostid
Windows ethernet address
Disk serial number
Type this command on the license server system: lmhostid
FLEXid parallel or
USB port dongle
Example
00B0A9DF9A32
DIR C: (look for “Volume
Serial Number is”, and remove
“-”)
DISK_SERIAL_NUM=
3e2e17fd lmhostid -flexid FLEXID=8-b28520b9
FLEXids are made available by your vendor. Your vendor can also provide you with an installer that installs drivers for all FLEXids.
For parallel FLEXids, the parallel port must be configured in bi-directional mode.
Special FLEXnet Licensing Hostids
FLEXnet Licensing contains a number of special hostid types which apply to all platforms.
These hostid types are valid to use in both SERVER lines and FEATURE lines, wherever a hostid is required. These are:
ANY
DEMO
COMPOSITE= composit_hostid
DISPLAY=display
HOSTNAME=host
FLEXnet Licensing End User Guide
Locks the software to any machine (i.e., does not lock anything).
Similar to ANY, but only for use with uncounted
FEATURE lines.
Locks the software to a composite hostid. A composite hostid is a hashed 12-character hexidecimal value formed by combining the values of one or more simple hostids types, as defined by the software vendor.
Locks the software to display display . On UNIX, display is /dev/ttyxx (which is always /dev/tty when an application is run in the background) or the X-
Display name. On Windows, it is the system name or, in the case of a terminal server environment, the terminal server client name. (v8+ FLEXenabled applications only)
Locks the software to computer host name host .
103
Appendix A - Hostids for FLEXnet Licensing-Supported Platforms
Special FLEXnet Licensing Hostids
ID=n
INTERNET=
###.###.###.###
USER= user
Functionally equivalent to the “ANY” hostid—it runs on any machine. The difference is that the license is unique and is used to identify the end user. This hostid is used to lock the license server system (on the SERVER line) or the FLEXenabled application (on the
FEATURE/INCREMENT line). The number can have dashes included for readability—the dashes are ignored.
Examples:
ID=12345678 is the same as
ID=1234-5678 is the same as
ID=1-2-3-4-5-6-7-8
Locks the software to an Internet IP address, or group of
IP addresses. Wildcards are allowed. For example,
198.156.*.* means any host with a matching internet IP address. The main use is to limit usage access by subnet, implying geographic area. For this purpose, it is used on the FEATURE/INCREMENT line as a hostid lock.
Locks the software to user name user .
Examples
FEATURE f1 demo 1.0 1-jan-2005 uncounted \
HOSTID=FLEXID=6-a6300015f SIGN=AB28E0011DA1 or
FEATURE f1 demo 1.0 1-jan-2005 uncounted \
HOSTID=INTERNET=10.10.10.* SIGN=EB78201163B0
104 FLEXnet Licensing End User Guide
Appendix B
License File Format
B
License files usually begin with a SERVER line (or three lines for three-server redundant servers) followed by one or more VENDOR lines, followed by one or more FEATURE or
INCREMENT lines. In some cases the license file requires no SERVER line and no VENDOR line.
You can modify these elements in the license file:
• Host names on the SERVER line(s)
• TCP/IP port numbers on the SERVER line(s)
• Three-server redundant configuration for a set of SERVER lines
• Paths on the VENDOR line(s)
• Options file paths on the VENDOR line(s)
• Optional TCP/IP port numbers on the VENDOR line(s) (for firewall support only)
• USE_SERVER line
• Values in keyword=value pairs on FEATURE lines, if keyword is specified in lowercase
Use the “\” line-continuation character to break up long lines.
8-bit Latin-based characters are fully supported in license files, options files, log files, and
FLEXenabled application environments.
See “Counted vs. Uncounted Licenses” for more information on SERVER and VENDOR line
requirements.
FLEX NET L ICENSING V ERSION N OTES
• USE_SERVER introduced in the v5.0 client library.
• Line-continuation character is required with the pre-v7.0 client library.
• 8-bit Latin-based character support introduced in the v8.0 client library.
FLEXnet Licensing End User Guide 105
Appendix B - License File Format
License File Syntax
License File Syntax
Sample License File
This is an example of a license file for a single vendor with two features.
SERVER my_server 17007ea8 1700
VENDOR sampled
FEATURE f1 sampled 1.000 01-jan-2005 10 SIGN=9BFAC0316462
FEATURE f2 sampled 1.000 01-jan-2005 10 SIGN=1B9A308CC0F7
The license file above allows the license server system “my_server” with the hostid “17007ea8” to serve ten floating licenses for each feature, “f1” and “f2,” to any user on the network.
SERVER Lines
The SERVER line specifies the host name and hostid of the license server system and the
TCP/IP port number of the license server manager ( lmgrd ). Normally a license file has one
SERVER line. Three SERVER lines mean that you are using a three-server redundant license server system. The absence of a SERVER line means that every FEATURE and INCREMENT line in the license file is uncounted.
The hostids from the SERVER lines are computed into the license key or signature on every
FEATURE and INCREMENT line. For this reason, make sure you keep SERVER lines together with any FEATURE/INCREMENT lines as they were sent from the vendor.
The format of the SERVER line is:
SERVER host hostid [port] [PRIMARY_IS_MASTER] [SERVER_TIMEOUT=seconds] where:
Field host hostid
Description
The system host name or IP address. String returned by the
UNIX hostname or uname -n command. On
NT/2000/XP, ipconfig /all ; on Windows 95/98/ME, winipcfg /all return the host name.
Usually the string returned by the lmhostid command.
This is changed only by your software supplier.
106 FLEXnet Licensing End User Guide
Field port
PRIMARY_IS_MASTER
SERVER_TIMEOUT= seconds
Appendix B - License File Format
License File Syntax
Description
TCP/IP port number to use. A valid number is any unused port number between 0 and 64000. On UNIX, choose a port >1024, since those <1024 are privileged port numbers.
If no TCP/IP port number is specified, one of the default ports in the range of 27000 and 27009 is used.
SERVER lines specifying servers in a three-server redundant license server system configuration require a port number to be specified; Macrovision recommends using port numbers outside the range of 27000 through
27009.
For a three-server redundant configuration, indicates how master control is transitioned between the primary and secondary servers.
• If set and the primary server goes down, the secondary server becomes the master and transitions control back to the primary server as soon as it comes back up.
• If not set and the primary server goes down, the secondary server becomes the master and remains the master even when the primary server comes back up.
If both primary and secondary go down, licenses are no longer served. In no instance does the tertiary server become the master.
This parameter is optional and is placed on the first
SERVER line in the license file. You must be running a v10.8 vendor daemon to use this parameter.
For a three-server redundant configuration, indicates how long a server waits to receive a heartbeat from another server in the configuration before shutting itself down. seconds is used in the following equation to calculate the timeout: timeout = (3 x seconds) + (seconds - 1)
If not specified, the default value for seconds is 20, equating to a timeout of 79 seconds. Valid values for seconds are 0 through 120 .
This parameter is optional and is placed on the first
SERVER line in the license file. You must be running a v10.8 vendor daemon to use this parameter.
FLEXnet Licensing End User Guide 107
Appendix B - License File Format
License File Syntax
Example:
SERVER my_server 17007ea8 21987
Three-Server Redundant Configurations
The machines that compose a three-server redundant configuration are required to have excellent communications. This form of redundancy requires that the servers exchange heartbeats periodically, and poor communications can cause poor performance. Avoid configuring redundant servers with slow communications or dial-up links.
Maintain an identical copy of the license file (as well as the lmgrd and the vendor daemons binaries) locally on each server machine rather than on a file server. If you do not do this, you lose all the advantages of having redundant servers, since the file server holding these files becomes a single point of failure.
Three-server redundant configurations are specified by including three SERVER lines in the license file. The set of three SERVER lines must appear in the same order with each line for a given server being identical across all three files. At any given moment in time, lmgrd has a notion of the master server, whose duties include:
• Serving licenses
• Recording information into the debug log
• Recording usage information into the report log
By default the primary server is the master; the method of transitioning the master server duties, in case of primary server failure, is controlled by the PRIMARY_IS_MASTER parameter.
Why are three license server systems required in a redundant configuration?
In order to provide for license server system failover, multiple redundant server systems, each running on their own machine, must be able to serve the same set of counted licenses. However, to ensure consistency and security of the software publisher’s licenses, these redundant license server systems must ensure that only one of them can serve licenses at any one time.
A given set of counted licenses is bound to the hostids of a specific number of redundant license server machines via SERVER lines in the license file. In this way, each license server system knows how to communicate with the other redundant license server systems that are bound to the same set of counted licenses. Upon startup, each server system determines whether or not it can communicate with the other redundant license server systems. A group of redundant license server systems is formed when all members of the group can each communicate with all others in that same group.
Once a group is formed, the group guarantees that only one of its license servers can serve licenses at any one time. However, FLEXnet Licensing must ensure that only one such group will be formed from the total number of redundant license servers. To ensure that there is only one group that is formed, only the group that contains greater than one half of the redundant license servers allows itself to serve licenses. This group of license servers is called the
108 FLEXnet Licensing End User Guide
Appendix B - License File Format
License File Syntax majority. License servers that are not part of the majority, including single license servers that cannot communicate with any other of its redundant license servers, refuse to serve licenses.
License servers that are not part of the majority continue to run, but only so that they can continue their attempt to join the majority or form a majority if no majority yet exists.
If a license server system ever detects that it is no longer in communication with the majority, it refuses to serve licenses until it can. If the members of the majority determine that they have lost communication with enough other license servers that they have lost the majority, they refuse to serve licenses.
If FLEXnet Licensing allowed a set of counted licenses to be bound to only two redundant license server systems, then, by the rules above, only a group that contains greater than one half of the total number of redundant license servers would allow itself to serve licenses. For a group of only two, this would mean both license servers would have to remain in constant communication and neither could fail. That is, the only number greater than one half of two is two, which is not a fail-over solution.
Because of the requirement for a majority, the obvious number of redundant license server systems to use is an odd number. Using an even number of license servers would require an extra license server to be part of the majority without adding value. For simplicity, FLEXnet
Licensing only supports three redundant license servers because three is the smallest odd number greater than one.
See Also
•
for more information about uncounted features.
•
Chapter 4, “Selecting License Server Machines,”
for more information about redundant servers.
FLEX
NET
L
ICENSING
V
ERSION
N
OTES
• IP address specification for host introduced in v5.0 lmgrd , vendor daemon, and client library.
• port specification is required with a pre-v6.0 lmgrd , vendor daemon, and client library.
• PRIMARY_IS_MASTER and SERVER_TIMEOUT introduced in v10.8 lmgrd and vendor daemon.
FLEXnet Licensing End User Guide 109
Appendix B - License File Format
License File Syntax
VENDOR Lines
The VENDOR line specifies the daemon name and path. lmgrd uses this line to start the vendor daemon, and the vendor daemon reads it to find its options file. The format of the VENDOR line is shown below.
VENDOR vendor [vendor_daemon_path]\
[[OPTIONS=]options_file_path] [[PORT=]port] where:
Field vendor vendor_daemon_ path options_file_ path port
Description
Name of the vendor daemon used to serve some feature(s) in the file. This name cannot be changed by the administrator.
Optional path to the executable for this daemon. Generally the license administrator is free to install the daemon in any directory. (It is recommended, however, that it be installed in a local directory on the license server machine.)
If omitted, lmgrd looks for the vendor daemon binary in
• the current directory
• the path specified in lmgrd’s $PATH environment variable
• in the directory where lmgrd is located
If vendor_daemon_path is blank, then any options or
TCP/IP port number specifications require the OPTIONS= and
PORT= strings.
Full path to the end-user options file for this daemon. FLEXnet
Licensing does not require an options file.
If omitted, the vendor daemon, by default, looks for a file called
vendor.opt
(where vendor is the vendor daemon name) located in the same directory as the license file.
Vendor daemon TCP/IP port number.
The default, if port is not specified, is chosen by the operating system at run-time. Sites with Internet firewalls need to specify the TCP/IP port number the daemon uses. If a TCP/IP port number is specified on the VENDOR line, there may be a delay restarting the vendor daemon.
110 FLEXnet Licensing End User Guide
Appendix B - License File Format
License File Syntax
See Also
•
Chapter 5, “The Options File,” for further information regarding options file contents.
FLEX
NET
L
ICENSING
V
ERSION
N
OTES
• vendor_daemon_path required in pre-v6.0 vendor daemon.
• options_file_path required in pre-v6.0 vendor daemon.
• VENDOR lines are known as DAEMON lines in the pre-v6.0 lmgrd and vendor daemon.
v6.0+:
VENDOR sampled pre-v6.0:
DAEMON sampled /etc/sampled \
/etc/sampled/licenses/sampled.opt
• The options= keyword introduced in the v5.0 vendor daemon.
USE_SERVER Line
USE_SERVER takes no arguments and has no impact on the server. When the application sees
USE_SERVER, it ignores everything in the license file except preceding SERVER lines and transfers checkout validation to the vendor daemon.
USE_SERVER is recommended since it improves performance when a license server system is used. For uncounted features, USE_SERVER is used to force logging of usage by the daemons.
FEATURE/INCREMENT Lines
A FEATURE line describes the license required to use a product. An INCREMENT line can be used in place of a FEATURE line, as well as to incrementally add licenses to a prior FEATURE or INCREMENT line in the license file.
Only the first FEATURE line for a given feature is processed by the vendor daemon. If you want to have additional copies of the same feature (for example, to have multiple node-locked, counted features), then you must use multiple INCREMENT lines. INCREMENT lines form license groups, or pools, based on the following fields:
• feature name
• version
• DUP_GROUP
• FLOAT_OK
FLEXnet Licensing End User Guide 111
Appendix B - License File Format
License File Syntax
• HOST_BASED
• HOSTID
• PLATFORM
• USER_BASED
• VENDOR_STRING (if configured by the vendor as a pooling component)
If two lines differ by any of these fields, a new group of licenses, called a license pool, is created in the vendor daemon, and this group is counted independently from other license pools with the same feature name. A FEATURE line does not give an additional number of licenses, whereas an INCREMENT line always gives an additional number of licenses.
The basic FEATURE/INCREMENT line format is:
{FEATURE|INCREMENT} feature vendor feat_version exp_date \
num_lic SIGN=sign [optional_attributes]
The six fields after the FEATURE/INCREMENT line keyword are required and have a fixed
order. They are defined by the vendor and cannot be changed. Table B-1 presents these fields
in the order they must appear.
Table B-1: FEATURE/INCREMENT Line Required Fields
Field feature vendor feat_version exp_date num_lic
SIGN= sign or
AUTH=...
Description
Name given to the feature by the vendor.
Name of the vendor daemon; also found in the VENDOR line.
The specified daemon serves this feature.
Version of this feature that is supported by this license.
Expiration date of license in the format dd-mmm-yyyy , e.g.,
07-may-2005. Note: If exp_date is the string “permanent” or the year is 0 (or 00, 000, 0000) then the license never expires.
Number of concurrent licenses for this feature. If the num_lic is set to the string “uncounted” or 0, the licenses for this feature are uncounted and no lmgrd is required but a hostid on the FEATURE line is required. See
SIGN= signature to authenticate this FEATURE line.
If your publisher has deployed his vendor daemon using the common vendor daemon technology, license certificate signatures are embedded within the AUTH= keyword. Contact your publisher for further details.
112 FLEXnet Licensing End User Guide
Appendix B - License File Format
License File Syntax
Table B-2 lists attributes that may appear in a FEATURE or INCREMENT line. They are
supplied at the discretion of the vendor to provide particular licensing behavior. If present in the FEATURE or INCREMENT line, they must remain there and cannot be altered by the end user. These attributes have a keyword=value syntax where keyword is in uppercase.
In places where value is a string surrounded with double quotes (“...”), the string can contain any characters except a quote.
Table B-2: Vendor Supplied Attributes
Attribute
BORROW[=n]
DUP_GROUP=...
FLOAT_OK
[ =server_hostid ]
Description
Enables license borrowing for a particular
FEATURE/INCREMENT line. n is the number of hours that the license is borrowed. The default borrow period is 168 hours, or one week.
The syntax is:
DUP_GROUP=NONE|SITE|[UHDV]
U = DUP_USER
H = DUP_HOST
D = DUP_DISPLAY
V = DUP_VENDOR_DEF
Any combination of UHDV is allowed, and the DUP_MASK is the OR of the combination. For example,
DUP_GROUP=UHD means the duplicate grouping is
(DUP_USER|DUP_HOST|DUP_DISPLAY), so for a user on the same host and display, additional uses of a feature do not consume additional licenses.
Enables mobile licensing via FLEXid with FLOAT_OK for a particular FEATURE/INCREMENT line. This
FEATURE/INCREMENT line must also be node-locked to a
FLEXid.
When
FLOAT_OK=server_hostid
is specified on a
FEATURE line:
• The server_hostid must refer to the same host that appears on the SERVER line of the license file.
• The license server system runs only on the machine with the hostid that lmhostid returns equal to the server_hostid specified with FLOAT_OK.
FLEXnet Licensing End User Guide 113
Appendix B - License File Format
License File Syntax
Table B-2: Vendor Supplied Attributes (cont.)
Attribute
HOSTID=
"hostid1
[hostid2 ...
hostidn]"
HOST_BASED[ =n ]
Description
Id of the host to which the feature line is bound. hostid is determined with the lmhostid utility. This field is required for uncounted licenses; but can be used for counted licenses as well. See
Appendix A, “Hostids for FLEXnet Licensing-
Supported Platforms,” for more information.
Host names must be specified in INCLUDE statements in the end-user options file, and the number of hosts is limited to num_lic , or the number specified in =n .
ISSUED= dd mmm yyyy Date issued.
ISSUER="..." Issuer of the license.
NOTICE="..."
OVERDRAFT=n
PLATFORMS="..."
SN= serial_num
A field for intellectual property notices.
The overdraft policy allows your vendor to specify a number of additional licenses which users are allowed to use, in addition to the licenses they have purchased. This allows your users to not be denied service when in a “temporary overdraft” state. Usage above the license limit is reported by the FLEXnet Manager reporting tool.
Usage is limited to the listed platforms.
Serial number, used to identify FEATURE or INCREMENT lines.
START= dd mmm yyyy Start date.
SUITE_DUP_GROUP=...
Similar to DUP_GROUP, but affects only the enabling
FEATURE line for a package suite. It limits the total number of users of the package to the number of licenses, and allows the package to be shared among the users that have the SUITE checked out.
SUPERSEDE=
" f1 f2 ...
"
If this appears, all licenses issued before the date specified in
ISSUED= are superseded by this line and become ineffective.
114 FLEXnet Licensing End User Guide
Appendix B - License File Format
License File Syntax
Table B-2: Vendor Supplied Attributes (cont.)
Attribute
TS_OK
USER_BASED [=n]
VENDOR_STRING=
"..."
Description
FLEXnet Licensing detects when a node-locked uncounted license is running under Windows Terminal Server. To run the application via a Terminal Server client window, TS_OK must be added to the FEATURE line. Without TS_OK , a user running on a Terminal Server client is denied a license.
Users must be specified in INCLUDE statements in the enduser options file, and the number of users are limited to num_lic , or the number specified in =n .
Vendor-defined string, enclosed in double quotes.
The following attributes listed in Table B-3
are optional and are under control of the end user.
These attributes have a keyword=value syntax where keyword is in lowercase.
Table B-3: End-User Attributes
Attribute asset_info="..." dist_info="..." sort=nnn user_info="..." vendor_info="...
"
Description
Additional information provided by the license administrator for asset management.
Additional information provided by the software distributor.
Specifies sort order of license file lines. See “Order of
Additional information provided by the license administrator.
Additional information provided by the software vendor.
Examples:
FEATURE sample_app sampled 2.300 31-dec-2005 20 \
SIGN=123456789012
INCREMENT f1 sampled 1.000 permanent 5 \
HOSTID=INTERNET=195.186.*.* NOTICE="Licensed to \
Sample corp" SIGN=901234567890
FLEXnet Licensing End User Guide 115
Appendix B - License File Format
License File Syntax
Order of Precedence
FEATURE/INCREMENT license file lines are automatically sorted when they are processed by FLEXnet Licensing; the default sorting rules are is as follows:
1. License file. Automatic sorting does not occur across files in a license-file list.
2. Feature name.
3. FEATURE before INCREMENT.
4. Uncounted before counted.
5. Version, higher versions before lower versions.
6. Issued date, in reverse order, newest first. The date is taken from ISSUED= or START=.
7. Original order is otherwise maintained.
To turn off automatic ordering add sort=nnn to the FEATURE/INCREMENT line, where nnn is the same on all lines; nnn specifies the relative sort order. The default sort order value is 100 . Lines with a sort order value of less than 100 are sorted before all lines without this attribute, and lines with a sort order value greater than 100 appear after all unmarked lines. All lines with the same number are sorted as they appear in the file.
FLEX
NET
L
ICENSING
V
ERSION
N
OTES
• Pre-v7.1 FEATURE/INCREMENT line format uses license_key:
{FEATURE|INCREMENT} feature vendor feat_version exp_date
num_lic license_key [optional_atributes]
The pre-v7.1 format is understood by the current client library and vendor daemon.
• The SIGN= keyword introduced in the v7.1 client library and vendor daemon.
• For v7.1 through v8.0 client libraries and vendor daemons, the FEATURE/INCREMENT line must have a SIGN= signature and, for backward compatibility with pre-v8.1, can contain a license_key:
{FEATURE|INCREMENT} feature vendor feat_version exp_date \
num_lic [license_key] SIGN=sign \
[optional_attributes]
• license_key obsoleted in v8.1 client library and vendor daemon
• The keyword “permanent” for exp_date introduced in v6 client library.
• The keyword “uncounted’ for num_lic introduced in v6 client library.
• BORROW keyword introduced in v8.0 client library and vendor daemon.
• FLOAT_OK keyword introduced in v8.0 client library and vendor daemon.
• TS_OK keyword introduced in v8.0 client library and vendor daemon.
• AUTH keyword introduced in v10.8 client library and vendor daemon.
116 FLEXnet Licensing End User Guide
Appendix B - License File Format
License File Syntax
PACKAGE Lines
The purpose of the PACKAGE line is to support two different licensing needs:
• To license a product SUITE, or
• To provide a more efficient way of distributing a license file that has a large number of features, which largely share the same FEATURE line arguments.
A PACKAGE line, by itself, does not license anything—it requires a matching
FEATURE/INCREMENT line to license the whole package. A PACKAGE line is shipped by your software vendor with a product, independent of any licenses. Later, when you purchase a license for that package, one or more corresponding FEATURE/INCREMENT lines enable the
PACKAGE line.
Example:
PACKAGE package vendor [pkg_version] COMPONENTS=pkg_list \
[OPTIONS=SUITE] [SUPERSEDE[="p1 p2 ..."] ISSUED=date]
SIGN=pkg_sign
Table B-4 lists the PACKAGE line fields. They must appear in the order listed.
Table B-4: PACKAGE Line Fields
Field package vendor
Description
Name of the package. The corresponding
FEATURE/INCREMENT line must have the same name.
Name of the vendor daemon that supports this package.
pkg_version Optional field specifying the package version. If specified, the enabling FEATURE/INCREMENT line must have the same version.
COMPONENTS= pkg_list List of package components. The format is: feature [: version [: num_lic ]]
Packages must consist of at least one component. Version and count are optional, and if left out, their values come from the corresponding FEATURE/INCREMENT line. num_lic is only legal if OPTIONS=SUITE is not set—in this case the resulting number of licenses is num_lic on the COMPONENTS line multiplied by the number of licenses in the FEATURE/INCREMENT line. Examples:
COMPONENTS="comp1 comp2 comp3 comp4"
COMPONENTS="comp1:1.5 comp2 comp3:2.0:4"
FLEXnet Licensing End User Guide 117
Appendix B - License File Format
License File Syntax
Table B-4: PACKAGE Line Fields (cont.)
Field
OPTIONS=SUITE
OPTIONS=
SUITE_RESERVED
SUPERSEDE
[=" p1 p2 ...
"]
ISSUED= dd-mmm-yyyy
SIGN= sign or
AUTH=...
Description
Optional field. Used to denote a package suite.
If set, the corresponding feature of the same name as the package is checked out in addition to the component feature being checked out.
If not set, then the corresponding feature of the same name as the package is removed once the package is enabled; it is not checked out when a component feature is checked out.
Optional field. If set, reserves a set of package components.
Once one package component is checked out, all the other components are reserved for that same user.
Optional field. Used in conjunction with ISSUED date.
Replaces all PACKAGE lines for the same package name with ISSUED dates previous to dd-mmm-yyyy .
Optional field. Used in conjunction with SUPERSEDE.
Replaces all PACKAGE lines for the same package name with ISSUED dates previous to dd-mmm-yyyy .
SIGN= signature to authenticate this FEATURE line.
If your publisher has deployed his vendor daemon using the common vendor daemon technology, license certificate signatures are embedded within the AUTH= keyword.
Contact your publisher for further details.
Examples:
PACKAGE suite sampled 1.0 SIGN=3B24B2F508CB \
COMPONENTS="comp1 comp2" OPTIONS=SUITE
FEATURE suite sampled 1.0 1-jan-0 5 SIGN=4193E6ABCCCB
This is a typical OPTIONS=SUITE example. There are two features, “comp1” and “comp2,” which are each version 1.0, each with five non-expiring licenses available. When “comp1” or
“comp2” is checked out, “suite” is also checked out.
PACKAGE suite sampled 1.0 SIGN=2CBF44FCB9C1 \
COMPONENTS="apple:1.5:2 orange:3.0:4"
FEATURE suite sampled 1.0 1-jan-2005 3 SIGN=321E78A17EC1 SN=123
In this example, the component version overrides the feature version, and the number of licenses available for any component is the product of the three licenses for “suite” and the number of licenses for that component. The result is equivalent to:
118 FLEXnet Licensing End User Guide
Appendix B - License File Format
Decimal Format
FEATURE apple sampled 1.5 1-jan-2005 6 SIGN=0D3AD5F26BEC SN=123
FEATURE orange sampled 3.0 1-jan-2005 12 SIGN=EB16C5AE61F0 SN=123
FLEX
NET
L
ICENSING
V
ERSION
N
OTES
• Ability to store PACKAGE lines in separate files introduced in v6 client library.
• pkg_version field required in pre-v7.1 client library.
• AUTH keyword introduced in v10.8 client library and vendor daemon.
UPGRADE Lines
UPGRADE feature vendor from_feat_version to_feat_version \
exp_date num_lic [options ... ] SIGN=sign
All the data is the same as for a FEATURE or INCREMENT line, with the addition of the from_feat_version field. An UPGRADE line removes up to the number of licenses specified from any old version (>= from_feat_version ) and creates a new version with that same number of licenses.
For example, the two lines:
INCREMENT f1 sampled 1.000 1-jan-2005 5 SIGN=9BFAC0316462
UPGRADE f1 sampled 1.000 2.000 1-jan-2005 2 SIGN=1B9A308CC0F7 provide three v1.0 licenses of “f1” and two v2.0 licenses of “f1.”
An UPGRADE line operates on the closest preceding FEATURE or INCREMENT line with a version number that is >= from_feat_version , and < to_feat_version .
Note UPGRADE lines do not work for node-locked, uncounted licenses.
Decimal Format
Licenses can be represented in decimal format. Decimal has the advantage that it’s simpler to type in, and often the licenses are much shorter.
A simple demo license in readable format:
FEATURE f1 sampled 1.00 1-jan-2005 0 key1 HOSTID=DEMO and its decimal equivalent: sampled-f1-00737-55296-1825
If needed, decimal lines can be mixed with readable format lines in a license file. Use the lminstall command to convert decimal licenses to readable format.
FLEXnet Licensing End User Guide 119
Appendix B - License File Format
License File Order
See Also
•
“lminstall” for additional information on the
lminstall command.
FLEX
NET
L
ICENSING
V
ERSION
N
OTES
• The decimal format was introduced in the v6 client library and vendor daemon.
License File Order
The order of the lines in a license file is not critical. They are sorted when they are processed so that in most cases the optimal result is achieved. However, pre-v7.0 versions of
FLEXenabled applications and license server systems implicitly impose an ordering to license file lines. Note the following suggestions for ordering lines in the license file:
• Place FEATURE lines before INCREMENT lines for the same feature.
The rule regarding FEATURE lines is that only the first counted FEATURE line is observed by the license server system, and that if there is a FEATURE line and
INCREMENT lines, the FEATURE line must appear first.
• Where multiple counted FEATURE lines exist for the same feature, make sure the desired
FEATURE line appears first.
All but the first is ignored.
• Place node-locked, uncounted lines before floating lines for the same FEATURE.
Otherwise, it is possible the floating license is consumed instead of the node-locked license, resulting in denial for other users.
• The placement of a USE_SERVER line affects behavior.
A USE_SERVER line is recommended. Normally, the USE_SERVER line is placed immediately after the SERVER line. However, place any uncounted licenses not served by
SERVER before the USE_SERVER line. Make sure each user that needs the uncounted license has direct access to a current copy of the file. The advantage to placing
USE_SERVER right after the SERVER line is users don’t need up-to-date copies of the license file.
See Also
•
120 FLEXnet Licensing End User Guide
Appendix C
Troubleshooting Guide
C
This appendix documents areas of FLEXnet Licensing that have given customers difficulty in the past.
General Troubleshooting Hints
The following are tips for debugging:
• When you start the license server system be sure that you direct the output into a local log file where you can examine it. The log file often contains useful information. Examine it when you have a problem, and be prepared to answer questions about it when you talk to a support person.
• If the license server system appears to have started correctly (which you can determine from the log file), try running lmstat -a and lmdiag to see if that program has the same problem as your application.
• If your application is v4.1 or later (v5 or later on Windows), you can use the
FLEXLM_DIAGNOSTICS environment variable. Set FLEXLM_DIAGNOSTICS to 1, 2, or 3.
A setting of 3 gives more information than 2, 2 gives more information than 1 (in particular, the feature name that was denied). See
for more information.
• When you talk to a support person, be prepared with answers to the following questions:
- What kind of machine is your license server system running on?
- What version of the operating system?
- What machine and operating system is the application running on?
- What version of FLEXnet Licensing does the FLEXenabled application use?
Use the lmver script, or, on UNIX, execute the following command on your lmgrd , vendor daemon, and application: strings binary_name | grep Copy
Alternatively, lmgrd -v gives the lmgrd version, and this works with the vendor daemon also.
- What error or warning messages appear in the log file?
- Did the server start correctly?
Look for a message such as:
FLEXnet Licensing End User Guide 121
Appendix C - Troubleshooting Guide
FLEXLM_DIAGNOSTICS server xyz started for: feature1 feature2 .
- What is the output from running lmstat -a ?
- Are you running other FLEXenabled products?
- Are you using a combined license file or separate license files?
- Are you using a three-server redundant license server system (multiple SERVER lines in your license file)?
FLEXLM_DIAGNOSTICS
Note The ability for FLEXnet Licensing to produce diagnostic output is controlled by your software vendor.
FLEXLM_DIAGNOSTICS is an environment variable that causes the application to produce diagnostic information when a checkout is denied. The format of the diagnostic information may change over time.
On UNIX, the diagnostic output goes to stderr.
On Windows, the output is a file in the current directory called flexpid.log
, where pid is the application’s process ID.
Level 1 Content
If FLEXLM_DIAGNOSTICS is set to 1, then the standard FLEXnet Licensing error message is be presented, plus a complete list of license files that the application tried to use. For example: setenv FLEXLM_DIAGNOSTICS 1
FLEXlm checkout error: Cannot find license file (-1,73:2) No such file or directory license file(s): /usr/myproduct/licenses/testing.lic license.lic
Level 2 Content
If FLEXLM_DIAGNOSTICS is set to 2, then, in addition to level 1 output, the checkout arguments are presented. For example: setenv FLEXLM_DIAGNOSTICS 2
FLEXlm checkout error: No such feature exists (-5,116:2) No such file or directory license file(s): /usr/myproduct/licenses/testing.lic license.lic
lm_checkout("f1", 1.0, 1, 0x0, ..., 0x4000)
Note that the error message actually contains two separate problems, which both occurred during the checkout:
• There’s no such feature in the license it did find
• It was unable to find the other license file, which is what produces the message “No such file or directory”
Following is a description of the arguments to lm_checkout()
122 FLEXnet Licensing End User Guide
Appendix C - Troubleshooting Guide
FLEXLM_DIAGNOSTICS lm_checkout(feature, version, num_lic, queue_flag, ..., dupgroup_mask) where: feature version num_lic queue_flag dupgroup_mask
The requested feature.
The requested version. The license file must contain a version
>= the requested version.
Number of licenses requested. Usually 1.
If 0, no queueing
If 1, queue for license (“blocking” queue)
If 2, queue for licenses, but return to application (“nonblocking” queue)
Indicates duplicate grouping, also called license sharing. User, host, and display are as shown by lmstat -a .
Level 3 Content (v6.0+ only)
If FLEXLM_DIAGNOSTICS is set to 3, then, in addition to level 1 and 2 output, if a checkout is successful, information is printed explaining how the license was granted: setenv FLEXLM_DIAGNOSTICS 3 app
Checkout succeeded: f0/14263EAEA8E0
License file: ./servtest.lic
No server used app2
Checkout succeeded: f1/BC64A7B120AE
License file: @localhost
License Server System: @localhost app3
Checkout succeeded: f1/BC64A7B120AE
License file: servtest.lic
License Server System: @speedy
Note that the feature name and license key are printed, along with the license file location (or host name if @host were used) and host name of the server, where applicable.
FLEXnet Licensing End User Guide 123
Appendix C - Troubleshooting Guide
FLEXLM_DIAGNOSTICS
124 FLEXnet Licensing End User Guide
Appendix D
FLEXnet Licensing Environment Variables
D
Environment variables are not required in order to use FLEXenabled applications. Environment variables are normally used for debugging or for changing license default location.
How to Set Environment Variables
FLEXnet Licensing environment variables are set in two different ways:
• In the process’ environment
• In the registry (Windows v6.0+) or in $HOME/.flexlmrc
(UNIX v7.0+), which functions like the registry for FLEXnet Licensing on UNIX.
Registry
On Windows, the FLEXnet Licensing registry location is:
HKEY_LOCAL_MACHINE\Software\FLEXlm License Manager
On UNIX, the equivalent information is stored in $HOME/.flexlmrc
. In this file, the syntax is variable=value .
Precedence
If the variable is LM_LICENSE_FILE or VENDOR_LICENSE_FILE , then both the environment and the registry are used, with the environment used first, and the registry appended to the path.
If it’s a different variable, then if the environment set, only that is used, otherwise the registry is used. That is, the registry is only used if the environment is not set.
Environment Variables
Variable
FLEXLM_BATCH
Definition
Windows only: prevents interactive pop-ups from appearing. Set to 1 if a batch application. (Version 7.0+ clients)
FLEXnet Licensing End User Guide 125
Appendix D - FLEXnet Licensing Environment Variables
Environment Variables
FLEXLM_DIAGNOSTICS
FLEXLM_TIMEOUT
LM_BORROW
LM_PROJECT
Used for debugging where applications don’t print
FLEXnet Licensing error message text. Set to 1, 2, or 3, depending on the amount of diagnostic information desired. See
“FLEXLM_DIAGNOSTICS.” (Version
5.0+ clients)
Windows only: Sets the timeout value a FLEXenabled application uses when attempting to connect to a license server system port in the range 27000-27009.
Values are in microseconds, within the range 0 through
2147483647. The default setting is 100000 microseconds.
Used for initiating license borrowing and setting the borrow period. See
“Initiating License Borrowing” for
more details. On UNIX platforms,
$HOME/.flexlmborrow
is used for the registry instead of $HOME/.flexlmrc
.
LM_PROJECT ’s value is logged in the report log file and later reported on by FLEXnet Manager. Limited to 30 characters. (v5.0+ client required.)
This can also be used to RESERVE, INCLUDE, etc. licenses with PROJECT. For example:
RESERVE 1 f1 PROJECT airplane v5.0+ clients and v7.0+ vendor daemon are required for this feature.
LM_SERVER_HIGHEST_FD
LM_UTIL_CASE_SENSITIVE
TCP_NODELAY
Used to set the highest file descriptor value, above which the license server will not access.
Used by the FLEXlm utilities. If set to 1 , the utilities process license file lines as case sensitive. By default, this variable is set to 0 ; license files are treated as case insensitive. This environment variable is applicable only when the license server, itself, has been configured by your vendor to treat license files in a case sensitive manner.
Improves FLEXnet license server system performance when processing license requests. Set to 1 to enable performance enhancements. Use with caution: when enabled it may cause an increase in network traffic.
126 FLEXnet Licensing End User Guide
LM_LICENSE_FILE or
VENDOR_LICENSE_FILE
Appendix D - FLEXnet Licensing Environment Variables
Environment Variables
Reset path to license file. Can be a license-file list, separated by “ : ” on UNIX and “ ; ” on Windows. If
VENDOR_LICENSE_FILE used, VENDOR is the vendor daemon name used by this application. For example,
Macrovision products use GSI_LICENSE_FILE . Can be a file name, or port@host . See also
“Setting the Path with an Environment Variable.”
( VENDOR_LICENSE_FILE requires v6.0+ clients.)
FLEXnet Licensing End User Guide 127
Appendix D - FLEXnet Licensing Environment Variables
Environment Variables
128 FLEXnet Licensing End User Guide
Appendix E
FLEXnet Licensing Error Codes
E
Error Message Format
FLEXnet Licensing error messages presented by applications have the following components:
• FLEXnet Licensing Error Number—a negative number starting at -1.
• FLEXnet Licensing Error Text—short sentence (< 80 characters) summarizing problem.
• FLEXnet Licensing Error Explanation (optional)—short paragraph (3-5 lines) explaining problem and possible solutions or workarounds.
• FLEXnet Licensing Minor Error Number—a positive number starting at 1. These numbers are unique error identifiers and are used by FLEXnet Licensing vendors for more advanced support assistance. Their meaning is not documented.
• System Error Number (optional)—a UNIX or Windows OS error code last set by the operating system.
• System Error Explanation (optional)—a short sentence (< 80 characters) explaining the system error.
• Other supporting information (optional)
Error messages were improved in v6. FLEXnet Licensing Error Explanation, and supporting information are only available in applications using v6.0+.
These error messages may occur in two formats available with FLEXnet Licensing or may appear in a format customized by the application.
Format 1 (short):
FLEXlm error text (-lm_errno, minor_num[:sys_errno]) [sys_error_text]
The system error information may be missing.
Example:
Can’t connect to license server system (-15,12:61) Connection refused
Format 2 (long—version 6.0+):
FLEXlm error text
FLEXlm error explanation
[Optional Supporting information]
FLEXlm error: -lm_errno, minor_num. [System Error: sys_errno] [“system_error_text”]
FLEXnet Licensing End User Guide 129
Appendix E - FLEXnet Licensing Error Codes
Error Code Descriptions
Example:
Cannot connect to license server system
The server (lmgrd) has not been started yet, or the wrong port@host or license file is being used, or the port or hostname in the license file has been changed.
Feature: f1
Server name: localhost
License path: @localhost:license.dat:./*.lic
FLEXlm error: -15,12. System Error: 61 “Connection refused”
Error Code Descriptions
The following table lists the most common errors produced by FLEXenabled products.
-10
-11
-12
-13
Table E-1: FLEXnet Licensing Error Codes
-4
-5
-6
Error Code
-1
-2
-3
-7
-8
-9
Description
Cannot find license file.
Invalid license file syntax.
No license server system for this feature.
Licensed number of users already reached.
No such feature exists.
No TCP/IP port number in license file and FLEXnet Licensing service does not exist. (pre-v6 only)
No socket connection to license server manager service.
Invalid (inconsistent) license key or signature.
The license key/signature and data for the feature do not match. This usually happens when a license file has been altered.
Invalid host.
The hostid of this system does not match the hostid specified in the license file.
Feature has expired.
Invalid date format in license file.
Invalid returned data from license server system.
No SERVER lines in license file.
130 FLEXnet Licensing End User Guide
Appendix E - FLEXnet Licensing Error Codes
Error Code Descriptions
-30
-31
-32
-33
-24
-25
-26
-29
-34
-35
-36
-19
-21
-22
-23
-16
-17
-18
Table E-1: FLEXnet Licensing Error Codes (cont.)
Error Code
-14
-15
Description
Cannot find SERVER host name in network database.
The lookup for the host name on the SERVER line in the license file failed. This often happens when NIS or DNS or the hosts file is incorrect. Workaround: Use IP address (e.g., 123.456.789.123) instead of host name.
Cannot connect to license server system.
The server ( lmgrd ) has not been started yet, or the wrong port@host or license file is being used, or the TCP/IP port or host name in the license file has been changed.
Cannot read data from license server system.
Cannot write data to license server system.
License server system does not support this feature.
Error in select system call.
License file does not support this version.
Feature checkin failure detected at license server system.
License server system temporarily busy (new server connecting).
Users are queued for this feature.
License server system does not support this version of this feature.
Request for more licenses than this feature supports.
Cannot find ethernet device.
Cannot read license file.
Feature start date is in the future.
No such attribute.
Bad encryption handshake with vendor daemon.
Clock difference too large between client and license server system.
In the queue for this feature.
Feature database corrupted in vendor daemon.
FLEXnet Licensing End User Guide 131
Appendix E - FLEXnet Licensing Error Codes
Error Code Descriptions
-59
-60
-61
-62
-54
-55
-56
-57
1
-42
-47
-52
-53
-38
-39
-40
-41
-69
-71
-73
-63
-64
-67
-68
Table E-1: FLEXnet Licensing Error Codes (cont.)
Error Code
-37
Description
Duplicate selection mismatch for this feature. Obsolete with v8.0+ vendor daemon.
User/host on EXCLUDE list for feature.
User/host not on INCLUDE list for feature.
Cannot allocate dynamic memory.
Feature was never checked out.
Invalid parameter.
Clock setting check not available in vendor daemon.
Vendor daemon did not respond within timeout interval.
Checkout request rejected by vendor-defined checkout filter.
No FEATURESET line in license file.
Incorrect FEATURESET line in license file.
Cannot compute FEATURESET data from license file.
socket() call failed.
Message checksum failure.
License server system message checksum failure.
Cannot read license file data from license server system.
Network software (TCP/IP) not available.
You are not a license administrator.
lmremove request before the minimum lmremove interval.
No licenses available to borrow.
License BORROW support not enabled.
FLOAT_OK can’t run standalone on license server system.
Invalid TZ environment variable.
Local checkout filter rejected request.
132 FLEXnet Licensing End User Guide
Appendix E - FLEXnet Licensing Error Codes
Error Code Descriptions
-85
-87
-88
-89
-90
Table E-1: FLEXnet Licensing Error Codes (cont.)
-77
-82
-83
-84
Error Code
-74
-75
-76
-91
-92
-93
-94
-95
Description
Attempt to read beyond end of license file path.
SYS$SETIMR call failed (VMS).
Internal FLEXnet Licensing error—please report to Macrovision
Corporation.
Bad version number must be floating-point number with no letters.
Invalid PACKAGE line in license file.
FLEXnet Licensing version of client newer than server.
USER_BASED license has no specified users - see license server system log.
License server system doesn’t support this request.
Checkout exceeds MAX specified in options file.
System clock has been set back.
This platform not authorized by license.
Future license file format or misspelling in license file.
The file was issued for a later version of FLEXnet Licensing than this program understands.
Encryption seeds are non-unique.
Feature removed during lmreread, or wrong SERVER line hostid.
This feature is available in a different license pool.
This is a warning condition. The server has pooled one or more
INCREMENT lines into a single pool, and the request was made on an
INCREMENT line that has been pooled.
Attempt to generate license with incompatible attributes.
Network connect to THIS_HOST failed.
Change this_host on the SERVER line in the license file to the actual host name.
FLEXnet Licensing End User Guide 133
Appendix E - FLEXnet Licensing Error Codes
Error Code Descriptions
Table E-1: FLEXnet Licensing Error Codes (cont.)
Error Code
-96
-97
-98
-99
-100
-101
-102
-103
-104
-106
-110
-112
-114
-115
-116
-117
Description
License server machine is down or not responding.
See the system administrator about starting the server, or make sure that you’re referring to the right host (see LM_LICENSE_FILE environment variable).
The desired vendor daemon is down.
1) Check the lmgrd log file, or 2) Try lmreread.
This FEATURE line can’t be converted to decimal format.
The decimal format license is typed incorrectly.
Cannot remove a linger license.
All licenses are reserved for others.
The system administrator has reserved all the licenses for others.
Reservations are made in the options file. The server must be restarted for options file changes to take effect.
A FLEXid borrow error occurred.
Terminal Server remote client not allowed.
Cannot borrow that long.
License server system out of network connections.
The vendor daemon can't handle any more users. See the debug log for further information.
Cannot read dongle: check dongle or driver.
Either the dongle is unattached, or the necessary software driver for this dongle type is not installed.
Missing dongle driver.
In order to read the FLEXid hostid, the correct driver must be installed.
These drivers are available from your software vendor.
SIGN= keyword required, but missing from license certificate.
You need to obtain a SIGN= version of this license from your vendor.
Error in Public Key package.
TRL not supported for this platform.
BORROW failed.
134 FLEXnet Licensing End User Guide
Appendix E - FLEXnet Licensing Error Codes
Error Code Descriptions
-143
-144
-145
-146
-147
-124
-125
-126
-127
-128
-135
-136
-137
-139
-140
-141
-142
Table E-1: FLEXnet Licensing Error Codes (cont.)
Error Code
-118
-119
-120
-121
-122
-123
Description
BORROW period expired.
lmdown and lmreread must be run on license server machine.
Cannot lmdown the server when licenses are borrowed.
FLOAT_OK requires exactly one FLEXid hostid.
Unable to delete local borrow info.
Returning a borrowed license early is not supported.
Contact the vendor for further details.
Error returning borrowed license.
A PACKAGE component must be specified.
Composite hostid not initialized.
A item needed for the composite hostid is missing or invalid.
Error, borrowed license doesn't match any known server license.
Error enabling the event log.
Event logging is disabled.
Error writing to the event log.
Communications timeout.
Bad message command.
Error writing to socket. Peer has closed socket.
Error, cannot generate version specific license tied to a single hostid, which is composite.
Version-specific signatures are not supported for uncounted licenses.
License template contains redundant signature specifiers.
Bad V71_LK signature.
Bad V71_SIGN signature.
Bad V80_LK signature.
FLEXnet Licensing End User Guide 135
Appendix E - FLEXnet Licensing Error Codes
Error Code Descriptions
-507
-508
-509
-510
-511
-512
-513
-503
-504
-505
-506
-156
-500
-501
-502
Table E-1: FLEXnet Licensing Error Codes (cont.)
Error Code
-148
-149
-150
-151
-152
-153
-154
-155
Description
Bad V80_SIGN signature.
Bad V81_LK signature.
Bad V81_SIGN signature.
Bad V81_SIGN2 signature.
Bad V84_LK signature.
Bad V84_SIGN signature.
Bad V84_SIGN2 signature.
License key required but missing from the license certificate. The application requires a license key in the license certificate. You need to obtain a license key version of this certificate from your vendor.
Invalid signature specified with the AUTH= keyword.
Invalid server port number.
Invalid value in license where an integer was expected.
Invalid value supplied for count.
Invalid hostid supplied in license.
Invalid hostid type supplied.
Bad feature line syntax.
Internal FLEXnet Licensing error.
Bad date format in license file.
Bad SERVER line.
Bad license string.
Server's feature doesn't authenticate on client side.
No license checked out.
License already checked out.
Error list returned.
136 FLEXnet Licensing End User Guide
Appendix E - FLEXnet Licensing Error Codes
Error Code Descriptions
Table E-1: FLEXnet Licensing Error Codes (cont.)
Error Code
-514
-515
-516
-517
-518
-519
Description
No certicom module available.
Wrong or incomplete certicom module.
SIGN or SIGN2 required in license certificate.
Feature object has no license sources.
An Identical license is already checked out on this license source.
This license has an asynchronously-queued checkout pending.
-521
-522
-523
-524
Library for native hostid couldn't be loaded.
Already connected to another vendor daemon.
No such user, host, or display.
Shutdown of license server system failed.
-525
-526
Shutdown failed — already connected to license server system.
Invalid license source string.
-527 Log file switch error.
1.Indicates errors due to an operating system failure.
FLEXnet Licensing End User Guide 137
Appendix E - FLEXnet Licensing Error Codes
Error Code Descriptions
138 FLEXnet Licensing End User Guide
Appendix F
The Report Log File
F
The license server system produces both report log files and debug log files. The focus of this
appendix is report log files. For information on debug log files see Appendix G, “The Debug
The report log file contains feature usage information and is generated by the vendor daemon.
However, a vendor daemon does not write report logs by default; this action must be enabled.
The data in report logs is compressed,authenticated and organized into a respository.
Use Macrovision's software license administration solution, FLEXnet Manager, to gain exceptional visibility into license usage data and to create insightful reports on critical information like license availability and usage. FLEXnet Manager can be fully automated to run these reports on schedule and can be used to track license servers and usage across a heterogeneous network of server including Windows NT, Linux and UNIX. Contact
Macrovision at www.macrovision.com
for more details on how to obtain an evaluation copy of
FLEXnet Manager for your enterprise.
Managing Report Log Output
As a vendor daemon runs for a period of time, the volume of report log output increases. If you have a lot of license activity, these log files grow very large. You need to consider where to put these files and how often to rotate and archive them. Therefore, it may be necessary to rotate or switch report log output into different files over time, each file containing license activity over a particular period of time.
Report log data is collected by the vendor daemon into an internal data buffer area before being flushed to the output file. The daemon’s internal buffer is flushed once a minute or whenever it gets full, whichever occurs first. To ensure the freshest data possible in the report log file, flush the buffer on demand with the lmreread command. Use standard file compression tools to reduce the size of a report log file when it is no longer being written.
To avoid corruption and for performance, it is suggested that the vendor daemon write its report log to a file on a disk local to the system running the vendor daemon. Each vendor daemon must write to its own report log file.
FLEXnet Licensing End User Guide 139
Appendix F - The Report Log File
Enabling Report Log Output for a Vendor Daemon
Enabling Report Log Output for a Vendor Daemon
There are two ways to enable report logging for a particular vendor daemon either before or after starting the license server system.
• Add the REPORTLOG line to the options file for that vendor daemon. See
for more details.
• Invoke lmswitchr on the vendor daemon. See
for more details.
Redirecting Report Log Output for a Vendor Daemon
The report log output for a particular vendor daemon can be moved into separate files, each file representing activity over a different period of time. There are three ways in which to do this whether the vendor daemon is running or not:
• Change the REPORTLOG line in the vendor daemon’s options file and reread its options file by invoking lmreread (v8.0+ vendor daemon) or restart.
• Invoke lmswitchr on the vendor daemon. See
for more details.
• Invoke lmnewlog on the vendor daemon. Requires a v7.1+ vendor daemon. See
for more details.
140 FLEXnet Licensing End User Guide
Appendix G
The Debug Log File
G
The license server system produces both debug log files and report log files. The focus of this
appendix is debug log files. For information on report log files see Appendix F, “The Report
A debug log file contains status and error messages useful for debugging the license server system. A license server system always generates debug log output. Some of the debug log output describes events specific to lmgrd and some of the debug log output describes events specific to each vendor daemon.
Managing Debug Log Output
As lmgrd and its vendor daemons run for a period of time, the volume of this output increases.
As it gets older, the value of the debug log output decreases; therefore, it may be necessary for you to separate old debug log output from current output; either archive or delete the old output.
For performance, it is suggested that each debug log file be a on disk that is local to the machine that is running lmgrd and its vendor daemons. However, if the debug log file must be on a remotely-mounted disk and you find that the license server system is too slow, start lmgrd with the -nfs_log option to improve performance.
See “Debug Log Messages” for a description of the debug log output format.
Capturing Debug Log Output for a License Server System
By default, lmgrd and the vendor daemons it manages write debug log output to standard out.
To put this debug log output in a file, either redirect the output of the license server system to a file or start lmgrd with the -l debug_log_path option.
Capturing Debug Log Output for a Particular Vendor Daemon
The debug log output from different vendor daemons controlled by the same license server system can be written to their own files (v8.0+ vendor daemon). There are two ways to do this:
• Add the DEBUGLOG line to the options file for each vendor daemon. See “DEBUGLOG”
for more details.
• Invoke lmswitch on the vendor daemon. See
Note that lmgrd writes its own debug log output to standard out.
FLEXnet Licensing End User Guide 141
Appendix G - The Debug Log File
Debug Log Messages
Redirecting Debug Log Output for a Running Vendor Daemon
It is possible to redirect the debug log output for a particular vendor daemon to a different file.
There are two ways to do this:
• Change the DEBUGLOG line to the options file for the vendor daemon and reread its options file by invoking lmreread . See
for more details.
• Invoke lmswitch on the vendor daemon. See
Limiting Debug Log Output for a Vendor Daemon
By default, debug log output contains all events. To limit the events that are logged for a particular vendor daemon, add a NOLOG line to the options file of that vendor daemon. See
“NOLOG” for more details. One of the reasons you may want to limit the events that are logged
is to reduce the size of the debug log output.
Debug Log Messages
FLEXnet Licensing processes generate debug log files in the following format:
hh:mm:ss (daemon) message where: hh : mm :ss daemon message
Time that the message was logged.
Either lmgrd or the vendor daemon name. In the case where a single copy of the daemon cannot handle all of the requested licenses, an optional “_” followed by a number indicates that this message comes from a forked daemon.
The text of the message.
The debug log files can be used to:
• Diagnose configuration problems
• Diagnose daemon software errors
Note A debug log file cannot be used for usage reporting with FLEXnet Manager.
142 FLEXnet Licensing End User Guide
Appendix G - The Debug Log File
Debug Log Messages
Informational Messages
Message
Connected to host
CONNECTED, master is host
DENIED: num_lic feature to user
EXITING DUE TO SIGNAL nnn
EXITING with code nnn
EXPIRED: feature
IN: “feature” user (num_lic licenses)
Description
This daemon is connected to its peer on host.
The license daemons log this message when a quorum is up and everyone has selected a master.
user was denied access to num_lic licenses of feature .
All daemons list the reason that the daemon has exited. feature user has checked in num_lic licenses of feature .
has passed its expiration date.
Lost connection to host
Lost quorum
MULTIPLE vendor servers running.
Please kill, and restart license daemon.
A daemon can no longer communicate with its peer on node host, which can cause the clients to have to reconnect, or cause the number of daemons to go below the minimum number, in which case clients may start exiting. If the license daemons lose the connection to the master, they kill all the vendor daemons; vendor daemons shut themselves down.
The daemon lost quorum, so it processes only connection requests from other daemons.
The license server manager, lmgrd , has detected that multiple vendor daemons for vendor are running.
Shutdown lmgrd and all vendor daemons with the lmdown utility and then restart lmgrd .
OUT: “feature” user (num_lic licenses)
RESERVE feature for USER user
RESERVE feature for HOST host user has checked out num_lic licenses of feature .
A license of feature is reserved for either user or host .
REStarted vendor (internet port nnn) Vendor daemon vendor was restarted at TCP/IP port nnn .
FLEXnet Licensing End User Guide 143
Appendix G - The Debug Log File
Debug Log Messages
Message
Retrying socket bind (address in use)
Selected (EXISTING) master host.
SERVER shutdown requested.
Server started on host for:
“feature_list”
Shutting down vendor
SIGCHLD received. Killing child servers.
Started vendor
Trying to connect to host
Description
The license server systems try to bind their sockets for approximately six minutes if they detect “address in use” errors.
This license daemon has selected an existing master host as the master.
A daemon was requested to shut down via a usergenerated kill command.
A (possibly new) server was started for the features listed.
The license server manager is shutting down the vendor daemon vendor.
A vendor daemon logs this message when a shutdown was requested by the license daemon.
The license server manager logs this message whenever it starts a new vendor daemon.
The daemon is attempting a connection to host.
144 FLEXnet Licensing End User Guide
Appendix G - The Debug Log File
Debug Log Messages
Configuration Problem Messages
Message Description host : Not a valid server host, exiting This daemon was run on an invalid host name.
host : Wrong hostid, exiting The hostid is wrong for host.
BAD CODE for feature
CANNOT OPEN options file file
Couldn’t find a master
License daemon: lost all connections
The specified feature name has a bad license key or signature. It was probably typed in wrong, or modified by the end user.
The options file specified in the license file could not be opened.
The daemons could not agree on a master.
Lost lock, exiting
Error closing lock file
Unable to re-open lock file
This message is logged when all the connections to a server are lost, which often indicates a network problem.
The vendor daemon has a problem with its lock file, usually because of an attempt to run more than one copy of the daemon on a single node. Locate the other daemon that is running via a ps command, and kill it with kill -9 .
No DAEMON line for vendor
No DAEMON lines, exiting
No features to serve!
UNSUPPORTED FEATURE request: feature by user
The license file does not contain a DAEMON or
VENDOR line for vendor.
The license daemon logs this message if there are no
DAEMON or VENDOR lines in the license file.
Because there are no vendor daemons to start, there is nothing for the license daemon to do.
A vendor daemon found no features to serve. This could be caused by a corrupted or incorrectly entered license file.
The user has requested a feature that this vendor daemon does not support. This can happen for a number of reasons: the license file is bad, the feature has expired, or the daemon is accessing the wrong license file.
FLEXnet Licensing End User Guide 145
Appendix G - The Debug Log File
Debug Log Messages
Message
Unknown host: host
Description
The host name specified on a SERVER line in the license file does not exist in the network database
(probably /etc/hosts ).
Daemon Software Error Messages
Message accept: message
Can’t allocate server table space
Connection to host TIMED OUT
Description
An error was detected in the “accept” system call.
A malloc error. Check swap space.
The daemon could not connect to host.
Illegal connection request to vendor A connection request was made to vendor, but this vendor daemon is not vendor.
read: error message select: message
Server exiting
An error in a “read” system call was detected.
An error in a “select” system call was detected. This is usually a sign of a system networking failure.
The server is exiting. This is normally due to an error.
146 FLEXnet Licensing End User Guide
Appendix H
IPv6 Support in FLEXnet Licensing
H
Internet Protocol version 6 (IPv6) is a suite of standard protocols that is the next generation of network layer protocols for the internet. This chapter describes IPv6 support in FLEXnet
Licensing. FLEXnet Licensing can support a heterogeneous mixture of IPv4-only, IPv6-only, and dual IPv4/IPv6 machines in both client (machine on which the FLEXenabled product resides) and server (machine on which the FLEXnet license server system resides) roles.
An IPv6 address can be used as a FLEXnet Licensing hostid in these contexts within the
FLEXnet Licensing paradigm:
• In a license file SERVER line to specify the license server system machine
An IPv6 address is used as a hostid to define which machine is authorized to run a license server system that serves licenses to your publisher’s FLEXenabled product. See
“SERVER Lines” for information on how IP addresses can be used in SERVER lines.
• In license file FEATURE and INCREMENT lines
An IPv6 address is used to lock the feature to a particular machine. See Appendix A,
“Hostids for FLEXnet Licensing-Supported Platforms,”
for more information on how IP addresses can be used as hostids.
• In an options file to specify host restrictions
An IPv6 address can be used in a HOST type specification with these keywords to specify the restriction: EXCLUDE, EXCLUDEALL, EXCLUDE_BORROW, INCLUDE,
INCLUDEALL, INCLUDE_BORROW, MAX, and RESERVE. Additionally, it can be
used in a HOST_GROUP keyword. See “Feature Specification” for more information on
how IP addresses can be used in this context.
FLEXnet Licensing IPv6 Support
In order for you to take advantage of IPv6 support in FLEXnet Licensing, you need to determine the level of support your publisher provides. Consult
client (machine on which the FLEXenabled product resides) and server (machine on which the
FLEXnet license server system resides) combinations supported by FLEXnet Licensing. Of these supported configurations, find out from your publisher the ones that he specifically supports.
FLEXnet Licensing End User Guide 147
Appendix H - IPv6 Support in FLEXnet Licensing
Using IPv6 Addresses in the Options File
Table H-1: Client/Server Compatibility Matrix
IPv4-only
Dual Stack, uses
IPv4 address only
Dual Stack, uses both IPv4 and
IPv6 addresses
Dual Stack, uses
IPv6 address only Not
IPv6-only
FLEXnet License Server Machine
IPv4-only
Dual IPv4/IPv6
Stack
IPv6-only No server
Use IPv4 addresses only.
Not supported.
Use IPv4 addresses only.
Use IPv4 addresses only.
Use IPv4, IPv6, or both addresses.
Use IPv4, IPv6, or both addresses.
Use IPv6 addresses only.
supported.
Use IPv6 addresses only.
Use IPv6 addresses only.
IPv6-Aware FLEXnet Licensing Components
Your publisher needs to provide IPv6-aware components. These components are used on IPv6only and dual IPv4/IPv6 machines; they will not work on IPv4-only machines. Consult your publisher’s installation instructions for specific details on how these components are packaged.
What to Tell Your Publisher
You need to survey your environment to determine your IPv4-only, IPv6-only, and dual
IPv4/IPv6 machines that are involved in your FLEXnet Licensing ecosystem. Provide your publisher with the hostids for those machines you plan to host the FLEXenabled product and those you plan to host the FLEXnet licenser server system.
With this information, your publisher can create license certificates locked to the appropriate machines.
Using IPv6 Addresses in the Options File
Both IPv6 and IPv4 addresses can be used in the HOST_GROUP keyword and options file type specifications. To specify restrictions for dual IPv4/IPv6 machines, consider specifying both addresses. The wildcard character, “ * ,” may be used in place of an entire field or on a byte-by-
byte basis to specify a range of addresses without having to list them all. See “Type
148 FLEXnet Licensing End User Guide
Appendix H - IPv6 Support in FLEXnet Licensing
Using IPv6 Addresses in the Options File for further information.
FLEX
NET
L
ICENSING
V
ERSION
N
OTES
• IPv6 address support introduced in FLEXnet Licensing v10.8.
FLEXnet Licensing End User Guide 149
Appendix H - IPv6 Support in FLEXnet Licensing
Using IPv6 Addresses in the Options File
150 FLEXnet Licensing End User Guide
Appendix I
FLEXnet Licensing Versions
Version Compatibility with FLEXnet Licensing Components
In general, always use the latest lmgrd and lmutil /LMTOOLS, which are available from www.macrovision.com
, and you’ll automatically enjoy many of the enhancements available in the most recent versions of FLEXnet Licensing. However, some enhancements require a vendor daemon built with a newer version of FLEXnet Licensing, and yet others require a
FLEXenabled application built with a newer version of FLEXnet Licensing. Contact your software vendor for the most current version of their vendor daemon.
The rules about FLEXnet Licensing version compatibility are summarized as:
Version of lmutil /LMTOOLS must be >=
Version of lmgrd , which must be >=
Version of vendor daemon, which must be >=
Version of the client library linked to the FLEXenabled application, which must be >=
Version of license file format
Except for the license file, use lmver to discover the version of all these FLEXnet Licensing components. For the vendor daemon, lmgrd , and lmutil , you can also use the -v argument to print the version.
How to Tell the License File Version
The following rules apply to individual FEATURE, INCREMENT or UPGRADE lines. It’s possible to have a mix of versions in a single file. Only the features that a particular application checks out determine the version of the license for that feature.
Version 2
>= Version 3
>= Version 4
Blank quotes or a quoted string at the end of the FEATURE line.
INCREMENT or UPGRADE line.
OVERDRAFT, DUP_GROUP, INTERNET, or PACKAGE appear.
I
FLEXnet Licensing End User Guide 151
Appendix I - FLEXnet Licensing Versions
Version Summary
>= Version 5
>= Version 6
>= Version 7.1
>= Version 8
SUPERSEDE, ISSUED, USER_BASED, HOST_BASED, or SN appear.
START appears.
SIGN= keyword appears.
BORROW, FLOAT_OK, and TS_OK appear.
Version Summary
v1.0—1988
First FLEXlm Release, containing all the basic FLEXlm features
v1.5—February 1990
First widely used version including DEMO
v2.1—March 1991
• Improved TIMEOUT support
• Improved ethernet hostid support
v2.21—November 1991
• Added support for many platforms and some platform-specific improvements, such as hostid
• Hostid ANY added
v2.26—March 1992 (Used only by Sun)
• Added license lingering
v2.4—December 1992
• Added “use-all-feature-lines” capability for incremental license distribution
• Enhanced vendor customization routines
• Enhanced end-user options file
• Added new hostid types: USER, HOSTNAME, and DISPLAY
• Added port@host to locate license file —downloads license file from server
v2.61—March 1993 (Used only by Sun)
• Added INCREMENT and UPGRADE lines to license file
v3.0—May 1994
• INCREMENT and UPGRADE behavior changed and improved
• Added UDP protocol support
• Added uname -i hostid for HP
152 FLEXnet Licensing End User Guide
Appendix I - FLEXnet Licensing Versions
Version Summary
• Added multiple jobs for enhanced support of LM_LICENSE_FILE environment variable as a license-file list
• New, optional license file format with keyword=value syntax for optional new features, including: asset_info, ISSUER, and NOTICE, “ \ ” license file continuation character, 2048 character limit per feature
v4.0—December 1994
• Removed use of floating point, for enhanced reliability
• FEATURE line additions: ck, OVERDRAFT, DUP_GROUP, INTERNET hostid
• PACKAGE line
• License Finder
• lmdiag and FLEXLM_DIAGNOSTICS for end-user diagnostics
v4.1—May 1995
• Performance improvements and new platform support
v4.1—Patch Release 6, October 1995
• Windows patch release for Windows 95 with various performance improvements
v5.0—March 1996
• Improved port@host behavior—FLEXenabled application doesn’t read license file
• Automatic port@host via USE_SERVER line in license file
• Hostid lists—lock a feature to several hostids
• New FEATURE attributes: SN (serial number), USER_BASED, HOST_BASED,
MINIMUM, SUPERSEDE, ISSUED (issued date), CAPACITY (charging based on system capacity)
• Optional avoidance of NIS and DNS via IP address instead of host name
• Improved report log file format
• Server, upon startup, notifies of licenses that expire within two weeks
• Improved end-user options file functionality
v5.11—February 1997
• SUPERSEDE lists, PLATFORMS= license attribute,
• new end-user options: MAX, TIMEOUTALL
• Windows control panel added
• Windows license generator GENLIC added
v5.12—April 1997
• Performance improvements and new platform support
v6.0—September 1997
• lmgrd can read multiple license files
FLEXnet Licensing End User Guide 153
Appendix I - FLEXnet Licensing Versions
Version Summary
• FLEXlm license directory support: *.lic
automatically used
• License files require no editing for use at the end-user site
• Optional path on DAEMON/VENDOR line; $ PATH environment variable used
• Decimal license format, with lminstall utility for typing in licenses
• FEATURE lines are shorter, easier to understand and type in
• PACKAGE lines can be shipped in separate files that never require user editing
• Default TCP/IP port numbers make SERVER line port number optional
• Default end-user options file path
• this_host host name supported on SERVER line
• VENDOR_LICENSE_FILE supported (e.g., GSI_LICENSE_FILE )
• @host supported where default port numbers are used
• Windows only: user prompted for license file or license server name
• License files are optionally case insensitive
• lmdown and lmreread accept -vendor vendor argument
• START=dd-mmm-yyyy optional license attribute
v6.1—June 1998
• Performance improvements
v7.0—August 1999
• License Certificate Manager support for automatic license fulfillment
• Support for “try-before-you-buy” licensing
• License file handles inserted newlines from emailers
• License lines automatically optimally sorted
• Improved LMTOOLS interface for Windows
• lmgrd , when run at command line on Windows, runs in background by default
• Improved three-server redundancy reliability (v7.0 vendor daemon and lmgrd )
• lmreread and lmdown take -all argument to shut down or reread all lmgrd s
• Support registry (Windows) and $HOME/.flexlmrc
(UNIX) for FLEXlm environment variables
• Automatically install license path in registry or $HOME/.flexlmrc
after successful checkout
• Options support for LM_PROJECT with PROJECT
• Performance improvements, especially for Windows NT
• Intel Pentium III CPU-ID (v7.0d+, November 1999)
v7.1—August 2000
• Security enhancements
154 FLEXnet Licensing End User Guide
Appendix I - FLEXnet Licensing Versions
Version Summary
• SIGN= keyword in license
• lmnewlog utility (v7.1+ vendor daemon)
v7.2—December 2000
• Performance enhancements
v8.0—October 2001
• lmborrow (v8.0+ components), lmpath (v8.0+ vendor daemon), lmswitch (v8.0+ vendor daemon) utilities
• lmreread rereads end-user options file and SERVER host name
• License borrowing with BORROW keyword
v8.1—January 2002
• CRO Security enhancements
v8.2—August 2002
• Support added for Windows XP compliancy
v8.3—October 2002
• Support added for returning borrowed licenses early
v8.4—January 2003
• Support for reserved package suites
v9.0—March 2003
• Support for COMPOSITE= hostid type
v9.2—July 2003
• Options file keywords added: GROUPCASEINSENSITIVE and
MAX_BORROW_HOURS
v9.5—November 2004
• New environment variable: LM_UTIL_CASE_SENSITIVE
v10.0—April 2004
• Released as FLEXnet Licensing
• Support for fully qualified domain names
v10.1—November 2004
• Additional FLEXid driver support for USB dongles
v10.8—April 2005
• IPv6 address support for hostids
• Enhanced three-server redundant configuration support
• Support for common vendor daemons
FLEXnet Licensing End User Guide 155
Appendix I - FLEXnet Licensing Versions
Third Party License Agreements
Third Party License Agreements
Part of the software shipped with the FLEXnet Licensing toolkit to enable the FLEXnet
Fulfillment API is protected by the following third party copyrights:
•
The Apache Software Foundation
This product includes software developed by the Apache Software Foundation
( http://www.apache.org/ ). Copyright (c) 2000 The Apache Software Foundation. All rights reserved.
•
This product includes software developed by the OpenSSL Project for use in the OpenSSL
Toolkit. ( http://www.openssl.org/ ). Copyright (c) 1998-2003 The Open SSL Project. All rights reserved.
•
This product includes cryptographic software written by Eric Young ( [email protected]
).
Copyright (c) 1995-1998 Eric Young ( [email protected]
). All rights reserved.
•
Part of the software embedded in this product is gSOAP software. Copyright (c) 2001-2003
Robert A. van Engelen, Genivia Inc. All rights reserved.
The Apache Software Foundation
Version 1.1 Copyright (c) 2000 The Apache Software Foundation. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. The end-user documentation included with the redistribution, if any, must include the following acknowledgment: “This product includes software developed by the Apache
Software Foundation ( http://www.apache.org/ ).” Alternately, this acknowledgment may appear in the software itself, if and wherever such third-party acknowledgments normally appear.
4. The names “Apache” and “Apache Software Foundation” must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact [email protected]
.
5. Products derived from this software may not be called “Apache”, nor may “Apache” appear in their name, without prior written permission of the Apache Software Foundation.
156 FLEXnet Licensing End User Guide
Appendix I - FLEXnet Licensing Versions
Third Party License Agreements
THIS SOFTWARE IS PROVIDED “AS IS” AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.
This software consists of voluntary contributions made by many individuals on behalf of the
Apache Software Foundation. For more information on the Apache Software Foundation, please see http://www.apache.org/ . Portions of this software are based upon public domain software originally written at the National Center for Supercomputer Applications, University of Illinois, Urban-Champaign.
The Open SSL Project
Copyright (c) 1998-2003 The OpenSSL Project. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software must display the following acknowledgment: “This product includes software developed by the OpenSSL
Project for use in the OpenSSL Toolkit. ( http://www.openssl.org/ )”
4. The names “OpenSSL Toolkit” and “OpenSSL Project” must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact [email protected]
.
5. Products derived from this software may not be called “OpenSSL” nor may “OpenSSL” appear in their names without prior written permission of the OpenSSL Project.
6. Redistributions of any form whatsoever must retain the following acknowledgment: “This product includes software developed by the OpenSSL Project for use in the OpenSSL
Toolkit ( http://www.openssl.org/ )”
FLEXnet Licensing End User Guide 157
Appendix I - FLEXnet Licensing Versions
Third Party License Agreements
THIS SOFTWARE IS PROVIDED BY THE OPENSSL PROJECT “AS IS” AND ANY
EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OPENSSL
PROJECT OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
This product includes cryptographic software written by Eric Young ( [email protected]
).
This product includes software written by Tim Hudson ( [email protected]
).
Eric Young
Copyright (c) 1995-1998 Eric Young ( [email protected]
) All rights reserved.
This package is an SSL implementation written by Eric Young ( [email protected]
). The implementation was written so as to conform with Netscape’s SSL. This library is free for commercial and non-commercial use as long as the following conditions are adhered to. The following conditions apply to all code found in this distribution, be it the RC4, RSA, leash,
DES, etc., code; not just the SSL code. The SSL documentation included with this distribution is covered by the same copyright terms except that the holder is Tim Hudson
). Copyright remains Eric Young's, and as such any Copyright notices in the code are not to be removed. If this package is used in a product, Eric Young should be given attribution as the author of the parts of the library used. This can be in the form of a textual message at program startup or in documentation (online or textual) provided with the package.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software must display the following acknowledgement: “This product includes cryptographic software written by
Eric Young ( [email protected]
)” The word “cryptographic” can be left out if the routines from the library being used are not cryptographic related :-).
4. If you include any Windows specific code (or a derivative thereof) from the apps directory
(application code) you must include an acknowledgement: “This product includes software written by Tim Hudson ( [email protected]
)”
158 FLEXnet Licensing End User Guide
Appendix I - FLEXnet Licensing Versions
Third Party License Agreements
THIS SOFTWARE IS PROVIDED BY ERIC YOUNG “AS IS” AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.
The licence and distribution terms for any publicly available version or derivative of this code cannot be changed. i.e. this code cannot simply be copied and put under another distribution licence [including the GNU Public Licence.]
Genivia Inc.
Part of the software embedded in this product is gSOAP software.
Portions created by gSOAP are Copyright (C) 2001-2003 Robert A. van Engelen, Genivia inc.
All Rights Reserved.
THE SOFTWARE IN THIS PRODUCT WAS IN PART PROVIDED BY GENIVIA INC.
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.
FLEXnet Licensing End User Guide 159
Appendix I - FLEXnet Licensing Versions
Third Party License Agreements
160 FLEXnet Licensing End User Guide
Index
A
about this manual
ANY hostid
B
C
commands
COMPOSITE hostid
concurrent license
configuring FLEXnet licensing files
D
DAEMON line
debugging license server system 121
deployed FLEXnet Licensing files
FLEXid drivers
Mac OS X
SuSE Linux
Windows
FLEXnet Licensing End User Guide lmgr10.dll
lmgrd
lmtools.exe
lmutil
vendor daemon
diagnosing checkout problems troubleshooting
disabling lmdown
DISPLAY hostid
type
DUP_GROUP
E
enabling report log
environment variables
FLEXLM_BATCH
FLEXLM_DIAGNOSTICS
FLEXLM_TIMEOUT
LM_BORROW
LM_SERVER_HIGHEST_FD
error code
161
EXCLUDE_BORROW
expiration date
F
feature version
DUP_GROUP
expiration date
feature version
FLOAT_OK
HOST_BASED
HOSTID
license count
NOTICE
PLATFORMS
serial number
SIGN
signature
SN
START
syntax
TS_OK
USER_BASED
user_info
vendor_info
VENDOR_STRING
Feature line
SUITE_DUP_GROUP
FLEXid drivers
Mac OS X
162
SuSE Linux
Windows
FLEXLM_BATCH
FLEXLM_DIAGNOSTICS
level 1
level 2
level 3
FLEXLM_TIMEOUT
FLEXnet Licensing
configuration 19 getting started checklist 19 installing FLEXenabled applications 19
FLEXnet Licensing Programming and Reference
Guide
FLEXnet Manager
FLOAT_OK
floating license
G
GROUP type
H
HOST_BASED
HOSTID
hostid
COMPOSITE
ID
SERVER line
USER
FLEXnet Licensing End User Guide
I
INCLUDE
INCLUDEALL
installing FLEXenabled applications 19
INTERNET hostid
type
IPv6 address support
L
license
concurrent
floating
mixed
node-locked
license agreements, third party
license count
license directory
license file
compatibility between different versions 36
DAEMON line
decimal format
how to combine
overview
rereading after an update
SERVER lines
USE_SERVER line
with multiple servers
license pool
license rehosting
license request process
license server
install as Windows service
license server manager
license-file list
license-file list redundancy
LINGER
LM_BORROW
to reference multiple files 16
LM_SERVER_HIGHEST_FD
lmdiag syntax
troubleshooting
lmdown disabling
restricting access
syntax
lmgrd
compatibility between versions
overview
starting
starting automatically at boot time
syntax
FLEXnet Licensing End User Guide163
lmhostid syntax
lminstall
syntax
lmnewlog, syntax
lmremove disabling
restricting access
syntax
lmreread restricting access
syntax
lmstat output for lmreread
syntax
lmswitchr, syntax
lmutil
lmdown
lmstat
lmswitch
lmver
M
MAX
MAX_BORROW_HOURS
MAX_OVERDRAFT
memory usage, daemons
mobile licensing
164
node-locked to FLEXid 93 node-locked to laptop 93
prepaid license pool fulfillment
N
network bandwidth and FLEXnet Licensing
node-locked license
NOTICE
O
options file
creating
DISPLAY type
examples
EXCLUDE_BORROW
GROUP type
INCLUDE
INCLUDEALL
INTERNET type
IPv6 addresses
LINGER
MAX
MAX_BORROW_HOURS
overview
PROJECT type
read by vendor daemon
REPORTLOG
FLEXnet Licensing End User Guide
RESERVE
rules of precedence
TIMEOUT
TIMEOUTALL
options file path
order of lines in license file 28, 120
P
SIGN
signature
syntax
package suite
PLATFORMS
port number
VENDOR line
precedence or FEATURE lines
preface
PROJECT type
R
redundant servers
separate license files
SERVER lines
rehosting, license
remote disks, guidelines for using 40 report log file 40
REPORTLOG
RESERVE
restricting access lmdown
S
SERVER line
default port numbers
host
hostid
port number
syntax
setting environment variables
SIGN
signature
SN
sockets
number used by license server 39
specifying location of license file 23
START
SUITE_DUP_GROUP
switching debug log lmswitch
switching report log
T
term
third party license agreements
TIMEOUT
TIMEOUTALL
troubleshooting with FLEXLM_DIAGNOSTICS
with lmdiag
TS_OK
FLEXnet Licensing End User Guide165
U
USE_SERVER line
USER_BASED
user_info
user_info= 114
V
vendor daemon
overview
vendor daemon name
VENDOR line
VENDOR line
options file path
port number
110 vendor daemon name 110 vendor daemon path 110
vendor_info
VENDOR_STRING
166 FLEXnet Licensing End User Guide
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
Related manuals
advertisement