# Reprise License Manager (RLM)

# Introduction

Open iT supports Reprise License Manager (RLM) usage reporting through the autoconfigurator by detecting configurations used to set the license manager data collection automatically. On the other hand, if you need to configure its behavior manually, the following sections will guide you on the required configuration for license manager utility polling and log file parsing.

Apply the configurations shown in the Open iT client.

# Configuring License Manager Utility Polling

Open iT polls the license servers at regular intervals to get the current status of its license use and availability. This will produce the following aggregated data types used for historical and real-time reporting:

The following sections will guide you in setting up the necessary configuration to collect and send the required data to the server.

# Requirements

An Open iT Client connected to an Open iT Server or a coexistent Open iT setup
Activated LicenseAnalyzer collection and license poller
License server administrative rights
Running license manager utility binary and its location

# Getting the License Status Utility Binary Location

This configuration requires the path to the license status utility binary, rlmstat, to obtain the license status information. Get this by following these steps:

Through the Interface

Open the Task Manager.
Go to the Details tab.
Locate rlmstat.
Right-click and choose Open file location.
The path of the binary will be displayed.

Through the Command Line

Open a command prompt with Administrator level privileges.
Run the following command to locate the binary:
Command Syntax
```
 where /r <installation_drive> rlmstat
```
where <installation_drive> is the drive where the license manager is installed.
Example
```
 where /r C:\ rlmstat
```
The path of the binary will be displayed.

After verifying the path of the polling program, make sure that it is running.
Open a command prompt in the directory of the license server executable or the polling program and run the following command:

Command Syntax
rlmstat -a

Example
rlmstat -a

Make sure that there are no errors encountered.

Run the following command to locate the binary:

Command Syntax
find . | grep rlmstat

The path of the binary will be displayed.

# Configuring Data Collection

These are the required steps to activate and configure collection of RLM usage data.

Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and back up the licpoll.xml configuration file.
Open a command prompt with Administrator level privileges.
Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:
Command Syntax
```
 cd $BIN_DIR
```
Example
```
 cd C:\Program Files\OpeniT\Core\bin
```
Once in the directory, activate the collection of RLM data, run the command:
Command Syntax
```
 openit_confinit -c "licpoll.license-types.rlm-sample.active=true"
```

Set the RLM license file location, run the command:

Command Syntax
 openit_confinit -c "licpoll.license-types.rlm-sample.license-file=<rlm-license-file>"

where is the filename, including the path, of the RLM license file.

Example
 openit_confinit -c "licpoll.license-types.rlm-sample.license-file=<C:\Program Files\rlm\license.lic>"

Set the path to the binary used by the RLM License Server, run the command:
Command Syntax
```
 openit_confinit -c "licpoll.license-types.rlm-sample.status-command=<binary_path>"
```
where <binary_path> is the obtained path in Getting the License Status Utility Binary Path.
Example
```
 openit_confinit -c "licpoll.license-types.rlm-sample.status-command=C:\rlm\bin\rlmstat"
```
Update the configuration file, run the command:
Command Syntax
```
 openit_confbuilder --client
```
Make sure that there are no errors encountered.

Refer to the RLM Data Collection Configuration table to learn more about RLM configuration in licpoll.xml.

Object Name	Accepted Value	Description
active	Boolean (`true` or `false`)	Setting this to true activates RLM usage data collection.
type	String (i.e., `RLM`)	The license manager type.
interval	Timespan (e.g., `P30S`, `P5M`, `P1H`)	The span of time between each polling round (it is recommended to set a value no less than P1M).
offset	Timespan (e.g., `P30S`, `P5M`, `P1H`)	The span of time the aligned poll time decided by interval is shifted.
license-file	FileName (e.g., `C:\Program Files\rlm\license.lic`)	The filename, including the path, to the RLM license file. This file is provided by the vendor and is usually in the license manager installation directory.
license-file-dir	DirName (i.e., `[rlm-license-dir]`)	The path to the RLM license directory. Do not change this.
product-name	String (e.g., `server;daemon`)	This object is defined if a product name other than the default `RLM=%server%;rlm` will be used.
status-command	FileName (e.g., `${OpeniT.directories.bin}/rlmstat`)	The binary used to obtain status from the license manager.
status-command.arguments	String (i.e., `-a`)	The arguments used for the status command.

