Script Hooks: Integrating Retrospect with Nagios

Hooks

Overview

Nagios is an open source system for monitoring servers, switches, applications and other services. With Script Hooks, you can now monitor Retrospect from Nagios as well. The Windows example script uses Perl and the open source Perl send_nrdp plugin, which you can download from here:

https://exchange.nagios.org/directory/Addons/Passive-Checks/send_nrdp-Perl-Client/details

You will also need a Nagios NRDP server set up.

Installing the Retrospect event handler (retroEventHandler)

Download the example Retrospect script hooks from our website.

For Mac, copy the file "RetroEventHandler.sh" from the Nagios folder to

/Library/Application Support/Retrospect

For Windows, copy the file "RetroEventHandler.vbs" from the Nagios folder to

C:\ProgramData\Retrospect\

In either case, edit the file in your favorite text editor. Find the section:

REM The following settings tells the NRDP client

REM how to communicate with the NRDP notification servder.

set NAGIOS_NRDP_SERVER=

set NAGIOS_URL=

set NAGIOS_TOKEN=

set NAGIOS_HTTP_USER=

set NAGIOS_HTTP_PASSWD=

Description of the required Nagios fields:

NAGIOS_NRDP_SERVER - IP address or host name of the NRDP server Retrospect will notify.
NAGIOS_URL - URL of NRDP server. Usually of the form http://<IP_ADDRESS>/nrdp/.
NAGIOS_TOKEN - Shared token. Must be the same token set in NRDP Server.
NAGIOS_HTTP_USER - Optional user name if using HTTP authentication.
NAGIOS_HTTP_PASSWD - Optional password if using HTTP authentication.

Note, the Perl send_nrdp plugin does not currently support SSL.

Additionally, there is a section below this which can be used to alter the Retrospect host and service name used in the notification:

set RETROSPECT_HOSTNAME=My Retrospect IP address

set RETROSPECT_SERVICE_NAME=Retrospect

Once you have entered the information, save the file. You are now done. You do not need to restart the Retrospect engine or application for it to start using the script.

Testing

To test, run a short backup.

Troubleshooting

If you do not get any notifications, confirm the information in the sections listed. You can also test just the script by opening up a cmd window, and cd’ing to the eventhandler folder. Then type:

retroEventHandler EndScript "Daily Backup" "7" "-530" "backup client not found"

If there are any errors, they should display in the cmd window and point you toward a solution.

Last Update: January 27, 2017