Edit

Share via


Get-RDVirtualDesktopCollectionJobStatus

Gets the status of a job on a virtual desktop collection.

Syntax

Default (Default)

Get-RDVirtualDesktopCollectionJobStatus
    [-CollectionName] <String>
    [-ConnectionBroker <String>]
    [<CommonParameters>]

Description

The Get-RDVirtualDesktopCollectionJobStatus gets status information for the most recent job that the server ran on a virtual desktop collection. You can use the Stop-RDVirtualDesktopCollectionJob cmdlet to forcibly end a job that is in an unknown state.

Examples

Example 1: Get the status of a job on a virtual desktop collection

PS C:\> Get-RDVirtualDesktopCollectionJobStatus -ConnectionBroker "rdcb.contoso.com" -CollectionName "Virtual Desktop Collection"

This command gets the status information of the job that the server most recently ran on the virtual desktop collection named Virtual Desktop Pool.

Parameters

-CollectionName

Specifies the name of a virtual desktop collection.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-ConnectionBroker

Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a remote desktop deployment. If you do not specify a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Outputs

Object