Win32_TSGatewayServerSettings class
Provides methods and properties to view and configure Remote Desktop Gateway (RD Gateway) server settings. An administrator can use this class to configure a set of protocols, the set of events that will be written to the event log, and the maximum number of connections through RD Gateway.
Syntax
[dynamic, provider("AAGProvider"), AMENDMENT]
class Win32_TSGatewayServerSettings
{
uint32 MaxConnections;
boolean UnlimitedConnections;
uint32 MaximumAllowedConnectionsBySku;
string SkuName;
uint32 MaxProtocols;
uint32 MaxLogEvents;
string adminMessageText;
string adminMessageStartTime;
string adminMessageEndTime;
string consentMessageText;
boolean OnlyConsentCapableClients;
boolean CentralCAPEnabled;
boolean RequestSOH;
string AuthenticationPluginName;
string AuthenticationPluginCLSID;
string AuthenticationPluginDescription;
string AuthorizationPluginName;
string AuthorizationPluginCLSID;
string AuthorizationPluginDescription;
uint32 SslBridging;
boolean IsConfigured;
uint8 CertHash[];
boolean EnforceChannelBinding;
};
Members
The Win32_TSGatewayServerSettings class has these types of members:
Methods
The Win32_TSGatewayServerSettings class has these methods.
| Method | Description |
|---|---|
| Configure | Configures the IIS and RPC settings required by the RD Gateway service. Windows Server 2008: This method is not available before Windows Server 2008 R2. |
| EnableCentralCAP | Enables or disables the CentralCAPEnabled property, which controls whether central Remote Desktop connection authorization policy (RD CAP) servers are used for controlling connection authorization policies for this server. |
| EnableLogEvent | Enables or disables logging of the specified event type. |
| EnableOnlyConsentCapableClients | Sets the OnlyConsentCapableClients property. Windows Server 2008: This method is not available before Windows Server 2008 R2. |
| EnableRequestSOH | This method is not supported starting with Windows Server 2016. Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2 and Windows Server 2008: Enables or disables requests for a Statement of Health (SoH). |
| EnableTransport | Enables or disables the specified transport. Windows Server 2008 R2 and Windows Server 2008: This method is not available before Windows Server 2012. |
| EnumAuthenticationPlugins | Enumerates all registered authentication plug-ins. Windows Server 2008: This method is not available. |
| EnumAuthorizationPlugins | Enumerates all registered authorization plug-ins. Windows Server 2008: This method is not available before Windows Server 2008 R2. |
| GetIPAndPort | Obtains the listening IP address and port number for the specified transport. Windows Server 2008 R2 and Windows Server 2008: This method is not available before Windows Server 2012. |
| GetLogEventName | Returns the log event name for the specified log event index. |
| GetProtocolName | Returns the protocol name for the specified protocol index. |
| IsLogEventEnabled | Indicates whether the specified event log type is enabled. |
| IsTransportEnabled | Determines whether the specified transport is enabled. Windows Server 2008 R2 and Windows Server 2008: This method is not available before Windows Server 2012. |
| QueryCertContext | Indicates whether the specified certificate is installed. |
| RecycleRpcApplicationPools | Recycles the RPC application pools in IIS. Windows Server 2008: This method is not available before Windows Server 2008 R2. |
| RefreshCertContext | Refreshes the certificate that is used by the RD Gateway server. |
| SetAuthenticationPlugin | Sets the current authentication plug-in for the RD Gateway server. Windows Server 2008: This method is not available before Windows Server 2008 R2. |
| SetAuthenticationPluginAndRecycleRpcApplicationPools | Sets the current authentication plug-in for the RD Gateway server and recycles the RPC application pools in IIS. Windows Server 2008: This method is not available before Windows Server 2008 R2. |
| SetAuthorizationPlugin | Sets the current authorization plug-in for the RD Gateway server. Windows Server 2008: This method is not available before Windows Server 2008 R2. |
| SetCertificate | Sets the certificate hash for HTTPS binding on port 443 in IIS. Windows Server 2008: This method is not available before Windows Server 2008 R2. |
| SetCertificateACL | Sets the certificate access control lists (ACLs) for this server. |
| SetDefaultPluginsAndRecycleRpcApplicationPools | Sets the current authentication and authorization plug-ins for the RD Gateway server and recycles the RPC application pools in IIS. Windows Server 2008: This method is not available before Windows Server 2008 R2. |
| SetEnforceChannelBinding | Sets the EnforceChannelBinding property. Windows Server 2008 R2 and Windows Server 2008: This method is not available before Windows Server 2012. |
| SetIPAndPort | Sets the listening IP address and port number for the specified transport. Windows Server 2008 R2 and Windows Server 2008: This method is not available before Windows Server 2012. |
| SetMaxConnections | Sets the maximum number of allowed connections through RD Gateway. This method changes the MaxConnections and UnlimitedConnections properties. |
| SetSslBridging | Sets the type of SSL bridging to be used by the RD Gateway server. Windows Server 2008: This method is not available before Windows Server 2008 R2. |
| TSGRemoveAdminMsg | Removes the administrative message for the gateway server. Windows Server 2008: This method is not available before Windows Server 2008 R2. |
| TSGRemoveConsentMsg | Removes the administrative message for the gateway server. Windows Server 2008: This method is not available before Windows Server 2008 R2. |
| TSGStoreAdminMsg | Updates the administrative message for the gateway server. Windows Server 2008: This method is not available before Windows Server 2008 R2. |
| TSGStoreConsentMsg | Updates the consent message for the gateway server. Windows Server 2008: This method is not available before Windows Server 2008 R2. |
Properties
The Win32_TSGatewayServerSettings class has these properties.
-
adminMessageEndTime
-
-
Data type: string
-
Access type: Read-only
The administrative message end time.
Windows Server 2008: This property is not available before Windows Server 2008 R2.
-
-
adminMessageStartTime
-
-
Data type: string
-
Access type: Read-only
The administrative message start time.
Windows Server 2008: This property is not available before Windows Server 2008 R2.
-
-
adminMessageText
-
-
Data type: string
-
Access type: Read-only
The administrative message text.
Windows Server 2008: This property is not available before Windows Server 2008 R2.
-
-
AuthenticationPluginCLSID
-
-
Data type: string
-
Access type: Read-only
The CLSID of the current authentication plug-in.
Windows Server 2008: This property is not available before Windows Server 2008 R2.
-
-
AuthenticationPluginDescription
-
-
Data type: string
-
Access type: Read-only
The description of the current authentication plug-in.
Windows Server 2008: This property is not available before Windows Server 2008 R2.
-
-
AuthenticationPluginName
-
-
Data type: string
-
Access type: Read-only
The name of the current authentication plug-in.
Windows Server 2008: This property is not available before Windows Server 2008 R2.
-
-
AuthorizationPluginCLSID
-
-
Data type: string
-
Access type: Read-only
The CLSID of the current authorization plug-in.
Windows Server 2008: This property is not available before Windows Server 2008 R2.
-
-
AuthorizationPluginDescription
-
-
Data type: string
-
Access type: Read-only
The description of the current authorization plug-in.
Windows Server 2008: This property is not available before Windows Server 2008 R2.
-
-
AuthorizationPluginName
-
-
Data type: string
-
Access type: Read-only
The name of the current authorization plug-in.
Windows Server 2008: This property is not available before Windows Server 2008 R2.
-
-
CentralCAPEnabled
-
-
Data type: boolean
-
Access type: Read-only
Specifies whether central RD CAP servers are used for controlling this server. This property can be changed by calling the EnableCentralCAP method.
-
-
CertHash
-
-
Data type: uint8 array
-
Access type: Read-only
Specifies the certificate hash for HTTPS binding on port 443 in IIS.
Windows Server 2008: This property is not available before Windows Server 2008 R2.
-
-
consentMessageText
-
-
Data type: string
-
Access type: Read-only
The consent message text.
Windows Server 2008: This property is not available before Windows Server 2008 R2.
-
-
EnforceChannelBinding
-
-
Data type: boolean
-
Access type: Read-only
Indicates if channel binding is enforced for the HTTP transport. This property value can be changed by using the SetEnforceChannelBinding method.
Windows Server 2008 R2 and Windows Server 2008: This property is not available before Windows Server 2012.
-
-
IsConfigured
-
-
Data type: boolean
-
Access type: Read-only
Specifies if IIS and RPC settings required by the RD Gateway service are configured.
Windows Server 2008: This property is not available before Windows Server 2008 R2.
-
-
MaxConnections
-
-
Data type: uint32
-
Access type: Read-only
-
Qualifiers: key
Returns the maximum number of connections that are allowed through RD Gateway. This property can be set by using the SetMaxConnections method.
-
-
MaximumAllowedConnectionsBySku
-
-
Data type: uint32
-
Access type: Read-only
Maximum number of connections that the stock-keeping unit (SKU) allows.
-
-
MaxLogEvents
-
-
Data type: uint32
-
Access type: Read-only
Returns the maximum number of log events.
-
-
MaxProtocols
-
-
Data type: uint32
-
Access type: Read-only
Number of protocols supported by RD Gateway.
-
-
OnlyConsentCapableClients
-
-
Data type: boolean
-
Access type: Read-only
Specifies if only clients capable of consent messages are allowed to connect to the RD Gateway.
Windows Server 2008: This property is not available before Windows Server 2008 R2.
-
-
nonzero
-
Only consent message capable clients can connect.
-
zero
-
Clients that are not consent message capable can also connect.
RequestSOH
-
Data type: boolean
-
Access type: Read-only
This property is not supported starting with Windows Server 2016.
**Windows Server 2012 R2, Windows Server 2012, Windows Server 2008 R2 and Windows Server 2008: **
Specifies whether the server must request a Statement of Health (SoH) from the client. This property can be changed by using the EnableRequestSOH method.
SkuName
-
Data type: string
-
Access type: Read-only
Name of the SKU.
SslBridging
-
Data type: uint32
-
Access type: Read-only
Specifies which type of SSL bridging to be used by the RD Gateway server. This can be one of the following values.
Windows Server 2008: This property is not available before Windows Server 2008 R2.
0
No SSL bridging.
1
HTTPS to HTTP bridging.
2
HTTPS to HTTPS bridging.
UnlimitedConnections
-
Data type: boolean
-
Access type: Read-only
Indicates whether an unlimited number of connections are allowed through RD Gateway. This property can be set by using the SetMaxConnections method.
Remarks
You must be a member of the Administrators group to use this class.
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\TerminalServices |
| MOF |
|
| DLL |
|
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for