.png)
Get-RDVirtualDesktopCollectionConfiguration
Updated: September 14, 2012
Applies To: Windows Server 2012
Get-RDVirtualDesktopCollectionConfiguration
Syntax
Parameter Set: __AllParameterSets Get-RDVirtualDesktopCollectionConfiguration [-CollectionName] <String> [-ConnectionBroker <String> ] [ <CommonParameters>] Parameter Set: Client Get-RDVirtualDesktopCollectionConfiguration -Client [ <CommonParameters>] Parameter Set: UserGroups Get-RDVirtualDesktopCollectionConfiguration -UserGroups [ <CommonParameters>] Parameter Set: UserProfileDisks Get-RDVirtualDesktopCollectionConfiguration -UserProfileDisks [ <CommonParameters>] Parameter Set: VirtualDesktopConfiguration Get-RDVirtualDesktopCollectionConfiguration -VirtualDesktopConfiguration [ <CommonParameters>]
Detailed Description
The Get-RDVirtualDesktopCollectionConfiguration gets configuration details for the specified virtual desktop collection.
Parameters
-Client
Gets the Remote Desktop Protocol (RDP) settings for virtual desktops in the collection. This parameter is required.
|
Aliases |
none |
|
Required? |
true |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-CollectionName<String>
Specifies the name of the 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 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 |
-UserGroups
Gets a list of domain groups and users that are authorized to connect to the collection.
|
Aliases |
none |
|
Required? |
true |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-UserProfileDisks
Gets user profile disk settings for the collection.
|
Aliases |
none |
|
Required? |
true |
|
Position? |
named |
|
Default Value |
none |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-VirtualDesktopConfiguration
Gets configuration details for virtual desktops in the collection.
|
Aliases |
none |
|
Required? |
true |
|
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 Configuration Details for a Virtual Desktop Collection
This command retrieves the configuration settings, of 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-RDVirtualDesktopCollectionConfiguration -ConnectionBroker rdcb.contoso.com -CollectionName "Virtual Desktop Pool"
Example 2: Retrieve User Profile Disk Details for a Virtual Desktop Collection
This command retrieves the user profile disk details, as specified by the UserProfileDisks parameter of 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-RDVirtualDesktopCollectionConfiguration -ConnectionBroker rdcb.contoso.com -CollectionName "Virtual Desktop Pool" -UserProfileDisks
