ssh-troubleshoot — tool for collecting system information
ssh-troubleshoot (ssh-troubleshoot.cmd on Windows) is a tool for collecting information on the operating system (its version, patches, configuration settings, installed software components, and the current environment and state) and on the Tectia installation (installed product components and versions, their state, and the global and user-specific configurations).
The collected information will be stored in a file named
ssh_troubleshoot_<host>_<date>_<time>.tar
on Unix and ssh_troubleshoot_*.log
on Windows. Send
the file to the SSH technical support for analysis to help in troubleshooting
situations.
To get all necessary information, run the command as an administrator, because it might need root access to some directories.
Enter each option separately, they cannot be combined. The following options are available:
-d, --debug
LEVEL
Sets the debug level string to LEVEL
.
-k, --keep-going
Defines that the data collecting is continued as long as possible, even after errors are encountered. Not supported on Windows.
-o, --output
FILENAME
Defines a non-default output file for storing the collected data. Not supported on Windows.
If FILENAME
is '-
', the collected data is
added to the standard output. The default output file is created in a temporary archive
directory and stored as
ssh-troubleshoot-data-<hostname>-<timestamp>.tar
. The
timestamp is in format: yyyymmdd-hhmmUTC
.
-u, --user
USERNAME
Defines another user for the info command, the default is the current user. This affects the home directory from which the user-specific Tectia configuration files are fetched. Not supported on Windows.
-q, --quiet
Suppresses detailed reporting about the command progress, reports only errors.
-h, --help
Displays this help text.
ssh-troubleshoot accepts the following command:
info
Gathers information about the system configuration. The collected data will be stored as
a tar
file on Unix or a log
file on
Windows.
Options:
--include-private-keys
Collects everything from the specified user's configuration directories, including the private keys. By default, the private keys nor unrecognized files are not included in the result data. This option is not supported on Windows.