FPC Object

The FPC object is the root of the administration COM object hierarchy, and provides programmatic access to almost all of the other FPC objects. For a diagram of the entire hierarchy, see Forefront TMG Administration Object Model.

Creating this root object is the first step in making any programmatic changes to Forefront TMG. Using Visual Basic, you can create it with the following code:

  Dim root As New FPCLib.FPC

The CreateObject function is also available to Visual Basic programmers, and alternatively, the following can be used:

  Dim root As FPCLib.FPC
  Set root = CreateObject("FPC.Root")

Scripts written in Visual Basic Scripting Edition (VBScript) must use the CreateObject function to create the root object, as in the following code example:

  Dim root  ' This line may be omitted.
  Set root = CreateObject("FPC.Root")

For information about creating the root object in other programming languages, see Creating the Root Forefront TMG Object.

After the FPC object is created, objects below it in the hierarchy can be accessed through the methods and properties of the root object.

After creating an instance of the FPC object and making changes to the properties of any object accessed through it, your code should not impersonate a different user. For example, changes made to the Forefront TMG configuration in one security context cannot be written to persistent storage in a different security context.

For examples of the use of the FPC root object, see Forefront TMG Administration Scripting.

Click here to see the Forefront TMG object hierarchy.

Methods

The FPC object defines the following methods.

Method Description

CanImport

Returns a Boolean value that indicates whether the object's properties can be imported from the specified XML document.

ChangeConroller

Moves the current machine to a new array controller.

ChangeManager

Installs a server certificate for accessing the stored configuration on the local computer.

ConnectToConfigServerPort

Connects to the specified Configuration Storage server on a specific port.

ConnectToConfigurationStorageServer

Connects to the specified Configuration Storage server.

DisconnectFromConfigurationStorageServer

Closes the connection to the Configuration Storage server used for accessing the Forefront TMG configuration.

Export

Recursively writes all of the properties of the object, including all the properties of its subobjects and their elements (for collections), to the specified XML document.

ExportToFile

Recursively writes all of the properties of the object, including all the properties of its subobjects and their elements (for collections), to the specified XML file.

GetContainingArray

Retrieves the FPCArray object that represents the array containing the current computer.

GetContainingServer

Retrieves the FPCServer object that represents the current Forefront TMG computer.

Import

Recursively copies the values of all the properties of the object, including all the properties of its subobjects and their elements (for collections), from the specified XML document to persistent storage.

ImportFromFile

Recursively copies the values of all the properties of the object, including all the properties of its subobjects and their elements (for collections), from the specified XML file to persistent storage.

InstallRootCACertificate

Installs the root CA certificate.

InstallManagementServerCertificate

Installs a server certificate for accessing the stored configuration on the local computer.

InstallStorageServerCertificate

Installs a server certificate on the storage machine.

JoinArray

Joins an array.

LeaveArray

Leaves the specified containing array and becomes a Standalone Server.

LoadDocProperties

Retrieves the OptionalData and Comment properties that are stored in a specified XML document.

Refresh

Recursively reads all the values of the properties of the object, including all the properties of its subobjects and their elements (for collections), from persistent storage, discarding any changes that were not saved.

Save

Recursively writes the current values of all the properties of the object, including all the properties of its sub-objects and their elements (for collections), to persistent storage.

SetAsController

Sets the current machine as the new array controller.

SetAsManager

Sets the local computer as the new array manager.

Properties

The FPC object defines the following properties.

Property Description

Arrays

Gets an FPCArrays collection that contains all the Forefront TMG arrays for the root object.

ConfigurationMode

Gets a value from the FpcConfigurationMode enumerated type that indicates whether the Forefront TMG configuration defines a standalone server, a standalone array, or an enterprise with central array management.

ConfigurationStorageServer

Gets the name of the Configuration Storage server used for accessing the Forefront TMG configuration.

Enterprise

Gets an FPCEnterprise object that represents the Forefront TMG enterprise within the root object (not available in Forefront TMG Medium Business Edition).

IsaEdition

Gets a value from the FpcIsaEditionType enumerated type that indicates the edition of Forefront TMG installed.

Interfaces for C++ Programming

This object implements the IFPC, IFPCEE, IFPC2, and IFPC3 interfaces.

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.


Объявления:

    Cannot connect to Mysql database...