Win32_TSRemoteDesktop class

Describes a remote desktop connection that is available through Remote Desktop Web Access (RD Web Access).

Syntax

class Win32_TSRemoteDesktop : CIM_LogicalElement
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  string   Status;
  string   Alias;
  string   SecurityDescriptor;
  string   IconPath;
  sint32   IconIndex;
  uint8    IconContents[];
  boolean  ShowInPortal;
  string   RDPFileContents;
  boolean  IsVmFarm;
  string   VmFarmSettings;
};

Members

The Win32_TSRemoteDesktop class has these types of members:

Properties

The Win32_TSRemoteDesktop class has these properties.

Alias
Data type: string
Access type: Read/write
Qualifiers: Key

The alias of the remote desktop connection.

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.

Description
Data type: string
Access type: Read-only

Description of the object.

This property is inherited from CIM_ManagedSystemElement.

IconContents
Data type: uint8 array
Access type: Read-only

The byte contents of the icon that corresponds to the remote desktop connection.

IconIndex
Data type: sint32
Access type: Read/write

The index or ID of the icon for the remote desktop connection.

IconPath
Data type: string
Access type: Read/write

Path of the icon for the remote desktop connection.

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.

IsVmFarm
Data type: boolean
Access type: Read/write

Indicates if this remote desktop connection is part of a virtual machine farm.

Name
Data type: string
Access type: Read-only

The name of the object.

This property is inherited from CIM_ManagedSystemElement.

RDPFileContents
Data type: string
Access type: Read/write

Contents of the RDP file that correspond to the remote desktop connection.

SecurityDescriptor
Data type: string
Access type: Read/write

A security descriptor that controls access to the remote desktop connection, in SDDL format. An empty string implies allow all access. This security descriptor does not support DENY ACEs, or ACEs that refer to nondomain users or groups.

ShowInPortal
Data type: boolean
Access type: Read/write

Indicates whether the remote desktop connection should be shown in RD Web Access.

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")

VmFarmSettings
Data type: string
Access type: Read/write

Virtual machine farm settings for the remote desktop connection.

Remarks

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

To connect to the \root\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. 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\TerminalServices

MOF

Tsallow.mof

DLL

TsPubWmi.dll

 

 

Show: