IFPCPolicyRules::AddServerPublishingRule method

Article
08/27/2012

Applies to: desktop apps only

The AddServerPublishingRule method creates a new FPCPolicyRule object representing a server publishing rule in the collection and returns a reference to it.

Syntax

HRESULT AddServerPublishingRule(
  [in]   BSTR Name,
  [in]   BSTR PublishedServerIP,
  [in]   BSTR Protocol,
  [out]  IFPCPolicyRule **ppNewRule
);

FPCPolicyRules.AddServerPublishingRule( _
  ByVal Name As String, _
  ByVal PublishedServerIP As String, _
  ByVal Protocol As String, _
  ByRef ppNewRule _
) As FPCPolicyRule

Parameters

Name [in]

C++ Required. BSTR that specifies the name of the new server publishing rule.

VB Required. String that specifies the name of the new server publishing rule.
PublishedServerIP [in]

C++ Required. BSTR that specifies the IP address of the internal server being published.

VB Required. String that specifies the IP address of the internal server being published.
Protocol [in]

C++ Required. BSTR that specifies the protocol for the new server publishing rule.

VB Required. String that specifies the protocol for the new server publishing rule.
ppNewRule [out]
Address of an interface pointer that on return points to an IFPCPolicyRule interface representing the new server publishing rule.

Return value

C++

This method returns one of the following:

S_OK, indicating that the operation succeeded.
An error code, indicating that the operation failed. In this case, the [out] parameter returned is a null object.

VB

This method returns a reference to the FPCPolicyRule object if the operation is successful. Otherwise, an error is raised that can be intercepted by using an error handler.

Remarks

Server publishing rules are used when there is a network address translation (NAT) relationship defined by a network rule (an FPCNetworkRule object) between the network on which the clients sending requests to the published server are located (the source network) and the network on which the published server is located (the destination network). A server publishing rule uses secure network address translation (SecureNAT), which allows requests that are sent to an IP address that is valid on the source network to reach an IP address on a protected network behind the Forefront TMG computer. The server publishing rule maps a port number and an IP address (or IP addresses) on the network adapter of the Forefront TMG computer that listens for requests from the clients to a port number and an IP address on the published server. Requests that meet the conditions specified by the rule are then redirected to the IP address specified in the PublishedServerIP parameter. However, only requests that are identified as part of the protocol specified in the Protocol parameter are processed by the server publishing rule and redirected to the published server.

The name assigned to the new rule must be unique. If the AddServerPublishingRule method is called with the name of an existing policy rule, the method fails.

The server publishing rule defined by the FPCPolicyRule object (IFPCPolicyRule interface in C++) created can be configured by setting the properties of the FPCServerPublishingProperties object (IFPCServerPublishingProperties interface in C++) accessed through the ServerPublishingProperties property.

Before the properties of a new server publishing rule can be written to persistent storage by calling the Save method, at least one network or network set on which the Forefront TMG will listen for requests must be specified for the rule through the IPsOnNetworks or IPsOnNetworkSets property.

When an enterprise with central array management is deployed, a server publishing rule cannot be created in an array policy if the enterprise administrator sets the EnablePublishingRules property of the FPCPolicyAssignment object (IFPCPolicyAssignment interface in C++) for the array to False (VARIANT_FALSE in C++).

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