Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

FPCServer

Internet Security and Acceleration Server 2004/2006 SDK

The FPCServer object represents a single ISA Server computer that is associated with an ISA Server 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 ISA Server Enterprise Edition, this object has additional properties and methods for implementing Network Load Balancing (NLB) and for performing other administrative tasks.

The FPCServer object representing the local ISA Server 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 FPCServer object is an element of the FPCServers collection for an array.

Click here to see the ISA Server 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.
DrainstopNLB Drains all remote connections and then stops Network Load Balancing (NLB) on the server (available only in Enterprise Edition).
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 (available only in Enterprise Edition).
StartFirewallService Starts the Microsoft Firewall service on the server.
StartJobSchedulerService Starts the Microsoft ISA Server Job Scheduler service on the server.
StartMSDEService Starts the Microsoft Data Engine (MSDE) service on the server.
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.
StopFirewallService Stops the Microsoft Firewall service on the server.
StopJobSchedulerService Stops the Microsoft ISA Server Job Scheduler service on the server.
StopMSDEService Stops the Microsoft Data Engine (MSDE) service on the server.
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).
VPNDisconnect Disconnects the VPN connection between the specified remote IP address and the server.

Properties

The FPCServer object has the following properties.

Property Description
Adapters Gets an FPCAdapters collection that contains objects representing the available 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.
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 FPCDistributionStatus object that represents the distribution status of the server (available only in Enterprise Edition).
FirewallClientSessionsCount Gets the number of 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.
FQDN Gets the fully qualified domain name (FQDN) of the server.
HostID Gets or sets the host ID of the server (available only in Enterprise Edition).
InstallationDirectory Gets the ISA Server 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 (available only in Enterprise Edition).
InstalledWebFilters Gets an FPCRefs collection that contains references to the FPCWebFilter objects defining the Web filters installed on the server (available only in Enterprise Edition).
IntermediateCertificates Gets an FPCCertificates collection that contains objects representing the certificates in the Intermediate Certification Authorities store on the server. (This property is introduced in ISA Server 2006.)
IntraArrayAddress Gets or sets the IP address of the server for intra-array communication (available only in Enterprise Edition).
JobSchedulerServiceStatus Gets a Boolean value that indicates whether the Microsoft ISA Server Job Scheduler service is running on the server.
JobSchedulerServiceUpTime Gets the number of seconds that the Microsoft ISA Server 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.
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 (available only in Enterprise Edition).
MSDEServiceStatus Gets a Boolean value that indicates whether the Microsoft Data Engine (MSDE) service is running on the server.
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 ISA Server 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.
ProductID Gets the identifier (ID) of the product installed on the server.
ProductVersion Gets the version of ISA Server 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.
SecureNATSessionsCount Gets the number of SecureNAT sessions running on the server.
ServerDomain Gets the name of the domain to which the server belongs (available only in Enterprise Edition).
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.
SignaledAlerts Gets the FPCSignaledAlerts collection for the server.
SiteToSiteVPNConnectionsCount Gets the number of site-to-site VPN connections running on the server.
SSLAllServerCertificates Gets an FPCCertificates collection that contains objects representing the Secure Sockets Layer (SSL) server certificates available on the server, including the certificates for user and service accounts. (This property is introduced in ISA Server 2006.)
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 (available only in Enterprise Edition).
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 (available only in Standard Edition).
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 (available only in Enterprise Edition).
WebProxySessionsCount Gets the number of ISA Server Web proxy sessions running on the 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.
VendorParametersSets 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, and IFPCServer2 interface.

Requirements

Client Requires Windows XP.
Server Requires Windows Server 2003. Requires Windows Server 2003 or Windows 2000 for ISA Server 2004 Standard Edition.
Version Requires Internet Security and Acceleration (ISA) Server 2006 or ISA Server 2004.
IDL

Declared in Msfpccom.idl.

See Also

COM Objects

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.