Materialise Floating License Server

Administrator Guide

 

 

 

 

Contents

1 Introduction................................................................................................................................. 4

2  Materialise FloatingLicense Server Overview........................................................................... 4

2.1.  Processing licenserequests by Proxy Service................................................................... 5

2.2.  Licensing API Server........................................................................................................... 5

2.2.1 Health check................................................................................................................. 5

2.2.2  License usage status.................................................................................................... 5

3  Installing Materialise Floating License Server............................................................................ 7

3.1.  New installation................................................................................................................... 7

3.2. Upgrading earlier version.................................................................................................... 9

3.3.  License servercomponents.............................................................................................. 10

4  Managing LicenseServer......................................................................................................... 11

4.1.  Command line interface.................................................................................................... 11

4.1.1  Show help................................................................................................................... 11

4.1.2 Register service.......................................................................................................... 11

4.1.3  Unregister service....................................................................................................... 11

4.1.4 Start service................................................................................................................ 11

4.1.5  Stop service................................................................................................................ 11

4.1.6 Add key file.................................................................................................................. 12

4.1.7  Show systemID.......................................................................................................... 12

4.1.8  Show registered license keys..................................................................................... 12

4.1.9  List licensekey users.................................................................................................. 13

4.1.10  Delete license key..................................................................................................... 13

4.2. Configuration file............................................................................................................... 13

4.2.1  Overview..................................................................................................................... 14

4.2.2  General settings.......................................................................................................... 14

4.2.3  License key access permissions................................................................................ 14

4.2.4  License key reservation.............................................................................................. 18

4.2.5 Logging settings.......................................................................................................... 20

4.2.6  SSL settings................................................................................................................ 21

5  Managing Proxy Service........................................................................................................... 22

5.1.  Command line interface.................................................................................................... 22

5.1.1 Register service.......................................................................................................... 22

5.1.2 Unregister service....................................................................................................... 22

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

5.1.3 Start service................................................................................................................ 22

5.1.4 Stop service................................................................................................................ 22

5.2.  Configuration UI tool......................................................................................................... 22

5.2.1 Control buttons............................................................................................................ 23

5.2.2 Generic........................................................................................................................ 25

5.2.3  Log settings........................................................................................................................ 25

5.2.4  Automatic licenses renew settings..................................................................................... 25

5.2.5  Mail settings........................................................................................................................ 26

6  Managing License API Server.................................................................................................. 27

6.1.  Command line interface.................................................................................................... 27

6.1.1 Show help................................................................................................................... 27

6.1.2 Register service.......................................................................................................... 27

6.1.3 Unregister service....................................................................................................... 27

6.1.4 Start service................................................................................................................ 27

6.1.5 Stop service................................................................................................................ 27

6.2.  Configuration file............................................................................................................... 28

6.2.1 Overview..................................................................................................................... 28

6.2.2 General settings.......................................................................................................... 28

6.2.3 License Server connection settings............................................................................ 29

6.2.4 Logging settings.......................................................................................................... 29

6.2.5 SSL settings................................................................................................................ 30

7  Generating license reports with LicReport Tool....................................................................... 32

7.1  Introduction........................................................................................................................ 32

7.2  LicReport usage................................................................................................................. 32

7.2.1 License module usage report..................................................................................... 33

7.2.2 Log entries report........................................................................................................ 36

7.2.3 License list report........................................................................................................ 38

7.3  Command line parameters list........................................................................................... 40

Appendix A: Cipher List Format................................................................................................... 42

 

 

 

 

 

 

 

 

 

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

1   Introduction

This documentdescribes how to use the Materialise FloatingLicense Server for licenseadministrators.

 

2   Materialise Floating LicenseServer Overview

TheMaterialise Floating License Server provides the licenses to Materialisesoftware products via a network. The server receivesrequests from the software products,verifies the validity ofrequested license keys and returns the response data.

The floating licenses installedon the server contain the following information:

•      Numeric module ID, which identifies the software product’sfunctionality that can beused if this license valid;

•       Maximal allowedversion number;

•       Validity period of the license module;

•      Product key (CCKey or voucherkey) the licensemodule is generatedfor; Maximum number ofconcurrent connections.

 

The main components of the Materialise Floating License Serverare depicted on thefollowing diagram:

 

 

The following components are present on the Materialise Floating License Server:

•      License server – a service, which processes the license requestsfrom software products, which use the Licensing 7.x component (Magics23 and later software).

