BPS-Events Manager-Variables
Listing of %VARS to be used in the Events Manager of BulletProof FTP Server for SMTP and HTTP Form-Post (NVP) event actions.REVISION HISTORY:
Variable | Description | Scope | Context | Units/Example |
---|---|---|---|---|
%BDOWN | Data Transferred by FTP-Account | Current Session | Download | Bytes |
%BDOWNALL | Data Transferred by FTP-Account | All Sessions | Download | Bytes |
%BTOT | Data Transferred by FTP-Account | All Sessions | Up/Down | Bytes |
%BUP | Data Transferred by FTP-Account | Current Session | Upload | Bytes |
%BUPALL | Data Transferred by FTP-Account | All Sessions | Upload | Bytes |
%C24H | Number of Connections by FTP-Account | Current Session | 24 Hours | integer-value |
%CALL | Number of Connections by FTP-Account | Current Session | Forever | integer-value |
%CLIENTGROUP | Group Account | Current Session | User Manager -> Login -> Group Name | agroupname |
%CLIENTIP | IP Address | Current Session | Obtained from Network | 192.168.0.1 |
%CLIENTIP_000 | IP Address (Zero Padded) | Current Session | Obtained from Network | 192.168.000.001 |
%CLIENTLOGIN | Username used to Login | Current Session | User Manager -> Login -> Group Name | ausername |
%CLIENTNAME | Account-Name | Current Session | User Manager -> Login -> Group Name | aaccountname |
%CLIENTPASSWORD | Password used to Login | Current Session | User Manager -> Login -> Group Name | apassword |
%CNOW | Number of Connections by FTP-Account | Current Session | Current | integer-value |
%DATE | Current Date | System | Obtained from OS | Locale-Specific |
%DATE_EX | Current Date | System | Obtained from OS | mmddyyyy |
%DATE_EX_DMY | Current Date | System | Obtained from OS | dd-mm-yyyy |
%DATE_EX_MDY | Current Date | System | Obtained from OS | mm-dd-yyyy |
%DATE_EX_YMD | Current Date | System | Obtained from OS | yyyy-mm-dd |
%DFREE | Diskspace Free | Current Session | Current Working Directory | Bytes |
%DFREEGB | Diskspace Free | Current Session | Current Working Directory | GiBytes |
%DFREEKB | Diskspace Free | Current Session | Current Working Directory | KiBytes |
%DFREEMB | Diskspace Free | Current Session | Current Working Directory | MiBytes |
%DIR_8.3 | Directory Name of Target FTP Command | Current Sessions | N/A | string (FAT32 shortened) |
%DIRCREATED | Created Directory Name | Current Sessions | N/A | string |
%DIRDELETED | Deleted Directory Name | Current Sessions | N/A | string |
%DIRFULLNAME | Directory Name of Target FTP Command | Current Sessions | N/A | string |
%DIRTARGET | Directory Name of Target FTP Command | Current Sessions | N/A | string |
%DIRTARGET_8.3 | Directory Name of Target FTP Command | Current Sessions | N/A | string (FAT32 shortened) |
%DISK | Drive Letter | Current Session | Current Working Directory | C (Single-Char, ex: C:\ drive) |
%FDOWN | Number of Files Transferred | Current Session | Downloaded | integer |
%FDOWNALL | Number of Files Transferred | All Sessions | Downloaded | integer |
%FILEDATE | File Creation Date | Current Sessions | Up/Down | Locale Specific |
%FILEDATE_EX | File Creation Date | Current Sessions | Up/Down | mmddyyyy |
%FILEDATE_EX_DMY | File Creation Date | Current Sessions | Up/Down | dd-mm-yyyy |
%FILEDATE_EX_MDY | File Creation Date | Current Sessions | Up/Down | mm-dd-yyyy |
%FILEDATE_EX_YMD | File Creation Date | Current Sessions | Up/Down | yyyy-mm-dd |
%FILEDIR | Directory Only | Current Session | Up/Down/Commands | string (No Trailing Backslash) |
%FILEEXT | Extension Only | Current Session | Up/Down/Commands | string |
%FILEFULLNAME | Fully Qualified Filename | Current Session | Up/Down/Commands | string (includes leading ".") |
%FILENAME | Filename Only | Current Session | Up/Down/Commands | string |
%FILENAME_8.3 | Filename Only (FAT32) | Current Session | Up/Down/Commands | string |
%FILENOEXT | Filename without Extension | Current Session | Up/Down/Commands | string |
%FILEPATH | Directory Only | Current Session | Up/Down/Commands | string (Incl Trailing Slash) |
%FILEPATH_8.3 | Directory Only (FAT32) | Current Session | Up/Down/Commands | string |
%FILESIZE | Size of File | Current Session | Up/Down/Commands | Bytes |
%FILETIME | File Creation Time | Current Sessions | Up/Down | Locale Specific |
%FILETIME_24H | File Creation Time | Current Sessions | Up/Down | hh:mm:ss |
%FILETIME_EX | File Creation Time | Current Sessions | Up/Down | hhmmss |
%FTOT | Number of Files Transferred | All Sessions | Up/Down | integer |
%FTOTALL | Number of Files Transferred | All Sessions | Up/Down | integer |
%FUP | Number of Files Transferred | Current Session | Uploaded | integer |
%FUPALL | Number of Files Transferred | All Sessions | Uploaded | integer |
%GBDOWN | Data Transferred by FTP-Account | Current Session | Download | GiBytes |
%GBDOWNALL | Data Transferred by FTP-Account | All Sessions | Download | GiBytes |
%GBTOT | Data Transferred by FTP-Account | All Sessions | Up/Down | GiBytes |
%GBUP | Data Transferred by FTP-Account | Current Session | Upload | GiBytes |
%GBUPALL | Data Transferred by FTP-Account | All Sessions | Upload | GiBytes |
%KBDOWN | Data Transferred by FTP-Account | Current Session | Download | KiBytes |
%KBDOWNALL | Data Transferred by FTP-Account | All Sessions | Download | KiBytes |
%KBTOT | Data Transferred by FTP-Account | All Sessions | Up/Down | KiBytes |
%KBUP | Data Transferred by FTP-Account | Current Session | Upload | KiBytes |
%KBUPALL | Data Transferred by FTP-Account | All Sessions | Upload | KiBytes |
%LOCALIP | IP Address | System | Obtained from Network | string |
%LOGFILE | Current Log-File | Software Settings | Management -> Logging -> Log Settings | string |
%LOGFILEOLD | Previous Log-File | Software Settings | Obtained from Software | string |
%MAXUSERS | Max Number of FTP-Clients | Software Settings | Management -> Settings -> General | integer |
%MBDOWN | Data Transferred by FTP-Account | Current Session | Download | MiBytes |
%MBDOWNALL | Data Transferred by FTP-Account | All Sessions | Up/Down | MiBytes |
%MBTOT | Data Transferred by FTP-Account | All Sessions | Up/Down | MiBytes |
%MBUP | Data Transferred by FTP-Account | Current Session | Upload | MiBytes |
%MBUPALL | Data Transferred by FTP-Account | All Sessions | Upload | MiBytes |
%PCOSVER | OS Version | System | Obtained from OS | string |
%PCPROC | CPU | System | Obtained from OS | string |
%PCRAM | RAM | System | Obtained from OS | string |
%S_IP | Server IP delimited by commas | System | Obtained from OS | string |
%SERVERDATE | Current Date | System | Obtained from OS | Locale Specific |
%SERVERDAYS | Uptime Days | Software State | Obtained from Software | integer |
%SERVERGBALL | Data Transferred | Software Install Date | Up/Down | GiBytes |
%SERVERGBDOWN | Data Transferred | Software Install Date | Downloaded | GiBytes |
%SERVERGBUP | Data Transferred | Software Install Date | Uploaded | GiBytes |
%SERVERHOURS | Uptime Hours | Software State | Obtained from Software | integer |
%SERVERIP | IP Address | System | Obtained from OS | string |
%SERVERKBALL | Data Transferred | Software Install Date | Up/Down | KiBytes |
%SERVERKBDOWN | Data Transferred | Software Install Date | Downloaded | KiBytes |
%SERVERKBUP | Data Transferred | Software Install Date | Uploaded | KiBytes |
%SERVERLOCALHOST | Server Local-Hostname | System | Obtained from Network | string |
%SERVERMBALL | Data Transferred | Software Install Date | Up/Down | MiBytes |
%SERVERMBDOWN | Data Transferred | Software Install Date | Downloaded | MiBytes |
%SERVERMBUP | Data Transferred | Software Install Date | Uploaded | MiBytes |
%SERVERMINS | Uptime Minutes | Software State | Obtained from Software | integer |
%SERVERSECS | Uptime Seconds | Software State | Obtained from Software | integer |
%SERVERSPEED | Data Transferred | Software Install Date | Up/Down | Bytes/Sec |
%SERVERSPEEDKB | Data Transferred | Software Install Date | Up/Down | KiBytes/Sec |
%SERVERSPEEDMB | Data Transferred | Software Install Date | Up/Down | MiBytes/Sec |
%SERVERTIME | Current Time | System | Obtained from OS | HH:MM:SS |
%SERVERTIMEUP | Uptime Since Restart | Software State | Obtained from Software | 99days 23:59:59 |
%SERVERTOTUPTIME | Total Uptime in Seconds | Software State | Obtained from Software | integer |
%SERVERVERSION | Version of FTP-Server | Software State | About | string |
%SESSIONAVG | Average number of files | Software Restart Date | Up/Down | integer |
%SESSIONFILESALL | Files Transferred | Software Restart Date | Up/Down | integer |
%SESSIONFILESDOWN | Files Transferred | Software Restart Date | Downloaded | integer |
%SESSIONFILESUP | Files Transferred | Software Restart Date | Uploaded | integer |
%SESSIONGBALL | Data Transferred | Software Restart Date | Up/Down | GiBytes |
%SESSIONGBDOWN | Data Transferred | Software Restart Date | Downloaded | GiBytes |
%SESSIONGBTOTAL | Data Transferred | Software Restart Date | All Data + Protocol Bytes | GiBytes |
%SESSIONGBUP | Data Transferred | Software Restart Date | Uploaded | GiBytes |
%SESSIONKBALL | Data Transferred | Software Restart Date | Up/Down | KiBytes |
%SESSIONKBDOWN | Data Transferred | Software Restart Date | Downloaded | KiBytes |
%SESSIONKBTOTAL | Data Transferred | Software Restart Date | All Data + Protocol Bytes | KiBytes |
%SESSIONKBUP | Data Transferred | Software Restart Date | Uploaded | KiBytes |
%SESSIONMBALL | Data Transferred | Software Restart Date | Up/Down | MiBytes |
%SESSIONMBDOWN | Data Transferred | Software Restart Date | Downloaded | MiBytes |
%SESSIONMBTOTAL | Data Transferred | Software Restart Date | All Data + Protocol Bytes | MiBytes |
%SESSIONMBUP | Data Transferred | Software Restart Date | Uploaded | MiBytes |
%SITEWHO | Listing of other online clients | Software State | Obtained from Software | string |
%TIME | Current Time | System | Obtained from OS | HH:MM:SS |
%TIME_24H | Current Time | System | Obtained from OS | HH:MM:SS |
%TIME_EX | Current Time | System | Obtained from OS | HHMMSS |
%TMIN | Minutes since connected | Current Session | Obtained from Software | integer |
%TOPALL | Most Frequently Accessed Files | All Time | Management -> Settings -> Stat Generator | integer |
%TOPDAY | Most Frequently Accessed Files | Day | Management -> Settings -> Stat Generator | integer |
%TOPMONTH | Most Frequently Accessed Files | Month | Management -> Settings -> Stat Generator | integer |
%TOPWEEK | Most Frequently Accessed Files | Week | Management -> Settings -> Stat Generator | integer |
%TSEC | Seconds since connected | Current Session | Obtained from Software | integer |
%UCURRENTDIR | Current Working Directory | Current Session | Current Working Directory | string |
%UFILESPEED | Last Transfer Speed | Current Session | Obtained from Software | Bytes |
%UFILESPEEDKB | Last Transfer Speed | Current Session | Obtained from Software | KiBytes |
%UFILESPEEDMB | Last Transfer Speed | Current Session | Obtained from Software | MiBytes |
%UHOME | User Home Directory | Current Session | Obtained from Software | string |
%UHOSTNAME | Hostname of IP Address | Current Session | Obtained from Network | ahost.adomain.com |
%UIADDRESS | User Account: Address | User Settings | User Manager -> Additional -> Contact Info | string |
%UICITY | User Account: City | User Settings | User Manager -> Additional -> Contact Info | string |
%UID | User Account: ID | User Settings | User Manager -> Additional -> Contact Info | string |
%UIEMAIL | User Account: Email | User Settings | User Manager -> Additional -> Contact Info | string |
%UIFAX | User Account: Fax | User Settings | User Manager -> Additional -> Contact Info | string |
%UINAME | User Account: Name | User Settings | User Manager -> Additional -> Contact Info | string |
%UINOTES | User Account: Notes | User Settings | User Manager -> Additional -> Contact Info | string |
%UIP | IP Address (same as %CLIENTIP) | Current Session | Obtained from Network | 192.168.0.1 |
%UIPHONEHOME | User Account: Phone (Home) | User Settings | User Manager -> Additional -> Contact Info | string |
%UIPHONEWORK | User Account: Phone (Work) | User Settings | User Manager -> Additional -> Contact Info | string |
%UNAME | Account-Name (same as %CLIENTNAME) | Current Session | User Manager -> Login -> Group Name | aaccountname |
%UQUOTA | Quota: Current Usage | Current Session | User Manager -> Private P2P | Bytes |
%UQUOTACURRENTGB | Quota: Current Usage | Current Session | User Manager -> Private P2P | GiBytes |
%UQUOTACURRENTKB | Quota: Current Usage | Current Session | User Manager -> Private P2P | KiBytes |
%UQUOTACURRENTMB | Quota: Current Usage | Current Session | User Manager -> Private P2P | MiBytes |
%UQUOTAMAX | Quota: Max Avail | Current Session | User Manager -> Private P2P | Bytes |
%UQUOTAMAXGB | Quota: Max Avail | Current Session | User Manager -> Private P2P | GiBytes |
%UQUOTAMAXKB | Quota: Max Avail | Current Session | User Manager -> Private P2P | KiBytes |
%UQUOTAMAXMB | Quota: Max Avail | Current Session | User Manager -> Private P2P | MiBytes |
%URATIO | Private P2P: Current Ratio | Current Session | Up/Down | float |
%URATIOCREDIT | Private P2P: Current Credit | Current Session | Download | Bytes |
%URATIOCREDITGB | Private P2P: Current Credit | Current Session | Download | GiBytes |
%URATIOCREDITKB | Private P2P: Current Credit | Current Session | Download | KiBytes |
%URATIOCREDITMB | Private P2P: Current Credit | Current Session | Download | MiBytes |
%URATIODOWN | Private P2P: Current Ratio | Current Session | Download | float |
%URATIOUP | Private P2P: Current Ratio | Current Session | Upload | float |
%USPEEDLIMIT | Max Allowed Bandwidth | User Account | Up/Down | integer |
%UTIMEOUT | Current Timeout for User-Account | User Account | N/A | integer |