Variables (parametric stuff)
Syncplify Server! allows you to use variables—placeholders wrapped in double curly braces like —to make your configuration dynamic and adaptable. These variables are evaluated at run-time and replaced with their actual values, allowing the software to adjust settings for each session or user automatically.
Example:
Suppose you want each user to have a personal home directory using a single VFS definition. You can set the VFS target to C:\SFTPData\. When user john logs in, their files go to C:\SFTPData\john; for user jane, it's C:\SFTPData\jane. This way, you only need one VFS rule for all users.
NOTE
Variables are always written as . Not all variables are available everywhere—some only work in VFS settings, others only in banners. See the lists below for details.
VFS-related variables
These variables can be used inside a VFS target to parametrize its destination based on the current real-time value of each variable.
| Variable | Explanation |
|---|---|
{{username}} | The username (ID) of the currently authenticated user account |
{{user_desc}} | The description field (free text) of the currently authenticated user account |
{{user_home}} | The home directory for the LDAP user account (available exclusively for LDAP user/group accounts) |
{{sess_custdata}} | The first string in the Session.CustomData (if a script populated this value in a previously executed event-handler) |
{{today}} | The server-time current date (YYYYMMDD) |
{{today_utc}} | The UTC-time current date (YYYYMMDD) |
Banner-related variables
These variables can be used to parametrize the following configuration settings:
- The SFTP software ID
- The SFTP banner
- The FTP(E/S) greeting banner
- The FTP(E/S) login message
- The FTP(E/S) login failure message
- The FTP(E/S) logout message
| Variable | Explanation |
|---|---|
{{server_time}} | The current server-time (ex: 2006-01-02 15:04:05.999999999 -0700 MST) |
{{utc_time}} | The current UTC-time (ex: 2006-01-02 15:04:05.999999999) |
{{software_name}} | Substituted with the words Syncplify Server! |
{{process_name}} | Substituted with the words Syncplify Server! Worker Service |
{{software_ver}} | Current software version (ex: 6.0.29) |
{{cpu_load}} | Current CPU load of the worker process (ex: 0.71%) |
{{memory}} | Current RAM (memory) used by the worker process (ex: 84 MB) |
{{active_sessions}} | Current number of active client sessions (ex: 42) |