NVAPI Reference Documentation
Release 520: October 14, 2022

Data Structures | Macros | Typedefs | Enumerations | Functions

Data Structures

struct  _NV_LICENSE_EXPIRY_DETAILS
 
struct  _NV_LICENSE_FEATURE_DETAILS_V1
 
struct  _NV_LICENSE_FEATURE_DETAILS_V2
 
struct  _NV_LICENSE_FEATURE_DETAILS_V3
 
struct  _NV_LICENSE_FEATURE_DETAILS_V4
 
struct  _NV_LICENSABLE_FEATURES_V1
 
struct  _NV_LICENSABLE_FEATURES_V2
 
struct  _NV_LICENSABLE_FEATURES_V3
 
struct  _NV_LICENSABLE_FEATURES_V4
 

Macros

#define NV_LICENSE_MAX_COUNT   3
 
#define NV_LICENSE_SIGNATURE_SIZE   (128)
 
#define NV_LICENSE_INFO_MAX_LENGTH   (128)
 
#define NV_LICENSE_FEATURE_DETAILS_VER1   MAKE_NVAPI_VERSION(NV_LICENSE_FEATURE_DETAILS_V1, 1)
 
#define NV_LICENSE_FEATURE_DETAILS_VER   NV_LICENSE_FEATURE_DETAILS_VER1
 
#define NV_LICENSABLE_FEATURES_VER1   MAKE_NVAPI_VERSION(NV_LICENSABLE_FEATURES_V1, 1)
 
#define NV_LICENSABLE_FEATURES_VER2   MAKE_NVAPI_VERSION(NV_LICENSABLE_FEATURES_V2, 2)
 
#define NV_LICENSABLE_FEATURES_VER3   MAKE_NVAPI_VERSION(NV_LICENSABLE_FEATURES_V3, 3)
 
#define NV_LICENSABLE_FEATURES_VER4   MAKE_NVAPI_VERSION(NV_LICENSABLE_FEATURES_V4, 4)
 
#define NV_LICENSABLE_FEATURES_VER   NV_LICENSABLE_FEATURES_VER4
 

Typedefs

typedef char NvAPI_LicenseString[NV_LICENSE_INFO_MAX_LENGTH]
 
typedef enum _NV_LICENSE_FEATURE_TYPE NV_LICENSE_FEATURE_TYPE
 
typedef struct _NV_LICENSE_EXPIRY_DETAILS NV_LICENSE_EXPIRY_DETAILS
 
typedef struct _NV_LICENSE_FEATURE_DETAILS_V1 NV_LICENSE_FEATURE_DETAILS_V1
 
typedef struct _NV_LICENSE_FEATURE_DETAILS_V2 NV_LICENSE_FEATURE_DETAILS_V2
 
typedef struct _NV_LICENSE_FEATURE_DETAILS_V3 NV_LICENSE_FEATURE_DETAILS_V3
 
typedef struct _NV_LICENSE_FEATURE_DETAILS_V4 NV_LICENSE_FEATURE_DETAILS_V4
 
typedef NV_LICENSE_FEATURE_DETAILS_V1 NV_LICENSE_FEATURE_DETAILS
 
typedef struct _NV_LICENSABLE_FEATURES_V1 NV_LICENSABLE_FEATURES_V1
 
typedef struct _NV_LICENSABLE_FEATURES_V2 NV_LICENSABLE_FEATURES_V2
 
typedef struct _NV_LICENSABLE_FEATURES_V3 NV_LICENSABLE_FEATURES_V3
 
typedef struct _NV_LICENSABLE_FEATURES_V4 NV_LICENSABLE_FEATURES_V4
 
typedef NV_LICENSABLE_FEATURES_V4 NV_LICENSABLE_FEATURES
 

Enumerations

enum  _NV_LICENSE_FEATURE_TYPE {
  NV_LICENSE_FEATURE_UNKNOWN = 0 , NV_LICENSE_FEATURE_VGPU = 1 , NV_LICENSE_FEATURE_NVIDIA_RTX = 2 , NV_LICENSE_FEATURE_QUADRO = NV_LICENSE_FEATURE_NVIDIA_RTX ,
  NV_LICENSE_FEATURE_GAMING = 3
}
 

Functions

NVAPI_INTERFACE NvAPI_GPU_GetLicensableFeatures (__in NvPhysicalGpuHandle hPhysicalGpu, __inout NV_LICENSABLE_FEATURES *pLicensableFeatures)
 

Detailed Description

Interface to the NVIDIA GRID licensing feature