RLM Data Collection Configuration

These instructions assume that your etc directory is in /var/opt/openit.

Go to the Components directory, which is by default in /var/opt/openit/etc/Components, and back up the licpoll.xml configuration file.
Go to the bin directory, which is by default in /opt/openit/bin, run the command:
Command Syntax
```
 cd $BIN_DIR
```
Example
```
 cd /opt/openit/bin
```

Once in the directory, activate the collection of RLM data, run the command:

Command Syntax
 ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.rlm-sample.active=true"

Set the RLM license file location, run the command:

Command Syntax
 ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.rlm-sample.license-file=<rlm-license-file>"

where is the filename, including the path, of the RLM license file.

Example
 ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.rlm-sample.license-file=</var/rlm/license.lic>"

Set the path to the binary used by the RLM License Server, run the command:

Command Syntax
 ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.rlm-sample.status-command=<binary_path>"

where <binary_path> is the obtained path in Getting the License Status Utility Binary Path.

Example
 ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.rlm-sample.status-command=/var/rlm/license.lic"

Update the configuration file, run the command:
Command Syntax
```
 ./openit_confbuilder --client
```
Make sure that there are no errors encountered.

Refer to the RLM Data Collection Configuration table to learn more about RLM configuration in licpoll.xml.

Object Name	Accepted Value	Description
active	Boolean (`true` or `false`)	Setting this to true activates RLM usage data collection.
type	String (i.e., `RLM`)	The license manager type.
interval	Timespan (e.g., `P30S`, `P5M`, `P1H`)	The span of time between each polling round (it is recommended to set a value no less than P1M).
offset	Timespan (e.g., `P30S`, `P5M`, `P1H`)	The span of time the aligned poll time decided by interval is shifted.
license-file	FileName (e.g., `/var/rlm/license.lic`)	The filename, including the path, to the RLM license file. This file is provided by the vendor and is usually in the license manager installation directory.
license-file-dir	DirName (i.e., `[rlm-license-dir]`)	The path to the RLM license directory. Do not change this.
product-name	String (e.g., `server;daemon`)	This object is defined if a product name other than the default `RLM=%server%;rlm` will be used.
status-command	FileName (e.g., `${OpeniT.directories.bin}/rlmstat`)	The binary used to obtain status from the license manager.
status-command.arguments	String (i.e., `-a`)	The arguments used for the status command.

RLM Data Collection Configuration

# Verifying Data Collection

After configuration, you can verify that the data is collected by following these steps:

Open a command prompt with Administrator level privileges.
Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:
Command Syntax
```
 cd $BIN_DIR
```
Example
```
 cd C:\Program Files\OpeniT\Core\bin
```
Run the command:
Command Syntax
```
 openit_licpoll -# 1
```
Verify that the temp directory, which is by default in C:\ProgramData\OpeniT\Data\temp, contains a LicPoll directory containing .data and status-*.log files.

Go to the bin directory, which is by default in /opt/openit/bin, run the command:
Command Syntax
```
 cd $BIN_DIR
```
Example
```
 cd /opt/openit/bin
```
Run the command:
Command Syntax
```
 ./openit_licpoll -# 1
```
Verify that the temp directory, which is by default in /var/opt/openit/temp, contains a LicPoll directory containing .data and status-*.log files.

Continue reading if you need to configure log file parsing. If not, here are some suggested readings.

# Configuring Log File Parsing

Open iT collects log files and converts them to Open iT format. This will produce the following aggregated data types used for historical and real-time reporting:

(89) Total License Use Licenseevents
(90) Individual License Use Licenseevents
(91) Usergroup License Use Licenseevents
(108) Host License Use Licenseevents
(109) Hostgroup License Use Licenseevents
(104) License Logfile Events v2.0
(107) Denied License Use Licenseevents

