Monitored Events

<< Click to Display Table of Contents >>

Navigation:  Handling Events via Scripting >

Monitored Events

These is a list of available event-handlers. You can configure your Syncplify.me Server! to run scripts when one (or more) of the following events occur:

 

Events related to connection establishment:

OnClientConnection: occurs when a client is trying to connect to the server, regardless of the protocol

BeforeSendSoftwareID: occurs just before client and server exchange information regarding the software they're running

 

Events related to the blacklist:

OnClientBlacklisted: occurs when a client IP address gets blacklisted

 

Authentication/authorization-related events:

OnAuthRequest: occurs when a user is requesting to authenticate (Username is available, but Password or Key aren't available yet at this point)

OnAuthPassword: occurs when a user sends a Password in order to authenticate

OnAuthPKI: occurs when a user tries to authenticate via PKI (SSH/SFTP only)

OnAuthInteractive: occurs when a user tried to authenticate via a Keyboard-interactive method (SSH/SFTP only)

OnAuthFail: occurs when a user has failed to authenticate

OnAuthSuccess: occurs when a user has authenticated successfully

 

Events related to subsystem establishment (SSH/SFTP only):

BeforeOpenSFTP: occurs when a user requests to open the SFTP subsystem

BeforeOpenShell: occurs when a user requests to open a Shell

BeforeOpenCmd: occurs when a user requests to execute a Command on the server

BeforeOpenClientFwd: occurs when a user requests to open a client forwarding tunnel

BeforeOpenServerFwd: occurs when a user requests to open a server forwarding tunnel

 

Events related to file-system, file and directory operations:

BeforeMakeDir: occurs just before a directory is created (allows to deny the operation via script)

BeforeListDir: occurs before a directory-list request is accepted (allows to deny the operation via script)

BeforeSendDirListToClient: occurs after the directory-list has been collected but before it is sent to the client (allows to remove unwanted items via script using the RemoveFromDirList method)

BeforeDeleteDir: occurs just before a directory is deleted (allows to deny the operation via script)

BeforeRenameDir: occurs just before a directory is renamed (allows to deny the operation via script)

BeforeDeleteFile: occurs just before a file is deleted (allows to deny the operation via script)

BeforeRenameFile: occurs just before a file is renamed (allows to deny the operation via script)

BeforeModifyFile: occurs just before a file is modified/appended-to (allows to deny the operation via script)

BeforeFileUpload: occurs just before a new file is uploaded (allows to deny the operation via script)

BeforeFileDownload: occurs just before a file is downloaded (allows to deny the operation via script)

AfterMakeDir: occurs right after a directory is created

AfterListDir: occurs right after a directory-list is sent to the client that requested it

AfterDeleteDir: occurs right after a directory is deleted

AfterRenameDir: occurs right after a directory is renamed

AfterDeleteFile: occurs right after a file is deleted

AfterRenameFile: occurs right after a file is renamed

AfterModifyFile: occurs right after a file is modified (for example some data has been appended to an existing file)

AfterFileUpload: occurs right after a file is uploaded

AfterFileDownload: occurs right after a file is downloaded

OnUploadFail: occurs when a file upload fails (for example when there's an "access denied" error on the server or the client sends the ABOR command)

OnDownloadFail: occurs when a file download fails (for example when there's an "access denied" error on the server or the client sends the ABOR command)

BeforeFileCopy: occurs just before a file is copied on the server (SFTP only)

AfterFileCopy: occurs right after a file is copied on the server (SFTP only)

BeforeFileCombineRequest: occurs just before a set of files are combined on the server (SFTP only)

AfterFileCombineRequest: occurs right after a set of files are combined on the server (SFTP only)

BeforeAttrChange: occurs just before an object (file/directory) attributes are changed (SFTP only)

AfterAttrChanged: occurs right after an object (file/directory) attributes are changed (SFTP only)

BeforeTimeChange: occurs just before a file timestamp is modified

AfterTimeChange: occurs right after a file timestamp is modified

OnCheckFileExist: occurs when a client explicitly requests to verify the existence of a file on the server (SFTP only)

OnFileSizeRequest: occurs whe a client requests the size of a file on the server (FTP/S protocols only)

OnFileHashRequest: occurs when a client requests the hash code of a file on the server

OnFileMDTMRequest: occurs when a client sends a MDTM request to the server (FTP/S protocols only)

OnReqAvailDisk: occurs when a client requests the server's available disk space (SFTP only)

 

Special or non-standard events:

OnCustomSITECommand: occurs when a client sends a custom SITE command (FTP/S protocols only)

 

Events related to session/subsystem closure:

OnSFTPClose: occurs when an SSH or SFTP connection ends

OnFTPSClose: occurs when an FTP, FTPS or FTPES connection ends