Get-RASPubItemStatus
NAME
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.
PARAMETERS
Id (uint)
The app ID for which to retrieve the information (optional).
SessionType (SessionType)
The type of Remote Desktop Session.
Possible values: Desktop, PublishedApps, Application, VDI, VDIApp, PC, PCApp, Admin, Unknown, RemoteApps, DirectRDP, All
Session (uint)
RAS session ID.
SiteId (uint)
Site ID for which to retrieve the app status information (optional).
Source (RDSessionSource)
Remote Desktop Session source for which to retrieve the app status information.
Possible values: RDS, VDI, AVD, All
SessionHostId (string)
The Host ID of the server for which to retrieve the app status information (optional).
SessionHostName (string)
The name of the host to filter the app status info list (optional).
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
User (string)
User to filter the app status info list (optional).
IP (string)
The server IP Address to filter the app status info list (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-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.
RELATED LINKS
Last updated