1. Introduction to the NVIDIA Virtual GPU Software License Server

The NVIDIA virtual GPU software License Server is used to serve a pool of floating licenses to NVIDIA virtual GPU software licensed products. The License Server is designed to be installed locally within a customer’s network, and be configured with licenses obtained from the NVIDIA Licensing Center.

1.1. Overview of NVIDIA virtual GPU software Licensing

NVIDIA virtual GPU software is a licensed product. Functionality of this product that requires a license is activated during guest OS boot by the acquisition of a software license served over the network from an NVIDIA virtual GPU software license server. The license is returned to the license server when the guest OS shuts down.

Figure 1. NVIDIA Virtual GPU Software Licensing Architecture

Diagram showing how NVIDIA virtual GPU software license files are downloaded from the NVIDIA Licensing Center to the license server and how licensed clients borrow licenses from the server.

The licenses served by the NVIDIA virtual GPU software license server are obtained from the NVIDIA Licensing Center as downloadable license files, and installed into the license server through its management interface.

1.2. NVIDIA Virtual GPU Software License Server High Availability

To provide NVIDIA virtual GPU software clients with continued access to NVIDIA virtual GPU software features if a single license server fails, you can configure the license server for high availability. High availability requires two license servers in a failover configuration:

  • A primary license server, which is actively serving licenses to NVIDIA virtual GPU software clients
  • A secondary license server, which acts as a backup for the primary license server

Configuring two servers in a failover configuration increases availability because simultaneous failure of two servers is rare. The primary and secondary license servers work together to ensure that licenses in the enterprise remain continually available to NVIDIA virtual GPU software clients. If the primary license server fails, failover occurs and the secondary server takes over from the primary server.

Note: After failure of a server, the remaining server becomes a single point of failure. Therefore, you should return the failed server to service as quickly as possible to restore high availability support for the license server.

1.3. Overview of the NVIDIA Virtual GPU Software Licensing Process

The following table lists the major tasks in the process of licensing NVIDIA virtual GPU software and provides a cross-reference to instructions for performing each task.

Task Instructions
Get your NVIDIA virtual GPU software and NVIDIA virtual GPU software License Server software. Virtual GPU Software Quick Start Guide
Install the NVIDIA virtual GPU software License Server software. Installing the NVIDIA Virtual GPU Software License Server
Access the management interface of the license server. Accessing the License Server Management Interface
Get the MAC address of the license server. Obtaining the License Server’s MAC Address
Register your license server, generate licenses, and download license files. Registering Your License Server and Getting License Files
Install a license. Installing a License
View available licenses. Viewing Information About Installed Licenses
Reserve and release licenses. Reserving Licenses
Move a license to a new server.
  1. Removing Licenses from a License Server
  2. Registering Your License Server and Getting License Files
Convert a trial license server to a permanent license server. Converting an Evaluation License Server to a Permanent License Server
Configure licensed NVIDIA virtual GPU software products for use with license server. Virtual GPU Client Licensing User Guide
Troubleshoot the license server. Troubleshooting the NVIDIA Virtual GPU Software License Server
Uninstall the license server software. Uninstalling the NVIDIA Virtual GPU Software License Server

2. Installing the NVIDIA Virtual GPU Software License Server

You can install the NVIDIA virtual GPU software license server on Windows and Linux systems that meet the license server’s platform requirements. If you require high availability for the license server, you must install the license server both on the system that you will use as the primary license server and on the system that you will use as the secondary license server.

The license server requires a Java runtime environment and an Apache Tomcat server. Before you install the license server software, ensure that the required software is already installed on each license server host machine that you are using:

  • On Windows, you need ensure only that the Java runtime environment is installed. The Apache Tomcat server is included in the license server installer for Windows.
  • On Linux, you must ensure that both the Java runtime environment and the Apache Tomcat server are installed.

Also ensure that you have obtained your NVIDIA virtual GPU software and NVIDIA virtual GPU software License Server software. For more information, refer to Virtual GPU Software Quick Start Guide.

2.1. Platform Requirements

Before proceeding, ensure that you have a platform suitable for hosting the license server.

2.1.1. Hardware and Software Requirements

  • The hosting platform may be a physical or virtual machine (VM). NVIDIA recommends using a host that is dedicated solely to running the license server.
  • The recommended minimum configuration is 2 CPU cores and 4 Gbytes of RAM. A high-end configuration of 4 or more CPU cores with 16 Gbytes of RAM is suitable for handling up to 150,000 licensed clients.
  • The hosting platform must run a supported operating system.
