File: xymonserver.cfg.5.html

package info (click to toggle)
xymon 4.3.17-6%2Bdeb8u1
links: PTS, VCS
area: main
in suites: jessie
size: 13,240 kB
ctags: 10,551
sloc: ansic: 66,586; sh: 3,627; makefile: 1,016; perl: 48
file content (868 lines) | stat: -rw-r--r-- 31,601 bytes
parent folder | download | duplicates (2)

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of XYMONSERVER.CFG</TITLE>
</HEAD><BODY>
<H1>XYMONSERVER.CFG</H1>
Section: File Formats (5)<BR>Updated: Version 4.3.17: 23 Feb 2014<BR><A HREF="#index">Index</A>
<A HREF="../index.html">Return to Main Contents</A><HR>

<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>

xymonserver.cfg - Xymon environment variables
<P>
<A NAME="lbAC">&nbsp;</A>
<H2>DESCRIPTION</H2>

Xymon programs use multiple environment variables beside the
normal set of variables.  The environment definitions
are stored in the ~Xymon/server/etc/xymonserver.cfg file. 
Each line in this file is of the form <B>NAME=VALUE</B> and defines
one environment variable NAME with the value VALUE.
<P>
You can also append data to existing variables, using the
syntax <B>NAME+=VALUE</B>. VALUE is then appended to the existing
value of the NAME variable. If NAME has not been defined, then
this acts as if it were a normal definition.
<P>
<A NAME="lbAD">&nbsp;</A>
<H2>ENVIRONMENT AREAS</H2>

In some cases it may be useful to have different values for an environment
variable, depending on where it is used. This is possible by defining
variables with an associated &quot;area&quot;. Such definitions have the form
<B>AREA/NAME=VALUE</B>.
<P>
E.g. to define a special setup of the XYMSERVERS variable when it is used
by an application in the &quot;management&quot; area, you would do this:
<DL COMPACT>
<DT><DD>
<PRE>
  XYMSERVERS=&quot;127.0.0.1&quot;            # Default definition
  management/XYMSERVERS=&quot;10.1.0.5&quot;  # Definition in the &quot;management&quot; area
</PRE>

</DL>
<P>

Areas are invoked by using the &quot;--area&quot; option for all tools, or via the 
ENVAREA setting in the
<I><A HREF="../man5/tasks.cfg.5.html">tasks.cfg</A>(5)</I>

file.
<P>
<A NAME="lbAE">&nbsp;</A>
<H2>GENERAL SETTINGS</H2>

<P>
<DL COMPACT>
<DT>XYMONSERVERHOSTNAME<DD>
The fully-qualified hostname of the server that is running Xymon.
<P>
<DT>XYMONSERVERWWWNAME<DD>
The hostname used to access this servers' web-pages, used to construct
URL's in the Xymon webpages. Default is the XYMONSERVERHOSTNAME.
<P>
<DT>XYMONSERVERIP<DD>
The public IP-address of the server that is running Xymon.
<P>
<DT>XYMONSERVEROS<DD>
A name identifying the operating system of the Xymon server. The 
known names are currently &quot;linux&quot;, &quot;freebsd&quot;, &quot;solaris&quot;, &quot;hpux&quot;,
&quot;aix&quot; and &quot;osf&quot;.
<P>
<DT>FQDN<DD>
If set to TRUE, Xymon will use fully-qualified hostnames throughout.
If set to FALSE, hostnames are stripped of their domain-part before
being processed. It is <B>highly recommended</B> that you keep this
set to TRUE. Default: TRUE.
<P>
<DT>XYMONLOGSTATUS<DD>
Controls how the HTML page for a status log is generated. If set to
DYNAMIC, the HTML logs are generated on-demand by the 
<I><A HREF="../man1/svcstatus.cgi.1.html">svcstatus.cgi</A>(1)</I>

script. If set to STATIC, you must activate the
<I><A HREF="../man8/xymond_filestore.8.html">xymond_filestore</A>(8)</I>