•      License storage 7.x – a storage, which keeps the license keys used by the License server component.

•      Proxy service – a service,which processes the license requestsfrom earlier software products, which do not use theLicensing 7.x components; this proxy service remains for the backwardscompatibility purposes.

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

•      License storage 6.x - a storage,which keeps the license keys used by the Proxy server component.

 

2.1.  Processing license requestsby Proxy Service

The followinglogic is used by the Proxy Servicewhen processing the license requestsfrom the software products:

1.    Forward request to the LicenseServer component.

2.   If the LicenseServer can locate the requestedlicense, forward the response to thesoftware product.

3.   If the LicenseServer cannot locate the requested licenseat step 1, try to locate it in the License Storage 6.x.

4.    Send the responseto the software product.

 

 

2.2.  Licensing API Server

 

 

REST Client

 

 

 

 

 

 

 

 

License API Server is a servicethat provides REST-interface for querying licenseserver state (e.g. licensesusage). It acts as a proxy for a License Server exposing its status via HTTP protocol.

 

2.2.1  Health check

License API Server provides/health endpoint for checking API service liveness.

 

This endpointaccepts GET requestsand replies with 200 status if API Server is workingproperly, 500 otherwise.

 

2.2.2  License usage status

License API Server provides/status endpoint for queriying LicenseServer licenses usage.

 

This endpointaccepts GET requestsand replies with a licensesusage status data structurein a JSON format, which looks like this:

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

 

In defaultconfiguration License API Server returnsall available (non-expired) licenses on the server (features) for a single vendorcalled ‘Materialise Floating License Server’.

Each featureobject contains information about maximum amountof users for a feature,actual current users, license type and lists of current user sessions.

Each sessionobject contains information about user and host name, used featureversion, session handle and amount of used licenses.

Server gives a 200 status code on successful query and 500 on error.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

3   Installing Materialise FloatingLicense Server

3.1.  New installation

Installation of the FloatingLicense Server is done with the help of the

FloatingLicenseServer.msi  installer  package.

1.    Start the installation

Press Next to proceedto the next step.

 

2.    Accept the licenseagreement in order to proceedfurther

3.    Select the components to install

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

The installation package proposesinstalling the followingcomponents:

-      License Server – in this case both the License Serverand the Proxy Service will beinstalled;

-      License Administrator – a UI tool,which allows viewing the licensekeys installed on this and other servers, as well asother operations, like registering new license keys;

-      License API Server– a server providing REST-interface to query LicenseServer status, licenses usage, etc.

 

4.    Specify the IP port numbers,used by the FLS components.

 

5.    When enable LicenseAPI Server you also need to specifyits port.

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

 

6.    Confirm selection and proceed to the installation

 

3.2.  Upgrading earlier version

Upgrading the installation of the Materialise Floating License Servercan also be done using the FloatingLicenseServer.msipackage.

When startingthe package on the host, where an earlier versionof the license server is installed, the installer provides auser with the notification about the upgrade.

 

 

 

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

After a user pressesUpgrade, the installation wizard follows the flow describedin the section

3.1.  New installation of this document.

 

 

3.3.  License server components

By default the Materialise Floating License Serveris installed in the following folder:

 

 

%PROGRAMFILES%\Materialise\Floating LicenseServer

 

 

The following components are installed:

•      MatLicenseServer.exe (7.0 subfolder)– the LicenseServer executable file, it is also registered as a WindowsService named “Materialise Floating License Server7”;

•      LicSrvFS60.exe –the Proxy Serviceexecutable file, also registered as a Windows Service named “MaterialiseFloating License Server 6.0”;

•       LicSrvConfig.exe – configuration UI tool for the Proxy Service component;

•       LicAdmin.exe(LicAdmin subfolder) – the LicenseAdministrator UI tool;

•      MatLicenseAPIServer.exe (APIServer subfolder) – theLicense API Server executable file, it is also registered as a WindowsService named “Materialise License API Server 7”. This component is installed if LicenseAPI Server feature is enabled.

 

 

 

 

 

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

4   Managing License Server

4.1.  Command line interface

A certainset of operations on the LicenseServer can be done using the commandline interface provided by MatLicenseServer.exe. This sectiondescribes the available commands.

4.1.1  Show help

Shows the list of available commandswith a brief description for each.Syntax:

MatLicenseServer.exe -–help

 

 

4.1.2  Register service

Registers the MatLicenseServer.exe as a “Materialise FloatingLicense Server 7” Windowsservice.

Syntax:

 

