FPCRadiusServers collection

Applies to: desktop apps only

The FPCRadiusServers collection contains an ordered set of all FPCRadiusServer objects that are defined in a Forefront TMG array. Each FPCRadiusServer object represents a RADIUS server that Forefront TMG can use to perform RADIUS authentication for Web proxy and VPN clients.

When RADIUS authentication is used, the Forefront TMG computer attempts to establish a connection with a RADIUS server defined in the FPCRadiusServers collection in the order defined by the collection.

All the RADIUS servers defined in the FPCRadiusServers collection for an array apply to all rules that allow RADIUS authentication.

This collection is accessed through the RadiusServers property of the FPCRuleElements object.

Click here to see the Forefront TMG object hierarchy.

Inheritance

This collection 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 FPCRadiusServers collection has these types of members:

• Methods
• Properties

Methods

The FPCRadiusServers collection has these methods.

Method	Description
Add	Creates a new FPCRadiusServer object in the collection and returns a reference to it.
Item	Retrieves the requested FPCRadiusServer object from the collection.
MoveDown	Moves the specified server one step down the list of RADIUS servers, which corresponds to the order in which RADIUS servers handle an authentication request.
MoveUp	Moves the specified server one step up the list of RADIUS servers, which corresponds to the order in which RADIUS servers handle an authentication request.
Remove	Removes the specified FPCRadiusServer object from the collection.

 

Properties

The FPCRadiusServers collection has these properties.

Property	Access type	Description
_NewEnum	Read-only	Gets an enumerator object for the collection.
Count	Read-only	Gets the number of FPCRadiusServer objects in the collection.
Retries	Read/write	Gets or sets the number of times each server in the collection retries an authentication request.
UnavailabilityTime	Read/write	Gets or sets the time, in minutes, during which a RADIUS server that failed to respond to retried requests will remain unavailable for subsequent requests.

 

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 properties of the collection and its elements can be imported from the specified XML document.
Export	Writes the stored values of all the properties of the collection and its elements to the specified XML document.
ExportToFile	Writes the stored values of all the properties of the collection and its elements 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	Copies the values of all the properties of the collection and its elements from the specified XML document to persistent storage.
ImportFromFile	Copies the values of all the properties of the collection and its elements 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	Reads the values of all the properties of the collection and its elements from persistent storage, overwriting any changes that have not been saved.
Save	Writes the current values of all the properties of the collection and its elements 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 collection. 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 collection.

 

Interfaces for C++ Programming

This collection implements the IFPCRadiusServers interface.

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