Skip to content

Dynamic "banners"

Some protocols feature so-called "banners", which are short pieces of textual information that are sent to the client upon occurrence of certain events.

For example, the SSH2 protocol can send one such banner upon successful user authentication.

The FTP protocol has a richer set of banners: one that can be sent to the client upon connection (before authentication), one upon successful login, one upon failed login, and one when the user logs out.

All of these banners can be crafted by the Syncplify Server! administrator to be dynamically built at run-time, using certain variables, at the moment they are sent to each client. All of these variables must be enclosed between double curly braces.

For example, the following banner configured in the Admin UI:

{{software_name}} v{{software_ver}} FTP(E/S) Service Ready

will be sent to the client like this:

Syncplify Server! v7.0.0 FTP(E/S) Service Ready

The following variables are available for use in banners:

Variable NameExplanation
{{software_name}}Syncplify Server!
{{process_name}}Syncplify Server! Worker Process
{{software_ver}}Ex: 7.0.0
{{server_time}}Local time on the server machine. Ex: 2022-11-10 14:00:01.6
{{utc_time}}Current UTC time. Ex: 2022-11-10 23:00:01.6
{{cpu_load}}Current average system-wide CPU load. Ex: 3.42%
{{memory}}Memory currently used by the worker process. Ex: 68 MB
{{active_sessions}}Current number of active client sessions being served by the server's worker process. Ex: 23

NOTE

These variables are only available in banner fields and cannot be used in other parts of the UI or in scripting.