MprAdminConnectionRemoveQuarantine function

Article
08/27/2012

Applies to: desktop apps only

The MprAdminConnectionRemoveQuarantine function removes quarantine filters on a dialed-in Remote Access Service (RAS) client if the filters were applied as a result of Internet Authentication Service (IAS) policies.

Syntax

DWORD MprAdminConnectionRemoveQuarantine(
  _In_  HANDLE hRasServer,
  _In_  HANDLE hRasConnection,
  _In_  BOOL fIsIpAddress
);

Parameters

hRasServer [in]
Handle to the RAS server that services the connection. Obtain this handle by calling MprAdminServerConnect.
hRasConnection [in]
Handle to connection for the RAS client for which to remove the quarantine filters. Obtain this handle by calling MprAdminConnectionEnum.

Alternatively, this parameter specifies the IP address of the RAS client for which to remove the quarantine filter. The IP address should be specified as a DWORD in network byte order. Obtain the IP address by calling MprAdminConnectionEnum. If this parameter specifies an IP address, the fIsIpAddress parameter should specify a TRUE value.
fIsIpAddress [in]
Boolean value that indicates whether the hRasConnection parameter specifies the IP address of the client for which to remove the quarantine filters. If this parameter is a TRUE value, hRasConnection specifies an IP address. Otherwise, hRasConnection specifies a handle to a connection.

Return value

NO_ERROR
The function succeeded.
ERROR_INVALID_PARAMETER
The handle to the RAS server or the handle to the RAS connection is invalid.
Other
An error from MprError.h, RasError.h, or WinError.h.

Remarks

The MprAdminConnectionRemoveQuarantine function is used by a custom listener component that you create. This component listens for messages from a notifier component running on quarantine-compatible remote access clients. These messages indicate that the clients have successfully run the scripts that validate that they conform to the requirements of your organization's network policies. When the listener component receives this message from the notifier component running on a client, it calls MprAdminConnectionRemoveQuarantine to remove the quarantine restrictions from the remote access connection. Forefront TMG then chains the call to Routing and Remote Access.

A listener component that calls MprAdminConnectionRemoveQuarantine must be running as under a system administrator account.

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
Library	Vpnplgin.dll

Share via