License System Quick Start Guide

NVIDIA License System Quick Start Guide

Minimal instructions for installing and configuring the NVIDIA License System.

About this Guide

This Quick Start Guide provides minimal instructions for installing and configuring NVIDIA License System. The instructions cover the configuration of a Cloud License Service (CLS) instance and the installation and configuration a standalone Delegated License Service (DLS) instance. The instructions for configuring a DLS instance assume that the VM that hosts the DLS instance has been assigned an IP address automatically.

If you need complete instructions, are hosting a DLS instance on a VM that has not been assigned an IP address automatically, or require high availability for a DLS instance, refer to NVIDIA License System User Guide.

Before proceeding, determine whether you want to use a CLS instance or DLS instance to serve licenses to clients. For guidance, refer to About Service Instances in NVIDIA License System User Guide.

1. Configuring a CLS Instance

A Cloud License Service (CLS) instance is hosted on the NVIDIA Licensing Portal.

1.1. Creating a License Server on the NVIDIA Licensing Portal

To be able to allot licenses to an NVIDIA License System instance, you must create at least one license allocation on the NVIDIA Licensing Portal. Creating a license allocation defines the set of licenses to be allotted.

In the NVIDIA Licensing Portal, navigate to the organization or virtual group for which you want to create the license allocation.
1. 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.
2. Optional: If your assigned roles give you access to multiple virtual groups, click View settings at the top right of the page and in the My Info window that opens, select the virtual group from the Virtual Group drop-down list, and close the My Info window.
If no license allocations 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 allocation.
In the left navigation pane of the NVIDIA Licensing Portal dashboard, expand LICENSE ALLOCATION and click CREATE ALLOCATION. If you are adding a license allocation to an organization or virtual group for which a license allocation has already been created, click CREATE ALLOCATION.

The Create License Allocation wizard opens.
On the Create License Allocation page of the wizard, step through the configuration requirements to provide the details of your license allocation.
1. Step 1 – Identification: In the Name field, enter your choice of name for the license allocation and in the Description field, enter a text description of the license allocation. The description is required and will be displayed on the details page for the license allocation that you are creating.
2. Step 2 – Features: Select one or more available features from your entitlements to allot to this license allocation.

Creating an allocation is the same process for every product family. Deploy to CLS and Deploy to DLS are not available for Network product families (UFM, Rivermax, and others) or for Bright.

Click REVIEW SUMMARY to review the configuration summary before creating the license allocation.

On the Create License Allocation page, from the Step 4 – Configuration menu, click the CREATE ALLOCATION option to create this license allocation. Alternatively, you can click CREATE ALLOCATION on the Server Summary page.

1.2. Installing a License Allocation on a CLS Instance

To install a license allocation on a CLS instance, select the Deploy to CLS option.

1.3. Generating a Client Configuration Token for a CLS Instance

Log in to theNVIDIA Enterprise Application Hub and click NVIDIA LICENSING PORTAL.
From the top navigation bar, select License Management, and then select License Allocations.
Select the CLS license allocation for which you want to generate a client configuration token.
Click Create client config token.
Optional: In the Expiration section, select an expiration date for the client configuration token. If you do not select a date, the default token expiration time is 12 years.
Click Download Token. A file named client_configuration_token_mm-dd-yyyy-hh-mm-ss.tok is saved to your default downloads folder.

2. Configuring a DLS Instance

A Delegated License Service (DLS) instance is hosted on-premises at a location that is accessible from your private network, such as inside your data center.

Before configuring a DLS instance, ensure that the DLS appliance is installed in a suitable VM or deployed in a suitable container on a bare-metal OS as explained in Installing and Configuring the DLS Virtual Appliance in NVIDIA License System User Guide.

2.1. Registering the DLS Administrator User

Each DLS virtual appliance is configured with a user account specifically for administering the DLS. This account provides access through a web-based management interface to the NVIDIA Licensing application on the appliance. Before administering a DLS virtual appliance, you must register this user to be able to access this management interface.

