IFPCEEArray::DNSName property

Article
08/27/2012

Applies to: desktop apps only

The DNSName property gets or sets the DNS name of the array.

This property is read/write.

Syntax

HRESULT put_DNSName(
  BSTR bstrDNSName
);

HRESULT get_DNSName(
  BSTR *pbstrDNSName
);

' Data type: String

Property DNSName( _
  ByVal bstrDNSName As BSTR, _
  ByVal pbstrDNSName As BSTR _
) As String

Property value

String that specifies the DNS name of the array.

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. Its default value is an empty string.

The DNS name of an array can be used in the settings that are passed to Forefront TMG Client and Firewall Client computers and to Web browsers running on Forefront TMG Client and Firewall Client computers so that they can send requests to the array as a single logical unit. The DNS name of the array should then be mapped in the DNS zone files used by the clients to the IP addresses of the array members.

If CARP is enabled for the array, Web proxy clients (CERN-compatible applications, such as Web browsers, running on a Forefront TMG Client or Firewall Client computer or on a SecureNAT client) can use the DNS name of the array to connect to an array member and download a script that implements the CARP algorithm. The clients then use the script to obtain a prioritized list of array members that can serve specific Web content.

For Network Load Balancing, the DNS name of the array should be mapped in the DNS zone files used by clients to the virtual IP addresses (VIP) of all the Network Load Balancing clusters that are configured in the array followed by the default IP addresses of the array members. When a Network Load Balancing cluster is enabled, clients in the applicable network that send requests to the DNS name of the array would use its virtual IP address because it is the first available IP address to which the DNS name is resolved. When the cluster is disabled, clients would use the first available dedicated IP address.

The DNS name of an array can also be used to configure firewall chaining (FPCFirewallChaining objects) and Web chaining rules (FPCRoutingRule objects) to an upstream Forefront TMG array.

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