.png)
Get-RDVirtualDesktopCollectionJobStatus
Updated: September 14, 2012
Applies To: Windows Server 2012
Get-RDVirtualDesktopCollectionJobStatus
Syntax
Parameter Set: __AllParameterSets Get-RDVirtualDesktopCollectionJobStatus [-CollectionName] <String> [-ConnectionBroker <String> ] [ <CommonParameters>]
Detailed Description
The Get-RDVirtualDesktopCollectionJobStatus gets status information for the job run most recently on the specified 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 the virtual desktop collection. This parameter is required.
|
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 this remote desktop deployment. If not supplied, defaults to the fully qualified domain name (FQDN) of the local host.
|
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.
Outputs
The output type is the type of the objects that the cmdlet emits.
- System.Object
Examples
Example 1: Retrieve Status Information for the Job run most Recently on the Virtual Desktop Collection
This command retrieves the status information of the job most recently run on the virtual desktop collection named Virtual Desktop Pool, as specified by the CollectionName parameter associated with the Remote Desktop Connection Broker server named rdcb.contoso.com, as specified by the ConnectionBroker parameter.
PS C:\> Get-RDVirtualDesktopCollectionJobStatus -ConnectionBroker rdcb.contoso.com -CollectionName "Virtual Desktop Collection"
Example 2: Duplicate Example
This command retrieves the status information of the job most recently run on the virtual desktop collection named Virtual Desktop Pool, as specified by the CollectionName parameter associated with the Remote Desktop Connection Broker server named rdcb.contoso.com, as specified by the ConnectionBroker parameter.
PS C:\> Get-RDVirtualDesktopCollectionJobStatus -ConnectionBroker rdcb.contoso.com -CollectionName "Virtual Desktop Collection"