Note: Before proceeding with the installation, refer to Virtual GPU License Server Release Notes for details of supported operating systems and known issues.

2.1.2. Platform Configuration Requirements

  • The platform must have a fixed (unchanging) IP address. The IP address may be assigned dynamically by DHCP or statically configured, but must be constant.
  • The platform must have at least one unchanging Ethernet MAC address, to be used as a unique identifier when registering the server and generating licenses in the NVIDIA Licensing Center.
  • The platform’s date and time must be set accurately. NTP is recommended.

2.1.3. Network Ports and Management Interface

The license server requires TCP port 7070 to be open in the platform’s firewall, to serve licenses to clients. By default, the installer will automatically open this port.

The license server’s management interface is web-based, and uses TCP port 8080. The management interface itself does not implement access control; instead, the installer does not open port 8080 by default, so that the management interface is only available to web browsers running locally on the license server host. Access to the management interface is therefore controlled by limiting remote access (via VNC, RDP, etc.) to the license server platform.

Note: If you choose to open port 8080 during license server installation, or at any time afterwards, the license server’s management interface is unprotected.

2.1.4. High Availability Requirements

If you plan to configure high availability for the license sever by configuring a primary server and a secondary server, these requirements must be met:

  • Both servers must run the same version of the NVIDIA Virtual GPU Software License Server software.
  • The clocks on both servers must be accurate and synchronized. NTP is recommended.
  • The same license configuration file must be installed on both servers. This file is configured to include the Ethernet MAC addresses of both servers.

2.2. Installing the NVIDIA Virtual GPU Software License Server on Windows

The license server requires a Java runtime environment, which must be installed separately before you install the license server.

Note: If you require high availability for the license server, you must install the license server both on the system that you will use as the primary license server and on the system that you will use as the secondary license server.

2.2.1. Installing the Java Runtime Environment on Windows

Before running the NVIDIA license server installer, download the current 32-bit Java runtime environment from the java.com: Java + You website and install it.

Note: Install the 32-bit Java runtime, regardless of whether your platform is 32-bit Windows or 64-bit Windows.
Figure 2. Java 32-Bit Runtime Installation on Windows

Screen capture showing the download and setup screens for Java for Windows.

2.2.2. Installing the License Server Software on Windows

  1. Unzip the license server installer and run setup.exe.
  2. Accept the EULA for the license server software and the Apache Tomcat software used to support the license server’s management interface.
    Figure 3. License Agreements on Windows

    Screen capture showing license agreements for the license server on Windows.

  3. Choose the destination folder where you want the license server software to be installed.
    Figure 4. Destination Folder Selection on Windows

    Screen capture showing the selection of the destination folder for the license server on Windows.

  4. In the Choose Firewall Options dialog box, select the ports to be opened in the firewall.

    To enable remote clients to access licenses from the server and prevent remote access to the management interface, use the default setting, which sets ports as follows:

    • Port 7070 is open to enable remote clients to access licenses from the server.
    • Port 8080 is closed to ensure that the management interface is available only through a web browser running locally on the license server host.
    Figure 5. Firewall Settings on Windows

    Screen capture showing firewall settings for the license server on Windows.

  5. After installation has completed successfully, click Done to exit the installer.
    Figure 6. Completed License Server Installation on Windows

    Screen capture showing the window that appears when the license server installation is complete on Windows.

After quitting the installer, verify the installation by accessing the License Server management interface as explained in Accessing the License Server Management Interface.

2.3. Installing the NVIDIA Virtual GPU Software License Server on Linux

The license server requires a Java runtime environment and an Apache Tomcat server, which must be installed separately before you install the license server software.

Note: If you require high availability for the license server, you must install the license server both on the system that you will use as the primary license server and on the system that you will use as the secondary license server.

2.3.1. Installing the Java Runtime Environment on Linux

Most Linux distributions install a Java runtime environment by default.
  1. Verify that your Linux installation has Java installed.
    [nvidia@localhost ~]$ java -version
    java version "1.7.0_51"
    OpenJDK Runtime Environment (rhel-2.4.5.5.el7-x86_64 u51-b31)
    OpenJDK 64-Bit Server VM (build 24.51-b03, mixed mode)
    [nvidia@localhost ~]$
  2. If Java is not installed, use your Linux distribution’s package manager to install Java.
    [nvidia@localhost ~]$ sudo yum install java

