Share via


FPCSipSettings object

Applies to: desktop apps only

The FPCSipSettings object represents the SIP settings for a Forefront TMG array. These settings determine how the array members protect an Internet Protocol Private Branch Exchange (IP PBX) that uses the SIP protocol.

The FPCSipSettings object is accessed through the SipSettings property of the FPCArrayPolicy object.

Ff826523.bkbutton(en-us,VS.85).png 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 FPCSipSettings object has these types of members:

  • Properties

Properties

The FPCSipSettings object has these properties.

Property Access type Description

ExternalRegistrationBasePort

Read/write

Gets or sets the base port for SIP external registration after the default port.

ExternalRegistrationEnabled

Read/write

Gets or sets a Boolean value that indicates whether internal SIP clients may register externally.

ExternalRegistrationIPAddress

Read/write

Gets or sets the IP address for external registration.

ExternalRegistrationPort

Read/write

Gets or sets the default external registration port for SIP.

MaxAllowedRegistrationExpiration

Read/write

Gets or sets the maximum allowed registration expiration time, in seconds.

MaxCallsPerIP

Read/write

Gets or sets the maximum number of calls for a specific IP address.

MaxGlobalCalls

Read/write

Gets or sets the global maximum number of calls on the SIP filter.

MaxGlobalRegistrations

Read/write

Gets or sets the global maximum number of registrations on the SIP filter.

MaxRegistrationsPerIP

Read/write

Gets or sets the maximum number of registrations for a specific IP address.

MinAllowedMediaPortInSDP

Read/write

Gets or sets the minimum allowed media stream port in SDP session descriptors.

NumExternalRegistrationPorts

Read/write

Gets or sets the number of registration ports for SIP in addition to the default port.

 

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 IFPCSipSettings 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