IFPCEEServer::HostID property

Article
08/27/2012

Applies to: desktop apps only

The HostID property gets or sets the host ID of the server. The host ID uniquely identifies the server within its array.

This property is read/write.

Syntax

HRESULT put_HostID(
  long lHostID
);

HRESULT get_HostID(
  long *plHostID
);

' Data type: Long

Property HostID( _
  ByVal lHostID As long, _
  ByVal plHostID As long _
) As Long

Property value

A 32-bit integer that specifies the host ID of the server.

Error codes

These property methods return S_OK if the call is successful; otherwise, they return an error code.

Remarks

This property is read/write. It is initially set during setup, and its range of permissible values is from 2 through 32.

An array cannot contain more than 31 Forefront TMG computers. Each array member must have a unique host ID, which is assigned during installation. The host ID assigned to the first member of an array is 2. The host ID is used to identify the server for storage purposes, in VPN settings, and in Network Load Balancing configurations.

The value of this property should not be changed unless an alert is issued indicating that two or more array members have the same host ID. Such a conflict can occur if Forefront TMG is installed concurrently on multiple servers, if settings are not specified correctly in the .ini file for unattended Setup, and in some export and import scenarios.

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