Open a web browser and connect to the URL https://dls-vm-ip-address.

dls-vm-ip-address

The IP address or, if defined, the fully qualified domain name or the CNAME of the VM on which the DLS virtual appliance is installed.
You can get the IP address from the management console of your hypervisor.
On the Set Up page that opens, click NEW INSTALLATION.
On the Register User page that opens, provide the credentials for the DLS administrator user.

Note:

If the DLS administrator user has already been registered, the login page opens instead of the Register User page.
1. Optional: If you want to change the user name from the preset name dls_admin, replace the text in the Username field with your choice of user name.
2. Provide a password for the DLS administrator user and confirm the password.
  The password is case sensitive and must contain 15 to 64 characters, including at least one uppercase letter, one lowercase letter, one digit, and one special character. It must not contain whitespace or the username, and it must pass the appliance's password-strength validation.
On the Register User page that opens, provide the credenttials for the DLS administrator user.

Note:

If the DLS administrator user has already been registered, the login page opens instead of the Register User page.
1. Optional: If you want to change the user name from the preset name dls_admin, replace the text in the Username field with your choice of user name.
2. Provide a password for the DLS administrator user and confirm the password. The password must be at least eight characters long and is case sensitive.
Note:

You can change the DLS administrator user name and password at any time after the DLS administrator user is registered. For instructions, refer to Changing the DLS Administrator User Name and Password.

2.2. Changing the Name and Description of a DLS Instance

By default, a DLS instance is created with the name DEFAULT_timestamp and the description ON_PREM_SERVICE_INSTANCE. To distinguish a DLS instance on the NVIDIA Licensing Portal when multiple DLS instances are configured, change these defaults to a meaningful name and the description.

Perform this task from the DLS virtual appliance.

Log in to the DLS appliance and open Home.
In the Appliance section, select Edit.
In Edit appliance, enter the Name and Description.

Note:

The instance name cannot contain special characters.

The updated name and description appear in the Appliance section.
Select Save.

2.3. Registering a DLS License Server Instance on an Air-Gapped Network

If your DLS license server instance is on an air-gapped network, you cannot download a DLS instance token to upload to the NVIDIA Licensing Portal to register the instance. Instead, you must register the instance by entering its details manually on the NVIDIA Licensing Portal..

Log in to the DLS appliance and open Home.
Under Get started, in Register with NLS Cloud Portal, select Pre-register DLS appliance.
Pre-registration is irreversible. It is intended for an appliance on an air-gapped network that blocks outbound traffic. Completing this operation signs you out of the appliance.
In the confirmation dialog, select Pre-register.
Sign in again. Copy the DLS appliance ID and record the appliance name and description. Use these details to register the appliance manually in the NVIDIA Licensing Portal.
In the NVIDIA Licensing Portal, navigate to the organization or virtual group for which you are registering the DLS license server instance. a. 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. b. Optional: If your assigned roles give you access to multiple virtual groups, click View settings at the top right of the page and in the My Info window that opens, select the virtual group from the Virtual Group drop-down list, and close the My Info window..
For your created license allocation, select either Deploy to DLS or (Legacy) NLL on DLS to open the Add DLS appliance window, select the Air-gapped DLS option, and complete the manual pre-registration. Alternatively, navigate to License Allocation in the left navigation pane of the NVIDIA Licensing Portal dashboard, choose Register DLS for air-gapped network from the ACTIONS menu, and enter the name, DLS license server instance ID, and description obtained in Step 5, then click REGISTER.
After portal registration, bind the license allocation to the appliance, download the allocation file, and install it on the DLS appliance.
After registration, return to the Deploy to DLS screen.
Select the acknowledgement checkbox ("I acknowledge that the downloaded license allocation file is valid for up to 3 years from the date of download").
Select the pre-registered appliance acknowledgement checkbox ("Important note: This license file must be retained until it is installed on [appliance name]. The system automatically acknowledges air-gapped registrations, making this initial installation file unavailable for re-download").
Click Download License File to complete the workflow (no additional installation steps are required).

