IFPCWebListenerProperties::SingleRadiusServerAuthPerSession property

Applies to: desktop apps only

The SingleRadiusServerAuthPerSession property gets or sets a Boolean value that indicates whether the Forefront TMG Web proxy will validate user credentials with a RADIUS server to authenticate the user only once during a TCP connection or on each request.

This property is read/write.

Syntax

HRESULT put_SingleRadiusServerAuthPerSession(
  [in]   VARIANT_BOOL fRadiusSingleRequest
);

HRESULT get_SingleRadiusServerAuthPerSession(
  [out]  VARIANT_BOOL *pfRadiusSingleRequest
);

' Data type: Boolean

Property SingleRadiusServerAuthPerSession( _
  ByVal fRadiusSingleRequest As VARIANT_BOOL, _
  ByRef pfRadiusSingleRequest As VARIANT_BOOL _
) As Boolean

Property value

Boolean value that indicates whether the Web proxy will validate user credentials with a RADIUS server to authenticate the user only once during a TCP connection.

Error codes

These property methods return S_OK if the call is successful; otherwise, they return an error code.

Remarks

This property is read/write. Its default value is False (VARIANT_FALSE in C++).

When this property is set to True (VARIANT_TRUE in C++), the Web proxy caches the credentials of a user after successful authentication using a RADIUS server and then uses the cached credentials for comparison with the credentials sent in subsequent requests within the same connection instead of sending them to the RADIUS server.

This property cannot be accessed through Forefront TMG Management.

Examples

This VBScript subprocedure sets the SingleRadiusServerAuthPerSession property of the specified Web listener to True or False according to the value passed to it. It does not include error handling.

Sub SetSingleRadiusAuth(listenerName, NewValue)
    ' Declare the other objects needed.
    Dim root           ' The FPCLib.FPC root object
    Dim isaArray       ' An FPCArray object
    Dim listener       ' An FPCNetwork object
    Dim currentValue   ' A Boolean
    ' Create the root object.
    Set root = CreateObject("FPC.Root")
    ' Get references to the array object 
    ' and the Web listener object.
    Set isaArray = root.GetContainingArray()
    Set listener = isaArray.RuleElements.WebListeners.Item(listenerName)
    ' Change the value of the property if necessary.
    currentValue = listener.Properties.SingleRadiusServerAuthPerSession
    WScript.Echo "Current status: " & currentValue
    If newValue <> currentValue Then
        listener.Properties.SingleRadiusServerAuthPerSession = newValue
        WScript.Echo "New status: " & listener.Properties.SingleRadiusServerAuthPerSession
        listener.Save
        WScript.Echo "Done!" 
    End If
End Sub

Requirements

See also

FPCWebListenerProperties

Build date: 7/12/2010