FPCBackupRoute Object

The FPCBackupRoute object represents the backup route, which is used to route requests from Web proxy clients when the primary route is unavailable. The backup route can be direct to the requested destination, or it can include an upstream proxy server. If the upstream proxy server on the backup route is a member of an array with two or more members, the Web requests can be directed to other members of its array.

This object can also be configured to indicate that there is no backup route.

The FPCBackupRoute object can be accessed through the BackupRoute property of an FPCPrimaryRoute object.

Click here to see the Forefront TMG object hierarchy.

Methods

The FPCBackupRoute object defines the following methods.

Method Description

Refresh

Recursively reads the values of all the properties of the object and of its subobjects from persistent storage, discarding any changes that were not saved.

Save

Recursively writes the current values of all the properties of the object and of its subobjects to persistent storage.

SetAutoPollConfig

Sets the configuration for automatic polling of the upstream proxy server on the backup route for information about the availability of upstream array members.

SetServerAndPort

Sets the name of the upstream proxy server on the backup route and the ports to use.

Properties

The FPCBackupRoute object defines the following properties.

Property Description

AuthenticationEnabled

Gets or sets a Boolean value that indicates whether credentials will be sent for authentication to an upstream proxy server on the backup route.

AuthenticationType

Gets or sets a value from the FpcAuthType enumerated type that specifies the type of authentication to use for establishing a connection with an upstream proxy server on the backup route.

AutomaticPollConfig

Gets a Boolean value that indicates whether polling of the upstream server for information about the availability of upstream array members on the backup route is enabled.

BackupRouteType

Gets or sets a value from the FpcBackupRouteType enumerated type that specifies whether there is a backup route and whether it is direct to the requested destination or includes an upstream proxy server.

Credentials

Gets an FPCCredentials object that represents the credentials to be supplied by the Forefront TMG computer for authenticating a connection to an upstream proxy server on the backup route.

EnableAutoDial

Gets or sets a Boolean value that indicates whether automatic dialing is enabled.

PollAtURL

Gets the URL at which to poll for information about the availability of upstream array members on the backup route. This property is valid only if the AutomaticPollConfig property is set to True.

RouteServerName

Gets the name of the upstream proxy server on the backup route.

RouteServerPort

Gets the port to use for routing requests from Web proxy clients to an upstream proxy server on the backup route.

RouteServerSSLPort

Gets the port to use for routing HTTPS requests from Web proxy clients to an upstream proxy server on the backup route.

Interfaces for C++ Programming

This object implements the IFPCBackupRoute interface.

Requirements

Client Requires Windows Vista or Windows XP.
Server Requires Windows Server 2008.
Version Requires Forefront Threat Management Gateway (TMG).
IDL

Declared in Msfpccom.idl.

See Also

COM Objects


Send comments about this topic to Microsoft

Build date: 11/30/2009

© 2008 Microsoft Corporation. All rights reserved.