License server

One or more license servers control — allow or deny and log — the usage of the software on one computer or throughout the local network.

Local Licensing

Usually node-locked licensing is controlled by a local license server on the computer executing the licensed software.

The licensed program automatically starts the license server. It is terminated when the program ends. There is no special configuration needed.

Central licensing

Floating licensing is controlled network-wide by one or more license servers. However, node-locked licenses may be administered by central license servers, too.

All license servers of a local network should have license directories with identical contents. Though, the license directories must not be mounted by for instance NFS. The web interface (Web interface) allows to easily synchronize multiple license directories.

Master and slave

Multiple license servers in a local network agree upon one master license server. Each of the other license servers, the slaves, may take over the role of the master as soon as this one fails.

At any time at least more than half of the license servers referred to by a license key (System ID) must be running.

Configuration

The license server may be configured by command line arguments.

The output of error messages, warning messages and other messages is specified by the arguments

-logDestination -|stdout|stderr|syslog|file_name

If file_name ends with .html or .htm, the messages are output in HTML format, else in plain text format. The default destination depends on the user executing the xlicense program: /var/opt/XSOXlicense/logs/xlicense-user_name.log.

The arguments

-logTypes {[+|-]checkInCheckOuts|[+|-]denials|[+|-]warnings|[+|-]hints}...

configure the types of messages:

checkInCheckOuts reports the use of individual licenses.

denials reports the denial of license requests.

warnings prints warning messages.

hints prints additional informations.

Besides error messages, which are printed always, denials and warnings are printed by default.

The remaining configuration arguments are useful with central licensing (Central licensing) only.

The arguments

-owner user:group

specify the user for who the license server should be started and her group. This is only necessary if there is a special user for license administration.

The argument

-slave

increases the probability that the started license server becomes a slave (Master and slave). If there are other license servers started without this configuration argument, one of these will become master. This is needed in special cases only, because the license servers automatically determine a master.

The argument

-sync IP_address|network_name|host_name...

lets multiple license server synchronize themselves over (sub)net borders. One argument specifies a network by the address or the name of the network or a host of the network.

The argument

-webPort port_number

specifies a port number, under which the web interface (Web interface) of the license server may be contacted. The default port_number 0 disables the web interface.

Start

The license server is manually started by the command

/opt/XSOXlicense/bin/xlicense [license_directory]

The default value for license_directory is /etc/opt/XSOXlicense/licenses.

However, for safe operation the license server should be started automatically during the start-up of the computer. The simplest method is the modification of the system file /etc/inittab (you need the access rights of the superuser root).

Add to the file /etc/inittab the following line:

XLS:2345:respawn:/opt/XSOXlicense/bin/xlicense

Then execute the command

init q

to make the modification effective.

Web interface

The web interface of the license server may be contacted using an arbitrary web browser under the URL address

http://hostname:port_number

Hostname determines a computer executing a license server — master or slave. The port_number can be configured (Configuration). You need the login name and password of the user executing the current master license server for authorized access.

The web interface shows the current state of all license servers of the local network, refreshed every 60 seconds, condensed and sorted:

the license keys in the upper part

and the license servers and license directories in the lower part.

For each license key the display shows:

the names of the computers executing the license servers which control the key; each hostname is linked to the corresponding license file;

each user of the license key, her clear name if known, the hostname of her computer and the time period of use;

limitations of number or time.

For each license directory the display shows:

the hostname of the computer hosting the directory;

a link to the log file if configured;

the uptime of the license server;

the names of all license files in the directory.

For each license file there are three links, which trigger one of the following actions:

The first link displays the license file.

"Distribute" lets the corresponding license server send the license file to all other license servers, which store it in their respective license directories.

"Remove" deletes the license file from the directory irrecoverably.