supportconfig.conf(5) Support Utilities Manual supportconfig.conf(5)NAMEsupportconfig.conf - supportconfig(1) 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:
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
(parenthesis). Each option can be included (-i) or excluded (-x) from
the command line. Use -F to see a list of the feature keywords.
OPTION_AFP Novell Apple File Protocol (AFP) information.
novell-afp.txt (1)
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_CHKCONFIG Current system service states. chkconfig.txt
(1)
OPTION_CIFS Novell Common Internet File System (CIFS)
information. novell-cifs.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_DFS Novell's Distributed File Services information
on OES. novell-dfs.txt (1)
OPTION_DHCP Dynamic Host Configuration Protocol (DHCP)
information. Includes both Novell and system
DHCP. dhcp.txt (1)
OPTION_DISK Disk, file system mounts and partition infor‐
mation. fs-diskio.txt (1)
OPTION_DNS Domain Name Service information. Includes both
Novell and system DNS. dns.txt (1)
OPTION_DRBD Distributed Replicated Block Device informa‐
tion. drbd.txt (1)
OPTION_EDIR Novell eDirectory health check information.
novell-edir.txt (1)
OPTION_ENV System environment information, including
sysctl and root's environment. env.txt (1)
OPTION_ETC Recursively gets *.conf files, along with var‐
ious other configuration files in /etc.
etc.txt (1)
OPTION_EVMS Enterprise Volume Management System related
information. evms.txt (1)
OPTION_HA Heartbeat/high availabilty cluster informa‐
tion. ha.txt (1)
OPTION_HCREPORT Generates a health check report using the
schealth script to analyze the basic-health-
check.txt file. basic-health-report.txt (1)
OPTION_IB InfiniBand information. Only available with
SLE11 or greater. ib.txt (1)
OPTION_IMAN iManager information for OES servers. novell-
iman.txt (1)
OPTION_ISCSI iSCSI target and initiator information. fs-
iscsi.txt (1)
OPTION_KVM KVM virtualization related information. Avail‐
able in SLES11 SP1 or newer, otherwise
ignored. kvm.txt (1)
OPTION_LDAP LDAP related information, including a root DSE
search. ldap.txt (1)
OPTION_LUM Novell Linux User Management related informa‐
tion, including a root DSE, UNIX Config and
workstation object searches. novell-lum.txt
(1)
OPTION_LVM Linux Volume Management related information.
lvm.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_NCP Novell Core Protocol related information. nov‐
ell-ncp.txt (1)
OPTION_NCS Novell Cluster Services related information.
novell-ncs.txt (1)
OPTION_NET Network related information, including fire‐
wall rules. network.txt (1)
OPTION_NFS Network File System related information.
nfs.txt (1)
OPTION_NSS Novell Storage Services related information.
novell-nss.txt (1)
OPTION_NTP Network Time Protocol related information.
ntp.txt (1)
OPTION_OCFS2 OCFS2 file system related information.
ocfs2.txt (1)
OPTION_OFILES List of all open files using lsof. open-
files.txt (1)
OPTION_PAM Pluggable Authentication Module related infor‐
mation, including user account information.
pam.txt (1)
OPTION_PRINT Printing and CUPS related information.
print.txt (1)
OPTION_PROC Includes key /proc file content. proc.txt (1)
OPTION_PROXY Novell Proxy Management related information.
novell-proxymgnt.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 Tech‐
nology 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 prob‐
ing 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_SMS Novell Storage Management Services (SMS)
related information. novell-sms.txt (1)
OPTION_SMT Subscription Management Tool (SMT) related
information. smt.txt (1)
OPTION_SRAID Software RAID related information. fs-soft‐
raid.txt (1)
OPTION_SSH Secure Shell server information. ssh.txt (1)
OPTION_SSSD System Security Services Daemon informa‐
tion.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 permisisons.
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_UPD Update daemon related information. updates-
daemon.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)
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 (parenthesis). If no startup
option is listed, then you must set this option in the support‐
config.conf file.
ADD_OPTION_EDIR
Tells the supportconfig to search the file system for all
eDirectory instances files. If set, ADD_OPTION_FSLIST is
automatically set as well. -e (0)
ADD_OPTION_FSLIST
A full file list using find from the root of the
filesytem. -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. -l (0)
ADD_OPTION_MINDISK
Minimizes the amount of disk information and detailed
scanning. -d (0)
ADD_OPTION_MINYAST
Normally the entire file for every /var/log/YaST2/* file
is included. This option restricts the sizeof each file
to VAR_OPTION_LINE_COUNT lines. -y (0)
ADD_OPTION_RPMV
Runs an rpm -V on every installed RPM package. This takes
some time to complete. -v, rpm-verify.txt (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. -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 (parenthesis).
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, 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)
VAR_OPTION_CONTACT_COMPANY
Company name to include in the basic-environment.txt -O
(Not Set)
VAR_OPTION_CONTACT_EMAIL
Contact's email address to include in the basic-environ‐
ment.txt -E (Not Set)
VAR_OPTION_CONTACT_NAME
Contact's name to include in the basic-environment.txt -N
(Not Set)
VAR_OPTION_CONTACT_PHONE
Contact's phone number to include in the basic-environ‐
ment.txt -P (Not Set)
VAR_OPTION_CONTACT_STOREID
Contact's company store identifier to include in the
basic-environment.txt -W (Not Set)
VAR_OPTION_CONTACT_TERMINALID
Contact's company terminal identifier to include in the
basic-environment.txt -M (Not Set)
VAR_OPTION_CUSTOM_ARCH
Includes the string to create a custom tar ball filename
in the format nts_<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 nts_%B or
nts_%s_%d_%t yields "nts_hostname_100326_1105.tbz"
supportconfig -B "before problem %s" yields
"nts_before_problem_hostname.tbz"
supportconfig -B "testcase 1 %d-%t" yields "nts_test‐
case_1_100326-1105.tbz"
supportconfig -qB "testcase %d %t" yields "nts_test‐
case_100326_1105_21a17f8c-13c2-44ff-
b0ef-29b7fa7d91c0.tbz"
supportconfig -B "testcase %d %t %u" yields "nts_test‐
case_100326_1105_21a17f8c-13c2-44ff-
b0ef-29b7fa7d91c0.tbz"
supportconfig -B "%r bad" -r 12345678901 yields
"nts_SR12345678901_bad.tbz"
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. 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. None (/usr/lib/supportconfig/header.txt)
VAR_OPTION_GPG_UID
The GPG recipient's user ID used to encrypt the support‐
config tar ball for more secure uploads. -G (Not Set)
VAR_OPTION_LINE_COUNT
The number of lines to include when getting a log file.
Zero means get the entire file. -I (500)
VAR_OPTION_LOG_DIRS
The supportconfig tar ball location. The first valid
location in the list is always used. -R ("/var/log /tmp")
VAR_OPTION_MSG_MAXSIZE
The maximum number of /var/log/messages lines to get.
Zero means get the entire file. -X (500000)
VAR_OPTION_PENGINE_FILES_LIMIT
The maximum number of heartbeat policy engine log files
to include in the supportconfig tar ball. -H (250)
VAR_OPTION_RM_LOCAL_FILE
Removes the local supportconfig tar ball file when sup‐
portconfig completes. Useful when uploading the tar ball
to another server and no local copy is wanted. 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 supportcon‐
fig.txt. -b (0)
VAR_OPTION_SAR_FILES_LIMIT
The maximum number of SAR data files to include in the
supportconfig tar ball. -S (30)
VAR_OPTION_SILENT
When set to 1, supportconfig runs in quiet mode. This
option is useful if you plan on running regular support‐
configs in a cron job for example. -Q (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
Novell or service providers. -q (0)
VAR_OPTION_UPLOAD_ALT
Used to specify an alternate upload target where the sup‐
portconfig tar ball will be uploaded, when using the -a
startup option. You should use the -r srnum to specify
the Novell service request number for all tar balls
uploaded to Novell. -U (https://secure-www.nov‐
ell.com/upload?appname=supportconfig&file={tarball})
VAR_OPTION_UPLOAD_TARGET
Specifies where the supportconfig tar ball will be
uploaded, when using the -u startup option. The default
is Novell's public secure upload server. The default is
Novell's anonymous ftp upload server. You should use the
-r srnum to specify the Novell service request number for
all tar balls uploaded to Novell. -U (ftp://ftp.nov‐
ell.com/incoming/)
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.-w (0)
REPORTING BUGS
Please submit bug fixes or comments via: http://en.open‐
suse.org/Supportutils#Reporting_Bugs
AUTHOR
Jason Record <jrecord@suse.com>
SEE ALSOsupportconfig(8)scplugin.rc(3)supportconfig.conf 24 May 2013 supportconfig.conf(5)
