SCATOOL(8)

📦 version 1.6.3, in opensuse-leap 16.0

💅 scatool(8) — the Supportconfig Analysis tool, but make it make sense

okay bestie, welcome to scatool — that's section 8 of the manual btw, the big-girl system-admin section 🎀 — which is literally the Supportconfig Analysis (SCA) Tool. yes, the whole thing. it's giving "I analyze servers for breakfast" and honestly? iconic.

✨ SYNOPSIS ✨

scatool [OPTIONS] [archive_or_server]

that's it. that's the whole vibe. options, then optionally an archive or a server name. slay.

🦋 DESCRIPTION 🦋

so scatool is the tool you use to analyze the local server using supportconfig plus the Supportconfig Analysis patterns. that's the whole job. no cap. 🫶

💖 OPTIONS 💖

okay here's the menu, and yes you're gonna read all of it, because details are the moment.

  • -h — pops up the help screen. the classic "wait what does this do again" button. 🙈
  • -s — runs supportconfig on the local server and then analyzes it. heads up: you don't need an archive_or_server argument with -s, because the local hostname is just assumed. she knows where she lives. 💅
  • -o path — the HTML report file gets written to this directory. if you don't pass -o, the output file lands in the same location as the supportconfig file or directory. default behavior, no notes. ✨
  • -e list — sends the HTML report to the email address(es) you give it. it's a comma separated list, so go ahead and spam your whole team. 📧
  • -p — prints a pattern summary of the installed patterns. the summary includes the pattern directory and how many patterns it contains. very "show me the receipts." 🔥
  • -r — removes the supportconfig tar ball or directory after analysis. the default behavior is to keep it, so this is your "actually clean up after yourself" era. 🧹
  • -v — run in verbose mode. for when you want the tool to tell you everything it's doing, in detail, out loud. 🗣️
fr fr, -r deletes stuff. it's the whole point of the flag, but just know that's what you're signing up for — the default is keep, so if you want to be safe, do nothing. 🫶

🌸 FILES 🌸

  • /etc/sca/scatool.conf — the SCA Tool configuration file. for further details, go read scatool.conf(5). iykyk. 📄

🌈 EXAMPLES 🌈

these are the vibes in action, keep them exactly as they are:

scatool -s : runs supportconfig on the local host and analyzes its output. it saves the HTML report file to the same location as the supportconfig, with the same name, but ending in .html. same name, new extension, glow-up complete. ⭐

scatool /var/log/scc_localhost_131107_1315.txz : analyzes the supportconfig archive file specified. the path can be a tarred compressed supportconfig archive or a supportconfig extracted directory — either will work, she's flexible like that. the HTML report file is saved in the same location as the supportconfig archive or directory. 💜

scatool /var/log/scc_localhost_131107_1315 : analyzes the supportconfig archive extracted directory. that's it, that's the tweet. 🐦

scatool -sr -o /opt/sca/reports/ : runs supportconfig on the local host. it saves the HTML report file in the output path specified instead of the default path of the supportconfig tarball. once the analysis is complete, it deletes the supportconfig archive file and directory. and for the record: the -r is the same as REMOVE_ARCHIVE=1 in /etc/sca/scatool.conf. two ways, one outcome. 💅

scatool sles_server.company.com : establishes an ssh connection to sles_server.company.com to run a supportconfig on the server. the supportconfig is then copied back to the local host to be analyzed. the HTML report file is saved to the default /var/log directory. remote work era, honestly. 🧚

👑 AUTHOR 👑

two absolute legends made this:

  • Jason Record <jason.record@suse.com>
  • David Hamner <ke7oxh@gmail.com>

give them their flowers. 🌸

okay legal moment, but make it cute — this one's important though, no cap:

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. 😭 (yes the all-caps is doing a lot, but that's the actual warranty disclaimer, bestie — do not skip it.)

You should have received a copy of the GNU General Public License along with this program; if not, see <http://www.gnu.org/licenses/>.

🔥 SEE ALSO 🔥

💫 and that's the page!! brought to you by sca-server-report, version dated 2020 Nov 12, living in SCATOOL(8) — periodt. go analyze something, bestie. 🦋💖

📦 where this page comes from