M-Files API 22.6.11519.0
ConnectAdministrativeEx Method
MFilesServerApplication Object : ConnectAdministrativeEx Method
The possible time zone information. In scripting languages, a specific null value (e.g., Nothing in VBScript) should be used to indicate the default value.
User name as a string. Not used with the MFAuthTypeLoggedOnWindowsUser authentication mode.
Password as a string. Not used with the MFAuthTypeLoggedOnWindowsUser authentication mode.
Domain for the user. Used only with the MFAuthTypeSpecificWindowsUser authentication mode.
Service Principal Name.

Protocol sequence name to be used in server communication. Supported protocols include:

Server address as an IP number or computer name. Not used with the LPC protocol.

Specifies the communication port on which the server listens for calls.

With the TCP/IP protocol, specify the TCP port that M-Files Server is listening to. Typically this value is 2266.

With the HTTPS protocol, specify the M-Files Server endpoint that will be used between the RPC Proxy and M-Files Server on the server side. Typically this value is 4466. Note that this parameter does not affect the port that the client uses to communicate with the server. Regardless of this setting, the client will always use the standard HTTPS port for communicating with the server.

With the LPC protocol, specify "MFServerCommon_F5EE352D-6A03-4866-9988-C69CEA2C39BF" to connect to the local M-Files Server instance regardless of its version. If multiple versions of M-Files Server are running on the same computer, the first instance that has started has been registered to listen to this endpoint. Alternatively, you can leave this parameter empty in order to connect to the exact same version of M-Files Server as the M-Files API version you are using. If you leave the Endpoint parameter empty with the LPC protocol, M-Files API uses a version-specific endpoint name to connect to M-Files Server.

The default endpoint for the gRPC protocol is 7766. With the local gRPC protocol, use the version of the M-Files Server instance you are connecting to as the endpoint value. For instance, 20.9.9403.0. Use an empty value for referring to the current installation.

Specifies whether data between M-Files Client and M-Files Server must be encrypted. May apply to certain protocol sequences only.

With non-local gRPC, the value must be true when the server you are connecting to uses TLS and false when the server does not use TLS. With local gRPC, the recommended value is false.

Local computer name as reported for the server. Use an empty string to use the computer name provided by the system.
Description
Connects to the server in administrative mode. Allows connection without a login account if the user has administrative rights on the server computer. Use the ConnectAdministrativeEx5 method for additional options.
Syntax
Visual Basic
Public Function ConnectAdministrativeEx( _
   Optional ByVal TimeZone As TimeZoneInformation = 0, _
   Optional ByVal AuthType As MFAuthType = MFAuthTypeLoggedOnWindowsUser, _
   Optional ByVal UserName As Variant, _
   Optional ByVal Password As Variant, _
   Optional ByVal Domain As Variant, _
   Optional ByVal SPN As Variant, _
   Optional ByVal ProtocolSequence As String = "ncacn_ip_tcp", _
   Optional ByVal NetworkAddress As String = "localhost", _
   Optional ByVal Endpoint As String = 2266, _
   Optional ByVal EncryptedConnection As Boolean = False, _
   Optional ByVal LocalComputerName As String = "" _
) As MFServerConnection
Parameters
TimeZone
The possible time zone information. In scripting languages, a specific null value (e.g., Nothing in VBScript) should be used to indicate the default value.
AuthType
ValueDescription
MFAuthTypeLoggedOnWindowsUserWindows authentication with current user credentials.
MFAuthTypeSpecificMFilesUserM-Files authentication, user needs to specify the credentials.
MFAuthTypeSpecificWindowsUserWindows authentication, user needs to specify the credentials.
MFAuthTypeUnknownUnspecified authentication method.
UserName
User name as a string. Not used with the MFAuthTypeLoggedOnWindowsUser authentication mode.
Password
Password as a string. Not used with the MFAuthTypeLoggedOnWindowsUser authentication mode.
Domain
Domain for the user. Used only with the MFAuthTypeSpecificWindowsUser authentication mode.
SPN
Service Principal Name.
ProtocolSequence

Protocol sequence name to be used in server communication. Supported protocols include:

  • "ncacn_ip_tcp" (TCP/IP protocol)
  • "ncacn_spx" (SPX protocol)
  • "ncalrpc" (local interprocess call, LPC)
  • "ncacn_http" (HTTPS)
  • "grpc" (gRPC)
  • "grpc-local" (local gRPC)
NetworkAddress
Server address as an IP number or computer name. Not used with the LPC protocol.
Endpoint

Specifies the communication port on which the server listens for calls.

With the TCP/IP protocol, specify the TCP port that M-Files Server is listening to. Typically this value is 2266.

With the HTTPS protocol, specify the M-Files Server endpoint that will be used between the RPC Proxy and M-Files Server on the server side. Typically this value is 4466. Note that this parameter does not affect the port that the client uses to communicate with the server. Regardless of this setting, the client will always use the standard HTTPS port for communicating with the server.

With the LPC protocol, specify "MFServerCommon_F5EE352D-6A03-4866-9988-C69CEA2C39BF" to connect to the local M-Files Server instance regardless of its version. If multiple versions of M-Files Server are running on the same computer, the first instance that has started has been registered to listen to this endpoint. Alternatively, you can leave this parameter empty in order to connect to the exact same version of M-Files Server as the M-Files API version you are using. If you leave the Endpoint parameter empty with the LPC protocol, M-Files API uses a version-specific endpoint name to connect to M-Files Server.

The default endpoint for the gRPC protocol is 7766. With the local gRPC protocol, use the version of the M-Files Server instance you are connecting to as the endpoint value. For instance, 20.9.9403.0. Use an empty value for referring to the current installation.

EncryptedConnection

Specifies whether data between M-Files Client and M-Files Server must be encrypted. May apply to certain protocol sequences only.

With non-local gRPC, the value must be true when the server you are connecting to uses TLS and false when the server does not use TLS. With local gRPC, the recommended value is false.

LocalComputerName
Local computer name as reported for the server. Use an empty string to use the computer name provided by the system.
Remarks
This connection methods should be used only to administer M-Files Server and document vaults.
See Also

MFilesServerApplication Object  | MFilesServerApplication Members