Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

Win32_TSLicenseServer class

Provides methods and properties to view and configure Remote Desktop Licensing (RD Licensing) on a Remote Desktop license server.

Syntax

[singleton, dynamic, provider("Win32_WIN32_TERMSERVLICENSING_Prov")]class Win32_TSLicenseServer
{
  string FirstName;
  string LastName;
  string Company;
  string CountryRegion;
  string eMail;
  string OrgUnit;
  string Address;
  string City;
  string State;
  string PostalCode;
  uint32 ServerRole;
  string DatabasePath;
  string ProductId;
  string Version;
  string VersionNumber;
};

Members

The Win32_TSLicenseServer class has these types of members:

Methods

The Win32_TSLicenseServer class has these methods.

MethodDescription
ActivateServer

Activates the Remote Desktop license server by using a Remote Desktop license server ID that is obtained over the phone or the Internet.

ActivateServerAutomatic

Activates the Remote Desktop license server automatically over the Internet. The FirstName, LastName, Company, and CountryRegion properties must not be empty when this method is called, or the method will fail.

AddLStoTSLSGroup

Adds the Remote Desktop license server to the Remote Desktop License Servers group on a domain controller in the same domain as the license server.

ChangeRole

Changes the discovery scope of the Remote Desktop license server.

CreateTSCGroup

This method is not supported.

Windows Server 2008 R2 and Windows Server 2008:  Creates the Terminal Server Computers local group on the Remote Desktop license server.

DeactivateServer

Deactivates the Remote Desktop license server by using a confirmation code that is received over the phone.

DeactivateServerAutomatic

Deactivates the Remote Desktop license server over the Internet. The FirstName and LastName properties must not be empty when this method is called, or the method will fail.

GetActivationStatus

Retrieves the current activation status.

GetLicenseServerId

Retrieves a Remote Desktop license server ID if the server is currently activated.

IsLSinTSLSGroup

Retrieves whether the Remote Desktop license server is a member of the Remote Desktop License Servers group on a domain controller in a given domain.

IsLSonDC

Retrieves whether RD Licensing is installed on a domain controller.

IsLSPreventUpgradeGPEnabled

Retrieves whether the "prevent license upgrade" group policy setting is enabled on the Remote Desktop license server.

IsLSPublished

Retrieves whether the Remote Desktop license server is published in Active Directory Domain Services (AD DS).

IsLSRegisteredToSCP

Retrieves whether the Remote Desktop license server is registered as a service connection point in Active Directory Domain Services.

IsLSSecGrpGPEnabled

Retrieves whether the "license server security group" group policy setting is enabled on the Remote Desktop license server.

IsSecureAccessAllowed

Retrieves whether an RD Session Host server is allowed to request Remote Desktop Services client access licenses (RDS CALs) from the Remote Desktop license server.

IsTSCGroupPresent

This method is not supported.

Windows Server 2008 R2 and Windows Server 2008:  Retrieves whether the Terminal Server Computers local group exists on the Remote Desktop license server.

IsTSinTSCGroup

Retrieves whether an RD Session Host server is a member of the Terminal Server Computers local group on the Remote Desktop license server.

PublishLS

Publishes the Remote Desktop license server in AD DS.

ReactivateServer

Reactivates the Remote Desktop license server by using a new Remote Desktop license server ID that is obtained over the phone or the Internet.

ReactivateServerAutomatic

Reactivates the Remote Desktop license server over the Internet. The FirstName and LastName properties must not be empty when this method is called, or the method will fail.

RegisterLSToSCP

Registers the Remote Desktop license server as a service connection point in Active Directory Domain Services.

RemoveLSfromTSLSGroup

Removes the Remote Desktop license server from the Remote Desktop License Servers group on a domain controller in the same domain as the license server.

RemoveTSCGroup

This method is not supported.

Windows Server 2008 R2 and Windows Server 2008:  Removes the Terminal Server Computers local group from the Remote Desktop license server.

UnpublishLS

Unpublishes a Remote Desktop license server from AD DS.

UnRegisterLSFromSCP

Removes the Remote Desktop license server as a service connection point in Active Directory Domain Services.

 

Properties

The Win32_TSLicenseServer class has these properties.

Address
Data type: string
Access type: Read/write

Street address of the contact for RD Licensing. This property is used when the ActivateServerAutomatic method is called. (This property is optional when using the ActivateServerAutomatic method.)

City
Data type: string
Access type: Read/write

City of the contact for RD Licensing. This property is used when the ActivateServerAutomatic method is called. (This property is optional when using the ActivateServerAutomatic method.)

Company
Data type: string
Access type: Read/write

Company of the contact for RD Licensing. This property is used (and required) when the ActivateServerAutomatic method is called.

CountryRegion
Data type: string
Access type: Read/write

Country/region of the contact for RD Licensing. This property is used (and required) when the ActivateServerAutomatic method is called.

DatabasePath
Data type: string
Access type: Read-only

Path of the RDS Licensing database.

eMail
Data type: string
Access type: Read/write

Email address of the contact for RD Licensing. This property is used when the ActivateServerAutomatic, ReactivateServerAutomatic, or DeactivateServerAutomatic methods are called. (This property is optional for these method calls.)

FirstName
Data type: string
Access type: Read/write

First name of the contact for RD Licensing. This property is used (and required) when the ActivateServerAutomatic, ReactivateServerAutomatic, or DeactivateServerAutomatic methods are called.

LastName
Data type: string
Access type: Read/write

Last name of the contact for RD Licensing. This property is used (and required) when the ActivateServerAutomatic, ReactivateServerAutomatic, or DeactivateServerAutomatic methods are called.

OrgUnit
Data type: string
Access type: Read/write

Organizational unit of the contact for RD Licensing. This property is used when the ActivateServerAutomatic is called. (This property is optional when using the ActivateServerAutomatic method.)

PostalCode
Data type: string
Access type: Read/write

Postal code of the contact for RD Licensing. This property is used when the ActivateServerAutomatic method is called. (This property is optional when using the ActivateServerAutomatic method.)

ProductId
Data type: string
Access type: Read-only

Product ID of the Remote Desktop license server.

ServerRole
Data type: uint32
Access type: Read-only

Describes the licensing scope for the Remote Desktop license server within the organization.

ValueMeaning
0

RD Session Host servers in the same workgroup can discover the license server.

1

RD Session Host servers in the same domain can discover the license server.

2

RD Session Host servers from multiple domains in the same forest can discover the license server.

 

State
Data type: string
Access type: Read/write

State of the contact for RD Licensing. This property is used when the ActivateServerAutomatic method is called. (This property is optional when using the ActivateServerAutomatic method.)

Version
Data type: string
Access type: Read-only

Version of the Remote Desktop license server.

VersionNumber
Data type: string
Access type: Read-only

Version number of the Remote Desktop license server.

Remarks

This class is a singleton class and can have only one instance. All of the methods contained within this class are static.

You must be a member of the Administrators group to use this class. If the caller is not a member of the Administrators group, the properties returned will be empty.

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

Minimum supported client

None supported

Minimum supported server

Windows Server 2008

Namespace

\root\CIMV2

MOF

Tlswmiprov.mof

See also

Win32_TSIssuedLicense
Win32_TSLicenseKeyPack
Win32_TSLicenseReport
Win32_TSLicenseReportEntry

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.