New-RDSessionDeployment
New-RDSessionDeployment
Installs the required role services for session-based desktop deployment.
Syntax
Parameter Set: Default
New-RDSessionDeployment [-ConnectionBroker] <String> [-WebAccessServer] <String> [-SessionHost] <String[]> [ <CommonParameters>]
Detailed 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.
Parameters
-ConnectionBroker<String>
Specifies the FQDN of a server to host the RD Connection Broker role service.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SessionHost<String[]>
Specifies an array of the FQDNs of servers to host the RD Session Host role service.
Aliases |
none |
Required? |
true |
Position? |
3 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WebAccessServer<String>
Specifies the FQDN of a server to host the RD Web Access role service.
Aliases |
none |
Required? |
true |
Position? |
2 |
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 (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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
Null.
Examples
Example 1: Install role services for a session deployment
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.
PS C:\> New-RDSessionDeployment -ConnectionBroker "RDCB.Contoso.com" -WebAccessServer "RDWA.Contoso.com" -SessionHost "RDSH01.Contoso.com"
Example 2: Install role services that include multiple RD Session Host servers
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 two servers, named RDSH01.Contoso.com and RDSH02.Contoso.com.
PS C:\> New-RDSessionDeployment -ConnectionBroker "RDCB.Contoso.com" -WebAccessServer "RDWA.Contoso.com" -SessionHost @("RDSH01.Contoso.com","RDSH02.Contoso.com")