SUPPORTCONFIG.CONF(5)

📦 version 3.2.14.2, in opensuse-leap 16.0

🎀 NAME 🎀

supportconfig.conf — the configuration file for supportconfig(8), straight out of the Support Utilities Manual. This is the file that tells supportconfig what to grab, what to skip, and what little extras to bring to the group chat. 💅✨

🌈 ENVIRONMENT 🌈

  • SC_CONF — bestie, you can use this environment variable to specify an alternate configuration file path. Iconic for testing or keeping your config somewhere cute and custom. 🫶

Example:

export SC_CONF=/opt/supportconfig.conf

✨ DESCRIPTION ✨

Okay so real talk: regular and additional options are used to turn a feature either on (1) or off (0), whereas variable options usually have differing values depending on the desired outcome. Running supportconfig -C will create a default /etc/supportutils/supportconfig.conf. The format for setting an option is:

TOKEN=value

💅 Regular Options 💅

Each regular option is described with the TOKEN used, a description, the filename containing the information, and the default value in parentheses. Each option can be included (-i) or excluded (-x) from the command line. Use -F to see a list of feature keywords. Periodt. 💖

  • OPTION_APPARMOR — AppArmor information. security-apparmor.txt (1)
  • OPTION_AUDIT — Auditing information. security-audit.txt (1)
  • OPTION_AUTOFS — autofs information. fs-autofs.txt (1)
  • OPTION_BOOT — Information related to booting and the kernel. boot.txt (1)
  • OPTION_BTRFS — Information related to the B-tree file system. fs-btrfs.txt (1)
  • OPTION_CIMOM — CIMOM and OpenWBEM related information. cimom.txt (1)
  • OPTION_CRASH — Information related to capturing a system core dump. crash.txt (1)
  • OPTION_CRON — Information related to cron and at. cron.txt (1)
  • OPTION_DAEMONS — SystemD service information. systemd.txt (1)
  • OPTION_DBUS — D-Bus status and configuration information. dbus.txt (1)
  • OPTION_DHCP — Dynamic Host Configuration Protocol (DHCP) information. dhcp.txt (1)
  • OPTION_DISK — Disk, file system mounts and partition information. fs-diskio.txt (1)
  • OPTION_DNS — Domain Name Service information. dns.txt (1)
  • OPTION_DOCKER — Docker virtualization information. docker.txt (1)
  • OPTION_DRBD — Distributed Replicated Block Device information. drbd.txt (1)
  • OPTION_ENV — System environment information, including sysctl and root's environment. env.txt (1)
  • OPTION_ETC — Recursively gets *.conf files, along with various other configuration files in /etc. etc.txt (1)
  • OPTION_EVMS — Enterprise Volume Management System related information. evms.txt (1)
  • OPTION_HA — Heartbeat/high availability cluster information. ha.txt (1)
  • OPTION_HAPROXY — Heartbeat/high availability proxy cluster information. haproxy.txt (1)
  • OPTION_HISTORY — root user shell history. history.txt (0)
  • OPTION_IB — InfiniBand information. Only available with SLES11 or greater. ib.txt (1)
  • OPTION_ISCSI — iSCSI target and initiator information. fs-iscsi.txt (1)
  • OPTION_KVM — KVM virtualization related information. Available in SLES11 SP1 or newer, otherwise ignored. kvm.txt (1)
  • OPTION_LDAP — LDAP related information, including a root DSE search. ldap.txt (1)
  • OPTION_LVM — Linux Volume Management related information. lvm.txt (1)
  • OPTION_LXC — Linux Container virtualization information. lxc.txt (1)
  • OPTION_MEM — Memory related information. memory.txt (1)
  • OPTION_MOD — System kernel module information. modules.txt (1)
  • OPTION_MPIO — Native device mapper multipathing information. mpio.txt (1)
  • OPTION_NET — Network related information, including firewall rules. network.txt (1)
  • OPTION_NFS — Network File System related information. nfs.txt (1)
  • OPTION_NTP — Network Time Protocol related information. ntp.txt (1)
  • OPTION_NVME — Non-Volatile Memory Express (NVMe) information. nvme.txt (1)
  • OPTION_OCFS2 — OCFS2 file system related information. ocfs2.txt (1)
  • OPTION_GFS2 — GFS2 file system related information. ofs-gfs2.txt (1)
  • OPTION_OFILES — List of all open files using lsof. open-files.txt (1)
  • OPTION_PODMAN — Podman virtualization information. podman.txt (1)
  • OPTION_PRINT — Printing and CUPS related information. print.txt (1)
  • OPTION_PROC — Includes key /proc file content. proc.txt (1)
  • OPTION_TUNED — Gathers dynamic adaptive system tuning daemon information. tuned.txt (1)
  • OPTION_SAM — Supportability Analysis Module report. NOTE: This takes up to 10 minutes to complete. sam.txt (1)
  • OPTION_SAR — System Activity Reporting related information, including copies of the SAR data files. sar.txt (1)
  • OPTION_SLERT — SLES Real Time kernel related information. slert.txt (1)
  • OPTION_SLP — Service Location Protocol related information. slp.txt (1)
  • OPTION_SMART — Self-Monitoring, Analysis, and Reporting Technology related information for hard disks. WARNING: Some hard disk controllers and drives do not behave kindly. Probing SMART data has been known to change file systems to read only mode or even hang the server. Make sure probing SMART data works in your environment before enabling this option. fs-smartmon.txt (0)
  • OPTION_SMB — Samba and CIFS related information. samba.txt (1)
  • OPTION_SMT — Subscription Management Tool (SMT) related information. smt.txt (1)
  • OPTION_SRAID — Software RAID related information. fs-softraid.txt (1)
  • OPTION_SSH — Secure Shell server information. ssh.txt (1)
  • OPTION_SSSD — System Security Services Daemon information. sssd.txt (1)
  • OPTION_SYSCONFIG — Configuration files found in /etc/sysconfig. sysconfig.txt (1)
  • OPTION_SYSFS — Gathers the contents of all files in /sys. sysfs.txt (1)
  • OPTION_UDEV — UDEV device manager related information. udev.txt (1)
  • OPTION_UFILES — Additional user included files. Any file listed in /usr/lib/supportconfig/additional-files.list will be included in the fs-files-additional.txt file when supportconfig is run. The additional-files.list file must be owned by root and have 0600 or 0400 permissions. Include the full file path of the files you want included. Any binary files will be base64 encoded. fs-files-additional.txt (1)
  • OPTION_UP — Update client related information. updates.txt (1)
  • OPTION_WEB — Web server and web related information. web.txt (1)
  • OPTION_X — X graphical system related information. x.txt (1)
  • OPTION_XEN — XEN virtualization related information. xen.txt (1)
  • FORCE_OPTION_PAM — Pluggable Authentication Module related information, including user account information. It is disabled in compliance with General Data Protection Regulation (GDPR). To consent to supportconfig collecting this information, set FORCE_OPTION_PAM=1. pam.txt (0)

