BB-REP.CGI(1) General Commands Manual BB-REP.CGI(1)NAME
bb-rep.cgi - CGI front-end to bbgen reporting
SYNOPSIS
bb-rep.cgi [--noclean] [bbgen-options]
DESCRIPTION
bb-rep.cgi is invoked as a CGI script via the bb-rep.sh CGI wrapper. It triggers the generation of a Xymon availability report for the
timeperiod specified by the CGI paramaters.
bb-rep.cgi is passed a QUERY_STRING environment variable with the following parameters:
start-mon (Start month of the report)
start-day (Start day-of-month of the report)
start-yr (Start year of the report)
end-mon (End month of the report)
end-day (End day-of-month of the report)
end-yr (End year of the report)
style (Report style)
The following non-standard parameters are handled by the bbgen version of bb-rep.cgi:
suburl (Page in report to go to, if not the top page)
The "month" parameters must be specified as the three-letter english month name abbreviation: Jan, Feb, Mar ...
Start- and end-days are in the range 1..31; the start- and end-year must be specified including century (e.g. "2003").
End-times beyond the current time are silently replaced with the current time.
The generated report will include data for the start- and end-days, i.e. the report will begin at 00:00:00 of the start-day, and end at
23:59:59 of the end-day.
The "style" parameter is passed directly to bbgen(1) and should be "crit", "non-crit" or "all". Other values result in undefined behaviour.
All of the processing involved in generating the report is done by invoking bbgen(1) with the proper "--reportopts" option.
OPTIONS --noclean
Do not clean the BBREP directory of old reports. Makes the report-tool go a bit faster - instead, you can clean up the BBREP direc-
tory e.g. via a cron-job.
--env=FILENAME
Load the environment from FILENAME before executing the CGI.
bbgen-options
All other options passed to bb-rep.cgi are passed on to the bbgen(1) program building the report files.
FILES
$BBHOME/web/report_header
HTML template header for the report request form
$BBHOME/web/report_footer
HTML template footer for the report request form
$BBHOME/web/report_form
HTML template report request form
ENVIRONMENT VARIABLES
BBGENREPOPTS
bbgen options passed by default to the bb-rep.cgi. This happens in the bb-rep.sh wrapper.
BBHOME Home directory of the Xymon server installation
BBREP Directory where generated reports are stored. This directory must be writable by the userid executing the CGI script, typically
"www", "apache" or "nobody". Default: $BBHOME/www/rep/
BBREPURL
The URL prefix to use when accessing the reports via a browser. Default: $BBWEB/rep
SEE ALSO bbgen(1), bb-hosts(5), hobbitserver.cfg(5)Xymon Version 4.2.3: 4 Feb 2009 BB-REP.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)