ssh-server-ctl

ssh-server-ctl — Tectia Server control utility.

Synopsis

ssh-server-ctl [options] [command [command-options] ]

Description

ssh-server-ctl (ssh-server-ctl.exe on Windows XP) 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.

Options

The following options are available:

-D, --debug=LEVEL: Defines the debug level.
-h, --help: Displays the help text for the command.
-l, --listen=PORT: Same as the port option.
-P, --pid PID: Targets the command to the ssh-server-g3 process identified with the given PID. Available on Unix only.
-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. Subsequent commands can be given without the port definition.
--server-address: The path to the server control socket.
-q, --quiet: Displays little or no output depending on the command.
-s, --short: Displays a shorter more machine readable output.
-v, --verbose: Displays more information if it is available.

Commands

ssh-server-ctl accepts the following commands:

add-servant

Start a new servant or new servants.

Options:

num: Defines the number of servants to be started.

continue

Continue a previously paused service.

pause

Pause the service. Existing connections continue to function, but new connections won't be accepted until the continue command has been given.

reload

Causes the server process to reload its configuration. The configuration is read from the ssh-server-config.xml file. Existing connection stay open using the old configuration and the new connections will use the new configuration.

start

Attempts to start the server process by executing ssh-server-g3.

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).
-f, --config-file FILE: Uses the given file as a configuration.

status

Outputs the server status.

Options:

--all: Lists the status for all connections, channels, servants and so on.

stop

Causes the server process to start shutting down. 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.

Options:

-F, --force: Forcefully disconnects connections to shut down the server quicker. The force option should be given with the inital stop command.

stop-servant

Causes the server to stop servants.

Options:

id ...: Specifies the servants to be stopped by their ID number. You can use a space-separated list to enter several IDs.