2.3.2. Installing and Running the Apache Tomcat Server on Linux

The license server’s management interface requires an Apache Tomcat server.
  1. Use your Linux distribution’s package manager to install the tomcat and tomcat-webapps packages.
    [nvidia@localhost ~]$ sudo yum install tomcat tomcat-webapps
  2. After installing the packages, enable the Tomcat service for automatic startup on boot.
    [nvidia@localhost ~]$ sudo systemctl enable tomcat.service
  3. Start the Tomcat service.
    [nvidia@localhost ~]$ sudo systemctl start tomcat.service
  4. Verify that the Tomcat service is operational by opening the URL http://localhost:8080 in a web browser. The home page of the default Tomcat web application should be displayed, as shown in Figure 7.
    Figure 7. Verifying the Apache Tomcat Installation

    Screen capture showing the home page of the default Apache Tomcat web application.

2.3.3. Installing the License Server Software on Linux

Note: Installation in Linux console mode is not supported. The license server installer must be run in a graphical desktop environment.
  1. Extract the contents of the license server tar archive.
    [nvidia@localhost ~]$ tar xfz NVIDIA-linux-5.0.0.22575570.tgz
  2. As root, run the extracted setup binary.
    [nvidia@localhost ~]$ sudo ./setup.bin
  3. Accept the EULA to proceed with installation.
    Figure 8. License Agreements on Linux

    Screen capture showing license agreements for the license server on Linux.

  4. Choose the destination folder where you want the license server software to be installed.
    Figure 9. Destination Folder Selection on Linux

    Screen capture showing the selection of the destination folder for the license server on Linux.

  5. Specify the path to the folder on the local host where the Apache Tomcat Server software is installed.
    Figure 10. Apache Tomcat Server Path on Linux

    Screen capture showing the selection of the Apache Tomcat Server path on Linux.

  6. In the Choose Firewall Options dialog box, shown in Figure 11, select the ports to be opened in the firewall.

    To enable remote clients to access licenses from the server and prevent remote access to the management interface, use the default setting, which sets ports as follows:

    • Port 7070 is open to enable remote clients to access licenses from the server.
    • Port 8080 is closed to ensure that the management interface is available only through a web browser running locally on the license server host.
    Figure 11. Firewall Settings on Linux

    Screen capture showing firewall settings for the license server on Linux.

  7. After installation has completed successfully, click Done to exit the installer.
    Figure 12. Completed License Server Installation on Linux

    Screen capture showing the window that appears when the license server installation is complete on Linux.

After quitting the installer, verify the installation by accessing the license server management interface as explained in Accessing the License Server Management Interface.

3. Managing Licenses on the NVIDIA Virtual GPU Software License Server

Managing licenses on the NVIDIA virtual GPU software license server involves installing licenses on the license server and controlling and monitoring the usage of installed licenses. You manage the license server in a web browser through the license server management interface.

3.1. Accessing the License Server Management Interface

Access the license server management interface to verify that the license server is operating correctly or to manage licenses on the license server.
  • If the license server host does not permit remote access, open a web browser on the license server host and connect to the URL http://localhost:8080/licserver.
  • If the license server host’s network firewall is configured to permit remote access to the license server, open a web browser on a remote machine and connect to the URL http://hostname:8080/licserver, where hostname is the fully-qualified domain name or IP address of the license server host.

The browser should display the home page for the license server management interface, as shown in Figure 13.

Figure 13. License Server Management Interface

Screen capture showing the home page for the license server management interface.

If the management interface is not displayed, consult Management Interface Connection Errors for troubleshooting steps.

3.2. Obtaining the License Server’s MAC Address

The license server’s Ethernet MAC address uniquely identifies your server to the NVIDIA Licensing Center. You will need this address to register your license server with the NVIDIA Licensing Center to generate license files.
  1. In the license server management interface, select Configuration.
  2. On the License Server Configuration page that opens, in the Server host ID drop-down list, select the platform’s ETHERNET address.
    Figure 14. Obtaining the License Server's MAC Address

    Screen capture showing the License Server Configuration page with the Server host ID property highlighted.

    Note: You must use the same ETHERNET ID to consistently identify the server when generating licenses on the NVIDIA Licensing Portal. If your platform has multiple Ethernet interfaces, multiple ETHERNET entries may be may be displayed in the Server host ID drop-down list. To ensure that you use the same ETHERNET ID to consistently to identify the server, select one entry that corresponds to a primary (nonremovable) interface on the platform.

