ICISite - Single Interface

ICISite 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)

interface ICISite : IDispatch

Jump to: B C D E F G H I K L M N O P R S T U V W

Scroll down for dialog box equivalents.

For SFTPAdvBool, used below:

abInherited = -2 (&HFFFFFFFE)
abFalse = 0
abTrue = 1

For PwdType, used below:

0 = Regular (hashed)
1 = Anonymous (regular with empty password)(removed in v7.3.3.21 and later)
2 = Anonymous (require email as password) (removed in v7.3.3.21 and later)
3 = OTP-MD4 (removed in v7.3.3.21 and later)
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
6 = nPwdType - For importing hashes of unknown type from another source. (When the user logs into EFT, EFT would cycle through possible hashes for the plaintext password to see which one matches the supplied hash. When a match is found, the user is able to log in. As well, EFT will rehash the password with its current default hashing algorithm and store that as the user's hashed password.)

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

Members (Listed alphabetically)

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 
	 *l[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
Next

All versions

Function AddConnectionProfile(pdispParams As Object) As Long

See also the following interfaces:

Sub AddUploadForm(pUploadForm As Object)

Used to add a new Upload Form to the Site.

HRESULT AddUploadForm([in] IDispatch* pUploadForm);

EFT v8.0.4 and later

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

Function AdvancedWorkflowFolders() As Object

Site's Advanced Workflow folders for organizing workflows.

HRESULT AdvancedWorkflowFolders([out, retval] IDispatch** ppdispAdvancedWorkflowFolders);

EFT v8.1 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 AllowClearCommandChannel As Boolean

Used to enable or disable clear command channel.

HRESULT AllowClearCommandChannel([in] VARIANT_BOOL newVal);
HRESULT AllowClearCommandChannel([out, retval] VARIANT_BOOL *pVal);

EFT v8.0.5 and later

Property AllowEmailLoginCredentials As Boolean

Retrieves or specifies 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 AllowUnprotectedDataChannel As Boolean

Used to enable or disable unprotected data channel.

HRESULT AllowUnprotectedDataChannel([out, retval] VARIANT_BOOL *pVal);
HRESULT AllowUnprotectedDataChannel([in] VARIANT_BOOL newVal);

EFT v8.0.5 and later

Property AllowSuppressForgotPassword As Boolean

HRESULT AllowSuppressForgotPassword([out, retval] VARIANT_BOOL *pVal);
HRESULT AllowSuppressForgotPassword([in] VARIANT_BOOL newVal);

EFT v7.4.11

Property AllowUPVariables As Boolean

Retrieves or specifies 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 AllowWorkspacesOAIReply As Boolean

HRESULT AllowWorkspacesOAIReply([out, retval] VARIANT_BOOL *pVal);
HRESULT AllowWorkspacesOAIReply([in] VARIANT_BOOL newVal);

EFT v7.4.7 and later

Property AS2AccountManagementPath As String (read only)

Retrieves 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

Retrieves or specifies 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

Retrieves or specifies 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

Retrieves or specifies 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

Retrieves or specifies 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)

Updates 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.

Retrieves 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

Retrieves or specifies 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

Retrieves or specifies 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.

Retrieves 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

NOTE: 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)

Retrieves 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

Retrieves or specifies 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

Retrieves or specifies 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

Retrieves or specifies 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

Retrieves or specifies 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)

Changes a user's password and password type.

HRESULT ChangeUserPassword([in] BSTR bstrUser,
[in] BSTR bstrPwd,
[in] int nPwdType);

Example:

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

6 = nPwdType - For importing hashes of unknown type from another source. (When the user logs into EFT, EFT would cycle through possible hashes for the plaintext password to see which one matches the supplied hash. When a match is found, the user is able to log in. As well, EFT will rehash the password with its current default hashing algorithm and store that as the user's hashed password.)

NOTE: 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)

Retrieves 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
Next

EFT v6.3 and later

Property ConnectMessage As String

Retrieves or specifies the connect message.

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

All versions

Property ContentIntegrityControlProfileList

Provides read-only list of CIC profiles

HRESULT ContentIntegrityControlProfileList([out, retval] VARIANT *pVal);

EFT v8

Function CreateCommand(bstrName As String) As CICommandSettings

Creates a new command.

HRESULT CreateCommand(
[in] BSTR bstrName,
[out, retval] ICICommandSettings **prop);

All versions

Function CreateComplexPassword([bstrUserName]) As String

Creates 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

Creates 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 CreateGuestSettingsLevel(bstrName As String)

HRESULT CreateGuestSettingsLevel([in] BSTR bstrName);

EFTv7.4 and later

See also the following interfaces:

ICIAutobanIPAccessRule Interface

ICIBannedIP Interface

ICIIPAccessRule Interface

ICIManualIPAccessRule Interface

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
Next

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 GetPCIDSSComplianceStatus(plPassed As Long, plWarning As Long, plComControl As Long, plFailed As Long)

HRESULT GetPCIDSSComplianceStatus(
[out] LONG* plPassed, 
[out] LONG* plWarning, 
[out] LONG* plComControl, 
[out] LONG* plFailed);

