Win32_TSDeploymentSettings class

Article
12/11/2020

Defines the default settings that the RemoteApp Manager uses when creating Remote Desktop Protocol (RDP) files. These settings do not affect any published applications or desktops.

Syntax

class Win32_TSDeploymentSettings : CIM_LogicalElement
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  string   Status;
  sint32   Port;
  string   FarmName;
  sint32   GatewayUsage;
  string   GatewayName;
  sint32   GatewayAuthMode;
  boolean  GatewayUseCachedCreds;
  boolean  RequireServerAuth;
  sint32   ColorBitDepth;
  boolean  AllowFontSmoothing;
  boolean  UseMultimon;
  sint32   RedirectionOptions;
  boolean  HasCertificate;
  uint8    CertificateHash[];
  string   CertificateIssuedTo;
  string   CertificateIssuedBy;
  string   CertificateExpiresOn;
  string   CustomRDPSettings;
  string   DeploymentRDPSettings;
};

Members

The Win32_TSDeploymentSettings class has these types of members:

Properties

Properties

The Win32_TSDeploymentSettings class has these properties.

AllowFontSmoothing

Data type: boolean
Access type: Read/write

Indicates whether to allow font smoothing.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Short description (one-line string) of the object.

This property is inherited from CIM_ManagedSystemElement.

CertificateExpiresOn

Data type: string
Access type: Read/write

The date that the certificate expires on. This value is stored as a 64-bit FILETIME format.

CertificateHash

Data type: uint8 array
Access type: Read/write

The thumbprint of the certificate that is used to sign RDP files.

CertificateIssuedBy

Data type: string
Access type: Read/write

Specifies who the certificate is issued by.

CertificateIssuedTo

Data type: string
Access type: Read/write

Specifies who the certificate is issued to.

ColorBitDepth

Data type: sint32
Access type: Read/write

The color bit depth of the display. Possible values are 4, 8, 15, 16, 24, and 32.

CustomRDPSettings

Data type: string
Access type: Read/write

The contents of the RDP file that correspond to the Custom RDP Settings in RemoteApp Manager.

DeploymentRDPSettings

Data type: string
Access type: Read/write

The contents of the RDP file that correspond to the deployment settings in RemoteApp Manager. If this value is set, the RDP deployment settings supersede the default settings in this class. For example, if you set the GatewayAuthMode property in this class, and set the DeploymentRDPSettings property, the GatewayAuthMode property from this class will be ignored and the GatewayAuthMode value from the DeploymentRDPSettings will be used.

Description

Data type: string
Access type: Read-only

Description of the object.

This property is inherited from CIM_ManagedSystemElement.

FarmName

Data type: string
Access type: Read/write

The name of the RD Session Host server, or the fully qualified domain name (FQDN) of the RD Session Host server farm.

GatewayAuthMode

Data type: sint32
Access type: Read/write

The RD Gateway authentication method. The following values are possible.

0

Password

1

Smart card

4

Allow user to select during connection.

GatewayName

Data type: string
Access type: Read/write

The name of the RD Gateway server to use.

GatewayUsage

Data type: sint32
Access type: Read/write

Indicates whether to use an RD Gateway server to connect to the target RD Session Host server across a firewall. The following values are possible.

Do not use an RD Gateway server.

Use an RD Gateway server. Bypass the RD Gateway server for local addresses.

Use an RD Gateway server.

Automatically detect RD Gateway server settings.

GatewayUseCachedCreds

Data type: boolean
Access type: Read/write

When possible, use the same user credentials for the RD Gateway server and the RD Session Host server.

HasCertificate

Data type: boolean
Access type: Read/write

Indicates whether to use a certificate to sign the RDP files.

InstallDate

Data type: datetime
Access type: Read-only
Qualifiers: Mappingstrings ("MIF.DMTF|ComponentID|001.5")

The date the object was installed. A lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

Name

Data type: string
Access type: Read-only

The name of the object.

This property is inherited from CIM_ManagedSystemElement.

Port

Data type: sint32
Access type: Read/write

The RDP port to use.

RedirectionOptions

Data type: sint32
Access type: Read/write

Specifies the device and resource redirection options for RemoteApp connections. Flags for RedirectionOptions can be combined. The following values are possible.

No device or resource redirection.

Redirect disk drives.

Redirect printers.

Redirect the Clipboard.

Redirect supported Plug and Play devices.

Redirect smart cards.

Redirect audio.

Redirect serial ports.

RequireServerAuth

Data type: boolean
Access type: Read/write

Indicates whether to require server authentication.

Status

Data type: string
Access type: Read-only
Qualifiers: MaxLen (10)

Current status of the object. Various operational and nonoperational statuses can be defined. Operational statuses include: "OK", "Degraded", and "Pred Fail" (an element, such as a SMART-enabled hard disk drive, may be functioning properly but predicting a failure in the near future). Nonoperational statuses include: "Error", "Starting", "Stopping", and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither "OK" nor in one of the other states.

This property is inherited from CIM_ManagedSystemElement.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

UseMultimon

Data type: boolean
Access type: Read/write

Indicates if multiple monitors are enabled for the desktop.

Remarks

You must be a member of the Administrators group to set properties by using this class.

If RequireServerAuth is set to TRUE, consider the following:

If the RemoteApp program is for intranet use, and all client computers are running either Windows Server 2008 or Windows Vista, you do not have to configure the RD Session Host server to use an SSL certificate. In this case, Network Level Authentication is used.
You must specify the FQDN of the server or farm for the value of the FarmName property.

To connect to the "CIMV2\TerminalServices" namespace, the authentication level must include packet privacy. For C/C++ calls, this is an authentication level of RPC_C_AUTHN_LEVEL_PKT_PRIVACY, which can be set by using the CoSetProxyBlanket COM function. For Visual Basic and scripting calls, this is an authentication level of WbemAuthenticationLevelPktPrivacy or "pktPrivacy", with a value of 6. The following Visual Basic Scripting Edition (VBScript) example shows how to connect to a remote computer with packet privacy.

strComputer = "RemoteServer1" 
Set objServices = GetObject( _
    "winmgmts:{authenticationLevel=pktPrivacy}!Root/CIMv2/TerminalServices")

Managed Object Format (MOF) files contain the definitions for Windows Management Instrumentation (WMI) classes. They are installed on the computer when you add the associated role. 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	Tsallow.mof
DLL	TsPubWmi.dll

Share via

Win32_TSDeploymentSettings class

Syntax

Members

Properties

Remarks

Requirements

Feedback

Additional resources