ssh-server-ctl — Tectia Server control utility.
ssh-server-ctl (ssh-server-ctl.exe on Windows) is a control utility that can be used to start, stop, or to reload the configuration of Tectia Server (ssh-server-g3). It can also be used to add new servants or to stop servants, to check the status of the server and to pause the server.
The following options are available:
Connects to the current server.
Defines the debug level.
Displays the help text for the command.
Same as the
Connects to the backup listener.
Targets the command to the ssh-server-g3 process identified with the given
PID. Available on Unix only.
Targets the command to the ssh-server-g3 process running on the given
PORT. The default port 22 is assumed if this option is not used.
The path to the server control socket.
Displays little or no output depending on the command.
Displays a shorter more machine readable output.
Displays more information if it is available.
Displays the version string.
ssh-server-ctl accepts the following commands:
Start a new servant or new servants.
Defines the number of servants to be started.
Continue a previously paused service.
(Windows only) This command removes the specified user's password from the currently active server password cache. the command will report an error if the specified user is not present in the password cache.
Pause the service. Existing connections continue to function, but new connections won't be accepted until the continue command has been given.
Prints the server process ID.
Causes the server process to reload its configuration. The configuration is read from the
ssh-server-config.xmlfile. Existing connection stay open using the old configuration and the new connections will use the new configuration.
(Windows only) This command displays all stored usernames from the currently active server password cache. The passwords are not displayed, only the usernames.
Attempts to start the server process by executing ssh-server-g3.
startcommand will check if there is a server process currently running; if yes, the tool will report the case and will not make any starting attempts.
Start the server on an alternate port (the default port is 22).
Uses the given file as a configuration.
Outputs the server status.
Lists the status for all connections, channels, servants and so on.
Causes the server process to start shutting down. The
stopcommand checks if there is a server process currently running; if not, the tool will report the case and will not make any stopping attempts.
Forcefully disconnects connections to shut down the server quicker. The
forceoption should be given with the inital stop command.
Causes the server to stop servants specifed by their ID numbers. You can use a space-separated list to enter several IDs.