FPCNetworkSet object

Applies to: desktop apps only

The FPCNetworkSet object represents a single network set.

The networks defined in an array that are included in or excluded from the network set are specified in the Networks property. When an enterprise with central array management is deployed, enterprise networks can also be included in the network set or excluded from it, and network sets can be also be defined on the enterprise level.

Note  Enterprise networks are available only in Forefront TMG Enterprise Edition.

By default, the following predefined network sets are supplied with Forefront TMG:

  • All Networks (and Local Host). A predefined network set that includes all the networks defined in the array, including the Local Host network.
  • All Protected Networks. A predefined network set that includes all the networks defined in the array except the built-in External network.

Network sets are referenced in the properties of several objects.

  • The network sets that are included in or excluded from a set of IP addresses are specified by including references to the applicable FPCNetworkSet objects in the FPCRefs collection held in the NetworkSets property of the FPCSelectionIPs object.
  • The network sets from which VPN clients and remote VPN servers can initiate VPN connections are specified by including references to the applicable FPCNetworkSet objects in the FPCRefs collection held in the NetworkSetsToListenOn property of the FPCVpnConfiguration object.
  • The network sets to which a Web listener listens are specified by including references to the applicable FPCNetworkSet objects in the FPCRefs collection held in the SourceNetworkSets property of the FPCWebListener object.
  • The network sets from which Forefront TMG listens for requests on behalf of the server published by a server publishing rule are specified by including references to the applicable FPCNetworkSet objects in the FPCRefs collection held in the IPsOnNetworkSets property of the FPCServerPublishingProperties object for the rule.
  • The network sets from which Forefront TMG listens for outbound or inbound SMTP requests for an SMTP route are specified by including references to the applicable FPCNetworkSet objects in the FPCRefs collection held in the IPsOnNetworkSets property of the FPCSmtpRoute object.

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

Ff825475.bkbutton(en-us,VS.85).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 an object's data to and importing it from an XML document.

Members

The FPCNetworkSet object has these types of members:

Properties

The FPCNetworkSet object has these properties.

PropertyAccess typeDescription

Description

Read/write

Gets or sets the description of the network set.

EnterpriseNetworks

Read-only

Gets an FPCRefs collection that contains references to the FPCEnterpriseNetwork objects defining the enterprise networks that are included in or excluded from the network set.

Name

Read/write

Gets or sets the name of the network set.

Networks

Read-only

Gets an FPCRefs collection that contains references to the FPCNetwork objects defining the networks included in or excluded from the network set.

NetworkSetType

Read-only

Gets a value from the FpcNetworkSetType enumerated type that specifies whether the network set includes only the networks specified in the Networks and EnterpriseNetworks properties, or includes all networks except the networks specified in the Networks and EnterpriseNetworks properties.

Predefined

Read-only

Gets a Boolean value that indicates whether the network set is a predefined network set that was created during the installation of Forefront TMG and cannot be deleted.

 

Methods Inherited from FPCPersist

NameDescription
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

NameDescription
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 IFPCNetworkSet and IFPCEENetworkSet interfaces.

Requirements

Minimum supported client

Windows Vista, None supported

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

See also

COM Objects

 

 

Build date: 7/12/2010

Community Additions

ADD
Show: