FPCIpOptions object

Applies to: desktop apps only

The FPCIpOptions object enables configuration of the IP options checking mechanism for Forefront TMG. Forefront TMG checks for IP options, which are included in the header of an IP packet. Using this object you can configure whether the mechanism checks for all or some IP options, and whether a packet with those options will be denied.

Forefront TMG has four modes of operation when inspecting the packets for IP options, which are specified by values defined in the FpcIpOptionsAction enumerated type:

• fpcAllowPacketsIpOptions
  A packet is allowed to pass no matter what IP options it may have.

• fpcDenyPacketsIpOptions
  A packet is dropped if it has any IP option.

• fpcAllowPacketsSelectedIpOptions
  Selected IP options are allowed, and a packet is denied if it has an IP option other than those on the list of selected IP options.

• fpcDenyPacketsSelectedIpOptions
  Selected IP options are not allowed, and a packet is dropped if it has any option that is in the list of selected IP options.

This object can be accessed through the IPOptions property of an FPCAttackDetection object.

Click here to see the Forefront TMG object hierarchy.

Inheritance

This object inherits from the FPCPersist object, which contains methods and properties related to the persistent storage of an object's data. They include methods for exporting the object's data to and importing it from an XML document.

Members

The FPCIpOptions object has these types of members:

• Methods
• Properties

Methods

The FPCIpOptions object has these methods.

Method	Description
Clear	Clears the specified IP option.
ClearAll	Clears all of the IP options.
IsSelected	Queries whether the specified IP option is selected.
Select	Selects the specified IP option.
SelectAll	Selects all of the IP options.

 

Properties

The FPCIpOptions object has these properties.

Property	Access type	Description
IPOptionsAction	Read/write	Gets or sets a value from the FpcIpOptionsAction enumerated type that specifies whether packets will be allowed or denied with consideration of the IP options included in them.

 

Methods Inherited from FPCPersist

Name	Description
CancelWaitForChanges	Cancels the registration established by the WaitForChanges method (for use in C and C++ programming only).
CanImport	Returns a Boolean value that indicates whether the object's properties can be imported from the specified XML document.
Export	Writes the stored values of all of the object's properties to the specified XML document.
ExportToFile	Writes the stored values of all of the object's properties to the specified XML file.
GetServiceRestartMask	Retrieves a 32-bit bitmask of the FpcServices enumerated type that specifies which services need to be restarted for currently unsaved changes to take effect.
Import	Copies the values of all of the object's properties from the specified XML document to persistent storage.
ImportFromFile	Copies the values of all of the object's properties from the specified XML file to persistent storage.
LoadDocProperties	Provides the XML document's properties so that you can know what information can be imported from the document.
Refresh	Reads the values of all of the object's properties from persistent storage, overwriting any changes that have not been saved.
Save	Writes the current values of all of the object's properties to persistent storage.
WaitForChanges	Registers to wait for an event indicating that the contents of the object have changed (for use in C and C++ programming only).

 

Properties Inherited from FPCPersist

Name	Description
PersistentName	Gets the persistent name of the object. The persistent name of an object is a name that is unique for the object at the respective level of the COM object hierarchy.
VendorParameterSets	Gets an FPCVendorParametersSets object that can hold sets of custom data for extending the object.

 

Interfaces for C++ Programming

This object implements the IFPCIpOptions interface.

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