Win32_TSSessionSetting class

The Win32_TSSessionSetting WMI class defines configuration settings for the Win32_Terminal class such as time-limits, and disconnection and reconnection actions.

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

Syntax

[dynamic, provider("Win32_WIN32_TSSESSIONSETTING_Prov"), ClassContext("local|hkey_local_machine\\SYSTEM\\CurrentControlSet\\Control\\TerminalServer\\WinStations"), AMENDMENT]
class Win32_TSSessionSetting : Win32_TerminalSetting
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  string   Status;
  string   TerminalName;
  uint32   ActiveSessionLimit;
  uint32   BrokenConnectionAction;
  uint32   BrokenConnectionPolicy;
  uint32   DisconnectedSessionLimit;
  uint32   IdleSessionLimit;
  uint32   PolicySourceActiveSessionLimit;
  uint32   PolicySourceBrokenConnectionAction;
  uint32   PolicySourceDisconnectedSessionLimit;
  uint32   PolicySourceIdleSessionLimit;
  uint32   PolicySourceReconnectionPolicy;
  uint32   ReconnectionPolicy;
  uint32   TimeLimitPolicy;
  uint32   EnableTimeoutWarning;
};

Members

The Win32_TSSessionSetting class has these types of members:

Methods

The Win32_TSSessionSetting class has these methods.

MethodDescription
BrokenConnection

Sets the broken connection properties included in this class.

TimeLimit

Sets the time-limit properties included in this class.

 

Properties

The Win32_TSSessionSetting class has these properties.

ActiveSessionLimit
Data type: uint32
Access type: Read-only

The maximum amount of time, in milliseconds, allocated to an active session. A value of 0 specifies an infinite amount of time.

BrokenConnectionAction
Data type: uint32
Access type: Read-only

The action the server takes on the session when a connection has been broken due to network loss or exceeded time-limits.

Disconnect (0)

The user is disconnected from the session.

Terminate (1)

The session is permanently deleted from the server.

BrokenConnectionPolicy
Data type: uint32
Access type: Read/write

The policy the server uses to determine when to break a connection because of network loss or exceeded time-limits.

Server-Override (1)

The user's disconnection policy settings are overridden by the server.

Per User (0)

The user's disconnection policy settings are in effect.

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.

DisconnectedSessionLimit
Data type: uint32
Access type: Read-only

The time interval, in milliseconds, after which a disconnected session is terminated. A value of 0 specifies an infinite amount of time.

EnableTimeoutWarning
Data type: uint32
Access type: Read/write

Enables the timeout warning.

Windows 7, Windows Server 2008 R2, Windows Vista and Windows Server 2008:  This property is not available.

IdleSessionLimit
Data type: uint32
Access type: Read-only

The time interval, in milliseconds, after which an idle session is terminated. A value of 0 specifies an infinite amount of time.

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.

PolicySourceActiveSessionLimit
Data type: uint32
Access type: Read-only

Indicates whether the ActiveSessionLimit property is configured by the server, group policy, or by default.

0

Server

1

Group policy

2

Default

PolicySourceBrokenConnectionAction
Data type: uint32
Access type: Read-only

Indicates whether the BrokenConnectionAction property is configured by the server, group policy, or by default.

0

Server

1

Group policy

2

Default

PolicySourceDisconnectedSessionLimit
Data type: uint32
Access type: Read-only

Indicates whether the DisconnectedSessionLimit property is configured by the server, group policy, or by default.

0

Server

1

Group policy

2

Default

PolicySourceIdleSessionLimit
Data type: uint32
Access type: Read-only

Indicates whether the IdleSessionLimit property is configured by the server, group policy, or by default.

0

Server

1

Group policy

2

Default

PolicySourceReconnectionPolicy
Data type: uint32
Access type: Read-only

Indicates whether the ReconnectPolicy property is configured by the server, group policy, or by default.

0

Server

1

Group policy

2

Default

ReconnectionPolicy
Data type: uint32
Access type: Read/write

Specifies whether a user must use the previous client to reconnect to a disconnected session.

Any Client (0)

Any client will be used to reconnect.

Previous Client (1)

The previous client used in a connection will be used to reconnect.

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

TerminalName
Data type: string
Access type: Read-only

The name of the terminal.

This property is inherited from Win32_TerminalSetting.

TimeLimitPolicy
Data type: uint32
Access type: Read/write

The policy the server uses to determine time-limits for user sessions.

Per User (0)

The user's time-limits policy settings are in effect.

Server Override (1)

The user's time-limits policy settings are overridden by the server.

Remarks

Be aware that Winstations associated with the console session cannot access the methods and properties of this class. If an attempt is made to do so by specifying "Console" as the value of the TerminalName property, methods of this object will return WBEM_E_NOT_SUPPORTED. This error code will also be returned if a window station attempts to call methods of this object for the purpose of adding or modifying the security properties of the LocalSystem, LocalService, or NetworkService accounts.

To connect to the "root\CIMV2\TerminalServices" namespace, the authentication level must include packet privacy. For C/C++ calls, this would be an authentication level of RPC_C_AUTHN_LEVEL_PKT_PRIVACY. For Visual Basic and scripting calls, this would be 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

Windows Vista

Minimum supported server

Windows Server 2008

Namespace

Root\CIMv2\TerminalServices

MOF

TSCfgWmi.mof

DLL

TSCfgWmi.dll

See also

Win32_TerminalSetting
CIM_Setting

 

 

Show: