Deploying the NVIDIA vGPU Software License Manager

This chapter covers deployment of the NVIDIA vGPU software license server, including:

  • Platform Requirements

  • Installing the Java Runtime Environment on Windows

  • Installing the License Server Software on Windows

Platform Requirements

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

Hardware and Software Requirements

  • The hosting platform may be a physical machine, an on-premises virtual machine (VM), or a VM on a supported cloud service. NVIDIA recommends using a host that is dedicated solely to running the license server.

  • The recommended minimum configuration is 2 CPU cores and 4 GB of RAM. A high-end configuration of 4 or more CPU cores with 16 GB of RAM is suitable for handling up to 150,000 licensed clients.

  • At least 1 GB of hard drive space is required.

  • The hosting platform must run a supported operating system.

  • On Window platforms, .NET Framework 4.5 or later is required.

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

  • The platform’s date and time must be set accurately. NTP is recommended.

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.

Installing vGPU SLS on Windows

The NVIDIA vGPU Software License Server requires a Java runtime environment, which must be installed separately before you install the license server.

Installing the Java Runtime Environment

If a suitable Java runtime environment (JRE) version is not already installed on your system install a supported JRE before running the NVIDIA license server installer.

  1. Download a supported 64-bit Oracle Java SE JRE or OpenJDK JRE.

    • Download Oracle Java SE JRE from the Java Downloads for All Operating Systems page.

    • Download Oracle Java SE JRE from the java.com: Java + You page.

    • Download OpenJDK JRE from the Community builds using source code from OpenJDK project on GitHub.

  2. Install the JRE that you downloaded.

    • Oracle Java SE JRE installation.

    ../_images/dg-nv-license-01.png
    • OpenJDK JRE installation.

    ../_images/dg-nv-license-02.png
  3. Set the JAVA_HOME system variable to the full path to the jre folder of your JRE installation.

    • For 64-bit Oracle Java SE JRE: C:Program FilesJavajre1.8.0_191

    • For 64-bit OpenJDK JRE: C:Program Filesojdkbuildjava-1.8.0-openjdk-1.8.0.201-1jre

    • Ensure that the path does not include any trailing characters, such as a slash or a space.

    • If you are upgrading to a new version of the JRE, update the value of the JAVA_HOME system variable to the full path to the jre folder of your new JRE version.

  4. Ensure that the Path system variable contains the path to the java.exe executable file.

    • For 64-bit Oracle Java SE JRE: C:Program FilesJavajre1.8.0_191bin

    • For 64-bit OpenJDK JRE: C:Program Filesojdkbuildjava-1.8.0-openjdk-1.8.0.201-1bin

Installing the License Server Software

  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.

    ../_images/dg-nv-license-03.png
  3. Choose the destination folder where you want the license server software to be installed.

    ../_images/dg-nv-license-04.png
  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.

    ../_images/dg-nv-license-05.png
  5. After installation has completed successfully, click Done to exit the installer.

Obtaining the License Server’s MAC Address

The license server’s Ethernet MAC address uniquely identifies your server to the NVIDIA Licensing Portal. You will need this address to register your license server with the NVIDIA Licensing Portal to generate license files.

  1. Open a web browser on the license server host and connect to the URL http://localhost:8080/licserver.

  2. In the license server management interface, select Configuration.

  3. On the License Server Configuration page that opens, in the Server host ID drop-down list, select the platform’s ETHERNET address.

    ../_images/dg-nv-license-06.png

Managing your License Files

To be able to download NVIDIA vGPU software licenses, you must create at least one license server on the NVIDIA Licensing Portal and allocate licenses to the server. After creating a license server and allocating licenses to it, you can download your license file.

Licensing Portal

To be able to download NVIDIA vGPU software licenses, you must create at least one license server on the NVIDIA Licensing Portal. Creating a license server on the NVIDIA Licensing Portal registers your license server host with the NVIDIA Licensing Portal through the MAC address of the host.

  1. In the NVIDIA Licensing Portal, navigate to the organization or virtual group for which you want to create the license server.

    • If you are not already logged in, log in to the NVIDIA Enterprise Application Hub and click NVIDIA LICENSING PORTAL to go to the NVIDIA Licensing Portal.

    • Optional: If your assigned roles give you access to multiple virtual groups, select the virtual group for which you are creating the license server from the list of virtual groups at the top right of the page.

    • If no license servers have been created for your organization or virtual group, the NVIDIA Licensing Portal dashboard displays a message asking if you want to create a license server.

    ../_images/dg-nv-license-07.png
  2. On the NVIDIA Licensing Portal dashboard, click CREATE LICENSE SERVER. The Create License Server window opens.

    ../_images/dg-nv-license-09.png
  3. Provide the details of your license server.

    • In the Server Name field, enter the host name of the license server.

    • In the Description field, enter a text description of the license server. This description is required and will be displayed on the details page for the license server that you are creating.

    • In the MAC Address field, enter the MAC address of your license server.

  4. Add the licenses for the products that you want to allocate to this license server. For each product, add the licenses as follows.

    • From the Product drop-down list, select the product for which you want to add licenses.

    • In the Licenses field, enter the number of licenses for the product that you want to add.

    • Click ADD.

  5. Leave the Failover License Server and Failover MAC Address fields unset.

  6. Click CREATE LICENSE SERVER.

Downloading a License File

Each license server that you create has license file associated with it. The license file contains all the licenses that you allocated to the license server. After downloading the license file, you can install it on the license server host associated with the license server on the NVIDIA Licensing Portal.

  1. In the NVIDIA Licensing Portal, navigate to the organization or virtual group for which you want to download the license file.

    • If you are not already logged in, log in to the NVIDIA Enterprise Application Hub and click NVIDIA LICENSING PORTAL to go to the NVIDIA Licensing Portal.

    • Optional: If your assigned roles give you access to multiple virtual groups, select the virtual group for which you are downloading the license file from the list of virtual groups at the top right of the page.

  2. In the list of license servers on the NVIDIA Licensing Portal dashboard, select the license server whose associated license file you want to download.

  3. In the License Server Details page that opens, review the licenses allocated to the license server.

    ../_images/dg-nv-license-10.png
  4. Screen capture showing the License Server Details page on the NVIDIA Licensing Portal.

  5. Click DOWNLOAD LICENSE FILE and save the .bin license file to your license server for installation.

Installing a License

NVIDIA vGPU software licenses are distributed as .bin files for download from the NVIDIA Licensing Portal.

Before installing a license, ensure that you have downloaded the license file from the NVIDIA Licensing Portal.

  1. In the license server management interface, select License Management.

    ../_images/dg-nv-license-11.png
  2. On the License Management page that opens, click Choose File.

  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.

    ../_images/dg-nv-license-12.png

Note

For additional configuration options including Linux server deployment, securing your license server, and license provisioning, refer to the Virtual GPU Software License Server User Guide.