Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

New-RDSessionCollection

New-RDSessionCollection

remotedesktop.psm1

Synopsis

Creates a session collection of RD Session Host servers.

Syntax

New-RDSessionCollection [-CollectionName] [-CollectionDescription] [-ConnectionBroker] [-SessionHost] [<CommonParameters>]

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

Parameters

-CollectionDescription <String>

Specifies a description for the collection.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-CollectionName <String>

Specifies a name for the session collection.

Aliases

None

Required?

true

Position

1

Default value

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

Accept pipeline input?

false

Accept wildcard characters?

false

-SessionHost <String[]>

Specifies an array of RD Session Host servers to include in the session collection.

Aliases

None

Required?

true

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

Microsoft.RemoteDesktopServices.Management.RDSessionCollection

Notes

None

Examples

Example 1: Create a session collection

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.

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"

Online Version
Get-RDSessionCollection
Remove-RDSessionCollection