EFT v7.3 and later

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)
Next

All versions

Function GetPermissionGroups() As Variant

Retrieves an array of users in a permission group. (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

Transforms a 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

Retrieves the port number of the Site.

HRESULT GetPort([out, retval] long *prop);

All versions

Function GetPrivacyPolicy() As Object ()

Retrieves the Privacy Policy settings (ICIPrivacyPolicy)

HRESULT GetPrivacyPolicy([out, retval] IDispatch **pdispParams);

Example (VBScript):

set pp = oSite.GetPrivacyPolicy

See also the following interfaces:

ICIAutobanIPAccessRule Interface

ICIBannedIP Interface

ICIIPAccessRule Interface

ICIManualIPAccessRule Interface

Changes 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)

Moves a user to another Settings Template.

HRESULT MoveUserToSettingsLevel([in] BSTR bstrUser,[in] BSTR bstrGroup);

All versions

Property MTCAllowFileCaching As Boolean

Turns on or off file caching for the Mobile Transfer Client.

HRESULT MTCAllowFileCaching([in] VARIANT_BOOL newVal);
HRESULT MTCAllowFileCaching([out, retval] VARIANT_BOOL* pVal);

EFT v6.5.16 and later

Property MTCAllowFileOpening As Boolean

Turns on or off ability to open files in external apps for the Mobile Transfer Client.

HRESULT MTCAllowFileOpening([in] VARIANT_BOOL newVal);
HRESULT MTCAllowFileOpening([out, retval] VARIANT_BOOL* pVal);

EFT v6.5.16 and later

Property MTCAllowFileSharing As Boolean

Turns on or off file sharing for the Mobile Transfer Client.

HRESULT MTCAllowFileSharing([in] VARIANT_BOOL newVal);
HRESULT MTCAllowFileSharing([out, retval] VARIANT_BOOL* pVal);

EFT v6.5.16 and later

Property MTCAllowSavingOffline As Boolean

Turns on or off saving files offline for the Mobile Transfer Client.

HRESULT MTCAllowSavingOffline([in] VARIANT_BOOL newVal);
HRESULT MTCAllowSavingOffline([out, retval] VARIANT_BOOL* pVal);

EFT v6.5.16 and later

Property MTCAllowSavingPasswords As Boolean

Turns on or off saving Mobile Transfer Client profile passwords on the device for the Mobile Transfer Client

HRESULT MTCAllowSavingPasswords([in] VARIANT_BOOL newVal);
HRESULT MTCAllowSavingPasswords([out, retval] VARIANT_BOOL* pVal);

EFT v6.5.16 and later

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 OverrideVFSCredentialsEnable As Boolean

Retrieves or specifies the number of previous passwords to save in history.

HRESULT OverrideVFSCredentialsEnable([out, retval] VARIANT_BOOL* pVal);
HRESULT OverrideVFSCredentialsEnable([in] VARIANT_BOOL newVal)

EFT v8.0.1 and later

Property OverrideVFSCredentialsLogin As String

Retrieves or specifies the number of previous passwords to save in history.

HRESULT OverrideVFSCredentialsLogin([out, retval] BSTR *pVal);
HRESULT OverrideVFSCredentialsLogin([in] BSTR newVal);

EFT v8.0.1 and later

Property OverrideVFSCredentialsPasswords As String

Retrieves or specifies the number of previous passwords to save in history.

HRESULT OverrideVFSCredentialsPassword([out, retval] BSTR *pVal);
HRESULT OverrideVFSCredentialsPassword([in] BSTR newVal);

EFT v8.0.1 and later

Property PasswordHistorySize As Long

Retrieves or specifies 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

Retrieves or specifies the PASV listening IP address.

HRESULT PASVListenIP([out, retval] long *pVal);
HRESULT PASVListenIP([in] long newVal);

All versions

Property PASVPortMax As Long

Retrieves or specifies 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

Retrieves or specifies the minimum end of the PASV listening port range.

HRESULT PASVPortMin([out, retval] long *pVal);
HRESULT PASVPortMin([in] long newVal);

All versions

Property PGPEmailExpirationRecipientsList As String

HRESULT PGPEmailExpirationRecipientsList([out, retval] BSTR* pVal);
HRESULT PGPEmailExpirationRecipientsList([in] BSTR newVal);

EFT v8.0.6 and later

Property PGPSendEmailExpirationCopyToAssociatedUser As Boolean

HRESULT PGPSendEmailExpirationCopyToAssociatedUser([out, retval] VARIANT_BOOL* pVal); 
HRESULT PGPSendEmailExpirationCopyToAssociatedUser([in] VARIANT_BOOL newVal);

EFT v8.0.6 and later

Property PGPSendEmailPriorExpiration As Boolean

HRESULT PGPSendEmailPriorExpiration([out, retval] VARIANT_BOOL* pVal);
HRESULT PGPSendEmailPriorExpiration([in] VARIANT_BOOL newVal);

EFT v8.0.6 and later

Property PGPSendEmailUponExpiration As Boolean

