Win32_TSSessionDirectory, ROOT\CIMV2\TerminalServices

Description

The Win32_TSSessionDirectory class defines the configuration for Win32_TSSessionDirectorySetting. This includes capabilities such as Session Directory store, Cluster Name and Server IP address.

Win32_TSSessionDirectory methods

Win32_TSSessionDirectory has 12 methods (12 Local)

Name	Origin	Return
CreateUserDiskTemplate	Win32_TSSessionDirectory	uint32 {'out':True}
DisableUserVhd	Win32_TSSessionDirectory	uint32 {'out':True}
EnableUserVhd	Win32_TSSessionDirectory	uint32 {'out':True}
GetCurrentRedirectableAddresses	Win32_TSSessionDirectory	uint32 {'out':True}
GetRedirectableAddresses	Win32_TSSessionDirectory	uint32 {'out':True}
PingSessionDirectory	Win32_TSSessionDirectory	uint32 {'out':True}
SetCurrentRedirectableAddresses	Win32_TSSessionDirectory	uint32 {'out':True}
SetLoadBalancingState	Win32_TSSessionDirectory	uint32 {'out':True}
SetServerWeight	Win32_TSSessionDirectory	uint32 {'out':True}
SetSessionDirectoryActive	Win32_TSSessionDirectory	uint32 {'out':True}
SetSessionDirectoryExposeServerIP	Win32_TSSessionDirectory	uint32 {'out':True}
SetSessionDirectoryProperty	Win32_TSSessionDirectory	uint32 {'out':True}

Win32_TSSessionDirectory properties

Win32_TSSessionDirectory has 18 properties (13 Local, 5 Derived)

Name	Origin	CIMType
Caption	CIM_ManagedSystemElement	8 [string]
Description	CIM_ManagedSystemElement	8 [string]
GetLoadBalancingState	Win32_TSSessionDirectory	19 [uint32]
GetServerWeight	Win32_TSSessionDirectory	19 [uint32]
GetTSRedirectorMode	Win32_TSSessionDirectory	19 [uint32]
InstallDate	CIM_ManagedSystemElement	101 [datetime]
Name	CIM_ManagedSystemElement	8 [string]
PolicySourceLoadBalancing	Win32_TSSessionDirectory	19 [uint32]
PolicySourceSessionDirectoryActive	Win32_TSSessionDirectory	19 [uint32]
PolicySourceSessionDirectoryClusterName	Win32_TSSessionDirectory	19 [uint32]
PolicySourceSessionDirectoryExposeServerIP	Win32_TSSessionDirectory	19 [uint32]
PolicySourceSessionDirectoryLocation	Win32_TSSessionDirectory	19 [uint32]
key SessionDirectoryActive	Win32_TSSessionDirectory	19 [uint32]
SessionDirectoryClusterName	Win32_TSSessionDirectory	8 [string]
SessionDirectoryExposeServerIP	Win32_TSSessionDirectory	19 [uint32]
SessionDirectoryIPAddress	Win32_TSSessionDirectory	8 [string]
SessionDirectoryLocation	Win32_TSSessionDirectory	8 [string]
Status	CIM_ManagedSystemElement	8 [string]

Detailed description of Win32_TSSessionDirectory methods

Local methods (12) of Win32_TSSessionDirectory class

…

▲ CreateUserDiskTemplate method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
UserDisksStorageUrl	string	0	✓	-	{'in':True}
UserDiskMaxSizeInGB	uint32	1	✓	-	{'in':True}

Description

'Creates User Disk Template of specified max size and at the specified location. All User Disks created will have max sizes matching the Template's max size.'

Implemented

True

CreateUserDiskTemplate method is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ DisableUserVhd method
Return	uint32 {'out':True}
Description	'Disables the User VHD'
Implemented	True
DisableUserVhd method is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ EnableUserVhd method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
UvhdShareUrl	string	0	✓	-	{'in':True}
UvhdRoamingPolicyXml	string	1	✓	-	{'in':True}

Description

'Enables, and sets parameters for the User VHD'

Implemented

True

EnableUserVhd method is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ GetCurrentRedirectableAddresses method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
fTokenRedirection	uint32	0	-	✓	{'out':True}
IPAddresses	string	1	-	✓	{'out':True}

Description

'Obtains the currently configured list of either Token Redirectable addresses or DNS Eligible addresses.'

Implemented

True

GetCurrentRedirectableAddresses method is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ GetRedirectableAddresses method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
fTokenRedirection	uint32	0	✓	-	{'In':True}
IPAddresses	string	1	-	✓	{'out':True}
AdapterNames	string	2	-	✓	{'out':True}
NetConName	string	3	-	✓	{'out':True}

Description

'Obtains entire list of Token Redirectable addresses or DNS Eligible address.'

Implemented

True

