ICIServer Interface

Use the ICIServer interface to manage the Server and access the Server's attributes.

interface ICIServer : IDispatch

Jump to: ARM  B  C  D  E  G  H  I  K  L  LOG  M  P  R  S  SMTP  T  U  W

Dialog Box Equivalents

Members (listed alphabetically)

HRESULT AdminPort([in] long newVal);

HRESULT ARMCommitEventRuleTransferLog([out, retval] DiagLoggingER *pVal);

HRESULT ARMCommitEventRuleTransferLog([in] DiagLoggingER newVal)

EFT v7.4.2 and later

The AvailableSSLVersions property of ICIServer returns an ICISSLVersions object, which is an array of ICISSLVersion objects. The BitFlag property of each ICISSLVersion is the value you would need to include when setting the SSLVersionMask property of ICIServer to enable the use of a particular SSL protocol version.

For example, if you wanted to enable TLS v1, v1.1, and v1.2, the value would be 25:

Protocol Version

Bitwise value

TLSv1

1

TLS v1.1

8

TLS v1.2

16

1 + 8 + 16 = 25

EFT v7.1.1 and later

Retrieves a list of Content Integrity Control profiles. (read only)

ID assigned to the CreateAdmin account.

HRESULT CreateAdminID([in] BSTR bstrLogin, [in] AdminAccountType type, [in] VARIANT_BOOL bGroup, [out, retval] ICIAdminID** ppVal);

EFT v7.2 and later

(See also the ICIContentIntegrityControlActionParams ProfileName property.)

Drain server allows in-progress transfers to continue, and prevents new ones from starting to gracefully drain connections and event rule activity.

HRESULT DrainServer([in] VARIANT_BOOL bRestartServer);

EFT v7.4 and later

Retrieves or specifies whether adding comments to the Event Rule Change log is Off, Mandatory, or Optional.

HRESULT EventRuleChangeLog([out, retval] ERChangeLog *pVal);

HRESULT EventRuleChangeLog([in] ERChangeLog newVal);

EFT v7.2 and later

Retrieves the name of the Content Integrity Control profile.

HRESULT GetHighAvailabilityParams([out, retval] IDispatch** ppDispParams);

HRESULT SetHighAvailabilityParams([in] IDispatch* pDispParams);

EFT v7.0 and later

HRESULT GetIPAccessRules([out, retval] VARIANT *aMasks);

 

See also AddIPAccessRule, RemoveIPAccessRule, MoveIPAccessRule methods, and the following interfaces:

All versions

Retrieve the change log on a Site.

Specify the HA coherence queue. (read only)

Retrieves the path to the HA configuration file. (read only)

Retrieves whether HA is enabled. (read only)

Retrieves the event queue. (read only)

Retrieves multicast address. (read only)

Retrieves multicast port. (read only)

Imports specified PGP key.

EFT v6.1 and later

EFT v7.0 and later

For an example using this property, refer to the ServerStats script in Script Examples.

EFT v6.3 and later

HRESULT LogMode([in] LogMode newVal);

EFT v6.3 and later

For an example using this method, refer to the PGP script in Script Examples.

Changes OpenPGP Keyring settings.

HRESULT SetPGPKeyringSettings([in] BSTR newPublicKeyring,[in] BSTR newPrivateKeyring);

Retrieve OpenPGP Keyring settings with GetPGPKeyringSettings.

Example (VBScript):

oServer.SetPGPKeyringSettings "C:\PGP\pubrign.pgp", "C:\PGP\secring.pgp"

Example (C#):

m_server.ImportSSHKey(@"C:\SSHKey.pub");

object publicPath = new object();

object privatePath = new object();

m_server.GetPGPKeyringSettings(out publicPath, out privatePath);

m_server.SetPGPKeyringSettings(@"C:\filecryptdata\pubring.pgp", @"C:\filecryptdata\secring.pgp");

EFT v6.3 and later

Signs an SSL certificate (Only for PEM format)

HRESULT SignSSLCertificate(

[in] BSTR bstrRequest,

[in] BSTR bstrServCert,

[in] BSTR bstrPrivateKey,

[in] BSTR bstrPass,

[in] BSTR bstrOutCert,

[in] LONG nDays);

EFT v6.3 and later

HRESULT SignSSLCertificateRemotely([in] BSTR bstrRequest, [in] BSTR bstrServCert, [in] BSTR bstrPrivateKey, [in] BSTR bstrPass, [in] BSTR bstrOutCert, [in] LONG nDays);

EFT v7.3.6 and later

All versions

EFT v6.3 and later

EFT v7.0.3 and later

Update the specified Content Integrity Control profile.

EFT v6.3 and later

Dialog Box Equivalents

The ICIServer interface properties and methods correlate to the following fields and controls in the EFT administration interface.

Server Administration Methods and Properties

The illustration of the Server node's Administration tab below is labeled with some of the methods and properties that are available in the ICIServer interface. (Not all methods and properties are represented in the GUIs.)

Administrator Account Security Settings

Server ARM and Log Methods and Properties

The illustration of the Server node's Logs tab below is labeled with some of the methods and properties that are available in the ICIServer interface.

Server General tab Methods and Properties

Server IP Access Rules

Server OpenPGP Keyring Methods and Properties

Server Security Methods and Properties

The ICIServer interface allows you to manage the Server, including the Server's security settings. In the administration interface, you can view/edit these settings on the Server's Security tab.

The illustration of the Server node's Security tab below is labeled with the properties that are available in the ICIServer interface.

Server SMTP Methods and Properties

The ICIServer interface allows you to manage the Server, including the Server's SMTP settings. The illustrations of the Server node's SMTP tab below is labeled with some of the methods and properties that are available in the ICIServer interface.

Server SSH Key Manager Methods and Properties

Server SSL Certificate Settings

The ICIServer interface allows you to manage the Server's SSL Certificate for remote administration connections. In the administration interface, you can access the SSL certificate settings on the Administration tab by clicking Configure next to the Require SSL for remote administration check box.