Add-RDVirtualDesktopToCollection
Adds virtual desktops to a virtual desktop collection.
Syntax
Add-RDVirtualDesktopToCollection
[-CollectionName] <String>
-VirtualDesktopAllocation <Hashtable>
[-VirtualDesktopPasswordAge <Int32>]
[-ConnectionBroker <String>]
[<CommonParameters>] Add-RDVirtualDesktopToCollection
[-CollectionName] <String>
-VirtualDesktopName <String[]>
[-ConnectionBroker <String>]
[<CommonParameters>] Add-RDVirtualDesktopToCollection
[-CollectionName] <String>
-VirtualDesktopAllocation <Hashtable>
[-VirtualDesktopTemplateName <String>]
[-VirtualDesktopTemplateHostServer <String>]
[-ConnectionBroker <String>]
[<CommonParameters>] Description
The Add-RDVirtualDesktopToCollection cmdlet adds one or more virtual desktops to a virtual desktop collection. You can use this cmdlet to add virtual desktops to personal virtual desktop collections, managed pooled virtual desktop collections, and unmanaged pooled virtual desktop collections.
Examples
Example 1: Add virtual desktops to a virtual desktop collection on an RD Connection Broker
PS C:\> Add-RDVirtualDesktopToCollection -ConnectionBroker "rdcb.contoso.com" -CollectionName "Virtual Desktop Pool" -VirtualDesktopAllocation @{"RDS-WKS-A27.vdi.contoso.com"=1;"RDS-WKS-A28.vdi.contoso.com"=2} -VirtualDesktopPasswordAge 31This command adds virtual desktops to the managed pooled virtual desktop collection named Virtual Desktop Pool that is associated with the RD Connection Broker server named rdcb.contoso.com. The VirtualDesktopAllocation parameter specifies that one virtual desktop is created on the host servers named RDS-WKS-A27.vdi.contoso.com and two virtual desktops are created on the host server named RDS-WKS-A28.vdi.contoso.com. The command specifies that after 31 days the server enforces a password update for the virtual desktops.
Parameters
-CollectionName
Specifies the name of a virtual desktop collection.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VirtualDesktopAllocation
Specifies a collection of values (key/value pair) that allocate virtual desktops to Remote Desktop Virtualization (RD Virtualization Host) servers.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VirtualDesktopName
Specifies an array of names of a virtual desktops.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VirtualDesktopPasswordAge
Specifies the number of days after which the server enforces a password update.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VirtualDesktopTemplateHostServer
Specifies the fully qualified domain name (FQDN) of the server where the virtual desktop template associated with the collection is stored.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VirtualDesktopTemplateName
Specifies a descriptive name for the virtual desktop template.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |