Get-RASPubItemStatus

NAME

Get-RASPubItemStatus

SYNOPSIS

Retrieves the status of one or multiple published resources session.

SYNTAX

Get-RASPubItemStatus -SessionType {Desktop | PublishedApps | Application | VDI | VDIApp | PC | PCApp | Admin | Unknown | RemoteApps | DirectRDP | All} [-GroupId <uint>] [-Id <uint>] [-IP <string>] [-Session <uint>] [-SiteId <uint>] [-State {Active | Connected | ConnectQuery | Shadow | Disconnected | Idle | Listen | Reset | Down | Init | All}] [-ThemeId <uint>] [-User <string>] [<CommonParameters>] Get-RASPubItemStatus -SessionHostId <string> -Source {RDS | VDI | AVD | All} [-GroupId <uint>] [-IP <string>] [-Session <uint>] [-SiteId <uint>] [-State {Active | Connected | ConnectQuery | Shadow | Disconnected | Idle | Listen | Reset | Down | Init | All}] [-ThemeId <uint>] [-User <string>] [<CommonParameters>] Get-RASPubItemStatus -SessionHostName <string> -Source {RDS | VDI | AVD | All} [-GroupId <uint>] [-IP <string>] [-Session <uint>] [-SiteId <uint>] [-State {Active | Connected | ConnectQuery | Shadow | Disconnected | Idle | Listen | Reset | Down | Init | All}] [-ThemeId <uint>] [-User <string>] [<CommonParameters>] Get-RASPubItemStatus [-GroupId <uint>] [-IP <string>] [-Session <uint>] [-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 status of one or multiple published resources session.

PARAMETERS

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

        Required?                    false

        Position?                    named

        Default value                4294967295

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SessionType <SessionType> The type of Remote Desktop Session. Possible values: Desktop, PublishedApps, Application, VDI, VDIApp, PC, PCApp, Admin, Unknown, RemoteApps, DirectRDP, All

        Required?                    true

        Position?                    named

        Default value                All

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Session <uint> RAS session ID.

        Required?                    false

        Position?                    named

        Default value                4294967295

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID for which to retrieve the app status information (optional).

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Source <RDSessionSource> Remote Desktop Session source for which to retrieve the app status information. Possible values: RDS, VDI, AVD, All

        Required?                    true

        Position?                    named

        Default value                All

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SessionHostId <string> The Host ID of the server for which to retrieve the app status information (optional).

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SessionHostName <string> The name of the host to filter the app status info list (optional).

        Required?                    true

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-State <SessionState> The session state to filter the app status info list (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 app status info list (optional).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-IP <string> The server IP Address to filter the app status info list (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 . 

INPUTS

-none-

OUTPUTS

PubItemStatus[]

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASPubItemStatus Retrieves the status of all the available published resources. ---------- EXAMPLE 2 ---------- Get-RASPubItemStatus -Id 11 Retrieves the status of a published resource specified by ID. ---------- EXAMPLE 3 ---------- Get-RASPubItemStatus -Source RDS Retrieves the published resources status for the available RDS Sessions. ---------- EXAMPLE 4 ---------- Get-RASPubItemStatus -Source RDS -SessionHost "MyServer" Retrieves the published resources status for the RDS Sessions pertaining to the specified server. ---------- EXAMPLE 5 ---------- Get-RASPubItemStatus -Source VDI -SiteId 1 Retrieves the published resources status for the VDI Sessions and SiteId 1. ---------- EXAMPLE 6 ---------- Get-RASPubItemStatus -Source VDI -SessionHostId 1 Retrieves the published resources status for VDI Session and SessionHostId 1.