< Back
Add-RDVirtualDesktopToCollection
Post
NAME Add-RDVirtualDesktopToCollection
SYNOPSIS
Adds virtual desktops to a virtual desktop collection.
SYNTAX
Add-RDVirtualDesktopToCollection [-CollectionName] <String> [-ConnectionBroker <String>] [-VirtualDesktopPasswordAge <Int32>]
-VirtualDesktopAllocation <Hashtable> [<CommonParameters>]
Add-RDVirtualDesktopToCollection [-CollectionName] <String> [-ConnectionBroker <String>] [-VirtualDesktopTemplateHostServer <String>]
[-VirtualDesktopTemplateName <String>] -VirtualDesktopAllocation <Hashtable> [<CommonParameters>]
Add-RDVirtualDesktopToCollection [-CollectionName] <String> [-ConnectionBroker <String>] -VirtualDesktopName <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.
PARAMETERS
-CollectionName <String>
Specifies the name of a virtual desktop collection.
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.
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.
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.
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.
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.
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Object
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 31
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294205
Remove-RDVirtualDesktopFromCollection
Get-RDVirtualDesktopCollection
SYNOPSIS
Adds virtual desktops to a virtual desktop collection.
SYNTAX
Add-RDVirtualDesktopToCollection [-CollectionName] <String> [-ConnectionBroker <String>] [-VirtualDesktopPasswordAge <Int32>]
-VirtualDesktopAllocation <Hashtable> [<CommonParameters>]
Add-RDVirtualDesktopToCollection [-CollectionName] <String> [-ConnectionBroker <String>] [-VirtualDesktopTemplateHostServer <String>]
[-VirtualDesktopTemplateName <String>] -VirtualDesktopAllocation <Hashtable> [<CommonParameters>]
Add-RDVirtualDesktopToCollection [-CollectionName] <String> [-ConnectionBroker <String>] -VirtualDesktopName <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.
PARAMETERS
-CollectionName <String>
Specifies the name of a virtual desktop collection.
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.
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.
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.
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.
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.
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.
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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Object
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 31
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294205
Remove-RDVirtualDesktopFromCollection
Get-RDVirtualDesktopCollection