MatLicenseServer.exe –-register MatLicenseServer.exe –r

The commandrequires administrator rights to execute.

 

4.1.3  Unregister service

Unregisters the “Materialise FloatingLicense Server 7” Windows service.Syntax:

 

MatLicenseServer.exe –-unregister MatLicenseServer.exe –u

The commandrequires administrator rightsto execute.

 

4.1.4  Start service

Starts the “Materialise FloatingLicense Server 7” Windows service.Syntax:

 

MatLicenseServer.exe –-start

 

The command requires administrator rights to execute.

 

4.1.5  Stop service

Stops the “Materialise FloatingLicense Server 7” Windows service. Syntax:

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

MatLicenseServer.exe –-stop

 

The command requires administrator rights to execute.

Please note that the License Servercomponent cannot be stopped withoutfirst stopping the Proxy Service component.

 

4.1.6  Add key file

Adds licensekeys delivered in a key file to the licensestorage. Syntax:

MatLicenseServer.exe –-add <path_to_keyfile>

 

During the execution this command displaysthe progress of adding the modules from the key file:

 

4.1.7  Show system ID

Shows the system ID value of the host where the license serveris installed. Syntax:

MatLicenseServer.exe –-sysidExample:

 

4.1.8  Show registered license keys

Shows the list of the licensekeys registered on the licenseserver Syntax:

 

MatLicenseServer.exe –-list

 

The following data is shown for each key in thelist:

-             License module name;

-             Maximum allowed versionnumber;

-             Validity start date;

-             Validity end date;

-             Counter (not used);

-             Maximum number of users/number of current users;

-             CCKey the licensekey has been generated for;

-             License key uniqueidentifier (assigned by the licenseserver after registration) Example:

 

 

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

 

4.1.9  List license key users

Shows the list of the users and hosts,which are currentlyusing the specifiedlicense key. Syntax:

MatLicenseServer.exe –-list-users <unique_id>

 

The commandrequires the licensekey’s unique ID as a parameter, it can be obtained via output of the –-list command.

Example:

 

4.1.10  Delete licensekey

Deletes a license key from the storage.Syntax:

MatLicenseServer.exe –-delete<unique_id>

 

The commandrequires the licensekey’s unique ID as a parameter, it can be obtained via output of the –-list command.

Example:

 

4.2.  Configuration file

 

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

 

4.2.1  Overview

The configuration of the LicenseServer component is defined in thesettings.ini file, which has to be located in the same folder as MatLicenseServer.exe.

If there is no configuration file available at the momentof License Serverstart, it is createdby the server and filled in with default values. In order to applychanges in the file to the License Server, the latter must be restarted.

All valuesin the configuration file are case-insensitive.

 

4.2.2  General settings

The generalconfiguration settings of the LicenseServer component must be definedunder the [general] section in the configuration file.

Below you can find an exampleof the configuration file contentwith the default general settings values.

 

port

The IP port used by the License Serverfor incoming connection. Example:

uselogfile

A flag indicating if the LicenseServer must generatelog file during its work.

 

logfilepath

Path to the log file createdby the License Server. This parameter is only valid if the

uselogfile parameter is set to 1.

 

 

loglevel

The level of log detail(0 – trace, most thorough; 1 – info; 2– warning; 3 – error).Default is 1.

 

 

4.2.3  License key access permissions

Materialise FloatingLicense Server allowsconfiguring access permissions to the licensekeys for specific users and hosts.

Access permissions can be configured using white- and blacklist modes:

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

-      Blacklist defines the users/hosts, which are not allowedusing the license keys; users, which are not in the blacklist, canuse the requested license key;

-      Whitelist defines the users/hosts, which are explicitly allowed using the license keys; users, which are not in thewhitelist, cannot use the requested license key.

Both blacklists and whitelists can be definedfor the following entities:

-       Entire server

-       Specific licensemodules

-       Specific CCKeys

Specificationof a blacklist has a precedence over a whitelist, e.g. if the same user/host islisted in both blacklist and whitelistfor the same entity, the license serverdenies accessing the requestedlicense key.

The following access permission checklogic is used a softwareproduct requests a licensekey:

1.   If the user or the hostis in the blacklist for theentire server, access is denied.Otherwise proceed to step 2.

2.   If a whitelistis defined for the entire server and neither the user nor the host is in thiswhitelist, access is denied. Otherwise proceed to step 3.

3.   If the user or the hostis in the blacklist for the requested module ID, accessis denied. Otherwise proceedto step 4.

4.   If a whitelistis defined for the requestedmodule ID and neither the user nor the host is in this whitelist, access isdenied. Otherwise proceed to step 5.

5.   If the user or the hostis in a blacklist for the CCKey the requestedmodule belongs to, access is denied. Otherwise proceed tostep 6.

6.   If a whitelistis defined for the CCKey the requestedmodule ID belongsto and neither the user nor the host is in this whitelist, access isdenied. Otherwise access is granted.

 

User and host groupsdefinition

Access permissions to the licensekeys can be configured for specific users, host, but also user and host groups.

Configuration of user groups is done under the [usersgroups] section of the configuration file. Below you can find anexample of defining the user groups named u_group1 and u_group2:

 

Configuration of host groups is done in a similar way, different section[hostsgroups] is used. Below you can find an example ofdefining the host groups h_group1 and h_group2:

 

 

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

Server access permissions

Access permissions to the entire license servercan be defined with the help of settings under the [general] section.

 

blacklistuseres

The list of users or user groups,which are prohibited from accessing any of the license keys registered on thelicense server.

Example:

 

whitelistusers

The list of users or user groups,which are allowedto use license keys registered on the license server. Users, which are not in this list, areprohibited from using the license keys on the server.

Example:

 

blacklisthosts

The list of hosts or host groups,which are prohibited from accessing any of the licensekeys registered on the license server.

Example:

 

 

whitelisthosts

The list of hosts or host groups, which are allowed to use license keysregistered on the license server.Software products on hosts, whichare not in this list, areprohibited from using the license keys on the server.

Example:

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

License module access permissions

Access permissions to specifichosts can be defined under the following sections:

-      blacklistmoduleusers – definesusers and user groups, which are not allowed using the specified license module;

-      whitelistmoduleusers – definesusers and user groups, which are explicitly allowed using the specified license module;

-      blacklistmodulehosts – defineshosts and host groups, which are not allowed usingthe specified license module;

-      whitelistmodulehosts – defineshosts and host groups, which are explicitly allowed using the specified license module.

In order to define accesspermissions to a specificmodule a setting must be added under one of sections listed above.The name of this settingmust be the respective module ID, the value– a list of the users or hosts in the black- or whitelist respectively.

Example of blacklist definitions:

 

Example of whitelist definitions:

 

 

 

CCKey access permissions

Access permissions to specifichosts can be defined under the following sections:

-      blacklistproductkeyusers – definesusers and user groups, which are not allowedusing the specified license module;

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

-      whitelistproductkeyusers – definesusers and user groups, which are explicitly allowed using the specified license module;

-      blacklistproductkeyhosts – defineshosts and host groups, which are not allowed using the specified license module;

-      whitelistproductkeyhosts – defineshosts and host groups, which are explicitly allowed using the specified license module.

In order to define access permissions to a specific CCKey a setting must beadded under one of sections listed above. The name of this settingmust be the respective moduleID, the value – a list of the users or hosts in the black- or whitelistrespectively.

Example of blacklist definitions:

 

Example of whitelist definitions:

 

4.2.4  License key reservation

TheMaterialise Floating License Server allows reserving certain number concurrentlicenses for certain users or hosts. If a license is reserved in such a way fora user, other users cannot use it and therefore it alwaysremains available for that user. For example, if a license module 21 registered on a license serverhas maximum number of connections 5, and 2 of them are reserved for USER1,other users can only consume 3 remaining connections even if the USER1 is notcurrently using this license module.

The licensereservations can be defined in the configuration file with the help of reservationgroups. Each such group is defined as a section according to the followingformat:

[reservationgroup <group_id>]

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

 

Each such section can contain settingswith the following names.

 

modules

Defines the list of modules, which must be reserved.

 

productkeys

Defines the list of CCKeys,which must be reserved. If the one is defines,all the modules with thisCCKey are reserved for specified users/hosts.

 

 

users

Defines the list of users and user groupsthe specified modulesmust be reserved for.

 

 

hosts

Defines the list of host and host groupsthe specified modulesmust be reservedfor.

 

 

size

 

The number of connection that must be reserved for specified users and modules. Default value is 1.

 

In the following example2 connections to the licensemodule 21 are reserved for user1,user2, user101, user102:

 

Ifreservations for same license keys are defined in different groups, they addup. For example, license module 21is registered as a part of the CCKey C6B5-82C8-49B4-8D33. Followingreservations are defined:

1.    Module 21, 2 connections reservedfor user1, and user2.

2.   CCKey C6B5-82C8-49B4-8D33, 3 connections reservedfor user1 and user3.In this case 5 connections will be reserved for user1.

 

If a reservation group contains both list of users andhosts, this reservation applies to users logged on these hosts.For example, the configuration file contains the following reservation definition:

 

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

 

In this case the reserved licensescan be used by:

1.  user1 on host1

2.  user1 on host2

3.  user2 on host1

4.  user2 on host2

 

 

4.2.5  Logging settings

Extended loggingsettings are configured via the [logger]section. This settingstake precedence over the settings in the [general] section.

Below you can find an exampleof the configuration file contentwith the default logging settings values.

 

UseLogfile

A flag indicating if the LicenseServer must generatelog file during its work.

 

LogFilePath

Path to the log file createdby the License Server. Supports specifying path as a pattern with counter (%N) and date time (%Y,%m,%d,%H,%M,%S) placeholders

 

 

LogLevel

The level of log detail(0 – trace, most thorough; 1 – info; 2– warning; 3 – error).Default is 1.

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

 

RotateLogs

Whether to enable log rotation based on the log filessize.

 

LogFileRoationSize

The size of the file at which rotationshould occur, in bytes.

 

MaxTotalLogsSize

The maximumtotal size of log files in folder,in bytes. If the thresholdis exceeded, the oldest file(s) is deleted.

 

MinFreeDiskSpace

Minimum free space on disk,in bytes. If the thresholdis exceeded, the oldest file(s)is deleted to free space.

 

 

4.2.6  SSL settings

 

HTTPS SSL/TLS settingsare configured via the [ssl] section. Belowyou can find an example of theconfiguration file content with the default settings values.

 

 

 

CipherList

Specifies the supported ciphersin OpenSSL notation(see Appendix A).

Default cipherlist string means using all available ciphers except ciphers containingADH,LOW,EXP,MD5,RC4 and 3DES algorithms; the ciphers are ordered/prioritized by the encryption algorithm key length, soby their reliability.

After updatingthis value the services MatFloatingLicenseServer60 and MatLicenseServer7 require a restart.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

5   Managing Proxy Service

 

5.1.  Command line interface

A certainset of operations on the License Server can be done using the command line interface providedby LicSrvFS60.exe. This sectiondescribes the availablecommands.

 

5.1.1  Register service

Registersthe LicSrvFS60.exe as “Materialise Floating LicenseServer 6.0” Windows service.

Syntax:

 

LicSrvFS60.exe /r

 

The command requires administrator rights to execute.

 

5.1.2  Unregister service

Unregisters the “Materialise FloatingLicense Server 6.0” Windows service.Syntax:

 

LicSrvFS60.exe /u

 

The command requires administrator rights to execute.

5.1.3  Start service

Starts the “Materialise FloatingLicense Server 6.0” Windows service.Syntax:

 

LicSrvFS60.exe /start LicSrvFS60.exe /s

The commandrequires administrator rightsto execute. Please note that the Proxy Service

component cannot be startedwithout first startingthe License Servercomponent.

 

5.1.4  Stop service

Stops the “Materialise FloatingLicense Server 6.0” Windows service.Syntax:

 

LicSrvFS60.exe /stop

 

The command requires administrator rights to execute.

 

 

5.2.  Configuration UI tool

The ProxyService configuration tool provide evolvedfrom the LicenseServer Configuratorapplication installed next to the license server (both local and floating)version 6.x. At the

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

moment it can only be used to configurethe settings of the Proxy Server, the settings of theLicense Server can be configured via its INI-file.

The configuration tool can be launched with the help of the LicSrvConfig.exe executable file installed next tothe LicSrvFS60.exe.

 

The main screen containstwo major sections:

1.    Floating License Server contains the parameters of the ServerProxy.

2.   Remote Servers can be used to edit the connections to the licenseservers. These settings are used by the software products installed onthe same host.

This chaptercontains the description of the parameters in the FloatingLicense Server section.

 

5.2.1  Control buttons

The following control buttonsare available in the FloatingLicense Server section.

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

 

Start

Starts the Proxy Service.The button is disabled if the serviceis already running.

 

Stop

Stops the Proxy Service.The button is disabled if the serviceis not running.

 

Find IPport

Automatically finds availableIP port that can be used by the ServiceProxy. The buttonis disable if the service is running.

 

Show Log

Toggles showing the ServiceProxy log output.

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

 

