Skip to main content
Skip table of contents

Debugging / How to Collect and Send Device Log Files to IGEL Support

To collect the log files from the IGEL UMS Server, UMS Console, etc., you can use the Support Wizard: UMS Console > Menu bar > Help > Save support information. See Support Wizard - How to Send Log Files in the IGEL UMS. For more information on UMS log files, see Where Can I Find the IGEL UMS Log Files?

To collect the device log files, see the instructions below.


With IGEL OS 12, additional logging functionalities have been introduced to facilitate debugging. To enable debug mode, proceed as follows:

  1. In the IGEL Setup, go to System > Registry and activate the following registry keys:

Registry

Parameter

Function

debug.remotemanager.enable

Enable debug logging

Debug logging for RMagent communication

debug.igel_desktop

Enable debug logging for IGEL desktop

Debug logging for user interface applications like the Setup Assistant and the Setup

debug.firmware_update

Enable debug logging for firmware update

Debug logging for updates and installations of IGEL OS Apps

  1. Save the setting.

Optionally, you can also enable protocol dump output via debug.remotemanager.protocol_dump. This activates debug logging for all commands sent from the UMS to the device or vice versa:
/var/log/rmagent-ws-in.log
/var/log/rmagent-ws-out.log

Activate this registry key only if required.

Collecting Device Logs via the UMS

After you have activated the above registry keys, you can use the UMS Console to collect the device log files:

  1. In the UMS Console, go to Help > Save device files for support.

    image-20240917-153808.png

    The dialog Save device files for support opens.

  1. Select the required device(s) and click Next.

  1. Select a directory which is suitable for saving the zipped log files and click Next.

    A confirmation dialog opens and shows the path and file name under which the log files are stored.

    5cb8f1ce-ae21-439e-b67b-ed5e810a17b8.png

  1. When the log collecting procedure is complete, close the confirmation dialog by clicking Finish.

  1. Find the ZIP file "tc_files_for_support_..." in the directory you selected and send it to IGEL Support via the IGEL Customer Portal.

Collecting Device Logs without the UMS

When the UMS is not accessible or there is an issue with network connectivity, you can still extract logs from a device.

Option 1: Via Local Terminal

  1. In the IGEL Setup, go to Accessories > Terminals and create a terminal session.

  1. Go to Devices > Storage Devices > Storage Hotplug and activate Enable dynamic client drive mapping.

    a6813061-68ba-4363-af8f-00baf2dc165f.png

  1. Verify that System > Registry > debug > igel_desktop > Enable debug logging for IGEL desktop is enabled.

  1. Save the settings.

  1. Plug the USB stick into the endpoint device and start the terminal session.

  1. Log in as root (by default, no password).

  1. To create the log files, execute the command /config/bin/create_support_information
    This will generate /tmp/tclogs.zip (you can go there as follows: cd /tmp)

    a6d90a6e-8e4d-474c-977d-c1592613a88b.png

To find out the name of the USB stick, you can use the following commands:

cd /userhome/media
ls -l

image2022-7-7_12-41-35.png

If there are spaces in the device name, you'll have to include it later in quotation marks. Example: "NEW VOLUME".
If there are no spaces in the device name, quotation marks will not be required.


  1. To copy the log files from your endpoint device to the USB stick, run the command cp /tmp/tclogs.zip /media/[name of your USB stick]/ and press [Return].

After /media/, you can press the tab key for autocompletion.


  1. Type sync and press [Return].

  1. Wait a few seconds before safely ejecting the USB stick from the endpoint device.

  1. Send the log files to IGEL Support via the IGEL Customer Portal.

Option 2: Via CLI

You can collect log files also via command line interface (CLI). This method can be useful, for example, if you experience problems on the stage of device onboarding.

  1. Press anytime [CTRL+ALT+F12] to enter CLI and then press [Return].

  1. Plug in a FAT32-formatted USB stick.

  1. Execute the following command: dmesg
    This command is used to find out if the USB stick was correctly detected and which device name was assigned (sda, sdb, sdc, etc.)

  1. Type cat /proc/partitions
    Search for sda, sdb, sdc, etc. and search for the next line showing the partitions (Example: sda1, sdb1, etc.)

  1. Create the mountpoint directory: mkdir /mnt

  1. The device name for mounting the USB stick for the following command in step 7 needs an additional partition number. Example: sda1, sdb1, sdc1, etc.

  1. Mount your USB stick: mount /dev/sda1 /mnt

    eac9827c-9ec0-45f2-819e-84a88eef9f7e.png

  1. Check your data on your mounted USB stick:
    cd /mnt
    ls -l
    Now you should see your data on the USB stick.

  1. Generate log files: /config/bin/create_support_information
    It can take some time till the log file generation is complete.

  1. Type:
    cd /tmp
    ls -l
    Now you should see the log file tclogs.zip listed.

  1. To copy tclogs.zip from your endpoint device to the USB stick, type cp /tmp/tclogs.zip /mnt and press [Return].

  1. To unmount your USB stick, use the command umount /mnt

  1. Now you can safely remove your USB stick.

  1. To close CLI, press [CTRL+ALT+F1].

  1. Send tclogs.zip  to IGEL Support via the IGEL Customer Portal.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.