ICISite - Single-Site Interface

The ICISite interface represents an individual Site. (Refer to ICISites - Multi-Site Management to view/make changes to all of the Sites at once or to create a new Site.)

For example: Set Site = Sites.Item(0)

Use the ICISites interface to manage multiple Sites at once or to create new Sites.

interface ICISite : IDispatch

Members

How it's used

Applicable version

Property AccountManagementPath As String (read only)

In the EFT administration interface, this property is enabled on the Site's Connection tab.

Retrieves the account management URL at which users can reset their passwords via HTTPS. You must restart the Site for the change to take effect. (Refer to Stop and Start below.)

HRESULT AccountManagementPath(

[out, retval] BSTR* pVal);

Example (VBScript):

MsgBox "Account management over https path is: " & CStr(oSite.AccountManagementPath)

EFT v6.3 and later

Function AddAdvancedWorkflow(pdisplParams As Object) As Long

Adds new Advanced Workflow to this Site.

HRESULT AddAdvancedWorkflow( [in] IDispatch* pdisplParams, // AW params // as ICIAdvancedWorkflowParams* [out, retval] long* plIndex);// zero-based index of created AW

Example (VBScript):

set AWParams = CreateObject("SFTPCOMInterface.CIAdvancedWorkflowParams")

‘...setup workflow

site.AddAdvancedWorkflow(AWParams)

EFT v6.5 and later

Function AddCertificateToTrusted(lID As Long) As Long

Moves a pending certificate to trusted.

HRESULT AddCertificateToTrusted(

[in] long lID,

[out, retval] long *lNewID);

Example (VBScript):

'Loop through pending certificates

'and assign certificate to a client

'if the certificate common name

'coincides with client's full name

For Each pID in Site.GetPendingCertificates

If Site.GetPendingCertificateInfo(pID).SubjectCName = C.FullName Then

tID = Site.AddCertificateToTrusted(pID)

C.SetSSLAuthenticationType "key"

C.SetSSLKeyID tID

End If

All versions

Sub AddIPAccessRule(bstrMask As String, bAllow As Boolean, nRulePos As Long)

See also the following interfaces:

Adds allowed or denied IP mask for the Site.

HRESULT AddIPAccessRule(

[in] BSTR bstrMask,

[in] VARIANT_BOOL bAllow,

[in] long nRulePos);

Example (VBScript):

oSite.AddIPAccessRule("1.2.3.4", false, 2)

All versions

Sub AddUserToPermissionGroup(bstrUser As String, bstrGroup As String)

Adds a user to a permission group.

HRESULT AddUserToPermissionGroup(

[in] BSTR bstrUser,

[in] BSTR bstrGroup);

All versions

Property AdvancedWorkflowsCount As Long

Retrieves the total count of site's Advanced Workflows.

HRESULT AdvancedWorkflowsCount([out, retval] long* plValue);

Example (VBScript):

If Site.AdvancedWorkflowsCount = 0 Then

‘Site has no Advanced Workflows…

End If

EFT v6.5 and later

Property AllowChangePassword As Boolean

Allows you to retrieve or specify whether Site users are allowed to change their passwords. The value can be overridden at the Settings Template or user account level.

HRESULT AllowChangePassword(

[out, retval] VARIANT_BOOL *pVal);

HRESULT AllowChangePassword(

[in] VARIANT_BOOL val);

Examples (VBScript):

Retrieving:

If Site.AllowChangePassword Then

Site.ForcePasswordResetOnInitialLogin = True

End If

Specifying:

If Site.AllowChangePassword = False

EFT v6.2 and later

Property AllowEmailLoginCredentials As Boolean

Retrieve or specify whether allow login credentials to be sent in emails. If AllowEmailLoginCredentials is enabled, EmailLoginCredentialsMode retrieves how they are sent (username and password in the same email, separate emails, or username only).

HRESULT AllowEmailLoginCredentials(

[out, retval] VARIANT_BOOL* pVal);

HRESULT AllowEmailLoginCredentials(

[in] VARIANT_BOOL newVal);

TRUE=Email login credentials; FALSE=Do not email login credentials

Example (VBScript):

Retrieving:

if False = oSite.AllowEmailLoginCredentials then

MsgBox "Disabled"

End If

Specifying:

oSite.AllowEmailLoginCredentials = True

EFT v6.3 and later

Property AllowUPVariables As Boolean

Retrieve or specify whether to allow username and passwords credentials as variables in Event Rules.

HRESULT AllowUPVariables(

[out, retval] VARIANT_BOOL* pVal);

HRESULT AllowUPVariables(

[in] VARIANT_BOOL newVal);

Example (VBScript):

Retrieving:

if False = oSite.AllowUPVariables then

MsgBox "Disabled"

End If

Specifying:

oSite.AllowUPVariables = True

EFT v6.3 and later

Property AS2AccountManagementPath As String (read only)

Retrieve URL for AS2 account management.

HRESULT AS2AccountManagementPath(

[out, retval] BSTR* pVal);

Example (VBScript):

MsgBox "AS2 management path is: " & oSite.AS2AccountManagementPath

EFT v6.3 and later

Property AS2Certificate As String

Retrieve or specify AS2 certificate path.

HRESULT AS2Certificate(

[out, retval] BSTR* pVal);

HRESULT AS2Certificate(

[in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 certificate is: " & oSite.AS2Certificate

Specifying:

oSite.AS2Certificate = "C:\MyCerts\AS2Cert.crt"

EFT v6.3 and later

Property AS2Identifier As String

Retrieve or specify the AS2 identifier.

HRESULT AS2Identifier(

[out, retval] BSTR* pVal);

HRESULT AS2Identifier(

[in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 identifier is: " & oSite.AS2Identifier

Specifying:

oSite.AS2Identifier = "my_as2_id"

EFT v6.3 and later

Property AS2Passphrase As String

Retrieve or specify the AS2 passphrase.

HRESULT AS2Passphrase(

[out, retval] BSTR* pVal);

HRESULT AS2Passphrase(

[in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 passphrase is: " & oSite.AS2Passphrase

Specifying:

oSite.AS2Passphrase = "new_passphrase"

EFT v6.3 and later

Property AS2PrivateKey As String

Retrieve or specify the AS2 private key.

HRESULT AS2PrivateKey(

[out, retval] BSTR* pVal);

HRESULT AS2PrivateKey(

[in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "AS2 certificate is: " & oSite.AS2PrivateKey

Specifying:

oSite.AS2PrivateKey = "C:\MyCerts\AS2Cert.crt"

EFT v6.3 and later

Sub AssignEventRuleCustomCommandWorkingFolder(bstrCustomCommandName As String, bstrWorkingFolder As String)

Update all instances of a given custom command in the event rule list to have a specified working folder.

HRESULT AssignEventRuleCustomCommandWorkingFolder(

[in] BSTR bstrCustomCommandName,

[in] BSTR bstrWorkingFolder);

Example (VBScript):

Dim strCommandName: strCommandName = "RunScript"

Dim strNewWorkingFolder: strNewWorkingFolder = "C:\Script\folder"

oSite.AssignEventRuleCustomCommandWorkingFolder(strCommandName, strNewWorkingFolder)

EFT v4.3.4 and later

Property AssignFullPermissionsForHomeFolder As Boolean

In the EFT administration interface, this property is enabled on the Site's Security tab, in the Account Security area.

Retrieve whether new users have full permissions in their home folders, and to either grant or deny users full permissions to their home folders. True = Granted (check box selected); False = Denied (check box cleared).

The AutoCreateHomeFolder property must be set to TRUE before you can use this property. If you do not grant users full permissions to their home folders, they will inherit permissions from their groups.

HRESULT AssignFullPermissionsForHomeFolder(

[out, retval] VARIANT_BOOL *pVal);

[in] VARIANT_BOOL newVal);

All versions

Property AutoBanIPsPermanently As Boolean

Retrieve or specify whether to automatically ban IP addresses permanently.

HRESULT AutoBanIPsPermanently(

[out, retval] VARIANT_BOOL *pVal);

HRESULT AutoBanIPsPermanently(

[in] VARIANT_BOOL newVal);

True=Permanently; False=Temporarily

All versions

Property AutobanSensitivity As AutobanSensitivity

Retrieve or specify autoban sensitivity.

HRESULT AutobanSensitivity(

[out, retval] AutobanSensitivity *pVal);

HRESULT AutobanSensitivity(

[in] AutobanSensitivity newVal);

Example (VBScript)::

Retrieving:

If Site.AutobanSensitivity <> SensitivityOff Then

MsgBox "Flood/Hammer Autoban is on for the site"

End If

Specifying:

Site.AutobanSensitivity = SensitivityVeryHigh

EFT v6.1 and later

Property AutoCreateHomeFolder As Boolean

In the EFT administration interface, this property is enabled on the Site's Security tab, in the Account Security area.

Retrieve whether the Site will automatically create a home folder for users, and to either enable or disable the automatic folder creation.

HRESULT AutoCreateHomeFolder(

[out, retval] VARIANT_BOOL *pVal);

[in] VARIANT_BOOL newVal);

True = Enabled; False = Disabled

The AutoCreateHomeFolder property must be set to TRUE before you can use the AssignFullPermissionsForHomeFolder property.

If you do not grant users full permissions to their home folders, they will inherit permissions from their groups.

All versions

Property AverageSpeed As Long (read only)

Retrieve the average upload/download speed on the Site.

HRESULT AverageSpeed(

[out, retval] LONG* pVal);

Example (VBScript):

MsgBox "Average speed: " & CStr(oSite.AverageSpeed)

EFT v6.3 and later

Property BanIPForInvalidLoginAttempts As Boolean

When banning an IP address for invalid login attempts, specify whether to count incorrect username and correct username + incorrect password or only incorrect username attempts.

HRESULT BanIPForInvalidLoginAttempts(

[out, retval] VARIANT_BOOL* pVal);

HRESULT BanIPForInvalidLoginAttempts(

[in] VARIANT_BOOL newVal);

TRUE = Count both 'incorrect username' and 'correct username + incorrect password'

FALSE = Count only incorrect username attempts

EFT v6.4 and later

Property BanIPForInvalidLoginAttemptsWithExistingUsername As Boolean

Retrieve or specify whether to ban an IP address after excessive invalid login attempts with existing username and wrong password.

HRESULT BanIPForInvalidLoginAttemptsWithExistingUsername(

[out, retval] VARIANT_BOOL* pVal);

HRESULT BanIPForInvalidLoginAttemptsWithExistingUsername(

[in] VARIANT_BOOL newVal);

EFT v6.4 and later

Property BanIPOnDOS As Boolean

Retrieve or specify whether to ban an IP address after excessive invalid commands.

HRESULT BanIPOnDOS(

[out, retval] VARIANT_BOOL *pVal);

HRESULT BanIPOnDOS(

[in] VARIANT_BOOL newVal);

True=Enabled; False=Disabled

All versions

Property BlockAntiTimeOut As Boolean

Retrieve or specify whether to block anti-timeout schemes (NOOP).

HRESULT BlockAntiTimeOut(

[out, retval] VARIANT_BOOL *pVal);

HRESULT BlockAntiTimeOut(

[in] VARIANT_BOOL newVal);

True = Blocked; False = Allowed

All versions

Property BlockSiteToSite As Boolean

Retrieve or specify whether to block Site-to-Site (FXP) transfers.

HRESULT BlockSiteToSite(

[out, retval] VARIANT_BOOL *pVal);

HRESULT BlockSiteToSite(

[in] VARIANT_BOOL newVal);

True = Blocked; False = Allowed

All versions

Function CancelTransfer(bstrPath As String) As Boolean

Close all HTTP sockets that upload/download (including POST upload) a file specified by the path parameter. Note that this is not effective for FTP or SFTP.

HRESULT CancelTransfer(

[in] BSTR bstrPath,

[out, retval] VARIANT_BOOL *pSuccess);

EFT v4.3.4 and later

Sub ChangeUserPassword(bstrUser As String, bstrPwd As String, nPwdType As Int)

Change a user's password and password type.

HRESULT ChangeUserPassword(

[in] BSTR bstrUser,

[in] BSTR bstrPwd,

[in] int nPwdType);

PwfType

0 = Regular (hashed)

1 = Anonymous (regular with empty password)

2 = Anonymous (require email as password)

3 = OTP-MD4

4 = OTP-MD5

5 = Literal (no hash) - For use when importing shadow passwords from a *nix password file. The format must follow: $1$*$* For example, user: test, password: test would be:

site.ChangeUserPassword "test", "$1$Bn3YdWKv$.BS3Qb2UQTV4SmV1JNN.w/", 5

DES-format passwords are not supported. These are password formats without the salt defined, that is, without the $1$.

All versions

Property ConnectedUsers As Variant (read only)

Retrieve an array of users currently connected to the Site.

HRESULT ConnectedUsers(

[out, retval] VARIANT* pVal);

Example (VBScript):

For Each u In oSite.ConnectedUsers

MsgBox "User: " & u.Login

EFT v6.3 and later

Property ConnectMessage As String

Retrieve or specify the connect message.

HRESULT ConnectMessage([out, retval] BSTR *pVal);

HRESULT ConnectMessage([in] BSTR newVal);

All versions

Function CreateCommand(bstrName As String) As CICommandSettings

Create a new command.

HRESULT CreateCommand(

[in] BSTR bstrName,

[out, retval] ICICommandSettings **prop);

All versions

Function CreateComplexPassword([bstrUserName]) As String

Create a complex password that meets the complexity criteria specified for the site.

HRESULT CreateComplexPassword(

[in, optional] VARIANT bstrUserName,

[out, retval] BSTR *bstrPassword);

Example (VBScript):

The following example generates a password that adheres to the complexity policy enforced for an existing user:

Dim strNewPassword

strNewPassword = oUserSettings.CreateComplexPassword("test")

WScript.Echo "New Password: " strNewPassword

Call oUserSettings.ChangeUserPassword("test", strNewPassword, 1)

This example illustrates how to obtain a password from the Server that meets the complexity requirements for the Settings Template that is configured as the default for the Site, which is useful when creating new users:

Dim strNewPassword

strNewPassword = oUserSettings.CreateComplexPassword()

WScript.Echo "New Password: " strNewPassword

Call oUserSettings.CreateUser("test", strNewPassword, 0, "New User Description")

EFT v5.0.1 and later

Function CreateComplexPasswordEx([bstrUserName], [bstrSettingsLevel]) As String

Create a complex password that meets the complexity criteria specified for the Settings Template.

HRESULT CreateComplexPasswordEx(

[in, optional] VARIANT bstrUserName,

[in,optional] VARIANT bstrSettingsLevel,

[out, retval] BSTR *bstrPassword);

Example (VBScript):

strPass = oSite.CreateComplexPasswordEx("","")

EFT v6.3 and later

Sub CreatePermissionGroup(bstrName As String)

Create a new permission group.

HRESULT CreatePermissionGroup(

[in] BSTR bstrName);

Permission Groups control user access to files and folders.

All versions

Sub CreatePhysicalFolder(bstrNewFolder As String)

Given a relative path, create a new physical folder (Use forward slashes instead of back slashes.)

HRESULT CreatePhysicalFolder(

[in] BSTR bstrNewFolder);

Example (VBScript):

Call Object.CreatePhysicalFolder("/folderpath/")

'another example:

MySite.CreatePhysicalFolder("/Usr/jsmith/")

'Note that backslashes "\" will not work:

MySite.CreatePhysicalFolder("\Usr\jsmith\") <--will fail!

All versions

Sub CreateSettingsLevel(bstrName As String, bstrDescription As String)

Create a Settings Template.

HRESULT CreateSettingsLevel(

[in] BSTR bstrName,

[in] BSTR bstrDescription);

All versions

Sub CreateUser(bstrLogin As String, bstrPwd As String, nPwdType As Int, bstrDescription As String, [abTwoFactorAuthentication As SFTPAdvBool = -2])

The CreateUser method will fail if a simple password is provided when enforce complex passwords is enabled in EFT. For example, the following will fail if enforce complex passwords is enabled in EFT:

oSite.CreateUser "tuser1", "testpassword", 0 "New User"

For the method to work, you must do one of the following:

Disable enforcement of complex passwords.
Provide a complex password. For example:

oSite.CreateUser "test", "$1$Bn3YdWKv$.BS3Qb2UQTV4SmV1JNN.w/", 0, "New User"

Call the CreateComplexPassword method and use the resulting string in the CreateUser method. For example (in pseudo code):

strUserPass = oUserSettings.CreateComplexPassword()

oSite.CreateUser "test", strUserPass, 0, "New User"

Create a user with the default values. (The CreateUser method creates users with the default values.)

HRESULT CreateUser(

[in] BSTR bstrLogin,

[in] BSTR bstrPwd,

[in] int nPwdType,

[in] BSTR bstrDescription,

[in, defaultvalue(abInherited)] SFTPAdvBool abTwoFactorAuthentication);

SFTPAdvBool

abInherited = -2 (&HFFFFFFFE)

abFalse = 0

abTrue = 1

PwdType

0 = Regular (hashed)

1 = Anonymous (regular with empty password)

2 = Anonymous (require email as password)

3 = OTP-MD4

4 = OTP-MD5

5 = Literal (no hash) - For use when importing shadow passwords from a *nix password file. The format must follow: $1$*$* For example, user: test, password: test would be:

site.ChangeUserPassword "test", "$1$Bn3YdWKv$.BS3Qb2UQTV4SmV1JNN.w/", 5

DES-format passwords are not supported. These are password formats without the salt defined, that is, without the $1$.

All versions

Sub CreateUserEx(bstrLogin As String, bstrPwd As String, nPwdType As Int, bstrDescription As String, bstrFullName As String, bCreateHomeFolder As Boolean, bFullPermissionsForHomeFolder As Boolean, [bstrSettingsLevel As String], [abTwoFactorAuthentication As SFTPAdvBool = -2])

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

The CreateUserEx method will fail if a simple password is provided when enforce complex passwords is enabled in EFT. For example, the following will fail if enforce complex passwords is enabled in EFT:

oSite.CreateUserEx "tuser1", "testpassword", 0 "New User"

For the method to work, you must do one of the following:

Disable enforcement of complex passwords.
Provide a complex password. For example:

oSite.CreateUserEx "test", "$1$Bn3YdWKv$.BS3Qb2UQTV4SmV1JNN.w/", 0, "New User"

Call the CreateComplexPassword method and use the resulting string in the CreateUserEx method. For example (in pseudo code):

strUserPass = oUserSettings.CreateComplexPassword()

oSite.CreateUserEx "test", strUserPass, 0, "New User"

Create a user and allows you to set values for all parameters. (The CreateUserEx method allows you to set values for all parameters.)

HRESULT CreateUserEx(

[in] BSTR bstrLogin,

[in] BSTR bstrPwd,

[in] int nPwdType,

[in] BSTR bstrDescription,

[in] BSTR bstrFullName,

[in] VARIANT_BOOL bCreateHomeFolder,

[in] VARIANT_BOOL bFullPermissionsForHomeFolder,

[in, optional] BSTR bstrSettingsLevel,

[in, defaultvalue(abInherited)] SFTPAdvBool abTwoFactorAuthentication);

SFTPAdvBool

abInherited = -2 (&HFFFFFFFE)

abFalse = 0

abTrue = 1

PwdType

0 = Regular (hashed)

1 = Anonymous (regular with empty password)

2 = Anonymous (require email as password)

3 = OTP-MD4

4 = OTP-MD5

5 = Literal (no hash) - For use when importing shadow passwords from a *nix password file. The format must follow: $1$*$* For example, user: test, password: test would be:

site.ChangeUserPassword "test", "$1$Bn3YdWKv$.BS3Qb2UQTV4SmV1JNN.w/", 5

DES-format passwords are not supported. These are password formats without the salt defined, that is, without the $1$.

Example (C#):

selectedSite.CreateUserEx(j.ToString(),j.ToString(),0,j.ToString(),j.ToString(),true, false,"Default settings", SFTPAdvBool.abFalse);

All versions

Sub CreateUserEx2(pdispParams As Object)

Refer to ICINewUserData Interface for more details.

Creates a new user and includes all of the user/client details, including the email address; ensures that the email address is available if an Event Rules is configured to send an e-mail to the user.

HRESULT CreateUserEx2

([in] IDispatch* pdispParams);

EFT v6.3.8 and later

Sub CreateVirtualFolder(bstrNewFolder As String, bstrTarget As String)

Given a relative path and a physical target path, create a new virtual folder.

HRESULT CreateVirtualFolder(

[in] BSTR bstrNewFolder,

[in] BSTR bstrTarget),

[in, defaultvalue(-1)] VARIANT_BOOL bCheckTarget); (This was added for 6.3.8)

Example (VBScript):

Call oSite.CreateVirtualFolder("/pub/temp/", "C:\Temp\")

All versions

Property DataSanitizationMethod As DataSanitizationMethod

Retrieve or specify the data sanitization method.

HRESULT DataSanitizationMethod(

[out, retval] DataSanitizationMethod* pVal);

HRESULT DataSanitizationMethod(

[in] DataSanitizationMethod newVal);

Example (VBScript):

Retrieving:

if DataSanitizationNoWipe = oSite.DataSanitizationMethod then

MsgBox "No wipe method is specified"

End If

Specifying:

oSite.DataSanitizationMethod = DataSanitizationPseudorandomData

EFT v6.3 and later

Sub DecryptFolder(bstrFolder As String, vbResursively As Boolean)

Specify whether to decrypt a folder.

HRESULT DecryptFolder(

[in] BSTR bstrFolder,

[in] VARIANT_BOOL vbResursively);

Example (VBScript):

oSite.DecryptFolder "/some_folder", True

EFT v6.3 and later

Property DefaultPGPKeyID As String

(read-only)

See also the following interfaces:

Retrieves an array of allowed IP masks.

HRESULT GetIPAccessRules(

[out, retval] VARIANT *aMasks);

Example (VBScript):

rules = oSite.GetIPAccessRules()

For Each key In rules

If key.type = 0 Then

WScript.echo "AutoBan"

End if

If key.type = 1 Then

WScript.echo "Manual " + key.address

End if

EFT v6.3 and later

Function GetKeyFilePath() As String

Retrieves the Site SSL private key file path.

HRESULT GetKeyFilePath(

[out, retval] BSTR *prop);

All versions

Function GetPassPhrase() As String

Retrieves the Site SSL Private key passphrase.

HRESULT GetPassPhrase(

[out, retval] BSTR *prop);

All versions

Function GetPendingCertificateInfo(lID As Long) As CICertInfo

Given an ID, retrieves a pending certificate info.

HRESULT GetPendingCertificateInfo(

[in] long lID,

[out, retval] ICICertInfo **prop);

All versions

Function GetPendingCertificates() As Variant

Retrieves a list of pending certificate IDs.

HRESULT GetPendingCertificates(

[out, retval] VARIANT *aCerts);

All versions

Function GetPermissionGroupList(bstrGroup As String) As Variant

Retrieves an array of permission groups.

HRESULT GetPermissionGroupList(

[in] BSTR bstrGroup,

[out, retval] VARIANT *aUsers);

Example (VBScript):

Dim arUsers: arUsers = oSite.GetPermissionGroupList("Administrative")

For iCount = LBound(arUsers) To UBound(arUsers)

WScript.Echo arUsers(iCount)

All versions

Function GetPermissionGroups() As Variant

Retrieves an array of permission groups. (Permission Groups control user access to files and folders.)

HRESULT GetPermissionGroups(

[out, retval] VARIANT *aGroups);

All versions

Function GetPermissionGroupsOfUser(bstrUser As String) As Variant

Given a user account, retrieve its permission groups.

HRESULT GetPermissionGroupsOfUser(

[in] BSTR bstrUser,

[out, retval] VARIANT *aGroups);

All versions

Function GetPermPathsList(bstrOptions As String) As String

Returns a list of all paths that have a unique set of permissions. (All other paths, which are not included in the set returned by this call, inherit the permissions as set in their parent.)

HRESULT GetPermPathsList(

[in] BSTR bstrOptions,

[out, retval] BSTR *prop);

Supported value for bStrOptions is -do (decorate orphans)—When specified, a folder that exists in the Virtual File System (VFS), but whose physical path does not exist, will be decorated with a trailing asterisk (*).

EFT v6.3.1 and later

Function GetPhysicalPath(bstrFolderAlias As String) As String

Transform virtual path to physical one.

HRESULT GetPhysicalPath(

[in] BSTR bstrFolderAlias,

[out, retval] BSTR *pbstrPhysicalPath);

Example (VBScript):

Msgbox Site.GetPhysicalPath("/Usr")

Returns a message box displaying the physical path, such as:

EFT v5.2.5 and later

Function GetPort() As Long

Retrieve the port number of the Site.

HRESULT GetPort(

[out, retval] long *prop);

All versions

Function GetResetPasswordSettings() As Object

Use ICISite::GetResetPasswordSettings and ICISite::SetResetPasswordSettings to retrieve and set the password settings for a Site.

Retrieve the password reset settings.

HRESULT GetResetPasswordSettings(

[out, retval] ICIResetPasswordSettings** ppIResetPasswordSettings); (v6.3 - 6.3.3)

[out, retval] IDispatch** ppIResetPasswordSettings); (v6.3.8 and later)

Example (VBScript):

Set oPwdSettings = oSite.GetResetPasswordSettings()

EFT v6.3 and later

Function GetRootFolder() As String

Retrieve the root folder for an individual site.

HRESULT GetRootFolder(

[out, retval] BSTR *prop);

All versions

Function GetSettingsLevels() As Variant

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

Retrieve an array of User Settings Templates.

HRESULT GetSettingsLevels(

[out, retval] VARIANT *aLevels);

Example (C#):

CIClientSettings userSettings = selectedSite.GetUserSettings(userName);

object settingsLevels = selectedSite.GetSettingsLevels();

All versions

Function GetSettingsLevelSettings(bstrGroup As String) As CIClientSettings

Given a Settings Template name retrieve its settings.

HRESULT GetSettingsLevelSettings(

[in] BSTR bstrGroup,

[out, retval] ICIClientSettings **prop);

All versions

Function GetSettingsLevelUsers(bstrGroup As String) As Variant

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

Given a Settings Template, retrieve an array of its users.

HRESULT GetSettingsLevelUsers(

[in] BSTR bstrGroup,

[out, retval] VARIANT *aUsers);

Example (C#):

CIClientSettings userSettings = selectedSite.GetUserSettings(userName);

object settingsLevels = selectedSite.GetSettingsLevels();

All versions

Function GetSFTPAccess() As Boolean

Returns TRUE if SFTP access is enabled.

HRESULT GetSFTPAccess(

[out, retval] VARIANT_BOOL* pbVal);

EFT v6.4 and later

Function GetSSHKeyFilePath() As String

Retrieves SSH key file path.

HRESULT GetSSHKeyFilePath(

[out, retval] BSTR *prop);

EFT v4.3.4 and later

Function GetSSLAuth() As Boolean

Returns TRUE if SSL authentication is enabled.

HRESULT GetSSLAuth(

[out, retval] VARIANT_BOOL *prop);

True = Enabled; False = Disabled

All versions

Function GetSSLImp() As Boolean

Returns TRUE if SSL implicit is enabled.

HRESULT GetSSLImp(

[out, retval] VARIANT_BOOL *prop);

True = Enabled; False = Disabled

All versions

Function GetStartTime() As String

Retrieve the time the Site was started.

HRESULT GetStartTime(

[out, retval] BSTR *bstrStartTime);

All versions

Function GetTrustedCertificateInfo(lID As Long) As CICertInfo

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

Given an ID retrieve a trusted certificate info.

HRESULT GetTrustedCertificateInfo(

[in] long lID,

[out, retval] ICICertInfo **prop);

All versions

Function GetTrustedCertificates() As Variant

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

Retrieve a list of trusted certificate IDs.

HRESULT GetTrustedCertificates(

[out, retval] VARIANT *aCerts);

All versions

Function GetTrustedCertsPath() As String

Retrieve the Trusted Certificate file path.

HRESULT GetTrustedCertsPath(

[out, retval] BSTR *prop);

All versions

Function GetUploadCount() As Long

Retrieve the number of active uploads.

HRESULT GetUploadCount(

[out, retval] long *pCnt);

All versions

Function GetUploadSpeed() As Long

Retrieve the upload speed of a site.

HRESULT GetUploadSpeed(

[out, retval] long *pSpeed);

All versions

Function GetUsers() As Variant

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

Retrieve an array of users.

HRESULT GetUsers(

[out, retval] VARIANT *aUsers);

Example (C#):

object[] users = (object[])selectedSite.GetUsers();

All versions

Function GetUserSettings(bstrUser As String) As CIClientSettings

For an example using this method, refer to the GetCertInfo, ServerIPBanEntry, ConfigureUser, or UserSettingsTemplates script in Script Examples.

Given a username, retrieves its settings.

HRESULT GetUserSettings(

[in] BSTR bstrUser,

[out, retval] ICIClientSettings **prop);

Example (VBScript):

Site.GetUserSettings("kmarsh")

GetUserSettings is case insensitive. That is, in many non-windows environments “KMarsh” and “kmarsh” are two different usernames and case matters. With this method, “KMarsh”, “KMARSH”, and “kmarsh” are all the same user account.

Example (C#):

ICIClientSettings client = selectedSite.GetUserSettings((string)users[0]);

CIClientSettings userSettings = selectedSite.GetUserSettings(userName);

object settingsLevels = selectedSite.GetSettingsLevels();

All versions

Function GetUserSettingsLevel(bstrUser As String)

Given a user, retrieves its settings template.

HRESULT GetUserSettingsLevel(

[in] BSTR bzUser, [out, retval] BSTR* pbzSettingsLevel);

EFT v6.4 and later

Function GetVirtualFolderList (bstrOptions As String) As String

Returns a list of all paths in the VFS that represent virtual folders. Follow with GetPhysicalPath to find out which physical folder the virtual folder represents.

HRESULT GetVirtualFolderList(

[in] BSTR bstrOptions,

[out, retval] BSTR *prop);

bstrOptions is included to support the possible addition of functionality in later versions. Currently, this option is ignored.

EFT v6.3.1 and later

Property HasMaxConcurrentLogins As Boolean

Retrieves or specifies whether the site has maximum concurrent logins enabled.

HRESULT HasMaxConcurrentLogins(

[out, retval] VARIANT_BOOL *pVal);

HRESULT HasMaxConcurrentLogins(

[in] VARIANT_BOOL newVal);

True=Enabled; False=Disabled

Secure FTP Server; EFT v6.3 and later

Property HasMaxConnectionsPerAccount As Boolean

Retrieve or specify whether the Site has a maximum concurrent socket connections enabled.

HRESULT HasMaxConnectionsPerAccount(

[out, retval] VARIANT_BOOL *pVal);

HRESULT HasMaxConnectionsPerAccount(

[in] VARIANT_BOOL newVal);

True=Enabled; False=Disabled

All versions

Property HasMaxIPPerAccount As Boolean

Retrieve or specify whether the Site has maximum connections from same IP enabled.

HRESULT HasMaxIPPerAccount(

[out, retval] VARIANT_BOOL *pVal);

HRESULT HasMaxIPPerAccount(

[in] VARIANT_BOOL newVal);

True=Enabled; False=Disabled

All versions

Property HasMaxSpeed As Boolean

Retrieve or specify whether the Site has a maximum transfer speed enabled.

HRESULT HasMaxSpeed(

[out, retval] VARIANT_BOOL *pVal);

HRESULT HasMaxSpeed(

[in] VARIANT_BOOL newVal);

True=Enabled; False=Disabled

All versions

Property HasMaxUsers As Boolean

Retrieve or specify whether the Site has the maximum connections per user enabled.

HRESULT HasMaxUsers(

[out, retval] VARIANT_BOOL *pVal);

HRESULT HasMaxUsers(

[in] VARIANT_BOOL newVal)

True=Enabled; False=Disabled

All versions

Property HTTPDomain As String

Retrieve or specify the Site's domain name for HTTP access. You must restart the Site for the change to take effect. (Refer to Stop and Start below.)

HRESULT HTTPDomain(

[out, retval] BSTR* pVal);

HRESULT HTTPDomain(

[in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "Current http domain: " & oSite.HTTPDomain

Specifying:

oSite.HTTPDomain = "localhost"

EFT v6.3 and later

Property ID As Long

Retrieve read-only version of the Site ID.

HRESULT ID(

[out, retval] long *pVal);

All versions

Function ImportTrustedCertificate(bstrCertPath As String) As Long

Imports a trusted certificate.

HRESULT ImportTrustedCertificate(

[in] BSTR bstrCertPath,

[out, retval] long * lID);

All versions

Property InactiveAccountsMonitoring As Boolean

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

Retrieve or specify whether inactive accounts are monitored.

HRESULT InactiveAccountsMonitoring(

[out, retval] VARIANT_BOOL* pVal);

HRESULT InactiveAccountsMonitoring(

[in] VARIANT_BOOL newVal);

Example (VBScript):

Retrieving:

if False = oSite.InactiveAccountsMonitoring then

MsgBox "Disabled"

End If

Specifying:

oSite.InactiveAccountsMonitoring = True

Example (C#):

selectedSite.InactiveAccountsMonitoring = true;

EFT v6.3 and later

Property InvalidAttemptsPeriod As Long

Retrieve or specify the length of time for "Lock out / disable account after N invalid login attempts during time period" option.

HRESULT InvalidAttemptsPeriod(

[out, retval] long *pVal);

HRESULT InvalidAttemptsPeriod(

[in] long newVal);

Example (VBScript):

Site.InvalidAttemptsPeriod = 30

EFT v5.1.1 and later

Property InvalidLoginAttemptsCountToBanIP As Long

Retrieve or specify the number of login attempts after which to ban the IP address.

HRESULT InvalidLoginAttemptsCountToBanIP(

[out, retval] long* pVal);

HRESULT InvalidLoginAttemptsCountToBanIP(

[in] long newVal);

EFT v6.4 and later

Property IPAccessAllowedDefault As Boolean

Retrieve or specify whether IP access is allowed by default.

HRESULT IPAccessAllowedDefault(

[out, retval] VARIANT_BOOL *pVal);

HRESULT IPAccessAllowedDefault(

[in] VARIANT_BOOL newVal);

True = Allowed; False = Denied

All versions

Function IsEncrypted(bstrFolder As String) As Boolean

(Was "IsFolderEncrypted" in v6.2.31)

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

Retrieve or specify whether a specified folder is encrypted.

HRESULT IsEncrypted(

[in] BSTR bstrFolder,

[out,retval] VARIANT_BOOL* pbResult);

Example (VBScript):

if False = oSite.IsEncrypted("/some_folder") then

MsgBox "Not encrypted."

end if

Example (C#):

Console.Write(" Is encrypted with EFS: ");

Console.WriteLine(site.IsEncrypted(folderPath) ? "Yes" : "No");

EFT v6.3 and later

Function IsFolderInherited(bstrFolder As String) As Boolean

Retrieve or specify whether a specified folder is inherited.

HRESULT IsFolderInherited(

[in] BSTR bstrFolder,

[out,retval] VARIANT_BOOL* vbResult);

Example (VBScript):

if False = oSite.IsFolderInherited("/some_folder") then

MsgBox "Not inherited"

end if

EFT v6.2.18 and later

Function IsFolderVirtual(bstrFolderAlias As String) As Boolean

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

Retrieve or specify whether a specified folder is a virtual folder.

HRESULT IsFolderVirtual(

[in] BSTR bstrFolderAlias,

[out,retval] VARIANT_BOOL* pbRes);

Examples (VBScript):

if True = oSite.IsFolderVirtual("/some_folder") then

MsgBox "/some_folder is virtual."

end if

Example (C#):

Console.Write(" Is virtual: ");

Console.WriteLine(site.IsFolderVirtual(folderPath) ? "Yes" : "No");

EFT v6.2.18 and later

Property IsStarted As Boolean

To start or stop a Site via the COM API, refer to:

Start
Stop

Retrieves TRUE if the Site is started, FALSE if it is not started.

HRESULT IsStarted(

[out, retval] VARIANT_BOOL *pVal);

Example (VBScript):

If Not Site.IsStarted Then

Site.Start

End If

All versions

Function KickUser(nUserID As Long) As Boolean

Forcibly log user off of Site.

HRESULT KickUser(

[in] long nUserID,

[out, retval] VARIANT_BOOL *pSuccess);

Example (VBScript):

Dim bResult: bResult = oSite.KickUser(1)

If bResult Then

WScript.Echo "User disconnected successfully."

Else

WScript.Echo "Failed to disconnect the user."

End If

EFT v4.3.4 and later

Property LastModifiedBy As String (read only)

Retrieves username of account that last modified the Site.

HRESULT LastModifiedBy(

[out, retval] BSTR* pVal);

Example (VBScript):

MsgBox "Last modified by " & CStr(oSite.LastModifiedBy)

EFT v6.3 and later

Property LastModifiedTime As Date (read only)

Retrieves the date that the Site was last modified.

HRESULT LastModifiedTime(

[out, retval] DATE* pVal);

Example (VBScript):

MsgBox "Last modified time " & CStr(oSite.LastModifiedTime)

EFT v6.3 and later

Property LimitLoginAttempts As Boolean

Retrieve or specify whether the number of login attempts is limited.

HRESULT LimitLoginAttempts(

[out, retval] VARIANT_BOOL *pVal);

HRESULT LimitLoginAttempts(

[in] VARIANT_BOOL newVal);

True=Enabled; False=Disabled

EFT v5.1.1 and later

Property ListenIPs As Variant

Retrieve or specify the IP addresses on which the server listens.

HRESULT ListenIPs(

[out, retval] VARIANT* pVal);

HRESULT ListenIPs(

[in] VARIANT newVal);

EFT v6.4 and later

Property LockoutNotDisable As Boolean

Retrieve or specify whether account lockout is not disabled.

HRESULT LockoutNotDisable(

[out, retval] VARIANT_BOOL *pVal);

HRESULT LockoutNotDisable(

[in] VARIANT_BOOL newVal);

True=Lockout is not disabled; False=Lockout is disabled

EFT v5.1.1 and later

Property LockoutPeriod As Long

Retrieve or specify the lockout period value. Values are 30, 60, or 90 minutes.

HRESULT LockoutPeriod(

[out, retval] long *pVal);

HRESULT LockoutPeriod(

[in] long newVal);

EFT v5.1.1 and later

Property MaxConcurrentConnections As Long

Retrieve or specify the maximum concurrent connections value.

HRESULT MaxConcurrentConnections(

[out, retval] long *pVal);

HRESULT MaxConcurrentConnections(

[in] long newVal);

All versions

Property MaxConcurrentLogins As Long

Retrieve or specify the maximum concurrent logins value.

HRESULT MaxConcurrentLogins(

[out, retval] LONG *pVal);

HRESULT MaxConcurrentLogins(

[in] LONG newVal);

Secure Server, All versions ; EFT v6.3 and later

Property MaxConnectionsFromSameIP As Long

Retrieve or specify the maximum connections from the same IP address value.

HRESULT MaxConnectionsFromSameIP(

[out, retval] long *pVal);

HRESULT MaxConnectionsFromSameIP(

[in] long newVal);

All versions

Property MaxConnectionsPerUser As Long

Retrieve or specify the maximum socket connections per user value.

HRESULT MaxConnectionsPerUser(

[out, retval] long *pVal);

HRESULT MaxConnectionsPerUser(

[in] long newVal);

All versions

Property MaxInactivePeriod As Long

For an example using this property, refer to the GetCertInfo, ConfigureSite, or ConfigureUser script in Script Examples.

Retrieve or specify the maximum inactive period value.

HRESULT MaxInactivePeriod(

[out, retval] LONG* pVal);

HRESULT MaxInactivePeriod(

[in] LONG newVal);

Example (VBScript):

Retrieving:

MsgBox "Inactive period is: " & CStr(oSite.MaxInactivePeriod)

Specifying:

oSite.MaxInactivePeriod = 90

Example (C#):

selectedSite.MaxInactivePeriod = 30;

EFT v6.3 and later

Property MaxInvalidLoginAttempts As Long

Retrieve or specify the maximum invalid login attempts value.

HRESULT MaxInvalidLoginAttempts(

[out, retval] long *pVal);

HRESULT MaxInvalidLoginAttempts(

[in] long newVal);

EFT v5.1.1 and later

Property MaxInvalidLoginAttemptsPeriodToBanIP As Long

Retrieve or specify the period during which to count invalid login attempts.

HRESULT MaxInvalidLoginAttemptsPeriodToBanIP(

[out, retval] long* pVal);

HRESULT MaxInvalidLoginAttemptsPeriodToBanIP(

[in] long newVal);

EFT v6.4 and later

Property MaxTransferSpeed As Long

Retrieve or specify the maximum transfer speed limit.

HRESULT MaxTransferSpeed(

[out, retval] long *pVal);

HRESULT MaxTransferSpeed(

[in] long newVal);

All versions

Sub MoveIPAccessRule(bstrMask As String, bAllow As Boolean, nRulePos As Long)

See also the following interfaces:

Change allowed or denied IP mask position for the Site.

HRESULT MoveIPAccessRule(

[in] long nRulePosFrom,

[in] long nRulePosTo);

Example (VBScript):

oSite.MoveIPAccessRule(1,2)

EFT v6.3 and later

Sub MoveUserToSettingsLevel(bstrUser As String, bstrGroup As String)

Move a user to another settings template.

HRESULT MoveUserToSettingsLevel(

[in] BSTR bstrUser,

[in] BSTR bstrGroup);

All versions

Property Name As String

Retrieves the name of the Site.

HRESULT Name(

[out, retval] BSTR *pVal);

All versions

Property ODBCSettings As String

Contains all auth manager settings in the form of string (attributes are separated with semicolons).

HRESULT ODBCSettings(

[out, retval] BSTR *pVal);

HRESULT ODBCSettings(

[in] BSTR newVal);

For example, the logon name attribute for an AD\NTLM site is represented by the "ATTR=N" substring. N = 0, 1, 2, or 3:

0 = "NT4 Account Name"

1 = "Display Name"

2 = "User Principal Name"

3 = "Common Name"

EFT v4.3.4 and later

Property PasswordHistorySize As Long

Retrieve or specify the number of previous passwords to save in history.

HRESULT PasswordHistorySize(

[out, retval] LONG* pVal);

HRESULT PasswordHistorySize(

[in] LONG newVal);

Example (VBScript):

Retrieving:

MsgBox "Password history size is: " & CStr(oSite.PasswordHistorySize)

Specifying:

oSite.PasswordHistorySize = 5

EFT v6.3 and later

Property PASVListenIP As Long

Retrieve or specify the PASV listening IP address.

HRESULT PASVListenIP(

[out, retval] long *pVal);

HRESULT PASVListenIP(

[in] long newVal);

All versions

Property PASVPortMax As Long

Retrieve or specify the maximum end of the PASV listening port range.

HRESULT PASVPortMax(

[out, retval] long *pVal);

HRESULT PASVPortMax(

[in] long newVal);

All versions

Property PASVPortMin As Long

Retrieve or specify the minimum end of the PASV listening port range.

HRESULT PASVPortMin(

[out, retval] long *pVal);

HRESULT PASVPortMin(

[in] long newVal);

All versions

Property PGPLogFilePath As String

Retrieve log file path.

HRESULT PGPLogFilePath(

[out, retval] BSTR* pVal);

HRESULT PGPLogFilePath(

[in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "PGP log file path: " & oSite.PGPLogFilePath

Specifying:

oSite.PGPLogFilePath = "C:\PGP\logfile.txt"

EFT v6.3 and later

Property PGPLogLevel As PGPLogLevel

Retrieve or specify the OpenPGP logging level.

HRESULT PGPLogLevel(

[out, retval] PGPLogLevel* pVal);

HRESULT PGPLogLevel(

[in] PGPLogLevel newVal);

PGPLogLevel

PGPLogLevelStandard = 0

PGPLogLevelVerbose = 1

Example (VBScript):

Retrieving:

if PGPLogLevelStandard = oSite.PGPLogLevel

MsgBox "PGP log level is standard."

End If

Specifying:

oSite.PGPLogLevel = PGPLogLevelVerbose

EFT v6.3 and later

Property RadiusConnectionRetriesCount As Long

Retrieve or specify the number of connections retries allowed to connect to the RADIUS server.

HRESULT RadiusConnectionRetriesCount(

[out, retval] long* pVal);

HRESULT RadiusConnectionRetriesCount(

[in] long newVal);

Example (VBScript):

Site.RadiusConnectionRetriesCount = 2

EFT v6.3 and later

Property RadiusNasIdentifier As String

Retrieve or specify the NAS identifier of the RADIUS server.

HRESULT RadiusNasIdentifier(

[out, retval] BSTR* pVal);

HRESULT RadiusNasIdentifier(

[in] BSTR newVal);

Example (VBScript):

MsgBox "NAS identifier: " & CStr(oSite.RadiusNasIdentifier)

EFT v6.3 and later

Property RadiusServerName As String

Retrieve or specify the name of the RADIUS server.

HRESULT RadiusServerName(

[out, retval] BSTR* pVal);

HRESULT RadiusServerName(

[in] BSTR newVal);

Example (VBScript):

MsgBox "Radius server name: " & CStr(oSite. RadiusServerName)

EFT v6.3 and later

Property RadiusServerPort As Long

Retrieve or specify the port number of the RADIUS server.

HRESULT RadiusServerPort(

[out, retval] long* pVal);

HRESULT RadiusServerPort(

[in] long newVal);

Example (VBScript):

oSite. RadiusServerPort = 1645

EFT v6.3 and later

Property RadiusSharedSecret As String

Retrieve or specify the shared secret of the RADIUS server.

HRESULT RadiusSharedSecret(

[out, retval] BSTR* pVal);

HRESULT RadiusSharedSecret(

[in] BSTR newVal);

Example (VBScript):

MsgBox "Radius shared secret: " & CStr(oSite. RadiusSharedSecret)

EFT v6.3 and later

Property RadiusTimeout As Long

Retrieve or specify the timeout for connection attempts to the RADIUS server in milliseconds.

HRESULT RadiusTimeout(

[out, retval] long* pVal);

HRESULT RadiusTimeout(

[in] long newVal);

Example (VBScript):

oSite.RadiusTimeout = 10000

EFT v6.3 and later

Property RedirectHTTPtoHTTPS As Boolean

Retrieve or specify whether to redirect all HTTP traffic to HTTPS. You must restart the Site for the change to take effect. (Refer to Stop and Start below.)

HRESULT RedirectHTTPtoHTTPS(

[out, retval] VARIANT_BOOL* pVal);

HRESULT RedirectHTTPtoHTTPS(

[in] VARIANT_BOOL newVal);

True = Enabled; False = Disabled

Example (VBScript):

Retrieving:

MsgBox "Redirecting is enabled: " & CStr(oSite.RedirectHTTPtoHTTPS)

Specifying:

oSite.EnableAccountManagementOverHTTPS = True

EFT v6.3 and later

Sub RemapVirtualFolder(bstrVFSFolder As String, bstrTarget As String)

Update an existing virtual folder path to point to a specified physical folder.

HRESULT RemapVirtualFolder(

[in] BSTR bstrVFSFolder,

[in] BSTR bstrTarget);

Example (VBScript):

var bResult = oSite.RemapVirtualFolder( "/usr/name", \\\\filer01\\home\\name")

var bResult = oSite.RemapVirtualFolder "/MyVirtualFolder", "c:\testfolder"

EFT v4.3.4 and later

Sub Remove()

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

Remove the Site. The Site object is no longer valid.

HRESULT Remove();

Example (C#):

siteToRemove.Remove();

All versions

Sub RemoveAdvancedWorkflow(lIndex As Long)

Given the Advanced Workflow zero-based index, removes the Workflow from this site

HRESULT RemoveAdvancedWorkflow(

[in] long lIndex); // zero-based index if the AW to remove

Example (VBScript):

‘Remova workflow by name

idxAW = site.GetAdvancedWorkflowIndex(“My Workflow”)

if idxAW -1 Then

site.RemoveAdvancedWorkflow idxAW

End If

EFT v6.5 and later

Sub RemoveCommand(bstrName As String)

Remove a command.

HRESULT RemoveCommand(

[in] BSTR bstrName);

All versions

Sub RemoveFolder(bstrFolder As String)

Remove a folder.

HRESULT RemoveFolder(

[in] BSTR bstrFolder);

All versions

Property RemoveInactiveAccounts As Boolean

For an example using this property, refer to the GetCertInfo, ConfigureSite, or ConfigureUser script in Script Examples.

Retrieve or specify whether to remove inactive accounts.

HRESULT RemoveInactiveAccounts(

[out, retval] VARIANT_BOOL* pVal);

HRESULT RemoveInactiveAccounts(

[in] VARIANT_BOOL newVal);

See also the following interfaces:

Remove allowed or denied IP mask for the Site.

HRESULT RemoveIPAccessRule(

[in] long nRulePos);

Example (VBScript):

oSite.RemoveIPAccessRule(0)

All versions

Sub RemovePendingCertificate(lID As Long)

Remove a pending certificate.

HRESULT RemovePendingCertificate(

[in] long lID);

All versions

Sub RemovePermission(bstrFolder As String, bstrClient As String)

Given Folder and Client remove the permission.

HRESULT RemovePermission(

[in] BSTR bstrFolder,

[in] BSTR bstrClient);

All versions

Sub RemovePermissionGroup(bstrName As String)

Remove a permission group.

HRESULT RemovePermissionGroup(

[in] BSTR bstrName);

All versions

Sub RemoveSettingsLevel(bstrName As String)

Remove a Settings Template.

HRESULT RemoveSettingsLevel(

[in] BSTR bstrName);

All versions

Sub RemoveTrustedCertificate(lID As Long)

Remove a trusted certificate.

HRESULT RemoveTrustedCertificate(

[in] long lID);

All versions

Sub RemoveUser(bstrLogin As String)

Remove a user.

HRESULT RemoveUser(

[in] BSTR bstrLogin);

All versions

Sub RemoveUserFromPermissionGroup(bstrUser As String, bstrGroup As String)

Remove a user from a permission group.

HRESULT RemoveUserFromPermissionGroup(

[in] BSTR bstrUser,

[in] BSTR bstrGroup);

All versions

Sub RenameFolder(bstrSrcFolder As String, bstrDstFolder As String)

Rename a folder.

HRESULT RenameFolder(

[in] BSTR bstrSrcFolder,

[in] BSTR bstrDstFolder);

All versions

Sub RenamePermissionGroup(bstrOldName As String, bstrNewName As String)

Rename a permission group.

HRESULT RenamePermissionGroup(

[in] BSTR bstrOldName,

[in] BSTR bstrNewName);

All versions

Sub RenameSettingsLevel(bstrOldName As String, bstrNewName As String)

Rename a Settings Template.

HRESULT RenameSettingsLevel(

[in] BSTR bstrOldName,

[in] BSTR bstrNewName);

All versions

Sub RenameUser(bstrOldName As String, bstrNewName As String)

Rename a user.

HRESULT RenameUser(

[in] BSTR bstrOldName,

[in] BSTR bstrNewName);

All versions

Property RequireStrongPasswords As Boolean

Retrieve or specify whether strong (complex) passwords are required.

HRESULT RequireStrongPasswords(

[out, retval] VARIANT_BOOL* pVal);

HRESULT RequireStrongPasswords(

[in] VARIANT_BOOL newVal);

TRUE=Enforce strong passwords; FALSE=Do not enforce strong passwords

Example (VBScript):

Retrieving:

MsgBox "Strong passwords for site: " & CStr(oSite.RequireStrongPasswords)

Specifying:

oSite.RequireStrongPasswords = False

EFT v6.3 and later

Sub ResetSubFolders(bstrFolder As String)

Reset subfolders to default permissions.

HRESULT ResetSubFolders(

[in] BSTR bstrFolder);

Example (VBScript):

oSite.ResetSubFolder "/some_folder"

EFT v6.3 and later

Property RSAConfigurationPath

Retrieve the path to the RSA configuration file.

HRESULT RSAConfigurationPath(

[out, retval] BSTR* pVal);

HRESULT RSAConfigurationPath(

[in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "RSA config path: " & oSite.RSAConfigurationPath

Specifying:

oSite.RSAConfigurationPath = "C:\RSAConfig\SDConf.rec"

EFT v6.3 and later

Sub SetAdvancedWorkflowParams(lIndex As Long, pdisplParams As Object)

(See also GetAdvancedWorkflowParams)

Given Advanced Workflow zero-based index, changes the Workflow's parameters

HRESULT SetAdvancedWorkflowParams(

[in] long lIndex, // zero-based index of the AW

[in] IDispatch* pdisplParams); // AW parameters

// as ICIAdvancedWorkflowParams*

Example (VBScript):

‘Rename workflow

idxAW = site.GetAdvancedWorkflowIndex(“My Workflow”)

if idxAW -1 Then

Set AWparams = site.GetAdvancedWorkflowParams(idxAW)

AWparams.Name = “My Workflow – new name”

site.SetAdvancedWorkflowParams idxAW, AWparams

End If

EFT v6.5 and later

Sub SetAllowCOMB(newVal As Boolean)

Specify whether users on the Site are allowed to use multi-part transfers (the COMB command) for FTP transfers.

HRESULT SetAllowCOMB([in] VARIANT_BOOL newVal);

Example (VBScript):

oSite.SetAllowCOMB True

EFT v6.3 and later

Sub SetAllowFXP(newVal As Boolean)

Specify whether users on the Site are allowed to use site-to-site transfers (FXP) for FTP transfers.

HRESULT SetAllowFXP([in] VARIANT_BOOL newVal);

Example (VBScript):

oSite.SetAllowFXP True

EFT v6.3 and later

Sub SetAllowNoop(newVal As Boolean)

Specify whether users on the Site are allowed to use client anti-timeout measures (the NOOP command) for FTP transfers.

HRESULT SetAllowNoop([in] VARIANT_BOOL newVal);

Example (VBScript):

oSite.SetAllowNoop True

EFT v6.3 and later

Sub SetAllowXCRC(newVal As Boolean)

Specify whether users on the Site are allowed to use integrity checking (the XCRC command) for FTP transfers.

HRESULT SetAllowXCRC([in] VARIANT_BOOL newVal);

Example (VBScript):

oSite.SetAllowXCRC True

EFT v6.3 and later

Sub SetAMParams(newVal As Object)

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

Specify authentication manager (AM) parameters.

HRESULT SetAMParams(

[in] IDispatch* newVal);

Example (VBScript)

Set oAMParams = oSite.GetAMParams()

oAMParams.RefreshIntervalMinutes = 10

oSite.SetAMParams(oAMParams)

EFT v6.3 and later

Function SetCertFilePath(newVal As String) As Boolean

Changes the certificate file path and returns TRUE if the Site has to be restarted. (Refer to Stop and Start below.)

HRESULT SetCertFilePath(

[in] BSTR newVal,

[out, retval] VARIANT_BOOL *pNeedRestart);

All versions

Function SetCheckClientCert(newVal As Boolean) As Boolean

Enables or disables the requirement of certificates on an implicit SSL Site. If you must restart the Server for the change to take effect the SetCheckClientCert method returns a value of TRUE. (Refer to Stop and Start below.)

HRESULT SetCheckClientCert(

[in] VARIANT_BOOL newVal,

[out, retval] VARIANT_BOOL *pNeedRestart);

All versions

Sub SetComplexPasswordSettings(pIComplexPasswordSettings As Object)

Specify complex password settings.

HRESULT SetComplexPasswordSettings(

[in] IDispatch* pIComplexPasswordSettings); (v6.3 - 6.3.3)

Example (VBScript):

Set oPwdSettings = oSite.GetComplexPasswordSettings()

oPwdSettings.MinPasswordLength = 8

oSite.SetComplexPasswordSettings(oPwdSettings)

EFT v6.3 and later

Sub SetDefaultPGPKey(bzKeyID As String, bzPassPhrase As String)

Specify the default PGP Key and passphrase. Specify an empty string for the key to assign "no key."

HRESULT SetDefaultPGPKey(

[in] BSTR bzKeyID, [in] BSTR bzPassphrase);

EFT v6.4 and later

Function SetFTPAccess(newVal As Boolean) As Boolean

Enable or disable FTP access and returns TRUE if the Site has to be restarted. (Refer to Stop and Start below.)

HRESULT SetFTPAccess(

[in] VARIANT_BOOL newVal,

[out, retval] VARIANT_BOOL *pNeedRestart);

True = Access enabled; False = Access disabled

All versions

Function SetHTTPAccess(newVal As Boolean) As Boolean

Enables or disables HTTP access and returns TRUE if the Site has to be restarted. (Refer to Stop and Start below.)

HRESULT SetHTTPAccess(

[in] VARIANT_BOOL newVal,

[out, retval] VARIANT_BOOL *pNeedRestart);

True = Access enabled; False = Access disabled

EFT v4.3.4 and later

Function SetHTTPPort(newVal As Long) As Boolean

Changes the HTTP port number of the site and returns TRUE if the Site has to be restarted. (Refer to Stop and Start below.)

HRESULT SetHTTPPort(

[in] long newVal,

[out, retval] VARIANT_BOOL *pNeedRestart);

EFT v4.3.4 and later

Function SetHTTPSAccess(newVal As Boolean) As Boolean

Enables or disables HTTPS access and returns TRUE if the Site has to be restarted. (Refer to Stop and Start below.)

HRESULT SetHTTPSAccess(

[in] VARIANT_BOOL newVal,

[out, retval] VARIANT_BOOL *pNeedRestart);

EFT v4.3.4 and later

Function SetHTTPSPort(newVal As Long) As Boolean

Changes the HTTPS port number of the site and returns TRUE if the Site has to be restarted. (Refer to Stop and Start below.)

HRESULT SetHTTPSPort(

[in] long newVal,

[out, retval] VARIANT_BOOL *pNeedRestart);

EFT v4.3.4 and later

Function SetIP(newVal As Long) As Boolean

Changes the index of Listen IP and returns TRUE if the Site has to be restarted. (Refer to Stop and Start below.)

HRESULT SetIP(

[in] long newVal,

[out, retval] VARIANT_BOOL *pNeedRestart);

All versions

Function SetKeyFilePath(newVal As String) As Boolean

Changes the Site's SSL private key file path and returns TRUE if the Site has to be restarted. (Refer to Stop and Start below.)

HRESULT SetKeyFilePath(

[in] BSTR newVal,

[out, retval] VARIANT_BOOL *pNeedRestart);

All versions

Function SetPassPhrase(newVal As String) As Boolean

Changes the Site's SSL private key passphrase and returns TRUE if the Site has to be restarted. (Refer to Stop and Start below.)

HRESULT SetPassPhrase(

[in] BSTR newVal,

[out, retval] VARIANT_BOOL *pNeedRestart);

All versions

Sub SetPermission(pPermission As Permission, [bRemoveOtherPermissions As Boolean])

Refer to ICIPermission - VFS Permission Interface for the available permission properties.

Adds a new permission or changes an existing one.

HRESULT SetPermission(

[in] IPermission *pPermission,

[in, optional] VARIANT_BOOL bRemoveOtherPermissions);

Example (VBScript):

If you want to set permissions on a folder for a user and remove all other permissions, pass TRUE to the second parameter of setPermission(). This will REMOVE all other permissions from a folder (that is, break the inheritance).

For example,

set perm = Site.GetBlankPermission( "/usr/foo", "foo" )

perm.FileDelete = True

perm.FileUpload = True

perm.FileDownload = False

Site.SetPermission( perm, True )

All versions

Function SetPort(newVal As Long) As Boolean

Changes the port number and returns TRUE if the Site has to be restarted. (Refer to Stop and Start below.)

HRESULT SetPort(

[in] long newVal,

[out, retval] VARIANT_BOOL *pNeedRestart);

All versions

Sub SetResetPasswordSettings(pIResetPasswordSettings As Object)

Use ICISite::GetResetPasswordSettings and ICISite::SetResetPasswordSettings to retrieve and set the password settings for a Site.

Specify password reset settings.

HRESULT SetResetPasswordSettings(

[in] ICIResetPasswordSettings* pIResetPasswordSettings); (v6.3 - 6.3.3)

[in] IDispatch* pIResetPasswordSettings); (v6.3.8 and later)

Example (VBScript):

Set oPwdSettings = oSite.GetResetPasswordSettings()

PwdSettings.MaxPasswordAgeDays = 8

oSite.SetResetPasswordSettings(oPwdSettings)

EFT v6.3 and later

Function SetRootFolder(newVal As String) As Boolean

Changes the root folder of the site and returns TRUE if the site has to be restarted. (Refer to Stop and Start below.)

HRESULT SetRootFolder(

[in] BSTR newVal,

[out, retval] VARIANT_BOOL *pNeedRestart);

All versions

Function SetSSHKeyFilePath(newVal As String) As Boolean

Changes the SSH Certificate file path and returns TRUE if the Site has to be restarted. (Refer to Stop and Start below.)

HRESULT SetSSHKeyFilePath(

[in] BSTR newVal,

[out, retval] VARIANT_BOOL *pNeedRestart);

Example (VBScript):

Dim bNeedRestart: bNeedRestart = oSite.SetSSHKeyFilePath("C:\Keys\Key.pvk")

If bNeedRestart Then

Call oSite.Stop()

Call oSite.Start()

End If

EFT 4.3.4 and later

Function SetSSLAuth(newVal As Boolean) As Boolean

Enables or disables SSL authentication and returns TRUE if the Site has to be restarted. (Refer to Stop and Start below.)

HRESULT SetSSLAuth(

[in] VARIANT_BOOL newVal,

[out, retval] VARIANT_BOOL *pNeedRestart);

All versions

Sub SetSSLCertificate(bzCertFilePath As String, bzKeyFilePath As String, bzPassPhrase As String)

Specifies the Site's SSL certificate file path, key file path, and passphrase.

HRESULT SetSSLCertificate(

[in] BSTR bzCertFilePath,

[in] BSTR bzKeyFilePath,

[in] BSTR bzPassPhrase);

Example (VBScript):

Site.SetSSLCertificate "C:\MySite.crt", "C:\ MySite.key", "My-Site_passwd"

EFT v6.1 and later

Function SetSSLImp(newVal As Boolean) As Boolean

Enables or disables SSLImp and returns TRUE if the Site has to be restarted. (Refer to Stop and Start below.)

HRESULT SetSSLImp(

[in] VARIANT_BOOL newVal,

[out, retval] VARIANT_BOOL *pNeedRestart);

All versions

Property SFTPEnCoding as string

Refer to TransferEnCodingType in the Enum Reference.

Retrieves or specifies the transfer enCoding mode for SFTP. TransferEnCodingUTF8 and TransferEnCodingASCII are the only valid values for this property.

HRESULT SFTPEnCoding([out, retval] TransferEnCodingType* pVal);

HRESULT SFTPEnCoding([in] TransferEnCodingType newVal);

Example (VBScript):

Retrieving:

If Site.SFTPEnCoding = 1 Then

‘UTF-8 mode

End If

Specifying:

‘set UTF-8 mode for SFTP

Site.SFTPEnCoding = 1f

EFT v6.5 and later

Property SFTPEnCodingAlgorithms As String

Retrieves the allowed ciphers. You must restart the Site for changes to take effect.

HRESULT SFTPEnCodingAlgorithms(

[out, retval] BSTR* pVal);

HRESULT SFTPEnCodingAlgorithms(

[in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "SFTP ciphers: " & oSite.SFTPEnCodingAlgorithms

Specifying:

oSite.SFTPEnCodingAlgorithms = "twofish256-cbc,twofish-cbc,twofish128-cbc,blowfish-cbc"

EFT v6.3 and later

Property SFTPIdentificationComment As String

Retrieves the SFTP comments. You must restart the Site for changes to take effect. (Refer to Stop and Start below.)

HRESULT SFTPIdentificationComment(

[out, retval] BSTR* pVal);

HRESULT SFTPIdentificationComment(

[in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "SFTP comments: " & oSite.SFTPIdentificationComment

Specifying:

oSite.SFTPIdentificationComment = "GlobalSCAPE"

EFT v6.3 and later

Property SFTPKeyFile As String

Retrieves the path to the SFTP key. You must restart the Site for changes to take effect. (Refer to Stop and Start below.)

HRESULT SFTPKeyFile(

[out, retval] BSTR* pVal);

HRESULT SFTPKeyFile(

[in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "SFTP private key file is: " & oSite.SFTPKeyFile

Specifying:

oSite.SFTPKeyFile = "C:\SFTPPriveteKeys\key1"

EFT v6.3 and later

Property SFTPKeyPassphrase As String

Retrieves the SFTP key passphrase. You must restart the Site for changes to take effect. (Refer to Stop and Start below.)

HRESULT SFTPKeyPassphrase(

[out, retval] BSTR* pVal);

HRESULT SFTPKeyPassphrase(

[in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "SFTP private key passphrase is: " & oSite.SFTPKeyPassphrase

Specifying:

oSite.SFTPKeyPassphrase = "new_passphrase"

EFT v6.3 and later

Property SFTPMacAlgorithms As String

Retrieves the list of allowed MAC algorithms. You must restart the Site for changes to take effect. (Refer to Stop and Start below.)

HRESULT SFTPMacAlgorithms(

[out, retval] BSTR* pVal);

HRESULT SFTPMacAlgorithms(

[in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "SFTP MAC algoriphms: " & oSite.SFTPMacAlgorithms

Specifying:

oSite.SFTPMacAlgorithms = "hmac-sha1,hmac-md5,hmac-sha1-96,hmac-md5-96"

EFT v6.3 and later

Property SFTPPort As Long

Retrieve or specify the SFTP port number. You must restart the Site for the change to take effect. (Refer to Stop and Start below.)

HRESULT SFTPPort(

[out, retval] LONG* pVal);

HRESULT SFTPPort(

[in] LONG newVal);

Example (VBScript):

Retrieving:

MsgBox "SFTP port: " & CStr(oSite.SFTPPort)

Specifying:

oSite.SFTPPort = 40

EFT v6.3 and later

Property SFTPPublicKeyBlob As String (read only)

Retrieves the SFTP public key blob.

HRESULT SFTPPublicKeyBlob(

[out, retval] BSTR* pVal);

Example (VBScript):

MsgBox "SFTP public key blob: " & oSite.SFTPPublicKeyBlob

EFT v6.3 and later

Property SFTPSoftwareVersion As String

Retrieves the SFTP software version. You must restart the Site for changes to take effect. (Refer to Stop and Start below.)

HRESULT SFTPSoftwareVersion(

[out, retval] BSTR* pVal);

HRESULT SFTPSoftwareVersion(

[in] BSTR newVal);

Example (VBScript):

Retrieving:

MsgBox "SFTP software: " & oSite.SFTPSoftwareVersion

Specifying:

oSite.SFTPSoftwareVersion = "1.82_sshlib"

EFT v6.3 and later

Sub Start()

Starts the Site.

HRESULT Start();

All versions

Sub Stop()

Stops the Site.

HRESULT Stop();

All versions

Property TwoFactorAuthentication TwoFactorAuthenticationMode

Retrieve or specify the two-factor authentication mode.

HRESULT TwoFactorAuthentication(

[out, retval] TwoFactorAuthenticationMode* pVal);

HRESULT TwoFactorAuthentication(

[in] TwoFactorAuthenticationMode newVal);

EFT v6.3 and later

Sub UnbanIP(bstrMask As String) (read only)

Removes denied IP mask from the Autoban list for the Site

HRESULT UnbanIP(

[in] BSTR bstrMask //mask to remove

);

Example (VBScript):

oSite.UnbanIP("1.2.3.4")

Property UnderPCIDSS As Boolean (read only)

Returns VARIANT_TRUE if the Site is under PCI DSS policy. Used to query the Site to determine if it is a strict security/PCI DSS-enabled Site.

HRESULT UnderPCIDSS(

[out, retval] VARIANT_BOOL * pVal);

Example (VBScript):

MsgBox "Under PCIDSS: " & CStr(oSite.UnderPCIDSS)

EFT v6.3.1 and later

Function UnlockUser(bstrUserName As String) As Boolean

Retrieve whether a user account is locked and unlock the account.

HRESULT UnlockUser(

[in] BSTR bstrUserName,

[out, retval] VARIANT_BOOL *pSuccess);

TRUE=Unlocked; FALSE=Locked

Example (VBScript):

if False = oSite.UnlockUser("User1") then

MsgBox "Cannot unlock user."

End if

EFT v6.3 and later

Property UseDynamicPGPLogFile

Retrieve or specify whether to use dynamic log file.

HRESULT UseDynamicPGPLogFile(

[out, retval] VARIANT_BOOL* pVal);

HRESULT UseDynamicPGPLogFile(

[in] VARIANT_BOOL newVal);

Example (VBScript):

Retrieving:

MsgBox "PGP uses dynamic log file:" & CStr(oSite.UseDynamicPGPLogFile)

Specifying:

oSite.UseDynamicPGPLogFile = true

EFT v6.3 and later

Property UserLimitMessage As String

Retrieve or specify user limit message.

HRESULT UserLimitMessage(

[in] BSTR newVal);

[out, retval] BSTR *pVal);

All versions

Property UsersDefined As Long (read only)

Retrieves the number of user accounts defined on the Site.

HRESULT UsersDefined(

[out, retval] LONG* pVal)

Example (VBScript):

MsgBox "Users count: " & CStr(oSite.UsersDefined)

EFT v6.3 and later

Function ValidatePassword(bstrUser As String, bstrPwd As String) As Boolean

Validates a user's password.

HRESULT ValidatePassword(

[in] BSTR bstrUser,

[in] BSTR bstrPwd,

[out, retval] VARIANT_BOOL *bValid);

Example (VBScript):

If oSite.ValidatePassword( "test", "pass") Then

WScript.Echo "Valid password"

End If

EFT v3.5.1 and later

Property VFSFilter As String

Retrieve or specify list of banned file types.

HRESULT VFSFilter(

[out, retval] BSTR *pVal);

[in] BSTR newVal);

All versions

Property WTCSessionsActive As Long (read only)

Retrieves the number of active WTC sessions in use.

HRESULT WTCSessionsActive(

[out, retval] LONG* pVal);

Example (VBScript):

MsgBox "WTC sessions count: " & CStr(oSite.WTCSessionsActive)

EFT v6.3 and later

Property WTCSessionsRemaining As Long (read only)

Retrieves the number of WTC sessions available.

HRESULT WTCSessionsRemaining(

[out, retval] LONG* pVal);

Example (VBScript):

MsgBox "WTC sessions remaining: " & CStr(oSite.WTCSessionsRemaining)

EFT v6.3 and later

Dialog Box Equivalents

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

Site General Settings

Site RADIUS Authentication Settings

The ICISite RADIUS authentication properties correlate to the following fields and controls in the EFT administration interface:

Site RSA Configuration Setting

Site ODBC Settings

The ODBCSettings property correlates to the Use this user attribute as logon name setting in the Windows Authentication Options dialog box. Other substrings appearing in the string depend on settings in the Windows Authentication Options dialog box. For example, if Create a virtual folder pointing to the user's home folder as defined in his/her AD profile is selected, the "CreateVirtualHF=1" substring is present in the ODBCSettings string; if Create a physical folder under the site root folder using the user's login name is selected, the "CreateVirtualHF=1" substring is not present in the ODBCSettings string.

Site Listener Settings (Connections Tab)

Site Connection Limits

Site IP Access Rules

Site Anti-flood/Hammer Settings

Site AS2 Settings

Site FTP Settings

Site Security Settings

Site Banned File Types

The Site data security settings can be viewed or set in the administration interface on the Site's Security tab.

Site Login Security Options

Site OpenPGP Security Settings

Site SFTP Settings

Site SSL Certificate Settings

These parameters also can be viewed/set in the Administrator interface on the Connections tab of the Site.

Site Groups

If this help topic did not help you, search the Knowledgebase or pose your question in the GlobalSCAPE User Forum.

For the most up-to-date information, to view version history, updates, and activation instructions; or to download a PDF of this user guide, visit the Support Center at http://www.globalscape.com/support.

Leave compliments or complaints regarding the help in the User Forum. At a minimum, please provide the topic title and why you needed help.

For information about GlobalSCAPE, visit www.globalscape.com, subscribe to our Secure Info Exchange blog, or follow us on Twitter.

Last modified: 14-May-13 at 9:50:34