For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get-RASPubItemStatus

SYNOPSIS

Retrieves the status of one or multiple published resources session.

SYNTAX

Get-RASPubItemStatus [-GroupId <uint>] [-Id <uint>] [-IP <string>] [-Session <uint>]
 [-SessionType {Desktop | PublishedApps | Application | VDI | VDIApp | PC | PCApp | Admin | Unknown | RemoteApps | DirectRDP | All}]
 [-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.

EXAMPLES

Example 1

Retrieves the status of all the available published resources.

Example 2

Retrieves the status of a published resource specified by ID.

Example 3

Retrieves the published resources status for the available RDS Sessions.

Example 4

Retrieves the published resources status for the RDS Sessions pertaining to the specified server.

Example 5

Retrieves the published resources status for the VDI Sessions and SiteId 1.

Example 6

Retrieves the published resources status for VDI Session and SessionHostId 1.

PARAMETERS

-Id

The app ID for which to retrieve the information (optional).

-SessionType

The type of Remote Desktop Session.

Possible values: Desktop, PublishedApps, Application, VDI, VDIApp, PC, PCApp, Admin, Unknown, RemoteApps, DirectRDP, All

Type reference: SessionType

-Session

RAS session ID.

-SiteId

Site ID for which to retrieve the app status information (optional).

-Source

Remote Desktop Session source for which to retrieve the app status information.

Possible values: RDS, VDI, AVD, All

Type reference: RDSessionSource

-SessionHostId

The Host ID of the server for which to retrieve the app status information (optional).

-SessionHostName

The name of the host to filter the app status info list (optional).

-State

The session state to filter the app status info list (optional).

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

Type reference: SessionState

-User

User to filter the app status info list (optional).

-IP

The server IP Address to filter the app status info list (optional).

-ThemeId

The Theme ID for which to retrieve the information (optional).

-GroupId

The RDS Group ID for which to retrieve the information (optional).

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

PubItemStatus

Last updated