InstallOpenLicenseKeyPack method of the Win32_TSLicenseKeyPack class

Article
12/11/2020

Installs an Open License Remote Desktop Services license key pack.

Syntax

uint32 InstallOpenLicenseKeyPack(
  [in]  string sLicenseNumber,
  [in]  string sAuthorizationNumber,
  [in]  uint32 ProductVersion,
  [in]  uint32 ProductType,
  [in]  uint32 LicenseCount,
  [out] uint32 KeyPackId
);

Parameters

sLicenseNumber [in]

8-character numeric string that is provided with the license key pack. The sLicenseNumber parameter cannot contain hyphens.

sAuthorizationNumber [in]

15-character alphanumeric string that is provided with the license key. The sAuthorizationNumber parameter cannot contain hyphens.

ProductVersion [in]

Product version.

Value	Description
0	Not supported
1	Not supported
2	Windows Server 2008/Windows Server 2008 R2
4	Windows Server 2012/Windows Server 2012 R2
5	Windows Server 2016
6	Windows Server 2019

ProductType [in]

Product type.

Value	Description
0	The Remote Desktop Services license key pack product type is per device. Therefore, each device that connects to the RD Session Host server must have a license.
1	The Remote Desktop Services license key pack product type is per user. Therefore, each user who connects to the RD Session Host server must have a license.
2	This product type is not valid.

LicenseCount [in]

The number of licenses to install.

KeyPackId [out]

Receives the key pack identifier.

Return value

If the method succeeds, it returns zero. If the method is unsuccessful, it returns a nonzero value. For a list of error codes, see Remote Desktop Services WMI Provider Error Codes.

Remarks

You must be a member of the Administrators group to call this method.

Managed Object Format (MOF) files contain the definitions for Windows Management Instrumentation (WMI) classes. MOF files are not installed as part of the Microsoft Windows Software Development Kit (SDK). They are installed on the server when you add the associated role by using the Server Manager. For more information about MOF files, see Managed Object Format (MOF).

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008
Namespace	Root\CIMv2
MOF	TlsWmiProv.mof
DLL	TlsWmiProv.dll