3.3. Enabling Failover Support on the Primary and Secondary License Servers

If you are configuring high availability for the license server, you must enable failover support on both the primary license server and on the secondary license server. Set the same options on both servers.

  1. In the license server management interface, select Configuration. The License Server Configuration page opens.
    Figure 15. License Server Settings for Enabling Failover Support

    Screen capture of the License Server Configuration page showing settings for enabling failover support.

  2. Under License Generation, use the Backup URI and Main URI fields to set the URI to each server in a failover configuration.
    1. In the Backup URI field, enter http://secondary-server-ip-address:7070/fne/bin/capability.
    2. In the Main URI field, enter http://primary-server-ip-address:7070/fne/bin/capability.
    secondary-server-ip-address
    The IP address of the secondary license server.
    primary-server-ip-address
    The IP address of the primary license server.
  3. Set the options under Settings for server to sync between License servers as follows:
    1. Set the Synchronization to fne enabled option to true.
    2. In the Main FNE Server URI field, enter http://primary-server-ip-address:7070/fne/bin/capability.
      primary-server-ip-address
      The IP address of the primary license server.
  4. Click Save.

3.4. Registering Your License Server and Getting License Files

To be able to generate and download licenses from the NVIDIA Licensing Center, you must register your license server. Before downloading a license file, you must generate the file by mapping to it the add-ons that correspond to your licenses. The license file is empty by default and does not contain any licenses it until you map add-ons to it.

Note: If you require high availability for the license server, you must register a secondary server when the primary server is registered. If you do not register a secondary server when the primary server is registered, you cannot register the secondary server later.
  1. If you are not already logged in, log in to the NVIDIA Licensing Center.
  2. In the navigation pane of the NVIDIA Software Licensing Center page, under GRID Licensing, select Register License Server.
  3. On the Register License Server page that opens, provide the details of your license server.
    1. In the MAC Address field, enter the MAC address of your primary license server. Enter only the numbers and letters in the address. Do not enter any spaces or punctuation. If you have only one license server configured, enter its MAC address in this field.
    2. In the Backup License Server ID field, enter the MAC address of your secondary license server. Enter only the numbers and letters in the address. Do not enter any spaces or punctuation. If you have only one license server configured, leave this field unset.
    3. Optional: Provide an alias and site name for your license server.

      If you do not provide an alias, it is set to the MAC address of your license server. You can edit the alias after your license server is registered.

      If you do not provide a site name, your license server is registered without a site name. You cannot add a site name after your license server is registered.

    4. Click Create.


    Screen capture showing the Register License Server page.

  4. On the View Server page that opens, follow the Map Add-Ons link.

    Screen capture showing the View Server page.

  5. On the Map Add-Ons page that opens, in the Qty to add field, enter the number of licenses you want to add to your license file and click Map Add-Ons.

    Screen capture showing the Map Add-Ons page.

    You can also configure and register multiple servers and distribute your NVIDIA virtual GPU software licenses across them by mapping add-ons to servers as necessary.

    After clicking Map Add-Ons, you are returned to the View Server page.
  6. Back on the View Server page, follow the Download License File link and save the .bin license file to your license server for installation.
Note: The .bin license file is valid for 24 hours. If you do not install the file within 24 hours of downloading it, you must download it again.

3.5. Installing a License

NVIDIA virtual GPU software licenses are distributed as .bin files for download from the NVIDIA Licensing Center.

Note: If you have configured high availability for the license server, you must install the license both on the primary license server and on the secondary license server.
Before installing a license, ensure that you have downloaded the license file from the NVIDIA Licensing Center.
  1. In the license server management interface, select License Management.
  2. On the License Management page that opens, click Choose File.
    Figure 16. Selecting a License File

    Screen capture that shows a file browser that is opened from the License Management page.

  3. In the file browser that opens, select the .bin file and click Open.
  4. Back on the License Management page, click Upload to install the license file on the license server. The license server should confirm successful installation of the license file.
    Figure 17. Successful Upload of a License File

    Screen capture of the License Management page showing confirmation of a successful installation of a license file.

  5. If you have configured high availability for the license server, restart the license server service on the primary license server and on the secondary license server.
    • On Windows, use the Service Manager, which is accessible from Task Manager, to restart the FNLS-nvidia service.
    • On Linux, as root, restart the flexnetls-nvidia service.
      [nvidia@localhost ~]$ sudo systemctl restart flexnetls-nvidia