5.2.2  Generic

IP port

The value of an IP portused by the Proxy Service,the parameter can only be edited if the Proxy Service is stopped.

 

AutoPassword server URL

The URL of the AutoPassword server, which the Proxy Serviceconnects to when performing the license keysautomatic renewals operation.

 

5.2.3  Log settings

This section contains parameters used by the Proxy Servicefor generating the log file.

 

Log to file

A flag indicating if logging to a file must be turned on.

 

Log file location

Path to a folderwhere the log file will be created.Only used if the loggingto file is on.

 

Split log file

A flag indicating if the log file must be split if it reachessome maximum size value.Only used if the logging to file is on.

 

Log file size

Maximum size of the generatedlog file. If the file becomes bigger,it’s being rolled over.

 

5.2.4  Automatic licensesrenew settings

This sectioncontains parameters for the automaticrenewal of the license keys using the AutoPassword Service.

 

Renew licenses with CC-key

Turn the automatic renewalof the license keys generated for CCKeys ON or OFF.

Renew licenses with Vouchers

Turn the automatic renewalof the license keys generatedfor vouchers ON or OFF.

Days till licenseexpired

Number of days before the license key expiration when the auto-renewal will be initiated.

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

 

5.2.5  Mail settings

This sectioncontains the settingsused by the Proxy Serviceto use the license key notification e-mails.

 

Send e-mail notification

Turn the e-mail notifications ON or OFF.

 

Days till licenseexpired

The number of days till the licensekeys expiration when an e-mailnotification will be sent. Only used when e-mailnotifications are turned on.

 

SMTP server

The address of the SMTP server used to send the e-mails.Only used when e-mailnotifications are turned on.

 

SMTP port

The IP port number on the SMTP server,which is used to send the e-mails.Only used when e-mail notifications are turned on.

 

Security type

The security type settingfor the SMTP server. Threeoptions are available:

1.   No security

2.   SSL

3.   TLS

Only used when e-mailnotifications are turnedon.

 

Username

User name requiredto logon to the SMTP server. Only used when e-mail notifications are turned on.

 

Password

The password requiredto logon to the SMTP server. Only used when e-mailnotifications are turned on.

 

From

Sender’s e-mail address. Only used when e-mail notifications are turned on.

 

To        Receiver’s e-mail address.Only used when e-mail notifications are turned on.

Subject

Text used as notification e-mailssubject. Only used when e-mailnotifications are turned on.

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

6   Managing License API Server

6.1.  Command line interface

Acertain set of operations on the License Server can be done using the commandline interface provided by MatLicenseAPIServer.exe. This sectiondescribes the available commands.

6.1.1  Show help

Shows the list of available commandswith a brief description for each.Syntax:

MatLicenseAPIServer.exe -–help

 

 

6.1.2  Register service

Registers the MatLicenseAPIServer.exe as a “Materialise LicenseAPI Server 7” Windowsservice. Syntax:

MatLicenseAPIServer.exe –-register MatLicenseAPIServer.exe –r

The commandrequires administrator rightsto execute.

 

6.1.3  Unregister service

Unregisters the “Materialise License API Server7” Windows service.Syntax: MatLicenseAPIServer.exe–-unregister MatLicenseAPIServer.exe –u

The commandrequires administrator rightsto execute.

 

6.1.4  Start service

Starts the “Materialise LicenseAPI Server 7” Windows service.Syntax:

 

MatLicenseAPIServer.exe –-start

 

The command requires administrator rights to execute.

 

6.1.5  Stop service

Stops the “Materialise LicenseAPI Server 7” Windows service.Syntax:

MatLicenseAPIServer.exe –-stop

 

The command requires administrator rights to execute.

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

6.1.6 Restart service

Stops and starts the “Materialise LicenseAPI Server 7” Windows service.Syntax:

MatLicenseAPIServer.exe –-restart

 

The command requires administrator rights to execute.

 

 

6.2.  Configuration file

 

6.2.1  Overview

The configuration of the License API Server component locates in the

MatLicenseAPIServer.ini file in the same folder as MatLicenseAPIServer.exe.

Ifthere is no configuration file available at the moment of License API Serverstart, it is created by the server and filled in with defaultvalues. To apply changesin the file to the License API Server, you need torestart the service.

All keys in the configuration file are case-insensitive.

 

6.2.2  General settings

The generalconfiguration settings of the LicenseAPI Server componentare defined under the [general] section in theconfiguration file.

