VE License Server Command-Line Utilities

The License Server kit contains the following command-line utilities:

All License Server utilities are located in /opt/license-server.

The c2v Utility

The c2v (Customer-to-Vendor) utility enables the user to collect the initial fingerprint of the license server system and later collect C2V data for license updates.

Usage: c2v [options]

The options are described in the table below:

OptionDescription

-f, --filename name

Specifies the name of the file in which the C2V data will be stored.
-p, --platform platform

VE platform on which the license server runs:

  • aws: to run on Amazon Cloud
  • oci: to run on Oracle Cloud
  • azure: to run on Microsoft Azure
  • gcp: to run on Google Cloud Platform
  • ibm: to run on the IBM cloud
  • nutanix: to run on Nutanix AHV
  • esxi: to run in a VMware environment
  • physical: physical host system
-a, --autoCreate a C2V for an AutoVE license (mutually exclusive with general, non AutoVE licenses).
-t, --transferExport a transfer file (.tfr) to transfer the license to another system.
-d, --debuglogPrint a debug log.
-h, --help
Print the usage information. Default if no parameter is selected.

The v2c Utility

The v2c (Vendor-to-Customer) utility enables the user to install the initial license and subsequent license updates.

Usage: v2c [options]

The options are described in the table below:

OptionDescription

-f,--filename name

Specifies the name of the file containing the V2C data.
-s, --silentRun v2c in silent mode. New in version 1.1.23
-d, --debuglogPrint a debug log.
-h, --help
Print the usage information. Default if no parameter is selected.

The license_viewer Utility

The license_viewer utility enables the user to displayed installed licenses.

Usage: license_viewer [options]

The options are described in the table below:

OptionDescription

-c, --client

Displays the license clients connected to the server.
-r, --registerDisplays the registered license clients.
-o, --output file.csvSend command output to a CSV file. New in version 1.1.23.
-u, --usageShows license utilization. That is, it shows how many of the allowed instances for each product sections are currently used and how many instances are still available. New in version 1.1.23.
-h, --helpPrint the usage information
No parameterIf run without parameters, the installed licenses will be displayed.

The esxi_bind Utility

The esxi_bind utility is used to establish the connection between license server and ESXi host or vCenter Server.

Usage: esxi_bind [options]

The options are described in the table below:

OptionDescription

-a, --address ip-address

IP address of the ESXi host or vCenter Server.
-u, --username username

Username of a user on the ESXi host or vCenter Server.

Important notes regarding the user on the ESXi host or the vCenter Server:

  1. The username on the vCenter Server can take different forms:
    • Simple username
      example for web-GUI: myusername
      example for esxi_bind command: -u myusername
    • Username includes a domain name in one of the following two formats:
      • <domain>\<username>
        example for web-GUI:   mydomain\myusername
        example for esxi_bind command: -u 'mydomain\myusername'
      • <username>@<domain>
        example for web-GUI:    myusername@mydomain
        example for esxi_bind command: -u myusername@mydomain
  2. The user must have at least the following global permissions (i.e. the permissions cannot be limited to a specific VM):

    • Datastore > Allocate Space
    • VirtualMachine > Config > AddNewDisk
    • VirtualMachine > Config > RemoveDisk

Please note: if username and/or password contain Unix shell meta-characters, these characters must be escaped (enclose the string in single quotes, or add a backslash character in front of the meta-character).

-p, --password passwordPassword of the user specified in the username option.
-d, --debuglogPrint a debug log.
-h, --help
Print the usage information. Default if no parameter is selected.

Please note: if username and/or password contain Unix shell meta-characters, these characters must be escaped (enclose the string in single quotes, or add a backslash character in front of the meta-character).


Command-Line Options of the License Server

The license server itself has some command-line options. They are described below.

Usage: license_server [options]

OptionDescription

-p, --password

Change the password of the web GUI user charon. Available starting with version 1.1.14.
-s, --statusDisplay the status of the license_server. Available starting with version 1.1.18.
-l debugEnable debug log output.
-h, --helpPrint the usage information.
No parameterIf run without parameters, the system will attempt to start the license server.



© Stromasys, 1999-2024  - All the information is provided on the best effort basis, and might be changed anytime without notice. Information provided does not mean Stromasys commitment to any features described.