GetRedirectableAddresses method is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ PingSessionDirectory method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
ServerName	string	0	✓	-	{'in':True}

Description

'Attempts to access a session directory server'

Implemented

True

PingSessionDirectory method is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ SetCurrentRedirectableAddresses method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
fTokenRedirection	uint32	0	✓	-	{'in':True}
IPAddresses	string	1	✓	-	{'in':True}

Description

'Writes out the configured list of either Token Redirectable addresses or DNS Eligible addresses.'

Implemented

True

SetCurrentRedirectableAddresses method is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ SetLoadBalancingState method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
StateValue	uint32	0	✓	-	{'in':True}

Description

'Sets the value to indicate whether the server will participate in Session Broker Load Balancing.0 = The server will not participate in Session Broker Load Balancing1 = The server will participate in TS Session Broker Load Balancing'

Implemented

True

SetLoadBalancingState method is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ SetServerWeight method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
ServerWeightValue	uint32	0	✓	-	{'in':True}

Description

'Sets the server weight value for Session Broker Load Balancing. Valid range is 1 to 10000.'

Implemented

True

SetServerWeight method is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ SetSessionDirectoryActive method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
SessionDirectoryActive	uint32	0	✓	-	{'In':True}

Description

'Enables or disables SessionDirectory according as whether Value is set to 0 or 1 respectively. The call returns 0 for success and an error if the policy was set to Group policy.'

Implemented

True

SetSessionDirectoryActive method is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ SetSessionDirectoryExposeServerIP method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
SessionDirectoryExposeServerIP	uint32	0	✓	-	{'In':True}

Description

'Allows or Denies retrieving IP address of SessionDirectory according as whether Value is set to 1 or 0 respectively. The call returns 0 for success and an error if the policy was set to Group policy.'

Implemented

True

SetSessionDirectoryExposeServerIP method is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ SetSessionDirectoryProperty method

Return

uint32 {'out':True}

Parameters

Name	CIMType	ID	IN	OUT	Qualifiers
PropertyName	string	0	✓	-	{'In':True}
Value	string	1	✓	-	{'In':True}

Description

'PropertyName is an enumeration of the properties: 0 = SessionDirectoryLocation and 1 = SessionDirectoryClusterNamewhich are flags that are either set to False or True according as whether Value is set to 0 or 1 respectively. The call returns 0 for success and an error if the policy was set to Group policy.'

Implemented

True

SetSessionDirectoryProperty method is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

Detailed description of Win32_TSSessionDirectory properties

Local properties (13) of Win32_TSSessionDirectory class

…

▲ GetLoadBalancingState property
CIMTYPE	'uint32'
Description	'GetLoadBalancingState indicates whether the server is configured to participate in Session Broker Load Balancing or not.'
read	True
GetLoadBalancingState property is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ GetServerWeight property
CIMTYPE	'uint32'
Description	'GetServerWeight returns the Server weight value used in Session Broker Load Balancing.'
read	True
GetServerWeight property is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ GetTSRedirectorMode property
CIMTYPE	'uint32'
Description	'GetTSRedirectorMode indicates whether the server is configured to be a Redirector or not.'
read	True
GetTSRedirectorMode property is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ PolicySourceLoadBalancing property
CIMTYPE	'uint32'
Description	'PolicySourceLoadBalancing indicates whether the property GetLoadBalancingStateis configured by Server (0) or Group Policy (1).'
read	True
PolicySourceLoadBalancing property is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ PolicySourceSessionDirectoryActive property
CIMTYPE	'uint32'
Description	'PolicySourceSessionActive indicates whether the property SessionDirectoryActive is configured by Server (0) or Group Policy (1).'
read	True
PolicySourceSessionDirectoryActive property is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ PolicySourceSessionDirectoryClusterName property
CIMTYPE	'uint32'
Description	'PolicySourceSessionDirectoryClusterName indicates whether the property SessionDirectoryClusterName is configured by Server (0) or Group Policy (1).'
read	True
PolicySourceSessionDirectoryClusterName property is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ PolicySourceSessionDirectoryExposeServerIP property
CIMTYPE	'uint32'
Description	'PolicySourceSessionDirectoryExposeServerIP indicates whether the property SessionDirectoryExposeServerIP is configured by Server (0) or Group Policy (1).'
read	True
PolicySourceSessionDirectoryExposeServerIP property is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ PolicySourceSessionDirectoryLocation property
CIMTYPE	'uint32'
Description	'PolicySourceSessionDirectoryLocation indicates whether the property SessionDirectoryLocation is configured by Server (0) or Group Policy (1).'
read	True
PolicySourceSessionDirectoryLocation property is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ SessionDirectoryActive property
CIMTYPE	'uint32'
Description	'Enables or Disables Session Directory.'
key	True
read	True
Values	['FALSE', 'TRUE']
SessionDirectoryActive property is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ SessionDirectoryClusterName property
CIMTYPE	'string'
Description	'Cluster to which this Terminal server belongs. Typically, it is a DNS entry which represents the Virtual IP address of computers.'
read	True
SessionDirectoryClusterName property is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ SessionDirectoryExposeServerIP property
CIMTYPE	'uint32'
Description	'Allows or Denies retrieving IP address of the Session Directory.'
read	True
Values	['FALSE', 'TRUE']
SessionDirectoryExposeServerIP property is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ SessionDirectoryIPAddress property
CIMTYPE	'string'
Description	'Specifies the IP Address of the LanAdapter that is used by the Session Directory.'
read	True
write	True
SessionDirectoryIPAddress property is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

…

▲ SessionDirectoryLocation property
CIMTYPE	'string'
Description	'Network path location to the Session Directory.'
read	True
SessionDirectoryLocation property is in 1 class (Win32_TSSessionDirectory) of ROOT\CIMV2\TerminalServices and in 2 namespaces

Derived properties (5) of Win32_TSSessionDirectory class

…

▲ Caption property
CIMTYPE	'string'
MaxLen	64
read	True
Caption property is in 43 classes of ROOT\CIMV2\TerminalServices and in 37 namespaces

…

▲ Description property
CIMTYPE	'string'
read	True
Description property is in 48 classes of ROOT\CIMV2\TerminalServices and in 142 namespaces

…

▲ InstallDate property
CIMTYPE	'datetime'
Mappingstrings	['MIF.DMTF\|ComponentID\|001.5']
read	True
InstallDate property is in 43 classes of ROOT\CIMV2\TerminalServices and in 23 namespaces

…

▲ Name property
CIMTYPE	'string'
read	True
Name property is in 53 classes of ROOT\CIMV2\TerminalServices and in 142 namespaces

…

▲ Status property
CIMTYPE	'string'
MaxLen	10
read	True
ValueMap	['OK', 'Error', 'Degraded', 'Unknown', 'Pred Fail', 'Starting', 'Stopping', 'Service']
Status property is in 43 classes of ROOT\CIMV2\TerminalServices and in 42 namespaces

Win32_TSSessionDirectory Qualifiers

…

Name	Value	ToInstance	ToSubclass	Overridable	Amended	Local
ClassContext	'local\|hkey_local_machine\SYSTEM\CurrentControlSet\Control\TerminalServer'	✗	✗	✓	✗	✓
Description	'The Win32_TSSessionDirectory class defines the configuration for Win32_TSSessionDirectorySetting. This includes capabilities such as Session Directory store, Cluster Name and Server IP address.'	✗	✓	✓	✓	✓
dynamic	True	✓	✗	✓	✗	✓
LOCALE	1033	✗	✗	✓	✓	✓
provider	'Win32_WIN32_TSSESSIONDIRECTORY_Prov'	✗	✗	✓	✗	✓

Win32_TSSessionDirectory System properties

…

Name	Value	Origin	CIMType	Local	Array
__PATH	'\\.\ROOT\CIMV2\TerminalServices:Win32_TSSessionDirectory'	___SYSTEM	8	✗	✗
__NAMESPACE	'ROOT\CIMV2\TerminalServices'	___SYSTEM	8	✗	✗
__SERVER	'.'	___SYSTEM	8	✗	✗
__DERIVATION	['CIM_Setting', 'CIM_ManagedSystemElement']	___SYSTEM	8	✗	✓
__PROPERTY_COUNT	18	___SYSTEM	3	✗	✗
__RELPATH	'Win32_TSSessionDirectory'	___SYSTEM	8	✗	✗
__DYNASTY	'CIM_ManagedSystemElement'	___SYSTEM	8	✗	✗
__SUPERCLASS	'CIM_Setting'	___SYSTEM	8	✗	✗
__CLASS	'Win32_TSSessionDirectory'	___SYSTEM	8	✗	✗
__GENUS	1	___SYSTEM	3	✗	✗

Similar Classes to Win32_TSSessionDirectory

Number of classes:1

…

Class name	Childs	Properties	Methods	Class Instances	Child Instances	Abstract	Singleton
Win32_TSSessionDirectorySetting	0	7	0	-	-	-	-

WUtils.com

Includes&Samples

Win32_TSSessionDirectory, ROOT\CIMV2\TerminalServices

Description

Win32_TSSessionDirectory methods

Win32_TSSessionDirectory properties

Detailed description of Win32_TSSessionDirectory methods

Local methods (12) of Win32_TSSessionDirectory class

Detailed description of Win32_TSSessionDirectory properties

Local properties (13) of Win32_TSSessionDirectory class

Derived properties (5) of Win32_TSSessionDirectory class

Win32_TSSessionDirectory Qualifiers

Win32_TSSessionDirectory System properties

Similar Classes to Win32_TSSessionDirectory