The license server installation guide covers the basic installation and usage of the XLSTAT license server. It is made for the most simple usecases.
You might want to adjust the service settings based on the requirements of the network of your organization, or improve the security around its administration. This guide is meant to help you on that matter.
License server admin tool
This guide makes use of
xnlsadmin.exe. It is a command line tool that is bundled with the server installation.
It allows to manage the local service installation and query and modify details about the running licensing service. It is available in the license server installation directory and should be usable directly by typing
xnlsadmin in a command prompt.
Changing default server settings
As it affects local service information, these commands must be run on the local machine the XLSTAT server is installed and running on. For the same reason, the commands must be launched as an administrator.
After the modification of the settings, it is required to restart the server. This can be done via
services.msc or by typing the following manage command as an administrator:
xnlsadmin service restart
Changing the default port
The server listens on the TCP port 7070 by default. This can be changed by running this command:
xnlsadmin service set Port NEW_PORT
Restart the service for the change to take effect.
Connecting through a proxy
Your network might require to go through a proxy to access the internet. If you wish to activate the license server automatically, it would have to connect via that proxy.
You can configure it using the commands below. Replace the all-caps words with your values.
xnlsadmin service set ProxyAddress PROXY_IP_OR_DNS xnlsadmin service set ProxyPort PROXY_PORT
Restart the service for the changes to take effect.
Administrating and querying server information
The license service embeds an API that allows to query information about its usage. This API is exposed via
xnlsadmin. Providing the
--help argument lists what it can be used for:
clients: Review the usage details and history of the XLSTAT clients,
config: Edit the licensing service configuration,
license: Management of the license activated on the server,
status: Print the status of the service, including current and maximum token amount. This command also allows to suspend/resume server activity.
users: Manage the users allowed to access the license server administration. This is used when security is enabled (see below),
connect: Setup the connection between this tool and the remote license server (more details below),
service: Allows to manage the service installation on the local server machine.
Apart from the
service command, all commands can be ran remotly.
Remote administration via the command line tool
xnlsadmin.exe command is a standalone software that can be ran on any computer. It allows to administrate and query information about the XLSTAT server remotly.
By example, if the amount of in-use tokens has to be monitored by your monitoring platform, the command can be copied and executed there. In order to initialize the connection to the XLSTAT license server, run the
connect command before-hand on the remote computer:
This will request the input of server connection details (address and port) along with whether or not authentication should be used (refer to Improving administration security below).
After initializing the connection, such a command could be ran automatically by the monitoring service:
xnlsadmin status --get TOKENS_FREE
Improving administration security
By default, the license server can be managed and monitored without authentication. This can be improved by enabling the server security.
To do so, launch a command line tool then type in the following command:
xnlsadmin config set security.enabled true
From now on, every access to the administration interface requires an authorization. In order to configure the credentials to use, run the
Connection information will then be requested:
- Server address: XLSTAT license server to connect to. This would be
localhostif it is the local machine, its IP or DNS address otherwise,
- Server port: The port the server listens on (7070 by default),
- Use authentication: Yes,
- Password: Password of the user. admin's default password is
After initializing the connection, the admin password can be changed via the following command:
xnlsadmin users edit --name admin --ask-password
The password will be requested by the command. After it is changed, don't forget to run the
connect command again to reinitialize the credentials to be used for the connection.