# V-Ray License Manager

# Introduction

Open iT supports V-Ray usage reporting by collecting license usage data by polling through another utility from the license server. This will produce the following aggregated data types used for historical and real-time reporting:

There are three(3) supported license models:

  • Online - licenses that can be used when online
  • Offline - licenses that a user can use offline for two(2) weeks
  • Dongle - licenses that are available through a USB license dongle attached to a workstation/server

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
  • License server hostname and port

# Configuring Raw Data Collection

These are the required steps to activate and configure collection of raw V-Ray data.

  1. Go to the scheduler directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\scheduler, and open collect_license_vray-polls.oconf.

  2. Locate and set root.scheduler.jobs.collect_vray.general.active to true to activate the collection of raw V-Ray data.

    collect_license_vray-polls.oconf
     13|	general
 14|	{
 15|		active
 16|		{
 17|			type=bool
 18|			value=true
 19|		}

  3. Locate root.scheduler.jobs.collect_vray.operations.arguments and set the values of --server and --port to the hostname and port of your V-Ray server.

    collect_license_vray-polls.oconf
     49|	arguments
 50|	{
 51|		type=string
 52|		value=--key vray --target "${OpeniT.directories.temp}/PollCollector/VRay" --interval PT5M --timeout PT5M --module license --datatype vray --skip-onerror --exe "${OpeniT.directories.bin}/openit_vraystat" --args --server "localhost" --port "30304" --retry "2" --timeout "10"
 53|	}
    Example: collect_license_vray-polls.oconf
     49|	arguments
 50|	{
 51|		type=string
 52|		value=--key vray --target "${OpeniT.directories.temp}/PollCollector/VRay" --interval PT5M --timeout PT5M --module license --datatype vray --skip-onerror --exe "${OpeniT.directories.bin}/openit_vraystat" --args --server "hou105win" --port "30304" --retry "2" --timeout "10"
 53|	}

  4. 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_vray, preprocess_vray, transfer_vray_parsed, or transfer_vray_raw in the same file and configure the attributes.

Refer to the V-Ray Poll Job Scheduler Instances Configuration table to learn the attributes used to configure V-Ray 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.
V-Ray Poll Job Scheduler Instances Configuration

  1. Go to the scheduler directory, which is by default in /var/opt/openit/etc/scheduler, and open collect_license_vray-polls.oconf.

  2. Locate and set root.scheduler.jobs.collect_vray.general.active to true to activate the collection of raw V-Ray data.

    collect_license_vray-polls.oconf
     13|	general
 14|	{
 15|		active
 16|		{
 17|			type=bool
 18|			value=true
 19|		}

  3. Locate root.scheduler.jobs.collect_vray.operations.arguments and set the values of --server and --port to the hostname and port of your V-Ray server.

    collect_license_vray-polls.oconf
     49|	arguments
 50|	{
 51|		type=string
 52|		value=--key vray --target "${OpeniT.directories.temp}/PollCollector/VRay" --interval PT5M --timeout PT5M --module license --datatype vray --skip-onerror --exe "${OpeniT.directories.bin}/openit_vraystat" --args --server "localhost" --port "30304" --retry "2" --timeout "10"
 53|	}
    Example: collect_license_vray-polls.oconf
     49|	arguments
 50|	{
 51|		type=string
 52|		value=--key vray --target "${OpeniT.directories.temp}/PollCollector/VRay" --interval PT5M --timeout PT5M --module license --datatype vray --skip-onerror --exe "${OpeniT.directories.bin}/openit_vraystat" --args --server "hou105lin" --port "30304" --retry "2" --timeout "10"
 53|	}

  4. 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_vray, preprocess_vray, transfer_vray_parsed, or transfer_vray_raw in the same file and configure the attributes.

Refer to the V-Ray Poll Job Scheduler Instances Configuration table to learn the attributes used to configure V-Ray 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.
V-Ray Poll Job Scheduler Instances Configuration

# Verifying Data Collection

After configuration, you can verify that the data is collected and sent to the server 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_executor -r collect_license_vray-polls

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

  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_executor -r collect_license_vray-polls

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

# Next Steps?

   Renaming Vendor License    Renaming Features    Create and Add Report    License Monitor

Powered by Open iT ® Open iT Docs All rights reserved.

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