FLEXNET LICENSING END USER GUIDE Version 10.
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.
Contents Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix About This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Versions of FLEXnet Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Related Documents from Macrovision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
One Machine with Multiple License Server Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . One Machine with One License Server System and Multiple License Files . . . . . . . . . . . . . . . . Managing Multiple License Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Additional Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Combining license files . .
RESERVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TIMEOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TIMEOUTALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How the Vendor Daemon Uses the Options File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 8 Mobile Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Node-Locked to a Laptop Computer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Node-locked to a FLEXid (Windows Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Node-Locked to a FLEXid with FLOAT_OK (Windows Only) . . . . . . . . . . . . . . . . . . . . . . . . . Initiating FLEXid with FLOAT_OK . . . .
Appendix E FLEXnet Licensing Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129 Error Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 Format 1 (short): . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 Format 2 (long—version 6.0+): . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
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.
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.
Introduction and Overview Chapter 1 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.
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. Chapter 4, “Selecting License Server Machines” Resources required by the servers; multiple servers; quorums; redundant license server systems.
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.
Chapter 1 - Introduction and Overview FLEXnet Licensing Components Figure 1-1 shows the relationship these FLEXnet Licensing components have to one another. See “Component Overview” for a description of each component.
Chapter 1 - Introduction and Overview FLEXnet Licensing Components Figure 1-2 shows this model. See “Component Overview” for a description of each component. Your Application Code FLEXnet Licensing Client Library FLEXenabled Application License File(s) Figure 1-2: FLEXnet Unserved License Component Model The FLEXenabled application and license certificate reside on the same machine.
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.
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.
Chapter 1 - Introduction and Overview The License Request Process Table 1-1: FLEXnet Licensing Components for End-User Distribution Component Description FLEXidInstaller.exe Required if vendor supports FLEXid hostids on Windows platforms aksusbd-redhat-1.5-1.i386.rpm Required if vendor supports FLEXid hostids on Red Hat Linux version 8 and 9 platforms. aksusbd-suse-1.7-2.i386.rpm Required if vendor supports FLEXid hostids on SuSE Linux platforms. HDD_Linux.tar.
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.
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.
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.
Chapter 1 - Introduction and Overview Getting Started Checklist 22 FLEXnet Licensing End User Guide
License File Basics Chapter 2 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.
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. Table 2-1 shows some examples of LM_LICENSE_FILE and VENDOR_LICENSE_FILE environment variable settings.
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).
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.
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.
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.
Managing Licenses from Multiple Vendors Chapter 3 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.
Chapter 3 - Managing Licenses from Multiple Vendors Multiple Machines Multiple Machines Vendor ABC’s License File(s) Server Machine1 Vendor DEF Daemon Vendor DEF’s License File(s) Server Machine2... lmgrd Vendor XYZ Daemon License Server System Vendor ABC Daemon lmgrd License Server System lmgrd License Server System In this scenario, each distinct vendor daemon and its associated license file or files is located on a separate server machine.
Chapter 3 - Managing Licenses from Multiple Vendors One Machine with Multiple License Server Systems One Machine with Multiple License Server Systems Vendor DEF’s License Files Vendor XYZ Daemon Vendor XYZ’s License Files Single License Server Machine Vendor ABC’s License Files Vendor DEF Daemon lmgrd License Server System 3 Vendor ABC Daemon lmgrd License Server System 2 lmgrd License Server System 1 In this model, each vendor daemon and its associated license file or files is served by its
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 “Managing Multiple License Files.
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.
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 (“ ; ”).
Chapter 3 - Managing Licenses from Multiple Vendors Additional Considerations Figure 3-4 shows one possible scenario using a combined license file. Vendor DEF Daemon Vendor XYZ Daemon Combined License File Single Server Machine Vendor ABC Daemon License Server lmgrd 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.
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 Figure 3-4 and below in “How to Combine License Files.
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 Licensing Components” you are assured that all of your FLEXnet Licensing components are compatible.
Chapter 3 - Managing Licenses from Multiple Vendors Additional Considerations 38 FLEXnet Licensing End User Guide
Selecting License Server Machines Chapter 4 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.
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.
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.
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.
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.
Chapter 4 - Selecting License Server Machines 44 FLEXnet Licensing End User Guide
The Options File Chapter 5 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).
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.
Chapter 5 - The Options File Options File Syntax Table 5-1: Option Keywords (cont.) Option Keyword Description GROUPCASEINSENSITI VE Sets case sensitivity for user and host lists specified in GROUP and HOST_GROUP keywords. HOST_GROUP Define a group of hosts for use with any options (v4.0+). INCLUDE Allow a user to use a feature. INCLUDE_BORROW Allow a user to borrow BORROW licenses. INCLUDEALL Allow a user to use all features served by this vendor daemon.
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.
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.
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 Name of feature being affected. keyword=value Feature name modifier to denote a group of licenses. See “Feature Specification” for details. n Number of licenses that cannot be borrowed via license borrowing.
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 Name of the feature being affected. keyword=value Feature name modifier to denote a group of licenses. See “Feature Specification” for details.
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.
Chapter 5 - The Options File Options File Syntax Table 5-2 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 Options File FQDN_MATCHING exact FQDN_MATCHING lenient Application configured for FQDN — sends. myhost.abc.com Application not configured for FQDN — sends myhost HOST myhost no yes HOST myhost.abc.c om yes no HOST myhost yes yes HOST myhost.abc.
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 • “Type Specification” FLEXNET LICENSING VERSION NOTES • FQDN_MATCHING introduced in v9.3 client library and vendor daemon.
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 Name of the group being defined. Host group names are case sensitive. host_list List of host names in that group. Names are case sensitive. Set the GROUPCASEINSENSITIVE options file keyword to turn on case insensitivity.
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.
Chapter 5 - The Options File Options File Syntax name Name of an item of type type for which license usage is included. group_name 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.
Chapter 5 - The Options File Options File Syntax feature Feature this limit applies to. keyword=value Feature name modifier to denote a group of licenses. See “Feature Specification” for details. type One of USER, HOST, DISPLAY, INTERNET, PROJECT, GROUP, or HOST_GROUP. See “Type Specification” for details. name Name of an item of type type for which usage is limited. group_name Name of the group to limit.
Chapter 5 - The Options File Options File Syntax keyword=value Feature name modifier to denote a group of licenses. See “Feature Specification” for details. num_lic 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.
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 Number of license to reserve for this user or group. feature Feature or package this reservation applies to.
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.
Chapter 5 - The Options File Rules of Precedence in Options Files FLEXNET LICENSING VERSION NOTES • 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.
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.
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.
The License Server Manager Chapter 6 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.
Chapter 6 - The License Server Manager Starting the License Server Manager on UNIX Platforms -2 -p 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.
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.
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.
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.
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.
Chapter 6 - The License Server Manager Starting the License Server Manager on Windows 4. Click the Start/Stop/Reread tab. 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.
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.
License Administration Tools Chapter 7 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. Table 7-1 lists these utilities. Table 7-1: License Administration Utilities Utility Description lmborrow Supports license borrowing. lmdiag Diagnoses license checkout problems.
Chapter 7 - License Administration Tools Running Administration Tools FLEXNET LICENSING VERSION NOTES • • • • 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.
Chapter 7 - License Administration Tools lmborrow FLEXNET LICENSING VERSION NOTES • 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.
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.
Chapter 7 - License Administration Tools lmborrow -c license_file_list Use the specified license file(s). In some configurations, the license file needs to be specified in order to return the license file early. -d display 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.
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 Diagnose the specified file(s). -n Run in non-interactive mode; lmdiag does not prompt for any input in this mode. In this mode, extended connection diagnostics are not available. feature Diagnose this feature only.
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 Use the specified license file(s). Note that specifying -c license_file_list license_file_list is always recommended with lmdown -vendor Shut down only this vendor daemon. lmgrd continues running. Requires v6.
Chapter 7 - License Administration Tools lmhostid See Also • “lmgrd Command-Line Syntax” for details about securing access to lmdown • “lmreread.” FLEXNET LICENSING VERSION NOTES • -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.
Chapter 7 - License Administration Tools lminstall Platform Independent Hostids -utf8 -user Current user name. -display 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. -hostname 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.
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.
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: Note -add 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.
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.
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.
Chapter 7 - License Administration Tools lmstat -all Note If more than one lmgrd is specified, instructs all lmgrds to reread. 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.
Chapter 7 - License Administration Tools lmstat -c license_file_list Uses the specified license file(s). -f [feature] Displays users of feature. If feature is not specified, usage information for all features is displayed. -i [feature] Displays information from the FEATURE/INCREMENT line for the specified feature, or all features if feature is not specified.
Chapter 7 - License Administration Tools lmswitch 27000 port TCP/IP port on server_host where license server system is running. 102 handle 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.
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.
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.
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.
Chapter 7 - License Administration Tools License Administration Tools—LMTOOLS for Windows 92 FLEXnet Licensing End User Guide
Mobile Licensing Chapter 8 8 End users often want to use applications on computers that do not have a continuous connection to a FLEXnet license server system.
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.
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.
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.
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 Today’s date in dd-mmm-yyyy format. Any checkouts done on this date create local borrow information.
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.
Chapter 8 - Mobile Licensing Node-locked to a User Name FLEXNET LICENSING VERSION NOTES • 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.
Chapter 8 - Mobile Licensing Fulfilled from a Prepaid License Pool 100 FLEXnet Licensing End User Guide
Hostids for FLEXnet Licensing-Supported Platforms Appendix A 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.
Appendix A - Hostids for FLEXnet Licensing-Supported Platforms FLEXnet Licensing Hostids Hardware Platform Hostid Type this command on the license server system: HP (32-bit and 64-bit platforms, nonItanium) 32-bit hostid uname -i and convert to hex, HP (64-bit Itanium machine getconf \ identification CS_PARTITION_ IDENT then prefix with “ID_STRING=” Mac OS X ethernet address or prepend with # ethernet address 778DA450 or #2005771344 ID_STRING=9c766319db72-d411-af620060b05e4c05 /sbin/ifconfig e
Appendix A - Hostids for FLEXnet Licensing-Supported Platforms Special FLEXnet Licensing Hostids Hardware Platform Hostid Type this command on the license server system: Example Windows ethernet address lmhostid 00B0A9DF9A32 Disk serial number DIR C: (look for “Volume Serial Number is”, and remove “-”) DISK_SERIAL_NUM= 3e2e17fd FLEXid parallel or USB port dongle lmhostid -flexid FLEXID=8-b28520b9 FLEXids are made available by your vendor.
Appendix A - Hostids for FLEXnet Licensing-Supported Platforms Special FLEXnet Licensing Hostids ID=n 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.
License File Format Appendix B 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.
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.
Appendix B - License File Format License File Syntax Field Description port 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.
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.
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.
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: 110 Field Description vendor Name of the vendor daemon used to serve some feature(s) in the file. This name cannot be changed by the administrator.
Appendix B - License File Format License File Syntax See Also • Chapter 5, “The Options File,” for further information regarding options file contents. FLEXNET LICENSING VERSION NOTES • 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.
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.
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 (“...
Appendix B - License File Format License File Syntax Table B-2: Vendor Supplied Attributes (cont.) Attribute Description HOSTID= 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 LicensingSupported Platforms,” for more information. "hostid1 [hostid2 ...
Appendix B - License File Format License File Syntax Table B-2: Vendor Supplied Attributes (cont.) Attribute Description TS_OK 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.
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.
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.
Appendix B - License File Format License File Syntax Table B-4: PACKAGE Line Fields (cont.) Field Description OPTIONS=SUITE 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.
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 FLEXNET LICENSING VERSION NOTES • 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.
Appendix B - License File Format License File Order See Also • “lminstall” for additional information on the lminstall command. FLEXNET LICENSING VERSION NOTES • 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.
Troubleshooting Guide Appendix C 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.
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.
Appendix C - Troubleshooting Guide FLEXLM_DIAGNOSTICS lm_checkout(feature, version, num_lic, queue_flag, ..., dupgroup_mask) where: feature The requested feature. version The requested version. The license file must contain a version >= the requested version. num_lic Number of licenses requested. Usually 1.
Appendix C - Troubleshooting Guide FLEXLM_DIAGNOSTICS 124 FLEXnet Licensing End User Guide
FLEXnet Licensing Environment Variables Appendix D 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.
Appendix D - FLEXnet Licensing Environment Variables Environment Variables FLEXLM_DIAGNOSTICS 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) FLEXLM_TIMEOUT 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.
Appendix D - FLEXnet Licensing Environment Variables Environment Variables LM_LICENSE_FILE or VENDOR_LICENSE_FILE FLEXnet Licensing End User Guide 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.
Appendix D - FLEXnet Licensing Environment Variables Environment Variables 128 FLEXnet Licensing End User Guide
FLEXnet Licensing Error Codes Appendix E 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.
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.
Appendix E - FLEXnet Licensing Error Codes Error Code Descriptions Table E-1: FLEXnet Licensing Error Codes (cont.) Error Code Description -14 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. -15 Cannot connect to license server system.
Appendix E - FLEXnet Licensing Error Codes Error Code Descriptions Table E-1: FLEXnet Licensing Error Codes (cont.) 132 Error Code Description -37 Duplicate selection mismatch for this feature. Obsolete with v8.0+ vendor daemon. -38 User/host on EXCLUDE list for feature. -39 User/host not on INCLUDE list for feature. -40 Cannot allocate dynamic memory. -41 Feature was never checked out. -42 Invalid parameter. -47 Clock setting check not available in vendor daemon.
Appendix E - FLEXnet Licensing Error Codes Error Code Descriptions Table E-1: FLEXnet Licensing Error Codes (cont.) Error Code Description -74 Attempt to read beyond end of license file path. -751 SYS$SETIMR call failed (VMS). -76 Internal FLEXnet Licensing error—please report to Macrovision Corporation. -77 Bad version number must be floating-point number with no letters. -82 Invalid PACKAGE line in license file. -83 FLEXnet Licensing version of client newer than server.
Appendix E - FLEXnet Licensing Error Codes Error Code Descriptions Table E-1: FLEXnet Licensing Error Codes (cont.) 134 Error Code Description -96 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). -97 The desired vendor daemon is down. 1) Check the lmgrd log file, or 2) Try lmreread. -98 This FEATURE line can’t be converted to decimal format.
Appendix E - FLEXnet Licensing Error Codes Error Code Descriptions Table E-1: FLEXnet Licensing Error Codes (cont.) Error Code Description -118 BORROW period expired. -119 lmdown and lmreread must be run on license server machine. -120 Cannot lmdown the server when licenses are borrowed. -121 FLOAT_OK requires exactly one FLEXid hostid. -122 Unable to delete local borrow info. -123 Returning a borrowed license early is not supported. Contact the vendor for further details.
Appendix E - FLEXnet Licensing Error Codes Error Code Descriptions Table E-1: FLEXnet Licensing Error Codes (cont.) 136 Error Code Description -148 Bad V80_SIGN signature. -149 Bad V81_LK signature. -150 Bad V81_SIGN signature. -151 Bad V81_SIGN2 signature. -152 Bad V84_LK signature. -153 Bad V84_SIGN signature. -154 Bad V84_SIGN2 signature. -155 License key required but missing from the license certificate. The application requires a license key in the license certificate.
Appendix E - FLEXnet Licensing Error Codes Error Code Descriptions Table E-1: FLEXnet Licensing Error Codes (cont.) Error Code Description -514 No certicom module available. -515 Wrong or incomplete certicom module. -516 SIGN or SIGN2 required in license certificate. -517 Feature object has no license sources. -518 An Identical license is already checked out on this license source. -519 This license has an asynchronously-queued checkout pending.
Appendix E - FLEXnet Licensing Error Codes Error Code Descriptions 138 FLEXnet Licensing End User Guide
The Report Log File Appendix F 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 Log File.” 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.
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 “REPORTLOG” for more details. • Invoke lmswitchr on the vendor daemon. See “lmswitchr” for more details.
The Debug Log File Appendix G 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 Log File.” 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.
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 “DEBUGLOG” for more details. • Invoke lmswitch on the vendor daemon. See “lmswitch” for more details.
Appendix G - The Debug Log File Debug Log Messages Informational Messages Message Description Connected to host This daemon is connected to its peer on host. CONNECTED, master is host The license daemons log this message when a quorum is up and everyone has selected a master. DENIED: num_lic feature to user user was denied access to num_lic licenses of feature. EXITING DUE TO SIGNAL nnn EXITING with code nnn All daemons list the reason that the daemon has exited.
Appendix G - The Debug Log File Debug Log Messages Message Description Retrying socket bind (address in use) The license server systems try to bind their sockets for approximately six minutes if they detect “address in use” errors. Selected (EXISTING) master host. This license daemon has selected an existing master host as the master. SERVER shutdown requested. A daemon was requested to shut down via a usergenerated kill command.
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 The specified feature name has a bad license key or signature. It was probably typed in wrong, or modified by the end user. CANNOT OPEN options file file The options file specified in the license file could not be opened.
Appendix G - The Debug Log File Debug Log Messages Message Description Unknown host: host 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 Description accept: message An error was detected in the “accept” system call. Can’t allocate server table space A malloc error. Check swap space. Connection to host TIMED OUT The daemon could not connect to host.
IPv6 Support in FLEXnet Licensing Appendix H 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.
Appendix H - IPv6 Support in FLEXnet Licensing Using IPv6 Addresses in the Options File Table H-1: Client/Server Compatibility Matrix FLEXnet License Server Machine FLEXenabled Application Machine IPv4-only Use IPv4 addresses only. IPv4-only Dual Stack, uses IPv4 address only Dual Stack, uses both IPv4 and IPv6 addresses Dual Stack, uses IPv6 address only Dual IPv4/IPv6 Stack Use IPv4 addresses only. Not supported. IPv6-only No server Not supported. Use IPv4 addresses only.
Appendix H - IPv6 Support in FLEXnet Licensing Using IPv6 Addresses in the Options File for further information. FLEXNET LICENSING VERSION NOTES • IPv6 address support introduced in FLEXnet Licensing v10.8.
Appendix H - IPv6 Support in FLEXnet Licensing Using IPv6 Addresses in the Options File 150 FLEXnet Licensing End User Guide
I FLEXnet Licensing Versions Appendix I 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.
Appendix I - FLEXnet Licensing Versions Version Summary >= Version 5 SUPERSEDE, ISSUED, USER_BASED, HOST_BASED, or SN appear. >= Version 6 START appears. >= Version 7.1 SIGN= keyword appears. >= Version 8 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.
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.
Appendix I - FLEXnet Licensing Versions Version Summary • • • • • • • • • • • • • • • FLEXlm license directory support: *.
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.
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.
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.
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.
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.
Appendix I - FLEXnet Licensing Versions Third Party License Agreements 160 FLEXnet Licensing End User Guide
Index A about this manual ix ANY hostid 103 asdfasdf 157 asset_info 115 AUTH 112, 118 B BORROW_LOWWATER 50 borrowing 96 C commands x COMPOSITE hostid 103 concurrent license 26 configuring FLEXnet licensing files 19 conventions x converting license formats 81 creating options file 45 D DAEMON line 111 debugging license server system 121 DEBUGLOG 50 decimal format licenses 81 DEMO hostid 103 deployed FLEXnet Licensing files FLEXid drivers Mac OS X 18 Red Hat Linux 18 SuSE Linux 18 Windows 18 FLEXnet Licens
EXCLUDE_BORROW 51 EXCLUDEALL 52 expiration date 112 F feature version 112 FEATURE line 111 asset_info 115 AUTH 112 dist_info 115 DUP_GROUP 113 expiration date 112 feature version 112 FLOAT_OK 113 HOST_BASED 114 HOSTID 113 ISSUED 114 ISSUER 114 license count 112 NOTICE 114 order of precedence 115 OVERDRAFT 114 PLATFORMS 114 serial number 114 SIGN 112 signature 112 SN 114 sort 115 sorting order 115 START 114 SUPERSEDE 114 syntax 116 TS_OK 114 USER_BASED 115 user_info 115 vendor daemon name 112 vendor_info 11
I ID hostid 104 INCLUDE 55 INCLUDE_BORROW 56 INCLUDEALL 56 INCREMENT line 111 installing FLEXenabled applications 19 INTERNET hostid 104 type 49 IPv6 address support 147 ISSUED 114 ISSUER 114 L license borrowing 96 concurrent 26 floating 26 mixed 27 mobile 93 network license 26 node-locked 27 license agreements, third party 156 license count 112 license directory 67, 68 license file compatibility between different versions 36 DAEMON line 111 decimal format 119 expected location 16 FEATURE line 111 format 2
use latest 151 lmhostid syntax 80 lmhostid, syntax 80 lminstall license file format 81 syntax 81 lmnewlog, syntax 82 lmremove disabling 66 restricting access 66 syntax 84 lmreread restricting access 66 syntax 85 lmstat output for lmreread 86 syntax 86 lmswitch, syntax 88 lmswitchr, syntax 89 LMTOOLS 18, 90 lmutil lmdiag 78 lmdown 79 lmhostid 80 lminstall 81 lmnewlog 82 lmremove 84 lmreread 85 lmstat 86 lmswitch 88 lmswitchr 89 lmver 90 lmver, syntax 90 M MAX 57 MAX_BORROW_HOURS 58 MAX_OVERDRAFT 58 memory u
RESERVE 60 rules of precedence 62 TIMEOUT 61 TIMEOUTALL 61 type argument 49 USER type 49 options file path 110 OPTIONS=SUITE 117 OPTIONS=SUITE_RESERVED 118 order of lines in license file 28, 120 OVERDRAFT 114 P PACKAGE line 116 AUTH 118 OPTIONS=SUITE 117 OPTIONS=SUITE_RESERVED 118 SIGN 118 signature 118 syntax 117 package suite 117 PLATFORMS 114 port number server default range 107 SERVER line 107 VENDOR line 110 precedence or FEATURE lines 115 preface ix PROJECT type 49 R redundant servers selecting serv
typographic conventions x U UPGRADE line, syntax 119 USE_SERVER line 111 USER hostid 104 USER type 49 USER_BASED 115 user_info 115 user_info= 114 V vendor daemon and redundant servers 67, 108 debug log file 142 lmnewlog 82 lmreread 85 lmswitchr 89 memory usage 40 options file 46 overview 15 uncounted licenses 43 VENDOR_LICENSE_FILE 127 version compatibility 65 vendor daemon name FEATURE line 112 VENDOR line 110 vendor daemon path 110 VENDOR line 109 options file path 110 port number 110 vendor daemon name
