FPCBackupRoute object
Applies to: desktop apps only
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.
.png "Ff824336.bkbutton(en-us,VS.85).png")
Click here to see the Forefront TMG object hierarchy.
Members
The FPCBackupRoute object has these types of members:
- Methods
- Properties
Methods
The FPCBackupRoute object has these 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 has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Gets or sets a Boolean value that indicates whether credentials will be sent for authentication to an upstream proxy server on the backup route. |
|
| 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 backup route. |
|
| 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 backup route is enabled. |
|
| Read/write | 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. |
|
| 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 backup route. |
|
| Read/write | Gets or sets a Boolean value that indicates whether automatic dialing is enabled. |
|
| 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. |
|
| Read-only | 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. |
|
| Read-only | Gets the name of the upstream proxy server on the backup route. |
|
| Read-only | Gets the port to use for routing requests from Web proxy clients to an upstream proxy server on the backup route. |
|
| Read-only | 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 and IFPCBackupRoute2 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
Build date: 7/12/2010