Export (0) Print
Expand All

FPCArray

Internet Security and Acceleration Server 2004/2006 SDK

The FPCArray object defines a single ISA Server array, and its properties provide access to the array-level configuration settings in the hierarchy of administration COM objects for the ISA Server computers associated with it. Each ISA Server computer is associated with a single array.

This object is an element of the FPCArrays collection.

Click here to see the ISA Server object hierarchy.

In ISA Server Standard Edition, there is only one FPCArray object in the FPCArrays collection, and it provides access to the registry-based configuration settings of only a single ISA Server computer.

In ISA Server Enterprise Edition, multiple ISA Server computers can be associated with a single array, and additional arrays can be created using the Add method of the FPCArrays collection. The configuration settings for the arrays in an enterprise are stored on a Configuration Storage server. A group of ISA Server computers that are associated with the same array can be managed as a single, logical entity and can provide distributed caching, load balancing, and fault tolerance.

The way in which an FPCArray object is retrieved depends on the edition of ISA Server that is installed on the computer on which the code is being executed and on the components of ISA Server that are installed and running on it. For information about retrieving an FPCArray object after creating the root object, see Retrieving an Array Object.

For examples that use the FPCArray object, see ISA Server Administration Scripting.

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 FPCArray object defines the following methods.

Method Description
CopyElementsIntoEnterprise Copies specified array rule elements into the enterprise configuration (available only in Enterprise Edition).
RestartServices Restarts the services specified in a bitmask of the FpcServices enumerated type and any services that depend on them.
SelectNetworkTemplateAndPolicy Sets a selected network template and default policy for the array.

Properties

The FPCArray object has the following properties.

Property Description
AdminSecurity Gets an FPCAdminSecurity object that holds the administration security settings for the array.
AdminVersionMajor Gets the major version number of the schema of the array.
AdminVersionMinor Gets the minor version number of the schema of the array.
Alerts Gets an FPCAlerts collection that contains objects defining all the alerts in the array.
ArrayPolicy Gets an FPCArrayPolicy object that specifies the array policy for the array.
Cache Gets an FPCCache object that provides access to the cache configuration settings for the array and to a method for downloading content to the cache.
CompatibilityVersion Gets or sets a value from the FpcCompatibilityVersion enumerated type that specifies the minimum version of an object or of ISA Server Management that may access the configuration settings of the array. (This property is introduced in ISA Server 2006.).
Components Gets a set of flags indicating the components that are installed in the array.
ConfigurationStorageServerConnection Gets an FPCConfigurationStorageServerConnection object that represents the connection to the Configuration Storage server for the array (available only in Enterprise Edition).
ConnectivityVerifiers Gets an FPCConnectivityVerifiers collection that contains objects defining all the connectivity verifiers for the array.
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 array in the form of a string.
DNSName Gets or sets the DNS name of the array (available only in Enterprise Edition).
Extensions Gets an FPCExtensions object that represents the set of application filters and Web filters for the array.
FWClientConfigSettings Gets an FPCClientConfigSettings collection that contains the Firewall client settings for the array.
IntraArrayCredentials Gets an FPCCredentials object that represents the credentials to be used by array members for authenticating intra-array communication (available only in Enterprise Edition).
LastModifiedTime Gets a Date value that specifies the date and time in Coordinated Universal Time (UTC) when the array was modified.
Logging Gets an FPCLogs collection that contains objects defining all the logging configurations for the array.
LogViewer Gets an FPCLogViewer object that represents the log viewer for the array.
MailCodePage Gets or sets the mail code page of the array.
Name Gets or sets the name of the array.
NetworkConfiguration Gets an FPCNetworkConfiguration object that holds all the network configuration settings for the array.
NetworkTemplateUsed Gets an FPCRef object that references the FPCNetworkTemplate object defining the network template used by the array.
PolicyAssignment Gets an FPCPolicyAssignment object that specifies the enterprise policy assigned to the array and some configuration settings that determine how the enterprise policy is applied in the array (available only in Enterprise Edition).
Reports Gets an FPCReports object that holds the ready reports, report jobs, and summary report configuration for the array.
RuleElements Gets an FPCRuleElements object that provides access to collections of rule elements for the array.
Servers Gets an FPCServers collection that contains objects representing all the ISA Server computers in the array.
SessionsMonitors Gets an FPCSessionsMonitors object that provides access to the firewall and the ISA Server Web proxy session monitors for the array.
SystemPolicy Gets an FPCSystemPolicy object that holds the system policy information for the array.
Type Gets a value from the FpcArrayType enumerated type that indicates whether the array consists of a single ISA Server computer or may contain multiple servers.
UseComputerAccountForIntraArrayAuthentication Gets or sets a Boolean value that indicates whether the computer accounts of the array members will be used for authenticating intra-array communication (available only in Enterprise Edition).

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 IFPCArray and IFPCArray2 interfaces. In Enterprise Edition, this object also implements the IFPCEEArray 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

Show:
© 2014 Microsoft