Win32_SessionBrokerServiceProperties class

Defines the query for a session broker service.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[dynamic, singleton, provider("Win32_WIN32_SESSIONBROKERSERVICEPROPERTIES_Prov"), AMENDMENT]
class Win32_SessionBrokerServiceProperties
{
  string SBNetworkName;
  string SBDbConnectionString;
  string SBDbSecondaryConnectionString;
};

Members

The Win32_SessionBrokerServiceProperties class has these types of members:

Methods

The Win32_SessionBrokerServiceProperties class has these methods.

MethodDescription
DeleteSBDbConnectionString

Deletes DB connection strings (primary and secondary) from the registry.

Windows Server 2012 R2, Windows Server 2012 and Windows Server 2008 R2:  This method is not available prior to Windows Server 2016

InstallBrokerDatabase

Installs RD Connection Broker DB on central SQL Server

IsDbReachable

Checks if DB is reachable

SetBrokerHAMode

Migrates data from local WID DB to the new SQL Server based DB. It also configures the broker server to use the central SQL Server

SetBrokerNonHAMode

Migrates data from central SQL Server to local DB. It also configures the broker server to use the local DB.

SetSBDbConnectionStrings

Saves DB connection strings (primary and secondary) in the registry.

Windows Server 2012 R2, Windows Server 2012 and Windows Server 2008 R2:  This method is not available prior to Windows Server 2016

 

Properties

The Win32_SessionBrokerServiceProperties class has these properties.

SBDbConnectionString
Data type: string
Access type: Read/write

Database connection string used by Session Broker service.

Windows Server 2008 R2:  This property is not available prior to Windows Server 2012

SBDbSecondaryConnectionString
Data type: string
Access type: Read/write

Optional. Secondary database connection string, used by Session Broker service to support password expiration.

Windows Server 2012 R2, Windows Server 2012 and Windows Server 2008 R2:  This property is not available prior to Windows Server 2016

SBNetworkName
Data type: string
Access type: Read-only

The network name used by the session broker service.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2008 R2

Namespace

Root\CIMv2\TerminalServices

MOF

TssdWmi.mof

DLL

TssdWmi.dll

 

 

Show: