Navigation:  Advanced Features >

Server Variables

Previous pageReturn to chapter overviewNext page

Certain configurable messages in the server can be customized to include a wide range of variables as outlined in the list below. These variables can be used in the Command Console, the Event Manager, and for customized FTP response message. A brief explanation is made for each variable. Statistical information, unless otherwise specified, is calculated since the server was last started.

 

Server Variables

%ServerName - The full name of the server

%ServerVersion - The full version number of the server

%CurrentTime - The current time according to the the server, in the system's local time format

%ServerYear - Current year

%ServerMonth - Current month, 1-12

%ServerDay - Current day, 1-31

%ServerHour - Current hour, 0-23

%YYYY - Current year

%MM - Current month, 01-12

%DD - Current day, 01-31

%HH - Current hour, 00-23

%ServOnlineSessions - The number of sessions currently connected

%ServMaxOnlineSessions - The highest number of concurrent sessions that has been recorded since being placed online

%ServLast24HSessions - The number of sessions that have connected in the past 24 hours

%ServAverageSessionLife - The average length of time a session has remained connected

%ServMaxSessionLife - The longest recorded time for a session

%ServTotalSessions -The total number of sessions that have connected since being placed online.

%ServRealtimeDownloadSpeedKBS - The current download transfer rate in KB/s

%ServAverageDownloadSpeedKBS - The average download rate in KB/s

%ServDownloadBytes -  The total amount of data downloaded since being placed online

%ServDownloadFiles - The total number of files downloaded since being placed online

%ServRealtimeUploadSpeedKBS - The current upload transfer rate in KB/s

%ServAverageUploadSpeedKBS - The average upload rate in KB/s

%ServUploadBytes - The total amount of data uploaded since being placed online

%ServUploadFiles - The total number of files uploaded since being placed online

 

 

Domain Variables

%DomOnlineSessions - The number of sessions currently connected

%DomMaxOnlineSessions - The highest number of concurrent sessions that has been recorded since being placed online

%DomLast24HSessions - The number of sessions that have connected in the past 24 hours

%DomAverageSessionLife - The average length of time a session has remained connected

%DomMaxSessionLife - The longest recorded time for a session

%DomTotalSessions - The total number of sessions that have connected since being placed online

%DomRealtimeDownloadSpeedKBS - The current download transfer rate in KB/s

%DomAverageDownloadSpeedKBS - The average download rate in KB/s

%DomDownloadBytes -  The total amount of data downloaded since being placed online

%DomDownloadFiles - The total number of files downloaded since being placed online

%DomRealtimeUploadSpeedKBS -  The current upload transfer rate in KB/s

%DomAverageUploadSpeedKBS - The average upload rate in KB/s

%DomUploadBytes - The total amount of data uploaded since being placed online

%DomUploadFiles - The total number of files uploaded since being placed online

 

 

Session Variables - Applies to the current session

 

%Domain - The domain name

%IP - The client's IP address

%Name - The session's User Name

%UserEmail  - The email address of the user %Name, which specified in the User->Notes page

%Dir - The session's current directory        

%LastDir - The last created or removed directory (physical path)        

%PathName - The last accessed file's path.

%FileName - The last accessed file's name, like "test.zip"

%FileSize - Retrieves the size, in bytes, of the file from %PathName

%OldFilePath - The old file path before renaming

%NewFilePath - The new file path after renaming

%SessionID - The session's ID

%ClientVersion - The FTP client name

%UserMaxQuota - The max disk quota for the user %Name

%UserCurrentQuota - The current disk quota for the user %Name

%ConRealtimeDownloadSpeedKBS - The current download transfer rate in KB/s

%ConAverageDownloadSpeedKBS - The average download rate in KB/s

%ConDownloadFiles -  The total number of files downloaded for this session

%ConRealtimeUploadSpeedKBS - The current upload transfer rate in KB/s

%ConAverageUploadSpeedKBS - The average upload rate in KB/s

%ConUploadFiles - The total number of files uploaded for this session

%ConTransferBytes - The total amount of data transferred last time by this session(include download and upload)

%ConTransferSpeedKBS - The average transfer rate transferred last time by this session in KB/s

 

How to use Variables in Command Console and Task Scheduler

Only Server Variables are applicable in Command Console and Task Scheduler. You can not use Domain Variables and Session Variables.

console-variables-example

 

 

 

How To use Variables in Event Manager and FTP Customized Message

All Variables are applicable in Event Manager and FTP Customized Message.

event-variable-example

 

This example shows how to respond to events for a specified user. In this case, when user "test" uploads a file, the server will send an email to admin@example.com.