New-RDSessionDeployment

Reference

Module:: RemoteDesktop

Installs the required role services for session-based desktop deployment.

Syntax

New-RDSessionDeployment
   [-ConnectionBroker] <String>
   [-SessionHost] <String[]>
   [[-WebAccessServer] <String>]
   [<CommonParameters>]

Description

The New-RDSessionDeployment cmdlet installs role services required for the Virtual Desktop Infrastructure (VDI) to create a Remote Desktop Services (RDS) session-based Remote Desktop deployment. A session-based deployment allows users to connect to session collections that include published Windows Server 2012 RemoteApp programs and session-based desktops.

Specify the fully qualified domain names (FQDN) for servers to host a Remote Desktop Connection Broker (RD Connection Broker) role service, a Remote Desktop Web Access (RD Web Access) role service, and one or more instances of the Remote Desktop Session Host (RD Session Host) role service.

Important

Transport Layer Security (TLS) version 1.0 must be enabled while doing a single instance install on Windows Server 2016 or earlier. If not, the Remote Desktop Session fails to deploy.

Examples

Example 1: Install role services for a session deployment

PS C:\> New-RDSessionDeployment -ConnectionBroker "RDCB.Contoso.com" -WebAccessServer "RDWA.Contoso.com" -SessionHost "RDSH01.Contoso.com"

This command installs Remote Desktop role services on specified servers. The command installs an RD Connection Broker role service on the server named RDCB.Contoso.com. The command installs an RD Web Access role service on the server named RDWA.Contoso.com. The command installs the RD Session Host role service on the server named RDSH01.Contoso.com.

Example 2: Install role services that include multiple RD Session Host servers

PS C:\> New-RDSessionDeployment -ConnectionBroker "RDCB.Contoso.com" -WebAccessServer "RDWA.Contoso.com" -SessionHost @("RDSH01.Contoso.com","RDSH02.Contoso.com")

Parameters

-ConnectionBroker

Specifies the FQDN of a server to host the RD Connection Broker role service.

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

-SessionHost

Specifies an array of the FQDNs of servers to host the RD Session Host role service.

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

-WebAccessServer

Specifies the FQDN of a server to host the RD Web Access role service.

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

Outputs

Null

Share via