🦋 Additional Regular Options 🦋

Each additional regular option is described with the TOKEN used, a description, the startup option used to set it, the filename if any, and the default value in parentheses. If no startup option is listed, then you must set this option in the supportconfig.conf file. No cap. 💀

  • ADD_OPTION_FSLIST — A full file list using find from the root of the filesystem. Startup option: -L. fs-files.txt (0)
  • ADD_OPTION_LOGS — Includes the entire log file, including comments, instead of just VAR_OPTION_LINE_COUNT lines of it. Additional rotated logs are included if available. Startup option: -l (0)
  • ADD_OPTION_LOCAL_ONLY — Disables curl checks to SUSE update servers. By default external SUSE update servers are checked. Startup option: -c (0)
  • ADD_OPTION_MINDISK — Minimizes the amount of disk information and detailed scanning. Startup option: -d (0)
  • ADD_OPTION_MAXYAST — Normally VAR_OPTION_LINE_COUNT lines are gathered from all /var/log/YaST2/* files. This option gathers each entire file. Startup option: -y (0)
  • ADD_OPTION_RPMV — Runs an rpm -V on every installed RPM package. This takes some time to complete. Startup option: -v. rpm-verify.txt (0)
  • ADD_OPTION_SCRUB — Scrub sensitive data from all collected files before packing the archive. Requires the supportutils-scrub package (version 1.2 or later). Obfuscates IP addresses, MAC addresses, hostnames, domain names, usernames, and serial numbers. Equivalent to passing -j on the command line. Use SUPPORTUTILS_SCRUB_OPTS to pass additional options to supportutils-scrub. Startup option: -j (0)
  • ADD_OPTION_SLP — Normally only the base SLP service types are listed. This option allows you to query each of the discovered service types individually. Startup option: -s. slp.txt (0)

🍓 Variable Options 🍓

Each variable option is described with the TOKEN used, a description, the startup option used to set the TOKEN, and the default value in parentheses. These are the ones with actual vibes and values, not just on/off energy. ✨

  • VAR_OPTION_BIN_TIMEOUT_SEC — The number of seconds to wait before ignoring a timed command. Commands that have been timed will show a progress dot . on the screen every 30 seconds while waiting for the command to complete. If the command does not complete within the VAR_OPTION_BIN_TIMEOUT_SEC period, it is ignored and the supportconfig moves on to gather additional information. If the command completes before supportconfig finishes, its output will be included in the tar ball. The timed command has been backgrounded and left running. You may need to kill this process, and the log file will identify what the process is. Startup option: -T (300)
  • VAR_OPTION_CONTACT_COMPANY — Company name to include in the basic-environment.txt. Startup option: -O (Not Set)
  • VAR_OPTION_CONTACT_EMAIL — Contact's email address to include in the basic-environment.txt. Startup option: -E (Not Set)
  • VAR_OPTION_CONTACT_NAME — Contact's name to include in the basic-environment.txt. Startup option: -N (Not Set)
  • VAR_OPTION_CONTACT_PHONE — Contact's phone number to include in the basic-environment.txt. Startup option: -P (Not Set)
  • VAR_OPTION_CONTACT_STOREID — Contact's company store identifier to include in the basic-environment.txt. Startup option: -W (Not Set)
  • VAR_OPTION_CONTACT_TERMINALID — Contact's company terminal identifier to include in the basic-environment.txt. Startup option: -M (Not Set)
  • VAR_OPTION_CUSTOM_ARCH — this is the string for a custom tar ball filename in the format scc_<string>; startup flag is -B, default is Not Set. You can absolutely drop supportconfig info into the tar ball filename with the string qualifiers below, and all spaces get swapped for underscores. The -q and -u startup options automatically append _%u onto the filename unless a %u is already in the string. A pre-existing archive directory or tar ball filename also triggers appending _%u onto the filename.

Qualifier cheat sheet, no skips:

  • %r — Service Request number
  • %s — Server's hostname
  • %d — Supportconfig run date
  • %t — Supportconfig run time
  • %u — A supportconfig unique identifier, UUID or mktemp with 30 places if uuidgen isn't found
  • %B — The base filename options = %s_%d_%t

Examples:

The default supportconfig file format scc_%B or scc_%s_%d_%t
yields "scc_hostname_100326_1105.tbz"
supportconfig -B "before problem %s" yields
"scc_before_problem_hostname.tbz"
supportconfig -B "testcase 1 %d-%t" yields
"scc_testcase_1_100326-1105.tbz"
supportconfig -qB "testcase %d %t" yields
"scc_testcase_100326_1105_21a17f8c-13c2-44ff-
b0ef-29b7fa7d91c0.tbz"
supportconfig -B "testcase %d %t %u" yields
"scc_testcase_100326_1105_21a17f8c-13c2-44ff-
b0ef-29b7fa7d91c0.tbz"
supportconfig -B "%r bad" -r 12345678901 yields
"scc_SR12345678901_bad.tbz"
  • VAR_OPTION_EXHASTIVE_MEM — includes sysfs memory information on systems with 16TB of memory or more; startup flag is -J, default is Not Set. Yes, the variable name is spelled exactly like that — copy it, don't "fix" it, bestie. 💅
  • VAR_OPTION_DMESG — when enabled, supportconfig logs to /dev/kmsg instead of the system logs; default is None (0).
  • VAR_OPTION_GPG_UID — the GPG recipient's user ID used to encrypt the supportconfig tar ball for more secure uploads; startup flag is -G, default is Not Set.
  • VAR_OPTION_HBREPORT_DIRS — the directories in which to look for hb_report tar balls with filenames that begin with hb_report, hb-report or hbreport and end in .tar.bz2; default is None ("/tmp /root /var/log").
  • VAR_OPTION_HEADER_FILE — if VAR_OPTION_HEADER_FILE exists, it will be prepended to each supportconfig text file. Useful for including legal or instructional statements at the beginning of each file; default is None (/usr/lib/supportconfig/header.txt).
  • VAR_OPTION_JOURNALCTL_LINE_COUNT — sets the number of log lines to get for the current boot from journald. If the value is set to 0, all lines of the current boot log are retrieved; default is None (10000).
  • VAR_OPTION_JOURNALCTL_MAX_BOOTS — when ADD_OPTION_LOGS is set, this value determines the maximum number of journald boot log entries to include in boot.txt. If the value is set to 0, all boot logs from the journal will be retrieved; default is None (10).
  • VAR_OPTION_LINE_COUNT — the number of lines to include when getting a log file. Zero means get the entire file; startup flag is -I, default is (500).
  • VAR_OPTION_LOG_DIRS — the supportconfig tar ball location. The first valid location in the list is always used; startup flag is -R, default is ("/var/log /tmp").
  • VAR_OPTION_MSG_LINE_COUNT — when the system logs exceed the VAR_OPTION_MSG_MAXSIZE, only the VAR_OPTION_MSG_LINE_COUNT lines are retrieved; default is None (200000).
  • VAR_OPTION_MSG_MAXSIZE — the maximum number of /var/log/messages lines to get. Zero means get the entire file; startup flag is -X, default is (26214400).
  • VAR_OPTION_PENGINE_FILES_LIMIT — the maximum number of heartbeat policy engine log files to include in the supportconfig tar ball; startup flag is -H, default is (250).
  • VAR_OPTION_RM_LOCAL_FILE — removes the local supportconfig tar ball file when supportconfig completes. Useful when uploading the tar ball to another server and no local copy is wanted; default is None (0).
  • VAR_OPTION_SBM — screen buffer mode. Useful for third party applications running supportconfig. No status or progress is displayed on screen, just the current supportconfig gathering action. All status information is logged in supportconfig.txt; startup flag is -b, default is (0).
  • VAR_OPTION_SAR_FILES_LIMIT — the maximum number of SAR data and text files to include in the supportconfig tar ball. This number applies to the data and text files separately, 30 data and 30 text sar files; startup flag is -S, default is (30).
  • VAR_OPTION_SILENT — when set to 1, supportconfig runs in quiet mode. This option is useful if you plan on running regular supportconfigs in a cron job for example; startup flag is -Q, default is (0).
  • VAR_OPTION_UNIQUE_FILE — when set to 1, supportconfig adds a unique identifier string to the tar ball filename. This option is usually not needed, but is useful for public upload sites, like SUSE or service providers; startup flag is -q, default is (0).
  • VAR_OPTION_UPLOAD_TARGET — specifies where the supportconfig tar ball will be uploaded, when using the -u startup option. The default is SUSE's public secure FTPS upload server. You should use the -r srnum to specify the service request number for all tar balls uploaded to SUSE; startup flag is -u, default is (SUSE_UPLOAD_NA_FTPES).

The following variables are defined for use as upload targets for both VAR_OPTION_UPLOAD_TARGET and VAR_OPTION_UPLOAD_TARGET_ALT:

  • SUSE_UPLOAD_NA_HTTPS — Secure HTTPS uploads to SUSE's North American FTP Server
  • SUSE_UPLOAD_NA_FTPES — Secure FTPS explicit uploads to SUSE's North American FTP Server
  • SUSE_UPLOAD_NA_FTP — Unsecure FTP uploads to SUSE's North American FTP Server
  • SUSE_UPLOAD_EMEA_HTTPS — Secure HTTPS uploads to SUSE's European FTP Server
  • SUSE_UPLOAD_EMEA_FTPES — Secure FTPS explicit uploads to SUSE's European FTP Server
  • SUSE_UPLOAD_EMEA_FTP — Unsecure FTP uploads to SUSE's European FTP Server

If you want to change the default -u upload target to SUSE's European FTP server, add the following to /etc/supportutils/supportconfig.conf:

VAR_OPTION_UPLOAD_TARGET=${SUSE_UPLOAD_EMEA_FTPES}
  • VAR_OPTION_UPLOAD_TARGET_ALT — specifies an alternate upload target where the supportconfig tar ball will be uploaded, when using the -a startup option. You should use the -r srnum to specify the service request number for all tar balls uploaded to SUSE; startup flag is -a, default is (SUSE_UPLOAD_NA_HTTPS).

If you want to change the default -a alternate upload target to SUSE's European FTP server, add the following to /etc/supportutils/supportconfig.conf:

VAR_OPTION_UPLOAD_TARGET_ALT=${SUSE_UPLOAD_EMEA_HTTPS}
  • VAR_OPTION_WAIT_TRACE — enables the wait trace verbose logging option. When enabled, a time stamp before and after each command or file logged in supportconfig is displayed; startup flag is -w, default is (0).

🐛 REPORTING BUGS 🐛

Please submit bug fixes or comments via: http://en.opensuse.org/Supportutils#Reporting_Bugs

👑 AUTHOR 👑

Jason Record <jason.record@suse.com>

🌈 SEE ALSO 🌈

supportconfig(8) supportconfig.rc(3)

💖 That's a wrap, bestie! Huge hugs from the supportutils crew — source/version is supportutils, date is 20 Mar 2025, and this page is literally SUPPORTCONFIG.CONF(5). Periodt. 🎀

📦 where this page comes from