Below you can find an exampleof the configuration file contentwith the default general settings values.

 

port

The IP port used by the License Serverfor incoming connections.

uselogfile

A flag for enablinglog file generation by the LicenseAPI Server.

logfilepath

Path to the log file to be created by the LicenseAPI Server. This parameter is only valid if theuselogfile parameter is set to 1.

loglevel

Specfies generated log verbosity level. 0– most detailed logs (trace),1 – info, 2 – warning, 3 – only errors. Default valueis 1.

 

 

 

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

6.2.3  License Server connection settings

License API Server works as a proxy for License Serverand requires an establishedconnection to work properly. This connection configuration is defined under the[licenseserver] section in the configuration file.

Below you can find an exampleof the configuration file contentwith the default general settings values.

 

port

The IP port used to connect to the LicenseServer.

 

 

host

The hostname used to connect to the LicenseServer.

 

 

vendorname

Vendor name of the License Server.Used in the server API model.

 

 

6.2.4  Logging settings

Extended loggingsettings are configured via the [logger]section. This settingstake precedence over the settings in the [general] section.

Below you can find an exampleof the configuration file contentwith the default logging settings values.

 

 

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

UseLogfile

A flag indicating if the LicenseServer must generatelog file during its work.

 

LogFilePath

Path to the log file created by the License Server. Supports specifyingpath as a pattern with counter(%N) and date time (%Y,%m,%d,%H,%M,%S) placeholders

 

 

LogLevel

The level of log detail(0 – trace, most thorough; 1 – info; 2– warning; 3 – error).Default is 1.

 

RotateLogs

Whether to enable log rotation based on the log filessize.

 

LogFileRoationSize

The size of the file at which rotationshould occur, in bytes.

 

MaxTotalLogsSize

The maximumtotal size of log files in folder,in bytes. If the thresholdis exceeded, the oldest file(s) is deleted.

 

MinFreeDiskSpace

Minimum free space on disk,in bytes. If the thresholdis exceeded, the oldestfile(s) is deleted to freespace.

 

 

6.2.5  SSL settings

HTTPS SSL/TLS settings are configured via the [ssl]section.

 

certificate

Contains the path to the certificate file (in PEM format).

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

 

private_key

Contains the path to the privatekey file used for encryption. If empty,default private key file is used.

 

private_key_password

Contains password to the private key file used for encryption.

 

ca_certificate

Contains the path to the file or directorycontaining the CA/rootcertificates.

 

verify

Specifies whether peer verification should be enabled.

 

verification_depth

Sets the upper limit for verification chain sizes. Verification will fail if a certificate chain larger than this is encountered.

 

CipherList

Specifies the supported ciphersin OpenSSL notation(see Appendix A).

Default cipherlist string means using all available ciphers except ciphers containingADH,LOW,EXP,MD5,RC4 and 3DES algorithms; the ciphers are ordered/prioritized by the encryption algorithm key length, soby their reliability.

After updatingthis value the services MatFloatingLicenseServer60 and MatLicenseServer7 require a restart.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

7   Generating license reportswith LicReport Tool

 

7.1  Introduction

 

The License serverreporting tool allowsgenerating easy readablereports from aboutthe license server’s work. Below the reporting tool’s workflow isdemonstrated:

 

 

 

 

The License server generates a log file during its work. The log file isread by the LicReport application, its content is analyzed and the resultof the analysis is saved in an XMLfile that can be used for further screening.

Besides the LicReport saves the hardcoded version of the XSL transformation file that can beused for the LicReport.xml for its transformation to the HTML format.

 

7.2  LicReport usage

 

LicReport tool comes with the installation of the LicAdmin. Its defaultlocation is C:\Program Files\Materialise\Floating LicenseServer\LicAdmin\LicReport.exe. It can also be delivered as a commandline tool named LicReport.exe, its work is regulated by the command line parameters.

There are three main usage modes: licensemodule usage report,log entries reportand server license list report.

 

 

 

 

 

 

 

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

7.2.1  License moduleusage report

 

Thismode is used to generate the output containing the information about theseparate license modules usage duration. By default the XML file named LicReport.xml is generated, its schema is demonstrated below:

 

<?xml version="1.0" encoding="UTF-8"?>

