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

Get-RASRDSHostStatus

SYNOPSIS

Retrieves the RD Session Host server status information.

SYNTAX

Get-RASRDSHostStatus [[-Id] <uint>] [-StatusLevel {Level1 | Level2 | Level3}] [<CommonParameters>]
Get-RASRDSHostStatus [[-InputObject] <RDSHost>] [-StatusLevel {Level1 | Level2 | Level3}]
 [<CommonParameters>]
Get-RASRDSHostStatus [[-Server] <string>] [[-SiteId] <uint>]
 [-StatusLevel {Level1 | Level2 | Level3}] [<CommonParameters>]

DESCRIPTION

Retrieves the RD Session Host status information and optionally session and application information.

EXAMPLES

Example 1

Get-RASRDSHostStatus -Id 15

Retrieves the RD Session Host status information for the server with ID 15.

Example 2

Retrieves the RD Session Host status and session information for the server named "MyRDSH".

Example 3

Retrieves the RD Session Host status, session, and application information for the server represented by the $RDSH object.

Example 4

Retrieves the RD Session Host status information for the server represented by the object obtained from the pipeline output.

PARAMETERS

-Server

The name of the RD Session Host server for which to retrieve the information.

This must be the actual server name used in the RAS farm.

-SiteId

Site ID from which to retrieve the specified RD Session Host server information.

If the parameter is omitted, the site ID of the Licensing Server will be used.

-Id

The ID of the RD Session Host server. To obtain the ID, use the Get-RASRDSHost cmdlet.

-InputObject

An object of type RDS representing the RD Session Host server.

To obtain the object, use the Get-RASRDSHost cmdlet.

Type reference: RDSHost

-StatusLevel

Specifies the level of detail that should be retrieved.

Acceptable values: Level1 (status information only), Level2 (status and session information), Level3 (status, session, and application info).

Possible values: Level1, Level2, Level3

Type reference: StatusLevel

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

RDSHost

OUTPUTS

RDSHostSysInfo RDSHostSysInfoSession RDSHostSysInfoSessionApp

Last updated