3.6. Verifying High Availability Setup of the License Server

The license server log file indicates the failover role of the given license server and its synchronization status.

For the location of the log file on your platform, refer to Log File Locations and Types.

In the license server log file search for the string that designates the server role. The line that contains the string and the lines that follow it indicate the role and status of the server.

  • For the primary server, search for the string main server.
    23:29:25,655 INFO  Server is designated as a main server in a failover configuration
    23:29:29,041 INFO  Generated sync message for the backup server
    23:34:31,815 INFO  Received sync request from the backup server
    
  • For the secondary server, search for the string backup server.
    00:39:53,290 INFO  Server is designated as a backup server in a failover configuration
    00:39:55,388 INFO  Starting sync from main server
    00:39:56,784 INFO  Successfully completed sync from main server
    
Tip: When a client acquires a license from the primary server, the number of available licensed features is reduced by 1 on both the primary and the secondary servers. When the license server is operating, you can verify its high availability setup by confirming that the count of available licenses on the primary and the secondary servers changes as expected as clients acquire licenses from the server.

3.7. Viewing Information About Installed Licenses

From the license server management interface, you can find out which licenses are installed on the server, view detailed information about individual licenses, and see how licensed clients are using the installed licenses.

3.7.1. Viewing the Properties of All Installed Licensed Features

By viewing licensed feature properties, you can see the licenses that are installed on the server and get detailed information about each installed license feature.

In the license server management interface, select Licensed Feature Usage.

The Licensed Feature Usage page that opens lists all licensed features installed on the license server.

Figure 18. Viewing Licensed Feature Properties

Screen capture showing the Licensed Feature Usage page

For each licensed feature, the properties in the following table are displayed.

Table 1. Licensed Feature Properties
Property Description
Feature An abbreviated name for the feature.
Version The version number associated with the feature.
Count The number of licenses for the feature that are currently installed on the license server. Each concurrent user of a feature normally consumes one license.
Available The number of licenses for the feature that are currently available to borrow from the server. This number decreases as users borrow licenses from the server, and increases as licenses are returned.
Expiry The date on which the right to use the licensed feature expires. If the licenses are perpetual use licenses, they have no expiration date. Perpetual licenses are indicated by permanent in place of an expiration date.

3.7.2. Viewing the Details of a Single Licensed Feature

For each installed license feature, you can view detailed information about the feature.
  1. In the license server management interface, select Licensed Feature Usage.
  2. On the Licensed Feature Usage page that opens, click the individual licensed feature about which you want detailed information. The Licensed Feature Details page that opens shows information about the feature.
    Figure 19. Licensed Feature Usage Details

    Screen capture showing the Licensed Feature Details page.

3.7.3. Viewing Information About All Borrowed Licenses

By viewing information about all borrowed licenses, you can find out which licenses have been borrowed from the license server and are in use by a licensed client.

In the license server management interface, select Licensed Clients.

The Licensed Clients page that opens lists the NVIDIA virtual GPU software client virtual machines are using licensed features.

The example in Figure 20 shows that one NVIDIA virtual GPU software client virtual machine is using a Quadro-Virtual-DWS license.

Figure 20. Viewing License Usage

Screen capture of the Licensed Clients page showing one NVIDIA virtual GPU software client virtual machine that is using a Quadro-Virtual-DWS license.

3.7.4. Viewing the Details of a Single Licensed Client

  1. In the license server management interface, select Licensed Clients.
  2. On the Licensed Clients page that opens, click the Client ID of the licensed client about which you want detailed information. The Client Details page opens to show detailed information about the licensed client.
    Figure 21. Licensed Client Details

    Screen capture showing the Client Details page.

3.7.5. About the License Borrow Period

At the end of the borrow period, typically multiple days, a borrowed license is automatically freed by the license server for use by other clients, and becomes unavailable on the licensed client that previously held it. While active, a licensed client renews its license periodically to ensure the borrow period does not expire, if it continues to use the license and has ongoing network connectivity to the license server.

3.8. Reserving Licenses

Licenses are normally distributed to clients on a first-come, first-served basis. Reservations allow licenses to be set aside for specific clients, ensuring that those clients can always obtain a license.

3.8.1. Creating License Reservations

