Win32_RDSHServer class

Manages a Remote Desktop Session Host (RDSH) server.

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

Syntax

[dynamic, provider("Win32_RDManagement_Prov"), AMENDMENT]
class Win32_RDSHServer
{
  string Name;
  string ConnectionBroker;
  string CollectionAlias;
  uint32 ServerState;
};

Members

The Win32_RDSHServer class has these types of members:

Methods

The Win32_RDSHServer class has these methods.

MethodDescription
GetInt32Property

Retrieves an integer property value of a Win32_RDSHServer object.

GetPendingStartServerList

Retrieves a list of server waiting to start.

GetStringProperty

Retrieves a string property value of a Win32_RDSHServer object.

SetInt32Property

Updates an integer property value of a Win32_RDSHServer object.

SetStringProperty

Updates a string property value of a Win32_RDSHServer object.

TestAndSetState

Compares the current state to the specified comparand; if the two match, the state is set to a new value. Regardless of the match, the current state is also returned.

 

Properties

The Win32_RDSHServer class has these properties.

CollectionAlias
Data type: string
Access type: Read/write
Qualifiers: optional

Gets and sets the alias to the RDSH collection to which the RDSH server is assigned.

ConnectionBroker
Data type: string
Access type: Read/write

Gets and sets the name of the Remote Desktop Connection Broker (RDCB) that manages user access to the RDSH server.

Name
Data type: string
Access type: Read/write
Qualifiers: key

Gets and sets the name of the RDSH server.

ServerState
Data type: uint32
Access type: Read-only
Qualifiers: optional

Describes the state of the server. Any value other than TARGET_RUNNING (3) is reserved and should be consider an invalid state.

The possible values are.

TARGET_UNKNOWN (1)

TARGET_RUNNING (3)

TARGET_INVALID (8)

TARGET_STARTING (9)

TARGET_STOPPING (10)

Windows Server 2012 R2 and Windows Server 2012:  This property is unavailable prior to Windows Server 2016.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012

Namespace

Root\cimv2\rdms

MOF

RDManagement.mof

DLL

RDMS.dll

See also

Remote Desktop Management Services Provider

 

 

Show: