|
This online help file is for EFT Server version 6.2.x. For other versions of EFT Server, please refer to http://help.globalscape.com/help/index.html. (If the Index and Contents are hidden, click Show Contents pane in the top left corner of this topic.) |
The tables below list each of the interfaces, methods, and properties used in Secure FTP Server, EFT Server, and EFT Server Enterprise. The Applicable Version column indicates in which product and version number the interface, method, or property is available. In most cases, the interface, method, or property applies to both EFT Server and Secure FTP Server, all versions.
|
The interfaces are listed alphabetically below. For an alphabetized list of each property and method, refer to the Index. |
List of Interfaces Show
The Action Statement interface members are listed below. For details of how to use them in scripts, refer to Action Statement Interface.
Members |
Applicable Version |
type |
EFT Server v5.2 and later |
Action |
|
FailSection |
The Action Statements interface members are listed below. For details of how to use them in scripts, refer to Action Statements Interface.
Members |
Applicable Version |
Add |
EFT Server v5.2 and later |
Count |
EFT Server v5.2 and later |
Delete |
EFT Server v5.2 and later |
Item |
EFT Server v5.2 and later |
The AS2 Send Action Parameters interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.
The Audit interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.
Members |
How It's Used |
Applicable Version |
AuditSATEmail |
EFT Server v6.0 and later |
|
AuditSATFile |
EFT Server v6.0 and later |
|
AuditSATTransaction |
EFT Server v6.0 and later |
The Automated Workflow Task Event Action Parameters interface members is listed below. For details of how to use it in scripts, refer to Automated Workflow Task Event Action Parameters Interface.
Members |
Applicable Version |
TaskName |
EFT Server v6.1 and later |
The Backup Action Parameters members is listed below. For details of how to use it in scripts, refer to Backup Action Parameters.
Members |
Applicable Version |
Folder |
EFT Server v6.1 and later |
The Certificate Information interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.
Members |
How It's Used |
Applicable Version |
Description |
All versions |
|
ID |
All versions |
|
IssuerCName |
All versions |
|
IssuerCountry |
All versions |
|
IssuerOneLine |
All versions |
|
IssuerOrg |
All versions |
|
IssuerUnit |
All versions |
|
NotAfter |
All versions |
|
NotBefore |
All versions |
|
SubjectCName |
All versions |
|
SubjectCountry |
All versions |
|
SubjectOneLine |
All versions |
|
SubjectOrg |
All versions |
|
SubjectUnit |
All versions |
The Cleanup Action Parameters interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.
Members |
How it's used |
Applicable Version |
DaysToKeepFiles |
Retrieving or Changing the Period to Keep Files before Removing |
EFT Server v5.2 and later |
ExcludeFileMask |
EFT Server v5.2 and later |
|
FileMask |
EFT Server v5.2 and later |
|
Folder |
EFT Server v5.2 and later |
|
Recursive |
EFT Server v5.2 and later |
The Client Settings interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.
Members |
How It's Used |
Applicable Version |
AddIPAccessRule |
EFT Server v5.1.1 and later |
|
Comment |
All versions |
|
Custom1, Custom2, Custom3 |
EFT Server v5.0.1 and later |
|
All versions |
||
Fax |
All versions |
|
ForcePasswordChange |
EFT Server v6.0 and later |
|
FullName |
All versions |
|
GetAllowAnyPwd |
EFT Server v6.0.1 and earlier |
|
GetAllowedMasks |
EFT Server v5.1.1 and later |
|
GetAllowMODEZ |
All versions |
|
GetAllowNoop |
All versions |
|
GetAllowXCRC |
All versions |
|
GetAnonymousLogin |
EFT Server v6.0.1 and earlier |
|
GetAppletEnabled |
EFT Server v3.5.1 and later |
|
GetChangePwd |
All versions |
|
GetClearFTP |
All versions |
|
GetClearHTTP |
EFT Server v4.3.4 and EFT Server v5.1 |
|
GetDeniedMasks |
EFT Server v5.1.1 and later |
|
GetDescription |
All versions |
|
GetDownloadsPerSession |
All versions |
|
GetEnableAccount |
Determining if a User Account or User Settings Level is Enabled |
All versions |
GetEnableDiskQuota |
All versions |
|
GetEnableTimeOut |
All versions |
|
GetExpirationDate |
All versions |
|
GetExpirationDateAsVariant |
EFT Server v4.3.4 and later |
|
GetForcePasswordResetOnInitialLogin |
EFT Server v6.2 and later |
|
GetFTPS |
EFT Server v6.0 and later |
|
GetHasDownloadsPerSession |
All versions |
|
GetHasMaxDownloadSize |
All versions |
|
GetHasMaxIPs |
All versions |
|
GetHasMaxSpeed |
All versions |
|
GetHasMaxUploadSize |
All versions |
|
GetHasMaxUsers |
Determining if the Number of Concurrent Connections is Limited for Users |
All versions |
GetHasPwdRetries |
All versions |
|
GetHasUploadsPerSession |
All versions |
|
GetHomeDir |
All versions |
|
GetHomeDirIsRoot |
Determining if the Account Home Folder is the Default Root Folder |
All versions |
GetHomeDirString |
All versions |
|
GetHomeIP |
Determining if Users are Restricted to a Specific IP Address |
EFT Server v6.0.x and earlier |
GetHomeIPString |
EFT Server v6.0.x and earlier |
|
GetHTTPS |
EFT Server v6.0 and later |
|
GetIncorrectPasswordAttempts |
All versions |
|
GetLimitAccessByIP |
EFT Server v6.1 and later |
|
GetLimitLoginAttempts |
EFT Server v5.1.1 and later |
|
GetLockoutNotDisable |
EFT Server v5.1.1 and later |
|
GetLoginMsg |
All versions |
|
GetLoginMsgString |
All versions |
|
GetMaxDownloadSize |
All versions |
|
GetMaxIPs |
Determining Number of Connections Allowed from the Same IP Address |
All versions |
GetMaxSpace |
All versions |
|
GetMaxSpeed |
All versions |
|
GetMaxUploadSize |
All versions |
|
GetMaxUsers |
Determining the Maximum Concurrent Connections Allowed per User |
All versions |
GetPwdRetries |
All versions |
|
GetSFTP |
All versions |
|
GetSFTPAuthenticationType |
All versions |
|
GetSSHKeyID |
All versions |
|
GetSSL |
EFT Server v5.2 and earlier |
|
GetSSLAuthenticationType |
EFT Server v5.1 and later |
|
GetSSLKeyID |
EFT Server v5.1 and later |
|
GetTimeOut |
All versions |
|
GetUploadsPerSession |
All versions |
|
GetUsedSpace |
All versions |
|
InvalidAttemptsPeriod |
EFT Server v5.1.1 and later |
|
IPAccessAllowedDefault |
IP addresses with which a user is allowed to connect to the Server |
EFT Server v5.1.1 and later |
IsActivityPeriodLimited |
Determining whether a User Account's Inactivity Period is Limited |
EFT Server v6.1 and later |
IsPasswordAgeLimited |
EFT Server v6.1 and later |
|
LockoutPeriod |
EFT Server v5.1.1 and later |
|
MaxInvalidLoginAttempts |
Viewing the Number of Invalid Login Attempts Allowed for a Client |
EFT Server v5.1.1 and later |
Pager |
All versions |
|
Phone |
All versions |
|
RemoveIPAccessRule |
EFT Server v5.1.1 and later |
|
SetAllowAnyPwd |
EFT Server v6.0.1 and earlier |
|
SetAllowMODEZ |
All versions |
|
SetAllowNoop |
All versions |
|
SetAllowXCRC |
All versions |
|
SetAnonymousLogin |
EFT Server v6.0.1 and earlier |
|
SetAppletEnabled |
EFT Server v3.5.1 and later |
|
SetChangePwd |
All versions |
|
SetClearFTP |
All versions |
|
SetClearHTTP |
EFT Server v4.3.4 and EFT Server v5.1 and later |
|
SetDescription |
All versions |
|
SetDownloadsPerSession |
Specifying the Maximum Number of Downloads a User is Permitted per Session |
All versions |
SetEnableAccount |
All versions |
|
SetEnableDiskQuota |
All versions |
|
SetEnableTimeOut |
All versions |
|
SetExpirationDate |
All versions |
|
SetForcePasswordResetOnInitialLogin |
EFT Server v6.2 and later |
|
SetFTPS |
EFT Server v6.x and later |
|
SetHasDownloadsPerSession |
All versions |
|
SetHasMaxDownloadSize |
All versions |
|
SetHasMaxIPs |
All versions |
|
SetHasMaxSpeed |
All versions |
|
SetHasMaxUploadSize |
All versions |
|
SetHasMaxUsers |
All versions |
|
SetHasPwdRetries |
All versions |
|
SetHasUploadsPerSession |
All versions |
|
SetHomeDir |
All versions |
|
SetHomeDirIsRoot |
All versions |
|
SetHomeDirString |
All versions |
|
SetHomeIP |
EFT Server v6.0.x and earlier |
|
SetHomeIPString |
EFT Server v6.0.x and earlier |
|
SetHTTPS |
EFT Server v6.x and later |
|
SetIncorrectPasswordAttempts |
All versions prior to 6.1 |
|
SetLimitAccessByIP |
EFT Server v6.1 and later |
|
SetLimitLoginAttempts |
EFT Server v5.1.1 and later |
|
SetLockoutNotDisable |
EFT Server v5.1.1 and later |
|
SetLoginMsg |
All versions |
|
SetLoginMsgString |
All versions |
|
SetMaxDownloadSize |
Specifying the Maximum File Size a User is Permitted to Download |
All versions |
SetMaxIPs |
All versions |
|
SetMaxSpace |
All versions |
|
SetMaxSpeed |
All versions |
|
SetMaxUploadSize |
Specifying the Maximum File Size a User is Permitted to Upload |
All versions |
SetMaxUsers |
All versions |
|
SetPwdRetries |
All versions |
|
SetSFTP |
All versions |
|
SetSftpAuthenticationType |
All versions |
|
SetSSHKeyID |
All versions |
|
SetSSL |
EFT Server v5.2 and earlier |
|
SetSSLAuthenticationType |
EFT Server v5.1 and later |
|
SetSSLKeyID |
EFT Server v5.1 and later |
|
SetTimeOut |
All versions |
|
SetUploadsPerSession |
Specifying the Maximum Number of Uploads a User is Permitted per Session |
All versions |
The Command Action Parameters interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.
Members |
How it's used |
Applicable Version |
Command |
EFT Server v5.2 and later |
|
Parameters |
EFT Server v5.2 and later |
|
WorkingFolder |
EFT Server v5.2 and later |
The Command Settings interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.
Members |
How It's Used |
Applicable Version |
AddUserPermission |
All versions |
|
Description |
All versions |
|
EnableProcessTimeOut |
All versions |
|
Executable |
Retrieving or Changing the Path to the Executable of a Custom Command |
All versions |
GetUserPermissions |
All versions |
|
IsEnabled |
All versions |
|
LogPath |
EFT Server v6.1 and later |
|
MinNumOfParams |
Requiring a Minimum Number of Parameters for Custom Commands |
All versions |
MinNumOfParamsMsg |
Defining or Changing a Message for an Invalid Number of Command Parameters |
All versions |
Name |
All versions |
|
Parameters |
All versions |
|
ProcessTimeOut |
All versions |
|
RedirectOutputToClient |
All versions |
|
RedirectOutputToLog |
All versions |
|
RemoveUserPermission |
All versions |
|
RequireParams |
All versions |
The Compound Condition interface members are listed below. For details of how to use them in scripts, refer to Compound Condition Interface.
Members |
Applicable Version |
Add |
EFT Server v5.2 and later |
Count |
EFT Server v5.2 and later |
Delete |
EFT Server v5.2 and later |
Item |
EFT Server v5.2 and later |
Operator |
EFT Server v5.2 and later |
The Download Action Parameters interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.
Members |
How it's used |
Applicable Version |
AutoLogin |
EFT Server v5.25 and later |
|
ConnectionRetryAttempts |
EFT Server v6.2.10 and later |
|
ConnectionTimeoutSeconds |
EFT Server v6.2.10 and later |
|
DeleteSourceFile |
EFT Server v5.25 and later |
|
FTPDataConnectionMode |
EFT Server v6.2.10 and later |
|
FTPDataConnectionPortMax |
EFT Server v6.2.10 and later |
|
FTPDataConnectionPortMin |
EFT Server v6.2.10 and later |
|
FTPSClearCommandChannel |
EFT Server v6.2.10 and later |
|
FTPSClearDataChannel |
EFT Server v6.2.10 and later |
|
Host |
EFT Server v5.25 and later |
|
LocalPath |
EFT Server v5.25 and later |
|
MaxConcurrentThreads |
EFT Server v6.210 and later |
|
Password |
EFT Server v5.25 and later |
|
Port |
EFT Server v5.25 and later |
|
PreserveFileTime |
EFT Server v6.2.10 and later |
|
PrivateKeyPassword |
EFT Server v5.25 and later |
|
PrivateKeyPath |
EFT Server v5.25 and later |
|
Protocol |
EFT Server v5.25 and later |
|
PublicKeyPath |
EFT Server v5.25 and later |
|
RemotePath |
EFT Server v5.25 and later |
|
RetryDelaySeconds |
EFT Server v6.2.10 and later |
|
TextFileTypes |
EFT Server v6.2.10 and later |
|
User |
EFT Server v5.25 and later |
|
ValidateIntegrity |
EFT Server v6.2.10 and later |
The Event Action interface members are listed below. For details of how to use them in scripts, refer to Event Action Interface.
Members |
Applicable Version |
GetParams |
EFT Server v6.1 and later |
Params |
EFT Server v5.2 - 6.0.x |
SetParams |
EFT Server v6.1 and later |
type |
EFT Server v5.2 - 6.0.x |
The Event Actions interface members are listed below. For details of how to use them in scripts, refer to Event Actions Interface Methods.
Members |
Applicable Version |
Add |
EFT Server v5.2 and later |
Count |
|
Delete |
|
Item |
|
The Event Information interface members are listed below. For details of how to use them in scripts, refer to Event Information Interface.
Members |
Applicable Version |
Name |
EFT Server v6.1 and later |
Type |
|
The Event Rule Interface members are listed below. For details of how to use them in scripts, refer to Event Rule Interface.
Members |
Applicable Version |
AddActionStatement |
EFT Server v5.2 and later |
AddIfStatement |
EFT Server v5.2 and later |
DeleteStatement |
EFT Server v5.2 and later |
GetParams |
EFT Server v6.2 and later |
Set Params |
EFT Server v6.2 and later |
Params |
EFT Server v5.2 - 6.1.x |
Statement |
EFT Server v5.2 and later |
StatementsCount |
EFT Server v5.2 and later |
The Event Rule Parameters interface members are listed below. For details of how to use them in scripts, refer to Event Rule Parameters Interface.
Members |
Applicable Version |
Description |
EFT Server v5.2 and later |
Enabled |
|
Name |
|
The Event Rules interface members are listed below. For details of how to use them in scripts, refer to Event Rules Interface.
Members |
Applicable Version |
Add |
EFT Server v5.2 and later |
Count |
|
Delete |
|
Find |
|
Item |
|
The Folder Monitor Event Rule Parameters members are listed below. For details of how to use them in scripts, refer to Folder Monitor Event Rule Parameters Interface.
Members |
Applicable Version |
CheckHealth |
EFT Server v5.2 and later |
CheckHealthInterval |
EFT Server v5.2 and later |
Description |
EFT Server v5.2 and later |
Enabled |
EFT Server v5.2 and later |
ForcedlyDisabled |
EFT Server v5.2.4 and prior |
IncludeSubfolders |
EFT Server v5.2 and later |
Name |
EFT Server v5.2 and later |
Path |
EFT Server v5.2 and later |
The If Statement Interface members are listed below. For details of how to use them in scripts, refer to If Statement Interface.
Members |
Applicable Version |
Condition |
EFT Server v5.2 and later |
ElseSection |
EFT Server v5.2 and later |
IfSection |
EFT Server v5.2 and later |
type |
EFT Server v5.2 and later |
The Mail Action Parameters interface members are listed below. For details of how to use the properties in scripts, refer to the links in the table.
Members |
How it's used |
Applicable Version |
CCAddresses |
EFT Server v5.2 and later |
|
BCCAddresses |
EFT Server v5.2 and later |
|
Body |
EFT Server v5.2 and later |
|
CopyToClient |
Determining whether to CC Message to Client Associated with Event |
EFT Server v5.2 and later |
Subject |
EFT Server v5.2 and later |
|
TOAddresses |
EFT Server v5.2 and later |
The OpenPGP Action Parameters interface members are listed below. For details of how to use the properties in scripts, refer to the links in the table.
Members |
How it's used |
Applicable Version |
ASCIIArmoredOutput |
Specifying or Retrieving PGP Action Output Encoded in Text Format |
EFT Server v6.1 and later |
CompressionLevel |
Specifying or Retrieving Compression Level for PGP Encryption Operation |
EFT Server v6.1 and later |
FilePath |
EFT Server v5.2 and later |
|
KeyIDs |
EFT Server v5.2 and later |
|
Operation |
EFT Server v5.2 and later |
|
PassPhrase |
Retrieving or Changing the Passphrase for Signing or Decryption Key |
EFT Server v5.2 and later |
SDAPassword |
EFT Server v6.1 and later |
|
Sign |
EFT Server v5.2 - 6.0.x |
|
SignatureInSeparateFile |
Specifying or Retrieving whether Signature will be Placed in Separate File |
EFT Server v6.1 and later |
SigningHash |
EFT Server v6.1 and later |
|
SignKeyID |
EFT Server v5.2 and later |
The OpenPGP Key Information interface members are listed below. For details of how to use the properties in scripts, refer to the links in the table.
Members |
Applicable Version |
| CreationDate | EFT Server v6.1 and later |
| Description | EFT Server v6.1 and later |
| ExpirationDate | EFT Server v6.1 and later |
| ID | EFT Server v6.1 and later |
| Name | EFT Server v6.1 and later |
| NeverExpires | EFT Server v6.1 and later |
| Private | EFT Server v6.1 and later |
| Size | EFT Server v6.1 and later |
The Permission interface members are listed below. For details of how to use them in scripts, refer to the links in the table below.
Members |
How It's Used |
Applicable Version |
Client |
All versions |
|
DirCreate |
All versions |
|
DirDelete |
All versions |
|
DirList |
All versions |
|
DirShowHidden |
All versions |
|
DirShowInList |
All versions |
|
DirShowReadOnly |
All versions |
|
FileAppend |
All versions |
|
FileDelete |
All versions |
|
FileDownload |
All versions |
|
FileRename |
All versions |
|
FileUpload |
All versions |
|
Folder |
All versions |
The Report Action Parameters members are listed below. For details of how to use the properties in scripts, refer to Report Action Parameters Interface.
Members |
Applicable Version |
CustomDate |
EFT Server v5.2 and later |
DateFormat |
EFT Server v5.2 and later |
FilterAndOr |
EFT Server v5.2 and later |
FilterField1 |
EFT Server v5.2 and later |
FilterField2 |
EFT Server v5.2 and later |
FilterOperator1 |
EFT Server v5.2 and later |
FilterOperator2 |
EFT Server v5.2 and later |
FilterValue1 |
EFT Server v5.2 and later |
FilterValue2 |
EFT Server v5.2 and later |
FromDate |
EFT Server v5.2 and later |
Name |
EFT Server v5.2 - 6.0.x (This information now can be set/retrieved via ICIReportInfo::Name.) |
OptionalParameters |
EFT Server v5.2 and later |
Path |
EFT Server v5.2 - 6.0.x (This information now can be set/retrieved via ICIReportInfo::DefinitionPath.) |
Report |
EFT Server v6.1 and later |
ReportFileFormat |
EFT Server v5.2 and later |
ToDate |
EFT Server v5.2 and later |
The Report Information interface members are listed below. For details of how to use them in scripts, refer to Report Information Interface.
Members |
Applicable Version |
Name |
EFT Server v6.1 and later |
DefinitionPath |
The Server interface members are listed below. For details of how to use the properties in scripts, refer to the links in the table below.
Members |
How It's Used |
Applicable Version |
AddIPAccessRule |
All versions |
|
AdminPort |
All versions |
|
AllowClearCommandChannel |
EFT Server v5.0.1 and later |
|
AllowRemoteAdministration |
All versions |
|
AllowUnprotectedDataChannel |
EFT Server v5.0.1 and later |
|
ApplyChanges |
Versions prior to EFT Server v5.0 |
|
AreLingeringTransactions |
EFT Server v5.2 to 6.0.x |
|
ARMDatabaseName |
All versions |
|
ARMPassword |
All versions |
|
ARMServerName |
All versions |
|
ARMUserName |
All versions |
|
Auditor |
EFT Server v6.0 and later |
|
AutoSave |
EFT Server v6.2.18 and later |
|
AvailableEvents |
EFT Server v6.1 and later |
|
AvailablePGPKeys |
EFT Server v6.1 and later |
|
AvailableReports |
EFT Server v6.1 and later |
|
AvailableSSHKeys |
EFT Server v6.1 and later |
|
CertificateFilePath |
All versions |
|
ChangeAdminPassword |
EFT Server 4.3.4 and later |
|
CipherList |
EFT Server v5.0.1 and later |
|
Close |
All versions |
|
Connect |
All versions |
|
ConnectedUsersNumber |
EFT Server 3.5.1 and later |
|
ConnectEx |
EFT Server v6.2 and later |
|
EnableARM |
All versions |
|
GenerateReport |
EFT Server v6.1 and later |
|
GetAdminIPs |
EFT Server v4.3.4 and later |
|
GetAllowedMasks |
All versions |
|
GetDeniedMasks |
All versions |
|
GetLocalIP |
All versions |
|
GetLocalTime |
All versions |
|
GetServerAdminCount |
Retrieving the Number of Server Administrator Accounts on the Server |
EFT Server v4.3.4 and later |
ImportSSHKey |
EFT Server v6.1 and later |
|
IPAccessAllowedDefault |
All versions |
|
IsDBConnected |
EFT Server v5.2 - 6.0.x |
|
KeyFilePath |
All versions |
|
ListenIP |
All versions |
|
LogPath |
All versions |
|
LogRotation |
All versions |
|
LogType |
All versions |
|
ModuleRegistrationState |
EFT Server v6.1 and later |
|
PassPhrase |
All versions |
|
RefreshSettings |
All versions |
|
RemoveIPAccessRule |
All versions |
|
RemoveServerAdminAccount |
EFT Server 4.3.4 and later |
|
RemoveSSHKey |
EFT Server v6.1 and later |
|
SetSSLCertificate |
EFT Server v6.1 and later |
|
Sites |
All versions |
|
SMTPLogin |
All versions |
|
SMTPPassword |
All versions |
|
SMTPPort |
All versions |
|
SMTPRecipientAddr |
All versions |
|
SMTPRecipientName |
All versions |
|
SMTPSenderAddr |
All versions |
|
SMTPSenderName |
All versions |
|
SMTPServer |
All versions |
|
SSLVersionMask |
EFT Server v5.0.1 and later |
|
UseSSLForAdministration |
All versions |
The Simple Condition Interface members are listed below. For details of how to use the properties in scripts, refer to Simple Condition Interface.
Members |
Applicable Version |
Not |
EFT Server v5.2 and later |
Operator |
EFT Server v5.2 and later |
Property |
EFT Server v5.2 and later |
Value |
EFT Server v5.2 and later |
The Site Interface members are listed below. For details of how to use the properties in scripts, refer to the links in the table below.
Members |
How It's Used |
Applicable Version |
AddCerficateToTrusted |
All versions |
|
AddIPAccessRule |
All versions |
|
AddUserToPermissionGroup |
All versions |
|
AllowChangePassword |
Retrieving or Specifying if Site Users are Allowed to Change Password |
EFT Server v6.2 and later |
AssignEventRuleCustomCommandWorkingFolder |
EFT Server v4.3.4 and later |
|
AssignFullPermissionsForHomeFolder |
All versions |
|
AutoBanIPsPermanently |
All versions |
|
AutobanSensitivity |
EFT Server version 6.1 and later |
|
AutoCreateHomeFolder |
All versions |
|
BanIPOnDOS |
All versions |
|
BlockAntiTimeOut |
All versions |
|
BlockSiteToSite |
All versions |
|
CancelTransfer |
EFT Server v4.3.4 and later |
|
ChangeUserPassword |
All versions |
|
ConnectMessage |
All versions |
|
CreateCommand |
All versions |
|
CreateComplexPassword |
EFT Server v5.0.1 and later |
|
CreatePermissionGroup |
All versions |
|
CreatePhysicalFolder |
All versions |
|
CreateSettingsLevel |
All versions |
|
CreateUser and CreateUserEx |
All versions |
|
CreateVirtualFolder |
All versions |
|
DisableSFTP |
EFT Server v6.1 and later |
|
DisconnectOnDOS |
All versions |
|
DOSLimit |
All versions |
|
EnablePortRange |
All versions |
|
EnableSFTP |
EFT Server v6.1 and later |
|
EventRules |
EFT Server v5.2 and later |
|
ExitMessage |
All versions |
|
ExportTrustedCertificate |
All versions |
|
ForcePasswordResetOnInitialLogin |
EFT Server v6.2 and later |
|
ForceSynchronizeUserDatabase |
All versions |
|
GetAllowedMasks |
All versions |
|
GetAuthManagerID |
All versions |
|
GetAwaitingCertsPath |
All versions |
|
GetBlankPermission |
All versions |
|
GetCertFilePath |
All versions |
|
GetCheckClientCert |
All versions |
|
GetCommands |
All versions |
|
GetCommandSettings |
All versions |
|
GetConnectedCount |
All versions |
|
GetConnectedUsers |
EFT Server v4.3.4 and later |
|
GetDeniedMasks |
All versions |
|
GetDownloadCount |
All versions |
|
GetDownloadSpeed |
All versions |
|
GetFolderList |
All versions |
|
GetFolderPermissions |
All versions |
|
GetFTPAccess |
All versions |
|
GetHTTPAccess |
EFT Server v4.3.4 and later |
|
GetHTTPPort |
EFT Server v4.3.4 and later |
|
GetHTTPSAccess |
EFT Server v4.3.4 and later |
|
GetHTTPSPort |
EFT Server v4.3.4 and later |
|
GetIP |
All versions |
|
GetKeyFilePath |
All versions |
|
GetPassPhrase |
All versions |
|
GetPendingCertificateInfo |
All versions |
|
GetPendingCertificates |
All versions |
|
GetPermissionGroupList |
All versions |
|
GetPermissionGroups |
All versions |
|
GetPermissionGroupsOfUser |
All versions |
|
GetPhysicalPath |
EFT Server v5.2.5 and later |
|
GetPort |
All versions |
|
GetRootFolder |
All versions |
|
GetSettingsLevels |
All versions |
|
GetSettingsLevelSettings |
All versions |
|
GetSettingsLevelUsers |
All versions |
|
GetSSHKeyFilePath |
EFT Server v4.3.4 and later |
|
GetSSLAuth |
All versions |
|
GetSSLImp |
All versions |
|
GetStartTime |
All versions |
|
GetTrustedCertificateInfo |
All versions |
|
GetTrustedCertificates |
All versions |
|
GetTrustedCertsPath |
All versions |
|
GetUploadCount |
All versions |
|
GetUploadSpeed |
All versions |
|
GetUsers |
All versions |
|
GetUserSettings |
All versions |
|
HasMaxConcurrentLogins |
Secure FTP Server |
|
HasMaxConnectionsPerAccount |
Retrieving or Setting Number of Connections per User to a Site |
All versions |
HasMaxIPPerAccount |
All versions |
|
HasMaxSpeed |
All versions |
|
HasMaxUsers |
All versions |
|
ID |
All versions |
|
ImportTrustedCertificate |
All versions |
|
InvalidAttemptsPeriod |
EFT Server v5.1.1 and later |
|
IPAccessAllowedDefault |
All versions |
|
IsFolderInherited |
Retrieving Whether a Folder is Virtual or Physical and Whether Folder is Inherited |
EFT Server v6.2.18 and later |
IsFolderVirtual |
Retrieving Whether a Folder is Virtual or Physical and Whether Folder is Inherited |
EFT Server v6.2.18 and later |
IsStarted |
All versions |
|
KickUser |
Forcing a User to Log Off of the Site |
EFT Server v4.3.4 and later |
LimitLoginAttempts |
EFT Server v5.1.1 and later |
|
LockoutNotDisable |
EFT Server v5.1.1 and later |
|
LockoutPeriod |
EFT Server v5.1.1 and later |
|
MaxConcurrentConnections |
All versions |
|
MaxConnectionsFromSameIP |
Managing Concurrent Connections Allowed from the Same IP Address |
All versions |
MaxConcurrentLogins |
Secure Server, All versions |
|
MaxConnectionsPerUser |
All versions |
|
MaxInvalidLoginAttempts |
Viewing the Number of Invalid Login Attempts Allowed for a Site |
EFT Server v5.1.1 and later |
MaxTransferSpeed |
All versions |
|
MoveUserToSettingsLevel |
All versions |
|
Name |
All versions |
|
ODBCSettings |
EFT Server v4.3.4 and later |
|
PASVListenIP |
All versions |
|
PASVPortMax |
All versions |
|
PASVPortMin |
All versions |
|
RemapVirtualFolder |
EFT Server v4.3.4 and later |
|
Remove |
All versions |
|
RemoveCommand |
All versions |
|
RemoveFolder |
All versions |
|
RemoveIPAccessRule |
All versions |
|
RemovedPendingCertificate |
All versions |
|
RemovePermission |
All versions |
|
RemovePermissionGroup |
All versions |
|
RemoveSettingsLevel |
All versions |
|
RemoveTrustedCertificate |
All versions |
|
RemoveUser |
All versions |
|
RemoveUserFromPermissionGroup |
All versions |
|
RenameFolder |
All versions |
|
RenamePermissionGroup |
All versions |
|
RenameSettingsLevel |
All versions |
|
RenameUser |
All versions |
|
SetCertFilePath |
All versions |
|
SetCheckClientCert |
All versions |
|
SetFTPAccess |
All versions |
|
SetHTTPAccess |
EFT Server v4.3.4 and later |
|
SetHTTPPort |
EFT Server v4.3.4 and later |
|
SetHTTPSAccess |
EFT Server v4.3.4 and later |
|
SetHTTPSPort |
EFT Server v4.3.4 and later |
|
SetIP |
All versions |
|
SetKeyFilePath |
All versions |
|
SetPassPhrase |
All versions |
|
SetPermission |
All versions |
|
SetPort |
All versions |
|
SetRootFolder |
All versions |
|
SetSSHKeyFilePath |
EFT Server 4.3.4 and later |
|
SetSSLAuth |
All versions |
|
Sub SetSSLCertificate |
Specifying the SSL Certificate for a Site (SetSSLCertificate) |
EFT Server 6.1 and later |
SetSSLImp |
All versions |
|
Start |
All versions |
|
Stop |
All versions |
|
UserLimitMessage |
All versions |
|
ValidatePassword |
EFT Server v3.5.1 and later |
|
VFSFilter |
All versions |
The Sites Interface members are listed below. For details of how to use the properties in scripts, refer to the links in the table below.
Members |
How It's Used |
Applicable Version |
Add |
All versions |
|
AddADSite |
All versions |
|
AddLDAPSite |
EFT Server v4.3.4 and later |
|
AddLocalSite |
All versions |
|
AddNTLMSite |
All versions |
|
AddODBCSite |
All versions |
|
Count |
All versions |
|
All versions |
||
All versions |
The SSH Key Information interface members are listed below. For details of how to use them in scripts, refer to SSH Key Information Interface.
Members |
Applicable Version |
ID |
EFT Server v6.1 and later |
Name |
EFT Server v6.1 and late |
Fingerprint |
EFT Server v6.1 and late |
The Stop Action Parameters interface members are listed below. For details of how to use the properties in scripts, refer to Stop Action Parameters Interface.
Members |
Applicable Version |
Action |
EFT Server v5.2 and later |
Enabled |
EFT Server v5.2 and later |
The Timer Event Rule Parameters interface members are listed below. For details of how to use the properties in scripts, refer to Timer Event Rule Parameters Interface.
Members |
Applicable Version |
CustomPeriod |
EFT Server v5.2 |
DayIndex |
EFT Server v5.2 |
DayOfMonth |
EFT Server v5.2 |
DayPeriod |
EFT Server v5.2 |
Enabled |
EFT Server v5.2 and later |
FixedDate |
EFT Server v5.2 |
LastPremature |
EFT Server v5.2 and later |
LastTime |
EFT Server v5.2 and later |
MonthIndex |
EFT Server v5.2 |
MonthPeriod |
EFT Server v5.2 |
Name |
EFT Server v5.2 and later |
NextRun |
EFT Server v5.2 and later |
Recurrence |
EFT Server v5.2 and later |
TimeStart |
EFT Server v5.2 |
WeekDayIndex |
EFT Server v5.2 |
Weekdays |
EFT Server v5.2 |
WeekPeriod |
EFT Server v5.2 |
The Transfer Action Parameters interface members are listed below. For details of how to use the properties in scripts, refer to Transfer Action Parameters Interface and Specifying Advanced Options for Transfer Action Parameters.
Members |
Applicable Version |
AutoLogin |
EFT Server v5.2 and later |
ConnectionRetryAttempts |
EFT Server v6.2.10 and later |
ConnectionTimeoutSeconds |
EFT Server v6.2.10 and later |
DeleteSourceFile |
EFT Server v5.2.5 and later |
FTPDataConnectionMode |
EFT Server v6.2.10 and later |
FTPDataConnectionPortMax |
EFT Server v6.2.10 and later |
FTPDataConnectionPortMin |
EFT Server v6.2.10 and later |
FTPSClearCommandChannel |
EFT Server v6.2.10 and later |
FTPSClearDataChannel |
EFT Server v6.2.10 and later |
Host |
EFT Server v5.2 and later |
Key |
EFT Server v5.2.x |
KeyPass |
EFT Server v5.2.x |
LocalPath |
EFT Server v5.2 and later |
MaxConcurrentThreads |
EFT Server v6.2.10 and later |
Operation |
EFT Server v5.2.x |
Password |
EFT Server v5.2 and later |
Port |
EFT Server v5.2 and later |
PreserveFileTime |
EFT Server v6.2.10 and later |
Protocol |
EFT Server v5.2 and later |
PubKey |
EFT Server v5.2.x |
PublicKeyPath |
EFT Server 6.0 and later |
RemotePath |
EFT Server v5.2 and later |
RetryDelaySeconds |
EFT Server v6.2.10 and later |
TextFileTypes |
EFT Server v6.2.10 and later |
User |
EFT Server v5.2 and later |
ValidateIntegrity |
EFT Server v6.2.10 and later |
The Upload Action Parameters interface members are listed below. For details of how to use the properties in scripts, refer to Upload Action Parameters Interface Properties and Specifying Advanced Options for Transfer Action Parameters.
Members |
Applicable Version |
AutoLogin |
EFT Server v5.25 and later |
ConnectionRetryAttempts |
EFT Server v6.2.10 and later |
ConnectionTimeoutSeconds |
EFT Server v6.2.10 and later |
DeleteSourceFile |
EFT Server v5.25 and later |
FTPDataConnectionMode |
EFT Server v6.2.10 and later |
FTPDataConnectionPortMax |
EFT Server v6.2.10 and later |
FTPDataConnectionPortMin |
EFT Server v6.2.10 and later |
FTPSClearCommandChannel |
EFT Server v6.2.10 and later |
FTPSClearDataChannel |
EFT Server v6.2.10 and later |
Host |
EFT Server v5.25 and later |
LocalPath |
EFT Server v5.25 and later |
MaxConcurrentThreads |
EFT Server v6.2.10 and later |
Password |
EFT Server v5.25 and later |
Port |
EFT Server v5.25 and later |
PreserveFileTime |
EFT Server v6.2.10 and later |
PrivateKeyPassword |
EFT Server v5.25 and later |
PrivateKeyPath |
EFT Server v5.25 and later |
Protocol |
EFT Server v5.25 and later |
PublicKeyPath |
EFT Server v5.25 and later |
RemotePath |
EFT Server v5.25 and later |
RetryDelaySeconds |
EFT Server v6.2.10 and later |
TextFileTypes |
EFT Server v6.2.10 and later |
User |
EFT Server v5.25 and later |
ValidateIntegrity |
EFT Server v6.2.10 and later |
The enumerations and constants used in the interfaces, properties, and methods are described in List of Enumerations and Constants.