Edit

Share via

Get-RDVirtualDesktopCollectionConfiguration

Module:
RemoteDesktop Module

Gets configuration details of a virtual desktop collection.

Syntax

General (Default) 

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

VirtualDesktopConfiguration 

Get-RDVirtualDesktopCollectionConfiguration
    [-CollectionName] <String>
    [-VirtualDesktopConfiguration]
    [-ConnectionBroker <String>]
    [<CommonParameters>]

UserGroups 

Get-RDVirtualDesktopCollectionConfiguration
    [-CollectionName] <String>
    [-UserGroups]
    [-ConnectionBroker <String>]
    [<CommonParameters>]

Client 

Get-RDVirtualDesktopCollectionConfiguration
    [-CollectionName] <String>
    [-Client]
    [-ConnectionBroker <String>]
    [<CommonParameters>]

UserProfileDisks 

Get-RDVirtualDesktopCollectionConfiguration
    [-CollectionName] <String>
    [-UserProfileDisks]
    [-ConnectionBroker <String>]
    [<CommonParameters>]

Description

The Get-RDVirtualDesktopCollectionConfiguration gets configuration details of a virtual desktop collection.

Examples

Example 1: Get configuration settings for virtual desktops in a collection

PS C:\> Get-RDVirtualDesktopCollectionConfiguration -ConnectionBroker "rdcb.contoso.com" -CollectionName "Virtual Desktop Pool" -VirtualDesktopConfiguration

This command gets the configuration settings for the virtual desktops in the collection named Virtual Desktop Pool that is associated with the RD Connection Broker server named rdcb.contoso.com.

Example 2: Get user profile disk settings for a virtual desktop collection

PS C:\> Get-RDVirtualDesktopCollectionConfiguration -ConnectionBroker "rdcb.contoso.com" -CollectionName "Virtual Desktop Pool" -UserProfileDisks

This command gets the user profile disk settings for the virtual desktop collection named Virtual Desktop Pool that is associated with the RD Connection Broker server named rdcb.contoso.com.

Parameters

-Client

Indicates that this cmdlet gets Remote Desktop Protocol (RDP) settings for virtual desktops in the collection.

Parameter properties

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

Parameter sets

Client
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

-UserGroups

Indicates that the cmdlet gets a list of domain groups and users that are authorized to connect to the collection.

Parameter properties

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

Parameter sets

UserGroups
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserProfileDisks

Indicates that the cmdlet gets a list of user profile disk settings for the collection.

Parameter properties

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

Parameter sets

UserProfileDisks
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VirtualDesktopConfiguration

Indicates that the cmdlet gets configuration settings for virtual desktops in the collection.

Parameter properties

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

Parameter sets

VirtualDesktopConfiguration
Position:Named
Mandatory:True
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