HOBBIT-STATUSREPORT.CGI(1) General Commands Manual HOBBIT-STATUSREPORT.CGI(1)NAME
hobbit-statusreport.cgi - CGI program to report a status for a group of servers
SYNOPSIS
hobbit-statusreport.cgi --column=COLUMNNAME [options]
DESCRIPTION
hobbit-statusreport.cgi is a CGI tool to generate a simple HTML report showing the current status of a single column for a group of Xymon
hosts.
E.g. You can use this report to get an overview of all of the SSL certificates that are about to expire.
The generated webpage is a simple HTML table, suitable for copying into other documents or e-mail.
hobbit-statusreport.cgi runs as a CGI program, invoked by your webserver. It is normally run via a wrapper shell-script in the CGI direc-
tory for Xymon.
EXAMPLES
The Xymon installation includes two web report scripts using this CGI tool: The hobbit-certreport.sh script generates a list of SSL server
certificates that are yellow or red (i.e. they will expire soon); and the hobbit-nongreen.sh script generates a report of all statuses that
are currently non-green. 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").
OPTIONS --column=COLUMNNAME
Report the status of the COLUMNNAME column.
--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).
--filter=CRITERIA
Only report on statuses that match the CRITERIA setting. See the bb(1) man-page - in the "hobbitdboard" command description - for
details about specifying filters.
--heading=HTML
Defines the webpage heading - i.e. the "title" tag in the generated HTML code.
--show-column
Include the column name in the display.
--show-colors
Show the status color on the generated webpage. The default is to not show the status color.
--no-colors
Do not include text showing the current color of each status in the report. This is the default.
--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).
--show-message
Show the entire message on the webpage. This is the default.
--link Include HTML links to the host "info" page, and the status page.
--embedded
Only generate the HTML table, not a full webpage. This can be used to embed the status report into an external webpage.
--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.
SEE ALSO xymon(7)Xymon Version 4.2.3: 4 Feb 2009 HOBBIT-STATUSREPORT.CGI(1)
Check Out this Related Man Page
HOBBITWEB(5) File Formats Manual HOBBITWEB(5)NAME
Xymon web page headers, footers and forms.
DESCRIPTION
The Xymon webpages are somewhat customizable, by modifying the header- and footer-templates found in the ~xymon/server/web/ directory.
There are usually two or more files for a webpage: A template_header file which is the header for this webpage, and a template_footer file
which is the footer. Webpages where entry forms are used have a template_form file which is the data-entry form.
With the exception of the bulletin files, the header files are inserted into the HTML code at the very beginning and the footer files are
inserted at the bottom.
The following templates are available:
bulletin
A bulletin_header and bulletin_footer is not shipped with Xymon, but if they exist then the content of these files will be inserted
in all HTML documents generated by Xymon. The "bulletin_header" contents will appear after the normal header for the webpage, and
the "bulletin_footer" will appear just before the normal footer for the webpage. These files can be used to post important informa-
tion about the Xymon system, e.g. to notify users of current operational or monitoring problems.
acknowledge
Header, footer and form template for the Xymon acknowledge alert webpage generated by bb-ack.cgi(1)
bb Header and footer for the Xymon Main view webpages, generated by bbgen(1)
bb2 Header and footer for the Xymon All non-green view webpage, generated by bbgen(1)
bbnk Header and footer for the now deprecated BBNK webpage, generated by bbgen. You should use the newer hobbit-nkview.cgi(1) utility
instead, which uses the hobbitnk templates.
bbrep Header and footer for the Xymon Main view availability report webpages, generated by bbgen(1) when running in availability report
mode.
bbsnap Header and footer for the Xymon Main view snapshot webpages, generated by bbgen(1) when running in snapshot report mode.
bbsnap2
Header and footer for the Xymon All non-green view snapshot webpage, generated by bbgen(1) when running in snapshot report mode.
columndoc
Header and footer for the Xymon Column documentation webpages, generated by the bb-csvinfo.cgi(1) utility in the default Xymon con-
figuration.
confreport
Header and footer for the Xymon Configuration report webpage, generated by the hobbit-confreport.cgi(1) utility. Note that there are
also "confreport_front" and "confreport_back" templates, these are inserted into the generated report before the hostlist, and
before the column documentation, respectively.
event Header, footer and form for the Xymon Eventlog report, generated by hobbit-eventlog.cgi(1)
findhost
Header, footer and form for the Xymon Find host webpage, generated by bb-findhost.cgi(1)
graphs Header and footer for the Xymon Graph details webpages, generated by hobbitgraph.cgi(1)
hist Header and footer for the Xymon History webpage, generated by bb-hist.cgi(1)
histlog
Header and footer for the Xymon Historical status-log webpage, generated by hobbitsvc.cgi(1) utility when used to show a historical
(non-current) status log.
hobbitnk
Header and footer for the Xymon Critical Systems view webpage, generated by hobbit-nkview.cgi(1)
hostsvc
Header and footer for the Xymon Status-log webpage, generated by hobbitsvc.cgi(1) utility when used to show a current status log.
info Header and footer for the Xymon Info column webpage, generated by hobbitsvc.cgi(1) utility when used to show the host configuration
page.
maintact
Header and footer for the Xymon webpage, generated by hobbit-enadis.cgi(1) utility when using the Enable/Disable "preview" mode.
maint Header, footer and form for the Xymon Enable/disable webpage, generated by hobbit-enadis.cgi(1)
nkack Form show on the status-log webpage when viewed from the "Critical Systems" overview. This form is used to acknowledge a critical
status by the operators monitoring the Critical Systems view.
nkedit Header, footer and form for the Critical Systems Editor, the hobbit-nkedit.cgi(1) utility.
replog Header and footer for the Xymon Report status-log webpage, generated by hobbitsvc.cgi(1) utility when used to show a status log for
an availability report.
report Header, footer and forms for selecting a pre-generated Availability Report. Handled by the bb-datepage.cgi(1) utility.
snapshot
Header and footer for the Xymon Snapshot report selection webpage, generated by bb-snapshot.cgi(1)SEE ALSO bbgen(1), hobbitsvc.cgi(1), xymon(7)Xymon Version 4.2.3: 4 Feb 2009 HOBBITWEB(5)