FPCConfigurationStorageServerConnection object
Applies to: desktop apps only
The FPCConfigurationStorageServerConnection object represents the configuration settings of the connection to a Configuration Storage server for a Forefront TMG array. The properties of this object specify the names of the primary and alternate Configuration Storage servers to be used by the array, the protocol to be used for connecting to the applicable Configuration Storage server, and the configuration settings for switching between the primary and alternate Configuration Storage servers (available only in Forefront TMG Enterprise Edition).
Note In Forefront TMG 2010, the FPCConfigurationStorageServerConnection object represents the configuration settings for connections of array members to the array manager in a standalone array, or to an Enterprise Management Server (EMS) when an EMS is deployed. In a standalone array, the array manager should be designated as the primary Configuration Storage server, and there is no alternate Configuration Storage server. When an EMS is deployed, it should be designated as the primary Configuration Storage server. If a replica EMS is deployed, it can be designated as the alternate Configuration Storage server.
Array members communicate with a Configuration Storage server to read and write configuration data using the MS Firewall Storage protocol, which is based on the Lightweight Directory Access Protocol (LDAP), through port 2171, or the MS Firewall Storage protocol over SSL, which is based on LDAP over SSL (LDAPS), through port 2172. If the array members belong to an Active Directory domain, connections to a Configuration Storage server are authenticated with Active Directory accounts using the MS Firewall Storage protocol through port 2171. In a workgroup environment, the connections are authenticated with certificates using the MS Firewall Storage protocol over SSL through port 2172.
An array member initially uses the primary Configuration Storage server as its current Configuration Storage server. By default, each array member polls its current Configuration Storage server for configuration changes every 15 seconds (the default polling time). If the primary Configuration Storage server is unavailable for 30 minutes (the default fallback delay), the array member switches to the other Configuration Storage server, if an alternate Configuration Storage server is specified. After using the alternate Configuration Storage server for six hours (the default primary testing delay), the array member periodically tests for connectivity with the primary Configuration Storage server. After the primary Configuration Storage server is continuously available for 10 minutes (the default primary stabilization time), the array member switches back to it.
This object is accessed through the ConfigurationStorageServerConnection property of the FPCArray object.
.png "Ff824558.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 the object's data to and importing it from an XML document.
Members
The FPCConfigurationStorageServerConnection object has these types of members:
- Properties
Properties
The FPCConfigurationStorageServerConnection object has these properties.
| Property | Access type | Description |
|---|---|---|
| Read/write | Gets or sets the name of the alternate Configuration Storage server for the array. |
|
| Read/write | Gets or sets the time (in seconds) that each array member will wait before checking the current Configuration Storage server for configuration changes again. |
|
| Read/write | Gets or sets a value from the FpcConfigurationStorageServerConnectionType enumerated type that indicates whether connections between array members and a Configuration Storage server are to be authenticated with Active Directory accounts using the MS Firewall Storage protocol or with certificates using the MS Firewall Storage protocol over SSL. |
|
| Read/write | Gets or sets a Boolean value that indicates whether array members will access the primary and alternate Configuration Storage servers over a VPN site-to-site connection. |
|
| Read/write | Gets or sets the time (in minutes) after which an array member will start using the other Configuration Storage server when the current Configuration Storage server is unavailable. |
|
| Read/write | Gets or sets the name of the primary Configuration Storage server for the array. |
|
| Read/write | Gets or sets the time (in minutes) during which the primary Configuration Storage server must be continuously available before an array member will reconnect to it. |
|
| Read/write | Gets or sets the time (in minutes) after which an array member will start testing for connectivity with the primary Configuration Storage server when using the alternate Configuration Storage server. |
|
| Read/write | Gets or sets the name of the name of the securely published Configuration Storage server to be used when array members cannot access the primary and alternate Configuration Storage servers over a VPN site-to-site connection. |
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 IFPCEEConfigurationStorageServerConnection and IFPCConfigurationStorageServerConnection2 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
Build date: 7/12/2010