New-RDSessionCollection

Module:

RemoteDesktop Module

Creates a session collection of RD Session Host servers.

Syntax

PersonalSessionCollection

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

PooledSessionCollection

New-RDSessionCollection
    [-CollectionName] <String>
    -SessionHost <String[]>
    [-CollectionDescription <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.

Parameter properties

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

Parameter sets

PersonalSessionCollection

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

-CollectionDescription

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.

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

-CollectionName

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.

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

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.

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

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

Parameter properties

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

Parameter sets

PersonalSessionCollection

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

-PersonalUnmanaged

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.

Parameter properties

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

Parameter sets

PersonalSessionCollection

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

-PooledUnmanaged

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.

Parameter properties

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

Parameter sets

PooledSessionCollection

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

-SessionHost

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.

Parameter properties

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

Parameter sets

(All)

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

Microsoft.RemoteDesktopServices.Management.RDSessionCollection

Related Links

• Get-RDSessionCollection
• Remove-RDSessionCollection