The following sections will guide you in setting up the necessary configuration to collect and send the required data to the server.

# Requirements

An Open iT Client connected to an Open iT Server or a coexistent Open iT setup
License server administrative rights
Activated Report Log Functionality and the REPORTLOG location (For instructions, please see the REPORTLOG option under The ISV Options File chapter in the RLM manual.)

# Configuring Log File Collection

These are the required steps to configure collection of RLM log files.

Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and open logfilecollector-rlm.xml.

Locate object node dir and set its value to the location of the REPORTLOG, which is specified in the ISV options file.

logfilecollector-rlm.xml
<Object>
	<Name>dir</Name>
	<Description>Directory containing the log files</Description>
	<Value type="DirName">%RLMLOGDIR%</Value>
</Object>

Example: logfilecollector-rlm.xml
<Object>
	<Name>dir</Name>
	<Description>Directory containing the log files</Description>
	<Value type="DirName">C:\RLM\home\logs</Value>
</Object>

Save the changes.
Open a command prompt with Administrator level privileges.
Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:
Command Syntax
```
 cd $BIN_DIR
```
Example
```
 cd C:\Program Files\OpeniT\Core\bin
```
Update the configuration file, run the command:
Command Syntax
```
 openit_confbuilder --client
```
Make sure that there are no errors encountered.

Refer to the RLM Log File Collection Configuration table to learn more about RLM configuration in logfilecollector-rlm.xml.

Object Name	Accepted Value	Description
source.dir	DirName (e.g., `C:\RLM\home\logs`)	Location of the RLM log files.
source.pattern	String (i.e., `*.log`)	The glob pattern identifying source files in the source directory.
source.seen	String (`collect`, `ignore`, or `tail`)	Seen files are source files collected from before. Specify collect to collect from the start every time, specify ignore to never collect from the same file again, or specify tail to continue collection from the end of the file last time (i.e., collect the ones added since last time).
source.cmplines	Integer (e.g., `6`, `10`, `20`)	This is required if the value of `source.seen` is tail. This is the number of lines compared to source files collected before to determine where to start the collection. Note: If this number is too low, you can end up with an incorrect position, and duplicate data may be in the log files. Usually, it is better to have a few lines more than strictly necessary than even a single line too little.
target.dir	DirName (i.e., `${OpeniT.directories.temp}/LogFileCollector`)	This is the location of the directory containing the collected log data.
target.module	String (i.e., `license`)	The target type of module (in general).
target.datatype	String (i.e., `rlm`)	The specific type of target data.
target.interval	Timespan (e.g., `P30S`, `P5M`, `P1D`)	The span of time between collector runs.
target.rotation-size	Integer (e.g., `6`, `10`, `20`)	The log file rotates if it goes beyond the number (in mb) defined.
target.rotation-glob	String (e.g., `*`)	The glob pattern to match before the log file rotates.

RLM Log File Collection Configuration

Go to the Components directory, which is by default in /var/opt/openit/etc/Components, and open logfilecollector-rlm.xml.

Locate object node dir and set its value to the location of the REPORTLOG, which is specified in the ISV options file.

logfilecollector-rlm.xml
<Object>
	<Name>dir</Name>
	<Description>Directory containing the log files</Description>
	<Value type="DirName">%RLMLOGDIR%</Value>
</Object>

Example: logfilecollector-rlm.xml
<Object>
	<Name>dir</Name>
	<Description>Directory containing the log files</Description>
	<Value type="DirName">/root/RLM/home/logs</Value>
</Object>

Save the changes.
Go to the bin directory, which is by default in /opt/openit/bin, run the command:
Command Syntax
```
 cd $BIN_DIR
```
Example
```
 cd /opt/openit/bin
```
Update the configuration file, run the command:
Command Syntax
```
 ./openit_confbuilder --client
```
Make sure that there are no errors encountered.

Refer to the RLM Log File Collection Configuration table to learn more about RLM configuration in logfilecollector-rlm.xml.

