System Administrator’s Guide
Copyright 2000, Rainbow Technologies, Inc. All rights reserved. http://www.rainbow.com All attempts have been made to make the information in this document complete and accurate. Rainbow Technologies, Inc. is not responsible for any direct or indirect damages or loss of business resulting from inaccuracies or omissions. The specifications contained in this document are subject to change without notice. Part Number 700619-001, Revision A Software releases 7.1 and later RAINBOW TECHNOLOGIES, INC.
Export Considerations Rainbow offers products that are based on encryption technology. This encryption technology is used solely to prevent unauthorized use of the protected software and for client authentication, and is not used to provide security of end user data. The Bureau of Export Administration (BXA) in the U.S. Department of Commerce administers the export controls on Rainbow’s commercial encryption products.
iv SentinelLM System Administrator’s Guide
Contents 1 Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii Note for Stand-alone Application Users . . . . . . . . . . . . . . . . . . . . . . . . . xiii Note for Networked Application Users . . . . . . . . . . . . . . . . . . . . . . . . . xiii About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xv Typographic Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv Syntax Conventions . . . . . . . . . . . .
Using the SentinelLM Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Chapter 2 - Configuring the License Server. . . . . . . . . . . . . . . . . . . Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Additive and Exclusive License Codes . . . . . . . . . . . . . . . . . . . . . . . . Location of the Applications and License Servers . . . . . . . . . . . . . . . . . . Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Configuring the License Server Client. . . . . . . . . . . . . . . . . . . . . . . . . . .32 Check the Network Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Locate the License Server Computer. . . . . . . . . . . . . . . . . . . . . . . . . . 33 Test the “Broadcast Method” of Locating a License Server . . . . . . . . . . . . . .
What Does WlmAdmin Do? . . . . . . . . . . . . . . . . . . . Creating or Editing the Redundant License File . . . . . . . Creating or Editing the Reservation File . . . . . . . . . . . Monitoring License Servers and Licenses . . . . . . . . . . Using lspool to Maintain a Redundant License Server Pool . . . . Logging Events. . . . . . . . . . . . . . . . . . . . . . . . . . Sample Uses of lspool . . . . . . . . . . . . . . . . . . . . . .
WlmAdmin - Administer License Management Activities . . . . . . . . . . . . . . . .96 What Does WlmAdmin Do? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Monitoring Licenses and License Servers . . . . . . . . . . . . . . . . . . . . . 97 Editing the Reservation File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Editing the Redundant License File . . . . . . . . . . . . . . . . . . . . . . . . . 98 Shutting Down the License Server . . . . . . . . . . . . . . . . . . . . . .
Including/Excluding Users or Computers. . . . . . . . How the Reservation File Works . . . . . . . . . . . . Reservation File Characteristics . . . . . . . . . . . Editing the Reservation File on Windows (WlsGrMgr) Manually Editing the Reservation File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 . 116 . 116 . 117 .
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SentinelLM System Administrator’s Guide xii
Preface 0 Welcome to the SentinelLM License Management system which protects the application you are using. SentinelLM may limit, track, or meter application use depending upon the unique requirements of your software license agreement.
Note for Networked Application Users xiv • Configure SentinelLM with environment variables. • Exclude or reserve licenses for users and groups of users. • How to set up e-mail or script alert messages.
About This Guide About This Guide This guide gives all the steps for maintaining SentinelLM. Chapter/Appendix Description “Chapter 1 - Getting Started” Introduces license management and discusses how to obtain a new license from your vendor. “Chapter 2 - Configuring the License Server” Explains how to install and configure a SentinelLM license server.
Getting Help Syntax Conventions The following syntax conventions are used throughout this guide: Convention Purpose [] Square brackets enclose optional syntax. ... Ellipses indicate that a clause can be repeated. | A pipe indicates that only one of the syntax choices it separates may be used. {} Curly braces indicate that one of the options they enclose must be used in actual syntax.
Chapter 1 - Getting Started 1 This chapter contains basic information of interest to anyone who uses or administers software that has been protected using SentinelLM. If your vendor has referred you to this manual, this is the chapter that you will want to read first. Basic Concepts This section contains information on basic concepts you will need to know about to administer licenses on your stand-alone or network computer.
Basic Concepts License Codes SentinelLM captures your license rights in electronic form. These are stored as digital data called a license code. The license code indicates the maximum number of concurrent users of the application, on which computers it can be run, and the license expiration date, if there is one. License codes are stored in a file that is accessible to the SentinelLM software called the license file. Multiple license codes may be stored in a single license file.
Basic Concepts lects this information and outputs a locking code that is a number based upon the collected information. You provide this locking code to your vendor using a telephone or the Internet and your vendor produces a license code that specifies all authorized uses and includes the locking code. Stand-alone or Networked Licensing A protected application can be licensed to run on a single computer without using a computer network.
Software Activation for Stand-alone Applications Advantages of Network Licensing A network license adds many capabilities to license management. The following is a quick summary for the network administrator: 1. A network license server, by centralizing license use, allows you to keep track of how much an application is being used. (The license server usage log contains a record of each license transaction.) 2.
Software Activation for Stand-alone Applications without a license code. To obtain a license code, your vendor may require that you provide locking codes for all computers that it will run on. Your vendor will use this information to create the license codes that SentinelLM needs to authorize use of the protected application. Your vendor will then give you the license code along with instructions on how to install it.
Getting Your Computer’s Locking Code 1. Contact your vendor following the instructions supplied. (Depending on your vendor, this may be by telephone or via the Internet.) 2. The vendor may tell you that a new license code has already been shipped with the application, and all you need to do is to install it. In this case, skip to the instructions in step #5, below. 3. If your vendor tells you a new license code is required, your vendor will probably ask you to get the locking code of your computer.
Installing License Codes You use the SentinelLM echoid utility to get the computer’s locking code. Your application vendor will provide you with instructions telling you what the locking code requirements and procedures are. Sometimes your vendor will ask that you provide two different locking codes for a computer. This can be done to allow you to change the configuration of that computer sometime in the future. Your vendor may have provided a Computer ID key.
Software Activation for Network Licensing Using lslic to Install a License Code If the application has not been configured to install the license code itself, you will need to use the lslic utility to install the license code you have obtained from your vendor. Note Installing a stand-alone license is simple. If you don’t want to use lslic, you can use a text editor to open the lservrc file; then, just type the license code into that file on its own line. Your vendor should have placed the lslic.
Getting Your License Server Computer’s Locking Code You may also be asked to provide a locking code for the computer that will run the license server. (For even greater security, your vendor may also ask you for locking codes for the computers that will run the protected application.) Getting Your License Server Computer’s Locking Code The procedure for getting a license server computer’s locking code is the same as for a stand-alone computer (discussed above).
Installing Network License Codes tool (or Wrlftool) SentinelLM utility may be used to install the license code on a Windows or UNIX computer. Note If a network license code is intended for use on a redundant license server, it is called a redundant license. Redundant license codes are installed differently than other types of license codes. See below.
Installing Network License Codes Installing a Redundant License Code Note In addition to providing license server backup, redundant license servers provide license balancing, which permits you to to spread the load of license acquisition over multiple license servers. For example, suppose a license code allows 15 concurrent users of the protected application. (Each authorization to use the license is called a token. In this case, the license code contains 15 tokens.
Using the SentinelLM Utilities where server is the host name, IP address, or IPX address of the license server, and tokens is the number of license tokens you want to allocate to that server. Separate each server’s allocation with a ^ symbol. If you do not include the license code after the -Ad option, lslic asks you for it.
Using the SentinelLM Utilities of these utilities give information on license use or status and may be used by anyone. These utilities are described in “Chapter 5 - Administrator Commands” on page 77.
Using the SentinelLM Utilities 14 Chapter 1 - Getting Started
Chapter 2 - Configuring the License Server 2 This chapter describes how to start up and configure a license server. A license server is required when the protected application uses network license codes. Note A redundant license server pool contains one or more license servers that are called redundant license servers. You can use redundant license servers to provide your network with license balancing and license server backup.
Overview license codes in a single license file. You generally add license codes to the license file by using the lslic utility. Additive and Exclusive License Codes License codes are either additive or exclusive. There can be multiple exclusive license codes per product in the license file. Only the last exclusive license code added to the file is used by the license server, if exclusive licenses are used. All other license codes, additive or exclusive, are ignored by the license server.
Overview Location of the Applications and License Servers The protected application is installed separately on each client computer. The license server can be installed and run on multiple computers. In this type of installation, the application running on a client may choose any available license server with a valid license code for that client. It’s possible to install the protected application and the license server on the same computer.
Performance Notes Performance Notes High performance is always a consideration on a busy network. There are several things you can do to optimize the speed with which licenses are acquired by your network users, and to speed up the use of SentinelLM utilities: • The computers on which license servers run should use static IP addresses rather than dynamically allocated IP addresses (DHCP). In fact, redundant license server computers must use static IP addresses.
License Authorization Process which SentinelLM has defined a specific environment variable are set. Finally, any options that are provided in the LSERVOPTS environment variable are set. Many of the license server options can be set using all three methods. When a setting is made using more than one method, the later methods override any settings made by an earlier method. This flexibility helps in some situations, but in general it isn’t needed.
License Authorization Process Step 3: Client Identifies License Server If the application supports network licensing, when it is started it first tries to identify a license server. This is how it looks for a license server: • If the LSFORCEHOST environment variable is set, the application looks for the specific license server host listed in that variable. If it cannot find that computer, an error message is displayed, and the application cannot run.
License Authorization Process network address of the license server computer. The application sends a license request to this address and the license server’s port. Step 5: License Server Responds When a license server receives a license request, it checks to see if a license can be granted based upon the current license codes. If it can, then an authorization is sent back to the client computer. Otherwise, the request is rejected and a denial is sent back to the client computer.
Configuring the License Server Step 9: License Server Releases License When the license server receives the license authorization back, it makes it available again to another user. Configuring the License Server If your application is being used with a network license then your vendor will provide you with a copy of the license server program and installation instructions. After you have installed the license server, you can then configure the license server options.
Configuring the License Server them in an alternate manner you should read “Appendix A - Using Environment Variables to Configure a License Server” on page 123 and “lserv, lserv9x, lservnt - Start the License Server” on page 82 of “Chapter 5 - Administrator Commands.” Please see those sections for a list of all the options available to you when you start up a license server. Setting the License File The license server must have read-access to a file that stores license codes.
Configuring the License Server Information is recorded in the log file one entry per line in the following format: Element Description Server-LFE Customer-defined log file encryption level as specified by the license server -lfe option. License-LFE Vendor-defined log file encryption level. If this is non-zero, it overrides the Server-LFE. Date The date the entry was made, in the format: Day-of-week Month Day Time (hh:mm:ss) Year Time-stamp The time stamp of the entry.
Configuring the License Server Here are what the fields in the first entry mean, reading from left to right: Field Description 2 (Server-LFE) Customer-defined log file encryption is set to level 2. 0 (License-LFE) 0 means the vendor set the log file encryption to customerdefined. Fri Aug 13 17:33:33 1999 (Date) Date the license transaction was made. 934590813 (Time-stamp) Time-stamp of the transaction record. 99 v (Feature/Ver) Feature name 99 and no version. 0 (Trans) License was granted.
Configuring the License Server how much each application is being used. If you don’t have much disk space, you can restrict the size of the log. You should enable logging and set the log file name and location. A typical log file name is lserv.log. • It’s best to use the -z option to specify the maximum size limit for the log file and to leave enabled automatic backup of the log file. You may want to set the maximum size of your log file fairly high to minimize the number of backup files created.
Configuring the License Server level, use the -lfe license server startup option and specify a number from 1 to 4, where: Note Encryption Level Description 1 No encryption. 2 No encryption. Transaction data will be readable, but tampering with or deleting an entry will be detected by lsusage. This is the default encryption level if you do not specify one (and if your vendor has not set an encryption level for your license codes). 3 Encrypt usage only.
Starting the License Server Setting License Server Quiet Startup The license server normally displays a message upon program startup. This display can be suppressed if desired. Recommended setting: By default, the startup message is enabled. We recommend you leave the message enabled. Starting the License Server License server installation and startup vary depending upon the operating system on the license server computer.
Starting the License Server Windows NT/2000 User Privileges Any user who has administrator privileges may start the license server and may also configure the license server (e.g., turn token borrowing on and off, change token distribution, turn logging on and off, and add or delete a redundant license server) regardless of who started it.
Starting the License Server System Requirements If you are using network licensing, a supported network protocol is required on the target machine. Windows NT/2000 Service The license server installation is done using the loadls utility. This utility may be run explicitly or as part of an installer program. This program is described in “loadls - Install the License Server as an NT/2000 Service” on page 81 of “Chapter 5 - Administrator Commands.
Starting the License Server Windows NT/2000 Event Logging For errors, look under Applications in the NT Event Logger. This log can be viewed using the Windows NT/2000 Event Viewer in the Administrative Tools group. After starting the Event Viewer, click the Log menu and select Application to view messages logged by the SentinelLM license server. Windows 95/98 License Server A Windows 95/98 license server can be configured to be started automatically when Windows 95/98 starts or to be started manually.
Configuring the License Server Client NetWare IPX clients can be served by a Win32 server (lserv9x.exe or lservnt.exe) running on Windows 9x or Windows NT/2000 systems. This does not require an NLM or running any application on the NetWare server. UNIX The license server, lserv, is placed in an appropriate directory and appropriate file permissions are set. The execution permission must be set so that only authorized users may execute the license server.
Configuring the License Server Client To verify that TCP/IP is used on a Windows 95/98 or Windows NT 4.0/Windows 2000 computer: 1. From the Control Panel, double-click the Network icon. 2. On the Configuration tab (or Protocols tab on Windows NT/2000), look at the list of Network components installed to see if TCP/IP is listed. 3. Select the TCP/IP component and then bring up the Properties dialog box. Check the subnet mask.
Configuring the License Server Client Test the “Broadcast Method” of Locating a License Server You can test the configuration using the following steps: 1. Verify the LSHOST and LSFORCEHOST environmental variables aren’t set and there isn’t an LSHOST or lshost file in the same directory as the protected application. 2. Run either the lswhere or WlmAdmin utilities on the client computer.
Configuring the License Server Client 2. If you can ping a license server when you specify its address by number but can’t do this when you specify the address as a name, then your client computer has a problem with network domain name resolution. In this case you can either solve this problem or just provide the numeric form of the address to SentinelLM. Of course, if your license server is dynamically assigned a numeric network address, you will have to solve the name resolution problem.
Configuring the License Server Client that the license server has a license that authorizes use of an application on the client computer.
Chapter 3 - Setting up Redundant License Servers and License Balancing 3 Redundant license servers and license balancing offer several important benefits to the network administrator: • Your end users can acquire license tokens even if a particular license server goes down (license server backup). • The speed with which an end user acquires a license token is optimized by distributing tokens among multiple license servers to reduce the traffic for a particular license server (license balancing).
Overview of License Balancing and Redundant License Servers pool can take over for any other if one of the license servers goes down. Each license server runs on a separate computer on the network. Imagine a wide-area network serving three basic groups of end users: the Sales Department, the Engineering Department, and the Accounting Department. Computers on this network might be in the same building, or might be in different cities or countries.
Overview of License Balancing and Redundant License Servers Figure 3-1: Sample Redundant License Server Pool Network Connections License Server Accounting 20 tokens License Server Sales 20 tokens License Server Engineering 20 tokens Subnet #A Subnet #B Subnet #C Total of 60 license tokens in the pool Note that the license server computers do not have to be on the same subnet— license servers can be in geographically separate locations on subnets connected to one another via WAN, Internet, or dial
Overview of License Balancing and Redundant License Servers You may also choose to configure the license servers so that only one is active and the others are solely backup license servers. In this case, all of the license tokens should be allocated to just a single license server and license balancing turned off. Then the other license servers would only be used if the main license server went down.
Overview of License Balancing and Redundant License Servers By default, the leader is the first license server in the pool you start up. However, Wrlftool or rlftool can be used to set the priority order of the license servers. If the leader redundant license server goes down, the next highest-priority redundant license server becomes the leader in turn.
Overview of Setting up Redundant License Servers many are in the free pool by using WlmAdmin or lspool.) The free pool is a temporary storage location for license tokens. Tokens are placed in the free pool when you do not allocate all license tokens for a feature/version to the redundant license servers; leftover tokens go into the free pool. As license balancing occurs, license tokens will be automatically redistributed from the free pool to the redundant license server requesting tokens.
Overview of Setting up Redundant License Servers network performance, affect this decision. If you want the license servers to be locked to specific computers, you must give your vendor the locking code for each computer on which a redundant license server will be installed. Your vendor includes the computer locking code when defining the license code. 2.
Overview of Setting up Redundant License Servers When using the SentinelLM utilities, you must have administrator privileges on Windows NT or Windows 2000, be logged into the root on UNIX, or be the user who started the license server on Windows 95/98 to: • Change distribution criteria. • Shut down the license server (and on Windows NT/2000, if user name Administrator started the license server, only user name Administrator can shut it down using lsrvdown). • Turn license server logging on and off.
Overview of Setting up Redundant License Servers Using Reservation Files You may use reservation files to reserve license tokens for particular users or groups of users. The reservation file applies to a specific license server, and may not reserve more than the total number of tokens initially allocated to that license server.
Setting up the Redundant License Server Pool are used to turn borrowing off on a specific license server for a particular license code feature/version or all feature/versions. Wrlftool (for Windows) or rlftool (for Windows or UNIX) is used to define the borrowing threshold, the percentage of license tokens that, when consumed, will trigger borrowing from another license server in the pool.
Setting up the Redundant License Server Pool 1. First, install (but don’t run) the license servers on different computers on the network. Note that these license servers must be the same version, at least SentinelLM version 7.0. 2. Next, set each client to access the preferred license server for that client by setting the LSHOST or LSFORCEHOST environment variables on that client’s computer.
Setting up the Redundant License Server Pool environment variable and allow the client to broadcast for an available license server.) 3. If your vendor has specified that the license servers will be locked to specific computers, you will need to run echoid on each computer and record the locking code. You should also record the host name of each computer and its IP or IPX address.
Setting up the Redundant License Server Pool 8. Since this is the first time that the redundant license server pool has been set up, you need to copy the redundant license file to each of the computers on which the redundant license servers resides. (After this, changes to any one of the redundant license files will automatically be transmitted to each redundant license server when one of the license servers is stopped and restarted.) 9. Bring up each of the license servers in the pool.
Redundant License Server Pool Utilities Redundant License Characteristics A redundant license code may be additive or exclusive. If it is exclusive, it acts like any other exclusive license code. If it is additive, when it is installed it: • Overwrites any exclusive or additive non-redundant license code for the same feature/version. • Combines any redundant additive license codes for the same feature/version unless aspects of the older additive license codes differ in important respects.
Redundant License Server Pool Utilities Table 3-1: Redundant License Server Pool Utilities Summary (T = Temporary change in effect only until license server is stopped and restarted; P = Permanent change to redundant license file, I = Informational only, makes no changes) Utilities Function Create redundant license file Add/delete license servers to/from existing pool Add/delete license to/from pool and set initial distribution of tokens Set borrowing threshold lslic WlmAdmin/ lspool Wrlftool/ rlftool
Redundant License Server Pool Utilities The lslic command installs or deletes a license. If you do not include necessary information on the command line, lslic will ask for the missing information. When you enter a license code, if you are entering an encrypted license code, type only the characters before the # symbol. lslic can add or delete licenses without stopping and restarting the license server, but the change is temporary unless you use an option that makes the change to the license file.
Redundant License Server Pool Utilities Option Description -Fd filename Adds all license codes and distribution criteria in the file to the redundant license server and updates the redundant license file. (Change is permanent.) See below for information on the file format. -d feature version Deletes a feature/version from the contacted license server. (Change is temporary until the license server is restarted.
Redundant License Server Pool Utilities #DIST_CRIT:Sales:5^192.160.2.101:5^Engr1:5 Using Wrlftool to Create or Edit a Redundant License File Wrlftool is a Windows-interface program that allows you to create and maintain a redundant license life.
Redundant License Server Pool Utilities Creating and Maintaining the Redundant License File 1. To create a new redundant license file, go to the File menu and select New. To edit an existing redundant license file, go to the File menu and select Open and then select the file.
Redundant License Server Pool Utilities 2. To add a new license server to the pool, click Add Server. You are then asked to type the host name and the IP or IPX address of the computer on which that license server resides. All license servers in the pool must use either IP or IPX to communicate, but you cannot mix the protocols. 3. Once you have added more than one license server to the pool, you can select one of the license servers and click Move Up or Move Down to adjust its order in the pool.
Redundant License Server Pool Utilities first license server in the pool to be started up becomes the leader by default, the preference order determines in what order the license servers will become the leader if license servers go down. 4. At any time you can select a license server and click Delete Server to delete it from the pool. Adding/Editing/Deleting Redundant Licenses 1. To add a redundant license to the pool, click Add License.
Redundant License Server Pool Utilities 3. The Edit License screen displays information about this license such as the feature/version licensed, how many license servers it is set up to use, and so on. This screen allows you to set the following information for this license: • 58 Borrowing threshold - This is the percentage of license tokens that, when consumed, will trigger borrowing from another license server in the pool.
Redundant License Server Pool Utilities • License distribution - You see a list of all license servers in the pool. You can choose which license servers will service this license by selecting the appropriate Include check boxes. For each license server you include, you can select how many tokens will initially be distributed to that license server. 4.
Redundant License Server Pool Utilities rlftool Or, to modify an existing redundant license file, type: rlftool -l redundant-license-file You then see a menu that lists the rlftool options. Type the number of the option you want to use and press Return. (At a minimum, you will want to use option 1 to create a new file, option 2 to add license servers to the pool, and then option 7 to add license codes.) To exit and save the file, type 12 and press Return.
Redundant License Server Pool Utilities Option Description -A license-code Add the specified license code to the redundant license file. Enclose the license code in quotation marks. You will be prompted for token distribution and for the threshold percentage. When this percentage of the total number of tokens has been consumed on any license server, token borrowing will occur. -F license-filename Add the license codes contained in the specified text file to the redundant license file.
Redundant License Server Pool Utilities started that license server or, on Windows NT/2000 and UNIX, you must have administrator privileges. What Does WlmAdmin Do? For full information on using WlmAdmin, see “WlmAdmin - Administer License Management Activities” on page 96 of “Chapter 5 - Administrator Commands.” Here is a brief summary of its functions.
Redundant License Server Pool Utilities Monitoring License Servers and Licenses You can also use WlmAdmin to: • Monitor license servers - See what license servers are running, and find out information about them. • Monitor licenses - See information on licenses on the license servers. You can see whether a license is a redundant license, can be used by commuters, how many tokens are in use, and how its tokens are distributed.
Redundant License Server Pool Utilities Note Tip When making changes to the redundant license server pool as a whole (for example, when adding or deleting license servers to the pool), for best performance we recommend you select the leader license server to make the changes to. If you are running on a Windows computer, you may find using the Windows-interface WlmAdmin program more convenient than using lspool. The lspool options are: Option Description -h (Help.) Displays list of lspool options.
Redundant License Server Pool Utilities Option Description -L event OFF|ON Disable or enable logging for the specified event. (Specify the number of the event you want to log from the list below.) Logging Events Note If you are using the lspool -L option to log events, you must be the person who started the license server or, on Windows NT/2000 and UNIX, you must have administrator privileges. Events that may be logged using the -L option are: 0 Log all events. 1 Log license server up.
Redundant License Server Pool Utilities Sample Uses of lspool To see what license servers are in the redundant license server pool: Use the lspool -p option. You see a list of the license servers as well as their status. Servers in Pool are : DISCOVERY EMERALD PLATINUM P3-ORION APOLLO - UP UP UP UP UP To See How Tokens Are Distributed for a Particular License Use the lspool -g option, specifying the license feature/version you are interested in.
Redundant License Server Pool Utilities The Distribution Criterion is: Units Allocation EMERALD PLATINUM DISCOVERY P3-ORION APOLLO FREE_POOL : : : : : : 1 1 18 17 1 0 Units Issued 0 0 18 0 0 Units Commuted 0 0 0 0 0 To Distribute Tokens for a Particular License Use the -c option to distribute tokens among the license servers for a particular feature/version. For example, to allocate 5 tokens each to the license servers Emerald, Platinum, and Discovery for feature 87 version 1.0: lspool -c 87 1.
Redundant License Server Pool Utilities 68 Chapter 3 - Setting up Redundant License Servers and License Balancing
Chapter 4 - Commuter Licensing 3 One of the most useful advantages of the SentinelLM license management system is that it provides commuter licensing, which allows you to temporarily use a protected application on a portable computer that is not connected to the network. The most common use of commuter licensing is when a user of your network needs to travel on business and wants to take along the protected application.
Before Your User Checks an Authorization In or Out server startup options.) This makes sure that commuter licensing doesn’t use up all of the license tokens needed by other users of the application on the network. Commuter Licensing Authorization Checkin Policy When checking out an authorization, the user may request authorization for a specific number of days (the default is 30).
Instructions for Your Network Users • Is connected to the network. • Has access to the Wcommute or lcommute utility. Wcommute is a Windows-interface utility (used in an MS-DOS command window); lcommute is a command-line utility for UNIX or Windows. Instructions for Your Network Users As the network administrator, you will want to give your network users instructions on how to check authorizations in and out. The following sections have been written aimed at your end users.
Instructions for Your Network Users 2. To find an authorization for the commuter license you want to use, click Search Subnet to see commuter licenses available on all license servers on your part of the network within the given subnet. Or, if there is a specific license server you want to search or want to select a license server outside of your subnet, click Single Server. If you click Search Subnet, you may need to wait a minute or two while Wcommute searches the subnet for license servers.
Instructions for Your Network Users 4. For each license server, you see a list of commuter licenses for which you can check out an authorization. If you see a red check mark next to a commuter license, that means that an authorization has already been checked out to your portable computer. You may not check out an authorization if it is already checked out. To check out an authorization, click once on a license to select it.
Instructions for Your Network Users of the application for other network users, so specify the minimum number of days that you need. Next click Check Out. Remember the name of the license server from which you obtained the authorization. You will need to check the authorization back into the same license server later. 5. To check in an authorization, look for the license under the license server from which you checked it out. Click once on it in the display to select it.
Instructions for Your Network Users Option Description -d:days Number of days the authorization will be checked out. Can be 1 to 30. (Only use when you are using the -c:o option.) Note that if you do not specify any command-line options, lcommute will interactively ask you for the information it needs.
Instructions for Your Network Users 76 Chapter 4 - Commuter Licensing
Chapter 5 - Administrator Commands 5 Your application may have been delivered with several SentinelLM administrator utilities which are used to install, configure, or to report on the license management system. Many of these utilities provide information but do not alter the license management system and may be run by an end user without administrative privileges or a detailed knowledge of SentinelLM. A description of these utilities is provided in this chapter.
Table 3-1: Summary of SentinelLM Administrator Utilities (Continued) Utility Description Where documented lserv, lserv9x, lservnt Starts the license server. “lserv, lserv9x, lservnt - Start the License Server” on page 82. Configuration information is also contained in “Appendix A - Using Environment Variables to Configure a License Server” on page 123 and “Chapter 2 - Configuring the License Server” on page 15. lslic Installs a license. You need the license code from your application developer.
echoid - Get a Computer’s Locking Code Table 3-1: Summary of SentinelLM Administrator Utilities (Continued) Utility Description Where documented WlmAdmin Used on Windows95/98 and NT/2000 computers for general SentinelLM administration. Can be used to monitor license server transactions. Gives information on license servers, licensed applications, and application users.
ipxecho - Display the IPX Network Address sends the locking code data to a text file named lock.txt in the directory from which you used echoid. Description An application or license server may be restricted to operation on certain com- puters. These restrictions are included in the license codes when they are created. Before a license code with any computer restrictions can be created by your vendor, you must get the locking code for your computer with the echoid program.
loadls - Install the License Server as an NT/2000 Service Who/Where Run by an administrative user on the computer containing the license server. Options None. Description Displays the IPX network address. When using the IPX network protocol, the license server host name must be the IPX address of the computer on which the license server resides. Use this utility to display that address.
lserv, lserv9x, lservnt - Start the License Server Who/Where Run from the operating system command prompt by an administrative or appli- cation user on a stand-alone, client, or license server computer. Options One of the following options may be supplied: Option Description -s license-file The name of the license file. If this is not specified, lsdecode uses the default file name, lservrc, in the current directory.
lserv, lserv9x, lservnt - Start the License Server Options Below is a list of the most commonly used options. For a complete list, see “LSERVOPTS - Set License Server Options” on page 126 of “Appendix A Using Environment Variables to Configure a License Server.” We recommend that you use the LSERVOPTS environment variable to make configuration changes to the license server, since options used at license server startup are in effect only until the license server is restarted.
lslic - Install/Delete a License Code Option Description -X install Install the license server service. -X start Start the license server service. -X stop Stop the license server service. -X status Get license server status. -X commline Start the license server service from the command line. If you use this option, it must be the first option on the command line. Description Starts the license server and sets various license server options.
lslic - Install/Delete a License Code Option Description -A license-code Adds a license code to the license server’s license file (lservrc) and communicates the change to the contacted license server. (Change is permanent.) -d feature version Deletes a feature/version from the contacted license server. (Change is temporary until the license server is restarted.) -f filename Adds all the license codes in the supplied file to the contacted license server without updating the license file (lservrc).
lslic - Install/Delete a License Code Description The lslic utility installs or deletes a license. If you do not include necessary information on the command line, lslic will ask for the missing information. When you enter a license code, if you are entering an encrypted license code, type only the characters before the # symbol.
lsmon - Monitor License Server Transactions lsmon - Monitor License Server Transactions Format lsmon [ Poll-interval_in_seconds ] [ Server-host ] Platform Windows 95/98, Windows NT/2000, UNIX. Who/Where Run from the operating system command prompt by an administrative or appli- cation user on a stand-alone, client, or license server computer. Options One of the following options may be supplied: Option Description Poll-interval_in_seconds Enable periodic update at indicated rate.
lsmon - Monitor License Server Transactions lsmon Display The information lsmon displays about the licenses on the license server depends on the license. In addition to basic information about the license, you can also see whether the license can be used as a commuter license or if it is a redundant license.
lsrvdown - Shut Down the License Server lsrvdown - Shut Down the License Server Format lsrvdown host-name Platform Windows 95/98, Windows NT/2000, UNIX. Who/Where Run from the operating system command prompt by an administrative user on a client or license server computer. On Windows 95/98, only the same user who started the license server can stop it. On UNIX, only the user logged in as “root” can use lsrvdown.
lsusage - Display the SentinelLM Usage Log File Options One or more of the following options must be specified:: Option Description -l log-file Selects the license server log file to display. Must be specified. If this is the only option, the summary will be displayed on the screen. -c CSV-format-file Specifies the name of an output file to which the output will be written in Comma-Separated Values (CSV) format.
lsusage - Display the SentinelLM Usage Log File Description lsusage displays a summary of application usage, providing information on license transactions contained in the license server usage file. See below for a sample. See Also “Setting Usage Logging” on page 23 of “Chapter 2 - Configuring the License Server.” Also see “License Server - Commonly Used Variables” on page 126 of “Appendix A - Using Environment Variables to Configure a License Server.
lsusage - Display the SentinelLM Usage Log File where: Element Description Feature name/Version Identifies the license for which this entry was made. %age Denied The percentage of requests for this license that were denied (usually because the hard limit of the license had already been reached), or if license queuing is enabled, this is the percentage of queued requests denied. %age Issued The percentage of requests for this license that were granted.
lsusage - Display the SentinelLM Usage Log File tem. (For information on creating reports from log file CSV-format output, see “Creating License Server Use Reports” on page 93.) Creating License Server Use Reports SentinelLM provides the ability on Windows computers to use Microsoft Access 97 to create graphical reports of license server use. To use this feature, you will need to use the lsusage -c option to create a comma-separated values (CSV) file from the license server log file.
lsusage - Display the SentinelLM Usage Log File 7. Select In an existing table and select the table Lservlog. (If instead of adding to an existing Lservlog table you want to create a new one, delete any rows that are already in the Lservlog table before importing new data.) 8. Click Finish. Don’t forget to keep the table name set to Lservlog. Creating Reports Once the log file use data is imported into the Lservlog table as discussed above, you can now create reports for that data. 1.
lswhere - Display a List of License Servers 2. You can now select the date range of the report by specifying Start Date and End Date. 3.
WlmAdmin - Administer License Management Activities Description Use lswhere to display the network names of the computers running the license server. By default, lswhere displays for each license server the address of the computer on which that license server is running as well as its host name. Example When using lswhere with the -d option you see the following information for each license server found on the network: Server Address: 10.10.32.
WlmAdmin - Administer License Management Activities WlmAdmin also performs a variety of administrative functions. See below for more information. See Also “Using WlmAdmin to Maintain a Redundant License Server Pool” on page 61 of “Chapter 3 - Setting up Redundant License Servers and License Balancing.” What Does WlmAdmin Do? WlmAdmin performs a variety of licensing administrative functions.
WlmAdmin - Administer License Management Activities Editing the Reservation File A reservation file defines groups of users or computers for whom license tokens can be reserved. The reservation file also can be used to exclude specific users or computers from using certain licenses. From the Edit menu of WlmAdmin, you can select the Reservation File command to call the WlsGrMgr utility to create a new reservation file or edit an existing one.
WlmAdmin - Administer License Management Activities about them. You can also see information about licenses on the license servers and the users who use them.
WlmAdmin - Administer License Management Activities Setting WlmAdmin Preferences You can choose what WlmAdmin displays when it starts. From the Edit menu, select the Preferences command: • To always show the license servers you have defined (see below), select the Discover defined servers on startup check box. • To automatically discover and display the license servers on your subnet, select Discover subnet servers on startup check box.
WlmAdmin - Administer License Management Activities To Create a List of Defined License Servers 1. Go to the Edit menu and select the Defined Server List command. 2. Type a license server name and click the Add button to add a server to the list. If you are not sure of the license server computer’s host name, you can wait for WlmAdmin to display license servers in the Subnet Servers area of the left-hand pane of the main window to see what license servers are available on the network. 3.
WlmAdmin - Administer License Management Activities To Add or Remove a License Server from the Defined Server List • Right-click the name of a license server in the left-hand pane of the main window. From the menu select Add to Defined List or Remove from Defined List. To Shut Down a License Server • Right-click the name of a license server in the left-hand pane of the main window. From the menu select Shutdown Server. To Add a License Code to the License Server from the Keyboard 1.
WlmAdmin - Administer License Management Activities until the license server is rebooted), select the Add feature to server’s file check box. 5. Click Add. To Add a License Code to the License Server from a File 1. Right-click the name of a license server in the left-hand pane of the main window. From the menu select Add Feature.
WlmAdmin - Administer License Management Activities specific license, see “To Disable/Enable Token Borrowing for a License” on page 107. License-Specific Actions The following actions affect individual licenses. To See Information on a License 1. In the left-hand pane of the main WlmAdmin window, click the + sign to the left of a license server to see what licenses it is servicing. (Once you have expanded the license server information, you can click the sign to collapse the information again.
WlmAdmin - Administer License Management Activities 3. Double-click a license to see if any users are using the license. (Once you have expanded the license information, you can click the - sign to collapse the information again.) Tip If a user symbol is red, that user is in a queue waiting for an available license.
WlmAdmin - Administer License Management Activities 4. Click the name of a user. In the right-hand pane of the display you see: user name and host name of the computer the user is on. If this user is in a reservation group, you see the name of the group. You also see information on how long the user has been using this license. To Delete a License from the License Server • 106 To delete a license from a license server, right-click the license name and select Remove Feature.
WlmAdmin - Administer License Management Activities To Change the Token Distribution for a License • Right-click a license name and select Change Distribution. (You can only use this function for a redundant license code.) You see a display something like this: For information on distributing tokens among redundant license servers, see “Chapter 3 - Setting up Redundant License Servers and License Balancing” on page 53.
WlmAdmin - Administer License Management Activities rowing on/off for all licenses on the license server, see “To Disable/ Enable Token Borrowing for a License Server” on page 103. Exiting WlmAdmin To leave WlmAdmin, go to the File menu and select Exit.
Chapter 6 - Setting User Options 5 The following advanced options are available for SentinelLM users: • Alerts • Group allocation An alert lets you know about license events, such as when a license reaches its expiration date. You specify alerts using a configuration file. There are seven alerts including hard and soft limits that can be generated. The reporting mechanisms are e-mail and script. For more information about alerts, see “Setting User Alerts” on page 109 below.
Setting User Alerts • License returned • License denied (occurs on the next request after the hard limit has been reached) • License time-out • License expiration date reached The alert reporting mechanisms are: • E-mail • Script Alert Specification To enable alerts, you need a configuration file with information on the license codes in the license code file. Configuration information can be readable license remap statements, alert action statements, etc.
Setting User Alerts The configuration file is broken into sections, headed by feature and version: [feature_name1 feature_version1] remap-statement-11 remap-statement-12 . . . alert-action-11 alert-action-12 . . . [feature_name2 feature_version2] remap-statement-21 remap-statement-22 . . . alert-action-21 alert-action-22 . . . For more detailed information about the configuration file format, contact your vendor.
Setting User Alerts • Note expired—License expiration date reached appstart and appstop may generate a lot of network traffic. An expired alert will occur when either condition occurs: • An expired license is added to the license server and the server does not already have an unexpired license for the same feature. • license expires due to passage of time.
Setting User Alerts One section of the file can specify only a single alert script and a single e-mail address. For all alerts enabled in one section, the same alert script will be invoked. SCRIPT SCRIPT will receive the following command-line arguments: SCRIPT alert-type feature,version user-name client-host-name limit If a certain argument is not applicable to the alert that occurs, the value NONE is passed in place of that argument.
Setting User Alerts Configuring E-mail Alerts for Windows On Windows computers, the license server calls the lsmail utility to send e-mail alerts using SMTP. Here is how to use lsmail: 1. Set up the alert information section of the license server configuration file and use the EMAIL statement to enable e-mail alerts. The file lsmail.exe should be in the directory in which the license server resides. 2. Run lsmail.
Setting Group Reservations • “/usr/ucb/mail” • “/usr/bin/mail” • “/bin/mail” If no program is found via search or MAILPGM, the e-mail mechanism will be off. The mail program will be invoked in a manner equivalent to: MAILPGM email-recipient-list text-of-alert-message No subject is provided. If your mail program accepts a subject via the -s option, you could use: MAILPGM= /usr/ucb/mail -s "Alert message" to receive a subject for outgoing alert email.
Setting Group Reservations Certain computers can also be allowed to run or prevented from running applications. This can help to balance application usage when you want to prevent users from running applications on heavily loaded computers or file servers. How the Reservation File Works The reservation file tells SentinelLM how many license tokens are reserved for members of different groups. For example, the Sales department could be a group with ten members for which 15 license tokens are reserved.
Setting Group Reservations • Different groups for the same feature should not have common users or computers. • Group names and member names cannot exceed 64 characters each. • The number of license tokens reserved for a feature cannot exceed the number of concurrent copies specified in the license code for that feature. • If you want to exclude all members of a group from using license tokens for a feature, you can specify 0 tokens.
Setting Group Reservations You now see the main WlsGrMgr screen: Feature area Group area 2. To make a new reservation file, select the New command from the File menu. Or use the Open command on the File menu to edit an existing reservation file. 3. To add definitions for who can use license tokens for specific licenses, right-click in the Feature Name area of the screen and select Add from the menu. The New Feature Wizard appears. 4. Click Next.
Setting Group Reservations 6. Now you see a box where you can add the members of the group. 7. Click Add to add a new member. You are asked to enter the name of the member, and whether it is a user (if so, use the user’s login name) or a machine (use the name of the computer on your network). You are also asked if you want to include or exclude this user or machine. Click OK to finish the definition.
Setting Group Reservations 10. After at least one feature has been defined, you can define another group to use that feature. Right-click in the Group area and select Add from the menu to add a new group. Do not add the same users or computers to different groups using the same feature. Manually Editing the Reservation File For UNIX computers, you will need to edit the reservation file manually rather than using the WlsGrMgr utility discussed above.
Setting Group Reservations A group specification consists of: • The name of the feature for which the reservation applies; • The name of the group; • The number of license tokens reserved for that group; • And the login names of users or host IDs of computers that belong to that group that will included or excluded from using the feature.
Setting Group Reservations 122 Chapter 6 - Setting User Options
Appendix A - Using Environment Variables to Configure a License Server 11 This appendix contains information on configuring the license server through the use of the following environment variables: Table A-2: Run-time Environment Variables Variable Where documented LSDEFAULTDIR See “LSDEFAULTDIR - Set the Default Location of the License Server Files” on page 129. LSERVOPTS See “LSERVOPTS - Set License Server Options” on page 126. LSERVRC See “LSERVRC - Set the License Code File” on page 130.
Client - Commonly Used Variables A Sentinel LM license server can be configured using operating system environment variables. There is also an environment variable that can be used to tell a protected application which license server to use. These variables are only used when you have a protected application that is used with network license codes. An application that is used exclusively with stand-alone license codes doesn’t require a license server.
Client - Commonly Used Variables LSHOST - Set the License Server Name The LSHOST environment variable is used on a computer that is running a protected application. It tells the application one or more license server computers to contact. If this variable is not set then the application will perform a broadcast for any license server that can authorize the application to run.
License Server - Commonly Used Variables LSPROTOCOL - Set Communication Protocol The LSPROTOCOL environment variable is used to specify the communications protocol that will be used to communicate with the license server. Specify IPX or UDP (for TCP/IP) to choose the protocol: Example: To tell protected applications running on a Windows 95/98 based computer to send license requests using the IPX protocol, place the following in the Windows 95/98 autoexec.bat file.
License Server - Commonly Used Variables configuring all license servers, it’s recommended to always use LSERVOPTS to set these options instead of providing them directly on the command line: Table A-3: LSERVOPTS Options Summary Option Description -s license-file Specifies the name and location of the license code file. By default, the license server will use the file, lservrc, in the local directory. The location of the license code file can also be specified by the environment variable, LSERVRC.
License Server - Commonly Used Variables Table A-3: LSERVOPTS Options Summary (Continued) Option Description -x By default, on overflow of the usage log file, the file contents will be moved into a backup file. New usage records are then written to the original file until it overflows again. If the -x option is specified, the file will not be backed up on overflow; instead the license server will simply stop writing further records to the file.
License Server - Infrequently Used Variables Table A-3: LSERVOPTS Options Summary (Continued) Option Description -q Quiet mode. When this option is specified, the license server will start up quietly without displaying its banner. Unexpected conditions will still be logged as usual. (UNIX only.) Some license server options have a specific environment variable which can be used to set them. You can also set any of these options using LSERVOPTS but this isn’t recommended.
License Server - Infrequently Used Variables To tell the license server running on a Windows 95/98 based computer that the default directory for license server files is a directory named, C:\LS_FILES, place the following in the Windows 95/98 autoexec.bat file: SET LSDEFAULTDIR=C:\LS_FILES LSERVRC - Set the License Code File The LSERVRC environment variable can be used to set the name and location of the license code file. It’s recommended that the default name and location are used for this file.
License Server - Infrequently Used Variables file will reside in the same directory as the license code file and have the same base name as the license code file but with the extension .cnf. Example: To tell the license server running on a Windows 95/98 based computer that configuration file is in the default directory but named, network.cnf, place the following in the Windows 95/98 autoexec.bat file. SET LSERVRCCNF=NETWORK.
Environment Variables for Administering License Queuing Example: To tell the license server running on a Windows 95/98 based computer to use the TCP/IP port number 5093, place the following in the Windows 95/98 autoexec.bat file. SET LSPORT=5093 Environment Variables for Administering License Queuing Several environment variables allow the network administrator to set license queuing preferences. These environment variables override settings within the application itself orginally set by your vendor.
Environment Variables for Administering License Queuing To tell the license server running on a Windows 95/98 based computer to hold a license for 120 seconds for a user, place the following in the Windows 95/98 autoexec.bat file. SET LS_MAX_QHOLD_SEC=120 LS_MAX_QLEN - Set Maximum Queue Length This environment variable allows the network administrator to set the maximum queue length for the license server computer on which the variable is set.
Notes on Setting Environment Variables by Operating System • If not set, then the application dictates whether the user is placed in the group queue. • Great than zero: specifies the maximum number of users that can be in the group queue. • Set to less than zero: enables license queuing, even if the application’s default is not to place the user in a group queue. • Set to zero: disables group license queuing for this license server.
Stand-alone Application Use of Environment Variables Services when the computer boots. If you make changes to variables, you may need to reboot for them to take effect. UNIX - Bourne or Korn Shell On UNIX computers using the Bourne or Korn shell, environment variables are set by using the SET command at the command prompt, in a format similar to that for Windows 95/98. However, remember to enclose the environment variable parameters in quotation marks, and follow the SET command with an export command.
Stand-alone Application Use of Environment Variables variables are used in the same way as they would be with a network license server. Those variables which are only appropriate for a network configuration are ignored by the stand-alone application. The differences between the use of these variables in stand-alone and network mode is described below. LSHOST - Disable a Network License Your application may have been built to support both stand-alone and network licensing.
Stand-alone Application Use of Environment Variables LSERVRCCNF - Set the Application License Management Configuration File This variable can be used to specify the configuration file that is used with the stand-alone application. Environment Variables Not Used in Stand-alone Mode The following variables are only meaningful when used with a license server: LSPORT, LSPROTOCOL, and the license queuing environment variables.
Stand-alone Application Use of Environment Variables 138 Appendix A - Using Environment Variables to Configure a License Server
Index 12 A additive licenses 16 alerts 109 notification 114 setting 109 B background service 128 borrowing threshold 46 C client 15 configuring 32 communication protocols 126, 128, 131 commuter licensing 44, 69 checking out authorization 70 locking authorization 70 redundant license 44 redundant license server restriction 70 restricting tokens 128 Computer ID key 5 conventions syntax xvi typographic xv CSV file 93 D distribution criteria 11 E echoid utility 79 encrypting usage log file 26, 128 environ
H hard limits 109 I including/excluding computers and users 116 IPX protocol 80 ipxecho utility 80 L -lfe option 26 license balancing 11, 45 disabling/enabling 45 free pool 41 initial setup 49 license code 2 adding/deleting 84 decrypting 82 displaying 81 installing 84 loading 18 license file 2, 10, 15, 23, 40, 127 location 23 lservrc 23 lservrlf 23 setting location 130 license queuing 132–134 license server 3 -b option 128 broadcast method identification 34 client 32 -com option 128 commuter tokens, restr
exclusive 16 renewing 21 token 38 loadls utility 30, 81 locking code 3 locking commuter authorization 70 log file encryption 128 log file. See usage log file logging events, Windows 31 LS_MAX_GROUP_LEN 133 LS_MAX_QHOLD_SEC 132 LS_MAX_QLEN 133 LS_MAX_QWAIT_SEC 132 lsdecode utility 81, 82 LSDEFAULTDIR 129 lserv utility 83 lserv.log 26 lserv9x.exe 31 lservc file 130 lservlog file 128 LSERVOPTS 19, 127 LSERVRC 82, 110, 130 lservrc file 10, 127 lservrc.
reserving licenses for users 45 rlftool utility 11, 40 S soft limits 109 stand-alone computer 135 stand-alone license 3 syntax conventions xvi system requirements NetWare 32 Windows 30 Windows 95/98 30 Windows 30 event logging 31 installing license server 30, 81 WlmAdmin utility 34, 96 WlsGrMgr utility 117 Wrlftool utility 11, 40, 46 T threshold 46 token 11, 38 distribution criteria 11 token borrowing 45 enabling/disabling 46 threshold 46 typographic conventions xv U usage log file 23, 89 backup 127 cha