Macro Definition Documentation

◆ NV_LICENSABLE_FEATURES_VER

#define NV_LICENSABLE_FEATURES_VER   NV_LICENSABLE_FEATURES_VER4

◆ NV_LICENSABLE_FEATURES_VER1

#define NV_LICENSABLE_FEATURES_VER1   MAKE_NVAPI_VERSION(NV_LICENSABLE_FEATURES_V1, 1)

◆ NV_LICENSABLE_FEATURES_VER2

#define NV_LICENSABLE_FEATURES_VER2   MAKE_NVAPI_VERSION(NV_LICENSABLE_FEATURES_V2, 2)

◆ NV_LICENSABLE_FEATURES_VER3

#define NV_LICENSABLE_FEATURES_VER3   MAKE_NVAPI_VERSION(NV_LICENSABLE_FEATURES_V3, 3)

◆ NV_LICENSABLE_FEATURES_VER4

#define NV_LICENSABLE_FEATURES_VER4   MAKE_NVAPI_VERSION(NV_LICENSABLE_FEATURES_V4, 4)

◆ NV_LICENSE_FEATURE_DETAILS_VER

#define NV_LICENSE_FEATURE_DETAILS_VER   NV_LICENSE_FEATURE_DETAILS_VER1

◆ NV_LICENSE_FEATURE_DETAILS_VER1

#define NV_LICENSE_FEATURE_DETAILS_VER1   MAKE_NVAPI_VERSION(NV_LICENSE_FEATURE_DETAILS_V1, 1)

◆ NV_LICENSE_INFO_MAX_LENGTH

#define NV_LICENSE_INFO_MAX_LENGTH   (128)

Length for Grid License.

◆ NV_LICENSE_MAX_COUNT

#define NV_LICENSE_MAX_COUNT   3

Maximum number of supported Feature License.

◆ NV_LICENSE_SIGNATURE_SIZE

#define NV_LICENSE_SIGNATURE_SIZE   (128)

Signature length for GRID License.

Typedef Documentation

◆ NV_LICENSABLE_FEATURES

◆ NV_LICENSABLE_FEATURES_V1

Licensable features.

◆ NV_LICENSABLE_FEATURES_V2

◆ NV_LICENSABLE_FEATURES_V3

◆ NV_LICENSABLE_FEATURES_V4

◆ NV_LICENSE_EXPIRY_DETAILS

Used in NV_LICENSE_FEATURE_DETAILS

The 'status' variable holds any one of the following license expiry status codes : 0 - Expiry information not available 1 - Invalid expiry or error fetching expiry 2 - Valid expiry 3 - Expiry not applicable 4 - Permanent expiry

◆ NV_LICENSE_FEATURE_DETAILS

◆ NV_LICENSE_FEATURE_DETAILS_V1

Used in NV_LICENSABLE_FEATURES.

◆ NV_LICENSE_FEATURE_DETAILS_V2

◆ NV_LICENSE_FEATURE_DETAILS_V3

◆ NV_LICENSE_FEATURE_DETAILS_V4

◆ NV_LICENSE_FEATURE_TYPE

Used in NV_LICENSE_FEATURE_DETAILS.

◆ NvAPI_LicenseString

typedef char NvAPI_LicenseString[NV_LICENSE_INFO_MAX_LENGTH]

License string.

Enumeration Type Documentation

◆ _NV_LICENSE_FEATURE_TYPE

Used in NV_LICENSE_FEATURE_DETAILS.

Enumerator
NV_LICENSE_FEATURE_UNKNOWN 
NV_LICENSE_FEATURE_VGPU 
NV_LICENSE_FEATURE_NVIDIA_RTX 
NV_LICENSE_FEATURE_QUADRO 

DEPRECATED name - do not use.

NV_LICENSE_FEATURE_GAMING 

Function Documentation

◆ NvAPI_GPU_GetLicensableFeatures()

NVAPI_INTERFACE NvAPI_GPU_GetLicensableFeatures ( __in NvPhysicalGpuHandle  hPhysicalGpu,
__inout NV_LICENSABLE_FEATURES pLicensableFeatures 
)

DESCRIPTION: This function call identifies whether licenses are supported on this system and if they are supported, returns the details of the features that can be licensed.

SUPPORTED OS: Windows 7 and higher

TCC_SUPPORTED

Parameters
[in]hPhysicalGpuGPU selection
[in,out]pLicensableFeaturesLicensable features information.
Returns
This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.


Copyright (c) 2007-2022 NVIDIA Corporation. All rights reserved.

NVIDIA