ssh-server-ctl

ssh-server-ctl — SSH Tectia Server control utility. Available on Unix only.

Synopsis

ssh-server-ctl [-D, --debug=LEVEL] [-P, --pid PID] [-p, --port PORT] [-h, --help] command
[options...]

Description

ssh-server-ctl is a control utility that can be used to start, stop, or to reload the configuration of SSH Tectia Server (ssh-server-g3).

Options

The following options are available:

-D, --debug=LEVEL: Defines the debug level.
-P, --pid PID: Targets the command to the ssh-server-g3 process identified with the given PID.
-p, --port PORT: 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.
-h, --help: Displays the help text for the command.

Commands

ssh-server-ctl accepts the following commands:

ping [-p, --port PORT] [-h, --help]

The ssh-server-ctl tool connects to the server process to check if it is running. Option port can be used to ping a server process on the given port (the default port is 22). Option help displays a help text on this command.

reload [-p, --port PORT] [-h, --help]

Causes the server process to reload its configuration. Option port can be used to define the server process on the given port to reload its configuration. Option help displays a help text on this command.

start [-p, --port PORT ] [-t, --timeout SECONDS] [-h, --help]

Attempts to start the server process by executing ssh-server-g3. The tool waits for the given timeout seconds, and then reports success or failure.

The start command 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.

Options:

-p, --port PORT: Start the server on an alternate port (the default port is 22).
-t, --timeout SECONDS: Waits for the given time for the server to respond. The default time is 10 seconds.
-h, --help: Displays a help text on this command.

stop [-p, --port PORT] [-h, --help]

Causes the server process to exit. The stop command checks if there is a server process currently running; if not, the tool will report the case and will not make any stopping attempts.

Option port can be used to define the server process on the given port to exit. Option help displays a help text on this command.