Is this page helpful?

Configuring License Extension#

Overview#

To enable Kit Applications to communicate with Omniverse License Servers, the NVIDIA License Service extension, omni.kit.nls, must be included as a dependency. This extension is responsible for requesting licenses from the license server.

Furthermore, the NVIDIA License Service extension can be configured to execute enforcement, thereby facilitating adherence to corporate license policies. When activated, this functionality prohibits the initiation of Kit applications if an insufficient number of licenses are available on the server.

Adding and Configuring the Kit Licensing Extension#

Build your Kit application and then edit the application .kit file and add the omni.kit.nls extension as a dependency. A more detailed guide to this licensing extension is available in the Omniverse Kit Documentation

Integrating Kit applications with an Omniverse License Server#

This guide details the steps required to integrate a Kit application with an Omniverse License Server. The steps relate to either Cloud License Servers (CLS) or Delegated License Servers (DLS).

  1. Log in to your Cloud or Delegated License Server.

  2. Navigate to the Dashboard tab. On the License Server Details page, open the Actions menu and then click Generate client config token.

  3. In the Generate Client Configuration Token dialog, click Download Client Configuration Token and save the token with a .tok file extension to your local workstation.

  4. Rename the downloaded token to client_config.tok and move it to the local .nvidia-omniverse/config/nls directory.

  5. On your Cloud or Delegated License Server, open the Settings tab. Under Server Instance Settings, select API Keys and copy the key string from the pop-up menu.

  6. Open up a text editor and paste the copied API key. Save the file as api_key in the .nvidia-omniverse/config/nls directory.

Note

Your local .nvidia-omniverse/config/nls folder should now have the two necessary files required for the Kit application to authenticate to the license server. These are:

  • client_config.tok

  • api_key

If desired, these files can be placed in a different directory, which must then be specified using the NLS_CONFIGURATION_PATH environment variable.

  1. To test the integration, launch the Kit application. License responses will appear in the Kit console log (for example [Info] [omni.kit.nls.impl.nls_extension] NLS: api key response). Active license leases are listed on the Leases tab.

Configuring License Enforcement#

By default, Kit applications can launch even if the license server denies access due to insufficient licenses. Organizations that require strict compliance can enforce policies to prevent application startup under these conditions.

To enable enforcement, use one of the following methods:

  1. Set the NLS_ENFORCE_COMPLIANCE environment variable to a non-zero value (for example setx NLS_ENFORCE_COMPLIANCE 1).

  2. Set /exts/omni.kit.nls/enforceCompliance setting to true.