# GNS License Manager

# Introduction

Open iT supports GNS usage reporting by polling 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

# Getting the License Status Utility Binary Location

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

Through the Interface

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

Through the Command Line

  1. Open a command prompt with Administrator level privileges.

  2. Run the following command to locate the binary:

    Command Syntax
     where /r <installation_drive> licstat

    where <installation_drive> is the drive where the license manager is installed.

    Example
     where /r C:\ licstat

    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
licstat

Make sure that there are no errors encountered.

Run the following command to locate the binary:

Command Syntax
find . | grep licstat

The path of the binary will be displayed.

# Configuring Data Collection

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

  1. 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.

  2. Open a command prompt with Administrator level privileges.

  3. 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
  4. Once in the directory, activate the collection of GNS data, run the command:

    Command Syntax
     openit_confinit -c "licpoll.license-types.gns-sample.active=true"
  5. Set the license server name and port used by the GNS License Server, run the command:

    Command Syntax
     openit_confinit -c "licpoll.license-types.gns-sample.license-server=<hostname:portnumber>"
    Example
     openit_confinit -c "licpoll.license-types.gns-sample.license-server=osl120win:27000"
  6. Set the path to the binary used by the GNS License Server, run the command:

    Command Syntax
     openit_confinit -c "licpoll.license-types.gns-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.gns-sample.status-command=C:\gns\licstat"
  7. Update the configuration file, run the command:

    Command Syntax
     openit_confbuilder --client

    Make sure that there are no errors encountered.

  1. Go to the Components directory, which is by default in /var/opt/openit/etc/Components, and back up the licpoll.xml configuration file.

  2. 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
  3. Once in the directory, activate the collection of GNS data, run the command:

    Command Syntax
     ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.gns-sample.active=true"
  4. Set the license server name and port used by the GNS License Server, run the command:

    Command Syntax
     ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.gns-sample.license-server=<hostname:portnumber>"
    Example
     ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.gns-sample.license-server=osl120win:27000"
  5. Set the path to the binary used by the GNS License Server, run the command:

    Command Syntax
     ./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "licpoll.license-types.gns-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.gns-sample.status-command=/var/opt/gns/licstat"
  6. Update the configuration file, run the command:

    Command Syntax
     ./openit_confbuilder --client

    Make sure that there are no errors encountered.

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

Object Name Accepted Value Description
active Boolean (true or false) Setting this to true activates GNS usage data collection.
type String (i.e., GNS) 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.
product-name String (e.g., server;daemon) This object is defined if a product name other than the default GNS=%server%;gns will be used.
license-server String (e.g., osl120win:27000) The GNS License Server name.
status-command FileName (e.g., ${OpeniT.directories.bin}/licstat) The binary used to obtain status from the license manager.
status-command.arguments String (i.e., Animator $license-server) The arguments used for the status command.
GNS Data Collection Configuration

# Verifying Data Collection

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

  1. Open a command prompt with Administrator level privileges.

  2. 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
  3. Run the command:

    Command Syntax
     openit_licpoll -# 1
  4. 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.

  1. 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
  2. Run the command:

    Command Syntax
     ./openit_licpoll -# 1
  3. Verify that the temp directory, which is by default in /var/opt/openit/temp, contains a LicPoll directory containing .data and status-*.log files.

# Next Steps?

   Renaming Vendor License    Renaming Features    Create and Add Report    License Monitor

We value your feedback!

Please take a few minutes to complete our survey and share your thoughts on your recent experience with our documentation.

Take survey

Close