The information on this page refers to License Statistics v6.20 or newer, which removed support for Windows Server 2012 R2. If you are using a version previous to v6.20, see documentation for previous versions. |
This section describes the installation and configuration of the License Statistics Agent add-on tool. Also see Reviewing and managing License Statistics Agents for information on viewing a report of all agents in use.
During communication between License Statistics Server Agents and License Statistics, some sensitive data (for example, the administrative password for the LM-X license server that is used by the query tool installed on the server (agent) host) can be sent through the HTTP protocol. It is therefore recommended to use secured SSL (HTTPS) when using Server Agents. |
Installation of License Statistics Agent has the following requirements:
Windows 64-bit |
---|
|
Hardware | Minimum |
---|---|
CPU | 2 core |
RAM | 1 GB |
Hard Drive | 1 GB |
To install License Statistics Agent:
Alternatively, you can install/update License Statistics Agent from a command line (or remotely) using the msiexec tool. You must have administrative privileges to use this tool.
The msiexec tool uses the following syntax:
msiexec /i {msi_installer} INSTALLDIR="{path}" LICSTATURL="{url}" LICSTATTOKEN="{token}" AGENTMODE="{mode}" /qn
Parameter | Required | Definition | Default Value |
---|---|---|---|
INSTALLDIR | No | Full path to License Statistics Agent installation directory | C:\Program Files\X-Formation\License Statistics Agent |
LICSTATURL | Yes | The endpoint to the License Statistics license server that License Statistics Agent will communicate with. | N/A |
LICSTATTOKEN | Yes | The Agent API authorization token, which License Statistics administrators can generate as described in API access | N/A |
AGENTMODE | No | The scope in which the Agent will operate; either "enduser" or "server" | enduser |
PSSUSPENDINSTALL | No | Indicator of whether to install the Optional Harvesting Tools (PSSuspend.exe), which enables use of License Harvesting Suspend mode; either 1 or 0 | 1 |
An example of command line installation is shown below.
msiexec /i license_statistics_agent_v6.17.0_win64_x64.msi LICSTATURL="https://licstat.company.com" LICSTATTOKEN="a479b76168de65fe42af853f651b637d" AGENTMODE="enduser" PSSUSPENDINSTALL=1 /qn |
You provide configuration information for License Statistics Agent using the Agent Configuration tool, which is installed along with the Agent. You must have administrative privileges to use this tool.
To access the configuration tool:
The configuration tool opens.
Configuration settings are described in the table below.
Configuration setting | Required | Description |
---|---|---|
License Statistics URL | Yes | The License Statistics URL is an endpoint to the License Statistics license server that License Statistics Agent will communicate with. The Agent will connect to the server and receive all necessary configuration information silently. |
Agent API Token | Yes | The Agent API Token is an authorization token, which License Statistics administrators can generate as described in API access. |
Flags | No | Flags define custom options for Agent execution and should not be used unless instructed to do so by X-Formation Support. |
Agent Mode | Yes | The Agent Mode can be changed at any time, but the Agent can operate in only one mode at a time. |
Optional Harvesting Tools | No | Installs or reinstalls Optional Harvesting Tools, which is required for using the Suspend harvesting release method. Applies to End User Agent Mode only. |
After changing the Agent configuration, the Agent must be restarted to begin using the modified configuration. |
Note the following:
After installation, an Agent icon is visible in the tray when:
When installing License Statistics Agent on dynamically created virtual machines, either do not connect to License Statistics or be sure to delete the C:\ProgramData\X-Formation\License Statistics Agent\AgentId.txt file before creating an image of the virtual machine. Otherwise, the machines may all use the same Agent ID and License Statistics will treat all Agents on the machines as a single instance, because the ID was assigned during the first connection to License Statistics, before creating the image. |
You can also use the Agent Manager to:
If you make changes to the configuration when the service is running, you will see a message that asks whether you want to restart License Statistics. You must restart License Statistics for any changes to the configuration to take effect.
License Statistics Agent can be uninstalled using the standard Windows uninstallation procedure. Uninstalling License Statistics Agent stops the service and removes it from the system. Optionally, you can specify during uninstallation to remove the user data, including logs, configuration file, etc.
If you choose to retain the user data, it will be reused if License Statistics Agent is reinstalled (for example, the configuration data will be automatically filled in on the configuration form during installation).