<!-- edited with XMLSPYv5 rel. 4 U (http://www.xmlspy.com) by Johan Duchateau(Materialise N.V.) -->

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">

<xs:element name="Report">

<xs:annotation>

<xs:documentation>Root element</xs:documentation>

</xs:annotation>

<xs:complexType>

<xs:sequence>

<xs:element name="Generated" type="xs:dateTime">

<xs:annotation>

<xs:documentation>Date/time when the reportis generated</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Usages">

<xs:annotation>

<xs:documentation>License usages information</xs:documentation>

</xs:annotation>

<xs:complexType>

<xs:sequence>

<xs:element name="Module" minOccurs="0" maxOccurs="unbounded">

<xs:annotation>

<xs:documentation>Specific module usage information</xs:documentation>

</xs:annotation>

<xs:complexType>

<xs:sequence>

<xs:element name="ID" type="xs:integer">

<xs:annotation>

<xs:documentation>Module ID</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Name" type="xs:string">

<xs:annotation>

<xs:documentation>Module name</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Version" type="xs:string">

<xs:annotation>

<xs:documentation>Module version</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Type" type="xs:integer">

<xs:annotation>

<xs:documentation>License type: 0 - license, 1 - evaluation</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Platform" type="xs:integer">

<xs:annotation>

<xs:documentation>License platform:0 - win32, 3 - x64</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Blocks">

<xs:annotation>

<xs:documentation>Specific module usage blocks</xs:documentation>

</xs:annotation>

<xs:complexType>

<xs:sequence>

<xs:element name="Usage" minOccurs="0" maxOccurs="unbounded">

<xs:annotation>

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

<xs:documentation>Module usage block</xs:documentation>

</xs:annotation>

<xs:complexType>

<xs:sequence>

<xs:element name="Day" type="xs:date">

<xs:annotation>

<xs:documentation>Date part of the license acquiringmoment</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Time" type="xs:time">

<xs:annotation>

<xs:documentation>Time part of the license acquiringmoment</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Duration" type="xs:duration">

<xs:annotation>

<xs:documentation>License usage duration</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Seconds" type="xs:integer">

<xs:annotation>

<xs:documentation>License usage duration in seconds</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="TypeEx" type="xs:integer">

<xs:annotation>

<xs:documentation>0 - real license,1 - temporary</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Host" type="xs:string">

<xs:annotation>

<xs:documentation>Host the license is obtained by</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Timeout" type="xs:boolean">

<xs:annotation>

<xs:documentation>Specifies if the licenseis released on timeout</xs:documentation>

</xs:annotation>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="Duration" type="xs:duration">

<xs:annotation>

<xs:documentation>Sum of all the module usage blocks durations</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Seconds" type="xs:integer">

<xs:annotation>

<xs:documentation>Sum of all the module usage blocks durationsin seconds</xs:documentation>

</xs:annotation>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

<xs:element name="Duration" type="xs:duration">

<xs:annotation>

<xs:documentation>Sum of all the license moduleusages</xs:documentation>

</xs:annotation>

</xs:element>

<xs:element name="Seconds" type="xs:integer">

<xs:annotation>

<xs:documentation>Sum of all the license moduleusages in seconds</xs:documentation>

</xs:annotation>

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com

 

 

 

 

</xs:element>

</xs:sequence>

</xs:complexType>

</xs:element>

</xs:schema>

 

 

The LicReport can analyze log files both for the local and the floatingversion, in the second case itmust run on the same PC where the floating server is installed.

 

The log file to analyze can be specified using one of two commandline keys:

 

--find-file [local|floating]

 

this way the LicReport will try to locate the path to the log file usingthe settings of the respective license server;

 

--input-file <path>

 

this way the exactlocation of the log file can be specified.

It is necessary to set one of the keys shownabove, otherwise the LicReport willreturn.

It is also possible to specify the time period for the log entriesto be analyzed using the following keys:

 

--from-date <yyyy-mm-dd hh:mm:ss>

--until-date <yyyy-mm-dd hh:mm:ss>

 

If the period is not specified, the entire log file will be used.

The path to the output file can be set usingthe following commandline key:

 

--output-file <path>

 

If it is not set, the file named LicReport.xml will be generatednext to the input log file.

It is possible to generatemodule usages in the CSV format by using the --csv-outputkey. The report will contain the following headers by default,: UsageID, ModuleID, Module, Version,  Type,  TypeEx, Platform,  UserName,  Host,  Day,  Time,  Duration,  Seconds,  Timeout. Itis possible to select only specific headers by providing a comma-separatedlist of headers to as a commandargument.

 

 

 

 

 

 

 

 

Materialise nv I Technologielaan 15 I 3001 LeuvenI Belgium I info@materialise.com I materialise.com