Add-RDVirtualDesktopToCollection
Add-RDVirtualDesktopToCollection
Adds virtual desktops to a virtual desktop collection.
Syntax
Parameter Set: PooledMgd
Add-RDVirtualDesktopToCollection [-CollectionName] <String> -VirtualDesktopAllocation <Hashtable> [-ConnectionBroker <String> ] [-VirtualDesktopPasswordAge <Int32> ] [ <CommonParameters>]
Parameter Set: PersonalMgd
Add-RDVirtualDesktopToCollection [-CollectionName] <String> -VirtualDesktopAllocation <Hashtable> [-ConnectionBroker <String> ] [-VirtualDesktopTemplateHostServer <String> ] [-VirtualDesktopTemplateName <String> ] [ <CommonParameters>]
Parameter Set: UnManaged
Add-RDVirtualDesktopToCollection [-CollectionName] <String> -VirtualDesktopName <String[]> [-ConnectionBroker <String> ] [ <CommonParameters>]
Detailed Description
The Add-RDVirtualDesktop 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.
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 |
-VirtualDesktopAllocation<Hashtable>
Specifies a collection of values (key=value pair) that allocate virtual desktops to Remote Desktop Virtualization (RD Virtualization Host) servers.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VirtualDesktopName<String[]>
Specifies an array of names of a virtual desktops.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VirtualDesktopPasswordAge<Int32>
Specifies the number of days after which the server enforces a password update.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VirtualDesktopTemplateHostServer<String>
Specifies the fully qualified domain name (FQDN) of the server where the virtual desktop template associated with the collection is stored.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VirtualDesktopTemplateName<String>
Specifies a descriptive name for the virtual desktop template.
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: Add virtual desktops to a virtual desktop collection on an RD Connection Broker
This 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.
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 31