Share via


FPCPrimaryRoute object

Applies to: desktop apps only

The FPCPrimaryRoute object represents the primary route used to route requests from Web proxy clients. The primary route can be direct to the requested destination, it can include an upstream proxy server, or it can redirect Web proxy client requests to a specified host. If the upstream proxy server on the primary 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 is accessed through the PrimaryRoute property of an FPCRoutingRule object.

Ff825790.bkbutton(en-us,VS.85).png Click here to see the Forefront TMG object hierarchy.

Members

The FPCPrimaryRoute object has these types of members:

  • Methods
  • Properties

Methods

The FPCPrimaryRoute object has these methods.

Method Description
Refresh

Recursively reads all of the properties of the object and of its subobjects from persistent storage, overwriting any changes made after the last call to the Save method.

Save

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

SetAutoPollConfig

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

SetRedirectHostAndPorts

Sets the name of the host for redirecting requests from Web proxy clients and the ports to use.

SetServerAndPort

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

 

Properties

The FPCPrimaryRoute object has these properties.

Property Access type Description

AuthenticationEnabled

Read/write

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

AuthenticationType

Read/write

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 primary route.

AutomaticPollConfig

Read-only

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

BackupRoute

Read-only

Gets an FPCBackupRoute object that represents the backup route, which is used to route Web proxy client requests when the upstream proxy server on the primary route is unavailable.

Credentials

Read-only

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 primary route.

EnableAutoDial

Read/write

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

InspectForMalware

Read/write

Gets or sets a Boolean value that indicates whether content returned in response to requests sent on this route will be inspected for malware if malware inspection is enabled.

PollAtURL

Read-only

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

RedirectHost

Read-only

Gets the name of the host for redirecting requests from Web proxy clients.

RedirectHostPort

Read-only

Gets the port to use for redirecting requests from Web proxy clients to a specified host.

RedirectHostSSLPort

Read-only

Gets the the port to use for redirecting HTTPS requests from Web proxy clients to a specified host.

RouteServerName

Read-only

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

RouteServerPort

Read-only

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

RouteServerSSLPort

Read-only

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

RouteType

Read/write

Gets or sets a value from the FpcPrimaryRouteType enumerated type that specifies whether requests from Web proxy clients are sent directly to the requested destination, to an upstream proxy server, or to a specified host.

 

Interfaces for C++ Programming

This object implements the IFPCPrimaryRoute and IFPCPrimaryRoute2 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