The license server management interface enables you to set up several new reservations and submit them to the license server in a single group.
  1. In the license server management interface, select Reservations. The License Reservations page opens.
  2. Add each reservation that you want to create to the list of pending reservations.
    Figure 22. Adding a License Reservation

    Screen capture showing the License Reservations page.

    1. On the License Reservations page, click Add.
    2. On the Add Reservation page that opens, provide the details of the client for which you are creating the reservation and click Add.
      Group Name
      (Optional) Enter the name you want to assign to this reservation group.
      Client ID
      Enter the client’s Ethernet MAC address.
      Feature Name
      Enter the licensed feature name as listed on the Licensed Feature Usage page, which is shown in Viewing the Properties of All Installed Licensed Features.
      Version
      Enter the version number listed for the feature listed on the Licensed Feature Usage page.
      Count
      Set to the number of licenses that you want to reserve for the client.
  3. After adding all reservations that you want to create, click Submit to commit the pending reservations to the license server.
    Figure 23. Submitting a Pending Reservation

    Screen capture showing the License Reservations page with pending reservations.

After the reservations are submitted, the License Reservations page shows a list of currently stored reservations on the server.
Figure 24. Listing Reservations

Screen capture of the License Reservations page showing currently stored reservations.

3.8.2. Deleting License Reservations

If a client no longer requires a license that is reserved for it, delete the reservation to release the license for distribution to other clients.
  1. In the license server management interface, select Reservations.
  2. On the License Reservations page that opens, select the reservations that you want to delete and click Edit.

    The License Reservations page is updated to replace the existing buttons on the page with the Delete button.

  3. On the updated License Reservations page, click Delete.
    Figure 25. Deleting a Reservation

    Screen capture of the License Reservations page showing the confirmation for deleting a request.

  4. In the confirmation dialog box that opens, click OK.

3.8.3. Exporting and Importing License Reservations

Exporting license reservations downloads the current reservation list as an XML file through your web browser. Importing license reservations from an XML file replaces the license server’s current reservation list with the contents of the file.
Note: Because importing license reservations from a file replaces the license server’s current reservation list, any reservations on the server that are not in the file are lost.
  1. In the license server management interface, select Reservations.
  2. On the License Reservations page that opens, do one of the following:
    • To export license reservations, click Export.
    • To import license reservations, click Import, browse to the XML file that contains the reservations, and click Upload.
    Figure 26. Exporting and Importing License Reservations

    Screen capture showing the License Reservations page with the Import and Export buttons highlighted.

3.8.4. Removing Licenses from a License Server

Remove licenses from a license server if they are no longer needed or in preparation for migrating them to a new server. Removing licenses involves generating and downloading a license file from which you have removed the add-ons that correspond to the licenses that you want to remove.

  1. If you are not already logged in, log in to the NVIDIA Licensing Center.
  2. In the navigation pane of the NVIDIA Software Licensing Center page, under GRID Licensing, select Search License Servers.
  3. On the Search Servers page that opens, select the license server from which you want to remove licenses.
  4. On the View Server page that opens, follow the Remove Add-Ons link.

    Screen capture showing the View Server page.

  5. On the Remove Add-Ons page that opens, in the Qty to Remove field, enter the number of licenses you want to remove and click Remove Add-Ons.

    Screen capture showing the Remove Add-Ons page.

    After clicking Remove Add-Ons, you are returned to the View Server page.
  6. Back on the View Server page, follow the Download License File link and save the .bin license file to your license server.
    Note: You must download the license file after you remove add-ons. If you do not download the license file, the licenses that correspond to the add-ons that you removed from the license file are not removed from the server.
If you removed licenses in preparation for migrating them to a new server, add them to the server as explained in Registering Your License Server and Getting License Files.

Converting an Evaluation License Server to a Permanent License Server

If you purchase NVIDIA virtual GPU software licenses after evaluating the software, you can use the same license server that you registered for your evaluation licenses to serve your permanent licenses.
  1. Log in to the NVIDIA Licensing Center with the account that you created for getting your evaluation licenses.
  2. Get the NVIDIA virtual GPU software for the licenses that you purchased. For instructions, refer to Virtual GPU Software Quick Start Guide.
  3. Get your new license files as explained in Registering Your License Server and Getting License Files.
    Note: Follow the steps only for mapping add-ons and downloading the license file. Do not try to register your license server again. If you try to register a license server that is already registered, the attempt fails and you are warned that the MAC address is already in use.

4. Troubleshooting the NVIDIA Virtual GPU Software License Server