HRESULT PGPSendEmailUponExpiration([out, retval] VARIANT_BOOL* pVal);
HRESULT PGPSendEmailUponExpiration([in] VARIANT_BOOL newVal);

EFT v8.0.6 and later

Property PGPTimePriorExpirationInDays As Long

HRESULT PGPTimePriorExpirationInDays([out, retval] LONG* pVal);
HRESULT PGPTimePriorExpirationInDays([in] LONG newVal);

EFT v8.0.6 and later

Property PGPKeys As String

Retrieves a list of the Site's PGP Keys. Its value is a variant containing the array of ICIPGPKeyInfo

HRESULT PGPKeys([out, retval] VARIANT* pVal);

Example (VBScript):

For Each key In oSite. PGPKeys
MsgBox key.Name & "key is available"
Next

EFT v8 and later

Property PGPLogFilePath As String

Retrieves or specifies the 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

Retrieves or specifies 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

Sub Propagate(targetEndpoint As String, targetAdminUsername As String, targetAdminPassword As String, exportDir As String)

HRESULT Propagate([in] BSTR targetEndpoint, [in] BSTR targetAdminUsername, [in] BSTR targetAdminPassword, [in] BSTR exportDir);

EFT v8.2

Sub PropagateAdvancedWorkflow(workflowName As String, targetEndpoint As String, targetSiteName As String, targetAdminUsername As String, targetAdminPassword As String)

HRESULT PropagateAdvancedWorkflow([in] BSTR workflowName, [in] BSTR targetEndpoint, [in] BSTR targetSiteName, [in] BSTR targetAdminUsername, [in] BSTR targetAdminPassword);

EFT v8.2

Sub PropagateCommand(commandName As String, targetEndpoint As String, targetSiteName As String, targetAdminUsername As String, targetAdminPassword As String)

HRESULT PropagateCommand([in] BSTR commandName, [in] BSTR targetEndpoint, [in] BSTR targetSiteName, [in] BSTR targetAdminUsername, [in] BSTR targetAdminPassword);

EFT v8.2

Sub PropagateConnectionProfile(profileName As String, targetEndpoint As String, targetSiteName As String, targetAdminUsername As String, targetAdminPassword As String)

HRESULT PropagateConnectionProfile([in] BSTR profileName, [in] BSTR targetEndpoint, [in] BSTR targetSiteName, [in] BSTR targetAdminUsername, [in] BSTR targetAdminPassword);

EFT v8.2

Property RadiusConnectionRetriesCount As Long

Retrieves or specifies 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

Retrieves or specifies 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

Retrieves or specifies 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

Retrieves or specifies 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

Retrieves or specifies 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

Retrieves or specifies 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 RecalculateClientUsedSpace (BSTR bstrUser)

Recalculates user disk quota for specified user.

Example (VBScript):

object[] users = site.GetUsers() as object[];
	foreach (string user in users)
	{
	site.RecalculateClientUsedSpace(user);
	}

EFT v7.4.13 and later

Property RedirectHTTPtoHTTPS As Boolean

Retrieves or specifies 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)

Updates an existing virtual folder path to point to a 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 RemapVirtualFolders(paths)

HRESULT RemapVirtualFolders([in] VARIANT paths);

EFT v7.4.13

Function RemoteEventRules(type As EventType) As Object

HRESULT RemoteEventRules([in] EventType type, [out, retval] IDispatch** ppdispRules);

EFT v7.4.11 and later

Sub Remove()

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

Removes the Site. After removal, the Site object is no longer available.

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):

‘Remove 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)

Removes a command.

HRESULT RemoveCommand([in] BSTR bstrName);

All versions

Sub RemoveConnectionProfile(lIndex As Long)

See also the following interfaces:

ICIAutobanIPAccessRule Interface

ICIBannedIP Interface

ICIIPAccessRule Interface

ICIManualIPAccessRule Interface

Removes 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)

Removes a pending certificate.

HRESULT RemovePendingCertificate([in] long lID);

All versions

Sub RemovePermission(bstrFolder As String, bstrClient As String)

Given Folder and Client removes the permission.

HRESULT RemovePermission([in] BSTR bstrFolder,[in] BSTR bstrClient);

All versions

Sub RemovePermissionGroup(bstrName As String)

Removes a permission group.

HRESULT RemovePermissionGroup([in] BSTR bstrName);

All versions

Sub RemovePGPKey(bstrKeyId As String)

Removes PGPKey from Site by key's ID.

HRESULT RemovePGPKey([in] BSTR bstrKeyId);

Example (VBScript):

oSite.RemovePGPKey "0x01234567"

See also CreatePGPKey, ExportPGPKey, and ImportPGPKey.

EFT v8 and later

Sub RemoveSettingsLevel(bstrName As String)

Removes a Settings Template.

HRESULT RemoveSettingsLevel([in] BSTR bstrName);

All versions

Sub RemoveSSHKey (keyIndex As Long)

NOTE: Deprecated in v8

Removes SSH key from site by key’s index in SSHKeys array.

HRESULT RemoveSSHKey([in] LONG keyIndex);

Example (VBScript):

oSite.RemoveSSHKey keyIndex