Win32_TSSessionDirectory class

Defines the Remote Desktop Connection Broker (RD Connection Broker) configuration settings for the Win32_TSSessionDirectorySetting class.

Note  In Windows Server 2008 R2, the name of Terminal Services Session Broker (TS Session Broker) was changed to RD Connection Broker. These properties apply to all supported operating systems unless otherwise noted.
 

The following syntax is simplified from MOF code and includes all defined and inherited properties, in alphabetical order. For reference information about methods, see the table of methods later in this topic.

Syntax

[dynamic, provider("Win32_WIN32_TSSESSIONDIRECTORY_Prov"), ClassContext("local|hkey_local_machine\\SYSTEM\\CurrentControlSet\\Control\\TerminalServer"), AMENDMENT]
class Win32_TSSessionDirectory : CIM_Setting
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  string   Status;
  string   SessionDirectoryLocation;
  uint32   PolicySourceSessionDirectoryLocation;
  uint32   SessionDirectoryActive;
  uint32   PolicySourceSessionDirectoryActive;
  uint32   SessionDirectoryExposeServerIP;
  uint32   PolicySourceSessionDirectoryExposeServerIP;
  string   SessionDirectoryClusterName;
  uint32   PolicySourceLoadBalancing;
  uint32   GetLoadBalancingState;
  uint32   GetServerWeight;
  uint32   PolicySourceSessionDirectoryClusterName;
  string   SessionDirectoryIPAddress;
  uint32   GetTSRedirectorMode;
  uint32   PolicySourceTSRedirectorMode;
};

Members

The Win32_TSSessionDirectory class has these types of members:

Methods

The Win32_TSSessionDirectory class has these methods.

MethodDescription
CreateUserDiskTemplate

Creates a user disk template.

DisableUserVhd

Disables a user profile VHD.

EnableUserVhd

Enables a user profile VHD on an RDSH server.

GetCurrentRedirectableAddresses

Obtains the currently configured list of DNS eligible addresses, and the redirection type.

GetRedirectableAddresses

Obtains the entire list of DNS eligible addresses.

PingSessionDirectory

Checks whether the RD Connection Broker server is available.

SetCurrentRedirectableAddresses

Sets the configured list of DNS eligible addresses, and the redirection type.

SetLoadBalancingState

Sets the value to indicate if the server will participate in RD Connection Broker load balancing.

SetServerWeight

Sets the server weight value for RD Connection Broker load balancing.

SetSessionDirectoryActive

Disables and enables the RD Connection Broker.

SetSessionDirectoryExposeServerIP

Sets the SessionDirectoryExposeServerIP property.

SetSessionDirectoryProperty

Sets the SessionDirectoryLocation property or the SessionDirectoryClusterName property.

SetTSRedirectorMode

This method is not available.

 

Properties

The Win32_TSSessionDirectory class has these properties.

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.

GetLoadBalancingState
Data type: uint32
Access type: Read-only

Indicates if the server is configured to participate in RD Connection Broker load balancing.

0

The server is not configured to participate in RD Connection Broker load balancing.

1

The server is configured to participate in RD Connection Broker load balancing.

GetServerWeight
Data type: uint32
Access type: Read-only

Retrieves the server weight value that is used in RD Connection Broker load balancing.

GetTSRedirectorMode
Data type: uint32
Access type: Read-only

Indicates if the server is configured to act as a Remote Desktop Services redirector.

0

The server is configured to act as a Remote Desktop Services redirector.

1

The server is not configured to act as a Remote Desktop Services redirector.

Windows Server 2008:  This property is not available.

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.

PolicySourceLoadBalancing
Data type: uint32
Access type: Read-only

Indicates if the GetLoadBalancingState property is configured by the server or by group policy.

0 (0x0)

Server

1 (0x1)

Group policy

PolicySourceSessionDirectoryActive
Data type: uint32
Access type: Read-only

Indicates if the SessionDirectoryActive property is configured by the server or by group policy.

0 (0x0)

Server

1 (0x1)

Group policy

PolicySourceSessionDirectoryClusterName
Data type: uint32
Access type: Read-only

Indicates if the SessionDirectoryClusterName property is configured by the server or by group policy.

0 (0x0)

Server

1 (0x1)

Group policy

PolicySourceSessionDirectoryExposeServerIP
Data type: uint32
Access type: Read-only

Indicates if the SessionDirectoryExposeServerIP property is configured by the server or by group policy.

0 (0x0)

Server

1 (0x1)

Group policy

PolicySourceSessionDirectoryLocation
Data type: uint32
Access type: Read-only

Indicates if the SessionDirectoryLocation property is configured by the server or by group policy.

0 (0x0)

Server

1 (0x1)

Group policy

PolicySourceTSRedirectorMode
Data type: uint32
Access type: Read-only

This property is not available.

Windows Server 2008 R2:  Indicates if the GetTSRedirectorMode property is configured by the server or by group policy.

0 (0x0)

Server

1 (0x1)

Group policy

SessionDirectoryActive
Data type: uint32
Access type: Read-only
Qualifiers: key

Specifies if Remote Desktop Services participates in the RD Connection Broker.

FALSE (0)

Remote Desktop Services participation in the RD Connection Broker is disabled.

TRUE (1)

Remote Desktop Services participation in the RD Connection Broker is enabled.

SessionDirectoryClusterName
Data type: string
Access type: Read-only

The virtual IP address of the cluster to which the RD Session Host server belongs.

SessionDirectoryExposeServerIP
Data type: uint32
Access type: Read-only

Specifies if retrieval of the IP address of the RD Connection Broker is allowed.

FALSE (0)

Retrieval is denied.

TRUE (1)

Retrieval is allowed.

SessionDirectoryIPAddress
Data type: string
Access type: Read/write

The IP address of the LAN adapter used by the session directory.

SessionDirectoryLocation
Data type: string
Access type: Read-only

The network DNS name or IP address of the server where the RD Connection Broker service is running.

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

Remarks

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. For Visual Basic and scripting calls, this is an authentication level of WbemAuthenticationLevelPktPrivacy or "pktPrivacy", with a value of six.

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


In Windows Server 2008, the name of the Terminal Services Session Directory feature was changed to Terminal Services Session Broker.

In Windows Server 2008 R2, the name of the Terminal Services Session Broker feature was changed to Remote Desktop Connection Broker.

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

TSCfgWmi.mof

DLL

TSCfgWmi.dll

See also

CIM_Setting
Win32_TSSessionDirectorySetting

 

 

Show: