FPCServer Object

Article
08/13/2010

The FPCServer object represents a single Forefront TMG computer that is associated with a Forefront TMG array. The FPCServer object has multiple properties that are used to set configuration settings. By using this object, you can programmatically access drives, available network adapters, product information, and other generic server attributes such as a server's name and description.

In Forefront TMG Enterprise Edition, this object has additional properties and methods for implementing Network Load Balancing (NLB).

The FPCServer object representing the local Forefront TMG computer can be retrieved using the GetContainingServer method of the FPC object (the root object).

An FPCServer object can be referenced through the FPCRef object held in the following properties:

The AssignedServer property of the FPCVpnNetworkConfiguration object.
The ReportingServicesManagerServer property of the FPCReportingServicesProperties object.
The Server property of the FPCAppliedSSLCertificate object.

The FPCServer object is an element of the FPCServers collection for an array.

Dd436621.bkbutton(en-us,MSDN.10).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.

Methods

The FPCServer object defines the following methods.

Method	Description
ActivateRASServerOnDomain	Adds or removes the server from the RAS and IAS Servers groups on the domain controller.
CanEnableBranchCache	Determines whether BranchCache can be enabled on the server. (This method is introduced in Forefront TMG 2010 SP 1.)
ClearDiagnosticLogging	Clears diagnostic logging on the server.
DrainstopNLB	Drains all remote connections and then stops Network Load Balancing (NLB) on the server (available only in Enterprise Edition).
ExecuteUnscheduledUpdate	Performs an unscheduled update operation.
FlushHostedCache	Deletes all content stored in the Hosted Cache. (This method is introduced in Forefront TMG 2010 SP 1.)
GetAdapterRoutableIpRangeSet	Retrieves an FPCReadOnlyIpRangeSet collection that contains objects representing the routable IP address ranges for the specified network adapter on the server.
GetCacheUtilizationCountersSnapshot	Creates a new instance of the FPCCacheUtilizationCountersSnapshot object and returns a reference to it. (This method is introduced in Forefront TMG 2010 SP 1.)
GetDiagnosticLogging	Retrieves diagnostic logging results on the server.
GetDiagnosticLoggingStatus	Retrieves information about the status of diagnostic logging on the server.
JoinDomain	Joins the server to the specified domain, and restarts the computer to apply the change if requested.
JoinWorkgroup	Joins the server to the specified workgroup using the specified user name and password to detach it from the current domain, and restarts the computer to apply the change if requested.
PopulateArrayStaticRoutes	Adds persistent routes in the server to the array static routes collection.
RestartOS	Restarts the operating system running on the server.
ResumeNLB	Resumes Network Load Balancing (NLB) on the server (available only in Enterprise Edition).
SendRestartNotification	Sends a notification that specific services need to be restarted.
SetPrimaryDNSSuffix	Sets the primary DNS suffix of the computer.
SetServerName	Sets the computer name of the server, and restarts the computer to apply the change if requested.
SetUserNameAndPassword	Sets the server current user name and password.
ShutdownOS	Shuts down the operating system running on the server.
StartDiagnosticLogging	Starts diagnostic logging for the specified component on the server.
StartExchangeEdgeService	Starts the Exchange Edge service on the server.
StartFirewallService	Starts the Microsoft Firewall service on the server.
StartForefrontServerSecurityService	Starts the Forefront Server Security for Exchange service on the server.
StartForefrontSystemMonitoringAgentService	Starts the Forefront Protection Manager Monitoring agent service on the server.
StartIsaDatabaseLogService	Starts the SQL Server Express service on the server.
StartJobSchedulerService	Starts the Microsoft Forefront TMG Job Scheduler service on the server.
StartManagedControlService	Starts the Microsoft Forefront TMG Managed Control service on the server.
StartMSDEService	Starts the Microsoft Data Engine (MSDE) service on the server. (This method is deprecated in Forefront TMG.)
StartNLB	Starts Network Load Balancing (NLB) on the server (available only in Enterprise Edition).
StartRemoteAccessService	Starts the Routing and Remote Access service on the server.
StopDiagnosticLogging	Stops diagnostic logging on the server.
StopExchangeEdgeService	Stops the Exchange Edge service on the server.
StopFirewallService	Stops the Microsoft Firewall service on the server.
StopForefrontServerSecurityService	Stops the Forefront Server Security for Exchange service on the server.
StopForefrontSystemMonitoringAgentService	Stops the Forefront Protection Manager Monitoring agent service on the server.
StopIsaDatabaseLogService	Stops the SQL Server Express service on the server.
StopJobSchedulerService	Stops the Microsoft Forefront TMG Job Scheduler service on the server.
StopManagedControlService	Stops the Microsoft Forefront TMG Managed Control service on the server.
StopMSDEService	Stops the Microsoft Data Engine (MSDE) service on the server. (This method is deprecated in Forefront TMG.)
StopNLB	Stops Network Load Balancing (NLB) on the server (available only in Enterprise Edition).
StopRemoteAccessService	Stops the Routing and Remote Access service on the server.
SuspendNLB	Suspends Network Load Balancing (NLB) on the server (available only in Enterprise Edition).
UpgradeArrayTypeByProgramID	Validates the specified Program ID for the currently installed SKU and sets appropriate properties in the stored configuration.
VPNDisconnect	Disconnects the VPN connection between the specified remote IP address and the server.