2.4. Installing a License Allocation on a DLS Instance

To install or update a license allocation on a DLS appliance, perform the following steps:

In the NVIDIA Licensing Portal, select either Deploy to DLS or (Legacy) NLL on DLS for your created allocation.
From the options provided, either select an existing registered DLS instance that is unused or register a new DLS instance using one of the supported methods (standard or air-gapped registration).
Download the license allocation .bin file (the file must not exceed 20 MB).
Log in to the DLS appliance and open Home.
For the first installation, locate No license allocation installed on the Home page. In License allocation file, select the downloaded .bin file, and then select Install allocation.
To update an installed allocation, open License Allocation. Under Allocation controls, select Update License File.
In Update License File, choose the downloaded .bin file or drag it into the upload area (up to 20 MB). Selecting a valid file starts the update immediately; there is no separate installation confirmation.
After the installation or update succeeds, open License Allocation and verify the allocation details.

2.5. Generating a Client Configuration Token for a DLS Instance

Log in to the DLS appliance and open License Allocation.
Under Allocation controls, select Create client config token.
In Create Client Configuration Token, choose the connection address for each DLS node. Select an available FQDN, IPv4, or IPv6 address that licensing clients can reach. When more than one address is available for the selected IP version, choose the required address.
For Leasing port, select 443 (default) or 8082. Ensure that clients can reach the selected port at the connection addresses included in the token.
Under Token expiration, select an Expiration date, or leave it blank to use the default expiration of 12 years. To create a token without expiration, enable Token never expires.
Token expiration does not change entitlement expiration or the duration of an individual license lease. Expiration dates more than 12 years in the future, including Token never expires, are not recognized by NVIDIA vGPU releases 13.0 through 13.7 and 15.0 through 15.2. Review the driver compatibility notice before using these options.
Select Download Token. The generated client configuration token is downloaded as a .tok file.
The allocation scope is resolved automatically. You do not select scope references or fulfillment class references in this form.

For a DLS virtual appliance, port 443 supports both the web UI and client authentication and leasing. Port 8082 supports client authentication and leasing separately from the web UI. Select 8082 in the client configuration token when using the separate leasing port. Port 443 remains available for backward-compatible leasing.

After creating a client configuration token from a service instance, copy the client configuration token to each licensed client that you want to use the combination of license allocations and fulfillment conditions specified in the token. For more information, see Configuring a Licensed Client.

3. Configuring a Licensed Client

A client with a network connection obtains a license by leasing it from a NVIDIA License System service instance. The service instance serves the license to the client over the network from a pool of floating licenses obtained from the NVIDIA Licensing Portal. The license is returned to the service instance when the licensed client no longer requires the license.

The NVIDIA vGPU software graphics driver creates a default location in which to store the client configuration token on the client.

The process for configuring a licensed client is the same for CLS and DLS instances but depends on the OS that is running on the client.

3.1. Configuring a Licensed Client on Windows with Default Settings

Perform this task from the client.

Copy the client configuration token to the %SystemDrive%\Program Files\NVIDIA Corporation\vGPU Licensing\ClientConfigToken folder.
Restart the NvDisplayContainer service.

The NVIDIA service on the client should now automatically obtain a license from the CLS or DLS instance.

3.2. Configuring a Licensed Client on Linux with Default Settings

Perform this task from the client.

As root, open the file /etc/nvidia/gridd.conf in a plain-text editor, such as vi.
Copy

Copied!
```
            
            $ sudo vi /etc/nvidia/gridd.conf
        
```
Note:

You can create the /etc/nvidia/gridd.conf file by copying the supplied template file /etc/nvidia/gridd.conf.template.

