Managed Terminal Services::ControlRemoteDesktop

  • Article

The method configures the specified terminal server to allow or disallow new Terminal Services connections. When disallowed, existing sessions are unaffected, but creation of new sessions is prevented.

This setting would be manually controlled by setting or clearing the 'Enable Remote Desktop' checkbox on the 'MyComputer->Properties->Remote' tab on the machine in question.

In order for this method to successfully execute, either

  • The MPF service account (domain\MPFServiceAcct) must have administrator privileges on the specified terminal server, or

  • The request must include the username and password of a domain user with administrator privileges on the specified terminal server.

Arguments

Input Arguments Required Description

<server>

Yes

The name of the server on which connections are to be enabled or disabled.

<action>

Yes

The action to be performed: "enable" or "disable".

<preferredDomainController>

Yes

The name of the preferred domain controller to be used to check the permissions of the caller.

<userName>

No

The name of a domain user with local administrator privileges on the specified server. This should be in the form "domain\username". If not specified, no credentials are sent, and the MPF Service Account must have administrative privileges on the specified server.

<password>

No

The password of the specified administrator. Required if userName has been specified.

Remarks

Security

Permitted to DomainAdmins only

Sample Code

Example XML Request

<request> 
  <procedure> 
    <execute namespace="Managed Terminal Services" 
             procedure="ControlRemoteDesktop"> 
      <executeData> 
        <server>TheServer</server> 
        <userName>Fabrikam\admin1</userName> 
        <password>mypassword</password> 
        <action>disable</action> 
        <preferredDomainController>dc1</preferredDomainController> 
      </executeData> 
    </execute> 
  </procedure> 
</request>

Applies To

Terminal Services Namespace

See also

Tasks

Managed Terminal Services::ControlConnection
Managed Terminal Services::ControlServer
Managed Terminal Services::ControlSession