IFPC2::ConnectToConfigServerPort method

Article
08/27/2012

Applies to: desktop apps only

The ConnectToConfigServerPort method connects to the specified Configuration Storage server on a specific port.

Syntax

HRESULT ConnectToConfigServerPort(
  [in, optional]  BSTR ConfigurationStorageServer,
  [in, optional]  BSTR StorageUserName,
  [in, optional]  BSTR StorageUserDomain,
  [in, optional]  BSTR StorageUserPassword,
  [in, optional]  BSTR MonitoringUserName,
  [in, optional]  BSTR MonitoringUserDomain,
  [in, optional]  BSTR MonitoringUserPassword,
  [in, optional]  FpcStorageServerConnectionType eConnectionType,
  [in, optional]  long Port
);

FPC.ConnectToConfigServerPort( _
  [ ByVal ConfigurationStorageServer As String ], _
  [ ByVal StorageUserName As String ], _
  [ ByVal StorageUserDomain As String ], _
  [ ByVal StorageUserPassword As String ], _
  [ ByVal MonitoringUserName As String ], _
  [ ByVal MonitoringUserDomain As String ], _
  [ ByVal MonitoringUserPassword As String ], _
  [ ByVal eConnectionType As FpcStorageServerConnectionType ], _
  [ ByVal Port As Long ] _
)

Parameters

ConfigurationStorageServer [in, optional]

C++	BSTR that specifies the name of the Configuration Storage server. The default value is an empty BSTR, which indicates the local computer.
VB	String value that specifies the name of the Configuration Storage server. The default value is an empty string, which indicates the local computer.

StorageUserName [in, optional]

C++	BSTR that specifies the name of a user with the permissions needed to modify the stored enterprise configuration. The default value is an empty BSTR, which specifies the user who is currently logged on.
VB	String value that specifies the name of a user with the permissions needed to modify the stored enterprise configuration. The default value is an empty string, which specifies the user who is currently logged on.

StorageUserDomain [in, optional]

C++	BSTR that specifies the name of the domain of the user with the permissions needed to modify the stored enterprise configuration. The default value is an empty BSTR, which specifies the domain of the user who is currently logged on.
VB	String value that specifies the name of the domain of the user with the permissions needed to modify the stored enterprise configuration. The default value is an empty string, which specifies the domain of the user who is currently logged on.

StorageUserPassword [in, optional]

C++	BSTR that specifies the password of the user with the permissions needed to modify the stored enterprise configuration. The default value is an empty BSTR, which specifies the password provided by the user who is currently logged on.
VB	String value that specifies the password of the user with the permissions needed to modify the stored enterprise configuration. The default value is an empty string, which specifies the password provided by the user who is currently logged on.

MonitoringUserName [in, optional]

C++	BSTR that specifies the name of a user with the permissions needed to read the stored enterprise configuration. The default value is an empty BSTR, which specifies the user who is currently logged on.
VB	String value that specifies the name of a user with the permissions needed to read the stored enterprise configuration. The default value is an empty string, which specifies the user who is currently logged on.

MonitoringUserDomain [in, optional]

C++	BSTR that specifies the name of the domain of the user with the permissions needed to read the stored enterprise configuration. The default value is an empty BSTR, which specifies the domain of the user who is currently logged on.
VB	String value that specifies the name of the domain of the user with the permissions needed to read the stored enterprise configuration. The default value is an empty string, which specifies the domain of the user who is currently logged on.

MonitoringUserPassword [in, optional]

C++	BSTR that specifies the password of the user with the permissions needed to read the stored enterprise configuration. The default value is an empty BSTR, which specifies the password provided by the user who is currently logged on.
VB	String value that specifies the password of the user with the permissions needed to read the stored enterprise configuration. The default value is an empty string, which specifies the password provided by the user who is currently logged on.

eConnectionType [in, optional]
Value from the FpcStorageServerConnectionType enumerated type that specifies whether the connection between the array member or remote management computer and the Configuration Storage server will be over an unencrypted channel or over a Secure Sockets Layer (SSL) channel. The default value is fpcRegularStorageConnection, which specifies that the connection will be over an unencrypted channel.
Port [in, optional]
A 32-bit integer that specifies the port on which the local computer will communicate with the Configuration Storage server.

Return value

C++

This method returns S_OK if the call is successful; otherwise, it returns an error code.

VB

This method has no return values. If the call is unsuccessful, an error is raised that can be intercepted by using an error handler.

Remarks

If user credentials are not supplied, the credentials of the user who is currently logged on are used.

When an FPC root object is created on an array member, it automatically attempts to connect to the Configuration Storage server specified in the registry for the array using the credentials of the user who is currently logged on. If this user is not an enterprise administrator or an enterprise auditor, the ConnectToConfigServerPort or ConnectToConfigurationStorageServer method must be called to connect to a Configuration Storage server.

After a connection to a Configuration Storage server is established and configuration changes are made, you should not call the DisconnectFromConfigurationStorageServer method and then the ConnectToConfigServerPort or ConnectToConfigurationStorageServer method to establish a new connection before saving the changes made using the current connection.

A computer on which Forefront TMG Management is installed without the Microsoft Firewall service can serve as a remote management computer and can create an instance of the root (FPC) object. However, that computer cannot access the properties of the root object or any other object in the administration COM object hierarchy until it connects to a Configuration Storage server using this method or the ConnectToConfigurationStorageServer method.

The following types of Forefront TMG computers are Configuration Storage servers, and the ConnectToConfigServerPort method can be used to connect to them from a remote management computer.

A standalone server.
An array manager in a standalone array.
An Enterprise Management Server (EMS).

Requirements

Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
IDL	Msfpccom.idl
DLL	Msfpccom.dll

Share via