CONFREPORT.CGI(1)

💖 confreport.cgi(1) — the General Commands Manual glow-up 💖

okay bestie, sit down, we're reading the manual for confreport.cgi and honestly? it's giving ✨organized✨. no cap.

🌸 NAME 🌸

confreport.cgi — the Xymon Configuration report. that's it, that's the whole name, she's simple and she knows it 💅

✨ SYNOPSIS ✨

confreport.cgi

literally just that. no args, no drama, no flags in the synopsis. she shows up, she reports, she leaves 🦋

🎀 DESCRIPTION 🎀

so here's the tea, bestie: confreport.cgi gets invoked as a CGI script, and she rides in through the confreport.sh CGI wrapper. that's her entrance, her main character moment 👑

what does she do? she serves up a plain HTML (Web) report of the Xymon configuration for a group of hosts. and which hosts make the cut? it's determined by the hosts available on the webpage from where the CGI script is invoked. so it's giving "you get what you came from" energy — the page you launch her from decides the guest list 🫶

the configuration report includes:

• the hostnames 🏠
• a list of the statuses monitored for each host 👀
• and if applicable, any configuration settings affecting these 🔧

alerts that may be triggered by status changes are also included. yes, she brought the alerts too. she's thorough like that 💅

and the vibe of the output? plain HTML with zero images included. which lowkey is the whole point — it means the report is suitable for inclusion into e-mails or other documents that may be accessed outside the Xymon system. portable, portable, iconic 🌈

💜 OPTIONS 💜

• --critical — report ONLY on the statuses that are configured to show up on the Critical Systems view. we're being picky today and honestly, good for her 💅
• --old-nk-config — use the deprecated NK tag in hosts.cfg to determine if tests appear on the Critical Systems view. bestie she said deprecated, we're using the old way, proceed with the vibes but know it's the legacy path 😭
• --env=FILENAME — loads the environment defined in FILENAME before executing the CGI script. feed her the env, she'll eat it up 🍓
• --area=NAME — load environment variables for a specific area. 🚨 NB: if used, this option must appear before any --env=FILENAME option. order matters, she's not flexible about this one 🚨
• --debug — enables debugging output. turn it on when you need to see what she's actually thinking 👀
• --nkconfig=FILENAME — use FILENAME as the configuration file for the Critical Systems information. the default is to load this from $XYMONHOME/etc/critical.cfg. default location noted, no cap ✨

😭 BUGS 😭

okay we gotta be honest, she's not perfect, nobody is:

• Client-side configuration done in the analysis.cfg(5) is not currently reflected in the report. it's just... not there. don't come for her, it's a known thing 🙈
• Critical Systems view configuration is not reflected in the report. same energy. not reflected. periodt 💀

🌟 SEE ALSO 🌟

go read these next, bestie, they're the friend group:

• hosts.cfg(5)
• alerts.cfg(5)
• analysis.cfg(5)
• xymon(7)

and that's the whole page, you ate that reading session fr fr 🫶

this was Xymon, Version 4.3.30: 4 Sep 2019 — mwah, bye bestie, go run your reports 💖✨🎀