FPCNetwork Object

  • Article

The FPCNetwork object represents a single network defined in an array. A network is a rule element, which can contain one or more ranges of IP addresses and domains. The networks that are defined for a Forefront TMG computer must include an IP address bound to a network adapter on the Forefront TMG computer and should reflect the physical network topology as viewed from it. Any host having an IP address that is included in a network should be able to exchange traffic with any other host having an IP address that is included in the network without passing it through the Forefront TMG computer. Rules can be applied to one or more networks, or to all IP addresses except those in a specified network.

Forefront TMG is installed with the following predefined networks:

  • Local Host. This network represents the Forefront TMG computer. All traffic that comes from or to a Forefront TMG computer is considered to have passed by way of the Local Host network. It includes all the IP addresses bound to network adapters on the local Forefront TMG computer, and the reserved loopback IP address 127.0.0.1. The Local Host network cannot be modified or deleted.
  • External. This network includes all IP addresses that are not included in any other enterprise or array-level network. The default External network cannot be modified or deleted.
  • Internal. The ranges of IP addresses included in the Internal network are initially specified during the installation process. The Internal network cannot be deleted.
  • VPN Clients. This network contains addresses of currently connected VPN clients. The possible IP addresses that can be assigned to VPN clients and moved into this network are included in the VPN static address pool (VpnStaticAddressPool) of the Forefront TMG computer. The VPN Clients network cannot be deleted.
  • Quarantined VPN Clients. This network contains addresses of VPN clients that have not yet cleared quarantine. The Quarantined VPN Clients network cannot be deleted.

The FPCNetwork object representing a specific network can be referenced through the FPCRef object held in the following properties:

Networks are specified in the following properties by including references to the applicable FPCNetwork objects in the FPCRefs collection held in these properties:

The FPCNetwork object is an element of an FPCNetworks collection, and a new object representing a network can be created by calling the Add method of this collection.

Dd436239.bkbutton(en-us,MSDN.10).png Click here to see the Forefront TMG object hierarchy.

Inheritance

This object inherits from the FPCPersist object, which contains methods and properties related to the persistent storage of an object's data. They include methods for exporting the object's data to and importing it from an XML document.

Methods

The FPCNetwork object does not define any methods.

Properties

The FPCNetwork object defines the following properties.

Property Description

AutoDiscoveryPort

Gets or sets the port to bind to if the EnableAutoDiscoveryPort property is set to True.

CalculatedEEIpRangeSet

Gets or sets an FPCReadOnlyIpRangeSet collection that contains the effective set of IP addresses ranges included in the network, which is the union of all the IP address ranges defining the network and all the IP address ranges defining the enterprise networks included in the network.

ClientConfig

Gets an FPCClientConfig object that provides access to configuration settings for Web proxy clients and for Forefront TMG Client and Firewall Client computers in the network.

Description

Gets or sets the description of the network.

EnableAutoDiscoveryPort

Gets or sets a Boolean value that indicates whether the Web proxy binds to a specific port so that Web proxy clients on the network can automatically discover the Forefront TMG computer.

EnableFirewallClients

Gets or sets a Boolean value that indicates whether Forefront TMG Client computers and Firewall clients on the network are supported.

EnableWebProxyClients

Gets or sets a Boolean value that indicates whether Web proxy clients on the network are supported.

EnterpriseNetworks

Gets an FPCRefs collection that contains references to the FPCEnterpriseNetwork objects defining the enterprise networks included in the network.

IpRangeSet

Gets an FPCIpRangeSet collection that contains the set of IP address ranges defining the network.

Ipv6RangeSet

Gets an FPCIpRangeSet collection that contains the set of IPv6 address ranges defining the network.

ISPRedundancyConfig

Gets an FPCISPRedundancyConfig object that holds the Internet service provider (ISP) redundancy configuration settings for the network.

LDT

Gets an FPCLDT collection that contains the entries in the local domain table (LDT).

Name

Gets or sets the name of the network.

NetworkConnectionType

Gets or sets a value from the FpcNetworkConnectionType enumerated type that specifies the type of connection to the network.

NetworkType

Gets a value from the FpcNetworkTypes enumerated type that specifies the type of network.

NLBCluster

Gets an FPCNLBCluster object that represents the Network Load Balancing (NLB) cluster on the network.

Predefined

Gets a Boolean value that indicates whether the network is predefined.

VpnConfiguration

Gets an FPCVpnNetworkConfiguration object that provides access to the configuration settings for site-to-site virtual private network (VPN) connections to the network.

WebListenerProperties

Gets an FPCWebListenerProperties object that contains the properties of the Web listener for outgoing requests from the network.

Methods Inherited from FPCPersist

Name Description
CancelWaitForChanges Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only).
CanImport Returns a Boolean value that indicates whether the object's properties can be imported from the specified XML document.
Export Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML document.
ExportToFile Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML file.
GetServiceRestartMask Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect.
Import Recursively copies the values of all the properties of the object and of its subobjects from the specified XML document to persistent storage.
ImportFromFile Recursively copies the values of all the properties of the object and of its subobjects from the specified XML file to persistent storage.
LoadDocProperties Provides the XML document's properties so that you can know what information can be imported from the document.
Refresh Recursively reads the values of all the properties of the object and of its subobjects from persistent storage, overwriting any changes that have not been saved.
Save Recursively writes the current values of all the properties of the object and its subobjects to persistent storage.
WaitForChanges Registers to wait for an event indicating that the contents of the object have changed (for use in C and C++ programming only).

Properties Inherited from FPCPersist

Name Description
PersistentName Gets the persistent name of the object. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy.
VendorParameterSets Gets an FPCVendorParametersSets collection that can hold sets of custom data for extending the object.

Interfaces for C++ Programming

This object implements the IFPCNetwork, IFPCEENetwork, and IFPCNetwork2 interfaces.

Requirements

Client Requires Windows 7 or Windows Vista.
Server Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version Requires Forefront Threat Management Gateway (TMG) 2010.
IDL

Declared in Msfpccom.idl.

See Also

COM Objects

Send comments about this topic to Microsoft

Build date: 6/30/2010