Collecting system information for the Univention Support Team

Knowledge Base Supported
, , , , , ,
1

The univention-support-info program automatically collects relevant information about a system for the Univention support team. This includes, for example, information about running processes, open network connections, the utilisation of file systems, logfiles and aspects of the system configuration. Accordingly, the collected data are sensitive and should be treated as such. univention-support-info can be found at https://updates.software-univention.de/download/scripts/univention-support-info.

Since UCS 5, we have included the Support Info Archive in the product. It is therefore already on the system and no longer needs to be downloaded.

~# univention-support-info --help
/usr/bin/univention-support-info:34: DeprecationWarning: 'pipes' is deprecated and slated for removal in Python 3.13
  from pipes import quote
usage: univention-support-info [-h] [--debug] [--verbose] [--encrypt] [--full-logs] [--flat] [--version] [--output FILE]

collects information about the system's configuration. The information is stored in a temporary tar archive, the path of which is printed to stdout.

options:
  -h, --help            show this help message and exit
  --encrypt             encrypt data (can only be decrypted by Univention support)
  --full-logs           collect also rotated logfiles
  --flat                flatten the directory structure
  --version             show program's version number and exit
  --output FILE, -o FILE
                        Output file or USI

Internal developer options:
  --debug               Show debug level DEBUG and above
  --verbose             Show debug level INFO and above

Usage

To collect information about a system, proceed as follows:

  • Logon to the target system as root:

    ssh root@targetsystem

  • Download the tool:

    wget -O ./univention-support-info https://updates.software-univention.de/download/scripts/univention-support-info

    Alternatively, the program can of course be copied onto the system from your own (e.g. via scp/WinSCP)

  • Make the script executable:
    chmod a+x ./univention-support-info

  • Run the program in UCS 5:

    ./univention-support-info
[...]
Data collection completed.
The data can be found here:
/tmp/univention-support-info-HOSTNAME.Hnc0OL.tar.bz2

  • Run the programm in UCS 4:

    python2 ./univention-support-info

    The program has now collected the information and saved it in an archive. The path to this archive has been output (in this example “/tmp/univention-support-info-HOSTNAME.Hnc0OL.tar.bz2”).
    The created archive must now be sent to the Univention support (e.g., by e-mail or upload at https://upload.univention.de).

Encrypting the data

The data can also be encrypted so that only the Univention support can read it. To do so, the tool must be run with the --encrypt parameter:

./univention-support-info --encrypt
Data collection completed.

The encrypted data can be found here: /tmp/univention-support-info-HOSTNAME.sqN7uC.tar.bz2.gpg

The unencrypted data can be found here: /tmp/univention-support-info-HOSTNAME.sqN7uC.tar.bz2

In this case, an additional .gpg file is created; this is the encrypted version of the archive.

1 Like