Object Name	Accepted Value	Description
source.dir	DirName (e.g., `/root/RLM/home/logs`)	Location of the RLM log files.
source.pattern	String (i.e., `*.log`)	The glob pattern identifying source files in the source directory.
source.seen	String (`collect`, `ignore`, or `tail`)	Seen files are source files collected from before. Specify collect to collect from the start every time, specify ignore to never collect from the same file again, or specify tail to continue collection from the end of the file last time (i.e., collect the ones added since last time).
source.cmplines	Integer (e.g., `6`, `10`, `20`)	This is required if the value of `source.seen` is tail. This is the number of lines compared to source files collected before to determine where to start the collection. Note: If this number is too low, you can end up with an incorrect position, and duplicate data may be in the log files. Usually, it is better to have a few lines more than strictly necessary than even a single line too little.
target.dir	DirName (i.e., `${OpeniT.directories.temp}/LogFileCollector`)	This is the directory location containing the collected log data.
target.module	String (i.e., `license`)	The target type of module (in general).
target.datatype	String (i.e., `rlm`)	The specific type of target data.
target.interval	Timespan (e.g., `P30S`, `P5M`, `P1D`)	The span of time between collector runs.
target.rotation-size	Integer (e.g., `6`, `10`, `20`)	The log file rotates if it goes beyond the number (in mb) defined.
target.rotation-glob	String (e.g., `*`)	The glob pattern to match before the log file rotates.

RLM Log File Collection Configuration

# Activating Log Data Collection

These are steps to activate collection of RLM log data.

Go to the scheduler directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\scheduler, and open collect_license_rlm-logs.oconf.
Locate and set root.scheduler.jobs.collect_rlm_licenselogs.general.active to true to activate the collection of RLM log data.
collect_license_rlm-logs.oconf
```
 13|	}
 14|		general
 15|		{
 16|			active
 17|			{
 18|				type=bool
 19|				value=true
```
Locate and set root.scheduler.jobs.collect_rlm_license_id_.general.active to true if you want to collect RLM license ID info.
collect_license_rlm-logs.oconf
```
 115|	}
 116|		general
 117|		{
 118|			active
 119|			{
 120|				type=bool
 121|				value=true
```
Save the changes.

The collection runs hourly using a 5-minute sample interval by default. The primary data is then transferred to the server every night according to the client timezone for processing. To configure the intervals, locate the instances attribute under collect_rlm_licenselogs, collect_rlm_license_id, preprocess_rlm_licenselogs-events, preprocess_rlm_licenselogs-records, or transfer_rlm_licenselogs in the same file and configure the attributes.

Refer to the RLM Log Job Scheduler Instances Configuration table to learn the attributes used to configure RLM data collection and transfer.

Attribute Name	Accepted Value	Description
max-instances	Uint (e.g., `5`, `8`, `9`)	The number of instances allowed to run at the same time.
max-handling	String (`end-oldest`, `end-all-old`, or `end-new`)	The action done upon reaching the maximum number of instances. Specify end-oldest to stop/kill the oldest instance and then start the new, specify end-all-old to stop/kill all running instances and then start the new, or specify end-new to not start the new instance.
end-timeout	Timespan (e.g., `P30S`, `P5M`, `P1H`)	The maximum waiting time before terminating a running instance.
quarantine	Timespan (e.g., `P30S`, `P5M`, `P1H`)	The waiting time before starting a new instance after a previous one.

RLM Log Job Scheduler Instances Configuration

Go to the scheduler directory, which is by default in /var/opt/openit/etc/scheduler, and open collect_license_rlm-logs.oconf.
Locate and set root.scheduler.jobs.collect_rlm_licenselogs.general.active to true to activate the collection of RLM log data.
collect_license_rlm-logs.oconf
```
 13|	}
 14|		general
 15|		{
 16|			active
 17|			{
 18|				type=bool
 19|				value=true
```
Locate and set root.scheduler.jobs.collect_rlm_license_id_.general.active to true if you want to collect RLM license ID info.
collect_license_rlm-logs.oconf
```
 115|	}
 116|		general
 117|		{
 118|			active
 119|			{
 120|				type=bool
 121|				value=true
```
Save the changes.