module (through an entry in the
<I><A HREF="../man5/tasks.cfg.5.html">tasks.cfg</A>(5)</I>

file) to create and store the HTML logs whenever a status update is
received. Setting &quot;XYMONLOGSTATUS=STATIC&quot; is <B>discouraged</B> since the
I/O load on the Xymon server will increase significantly.
<P>
<DT>PINGCOLUMN<DD>
Defines the name of the column for &quot;ping&quot; test status. The data from
the &quot;ping&quot; test is used internally by Xymon, so it must be defined
here so all of the Xymon tools know which column to watch for this 
data. The default setting is PINGCOLUMN=conn.
<P>
<DT>INFOCOLUMN<DD>
Defines the name of the column for the &quot;info&quot; pages.
<P>
<DT>TRENDSCOLUMN<DD>
Defines the name of the column for the RRD graph pages.
<P>
<DT>RRDHEIGHT<DD>
The default height (in pixels) of the RRD graph images.
Default: 120 pixels.
<P>
<DT>RRDWIDTH<DD>
The default width (in pixels) of the RRD graph images.
Default: 576 pixels.
<P>
<DT>RRDGRAPHOPTS<DD>
Extra options for the RRD graph command. These are passed directly to
the &quot;rrdgraph&quot; command used to generate graphs, see the
<I><A HREF="../man1/rrdgraph.1.html">rrdgraph</A>(1)</I>

man-page for details of the options.
<P>
<DT>TRENDSECONDS<DD>
The graphs on the &quot;trends&quot; page show data for the past TRENDSECONDS
seconds. Default: 172800 seconds, i.e. 48 hours.
<P>
<DT>HTMLCONTENTTYPE<DD>
The Content-type reported by the CGI scripts that generate web pages.
By default, this it &quot;text/html&quot;. If you have on-line help texts in
character sets other than the ISO-8859-1 (western european) character
set, it may be necessary to modify this to include a character set.
E.g.
<BR>

<BR>&nbsp;&nbsp;&nbsp;HTMLCONTENTTYPE=&quot;text/html;&nbsp;charset=euc-jp&quot;
<BR>

for a Japanese character sets. Note: Some webservers will automatically
add this, if configured to do so.
<P>
<DT>HOLIDAYS<DD>
Defines the default set of holidays used if there is no &quot;holidays&quot; 
tag for a host in the hosts.cfg file. Holiday sets are defined in the
<I><A HREF="../man5/holidays.cfg.5.html">holidays.cfg</A>(5)</I>

