New-RDSessionCollection

  • Reference
Module:
RemoteDesktop

Creates a session collection of RD Session Host servers.

Syntax

New-RDSessionCollection
   [-CollectionName] <String>
   [-CollectionDescription <String>]
   -SessionHost <String[]>
   [-ConnectionBroker <String>]
   [-PersonalUnmanaged]
   [-AutoAssignUser]
   [-GrantAdministrativePrivilege]
   [<CommonParameters>]
New-RDSessionCollection
   [-CollectionName] <String>
   [-CollectionDescription <String>]
   -SessionHost <String[]>
   [-ConnectionBroker <String>]
   [-PooledUnmanaged]
   [<CommonParameters>]

Description

The New-RDSessionCollection cmdlet creates a session collection that consists of one or more Remote Desktop Session Host (RD Session Host) servers. Users can connect to RD Session Host servers in a session collection to run programs, save files, and use resources on those servers.

Examples

Example 1: Create a session collection

PS C:\> New-RDSessionCollection -CollectionName "Session Collection 02" -SessionHost @("RDSH01.Contoso.com"," RDSH02.Contoso.com") -CollectionDescription "Session collection for West office hosts." -ConnectionBroker "RDCB.Contoso.com"

This command creates a session collection named Session Collection 02 in the Remote Desktop deployment that has the RD Connection Broker server named RDCB.Contoso.com. The collection includes the RD Session Host servers named RDSH01.Contoso.com and RDSH02.Contoso.com. The command specifies a description of the new collection.

Parameters

-AutoAssignUser

Indicates that this cmdlet enables automatic session desktop assignments for a personal session collection.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CollectionDescription

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CollectionName

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ConnectionBroker

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GrantAdministrativePrivilege

Indicates that the server grants administrative privileges to the user account that the server assigns to a given personal virtual desktop. This parameter applies only to personal virtual desktop collections.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PersonalUnmanaged

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PooledUnmanaged

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SessionHost

Type:String[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Microsoft.RemoteDesktopServices.Management.RDSessionCollection