HOBBITCLIENT.CFG(5) File Formats Manual HOBBITCLIENT.CFG(5)NAME
hobbitclient.cfg - Xymon client environment variables
DESCRIPTION
Xymon programs use multiple environment variables beside the normal set of variables. For the Xymon client, the environment definitions
are stored in the ~xymon/client/etc/hobbitclient.cfg file. Each line in this file is of the form NAME=VALUE and defines one environment
variable NAME with the value VALUE.
SETTINGS
BBDISP The IP-address used to contact the Xymon server. Default: Chosen when the Xymon client was compiled.
BBDISPLAYS
List of IP-adresses of Xymon servers. Data will be sent to all of the servers listed here. This setting is only used if
BBDISP=0.0.0.0.
BBPORT The portnumber for used to contact the Xymon server. Default: 1984.
BBHOME The Xymon client top-level directory. Default: The $HOBBITCLIENTHOME setting inherited from the "runclient.sh" script which starts
the Xymon client.
BBCLIENTLOGS
The directory for the Xymon clients' own logfiles. Default: $BBHOME/logs
BBTMP Directory used for temporary files. Default: $BBHOME/tmp/
BB Full path to the bb(1) client program. Default: $BBHOME/bin/bb.
Commands
Many extension scripts expect a series of environment variables to point at various system utilities. These are included in the file
when the client is built.
INHERITED SETTINGS
Some environment variables are inherited from the "runclient.sh" script which launches the Xymon client:
MACHINEDOTS
The hostname of the local system. Default: Taken from "uname -n".
MACHINE
The hostname of the local system, with dots replaced by commas. For compatibility with Big Brother extension scripts.
BBOSTYPE
The operating system of the local system, in lowercase. Default: taken from "uname -s".
HOBBITCLIENTHOME
The top-level directory for the Xymon client. Default: The location of the "runclient.sh" script.
SEE ALSO xymon(7)Xymon Version 4.2.3: 4 Feb 2009 HOBBITCLIENT.CFG(5)
Check Out this Related Man Page
HOBBITFETCH(8) System Manager's Manual HOBBITFETCH(8)NAME
hobbitfetch - fetch client data from passive clients
SYNOPSIS
hobbitfetch [--server=HOBBIT.SERVER.IP] [options]
DESCRIPTION
This utility is used to collect data from Xymon clients.
Normally, Xymon clients will themselves take care of sending all of their data directly to the Xymon server. In that case, you do not need
this utility at all. However, in some network setups clients may be prohibited from establishing a connection to an external server such as
the Xymon server, due to firewall policies. In such a setup you can configure the client to store all of the client data locally by
enabling the msgcache(8) utility on the client, and using hobbitfetch on the Xymon server to collect data from the clients.
hobbitfetch will only collect data from clients that have the pulldata tag listed in the bb-hosts(5) file. The IP-address listed in the bb-
hosts file must be correct, since this is the IP-address where hobbitfetch will attempt to contact the client. If the msgcache daemon is
running on a non-standard IP-address or portnumber, you can specify the portnumber as in pulldata=192.168.1.2:8084 for contacting the msg-
cache daemon using IP 192.168.1.2 port 8084. If the IP-address is omitted, the default IP in the bb-hosts file is used. If the port number
is omitted, the portnumber from the BBPORT setting in hobbitserver.cfg(5) is used (normally, this is port 1984).
OPTIONS --server=HOBBIT.SERVER.IP
Defines the IP address of the Xymon server where the collected client messages are forwarded to. By default, messages are sent to
the loopback address 127.0.0.1, i.e. to a Xymon server running on the same host as hobbitfetch.
--interval=N
Sets the interval (in seconds) between polls of a client. Default: 60 seconds.
--id=N Used when you have a setup with multiple Xymon servers. In that case, you must run hobbitfetch on each of the Xymon servers, with
hobbitfetch instance using a different value of N. This allows several Xymon servers to pick up data from the clients running msg-
cache, and msgcache can distinguish between which messages have already been forwarded to which server.
N is a number in the range 1-31.
--log-interval=N
Limit how often hobbitfetch will log problems with fetching data from a host, in seconds. Default: 900 seconds (15 minutes). This is
to prevent a host that is down or where msgcache has not been started from flooding the hobbitfetch logs. Note that this is ignored
when debugging is enabled.
--debug
Enable debugging output.
SEE ALSO msgcache(8), hobbitd(8), xymon(7)Xymon Version 4.2.3: 4 Feb 2009 HOBBITFETCH(8)