Refer to the RLM Log Job Scheduler Instances Configuration table to learn the attributes used to configure RLM data collection and transfer.

Attribute Name	Accepted Value	Description
max-instances	Uint (e.g., `5`, `8`, `9`)	The number of instances allowed to run at the same time.
max-handling	String (`end-oldest`, `end-all-old`, or `end-new`)	The action done upon reaching the maximum number of instances. Specify end-oldest to stop/kill the oldest instance and then start the new, specify end-all-old to stop/kill all running instances and then start the new, or specify end-new to not start the new instance.
end-timeout	Timespan (e.g., `P30S`, `P5M`, `P1H`)	The maximum waiting time before terminating a running instance.
quarantine	Timespan (e.g., `P30S`, `P5M`, `P1H`)	The waiting time before starting a new instance after a previous one.

RLM Log Job Scheduler Instances Configuration

# Verifying Log Data Collection

After configuration, you can verify that the data is collected and sent to the server by following these steps:

Open a command prompt with Administrator level privileges.
Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:
Command Syntax
```
 cd $BIN_DIR
```
Example
```
 cd C:\Program Files\OpeniT\Core\bin
```

Run the command:

Command Syntax
 openit_executor -r collect_license_rlm-logs

Verify that there are archiver*.in files created in the server in the archiver directory, which is by default in C:\ProgramData\OpeniT\Data\incoming\archiver.

Go to the bin directory, which is by default in /opt/openit/bin, run the command:
Command Syntax
```
 cd $BIN_DIR
```
Example
```
 cd /opt/openit/bin
```

Run the command:

Command Syntax
 ./openit_executor -r collect_license_rlm-logs

Verify that there are archiver*.in files created in the incoming directory in your defined data_dir ($ROOT_DATA_DIR) upon Open iT server installation.

# Troubleshooting

# API Controller Cannot Upload Parsed Log Data

# Problem

This issue may be encountered when the total size of parsed RLM data per sending is greater than 2 GB. The large parsed RLM data cannot to be sent to the server, showing the error, ApiController: : postUploadData Failed to upload x files in the debug logs.

# Resolution

Compress object nodes for the upload_rlm_logs tasks is added so you can enable compression of the target data before sending them to the server.

Make sure that the receiving Open iT server is version 9.16.190 or later to properly receive the uploaded data and avoid data processing error and data loss.

These are the required steps to activate compression of parsed RLM data before uploading them to the server.

Apply the configurations shown in the Open iT client.

Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and open apicontroller.xml.

Locate the object node compress under the object node upload_rlm_logs and set its value to true.

apicontroller.xml
<Object>
	<Name>compress</Name>
	<Description>Compress upload files before upload</Description>
	<Value type="Bool">true</Value>
</Object>

Save the changes.
Open a command prompt with Administrator level privileges.
Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:
Command Syntax
```
 cd $BIN_DIR
```
Example
```
 cd C:\Program Files\OpeniT\Core\bin
```
Update the configuration file, run the command:
Command Syntax
```
 openit_confbuilder --client
```
Make sure that there are no errors encountered.

Go to the Components directory, which is by default in /var/opt/openit/etc/Components, and open apicontroller.xml.

Locate the object node compress under the object node upload_rlm_logs and set its value to true.

apicontroller.xml
<Object>
	<Name>compress</Name>
	<Description>Compress upload files before upload</Description>
	<Value type="Bool">true</Value>
</Object>

Save the changes.
In the terminal, go to the bin directory, which is by default in /opt/openit/bin, run the command:
Command Syntax
```
 cd $BIN_DIR
```
Example
```
 cd /opt/openit/bin
```
Update the configuration file, run the command:
Command Syntax
```
 ./openit_confbuilder --client
```
Make sure that there are no errors encountered.

# Next Steps?

Renaming Vendor License Renaming Features Create and Add Report License Monitor