Edit

Share via

Add-RDVirtualDesktopToCollection

Module:
RemoteDesktop Module

Adds virtual desktops to a virtual desktop collection.

Syntax

PooledMgd (Default) 

Add-RDVirtualDesktopToCollection
    [-CollectionName] <String>
    -VirtualDesktopAllocation <Hashtable>
    [-VirtualDesktopPasswordAge <Int32>]
    [-ConnectionBroker <String>]
    [<CommonParameters>]

UnManaged 

Add-RDVirtualDesktopToCollection
    [-CollectionName] <String>
    -VirtualDesktopName <String[]>
    [-ConnectionBroker <String>]
    [<CommonParameters>]

PersonalMgd 

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 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.

Parameters

-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

-VirtualDesktopAllocation

Specifies a collection of values (key/value pair) that allocate virtual desktops to Remote Desktop Virtualization (RD Virtualization Host) servers.

Parameter properties

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

Parameter sets

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

-VirtualDesktopName

Specifies an array of names of a virtual desktops.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-VirtualDesktopPasswordAge

Specifies the number of days after which the server enforces a password update.

Parameter properties

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

Parameter sets

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

-VirtualDesktopTemplateHostServer

Specifies the fully qualified ___domain name (FQDN) of the server where the virtual desktop template associated with the collection is stored.

Parameter properties

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

Parameter sets

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

-VirtualDesktopTemplateName

Specifies a descriptive name for the virtual desktop template.

Parameter properties

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

Parameter sets

PersonalMgd
Position:Named
Mandatory:False
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