Win32_TSGatewayConnection class

Article
12/11/2020

Represents a connection from a client computer to a Remote Desktop Gateway (RD Gateway) server.

Syntax

[dynamic, provider("AAGProvider"), AMENDMENT]
class Win32_TSGatewayConnection
{
  string ConnectionKey;
  uint64 TunnelId;
  uint32 ChannelId;
  string UserName;
  string FullUserName;
  string ClientAddress;
  string ConnectedTime;
  string IdleTime;
  string ConnectedResource;
  string ProtocolName;
  uint32 ConnectedPort;
  uint64 NumberOfKilobytesSent;
  uint64 NumberOfKilobytesReceived;
  string ConnectionDuration;
  uint32 TransportProtocol;
};

Members

The Win32_TSGatewayConnection class has these types of members:

Methods
Properties

Methods

The Win32_TSGatewayConnection class has these methods.

Method	Description
CheckStatus	Checks the status of an RD Gateway server connection, and whether the target server is configured for load balancing.
Disconnect	Ends the connection.
DisconnectProtocol	Ends all connections that use the specified protocol.
DisconnectUser	Ends all connections of the specified user.

Properties

The Win32_TSGatewayConnection class has these properties.

ChannelId

Data type: uint32
Access type: Read-only

Channel identifier.

ClientAddress

Data type: string
Access type: Read-only

Client IP address.

ConnectedPort

Data type: uint32
Access type: Read-only

Port on the connected resource to which the user is connected.

ConnectedResource

Data type: string
Access type: Read-only

Name of the computer (or cluster) to which the client is connected.

ConnectedTime

Data type: string
Access type: Read-only

The time stamp for when the connection was established. This time is reset when the connection is reset, even if it is automatically reconnected.

ConnectionDuration

Data type: string
Access type: Read-only

The time that has elapsed since the connected time.

ConnectionKey

Data type: string
Access type: Read-only
Qualifiers: key

Connection identifier in the format "tunnelId:channelID".

FullUserName

Data type: string
Access type: Read-only

Full user name of the connected user.

IdleTime

Data type: string
Access type: Read-only

Idle time of the connection.

NumberOfKilobytesReceived

Data type: uint64
Access type: Read-only

Number of kilobytes received from the client computer by the RD Gateway server.

NumberOfKilobytesSent

Data type: uint64
Access type: Read-only

Number of kilobytes sent to the client computer by the RD Gateway server.

ProtocolName

Data type: string
Access type: Read-only

Protocol that is used to connect to the RD Gateway server.

"RDP"

The protocol for the RD Gateway server.

TransportProtocol

Data type: uint32
Access type: Read-only

Specifies the transport type for the connection. This must be one of the following values.

RPC over HTTP transport.

HTTP transport.

UDP transport.

TunnelId

Data type: uint64
Access type: Read-only

Tunnel identifier.

UserName

Data type: string
Access type: Read-only

User name connected to the RD Gateway server.

Remarks

You must be a member of the Administrators group to use this class.

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

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows Server 2008
Namespace	Root\CIMv2\TerminalServices
MOF	TSGateway.mof
DLL	AagWmi.dll

Share via