Nagios plugins for Box Backup

This package contains two plugins for checking the status of the 2 Box Backup Daemons:

• bbstored
• bbackupd

The Box Backup software is an OSS package that provides a way to securely backup data over a network connection to an (untrusted) server. Box Backup has a web site and a Wiki.

To Install

First, download the Tar-file. Untar it in a temporary directory.

Then, simply run the 'install.pl' script. It will try to find your Nagios Plugins directory, and copy the plugins there. The user running the script must have privileges to write to the Nagios Plugins directory.

The installer will attempt to find our if all required Perl Modules are installed. If a module is not there, it will ask your permission to install it. If you are not root, however, it will simply tell you to do it, since in most cases only root can install Perl modules.

Both plugins require the 'Sys::Hostname' module to be installed. If you do not have it installed (most people do), the installation script will attempt to install it for you.

The 'check_bbackupd' plugin additionally requires the Proc::ProcessTable module.

check_bbstored

The 'check_bbstored' plugin checks that the bbstored daemon is running on the backup server.

This plugin requires that the client executable 'bbackupquery' be installed on the Nagios server, and that a Box Backup account is created for the server. If the Nagios server is itself backed up by Box Backup, the backup account can be used. If you wish, You can create an account solely for the purpose of checking the status. When doing that, use the '-c' option, to ensure that you point to the correct configuration file. The plugin will then connect to the server, using the 'check' account.

It takes the following parameters:

check_bbstored -H <host> [-c <configPath>] [-p <execPath>] [-N -S <servicedescription> [-O <hostname>]] [-v]

-H, --hostname=HOST
   Name or IP address of host to check. This is for display only.
-c, --configpath=STRING
   Path to config file. Default is /etc/box/bbackupd.conf. If you prefer to have a
   separate Box Backup account do the monitoring, point the plugin at the config 
   file for that account.
-p, --execpath=STRING
   Path to the bbackupquery executable on the Nagios server.
   Default is /usr/local/bin/bbackupquery
-N, --nsca
   Format the output for submission to send_nsca.
-S, --servicedesc=SERVICEDESCRIPTION
   The service description as listed in the services.cfg file
   on the Nagios server.
-O, --naghostname
   The host name as defined in the hosts.cfg file on the 
   Nagios server.
-v, --verbose
   Print extra debugging information                                               
-h, --help
   Print the usage message and exit.

check_bbackupd

The 'check_bbackupd' plugin is a local check plugin, that will check that the bbackupd daemon is running on the local server. Use nrpe or nsca to run this check on remote servers.

The Proc::ProcessTable Perl Module is required, so if you don't have the package, please install it. The installer will attempt to find it, and if it can't, it will ask your permission to install it. If you are not root, however, it will simply tell you to do it, since in most cases only root can install Perl modules.

The plugin takes the following parameters

check_bbackupd [-p <pidfile>] [-N -S <servicedescription> [-O <hostname>]] [-v]

-p, --pidfile=PIDFILEPATH
   Full path to the PID file of the bbackupd daemon.
   Defaults to /var/run/bbackupd.pid
-N, --nsca
   Format the output for submission to send_nsca.
-S, --servicedesc=SERVICEDESCRIPTION
   The service description as listed in the services.cfg file
   on the Nagios server.
-O, --hostname
   The host name as defined in the hosts.cfg file on the 
   Nagios server.
-v, --verbose
   Print extra debugging information           
-h, --help
   Print the usage message and exit.     

For Help

If you're having trouble with the plugins, don't hesitate to let me know.

Email me at pthomsen@reedtz.com, and I'll try to get back to you as soon as I can.