Add the FeatureType configuration parameter to the file /etc/nvidia/gridd.conf on a new line as FeatureType="value".

value depends on the type of the GPU assigned to the licensed client that you are configuring.

GPU Type	Value
NVIDIA vGPU	1. NVIDIA vGPU software automatically selects the correct type of license based on the vGPU type.
Physical GPU	The feature type of a GPU in pass-through mode or a bare-metal deployment: 0: NVIDIA Virtual Applications 2: NVIDIA RTX Virtual Workstation 4: NVIDIA Virtual Compute Server

This example shows how to configure a licensed Linux client for NVIDIA RTX Virtual Workstation.

Copy
Copied!

            
            # /etc/nvidia/gridd.conf.template - Configuration file for NVIDIA Grid Daemon
…
# Description: Set Feature to be enabled
# Data type: integer
# Possible values:
# 0 => for unlicensed state
# 1 => for NVIDIA vGPU
# 2 => for NVIDIA RTX Virtual Workstation
# 4 => for NVIDIA Virtual Compute Server
FeatureType=2
...

Copy the client configuration token to the /etc/nvidia/ClientConfigToken directory.
Ensure that the file access modes of the client configuration token allow the owner to read, write, and execute the token, and the group and others only to read the token.
1. Determine the current file access modes of the client configuration token.
  Copy
  
  Copied!
```
            
            # ls -l client-configuration-token-directory
        
```
2. If necessary, change the mode of the client configuration token to 744.
  Copy
  
  Copied!
```
            
            # chmod 744 client-configuration-token-directory/client_configuration_token_*.tok
        
```
client-configuration-token-directory

The directory to which you copied the client configuration token in the previous step.
Save your changes to the /etc/nvidia/gridd.conf file and close the file.
Restart the nvidia-gridd service.

The NVIDIA service on the client should now automatically obtain a license from the CLS or DLS instance.

3.3. Verifying the NVIDIA vGPU Software License Status of a Licensed Client

After configuring a client with an NVIDIA vGPU software license, verify the license status by displaying the licensed product name and status.

To verify the license status of a licensed client, run nvidia-smi with the –q or --query optionfrom the licensed client, not the hypervisor host. If the product is licensed, the expiration date is shown in the license status.

Copy
Copied!

            
            nvidia-smi -q
==============NVSMI LOG==============

Timestamp                                 : Wed Nov 23 10:52:59 2022
Driver Version                            : 525.60.06
CUDA Version                              : 12.0

Attached GPUs                             : 2
GPU 00000000:02:03.0
    Product Name                          : 
    Product Brand                         : NVIDIA RTX Virtual Workstation
    Product Architecture                  : Ampere
    Display Mode                          : Enabled
    Display Active                        : Disabled
    Persistence Mode                      : Enabled
    MIG Mode
        Current                           : Disabled
        Pending                           : Disabled
    Accounting Mode                       : Disabled
    Accounting Mode Buffer Size           : 4000
    Driver Model
        Current                           : N/A
        Pending                           : N/A
    Serial Number                         : N/A
    GPU UUID                              : GPU-ba5b1e9b-1dd3-11b2-be4f-98ef552f4216
    Minor Number                          : 0
    VBIOS Version                         : 00.00.00.00.00
    MultiGPU Board                        : No
    Board ID                              : 0x203
    Board Part Number                     : N/A
    GPU Part Number                       : 25B6-890-A1
    Module ID                             : N/A
    Inforom Version
        Image Version                     : N/A
        OEM Object                        : N/A
        ECC Object                        : N/A
        Power Management Object           : N/A
    GPU Operation Mode
        Current                           : N/A
        Pending                           : N/A
    GSP Firmware Version                  : N/A
    GPU Virtualization Mode
        Virtualization Mode               : VGPU
        Host VGPU Mode                    : N/A
    vGPU Software Licensed Product Product Name : NVIDIA RTX Virtual Workstation License Status : Licensed (Expiry: 2022-11-23 10:41:16 GMT)
    …
    …