Properties

The FPCServer object defines the following properties.

Property	Description
Adapters	Gets an FPCAdapters collection that contains objects representing the available network adapters on the server.
AllAdapters	Gets an FPCAllAdapters collection that contains FPCAdapter objects representing all of the network adapters on the server.
CacheDrives	Gets an FPCCacheDrives collection that contains objects representing the cache drives on the server.
ConnectivityResults	Gets an FPCConnectivityResults collection that contains objects representing the results of attempts to verify connectivity for the server.
CreatedTime	Gets a Date value that specifies the date and time in Coordinated Universal Time (UTC) when the object was created.
CurrentUserName	Gets the name of the user currently logged on to the server.
Description	Gets or sets the description of the server.
DialupNetworkConnections	Gets an FPCDialupNetworkConnections collection that holds the names of the dial-up network connections that have been set up on the server.
DiskDrives	Gets an FPCDiskDrives collection that contains objects representing the disk drives on the server.
DistributionStatus	Gets an FPCEEDistributionStatus object that represents the distribution status of the server.
DomainOrWorkgroupName	Gets the name of the domain or workgroup to which the server belongs.
ExchangeEdgeServiceStatus	Gets a Boolean value that indicates whether the Exchange Edge service is running on the server.
ExternalComponents	Gets an FPCExternalComponents collection that contains objects representing all the Forefront TMG external components installed on the server.
FirewallClientSessionsCount	Gets the number of Forefront TMG Client or Firewall Client sessions running on the server.
FirewallServiceStatus	Gets a Boolean value that indicates whether the Microsoft Firewall service is running on the server.
FirewallServiceUpTime	Gets the number of seconds that the Microsoft Firewall service has been working properly on the server.
ForefrontServerSecurityServiceStatus	Gets a Boolean value that indicates whether the Forefront Server Security for Exchange service is running.
ForefrontSystemMonitoringAgentStatus	Gets a Boolean value that indicates whether the Forefront Protection Manager Monitoring agent service is running.
FQDN	Gets the fully qualified domain name (FQDN) of the server.
HostedCacheServer	Gets an FPCHostedCacheServer object that represents the Hosted Cache server running on the server. (This property is introduced in Forefront TMG 2010 SP 1.)
HostID	Gets or sets the host ID of the server.
InstallationDirectory	Gets the Forefront TMG installation directory on the server.
InstalledApplicationFilters	Gets an FPCRefs collection that contains references to the FPCApplicationFilter objects defining the application filters installed on the server.
InstalledWebFilters	Gets an FPCRefs collection that contains references to the FPCWebFilter objects defining the Web filters installed on the server.
IntermediateCertificates	Gets an FPCCertificates collection that contains objects representing the certificates in the Intermediate Certification Authorities store on the server.
IntraArrayAddress	Gets or sets the IP address of the server for intra-array communication (available only in Enterprise Edition).
IsaDatabaseLogServiceStatus	Gets a Boolean value that indicates whether the SQL Server Express service is running on the server.
IsJoinedToDomain	Gets a Boolean value that indicates whether the server is a member of a domain or a workgroup.
JobSchedulerServiceStatus	Gets a Boolean value that indicates whether the Microsoft Forefront TMG Job Scheduler service is running on the server.
JobSchedulerServiceUpTime	Gets the number of seconds that the Microsoft Forefront TMG Job Scheduler service has been working properly on the server.
LastModifiedTime	Gets a Date value that specifies the date and time in Coordinated Universal Time (UTC) when the object was last modified.
LoadFactor	Gets or sets the load factor for the server.
MachineAccount	Gets the machine account of the server.
ManagedControlServiceStatus	Gets a Boolean value that indicates whether the Microsoft Forefront TMG Managed Control service is running.
ManagementIpOrName	Gets or sets the IP address or computer name that can be used instead of the fully qualified domain name (FQDN) of the server for remote monitoring.
MicrosoftUpdateSetting	Gets a value from the FpcMicrosoftUpdateSetting enumerated type that specifies whether the server will use the Microsoft Update service to check for updates.
MSDEServiceStatus	Gets a Boolean value that indicates whether the Microsoft Data Engine (MSDE) service is running on the server. (This property is deprecated in Forefront TMG.)
Name	Gets the name of the server.
NLBStatus	Gets a value from the FpcNLBStatus enumerated type that indicates the status of Network Load Balancing (NLB) on the Forefront TMG computer (available only in Enterprise Edition).
OperatingSystemMajorVersion	Gets the major version number of the operating system installed on the server.
OperatingSystemMinorVersion	Gets the minor version number of the operating system installed on the server.
OperatingSystemSuiteMask	Gets a bitmask that specifies the product suites available on the server.
PrimaryDNSSuffix	Gets the primary DNS suffix of the computer.
ProductID	Gets the identifier (ID) of the product installed on the server.
ProductVersion	Gets the version of Forefront TMG installed on the server.
QuarantinedVPNConnectionsCount	Gets the number of quarantined VPN connections running on the server.
RemoteAccessServiceStatus	Gets a Boolean value that indicates whether the Routing and Remote Access service is running on the server.
RoutingTable	Gets an FPCRoutingTable collection that represents the routing table of the server.
SecureNATSessionsCount	Gets the number of SecureNAT sessions running on the server.
ServerDomain	Gets the name of the domain to which the server belongs.
ServerStatus	Gets a Boolean value that indicates whether the server is functioning.
ServicePackMajorVersion	Gets the major version number of the latest service pack installed on the server.
ServicePackMinorVersion	Gets the minor version number of the latest service pack installed on the server.
ServiceUpdatesStates	Gets an FPCServiceUpdatesStates collection that contains objects representing the states of the updates obtained from the update services for protection technologies on the server.
SignaledAlerts	Gets the FPCSignaledAlerts collection for the server.
SiteToSiteVPNConnectionsCount	Gets the number of site-to-site VPN connections running on the server.
SmtpProtectionStatus	Gets an FPCSmtpProtectionStatus object that represents the status of SMTP protection on the server.
SqlServerReportingServicesServiceStatus	Gets a Boolean value that indicates whether the SQL Server Reporting Services (ISARS) service is running.
SqlServerServiceStatus	Gets a Boolean value that indicates whether the SQL Server (ISARS) service is running.
SSLAllServerCertificates	Gets an FPCCertificates collection that contains objects representing the Secure Sockets Layer (SSL) certificates available on the server, including the certificates for user and service accounts.
SSLClientCertificates	Gets an FPCCertificates collection that contains objects representing the Secure Sockets Layer (SSL) client certificates available on the server.
SSLServerCertificates	Gets an FPCCertificates collection that contains objects representing the Secure Sockets Layer (SSL) server certificates available on the server.
TrustedRootCertificates	Gets an FPCCertificates collection that contains objects representing the trusted root certificates available on the server.
UseManagementIpOrName	Gets or sets a Boolean value that indicates whether use of an IP address or computer name for remote monitoring is enabled.
VPNConnectionsCount	Gets the number of VPN connections running on the server.
VpnStaticAddressPool	Gets an FPCReadOnlyIpRangeSet collection that contains objects defining the IP address ranges in the static address pool from which the server can assign IP addresses to VPN clients and remote VPN servers connecting to it. (This property is deprecated in Forefront TMG.)
VpnStaticAddressPoolEx	Gets an FPCIpRangeSet collection that contains objects defining the IP address ranges in the static address pool from which the server can assign IP addresses to VPN clients and remote VPN servers connecting to it.
WebProxySessionsCount	Gets the number of Forefront TMG Web proxy sessions running on the server.
WSUSConfigured	Gets a Boolean value that indicates whether the server is configured to receive downloads from Microsoft Update through a WSUS server.

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	Recursively writes the stored values of all the properties of the object and its subobjects to the specified XML document.
ExportToFile	Recursively writes the stored values of all the properties of the object and its subobjects 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	Recursively copies the values of all the properties of the object and of its subobjects from the specified XML document to persistent storage.
ImportFromFile	Recursively copies the values of all the properties of the object and of its subobjects 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	Recursively reads the values of all the properties of the object and of its subobjects from persistent storage, overwriting any changes that have not been saved.
Save	Recursively writes the current values of all the properties of the object and its subobjects 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 collection that can hold sets of custom data for extending the object.

Interfaces for C++ Programming

This object implements the IFPCServer, IFPCEEServer, IFPCServer2, IFPCServer3, IFPCServer4, and IFPCServer5 interfaces.

Requirements

Client	Requires Windows 7 or Windows Vista.
Server	Requires Windows Server 2008 R2 or Windows Server 2008 x64 Edition with SP2.
Version	Requires Forefront Threat Management Gateway (TMG) 2010.
IDL	Declared in Msfpccom.idl.