This is a legacy documentation space! Please visit the License Server 5.0 documentation for an up-to-date information. 

This page provides information on the V-Ray Online Licensing Server Controller.

 

Page Contents

 

Overview


The License Server Controller allows users to make adjustments to V-Ray Online License Server through the command line.

 

 

 

Installation Path

Depending on your operating system, the vrlctl command's default location is as follows:

Windows

C:\Program Files\Chaos Group\VRLService\OLS
Linux/usr/ChaosGroup/VRLService/OLS
Mac OSX/Applications/ChaosGroup/VRLService/OLS

 

Usage


To use the License Server Controller, use the following format:

vrlctl <command>

When entered without a command, additional help information will be displayed.

 

Commands


The following commands are available:

Online

These commands provide a way to enable, disable, and monitor online licensing settings of the license server. For steps on setting up online licensing, see the Enabling Online Licensing section below.

online getcsrSaves an online licensing request file (cert.csr) in the current directory.
online enableEnables online licensing using an online licensing key file (cert.crt) from the current directory.
online disableDisables online licensing for the license server.
online statusDisplays information about the online licensing status.
online login <username> <password>Activates online licensing for the specified credentials.

 

Diagnostics

These commands help you obtain the diagnostic bundle which can assist ChaosGroup's support team when investigating problems you might encounter.

diagnostics get <save_path>Downloads the diagnostic bundle. If <save_path> is provided, the diagnostic bundle will be saved in the given directory.

 

Config

These commands allow users to get or set different configuration variables of the V-Ray Online Licensing Server.

config getReturns the complete license server configuration.
config set <configuration_option> "<new_value>"Sets the value of a specific configuration option. The configuration option consists of all the configuration nodes that lead to it connnected with a dot (.). For example, proxy.host and diagnostics.level. The new value must be surrounded with quotation marks (").

 

Dongle

These commands are for using a dongle with the online license server. See the Dongle and Online Licensing page for additional information.

dongle enableEnables the dongle server.
dongle disableDisables the dongle server.
dongle port <new_port>Gets/Sets the Dongle server port. If <new_port> is omitted, the port number of the dongle server will be returned. Otherwise, the dongle server will be set to the specified port.

 

Enabling Online Licensing


Follow these steps to enable online licensing through the License Server Controller:

  1. In the command line, type vrlctl online getcsr to save an online licensing request file (cert.csr) in the current directory.
  2. Visit http://my.chaosgroup.com and follow the instructions to obtain an online licensing key file (cert.crt).
  3. Type vrlctl online enable to enable online licensing using the newly obtained key file from the current directory.