Get-RASRDSession
Retrieves information about one or multiple RD Sessions.
Get-RASRDSession -ServerId <uint> -Source {RDS | VDI | AVD | All} [-GroupId <uint>] [-HostName <string>] [-IP <string>] [-SiteId <uint>] [-State {Active | Connected | ConnectQuery | Shadow | Disconnected | Idle | Listen | Reset | Down | Init | All}] [-ThemeId <uint>] [-User <string>] [<CommonParameters>]
Get-RASRDSession -Server <string> -Source {RDS | VDI | AVD | All} [-GroupId <uint>] [-HostName <string>] [-IP <string>] [-SiteId <uint>] [-State {Active | Connected | ConnectQuery | Shadow | Disconnected | Idle | Listen | Reset | Down | Init | All}] [-ThemeId <uint>] [-User <string>] [<CommonParameters>]
Get-RASRDSession [-GroupId <uint>] [-HostName <string>] [-IP <string>] [-SiteId <uint>] [-Source {RDS | VDI | AVD | All}] [-State {Active | Connected | ConnectQuery | Shadow | Disconnected | Idle | Listen | Reset | Down | Init | All}] [-ThemeId <uint>] [-User <string>] [<CommonParameters>]
Retrieves the information about one or multiple RD Sessions, from different sources such as RDS, VDI, and AVD.
-SiteId <uint> Site ID from which to retrieve the Remote Desktop Session information (optional).
-Source <RDSessionSource> Source from which to retrieve the Remote Desktop Session information.
Possible values: RDS, VDI, AVD, All
-ServerId <uint> The Host ID of the server for which to retrieve the information (optional).
-Server <string> The name of the server to filter the Remote Desktop Session information (optional).
-HostName <string> The name of the host to filter the AVD/VDI Remote Desktop Session information (optional).
-State <SessionState> State to filter the Remote Desktop Session information (optional).
Possible values: Active, Connected, ConnectQuery, Shadow, Disconnected, Idle, Listen, Reset, Down, Init, All
-User <string> User to filter the Remote Desktop Session information (optional).
-IP <string> IP Address to filter the Remote Desktop Session information (optional).
-ThemeId <uint> The Theme ID for which to retrieve the information (optional).
-GroupId <uint> The RDS Group ID for which to retrieve the information (optional).
<CommonParameters>
-none-
---------- EXAMPLE 1 ----------
Get-RASRDSession
Retrieves a list of RD Sessions. ---------- EXAMPLE 2 ----------
Get-RASRDSession -Source RDS
Retrieves a list of RDS Sessions. ---------- EXAMPLE 3 ----------
Get-RASRDSession -Source RDS -Server "MyServer"
Retrieves a list of RDS Sessions pertaining to the specified server. ---------- EXAMPLE 4 ----------
Get-RASRDSession -Source VDI -SiteId 1
Retrieves a list of VDI Sessions for SiteId 1. ---------- EXAMPLE 5 ----------
Get-RASRDSession -Source AVD -ServerId 1
Retrieves the AVD Session for ServerId 1. ---------- EXAMPLE 6 ----------
Get-RASRDSession -User "Administrator" -IP "1.1.1.1" -State Idle
Retrieves the Sessions with specified Username, IP and State.