Export (0) Print
Expand All
Expand Minimize

New-RDSessionCollection

Updated: August 12, 2013

Applies To: Windows Server 2012

New-RDSessionCollection

Creates a session collection of RD Session Host servers.

Syntax

Parameter Set: Default
New-RDSessionCollection [-CollectionName] <String> -SessionHost <String[]> [-CollectionDescription <String> ] [-ConnectionBroker <String> ] [ <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

none

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

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.RemoteDesktopServices.Management.RDSessionCollection

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"

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft