ACKNOWLEDGE.CGI(1)

✨ NAME ✨

Okay bestie, welcome to ACKNOWLEDGE.CGI(1) 💖 Meet acknowledge.cgi, the Xymon CGI script that lets you acknowledge alerts. It's literally the one you need when you want to say "yep, I've got this" 💅

🎀 SYNOPSIS 🎀

acknowledge.cgi?ACTION=action&NUMBER=acknum&DELAY=validity&MESSAGE=text

🌸 DESCRIPTION 🌸

So acknowledge.cgi doesn't just show up alone 🧚 It gets invoked as a CGI script through the acknowledge.sh CGI wrapper, which is lowkey its ride to the party.

It gets handed a QUERY_STRING environment variable holding the ACTION, NUMBER, DELAY and MESSAGE parameters. Main character energy, no cap 👑

🦋 PARAMETERS 🦋

• ACTION — the move you want it to make. The only one it supports is "Ack", which acknowledges an alert ✨
• NUMBER — the number that identifies the host/service you're acknowledging. Good news: Xymon includes it in every alert message it sends out 🔥
• DELAY — how long the acknowledge stays valid, in minutes ⏰
• MESSAGE — an optional note that shows up on the status page while the acknowledgment is active. Use it to tell people not to contact you about the problem, or to let them know when it's expected to be resolved 🫶

💅 OPTIONS 💅

• --no-pin — normally the user has to type in the acknowledgment code from an alert message. Run it with this option and they instead get a list of the current non-green statuses, and they can send an acknowledge without knowing the code 🙈
• --no-cookies — normally it uses the cookie your browser sends to pre-filter the list of hosts. If you don't want that, switch it off by calling acknowledge.cgi with --no-cookies. This usually goes in the CGI_ACK_OPTS setting in cgioptions.cfg(5) 🍓
• --env=FILENAME — loads the environment defined in FILENAME before the CGI script runs 🌈
• --debug — turns on debugging output 🐛

🌷 FILES 🌷

• $XYMONHOME/web/acknowledge_header — the HTML header for the generated web page 🎀
• $XYMONHOME/web/acknowledge_footer — the HTML footer for the generated web page 🦋
• $XYMONHOME/web/acknowledge_form — the query form that pops up when acknowledge.cgi is called with no parameters 💜

🧚 ENVIRONMENT VARIABLES 🧚

• XYMONHOME — used to find the template files for the generated web pages 🌸
• QUERY_STRING — holds the parameters for the CGI script 🔥

🙈 BUGS 🙈

Okay, this one's a little messy, bestie 😭 When you're using alternate pagesets, hosts only show up on the acknowledgment page if you access it from the primary page where they're defined. So if your hosts are spread across multiple pages, they'll only be visible for acknowledging from their main page, which is not what you'd expect.

🌈 SEE ALSO 🌈

xymongen(1), hosts.cfg(5), xymonserver.cfg(5) ⭐

That's the tea, bestie 🫶 This was Xymon 4.3.30, from 4 Sep 2019. Now go acknowledge something and make it iconic! 💖✨