Set-RDActiveManagementServer
Set-RDActiveManagementServer
Sets the active Remote Desktop Connection Broker server, or management server, in a remote desktop deployment.
Syntax
Parameter Set: Default
Set-RDActiveManagementServer [-ManagementServer] <String> [ <CommonParameters>]
Detailed Description
The Set-RDActiveManagementServer cmdlet sets the active Remote Desktop Connection Broker (RD Connection Broker) server in a remote desktop deployment.
This server runs the Remote Desktop Management Server (RDMS) service, which belongs in a high availability group to ensure uninterrupted access. The Remote Desktop Management Server service configures the deployment and deployment properties, creates and configures collections, and provisions virtual machines.
Parameters
-ManagementServer<String>
Specifies the name of a server that acts as the active RD Connection Broker for a remote desktop deployment.
Aliases |
none |
Required? |
true |
Position? |
1 |
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
None
Examples
Example 1: Set the active management server for a remote desktop deployment
This command sets the active management server for the remote desktop.
PS C:\> Set-RDActiveManagementServer -ManagementServer "Rdcb.Contoso.com"