Get-RASProviderStatus
NAME
Get-RASProviderStatus
SYNOPSIS
Retrieves the Provider status information.
SYNTAX
Get-RASProviderStatus [-Id] <uint> [-StatusLevel {Level1 | Level2 | Level3}] [<CommonParameters>]
Get-RASProviderStatus [-InputObject] <Provider> [-StatusLevel {Level1 | Level2 | Level3}] [<CommonParameters>]
Get-RASProviderStatus [[-Server] <string>] [[-SiteId] <uint>] [-StatusLevel {Level1 | Level2 | Level3}] [<CommonParameters>]
DESCRIPTION
Retrieves the Provider status information and optionally desktop VM and application info.
PARAMETERS
-Server <string> The name of the Provider server for which to retrieve the information.
This must be the actual server name used in the RAS farm.
Required? false
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SiteId <uint> Site ID from which to retrieve the specified Provider server information.
If the parameter is omitted, the site ID of the Licensing Server will be used.
Required? false
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Id <uint> The ID of the Provider server. To obtain the ID, use the Get-RASProvider cmdlet.
Required? true
Position? 0
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-InputObject <Provider> An object of type Provider representing a Provider server for which to retrieve the information.
To obtain the object, use the Get-RASProvider cmdlet.
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-StatusLevel <StatusLevel> Specifies the level of detail that should be returned.
Acceptable values: Level1 (Provider status information only), Level2 (Provider status and Desktop VM info), Level3 (Provider status, Desktop VMs, Applications).
Possible values: Level1, Level2, Level3
Required? false
Position? named
Default value Level1
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
OUTPUTS
EXAMPLES
---------- EXAMPLE 1 ----------
Get-RASProviderStatus -Id 15
Retrieves the Provider status information for the Provider server with ID 15. ---------- EXAMPLE 2 ----------
Get-RASProviderStatus -Server MyProvider -StatusLevel Level2
Retrieves the Provider status and the desktop VM information for the server named "MyProvider". ---------- EXAMPLE 3 ----------
Get-RASProviderStatus -InputObject $Provider -StatusLevel Level3
Retrieves the Provider status, desktop VM, and application information for the server represented by the $Provider object. ---------- EXAMPLE 4 ----------
Get-RASProvider -Id 15 | Get-RASProviderStatus -StatusLevel Level1
Retrieves the Provider status information for the server represented by the object obtained from the pipeline output.
RELATED LINKS
Last updated