You can troubleshoot some common issues with the license server yourself without the need to obtain help from NVIDIA.

Note: Before troubleshooting, review Virtual GPU License Server Release Notes for information about known issues and potential workarounds.

4.1. Obtaining Diagnotsic Information from the License Server Log files

The license server log files contain diagnostic information to help with troubleshooting. If necessary, you can increase the amount of information in the log files by changing the log level of the license server.

4.1.1. Log File Locations and Types

Log files from the installer and license server are in the locations in the following table.

Table 2. Log File Locations
Host OS Log Location
Windows Installer C:\Program Files (x86)\NVIDIA\License Server\Logs
License server C:\Windows\ServiceProfiles\NetworkService\flexnetls\nvidia\logs
Linux Installer /opt/flexnetls/nvidia/Logs/
License server /var/opt/flexnetls/nvidia/logs

The license server generates these types of runtime log files:

  • Management interface accesses are recorded in access_*.request.log files.
  • License server activity is recorded in flexnetls_*.log files.

4.1.2. Changing the License Server Log Level

The default log level of the license server is ERROR. To increase the amount of information in the log files, set the log level to a higher level.
  1. In the license server management interface, select Configuration and click the Properties tab.
  2. On the License Server Configuration page, in the Logging Threshold field, enter a higher log level, for example WARN or INFO, and click Save.
    Figure 27. Changing the License Server Log Level

    Screen capture showing the License Server Configuration page with the Logging Threshold field highlighted.

All messages at or below the level you set are recorded in the log file. For example, if you set the log level to WARN, fatal-event, error, and warning messages are recorded.

4.2. Management Interface Connection Errors

The management interface at http://hostname:8080/licserver might be unreachable because the license server host’s firewall disallows remote access to server TCP port 8080 or because the Apache Tomcat service is not running on the server.
  1. If you are trying to access the management interface from a remote machine, try accessing the interface locally from the license server host. To access the interface locally, open a web browser on the license server host and connect to the URL http://localhost:8080/licserver.
  2. If you can access the management interface locally, ensure that the license server host’s firewall is configured to allow remote access to server TCP port 8080.
  3. If you cannot access the management interface locally, verify that the Apache Tomcat service is running on the license server host.
    • On Windows, use the Service Manager, which is accessible from Task Manager, to restart the service if it is not running.
      Figure 28. Apache Tomcat Status in Windows Services Manager

      Screen capture of the Windows Services Manager showing the status of Apache Tomcat.

    • On Linux, check the status of the tomcat service.
      [nvidia@localhost ~]$ systemctl status tomcat.service
      tomcat.service - Apache Tomcat Web Application Container
         Loaded: loaded (/usr/lib/systemd/system/tomcat.service; enabled)
         Active: active (running) since Fri 2015-09-11 07:39:11 PDT; 9h ago
       Main PID: 1373 (java)
         CGroup: /system.slice/tomcat.service
                 └─1373 java -classpath /usr/share/tomcat/bin/bootstrap.jar:/usr/sh...

4.3. License Server Connection Errors

If the license server’s management interface cannot establish a connection to the license server, the management interface displays an error message.
Figure 29. License Server Connection Error

Screen capture of the Licensed Clients page showing a connection error.

  1. Verify that the license service is running.
    • On Windows, use the Service Manager, which is accessible from Task Manager, to restart the service if it is not running.
      Figure 30. License Server Status in Windows Services Manager

      Screen capture of the Windows Services Manager showing the status of the license server.

    • On Linux, check the status of the flexnetls-nvidia service.
      [nvidia@localhost ~]$ systemctl status flexnetls-nvidia.service
      flexnetls-nvidia.service - LSB: start and stop FlexNet License Server
         Loaded: loaded (/etc/rc.d/init.d/flexnetls-nvidia)
         Active: active (running) since Fri 2015-09-11 14:44:34 PDT; 2h 49min ago
        Process: 4502 ExecStart=/etc/rc.d/init.d/flexnetls-nvidia start (code=exited, status=0/SUCCESS)
         CGroup: /system.slice/flexnetls-nvidia.service
                 ├─4567 java -Dbase.dir=/var/opt/flexnetls/nvidia -jar /opt/flexnet...
                 └─4609 java -Dbase.dir=/var/opt/flexnetls/nvidia -jar /opt/flexnet...
  2. Inspect the license server log files, which are described in Log File Locations and Types.

