Get-RASRDSession

NAME

Get-RASRDSession

SYNOPSIS

Retrieves information about one or multiple RD Sessions.

SYNTAX

Get-RASRDSession - ServerId <uint> - Source {RDS | VDI | AVD | All} [- GroupId <uint> ] [- 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> ] [- 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> ] [- 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 > ]

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

        Required?                    false
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

- Source < RDSessionSource >
Source from which to retrieve the Remote Desktop Session information.

Possible values: RDS, VDI, AVD, All 

        Required?                    true
        Position?                    named
        Default value                All
        Accept pipeline input?       false
        Accept wildcard characters?  false

- ServerId <uint>
The Host ID of the server for which to retrieve the information (optional). 

        Required?                    true
        Position?                    named
        Default value                4294967295
        Accept pipeline input?       false
        Accept wildcard characters?  false

- Server <string>
The name of the server to filter the Remote Desktop Session information (optional). 

        Required?                    true
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- State < SessionState >
State to filter the Remote Desktop Session information (optional).

Possible values: Active, Connected, ConnectQuery, Shadow, Disconnected, Idle, Listen, Reset, Down, Init, All 

        Required?                    false
        Position?                    named
        Default value                All
        Accept pipeline input?       false
        Accept wildcard characters?  false

- User <string>
User to filter the Remote Desktop Session information (optional). 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- IP <string>
IP Address to filter the Remote Desktop Session information (optional). 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- ThemeId <uint>
The Theme ID for which to retrieve the information (optional). 

        Required?                    false
        Position?                    named
        Default value                4294967295
        Accept pipeline input?       false
        Accept wildcard characters?  false

- GroupId <uint>
The RDS Group ID for which to retrieve the information (optional). 

        Required?                    false
        Position?                    named
        Default value                4294967295
        Accept pipeline input?       false
        Accept wildcard characters?  false

< CommonParameters > 
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

RDSession[]

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.

RELATED LINKS