Export (0) Print
Expand All
Expand Minimize

Add-RDSessionHost

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Add-RDSessionHost

Adds one or more RD Session Host servers to a session collection.

Syntax

Parameter Set: Default
Add-RDSessionHost [-CollectionName] <String> -SessionHost <String[]> [-ConnectionBroker <String> ] [ <CommonParameters>]




Detailed Description

The Add-RDSessionHost cmdlet adds one or more Remote Desktop Session Host (RD Session Host) servers to a session collection. RD Session Host is a Remote Desktop Services role service that enables users to share Windows-based programs or the full Windows desktop. Users can connect to an RD Session Host server to run programs, save files, and use network resources on that server.

Parameters

-CollectionName<String>

Specifies the name of the RD Session Host 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 this Remote Desktop deployment. Remote users connect to this server to obtain views of available Windows Server® 2008 R2 RemoteApp programs, session-based desktops, and virtual desktops. If this parameter does not appear, the default value is the fully qualified domain name (FQDN) of the local host.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-SessionHost<String[]>

Specifies an array that contains the name of one or more servers that run the RD Session Host role service.


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.

  • Null

Examples

Example 1: Add an RD Session Host server to a session collection on an RD Connection Broker server

This command adds an RD Session Host server named sessionhost.contoso.com to a session collection. Remote users connect to the RD Connection Broker server named rdcb.contoso.com to obtain views of available RemoteApp programs, session-based desktops, and virtual desktops.


PS C:\> Add-RDSessionHost -SessionHost "sessionhost.contoso.com" -ConnectionBroker "rdcb.contoso.com"

Related topics

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