LicensingGuide LMS2.ENU
LicensingGuide LMS2.ENU
LicensingGuide LMS2.ENU
LG_LMS2-8
COPYRIGHT NOTICE
© 2011-2019 IAR Systems AB.
No part of this document may be reproduced without the prior written consent of IAR
Systems AB. The software described in this document is furnished under a license and
may only be used or copied in accordance with the terms of such a license.
DISCLAIMER
The information in this document is subject to change without notice and does not
represent a commitment on any part of IAR Systems. While the information contained
herein is assumed to be accurate, IAR Systems assumes no responsibility for any errors
or omissions.
In no event shall IAR Systems, its employees, its contractors, or the authors of this
document be liable for special, direct, indirect, or consequential damage, losses, costs,
charges, claims, demands, claim for lost profits, fees, or expenses of any nature or kind.
TRADEMARKS
IAR Systems, IAR Embedded Workbench, Embedded Trust, C-Trust, IAR Connect,
C-SPY, C-RUN, C-STAT, IAR Visual State, IAR KickStart Kit, I-jet, I-jet Trace,
I-scope, IAR Academy, IAR, and the logotype of IAR Systems are trademarks or
registered trademarks owned by IAR Systems AB.
Microsoft and Windows are registered trademarks of Microsoft Corporation.
Adobe and Acrobat Reader are registered trademarks of Adobe Systems Incorporated.
All other product names are trademarks or registered trademarks of their respective
owners.
EDITION NOTICE
Eighth edition: October 2019
Part number: LG_LMS2-8
Internal reference: LMS2.17.x, INIT.
2 Licensing Guide
AFE1_AFE2-1:1
Contents
Preface ...................................................................................................................... 5
Who should read this guide ................................................................. 5
What this guide contains ....................................................................... 5
Further information .............................................................................. 6
Document conventions .......................................................................... 6
Typographic conventions ..................................................................... 6
Introduction .......................................................................................................... 9
Installation ............................................................................................................ 15
AFE1_AFE2-1:1
Starting and stopping a license server manually ................................ 32
Switching between different licenses for a product ........................... 33
Adding more users to a network license ............................................ 33
Checking out a product for commuter authorization ......................... 34
Setting the maximum number of commuter authorizations ............... 34
Activating a license when offline ....................................................... 35
Transferring a license when offline ................................................... 41
Reserving user groups for network licenses ............................... 46
Logging license server activities ....................................................... 48
Activating logging for the IAR License Manager for License Server 48
Activating logging using an environment variable ............................ 49
Specifying the size of the log files ..................................................... 49
Backing up the log files ..................................................................... 49
Disable backing up log files ............................................................... 50
Index ....................................................................................................................... 69
4 Licensing Guide
AFE1_AFE2-1:1
Preface
Welcome to the Licensing Guide. This guide contains information about how to
install an IAR Systems product that uses a network license, and how to manage
network, mobile and PC-locked licenses. This guide also contains reference
information on the IAR License Manager.
For information about how to install and license an IAR Systems product
online that uses a mobile or PC-locked single-user license, see the Installation
and Licensing Quick Reference Guide.
AFE1_AFE2-1:1
Document conventions
FURTHER INFORMATION
If this guide does not answer your questions or solve your problems concerning
installation or licensing, you can:
● Read the Release notes for recent information that might not be included in this
guide. The Release notes for IAR Systems products are available in the Information
Center and from the installation wizard. The Release notes for the IAR License
Server Tools are available from the installation wizard.
● See the technical notes on the Technical Support pages on the IAR Systems web
site, www.iar.com/support.
● Contact IAR Systems Technical Support for technical support. Information about
how to access our Technical Support can be found on the IAR Systems web site,
www.iar.com/support.
If you contact our Technical Support, be prepared to provide the following information:
your license number, the type of license lock you use, when and where you purchased
the product, and a detailed description of the problem.
Command line instructions are located in the product installation subdirectory
\common\doc\LightLicenseManager\.
Document conventions
When referring to a directory in your product installation, for example \doc, the full
path to the location is assumed, for example c:\Program Files\IAR
Systems\Embedded Workbench N.n\cpuname\doc, where the initial digit of the
version number reflects the initial digit of the version number of the IAR Embedded
Workbench shared components.
TYPOGRAPHIC CONVENTIONS
The IAR Systems documentation set uses the following typographic conventions:
Style Used for
computer • Source code examples and file paths.
• Text on the command line.
• Binary, hexadecimal, and octal numbers.
Table 1: Typographic conventions used in this guide
6 Licensing Guide
AFE1_AFE2-1:1
Preface
Identifies warnings.
AFE1_AFE2-1:1
Document conventions
8 Licensing Guide
AFE1_AFE2-1:1
Introduction
This chapter introduces the IAR Systems licensing system, giving an overview
of the installation and license activation procedure, and of the different license
types.
When you have finished the purchase of your product, you will receive email
notification from IAR Systems that your permanent license is now available. You can
then activate your license for permanent use. With a permanent license, you are also
entitled to up to one year of free updates and prioritized technical support, depending on
your purchased product.
The IAR License Manager is automatically installed when you install your IAR Systems
product or the IAR License Server Tools, and is used to manage your licenses on both
license servers and client computers. For more information about how to use the IAR
License Manager, see License management, page 25.
AFE1_AFE2-1:1
Network licenses
LICENSE TYPES
There are three types of permanent licenses:
● Mobile license—a single-user license locked to a dongle (hardware lock). A dongle
is a device you attach to the computer’s USB port, which allows you to easily move
the license to another computer by just moving the dongle.
● PC-locked license—a single-user license locked to the computer where the product
is installed.
● Network license—a multi-user license located on a license server and used by
multiple users on a network. The network license is locked to either to the computer
where the license server runs, or to a dongle (hardware lock).
Network licenses
A network license is a multi-user license that is located on a license server computer and
used by multiple users on a network. A license server computer is a PC with the IAR
License Server Tools installed. Individual installations of IAR Systems products are
installed on other client computers in the same network.
The network license makes it possible to use your IAR Systems product from any of the
client computers on the network. The network license allows for a maximum number of
concurrent users, and the license server keeps track of the current number of users.
10 Licensing Guide
AFE1_AFE2-1:1
Introduction
The network license is locked to the computer where the license server is installed,
either to the computer itself or to an attached dongle (hardware lock). With the dongle,
you can easily transfer the license server to a different license server computer.
The license server is generic and you can use it for all IAR Systems products you install.
11
AFE1_AFE2-1:1
Network licenses
SYSTEM REQUIREMENTS
For information about systems requirements:
● For the license server computer (network licenses only), see the Release notes for
the IAR License Server Tools available from the installation wizard.
● For client computers, see the Installation and license activation section in the
Release notes available in the Information Center and from the installation wizard.
Note: It is not recommended to use the same computer as both a license server and a
client computer.
Note: To install and activate an IAR Systems product, you must have administrator
privileges on the computer, and an internet connection. If the license server computer
does not have access to the internet, see Activating a license when offline, page 35.
12 Licensing Guide
AFE1_AFE2-1:1
Introduction
UDP broadcast packets at port 5093 are also used every time your IAR Systems product
is started and periodically for as long as the IAR License Manager is running. The
broadcasts are made to find available license servers on the network. No broadcasts are
made during the time that a licensed product is being used.
The IAR License Manager uses the HTTPS communication protocol to fetch license
keys from IAR Systems. The Windows settings for internet proxy are used.
13
AFE1_AFE2-1:1
Network licenses
14 Licensing Guide
AFE1_AFE2-1:1
Installation
This chapter gives information to a system or network administrator about
how to install IAR Systems products that use a network license, which includes
installing the IAR License Server Tools on a designated server computer and
an IAR Systems product on client computers.
For information about network licenses, see Network licenses, page 10.
A Install the IAR License Server Tools on a server computer. (Omit this step if
the latest version of the IAR License Server Tools is already installed.)
B Activate your temporary startup network license using the IAR License
Manager on the server computer.
C Activate your network license for permanent use. Perform this step when you
receive notification from IAR Systems that your permanent license is
available.
D Install your IAR Systems product on the client computers. Repeat this step for
each client computer.
Note: To install products from IAR Systems, you must have administrator privileges to
the system.
15
AFE1_AFE2-1:1
Installing network licenses
16 Licensing Guide
AFE1_AFE2-1:1
Installation
17
AFE1_AFE2-1:1
Installing network licenses
4 Type your license number and click Next. You can find your license number in the
welcome letter in your product package.
5 If you have not registered your license you will be asked to do that before proceeding.
If your license is already registered, go to step 10.
To register your license, click Register to register your license.
18 Licensing Guide
AFE1_AFE2-1:1
Installation
6 The License Wizard opens the IAR Systems registration web page where you can
register your license.
7 When you have completed the registration form, click Submit Registration. A
verification email will be sent to the address you specified.
19
AFE1_AFE2-1:1
Installing network licenses
8 Open the email when you receive it, and click on the link in the email to verify the
registration. The registration is now complete.
9 In the License Wizard, click Next to continue with the license activation.
10 Click Next to confirm that the license should be installed on the server shown.
20 Licensing Guide
AFE1_AFE2-1:1
Installation
11 If your network license is using a dongle, you must now lock the license to the dongle.
(If your license will not use a dongle, skip this step.) Connect the dongle to your
computer, and make sure that no other dongle is connected. Click Next to continue.
Alternatively, if your dongle has not arrived, you can temporarily lock your license to
your computer. Select the corresponding checkbox.
You can lock the license to a dongle other than the one provided with the product
package, for example, if you want to lock several products to the same dongle. However,
you need to consider this carefully, because once the dongle is confirmed, the lock
cannot be undone.
12 The License Wizard now confirms your license details. Click Next to finish the
activation.
21
AFE1_AFE2-1:1
Installing network licenses
4 Click Check selected licenses. The IAR License Manager contacts IAR Systems to
check whether there are any renewals available for the selected license.
22 Licensing Guide
AFE1_AFE2-1:1
Installation
5 The Available Renewals dialog box is displayed and lists the licenses for which there
are new licenses available. Select the license you want to activate, and click Install
selected to install the license.
6 The Renewal Results are displayed. Click OK to close the License Wizard.
7 On the client computers, you might need to restart your IAR Systems product or start
the IAR License Manager to detect the renewed licenses.
The permanent license of your IAR Systems product can now be used.
23
AFE1_AFE2-1:1
Installing network licenses
You are now finished with the installation and the licensed product can be used.
Note: If you are upgrading from a size-limited IAR Embedded Workbench version,
make sure to perform a Rebuild All command when you build your project for the first
time using the new version.
24 Licensing Guide
AFE1_AFE2-1:1
License management
This chapter describes how to perform some typical tasks for managing your
network, mobile and PC-locked licenses.
ACTIVATING A LICENSE
Before you can use your IAR Systems product, you need to activate your license.
Follow these steps to activate your permanent network license, which has been
previously registered, when the license server computer is connected to the internet.
To activate (and register) your network license for the first time, see B. Activate your
temporary startup license, page 16.
To activate your license when the license server computer is offline, see Activating a
license when offline, page 35.
To activate a mobile or PC-locked license, see the Installation and Licensing Quick
Reference Guide.
25
AFE1_AFE2-1:1
Managing your licenses
Note: Two network licenses for the same IAR product and package cannot coexist on
the same license server, with the later activated license overwriting the previous one.
The previous license can be reactivated on the same computer with the same locking
criteria. If you want to add more users to a network license, contact your IAR Sales
office.
To activate your network license:
1 On the license server computer, start the IAR License Manager for License Server from
the Windows Start menu.
2 Choose License>Activate License to start the License Wizard.
26 Licensing Guide
AFE1_AFE2-1:1
License management
4 Type your license number and click Next. You can find your license number in the
welcome letter in your product package.
27
AFE1_AFE2-1:1
Managing your licenses
5 Click Next to confirm that the license should be installed on the server shown.
6 If your network license is using a dongle, you must now lock the license to the dongle.
(If your license will not use a dongle, skip this step.) Connect the dongle to your
computer, and make sure that no other dongle is connected. Click Next to continue.
28 Licensing Guide
AFE1_AFE2-1:1
License management
7 The License Wizard now confirms your license details. Click Next to finish the
activation.
8 Your license is now installed. In the IAR License Manager, click Done to close the
License Wizard. The license server will be running in the background, and you can use
the IAR License Manager at any time to view or manage the licenses.
DEACTIVATING A LICENSE
If required, you can use the IAR License Manger to deactivate a license, for example, if
you are transferring a license or merging several licenses, where you need to first
deactivate the license.
Note: To deactivate a network license locked to a license server computer, you must first
contact your local IAR Sales office or IAR Customer Care team to request permission
for the transfer.
To deactivate a license:
1 In the IAR License Manager, choose License>Deactivate to start the License Wizard.
29
AFE1_AFE2-1:1
Managing your licenses
2 In the list, select the product that you want to deactivate, and click Next.
30 Licensing Guide
AFE1_AFE2-1:1
License management
2 If you have installed more than one product on the computer, you are prompted to
select the product that you want to use. Select the product and click Next:
3 In the list, select the server that you want to use and click Next:
31
AFE1_AFE2-1:1
Managing your licenses
4 Alternatively, if the server is not in the list, click Add a server. In the dialog box that
appears, click Add and type the name or IP number of your server:
Note: Entering an incorrect server name might slow down the IAR License Manager.
Click OK to return to the License Wizard.
5 In the License Wizard, select the server you want to use, and click Next.
6 The server is selected for the product. Click Done to close the License Wizard.
In that directory there is a subdirectory WinNT where the server files are located. The
name of the server executable file is Lservnt.exe. To start and stop it, you run
loadls.exe (which requires administrator privileges).
32 Licensing Guide
AFE1_AFE2-1:1
License management
Click Add or Remove to start or stop the service. If you click Add when the service is
already running, or Remove when the service is not running, you will get an error
message.
33
AFE1_AFE2-1:1
Managing your licenses
You will get an email notification when your purchase is finished. To activate your
license with the new capacity, do one of these:
● Renewing a network license—looking for renewals for all activated licenses on the
computer. If you have many licenses installed this might take some time
(approximately one minute per license number). In this case, it might be better to
activate the license instead.
● Activating the license—renewing a specific license. You will need to specify the
same license number as when the original license was activated. One advantage
with this alternative is that only that specific license number is checked. This option
can also be used if renewals fail due to, for example, a changed locking criterion.
34 Licensing Guide
AFE1_AFE2-1:1
License management
For information on how to check out a product for commuter authorizations, see
Checking out a product for commuter authorization, page 34.
35
AFE1_AFE2-1:1
Managing your licenses
36 Licensing Guide
AFE1_AFE2-1:1
License management
7 If you chose to lock the license to a dongle directly (by selecting Yes in the previous
step) you will be asked to connect the dongle before proceeding.
Connect the dongle and click Refresh dongle list.
8 Specify where to save the activation information file, then click Next. An activation
information file is created.
37
AFE1_AFE2-1:1
Managing your licenses
38 Licensing Guide
AFE1_AFE2-1:1
License management
2 Browse to the activation information file you have moved to this computer, then click
Activate License to notify IAR Systems of the license activation. (This may take
several minutes.)
3 If you have not registered your license you will be asked to do that before proceeding.
39
AFE1_AFE2-1:1
Managing your licenses
4 At the end of the activation process, an activation response file is created. Click
Download response to download the activation response file.
5 Move the activation response file to the offline computer where the product or the IAR
License Server Tools are installed.
40 Licensing Guide
AFE1_AFE2-1:1
License management
4 If your license is a temporary startup license, when you have finalized your IAR
Systems product purchase, you will receive email notification from IAR Systems that
your permanent license is available. You can then repeat the offline activation to
activate your permanent license.
41
AFE1_AFE2-1:1
Managing your licenses
2 Type the license number you want to deactivate, and click Request deactivation.
3 When prompted, click Yes, proceed to proceed with the request deactivation.
42 Licensing Guide
AFE1_AFE2-1:1
License management
4 Your request for deactivation of the license is received, and a deactivation permission
file is created. Click Download Permission file to download the file.
5 Move the deactivation permission file to the computer where you want to transfer the
license from (computer X).
43
AFE1_AFE2-1:1
Managing your licenses
4 Browse to the deactivation permission file you have downloaded and moved to this
computer, and click OK.
44 Licensing Guide
AFE1_AFE2-1:1
License management
2 Browse to the deactivation confirmation file you have moved to this computer, then
click Post confirmation to confirm the license deactivation with IAR Systems.
45
AFE1_AFE2-1:1
Reserving user groups for network licenses
where:
46 Licensing Guide
AFE1_AFE2-1:1
License management
For example:
$computer1
$10.11.0.*
John.Smith
!David.Smith
For example, this file will make the server hold two tokens exclusively for users at
workstations PC-ADAM and PC-ADA, for the compiler and debugger features, while
the user of PC-GUEST will be unable to use the specified features at all:
XXX.EW.COMPILER_STD,1.01:include_grp:2:$PC-ADAM $PC-ADA
XXX.EW.COMPILER_STD,1.01:exclude_grp:0:$PC-GUEST
XXX.EW.DEBUGGER_STD,1.01:include_grp:2:$PC-ADAM $PC-ADA
XXX.EW.DEBUGGER_STD,1.01:exclude_grp:0:$PC-GUEST
Note that a license normally has a number of features. You can find the feature names
and versions in the IAR License Manager. Double-click a product to open the License
Details dialog box.
2 Save the file, for example, as
C:\IARSystems\LicenseManagement\lreserv.txt.
3 Use the LSRESERV environment variable to set the destination of the user group file.
For example: LSRESERV=C:\IARSystems\LicenseManagement\lreserv.txt
4 Restart the license server.
Note: You must restart the server after making any changes to the file lreserv.txt.
5 Using the license is now restricted according to your specification:
● If the number of reserved tokens for the group is the same as the number of users
allowed for the license, no one outside the group can use the license.
● If the number of reserved tokens for the group is zero, no one in the group can use
the license.
47
AFE1_AFE2-1:1
Logging license server activities
48 Licensing Guide
AFE1_AFE2-1:1
License management
You must make these settings on the server computer and they will take effect the next
time the license server Windows service is restarted. To modify these settings, you must
start the IAR License Manager as an administrator.
For example:
LSERVOPTS=-1 C:\ServerLog\logfile.txt
You must restart the license server Windows service for the changes to take effect.
Note: If the environment variable is set globally, for example in Windows system
properties, it might affect other products.
Example
The administrator has specified the maximum size of the log files as 2 Mbytes. When
the size reaches 2 Mbytes, the license server adds a suffix at the end of the log files. For
example: serverlog.txt.00, serverlog.txt.01, serverlog.txt.02 up until
serverlog.txt.99. Once this limit is reached, the license server starts generating the
backup files using the same log file name series starting from 00, which means the old
log files will be overwritten.
If you need more log files, you must write your own script which will back up the first
100 log files to another location (storing the content), which means it is no longer a
problem when the first log files are overwritten.
49
AFE1_AFE2-1:1
Logging license server activities
50 Licensing Guide
AFE1_AFE2-1:1
Reference information
This chapter gives reference information about the IAR License Manager—a
tool for managing your IAR Systems product licenses.
51
AFE1_AFE2-1:1
Reference information on the IAR License Manager
File menu
These commands are available:
View menu
These commands are available:
License menu
These commands are available:
Activate License Starts the License Wizard where you can activate a license
using a license number, see Activating a license, page 25.
You can activate a license even if your computer does not
have an internet connection, see Activating a license when
offline, page 35.
52 Licensing Guide
AFE1_AFE2-1:1
Reference information
Check for License Displays the Check for License Renewals dialog box
Renewal where you can list any new versions available for selected
licenses, see Check for License Renewals dialog box, page
56.
Use Network License Starts the License Wizard where you can select the product
and server you want to use for a network license, see
Choosing a network license server manually, page 30.
Transfer License Starts the License Wizard where you can select a license
that you want to transfer to another computer. You can
transfer a license even if your computer does not have an
internet connection. See Transferring a license when
offline, page 41
Note that to transfer a network license locked to a license
server computer, you must first contact your local IAR
Sales office or IAR Customer Care team to request
permission for the transfer.
Note that you can only transfer a PC-locked license up to
three times during a 12-month period.
Deactivate License Displays the Deactivate License dialog box where you can
select a license that you want to deactivate, see
Deactivating a license, page 29.
Get Evaluation License Starts the License Wizard where you can select a product
that you want to evaluate.
Tools menu
These commands are available:
Options Displays the Options dialog box, where you can re-enable
all previously suppressed dialog boxes, and activate logging
server activities, see Options dialog box, page 60.
Extract Optional Extracts source code libraries that were delivered with your
Packages product.
Windows menu
These commands are available:
Close Closes the currently selected page in the display area of the
IAR License Manager main window.
53
AFE1_AFE2-1:1
Reference information on the IAR License Manager
Help menu
These commands are available:
License Details Displays the License Details dialog box which lists detailed
information about selected licenses, see License Details
dialog box, page 57.
Check in Checks in a network license which you previously have
checked out with commuter authorization.
Check out Checks out a network license with commuter authorization
which means you can use it as a PC-locked license for a
limited time.
54 Licensing Guide
AFE1_AFE2-1:1
Reference information
Check for renewals Displays the Check for License Renewals dialog box
where you can list any new versions available for selected
licenses, see Check for License Renewals dialog box, page
56.
Delete Deletes the selected network license from the server. This
can only be performed on the license server computer.
A deleted network license can be activated anytime on the
same license server computer with the same locking criteria.
Note that the Delete command is not the same as the
Deactivate command, which deactivate the license from the
IAR Systems database.
This dialog box lists any new versions available for the licenses selected in the Check
for License Renewals dialog box.
The IAR License Manager contacts IAR Systems to check whether the local licenses are
up to date. If there are any new versions available, you will get the opportunity to renew
them.
55
AFE1_AFE2-1:1
Reference information on the IAR License Manager
Display area
Lists licenses in these columns:
Buttons
This dialog box lists the currently used license for each installed IAR Systems product
on the local machine, and the installed licenses on the local license server (if any). You
can also list unused licenses that have been installed and then deleted.
56 Licensing Guide
AFE1_AFE2-1:1
Reference information
Display area
Lists licenses in these columns:
Check Select the license for which you want to check for new licenses
and click Check selected licenses. If there are any new
licenses, the Available Renewals dialog box is displayed. See
Available Renewals dialog box, page 55.
License Number The license number for the product.
Product The name of the product.
Expiry Date The date for the license expiration.
Comment Information about the license.
Buttons
Check selected licenses Checks whether there are any new licenses available for
the licenses selected in the Check column. If there are any
new licenses, the Available Renewals dialog box is
displayed, see Available Renewals dialog box, page 55.
57
AFE1_AFE2-1:1
Reference information on the IAR License Manager
Use this dialog box to choose between available licenses and to get detailed information
about the selected license.
Selected license
Lists all licenses that you have activated for this product and available network licenses.
Select the license that you want to use.
Description
Lists detailed information for the selected license.
Features
Displays all licensable features in the product and their license status in these columns:
58 Licensing Guide
AFE1_AFE2-1:1
Reference information
Buttons
These buttons are available:
59
AFE1_AFE2-1:1
Reference information on the IAR License Manager
Use this dialog box to enable all previously suppressed dialog boxes, and to activate
logging server activities.
Buttons
60 Licensing Guide
AFE1_AFE2-1:1
Reference information
Use this dialog box to manually point out license servers that the IAR License Server
for some reason does not automatically detect.
Note: Manually added non-existing servers will seriously increase response times in the
IAR License Manager.
Found servers
Lists automatically detected license servers.
Buttons
These buttons are available:
Add Adds a license server to the list. Click Add and type the name
or IP number of the license server that you want to add.
61
AFE1_AFE2-1:1
Log file format
Explicit entries:
0 - A license is issued.
1 - A license is denied.
2 - The licensed application released the license token (when the release
API is called)
3 - A queued key is issued and the client is placed in a queue. When the
license would be available (after other clients release any token), this
client is allowed to get that license.
4 - The queuing request failed.
5 - The queuing request succeeded. However, instead of obtaining a
queued key, the client receives the normal key and is not placed in the
queue.
6 - A queued license is converted to an actual license. This happens
Table 2: The log file elements
62 Licensing Guide
AFE1_AFE2-1:1
Reference information
Element Description
Trans (Continued) when the client obtains the license that was released by some other
client (and a queued client is allowed to call the VLSgetQueuedClient API
to get the key). Thereafter, the client is removed from the queue.
7 - A queued license key that was issued earlier is released because it
could not be converted into an actual license key (non-queued key) after
a certain time period.
8 - A commuter license is checked out.
9 - A commuter license is checked in.
Implicit entries:
10 - Implicit license release entry when the License Manager performs
cleanup of in use keys before shutdown.
11 - Implicit license release entry when the License Manager reclaims
tokens after the key lifetime period has expired.
12 - Implicit license release entry when any of the following transactions
takes place:
* License A is released at midnight when license switches to License B.
* The license is released after actual revocation takes place for a deferred
revocation case.
* License A is released when License B is dynamically added.
13 - Implicit license release entry when the usage log file is changed
under any of the following scenarios:
* When the backup usage log file is created (in case of overflow), a license
release entry in the backup log file.
* When the log file is changed by calling the usage log function
VLSchangeUsageLogFileName, a license release entry in the previous
log file
14 - Implicit license request entry under the scenarios when update calls
are converted into request. For example:
* When clients are running and the heartbeat message is sent after the
License Manager restart
* When heartbeat messages are sent after the key lifetime expiration
15 - Implicit license request entry under any of the following scenarios:
* When the backup usage log file is created (in case of overflow), a license
request entry in the new log file.
* When the log file is changed by calling the usage log function
VLSchangeUsageLogFileName, a license request entry in the new log
file.
16 - Implicit release entries in the usage log file of the follower server,
when the original leader comes back after going down (in the case of
redundant License Manager setup).
17 - Explicit request entry of a shared license token
18 - Explicit release entry of a shared license token
Table 2: The log file elements (Continued)
63
AFE1_AFE2-1:1
Log file format
Element Description
Numkeys The number of licenses in use after the current request/release.
(Encrypted if encryption level is set to 3 or 4.)
Keylife How long, in seconds, the license was used. Only applicable in a license
release entry.
User The user name of the application associated with the entry.
This element can be logged anonymously if the anonymous logging
option is set.
If the License Manager is not started with the extended log option,
LM_SERVER appears as the user name.
If the License Manager is started with the extended log option, the actual
user name appears in the user name field of each dummy record.
If clients are connected to the License Manager when the backup file is
created, dummy records are created only for in-use license tokens in the
backup file (and not for the tokens whose key lifetime has expired).
Correspondingly, their dummy records are created in the new file. the
dummy entries are differentiated from the rest of the entries by specific
transaction IDs (13 and 15).
Host The host name of the application associated with the entry.
This element can be logged anonymously if the anonymous logging
option is set.
LSver The version of the Sentinel RMS Development Kit license server.
Currency The number of licenses handled during the transaction. (Encrypted if the
encryption level is set to 3 or 4.)
Comment The text passed by the license application.
This element can be logged anonymously if these conditions are met:
* Anonymization of comments is allowed in the licensed application.
* The system administrator has set the License Manager anonymous
logging option.
Further, the comment can be fully or partially anonymized depending on
the vendor's implementation.
Queue key ID If license queuing is enabled, this value denotes the queue ID—a unique
identifier of the queued key. Otherwise, it contains a hyphen as in the
example below.
Absolute position If license queuing is enabled, this value denotes position of the queued
client in the queue. Otherwise, it contains a hyphen as in the example
below.
Table 2: The log file elements (Continued)
64 Licensing Guide
AFE1_AFE2-1:1
Reference information
Element Description
Group position If the system administrator has created a group reservation file and
license queuing is enabled, this value denotes the position of the queued
client in its group. Otherwise, it contains a hyphen as in the example
below.
Group name If the system administrator has created a group reservation file and the
queued key is granted from the reserved group, (as specified in the
reservation file) the group name will appear. Otherwise, it contains a
hyphen as in the example below.
Queue length If license queuing is enabled, this value denotes the queue length—the
total number of clients existing in the queue at that particular time.
Otherwise, it contains a hyphen as in the example below.
Capacity flag 0 - Capacity licensing is not used.
1 - Capacity licensing is used.
License capacity If capacity licensing is used, this field contains the license capacity.
Otherwise, it contains a hyphen as in the example below.
Team capacity If capacity licensing is used, this field contains the team capacity.
Otherwise, it contains a hyphen as in the example below.
User capacity If capacity licensing is used, this field contains the user capacity.
Otherwise, it contains a hyphen as in the example below.
Record number Encrypted record number
Client ID A 16-byte value that uniquely identifies each client request and is logged
in the following transaction types: 0, 2, 10, 11, 12, 13, 14, 15, 16, 17, and
18. Using the client ID, each request log entry can be mapped with the
corresponding release log entry.
Also note the following behavior:
* The client ID is shown in extended logs only. In plain logs, a hyphen will
be logged instead of the client ID.
* The client ID will not be maintained for commuter and queued clients.
In such cases, a hyphen will be logged instead of the client ID.
* For clients earlier than v8.5.5, the client ID in the case of transaction ID
14 will not be maintained, instead a fresh client ID will be assigned.
Readable checksum Readable checksum of the record
Encrypted checksum Encrypted cumulative checksum
Table 2: The log file elements (Continued)
65
AFE1_AFE2-1:1
Log file format
If the License Manager is started with extended log option, an entry in the log file might
look like:
# # Startup Sentinel RMS License Manager v8.6.0.0036 Mon Aug 25
15:22:34 2014 140890354 Machine1 25 5976 v2.0 437875
66 Licensing Guide
AFE1_AFE2-1:1
Licensing concepts
Licensing concepts collected, most notably the email address. At the end of the
registration process an email is sent to the registered address to
verify that it is correct.
This chapter lists terms related to licensing. License server
A PC with the IAR License Server installed.
Mobile license
Commuter authorization A single-user license that is locked to a dongle, and thus can be
A network license that you can check out from the server and used on any computer where the product is installed when the
use as a PC-locked license for a limited time. dongle is connected.
Entitlement Network license
The features your license entitles you to. In other words, the A multi-user license that is located on a license server
features that will be enabled and the period they can be used computer. This license can be used by any computer on the
for. local network.
Evaluation license Offline activation
A free license that is limited in time or in function. For a License activation requires the IAR License Manager to
time-limited evaluation license, the same product version can connect to IAR Systems over the internet. If that is not
only be evaluated once on a specific computer. possible, there is a backup routine called Offline activation.
Feature PC-locked license
A feature in the installed software that is enabled or disabled A single-user license that is locked to the computer hardware
depending on the entitlement in your license. There is a license and can be used on this computer only.
key for each feature.
Permanent license
License activation A license without a time limit.
The procedure to get the license keys from IAR Systems.
Product
License key The product is what you have bought from IAR Systems. In
A string that contains information that allows the license to addition to the software you have installed, the documentation,
verify your entitlements. and optionally a dongle, it is a license package that entitles you
to use a number of the features in the software.
License number
A unique identifier of a license, which is used in the license Startup license
activation and in contact with IAR Systems support. A time-limited license that you get immediately when you
activate your newly purchased product. Also known as a
License package
temporary startup license.
License keys and license information stored in a file. A license
package is created on your computer when you activate a Transfer license
license. Deactivating a license and returning it to IAR Systems, to be
able to reactivate it on another computer.
License registration
All licenses must be registered with IAR Systems. During
registration, contact information about the license owner is
67
LG_LMS2-4
68 Licensing Guide
AFE1_AFE2-1:1
Index
Index
A dongle
included in IAR License Server package . . . . . . . . . . . . 11
Activate License (License menu) . . . . . . . . . . . . . . . . . . . . 52 mobile license locked to. . . . . . . . . . . . . . . . . . . . . . . . . 10
activating license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Dongle List (View menu) . . . . . . . . . . . . . . . . . . . . . . . . . . 52
activating when offline . . . . . . . . . . . . . . . . . . . . . . . . . 35
permanent license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
startup license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
E
Available Renewals dialog box . . . . . . . . . . . . . . . . . . . . . . 55 edition, of this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
entitlement, definition of . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
evaluation license, definition of . . . . . . . . . . . . . . . . . . . . . 67
B Extract Optional Packages (Tools menu) . . . . . . . . . . . . . . 53
broadcast . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
F
C feature, definition of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Check for License Renewal (License menu) . . . . . . . . . . . . 53 File menu (IAR License Manager) . . . . . . . . . . . . . . . . . . . 52
Check for License Renewals dialog box . . . . . . . . . . . . . . . 56 Found servers (Servers dialog box) . . . . . . . . . . . . . . . . . . . 61
Check for renewals (Network Licenses context menu) . . . . 55
Check in (Product List context menu) . . . . . . . . . . . . . . . . . 54
Check out (Product List context menu) . . . . . . . . . . . . . . . . 54
G
client computer Get Evaluation License (License menu) . . . . . . . . . . . . . . . 53
installing product . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
system requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Collect Diagnostic Information (Help menu) . . . . . . . . . . . 54 H
commuter authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Help menu (IAR License Manager) . . . . . . . . . . . . . . . . . . 54
checking out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
definition of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
maximum number of . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 I
conventions, used in this guide . . . . . . . . . . . . . . . . . . . . . . . 6 IAR License Manager . . . . . . . . . . . . . . . . . . . . . . . . . . 10–11
logging activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
69
LG_LMS2-4
installing License Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
IAR License Server Tools . . . . . . . . . . . . . . . . . . . . . . . 15 Log server activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
license server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 log server activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
network license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 logging activities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
product on client computer . . . . . . . . . . . . . . . . . . . . . . 23 LSERVOPTS (environment variable)
enable logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
license
activating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 M
activating permanent license . . . . . . . . . . . . . . . . . . . . . 22 Manually added servers (Servers dialog box) . . . . . . . . . . . 61
activating startup license . . . . . . . . . . . . . . . . . . . . . . . . 16 mobile license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
activating when offline . . . . . . . . . . . . . . . . . . . . . . . . . 35 definition of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
deactivating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
mobile license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
network license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 N
PC-locked license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 network license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
permanent license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 activating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
startup license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 activating offline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
switching between licenses . . . . . . . . . . . . . . . . . . . . . . 33 adding more users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
transferring when offline . . . . . . . . . . . . . . . . . . . . . . . . 41 deactivating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
types, of licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 definition of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
license activation, definition of . . . . . . . . . . . . . . . . . . . . . . 67 installing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
License Details dialog box . . . . . . . . . . . . . . . . . . . . . . . . . 57 reserving user groups . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
License Details (View menu) . . . . . . . . . . . . . . . . . . . . . . . 52 system requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
license key, definition of . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 transferring when offline . . . . . . . . . . . . . . . . . . . . . . . . 41
License menu (IAR License Manager) . . . . . . . . . . . . . . . . 52 Network License Users (View menu) . . . . . . . . . . . . . . . . . 52
license number, definition of . . . . . . . . . . . . . . . . . . . . . . . 67 Network Licenses context menu . . . . . . . . . . . . . . . . . . . . . 54
license package, definition of . . . . . . . . . . . . . . . . . . . . . . . 67 Network Licenses (View menu) . . . . . . . . . . . . . . . . . . . . . 52
license registration, definition of. . . . . . . . . . . . . . . . . . . . . 67 network requirements for license server . . . . . . . . . . . . . . . 12
license server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
choosing manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
definition of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
installing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
O
offline
logging activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 activating license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
network requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . 12 transferring licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
starting and stopping manually . . . . . . . . . . . . . . . . . . . 32 offline activation, definition of . . . . . . . . . . . . . . . . . . . . . . 67
system requirements for computer . . . . . . . . . . . . . . . . . 12 Options dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
license types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
70 Licensing Guide
LG_LMS2-4
Index
when offline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
P Transfer License (License menu) . . . . . . . . . . . . . . . . . . . . 53
part number, of this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 types, of licenses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
PC-locked license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 typographic conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
definition of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
permanent license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
permanent license, definition of . . . . . . . . . . . . . . . . . . . . . 67
U
Product List context menu . . . . . . . . . . . . . . . . . . . . . . . . . 54 Use broadcast to find servers (Servers dialog box) . . . . . . . 61
Product List (View menu) . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Use Network License (License menu) . . . . . . . . . . . . . . . . 53
product, definition of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 user groups
publication date, of this guide . . . . . . . . . . . . . . . . . . . . . . . . 2 reserving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
R V
registered trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 vendor, of software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
requirements, for network hosting license server . . . . . . . . 12 version number
reservation file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 of this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
View menu (IAR License Manager) . . . . . . . . . . . . . . . . . . 52
S W
Sentinel RMS License Manager . . . . . . . . . . . . . . . . . . . . . 11
Servers dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 web site, IAR Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Servers (View menu) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Windows menu (IAR License Manager). . . . . . . . . . . . . . . 53
software distributor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
startup license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
definition of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
switching between licenses . . . . . . . . . . . . . . . . . . . . . . . . . 33
system requirements
client computer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
network license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
T
technical notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
technical support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Tools menu (IAR License Manager) . . . . . . . . . . . . . . . . . . 53
trademarks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
transfer license
definition of . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
71
LG_LMS2-4