TerminalServicesProvider::ControlConnection

  • Article

The ControlConnection method enables or disables incoming Terminal Services connections for the specified server. In addition, when connections are disabled, this method also immediately terminates all existing sessions. This may result in loss of data in those sessions.

This setting would be manually controlled by right-clicking on the connection in the Terminal Services Connection Configuration snap-in and selecting All actions/Enable connection or Disable connection.

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

<userName>

No

The name of a 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

Rollback

Yes - the original state of this setting is restored on rollback.

Underlying API

SetAllowTSConnections Method of the Win32_TerminalServiceSetting Class

Sample Code

Example XML Request

<request> 
  <procedure> 
    <execute namespace="Terminal Services Provider" procedure="ControlRemoteDesktop"> 
      <executeData> 
        <server>TheServer</server> 
        <action>disable</action> 
      </executeData> 
    </execute> 
  </procedure> 
</request>

Applies To

Terminal Services Provider