5 Creating Support Packages¶

Sometimes the Greenbone Support needs additional information to troubleshoot and support customers. The required data is collected in the form of an (encrypted) support package that contains all configuration data of OpenSight OS.

5.1 General Information¶

Per default, support packages are obfuscated and encrypted. Only the Greenbone Support is able to decrypt the package while the map for obfuscating sensible data remains on the customer’s host.

The following data is obfuscated:

Host names
IP addresses
MAC addresses
User data

5.2 Creating a Support Package¶

Create a support package using the default settings (encrypted & obfuscated) by running the following command:

opensight-os-cli support create

→ Once the support package is created, the output shows the location and ID of the generated support package.

HTTP/1.1 201 Created
Connection: keep-alive
Content-Length: 122
Content-Type: application/json
Date: Tue, 22 Apr 2025 14:12:19 GMT
Server: nginx

file: /var/tmp/secured-sosreport-opensight-os-20250422141152-obfuscated.tar.xz.gpg
id: opensight-os-20250422141152

5.2.1 Creating a Support Package Without Encryption and/or Obfuscation¶

For customizing the support package, there are two options which can be configured in order to change the default behavior.

Create a support package without encryption by running the following command:

opensight-os-cli support create encryption:false

Create a support package without obfuscation by running the following command:

opensight-os-cli support create obfuscation:false

These options can also be combined:

opensight-os-cli support create encryption:false, obfuscation:false

5.3 Downloading a Support Package¶

Support packages are copied from OpenSight OS to a computer or notebook via SSH/SCP.

Note

The download command must be run in a terminal on a Linux system or PuTTY on a Microsoft Windows system, not in the OpenSight OS CLI.

Download a support package to a computer or notebook by running the following command with the IP address of OpenSight OS and the support package file name specified:

scp admin@<OPENSIGHT_OS_HOST>:/var/tmp/<SUPPORT_PACKAGE_FILE_NAME> .

Example:

scp admin@192.168.0.1:/var/tmp/secured-sosreport-opensight-os-20250422141152-obfuscated.tar.xz.gpg .

→ The support package is copied to the current location on the used computer or notebook and can be shared with the Greenbone Support.

5.4 Managing Support Packages¶

5.4.1 Listing all Existing Support Packages¶

Display a list of all existing support packages by running the following command:

opensight-os-cli support show-all

→ The output shows all existing support packages.

HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 317
Content-Type: application/json
Date: Mon, 28 Apr 2025 13:56:05 GMT
Server: nginx

- file: /var/tmp/sosreport-opensight-os-20250428135337-obfuscated.tar.xz
id: opensight-os-20250428135337
- file: /var/tmp/sosreport-opensight-os-20250428135236.tar.xz
id: opensight-os-20250428135236
- file: /var/tmp/secured-sosreport-opensight-os-20250428135409-obfuscated.tar.xz.gpg
id: opensight-os-20250428135409

Note

In this case there are three different types of support packages:

The file sosreport-opensight-os-20250428135337-obfuscated.tar.xz is unencrypted and obfuscated.
The file sosreport-opensight-os-20250428135236.tar.xz is unencrypted and not obfuscated.
The file secured-sosreport-opensight-os-20250428135409-obfuscated.tar.xz.gpg is encrypted and obfuscated (default).

5.4.2 Deleting a Support Package¶

Delete a support package by running the following command with the support package ID specified:

opensight-os-cli support delete <ID>

Example:

opensight-os-cli support delete opensight-os-20250428135409