Variables (parametric stuff)
Syncplify Server! supports variables to make several pieces of configuration parametric. These variables are evaluated live at run-time, and substituted to their respiective placeholders, so that the software can adapt its configuration to each ongoing session.
Just one example, to clarify what we're talking about, is the ability to use a single VFS to create parametric homes for many user accounts, by simply using the account username as a variable parameter. To achieve that, you can simply define a VFS target as (for example) C:\SFTPData\, and each user can use the same VFS and have their own individual and isolated home. User john's files will be stored in C:\SFTPData\john, user jane's files will be stored in C:\SFTPData\jane, and so on...
Now that the concept is clear, what variables can be used and where exactly?
VFS-related variables/parameters
These variables can be used inside of a VFS target to parametrize its destination based upon 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 (provided 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/parameters
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) |