Notices

Notice

This document is provided for information purposes only and shall not be regarded as a warranty of a certain functionality, condition, or quality of a product. NVIDIA Corporation (“NVIDIA”) makes no representations or warranties, expressed or implied, as to the accuracy or completeness of the information contained in this document and assumes no responsibility for any errors contained herein. NVIDIA shall have no liability for the consequences or use of such information or for any infringement of patents or other rights of third parties that may result from its use. This document is not a commitment to develop, release, or deliver any Material (defined below), code, or functionality.

NVIDIA reserves the right to make corrections, modifications, enhancements, improvements, and any other changes to this document, at any time without notice.

Customer should obtain the latest relevant information before placing orders and should verify that such information is current and complete.

NVIDIA products are sold subject to the NVIDIA standard terms and conditions of sale supplied at the time of order acknowledgement, unless otherwise agreed in an individual sales agreement signed by authorized representatives of NVIDIA and customer (“Terms of Sale”). NVIDIA hereby expressly objects to applying any customer general terms and conditions with regards to the purchase of the NVIDIA product referenced in this document. No contractual obligations are formed either directly or indirectly by this document.

NVIDIA products are not designed, authorized, or warranted to be suitable for use in medical, military, aircraft, space, or life support equipment, nor in applications where failure or malfunction of the NVIDIA product can reasonably be expected to result in personal injury, death, or property or environmental damage. NVIDIA accepts no liability for inclusion and/or use of NVIDIA products in such equipment or applications and therefore such inclusion and/or use is at customer’s own risk.

NVIDIA makes no representation or warranty that products based on this document will be suitable for any specified use. Testing of all parameters of each product is not necessarily performed by NVIDIA. It is customer’s sole responsibility to evaluate and determine the applicability of any information contained in this document, ensure the product is suitable and fit for the application planned by customer, and perform the necessary testing for the application in order to avoid a default of the application or the product. Weaknesses in customer’s product designs may affect the quality and reliability of the NVIDIA product and may result in additional or different conditions and/or requirements beyond those contained in this document. NVIDIA accepts no liability related to any default, damage, costs, or problem which may be based on or attributable to: (i) the use of the NVIDIA product in any manner that is contrary to this document or (ii) customer product designs.

No license, either expressed or implied, is granted under any NVIDIA patent right, copyright, or other NVIDIA intellectual property right under this document. Information published by NVIDIA regarding third-party products or services does not constitute a license from NVIDIA to use such products or services or a warranty or endorsement thereof. Use of such information may require a license from a third party under the patents or other intellectual property rights of the third party, or a license from NVIDIA under the patents or other intellectual property rights of NVIDIA.

Reproduction of information in this document is permissible only if approved in advance by NVIDIA in writing, reproduced without alteration and in full compliance with all applicable export laws and regulations, and accompanied by all associated conditions, limitations, and notices.

THIS DOCUMENT AND 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. TO THE EXTENT NOT PROHIBITED BY LAW, IN NO EVENT WILL NVIDIA BE LIABLE FOR ANY DAMAGES, INCLUDING WITHOUT LIMITATION ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF ANY USE OF THIS DOCUMENT, EVEN IF NVIDIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Notwithstanding any damages that customer might incur for any reason whatsoever, NVIDIA’s aggregate and cumulative liability towards customer for the products described herein shall be limited in accordance with the Terms of Sale for the product.

VESA DisplayPort

DisplayPort and DisplayPort Compliance Logo, DisplayPort Compliance Logo for Dual-mode Sources, and DisplayPort Compliance Logo for Active Cables are trademarks owned by the Video Electronics Standards Association in the United States and other countries.

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 Maxwell, NVIDIA Pascal, NVIDIA Turing, NVIDIA Volta, 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.