All pages
Powered by GitBook
1 of 1

Loading...

Get-RASRDSession

NAME

Get-RASRDSession

SYNOPSIS

Retrieves information about one or multiple RD Sessions.

SYNTAX

Get-RASRDSession - <uint> - {RDS | VDI | AVD | All} [- <uint>] [- <string>] [- <uint>] [- {Active | Connected | ConnectQuery | Shadow | Disconnected | Idle | Listen | Reset | Down | Init | All}] [- <uint>] [- <string>] [<>] Get-RASRDSession - <string> - {RDS | VDI | AVD | All} [- <uint>] [- <string>] [- <uint>] [- {Active | Connected | ConnectQuery | Shadow | Disconnected | Idle | Listen | Reset | Down | Init | All}] [- <uint>] [- <string>] [<>] Get-RASRDSession [- <uint>] [- <string>] [- <uint>] [- {RDS | VDI | AVD | All}] [- {Active | Connected | ConnectQuery | Shadow | Disconnected | Idle | Listen | Reset | Down | Init | All}] [- <uint>] [- <string>] [

DESCRIPTION

Retrieves the information about one or multiple RD Sessions, from different sources such as RDS and VDI.

PARAMETERS

-SiteId <uint> Site ID from which to retrieve the Remote Desktop Session information (optional).

-Source <> 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).

-State <> 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>

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- 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 VDI -ServerId 1 Retrieves the VDI 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.

<
>]
ServerId
Source
GroupId
IP
SiteId
State
ThemeId
User
CommonParameters
Server
Source
GroupId
IP
SiteId
State
ThemeId
User
CommonParameters
GroupId
IP
SiteId
Source
State
ThemeId
User
RDSessionSource
SessionState
RDSession[]
CommonParameters
        Required?                    false
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    true
        Position?                    named
        Default value                All
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    true
        Position?                    named
        Default value                4294967295
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                All
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                4294967295
        Accept pipeline input?       false
        Accept wildcard characters?  false
        Required?                    false
        Position?                    named
        Default value                4294967295
        Accept pipeline input?       false
        Accept wildcard characters?  false
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters .