Get-RDVirtualDesktopCollectionJobStatus
Get-RDVirtualDesktopCollectionJobStatus
Gets the status of a job on a virtual desktop collection.
Syntax
Parameter Set: Default
Get-RDVirtualDesktopCollectionJobStatus [-CollectionName] <String> [-ConnectionBroker <String> ] [ <CommonParameters>]
Detailed 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.
Parameters
-CollectionName<String>
Specifies the name of a virtual desktop collection.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ConnectionBroker<String>
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- System.Object
Examples
Example 1: Get the status of a job on a 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".
PS C:\> Get-RDVirtualDesktopCollectionJobStatus -ConnectionBroker "rdcb.contoso.com" -CollectionName "Virtual Desktop Collection"