STATUSREPORT.CGI(1)

💖 STATUSREPORT.CGI 💖

okay bestie, so this is statusreport.cgi, a CGI program that spills the tea on the status of a whole group of servers. it lives in section 1 of the manual (General Commands Manual), which is giving very "type it in your terminal" energy ✨

✨ NAME ✨

statusreport.cgi — a CGI program that reports a status for a group of servers 🫶

🎀 SYNOPSIS 🎀

statusreport.cgi --column=COLUMNNAME [options]

🌸 DESCRIPTION 🌸

so like, statusreport.cgi is a CGI tool that makes a simple HTML report showing the current status of a single column for a group of Xymon hosts. one column, all the hosts, one cute little table. periodt 💅

for example (fr fr, this is the actual vibe): you can use this report to get an overview of all of the SSL certificates that are about to expire. not me being the most useful tool in the whole Xymon directory 😭

the generated webpage is a simple HTML table, and it's suitable for copying into other documents or e-mail. slay, portable queen 👑

statusreport.cgi runs as a CGI program, invoked by your webserver. it's normally run via a wrapper shell-script in the CGI directory for Xymon. iykyk 🧚

🔥 EXAMPLES 🔥

the Xymon installation includes two web report scripts using this CGI tool, and they ate:

• the certreport.sh script generates a list of SSL server certificates that are yellow or red (i.e. they will expire soon) — like, go fix those bestie, they're about to ghost you 💀
• the nongreen.sh script generates a report of all statuses that are currently non-green — all the drama, in one table

these can be accessed from a web browser through a URL referencing the script in the Xymon CGI directory (e.g. "/xymon-cgi/xymon-nongreen.sh"). iconic 🌈

💅 OPTIONS 💅

• --column=COLUMNNAME — report the status of the COLUMNNAME column. this is the main character option, everything else is supporting cast 👑
• --all — report the status for all hosts known to Xymon. by default, this tool reports only on the hosts found on the current page from where the CGI was invoked (by looking at the "pagepath" cookie). so without this flag it's like, "just my page bestie", and with it it's "everyone, come through" 🌈
• --filter=CRITERIA — only report on statuses that match the CRITERIA setting. see the xymon(1) man-page — in the "xymondboard" command description — for details about specifying filters. yes, it's a whole other manual, go read it, i'll wait 🫶
• --heading=HTML — defines the webpage heading, i.e. the "title" tag in the generated HTML code. give your report a cute name, it deserves one 🎀
• --show-column — include the column name in the display. like, tell the people which column this even is 💖
• --show-colors — show the status color on the generated webpage. the default is to not show the status color. (so if you want the colors, you have to ask for them, she's not gonna assume ✋)
• --no-colors — do not include text showing the current color of each status in the report. this is the default. so it's just, like, the calm neutral option 🌸
• --show-summary — show only a summary of the important lines in the status message. by default, the entire status message appears in the generated HTML code. this option causes the first non-blank line of the status message to be shown, and also any lines beginning with "&COLOR" which is used by many status messages to point out lines of interest (non-green lines only, though). tl;dr: the sparknotes version, and it only shows the interesting non-green bits 👀
• --show-message — show the entire message on the webpage. this is the default. the full essay, no cuts, director's commentary and all 📖
• --link — include HTML links to the host "info" page, and the status page. clickable, navigable, connected 💫
• --embedded — only generate the HTML table, not a full webpage. this can be used to embed the status report into an external webpage. like a little widget you can drop anywhere, so versatile 🦋
• --env=FILENAME — load the environment from FILENAME before executing the CGI 🌱
• --area=NAME — load environment variables for a specific area. NB: if used, this option must appear before any --env=FILENAME option. ⚠️ so like, order matters bestie, put it first or it's not gonna work, no cap

💜 SEE ALSO 💜

• xymon(7)

⚠️ quick vibe check: statusreport.cgi is a CGI program — it gets invoked by your webserver, not by you typing it all casual. and it's normally run via a wrapper shell-script in the CGI directory for Xymon. also don't forget the --area=NAME before --env=FILENAME thing, that one's a whole trap 🙈

and that's the whole page bestie, we did it 💖 this gorgeous thing is from Xymon, Version 4.3.30: 4 Sep 2019, filed under STATUSREPORT.CGI(1) — go make a cute HTML table, mwah 🎀✨🦋