4.4. License Upload Failures

Errors may occur during an attempt to upload a license file to the license server.

4.4.1. License Response Fails Trust Criteria

The license server reports a trust failure if it attempts to reload a license file that’s already loaded.

Verify that the license file being uploaded is not already active on the server.

4.4.2. Capability Response Rejected - Response Time Too Old

The license server reports this error if the license file you are attempting to upload has expired. Licenses generated on the NVIDIA licensing portal must be installed onto your license server within 24 hours of generation.

Generate a new license file on the licensing portal and promptly upload the new file to your license server.

4.4.3. Capability Response Rejected – Update Time Invalid

The license server reports this error if the license server is already configured with a license file that is newer than the license file you are attempting to upload.

You cannot roll back an active license to an older license file.

5. Uninstalling the NVIDIA Virtual GPU Software License Server

You can uninstall the NVIDIA virtual GPU software License Server when it is no longer required.

5.1. Uninstalling the NVIDIA Virtual GPU Software License Server on Windows

  1. Start the license server uninstaller. You can start the license server uninstaller in Windows Control Panel or in Windows Explorer from the license server installation directory.
    • In Windows Control Panel, open the Programs and Features pane, select License Server from the publisher NVIDIA, and click Uninstall/Change.
      Figure 31. Starting the Uninstaller from Windows Control Panel

      Screen capture of the Windows Control Panel showing how to uninstall the license server.

    • In Windows Explorer, open the license server installation directory and double-click the Change License Server Installation application.

      The default license server installation directory is C:\Program Files (x86)\NVIDIA\License Server.

      Figure 32. Starting the Uninstaller in Windows Explorer from the License Server Installation Directory

      Screen capture of Windows Explorer showing the Change License Server Installation application in the license server installation directory.

  2. In the Configure License Server dialog box that opens, ensure that the Uninstall Product option is selected and click Next.
    Figure 33. Running the License Server Uninstaller on Windows

    Screen capture showing the Configure License Server dialog box with the Uninstall Product option selected.

  3. When prompted, confirm that you want to uninstall the license server.

5.2. Uninstalling the NVIDIA Virtual GPU Software License Server on Linux

  1. Start the license server uninstaller.
    1. Change to the license server installation directory. The default license server installation directory is /opt/flexnetls/nvidia.
      [nvidia@localhost ~]$ cd /opt/flexnetls/nvidia
    2. As root, run the Change License Server Installation command.
      [nvidia@localhost ~]$ sudo ./Change\ License\ Server\ Installation
  2. In the Configure License Server window that opens, ensure that the Uninstall Product option is selected and click Next.
    Figure 34. Running the License Server Uninstaller on Linux

    Screen capture showing the Configure License Server dialog box with the Uninstall Product option selected.

  3. When prompted, confirm that you want to uninstall the license server.

Notices

Notice

ALL NVIDIA DESIGN SPECIFICATIONS, REFERENCE BOARDS, FILES, DRAWINGS, DIAGNOSTICS, LISTS, AND OTHER DOCUMENTS (TOGETHER AND SEPARATELY, "MATERIALS") ARE BEING PROVIDED "AS IS." NVIDIA MAKES NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE.

Information furnished is believed to be accurate and reliable. However, NVIDIA Corporation assumes no responsibility for the consequences of use of such information or for any infringement of patents or other rights of third parties that may result from its use. No license is granted by implication of otherwise under any patent rights of NVIDIA Corporation. Specifications mentioned in this publication are subject to change without notice. This publication supersedes and replaces all other information previously supplied. NVIDIA Corporation products are not authorized as critical components in life support devices or systems without express written approval of NVIDIA Corporation.

HDMI

HDMI, the HDMI logo, and High-Definition Multimedia Interface are trademarks or registered trademarks of HDMI Licensing LLC.

OpenCL

OpenCL is a trademark of Apple Inc. used under license to the Khronos Group Inc.

Trademarks

NVIDIA, the NVIDIA logo, NVIDIA GRID, vGPU, Pascal, Quadro, and Tesla are trademarks or registered trademarks of NVIDIA Corporation in the U.S. and other countries. Other company and product names may be trademarks of the respective companies with which they are associated.

Third-Party Software

This NVIDIA product contains third party software that is made available under their respective software licenses.

Apache Tomcat (https://tomcat.apache.org/download-80.cgi) is provided under the following terms: Copyright 2015 NVIDIA Corporation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.