file. If not defined, only the default holidays (those defined outside
a named holiday set) will be considered as holidays.
<P>
<DT>WEEKSTART<DD>
Defines which day is the first day of the week. Set to &quot;0&quot; for Sunday,
&quot;1&quot; for Monday. Default: 1 (Monday).
<P>
<DT>XYMONBODYHEADER<DD>
Text that is included in the Xymon web pages at the location specified
by ~xymon/server/web/*_header templates. If this is set to a value
beginning with &quot;file:&quot;, then the contents of the specified file is
included. Default: &quot;file:$XYMONHOME/etc/xymonmenu.cfg&quot;
<P>
<DT>XYMONBODYFOOTER<DD>
Text that is included in the Xymon web pages at the location specified
by ~xymon/server/web/*_footer templates. If this is set to a value
beginning with &quot;file:&quot;, then the contents of the specified file is
included. Default: Empty.
<P>
<DT>XYMONBODYMENUCSS<DD>
URL for the Xymon menu CSS file. Default: &quot;$XYMONMENUSKIN/xymonmenu.css&quot;
<P>
<DT>HOSTPOPUP<DD>
Determines what is used as the host comment on the webpages. The comment 
by default appears as a pop-up when the mouse hovers over the hostname, 
and is also shown on the &quot;info&quot; status page. This setting must be one or
more of the letters &quot;C&quot; (COMMENT), &quot;D&quot; (DESCRIPTION) or &quot;I&quot; (IP-address).
Including &quot;C&quot; uses the COMMENT setting for the host, including &quot;D&quot; uses 
the DESCR setting for the host, and &quot;I&quot; uses the IP-address of the host.
If more than one of these is set, then COMMENT takes precedence over
DESCR which again has precence over IP.
Note that DESCR and IP only appear in pop-up windows (if enabled),
whereas the COMMENT is always used - if pop-up's have been disabled, then
the COMMENT value is displayed next to the hostname on the webpages.
Default: CDI
<P>
<DT>STATUSLIFETIME<DD>
The number of minutes that a status is considered valid after an update.
After this time elapses, the status will go purple.
Default: 30 minutes
<P>
<P>
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>DIRECTORIES</H2>

<P>
<DL COMPACT>
<DT>XYMONSERVERROOT<DD>
The top-level directory for the Xymon installation. The default 
is the home-directory for the user running Xymon.
<P>
<DT>XYMONSERVERLOGS<DD>
The directory for the Xymon's own logfiles (NOT the status-logs
from the monitored hosts).
<P>
<DT>XYMONHOME<DD>
The Xymon server directory, where programs and configurations are kept.
Default: $XYMONSERVERROOT/server/ .
<P>
<DT>XYMONTMP<DD>
Directory used for temporary files. Default: $XYMONHOME/tmp/
<P>
<DT>XYMONWWWDIR<DD>
Directory for Xymon webfiles. The $XYMONWEB URL must map to this directory.
Default: $XYMONHOME/www/
<P>
<DT>XYMONNOTESDIR<DD>
Directory for Xymon notes-files. The $XYMONNOTESSKIN URL must map to this directory.
Default: $XYMONHOME/www/notes/
<P>
<DT>XYMONREPDIR<DD>
Directory for Xymon availability reports. The $XYMONREPURL URL must map to this directory.
Note also that your webserver must have write-access to this directory, if you want to
use the 
<I><A HREF="../man1/report.cgi.1.html">report.cgi</A>(1)</I>

CGI script to generate reports on-demand. Default: $XYMONHOME/www/rep/
<P>
<DT>XYMONSNAPDIR<DD>
Directory for Xymon snapshots. The $XYMONSNAPURL URL must map to this directory.
Note also that your webserver must have write-access to this directory, if you want to
use the 
<I><A HREF="../man1/snapshot.cgi.1.html">snapshot.cgi</A>(1)</I>

CGI script to generate snapshots on-demand. Default: $XYMONHOME/www/snap/
<P>
<DT>XYMONVAR<DD>
Directory for all data stored about the monitored items. 
Default: $XYMONSERVERROOT/data/
<P>
<DT>XYMONRAWSTATUSDIR<DD>
Directory for storing the raw status-logs. Not used unless
&quot;xymond_filestore --status&quot; is running, which is <B>discouraged</B>
since it increases the load on the Xymon server significantly.
Default: $XYMONVAR/logs/
<P>
<DT>XYMONHTMLSTATUSDIR<DD>
Directory for storing HTML status-logs. Not used unless
&quot;xymond_filestore --status --html&quot; is running, which is <B>discouraged</B>
since it increases the load on the Xymon server significantly.
Default: $XYMONHOME/www/html/
<P>
<DT>XYMONHISTDIR<DD>
Directory for storing the history of monitored items.
Default: $XYMONVAR/hist/
<P>
<DT>XYMONHISTLOGS<DD>
Directory for storing the detailed status-log of historical events.
Default: $XYMONVAR/histlogs/
<P>
<DT>XYMONACKDIR<DD>
Directory for storing information about alerts that have been acknowledged.
Default: $XYMONVAR/acks/
<P>
<DT>XYMONDISABLEDDIR<DD>
Directory for storing information about tests that have been disabled.
Default: $XYMONVAR/disabled/
<P>
<DT>XYMONDATADIR<DD>
Directory for storing incoming &quot;data&quot; messages.
Default: $XYMONVAR/data/
<P>
<DT>XYMONRRDS<DD>
Top-level directory for storing RRD files (the databases with
trend-information used to generate graphs).
Default: $XYMONVAR/rrd/
<P>
<DT>CLIENTLOGS<DD>
Directory for storing the data sent by a Xymon client around the
time a status changes to a warning (yellow) or critical (red) state.
Used by the
<I><A HREF="../man8/xymond_hostdata.8.html">xymond_hostdata</A>(8)</I>

module.
Default: $XYMONVAR/hostdata/
<P>
<DT>XYMONCGILOGDIR<DD>
Directory where debug output from CGI applications are stored. If not
specified, it defaults to $XYMONSERVERLOGS, but this is often a directory
that is not writable by the userid running the CGI applications. It
is therefore recommended when using &quot;--debug&quot; on CGI applications that
you create a separate directory owned by the user running your webserver,
and point XYMONCGILOGDIR to this directory.
<P>
<P>
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>SYSTEM FILES</H2>

<P>
<DL COMPACT>
<DT>HOSTSCFG<DD>
Full path to the Xymon
<I><A HREF="../man5/hosts.cfg.5.html">hosts.cfg</A>(5)</I>

configuration file. Default: $XYMONHOME/etc/hosts.cfg.
<P>
<DT>XYMON<DD>
Full path to the 
<I><A HREF="../man1/xymon.1.html">xymon</A>(1)</I>

client program. Default: $XYMONHOME/bin/xymon.
<P>
<DT>XYMONGEN<DD>
Full path to the
<I><A HREF="../man1/xymongen.1.html">xymongen</A>(1)</I>

webpage generator program. Default: $XYMONHOME/bin/xymongen.
<P>
<P>
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>URLS</H2>

<DL COMPACT>
<DT>XYMONSERVERWWWURL<DD>
The root URL for the Xymon webpages, without the hostname. This
URL must be mapped to the ~/server/www/ directory in your webserver
configuration. See the sample Apache configuration in ~/server/etc/xymon-apache.conf.
<P>
<DT>XYMONSERVERCGIURL<DD>
The root URL for the Xymon CGI-scripts, without the hostname. This
directory must be mapped to the ~/cgi-bin/ directory in your webserver
configuration, and must be flagged as holding executable scripts. See
the sample Apache configuration in ~/server/etc/xymon-apache.conf.
<P>
<DT>XYMONWEBHOST<DD>
Initial part of the Xymon URL, including just the protocol and the
hostname, e.g. &quot;<A HREF="http://www.foo.com">http://www.foo.com</A>&quot;
<P>
<DT>XYMONWEBHOSTURL<DD>
Prefix for all of the static Xymon webpages, e.g. &quot;<A HREF="http://www.foo.com/xymon">http://www.foo.com/xymon</A>&quot;
<P>
<DT>XYMONWEBHTMLLOGS<DD>
URL prefix for the static HTML status-logs generated when XYMONLOGSTATUS=STATIC.
Note that this setting is <B>discouraged</B> so this setting should not be used.
<P>
<DT>XYMONWEB<DD>
URL prefix (without hostname) of the Xymon webpages. E.g. &quot;/xymon&quot;.
<P>
<DT>XYMONSKIN<DD>
URL prefix (without hostname) of the Xymon graphics. E.g. &quot;/xymon/gifs&quot;.
<P>
<DT>XYMONHELPSKIN<DD>
URL prefix (without hostname) of the Xymon on-line help files. E.g &quot;/xymon/help&quot;.
<P>
<DT>XYMONMENUSKIN<DD>
URL prefix (without hostname) of the Xymon menu files. E.g &quot;/xymon/menu&quot;.
<P>
<DT>XYMONNOTESSKIN<DD>
URL prefix (without hostname) of the Xymon on-line notes files. E.g &quot;/xymon/notes&quot;.
<P>
<DT>XYMONREPURL<DD>
URL prefix (without hostname) of the Xymon availability reports. E.g. &quot;/xymon/rep&quot;.
<P>
<DT>XYMONSNAPURL<DD>
URL prefix (without hostname) of the Xymon snapshots. E.g. &quot;/xymon/snap&quot;.
<P>
<DT>XYMONWAP<DD>
URL prefix (without hostname) of the Xymon WAP/WML files. E.g. &quot;/xymon/wml&quot;.
<P>
<DT>CGIBINURL<DD>
URL prefix (without hostname) of the Xymon CGI-scripts. Default: $XYMONSERVERCGIURL .
<P>
<DT>COLUMNDOCURL<DD>
Format string used to build a link to the documentation for a column heading.
Default: &quot;$CGIBINURL/columndoc.sh?%s&quot;, which causes links to use the
<I><A HREF="../man1/columndoc.sh.1.html">columndoc.sh</A>(1)</I>

script to document a column.
<P>
<DT>HOSTDOCURL<DD>
Format string used to build a link to the documentation for a host.
If not set, then Xymon falls back to scanning the XYMONNOTES directory
for files matching the hostname, or the hostname together with a common
filename extension (.php, .html, .doc and so on). If set, this string
becomes a formatting string for the documentation URL. E.g. for the host
&quot;myhost&quot;, a setting of HOSTDOCURL=&quot;/docs/%s.php&quot; will generate a link to
&quot;/docs/myhost.php&quot;.
Default: Not set, so host documentation will be retrieved from the
XYMONNOTES directory.
<P>
<P>
</DL>
<A NAME="lbAI">&nbsp;</A>
<H2>SETTINGS FOR SENDING MESSAGES TO XYMON</H2>

<DL COMPACT>
<DT>XYMSRV<DD>
The IP-address used to contact the
<I><A HREF="../man8/xymond.8.html">xymond</A>(8)</I>

service. Used by clients and the tools that perform network tests.
Default: $XYMONSERVERIP
<P>
<DT>XYMSERVERS<DD>
List of IP-addresses. Clients and network test tools will try to
send status reports to a Xymon server running on each of these
addresses. This setting is only used if XYMSRV=0.0.0.0.
<P>
<DT>XYMONDPORT<DD>
The portnumber for used to contact the
<I><A HREF="../man8/xymond.8.html">xymond</A>(8)</I>

service. Used by clients and the tools that perform network tests.
Default: 1984.
<P>
<DT>MAXMSGSPERCOMBO<DD>
The maximum number of status messages to combine into one
combo message.  Default: 100.
<P>
<DT>SLEEPBETWEENMSGS<DD>
Length of a pause introduced between each successive transmission
of a combo-message by xymonnet, in microseconds. Default: 0 
(send messages as quickly as possible).
<P>
<P>
</DL>
<A NAME="lbAJ">&nbsp;</A>
<H2>XYMOND SETTINGS</H2>

<P>
<DL COMPACT>
<DT>ALERTCOLORS<DD>
Comma-separated list of the colors that may trigger an alert-message.
The default is &quot;red,yellow,purple&quot;. Note that alerts may further be
generated or suppresed based on the configuration in the
<I><A HREF="../man5/alerts.cfg.5.html">alerts.cfg</A>(5)</I>

file.
<P>
<DT>OKCOLORS<DD>
Comma-separated list of the colors that may trigger a recovery-message.
The default is &quot;green,clear,blue&quot;.
<P>
<DT>ALERTREPEAT<DD>
How often alerts get repeated while a status is in an alert state.
This is the default setting, which may be changed in the 
<I><A HREF="../man5/alerts.cfg.5.html">alerts.cfg</A>(5)</I>

file.
<P>
<DT>MAXMSG_STATUS<DD>
The maximum size of a &quot;status&quot; message in kB, default: 256.
Status messages are the ones that end up as columns on the 
web display. The default size should be adequate in most
cases, but some extension scripts can generate very large
status messages - close to 1024 kB. You should only change
this if you see messages in the xymond log file about status
messages being truncated.
<P>
<DT>MAXMSG_CLIENT<DD>
The maximum size of a &quot;client&quot; message in kB, default: 512.
&quot;client&quot; messages are generated by the Xymon client, and often
include large process-listings. You should only change
this if you see messages in the xymond log file about client
messages being truncated.
<P>
<DT>MAXMSG_DATA<DD>
The maximum size of a &quot;data&quot; message in kB, default: 256.
&quot;data&quot; messages are typically used for client reports of
e.g. netstat or vmstat data. You should only change this
setting if you see messages in the xymond log file about
data messages being truncated.
<P>
<DT>MAXMSG_NOTES<DD>
The maximum size of a &quot;notes&quot; message in kB, default: 256.
&quot;notes&quot; messages provide a way for uploading documentation
about a host to Xymon; it is not enabled by default. If you 
want to upload large documents, you may need to change this
setting.
<P>
<DT>MAXMSG_STACHG<DD>
The maximum size of a &quot;status change&quot; message in kB, default: 
Current value of the MAXMSG_STATUS setting.  Status-change 
messages occur when a status changes color. There is no 
reason to change this setting.
<P>
<DT>MAXMSG_PAGE<DD>
The maximum size of a &quot;page&quot; message in kB, default: 
Current value of the MAXMSG_STATUS setting. &quot;page&quot; messages
are alerts, and include the status message that triggers the
alert. There is no reason to change this setting.
<P>
<DT>MAXMSG_ENADIS<DD>
The maximum size of an &quot;enadis&quot; message in kB, default: 32.
&quot;enadis&quot; are small messages used when enabling or disabling
hosts and tests, so the default size should be adequate.
<P>
<DT>MAXMSG_CLICHG<DD>
The maximum size of a &quot;client change&quot; message in kB, default: 
Current value of the MAXMSG_CLIENT setting.  Client-change 
messages occur when a status changes color to one of the
alert-colors, usually red, yellow and purple. There is no 
reason to change this setting.
<P>
<DT>MAXMSG_USER<DD>
The maximum size of a &quot;user&quot; message in kB, default: 128.
&quot;user&quot; messages are for communication between custom Xymon
modules you have installed, it is not used directly by
Xymon.
<P>
<P>
</DL>
<A NAME="lbAK">&nbsp;</A>
<H2>XYMOND_HISTORY SETTINGS</H2>

<P>
<DL COMPACT>
<DT>XYMONALLHISTLOG<DD>
If set to TRUE,
<I><A HREF="../man8/xymond_history.8.html">xymond_history</A>(8)</I>

will update the $XYMONHISTDIR/allevents file logging all changes to
a status. The allevents file is used by the
<I><A HREF="../man1/eventlog.cgi.1.html">eventlog.cgi</A>(1)</I>

tool to show the list of recent events on the &quot;All non-green&quot; 
webpage.
<P>
<DT>XYMONHOSTHISTLOG<DD>
If set to TRUE,
<I><A HREF="../man8/xymond_history.8.html">xymond_history</A>(8)</I>

will update the host-specific eventlog that keeps record
of all status changes for a host. This logfile is not used
by any Xymon tool.
<P>
<DT>SAVESTATUSLOG<DD>
If set to TRUE,
<I><A HREF="../man8/xymond_history.8.html">xymond_history</A>(8)</I>

will save historical detailed status-logs to the $XYMONHISTLOGS
directory.
<P>
<P>
</DL>
<A NAME="lbAL">&nbsp;</A>
<H2>XYMOND_ALERT SETTINGS</H2>

<P>
<DL COMPACT>
<DT>MAIL<DD>
Command used to send alerts via e-mail, including a &quot;Subject:&quot;
header in the mail. Default: &quot;mail -s&quot;
<P>
<DT>MAILC<DD>
Command used to send alerts via e-mail in a form that does not
have a &quot;Subject&quot; in the mail. Default: &quot;mail&quot;
<P>
<DT>SVCCODES<DD>
Maps status-columns to numeric service-codes. The numeric codes are
used when sending an alert using a script, where the numeric code of
the service is provided in the BBSVCNUM variable.
<P>
<P>
</DL>
<A NAME="lbAM">&nbsp;</A>
<H2>XYMOND_RRD SETTINGS</H2>

<P>
<DL COMPACT>
<DT>TEST2RRD<DD>
List of &quot;COLUMNNAME[=RRDSERVICE]&quot; settings, that define which
status- and data-messages have a corresponding RRD graph. You will 
normally not need to modify this, unless you have added a
custom TCP-based test to the protocols.cfg file, and want to collect data about
the response-time, OR if you are using the
<I><A HREF="../man8/xymond_rrd.8.html">xymond_rrd</A>(8)</I>

external script mechanism to collect data from custom tests. 
Note: All TCP tests are automatically added.
<P>
This is also used by the 
<I><A HREF="../man1/svcstatus.cgi.1.html">svcstatus.cgi</A>(1) </I>

script to determine if the detailed status view of a test should 
include a graph.
<P>
<DT>GRAPHS<DD>
List of the RRD databases, that should be shown as a graph on
the &quot;trends&quot; column.
<P>
<DT>NORRDDISKS<DD>
This is used to disable the tracking of certain filesystems. By default
all filesystems reported by a client are tracked. In some cases you may want 
to disable this for certain filesystems, e.g. database filesystems since they
are always completely full. This setting is a regular expression that is matched
against the filesystem name (the Unix mount-point, or the Windows disk-letter) -
if the filesystem name matches this expression, then it will not be tracked
by Xymon.
<BR>

Note: Setting this does not affect filesystems that are already being tracked
by Xymon - to remove them, you must remove the RRD files for the unwanted filesystems
from the ~xymon/data/rrd/HOSTNAME/ directory.
<P>
<DT>RRDDISKS<DD>
This is used to enable tracking of only selected filesystems (see the NORRDDISKS
setting above). By default all filesystems are being tracked, setting this changes 
that default so that only those filesystems that match this pattern will be 
tracked.
<P>
<P>
</DL>
<A NAME="lbAN">&nbsp;</A>
<H2>XYMONNET NETWORK TEST SETTINGS</H2>

<P>
<DL COMPACT>
<DT>XYMONNETWORK<DD>
If this variable is defined, then only the hosts that have been tagged
with &quot;NET:$XYMONNETWORK&quot; will be tested by the xymonnet tool.
<P>
<DT>CONNTEST<DD>
If set to TRUE, the connectivity (ping) test will be performed.
<P>
<DT>IPTEST_2_CLEAR_ON_FAILED_CONN<DD>
If set to TRUE, then failing network tests go CLEAR if the conn-test fails.
<P>
<DT>NONETPAGE<DD>
List of network services (separated with &lt;space&gt;) that should go yellow
upon failure instead of red.
<P>
<DT>XYMONROUTERTEXT<DD>
When using the &quot;router&quot; or &quot;depends&quot; tags for a host, a failure
status will include text that an &quot;Intermediate router is down&quot;.
With todays network topologies, the router could be a switch or
another network device; if you define this environment variable
the word &quot;router&quot; will be replaced with whatever you put into
the variable. So to inform the users that an intermediate switch
or router is down, use XYMONROUTERTEXT=&quot;switch or router&quot;.  This can 
also be set on a per-host basis using the &quot;DESCR:hosttype:description&quot;
tag in the 
<I><A HREF="../man5/hosts.cfg.5.html">hosts.cfg</A>(5)</I>

file.
<P>
<DT>NETFAILTEXT<DD>
When a network test fails, the status message reports &quot;SERVICENAME
not OK&quot;. The &quot;not OK&quot; message can be changed via this variable, e.g.
you can change it to &quot;FAILED&quot; or customize it as you like.
<P>
<DT>FPING<DD>
The command used to run the
<I><A HREF="../man1/xymonping.1.html">xymonping</A>(1)</I>

tool for the connectivity test. (The name FPING is due to the fact that
the &quot;fping&quot; utility was used until Xymon version 4.2). This may include 
suid-root wrappers and xymonping options.
Default: &quot;xymonping&quot;
<P>
<DT>TRACEROUTE<DD>
Defines the location of the &quot;traceroute&quot; tool and
any options needed to run it. traceroute it used by
the connectivity test when the ping test fails; if
requested via the &quot;trace&quot; tag, the TRACEROUTE command
is executed to try to determine the point in the
network that is causing the problem. By default the
command executed is &quot;traceroute -n -q 2 -w 2 -m 15&quot;
(no DNS lookup, max. 2 probes, wait 2 seconds per hop,
max 15 hops).
<P>
If you have the
<I><A HREF="../man8/mtr.8.html">mtr</A>(8)</I>

tool installed - available from <A HREF="http://www.bitwizard.nl/mtr/">http://www.bitwizard.nl/mtr/</A> - I
strongly recommend using this instead. The recommended
setting for mtr is &quot;/usr/sbin/mtr -c 2 -n --report&quot; (the
exact path to the mtr utility may be different on your 
system).  Note that mtr needs to be installed suid-root 
on most systems.
<P>
<DT>NTPDATE<DD>
Defines the 
<I><A HREF="../man1/ntpdate.1.html">ntpdate</A>(1)</I>

program used for the &quot;ntp&quot; test.  
Default: &quot;ntpdate&quot;
<P>
<DT>RPCINFO<DD>
Defines the
<I><A HREF="../man8/rpcinfo.8.html">rpcinfo</A>(8)</I>

program used for &quot;rpc&quot; tests.
Default: &quot;rpcinfo&quot;
<P>
<P>
</DL>
<A NAME="lbAO">&nbsp;</A>
<H2>XYMONGEN WEBPAGE GENERATOR SETTINGS</H2>

<P>
<DL COMPACT>
<DT>XYMONLOGO<DD>
HTML code that is inserted on all standard headers. The default is to add
the text &quot;Xymon&quot; in the upper-left corner of the page, but you can easily 
replace this with e.g. a company logo. If you do, I suggest that you keep 
it at about 30-35 pixels high, and 100-150 pixels wide.
<P>
<DT>XYMONPAGELOCAL<DD>
The string &quot;Pages hosted locally&quot; that appears above all of the pages
linked from the main Xymon webpage.
<P>
<DT>XYMONPAGESUBLOCAL<DD>
The string &quot;Subpages hosted locally&quot; that appears above all of the sub-pages
linked from pages below the main Xymon webpage.
<P>
<DT>XYMONPAGEREMOTE<DD>
The string &quot;Remote status display&quot; that appears about the summary
statuses displayed on the min Xymon webpage.
<P>
<DT>XYMONPAGETITLE<DD>
HTML tags designed to go in a &lt;FONT&gt; tag, to choose the font for 
titles of the webpages.
<P>
<DT>XYMONPAGEROWFONT<DD>
HTML tags designed to go in a &lt;FONT&gt; tag, to choose the font for 
row headings (hostnames) on the webpages.
<P>
<DT>XYMONPAGECOLFONT<DD>
HTML tags designed to go in a &lt;FONT&gt; tag, to chose the font for
column headings (test names) on the webpages.
<P>
<DT>XYMONPAGEACKFONT<DD>
HTML tags designed to go in a &lt;FONT&gt; tag, to chose the font for
the acknowledgement text displayed on the status-log HTML page
for an acknowledged status.
<P>
<DT>ACKUNTILMSG<DD>
When displaying the detailed status of an acknowledged test,
Xymon will include the time that the acknowledge expires
using the print-format defined in this setting. You can define
the timeformat using the controls in your systems
<I><A HREF="../man3/strftime.3.html">strftime</A>(3)</I>

routine, and add the text suitable for your setup.
<P>
<DT>XYMONDATEFORMAT<DD>
On webpages generated by xymongen, the default header includes
the current date and time. Normally this looks like &quot;Tue Aug 24
21:59:47 2004&quot;. The XYMONDATEFORMAT controls the format of this
timestamp - you can define the format using the controls in the 
<I><A HREF="../man3/strftime.3.html">strftime</A>(3)</I>

routine. E.g. to have it show up as &quot;2004-08-24 21:59:47 +0200&quot;
you would set XYMONDATEFORMAT=&quot;%Y-%m-%d %H:%M:%S %z&quot;
<P>
<DT>HOLIDAYFORMAT<DD>
How holiday dates are displayed. The default is &quot;%d/%m&quot; which
show the day and month. American users may want to change this 
to &quot;%m/%d&quot; to suit their preferred date-display style. This
is a formatting string for the system
<I><A HREF="../man3/strftime.3.html">strftime</A>(3)</I>

routine, so any controls available for this routine may be used.
<P>
<DT>XYMONPAGECOLREPEAT<DD>
Inspired by Jeff Stoner's col_repeat_patch.tgz patch, this defines
the maximum number of rows before repeating the column headings
on a webpage. This sets the default value for the 
<I><A HREF="../man1/xymongen.1.html">xymongen</A>(1)</I>

&quot;--maxrows&quot; option; if the command-line option is also specified,
then it overrides this environment variable. Note that unlike
Jeff's patch, xymongen implements this for both the &quot;All non-green&quot; 
page and all other pages (xymon.html, subpages, critical.html). 
<P>
<DT>SUMMARY_SET_BKG<DD>
If set to TRUE, then summaries will affect the color of the
main Xymon webpage. Default: FALSE.
<P>
<DT>DOTHEIGHT<DD>
The height (in pixels) of the icons showing the color of a status.
Default: 16, which matches the default icons.
<P>
<DT>DOTWIDTH<DD>
The width (in pixels) of the icons showing the color of a status.
Default: 16, which matches the default icons.
<P>
<DT>CLIENTSVCS<DD>
List of the status logs fed by data from the Xymon client. These
status logs will - if there are Xymon client data available for
the host - include a link to the raw data sent by the client.
Default: cpu,disk,memory,procs,svcs.
<P>
<DT>XYMONRSSTITLE<DD>
If defined, this is the title of the RSS/RDF documents generated when
<I><A HREF="../man1/xymongen.1.html">xymongen</A>(1)</I>

is invoked with the &quot;--rss&quot; option. The default value is &quot;Xymon Alerts&quot;.
<P>
<DT>WMLMAXCHARS<DD>
Maximum size of a WAP/WML output &quot;card&quot; when generating these.
Default: 1500.
<P>
<DT>XYMONNONGREENEXT<DD>
List of scripts to run as extensions to the &quot;All non-green&quot; page. Note that
two scripts, &quot;eventlog.sh&quot; and &quot;acklog.sh&quot; are handled specially:
They are handled internally by xymongen, but the script names must
be listed in this variable for this function to be enabled.
<P>
<DT>XYMONHISTEXT<DD>
List of scripts to run as extensions to a history page.
<P>
<DT>XYMONREPWARN<DD>
Default threshold for listing the availability as &quot;critical&quot; (red) when
generating the availability report. This can be set on a per-host basis
with the WARNPCT setting in
<I><A HREF="../man5/hosts.cfg.5.html">hosts.cfg</A>(5).</I>

Default: 97 (percent)
<P>
<DT>XYMONGENREPOPTS<DD>
Default xymongen options used for reports. This will typically include
such options as &quot;--subpagecolumns&quot;, and also &quot;--ignorecolumns&quot; if 
you wish to exclude certain tests from reports by default.
<P>
<DT>XYMONGENSNAPOPTS<DD>
Default xymongen options used by snapshots. This should be identical to
the options you normally used when building Xymon webpages.
<P>
</DL>
<A NAME="lbAP">&nbsp;</A>
<H2>FILES</H2>

<B>~xymon/server/etc/xymonserver.cfg</B>

<P>
<A NAME="lbAQ">&nbsp;</A>
<H2>SEE ALSO</H2>

<A HREF="../man7/xymon.7.html">xymon</A>(7)
<P>
<P>

<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT><A HREF="#lbAB">NAME</A><DD>
<DT><A HREF="#lbAC">DESCRIPTION</A><DD>
<DT><A HREF="#lbAD">ENVIRONMENT AREAS</A><DD>
<DT><A HREF="#lbAE">GENERAL SETTINGS</A><DD>
<DT><A HREF="#lbAF">DIRECTORIES</A><DD>
<DT><A HREF="#lbAG">SYSTEM FILES</A><DD>
<DT><A HREF="#lbAH">URLS</A><DD>
<DT><A HREF="#lbAI">SETTINGS FOR SENDING MESSAGES TO XYMON</A><DD>
<DT><A HREF="#lbAJ">XYMOND SETTINGS</A><DD>
<DT><A HREF="#lbAK">XYMOND_HISTORY SETTINGS</A><DD>
<DT><A HREF="#lbAL">XYMOND_ALERT SETTINGS</A><DD>
<DT><A HREF="#lbAM">XYMOND_RRD SETTINGS</A><DD>
<DT><A HREF="#lbAN">XYMONNET NETWORK TEST SETTINGS</A><DD>
<DT><A HREF="#lbAO">XYMONGEN WEBPAGE GENERATOR SETTINGS</A><DD>
<DT><A HREF="#lbAP">FILES</A><DD>
<DT><A HREF="#lbAQ">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 09:41:01 GMT, February 23, 2014
</BODY>
</HTML>