FPCRadiusServer object

Applies to: desktop apps only

The FPCRadiusServer object represents a RADIUS server that Forefront TMG can use to perform RADIUS authentication for Web proxy and VPN clients. For more information about RADIUS servers, see RADIUS Authentication and Accounting.

This object is created as an element of an FPCRadiusServers collection. All the RADIUS servers defined in the FPCRadiusServers collection for an array apply to all rules that allow RADIUS authentication.

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 FPCRadiusServer object has these types of members:

• Properties

Properties

The FPCRadiusServer object has these properties.

Property	Access type	Description
AccountingPort	Read/write	Gets or sets the accounting port for connecting to the RADIUS server.
AlwaysUseMessageAuthenticator	Read-only	Gets a Boolean value that indicates whether a message authenticator based on the shared secret is sent with every message sent to the RADIUS server.
ConnectionTimeout	Read/write	Gets or sets the amount of time, in seconds, that Forefront TMG will wait for a response from the RADIUS server before trying the next RADIUS server.
Description	Read/write	Gets or sets the description of the RADIUS server.
Name	Read/write	Gets or sets the name of the RADIUS server.
Order	Read-only	Gets the ordinal position of the RADIUS server in the list of RADIUS servers, which corresponds to the order in which the RADIUS servers handle an authentication request.
Port	Read/write	Gets or sets the port for connecting with the RADIUS server.
SharedSecret	Write-only	Sets the shared secret that is used to create digital signatures for authenticating to the RADIUS server.
UsedForAccounting	Read/write	Gets or sets a Boolean value that indicates whether the RADIUS server is used for accounting.
UsedForAuthentication	Read/write	Gets or sets a Boolean value that indicates whether the RADIUS server is used for authentication.

 

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	Writes the stored values of all of the object's properties to the specified XML document.
ExportToFile	Writes the stored values of all of the object's properties 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 of the object's properties from the specified XML document to persistent storage.
ImportFromFile	Copies the values of all of the object's properties 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 of the object's properties from persistent storage, overwriting any changes that have not been saved.
Save	Writes the current values of all of the object's properties 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 object that can hold sets of custom data for extending the object.

 

Interfaces for C++ Programming

This object implements the IFPCRadiusServer and IFPCRadiusServer2 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