Set-RDClientAccessName

Set-RDClientAccessName

Sets a DNS name that clients use to connect to a Remote Desktop deployment.

Syntax

Parameter Set: Default
Set-RDClientAccessName [[-ConnectionBroker] <String> ] [-ClientAccessName] <String> [ <CommonParameters>]

Detailed Description

The Set-RDClientAccessName cmdlet sets a Domain Name System (DNS) name that clients use to connect to a Remote Desktop deployment. For a deployment that includes a single Remote Desktop Connection Broker (RD Connection Broker) server, provide the fully qualified domain name (FQDN) of the RD Connection Broker server. For deployment that uses multiple RD Connection Broker servers in an Active/Active cluster, provide the DNS round robin name that contains FQDNs of the RD Connection Broker servers.

Parameters

-ClientAccessName<String>

Specifies a DNS name for clients to use to connect to a Remote Desktop deployment.

-ConnectionBroker<String>

Specifies the RD Connection Broker server for a Remote Desktop deployment. If you do not specify a value, the cmdlet uses the FQDN of the local computer.

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

Examples

Example 1: Set a client access name

This command sets the client access name RemoteResources.Contoso.com for the Remote Desktop deployment that has the RD Connection Broker named RDCB.Contoso.com.

PS C:\> Set-RDClientAccessName -ConnectionBroker "RDCB.Contoso.com" -ClientAccessName "RemoteResources.Contoso.com"