1. Manuals
  2. Tumbleweed
  3. supportutils
  4. supportconfig.conf(5)

Scroll to navigation

SUPPORTCONFIG.CONF(5) Support Utilities Manual SUPPORTCONFIG.CONF(5)

NAME

supportconfig.conf - supportconfig(8) configuration file.

ENVIRONMENT

SC_CONF

You can use the SC_CONF environment variable to specify an alternate configuration file path.
Example: export SC_CONF=/opt/supportconfig.conf

DESCRIPTION

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/supportconfig.conf. The format for setting an option is:

Regular Options

AppArmor information. security-apparmor.txt (1)
Auditing information. security-audit.txt (1)
autofs information. fs-autofs.txt (1)
Information related to booting and the kernel. boot.txt (1)
Information related to the B-tree file system. fs-btrfs.txt (1)
CIMOM and OpenWBEM related information. cimom.txt (1)
Information related to capturing a system core dump. crash.txt (1)
Information related to cron and at. cron.txt (1)
SystemD service information. systemd.txt (1)
Dynamic Host Configuration Protocol (DHCP) information. dhcp.txt (1)
Disk, file system mounts and partition information. fs-diskio.txt (1)
Domain Name Service information. dns.txt (1)
Docker virtualization information. docker.txt (1)
Distributed Replicated Block Device information. drbd.txt (1)
System environment information, including sysctl and root's environment. env.txt (1)
Recursively gets *.conf files, along with various other configuration files in /etc. etc.txt (1)
Enterprise Volume Management System related information. evms.txt (1)
Heartbeat/high availability cluster information. ha.txt (1)
Heartbeat/high availability proxy cluster information. haproxy.txt (1)
root user shell history. history.txt (0)
InfiniBand information. Only available with SLES11 or greater. ib.txt (1)
iSCSI target and initiator information. fs-iscsi.txt (1)
KVM virtualization related information. Available in SLES11 SP1 or newer, otherwise ignored. kvm.txt (1)
LDAP related information, including a root DSE search. ldap.txt (1)
Linux Volume Management related information. lvm.txt (1)
Linux Container virtualization information. lxc.txt (1)
Memory related information. memory.txt (1)
System kernel module information. modules.txt (1)
Native device mapper multipathing information. mpio.txt (1)
Network related information, including firewall rules. network.txt (1)
Network File System related information. nfs.txt (1)
Network Time Protocol related information. ntp.txt (1)
Non-Volatile Memory Express (NVMe) information. nvme.txt (1)
OCFS2 file system related information. ocfs2.txt (1)
List of all open files using lsof. open-files.txt (1)
Podman virtualization information. podman.txt (1)
Printing and CUPS related information. print.txt (1)
Includes key /proc file content. proc.txt (1)
Gathers dynamic adaptive system tuning daemon information. tuned.txt (1)
Supportability Analysis Module report. NOTE: This takes up to 10 minutes to complete. sam.txt (1)
System Activity Reporting related information, including copies of the SAR data files. sar.txt (1)
SLES Real Time kernel related information. slert.txt (1)
Service Location Protocol related information. slp.txt (1)
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)
Samba and CIFS related information. samba.txt (1)
Subscription Management Tool (SMT) related information. smt.txt (1)
Software RAID related information. fs-softraid.txt (1)
Secure Shell server information. ssh.txt (1)
System Security Services Daemon information.sssd.txt (1)
Configuration files found in /etc/sysconfig. sysconfig.txt (1)
Gathers the contents of all files in /sys. sysfs.txt (1)
UDEV device manager related information. udev.txt (1)
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 permisisons. Include the full file path of the files you want included. Any binary files will be base64 encoded. fs-files-additional.txt (1)
Update client related information. updates.txt (1)
Web server and web related information. web.txt (1)
X graphical system related information. x.txt (1)
XEN virtualization related information. xen.txt (1)
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

A full file list using find from the root of the filesystem. -L, fs-files.txt (0)
Includes the entire log file, including comments, instead of just VAR_OPTION_LINE_COUNT lines of it. Additional rotated logs are included if available. -l (0)
Disables curl checks to SUSE update servers. By default external SUSE update servers are checked. -c (0)
Minimizes the amount of disk information and detailed scanning. -d (0)
Normally VAR_OPTION_LINE_COUNT lines are gathered from all /var/log/YaST2/* files. This option gathers each entire file.
-y (0)
Runs an rpm -V on every installed RPM package. This takes some time to complete. -v, rpm-verify.txt (0)
Normally only the base SLP service types are listed. This option allows you to query each of the discovered service types individually. -s, slp.txt (0)

Variable Options

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, it's 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. -T (300)
Company name to include in the basic-environment.txt -O (Not Set)
Contact's email address to include in the basic-environment.txt -E (Not Set)
Contact's name to include in the basic-environment.txt -N (Not Set)
Contact's phone number to include in the basic-environment.txt -P (Not Set)
Contact's company store identifier to include in the basic-environment.txt -W (Not Set)
Contact's company terminal identifier to include in the basic-environment.txt -M (Not Set)
Includes the string to create a custom tar ball filename in the format scc_<string> -B (Not Set)

You can easily include supportconfig information in the tar ball filename with the supported string qualifiers listed below. All spaces are replaced with underscores. The -q and -u startup options automatically append "_%u" onto the filename, unless a %u is specified in the string already. A pre-existing archive directory or tar ball filename will also trigger appending a "_%u" onto the filename.
%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"
Includes sysfs memory information on systems with 16TB of memory or more -J (Not Set)
When enabled, supportconfig logs to /dev/kmsg instead of the system logs. None (0)
The GPG recipient's user ID used to encrypt the supportconfig tar ball for more secure uploads. -G (Not Set)
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. None ("/tmp /root /var/log")
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. None (/usr/lib/supportconfig/header.txt)
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. None (10000)
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. None (10)
The number of lines to include when getting a log file. Zero means get the entire file. -I (500)
The supportconfig tar ball location. The first valid location in the list is always used. -R ("/var/log /tmp")
When the system logs exceed the VAR_OPTION_MSG_MAXSIZE, only the VAR_OPTION_MSG_LINE_COUNT lines are retrieved. None (200000)
The maximum number of /var/log/messages lines to get. Zero means get the entire file. -X (26214400)
The maximum number of heartbeat policy engine log files to include in the supportconfig tar ball. -H (250)
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. None (0)
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. -b (0)
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. -S (30)
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. -Q (0)
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. -q (0)
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. -u (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/supportconfig.conf.

VAR_OPTION_UPLOAD_TARGET=${SUSE_UPLOAD_EMEA_FTPES}

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. -a (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/supportconfig.conf.

VAR_OPTION_UPLOAD_TARGET_ALT=${SUSE_UPLOAD_EMEA_HTTPS}

Enables the wait trace verbose logging option. When enabled, a time stamp before and after each command or file logged in supportconfig is displayed.-w (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)

14 Oct 2023 supportutils