FPCEnterpriseNetwork Object
The FPCEnterpriseNetwork object represents an enterprise network, and its properties provide access to the configuration settings of the enterprise network (available only in Forefront TMG Enterprise Edition).
An enterprise network is a network that is defined in the enterprise configuration and can be used for configuring access rules in an enterprise policy that can be applied to any array in the enterprise and for configuring enterprise network rules that apply to all arrays in the enterprise. Enterprise networks can also be used for defining array-level access and publishing rules and for defining array-level network rules.
Forefront TMG is installed with the following predefined enterprise networks:
- External.
- Local Host.
- Quarantined VPN Clients.
- VPN Clients.
User-defined enterprise networks can be included in a network defined in an array by including references to them in the FPCRefs collection held in the EnterpriseNetworks property of the FPCNetwork object representing the array-level network. The set of IP address ranges defined by each enterprise network is then included in the array-level network, and the additional array-level configuration settings specified in the properties of the FPCNetwork object will also apply to this set of IP address ranges.
The enterprise networks that are included in or excluded from a set of IP addresses are specified by including references to the applicable FPCEnterpriseNetwork objects in the FPCRefs collection held in the EnterpriseNetworks property of the FPCSelectionIPs object. Similarly, the enterprise networks that are included in or excluded from a network set are specified by including references to the applicable FPCEnterpriseNetwork objects in the FPCRefs collection held in the EnterpriseNetworks property of the FPCNetworkSet object. For more information, see Enterprise Networks.
This object is an element of an FPCEnterpriseNetworks collection, and a new object representing a user-defined enterprise network can be created by calling the Add method of this collection.
.png "Dd435958.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 FPCEnterpriseNetwork object does not define any methods.
Properties
The FPCEnterpriseNetwork object defines the following properties.
| Property | Description |
|---|---|
Gets or sets the description of the enterprise network. |
|
Gets an FPCIpRangeSet collection that contains the set of IP address ranges defining the enterprise network. |
|
Gets an FPCIpRangeSet collection that contains the set of IPv6 address ranges defining the enterprise network. |
|
Gets or sets the name of the enterprise network. |
|
Gets a Boolean value that indicates whether the enterprise network is a predefined enterprise network that was installed with Forefront TMG and cannot be deleted. |
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 IFPCEEEnterpriseNetwork interface.
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
Send comments about this topic to Microsoft
Build date: 6/30/2010