Monitoring Symantec Backup Exec

From OpenNMS
Jump to navigation Jump to search
Tested for Versions
The instructions in this article have been tested against the following versions of OpenNMS.
Tested Against:
Version 1.12.8 tested by Fuhrmann

Introduction

Symantec Backup Exec is a long-established and widely-used backup software. There are two ways to get informed, if your Backup Exec has some problems and needs help.

Windows services

It is possible to monitor the Windows Backup Exec services. You can detect these services with Caps Daemon and Provision Daemon and monitor them with the Poller Daemon.

Detecting with CapsD

Warning.png Capsd is Deprecated

Capsd is deprecated in OpenNMS 1.12.x and will be removed in a future release. Provisiond now plays the role that Capsd once filled. If a helpful person tells you that your goal requires the use of Capsd, be skeptical.

First configure $OPENNMS_HOME/etc/capsd-configuration.xml to detect the services on your Symantec Backup Exec machines. The setup use the integrated Win32ServicePlugin:

  <!-- BackupExec Windows Services -->
  <protocol-plugin protocol="BE-Agent-Browser"
    class-name="org.opennms.netmgt.capsd.plugins.Win32ServicePlugin"
    scan="on" user-defined="false">
      <property key="timeout" value="2000" />
      <property key="retry" value="1" />
      <property key="service-name" value="Backup Exec Agent Browser" />
  </protocol-plugin>
  <protocol-plugin protocol="BE-Device-Media-Service"
    class-name="org.opennms.netmgt.capsd.plugins.Win32ServicePlugin"
    scan="on" user-defined="false">
      <property key="timeout" value="2000" />
      <property key="retry" value="1" />
      <property key="service-name" value="Backup Exec Device * Media Service" />
      </protocol-plugin>
  <protocol-plugin protocol="BE-Job-Engine"
    class-name="org.opennms.netmgt.capsd.plugins.Win32ServicePlugin"
    scan="on" user-defined="false">
      <property key="timeout" value="2000" />
      <property key="retry" value="1" />
      <property key="service-name" value="Backup Exec Job Engine" />
  </protocol-plugin>
  <protocol-plugin protocol="BE-Remote-Agent-for-Windows"
    class-name="org.opennms.netmgt.capsd.plugins.Win32ServicePlugin"
    scan="on" user-defined="false">
      <property key="timeout" value="2000" />
      <property key="retry" value="1" />
      <property key="service-name" value="Backup Exec Remote Agent for Windows Systems" />
  </protocol-plugin>
  <protocol-plugin protocol="BE-Server"
    class-name="org.opennms.netmgt.capsd.plugins.Win32ServicePlugin"
    scan="on" user-defined="false">
      <property key="timeout" value="2000" />
      <property key="retry" value="1" />
      <property key="service-name" value="Backup Exec Server" />
  </protocol-plugin>

Detecting with ProvisionD

<detector name="BE-Agent-Browser" class="org.opennms.netmgt.provision.detector.snmp.Win32ServiceDetector">
 <parameter key="retries" value="1"/>
 <parameter key="timeout" value="2000"/>
 <parameter key="win32ServiceName" value="Backup Excec Agent Browser"/>
</detector>
<detector name="BE-Device-Media-Service" class="org.opennms.netmgt.provision.detector.snmp.Win32ServiceDetector">
 <parameter key="retries" value="1"/>
 <parameter key="timeout" value="2000"/>
 <parameter key="win32ServiceName" value="Backup Excec Device * Media Service"/>
</detector>
<detector name="BE-Job-Engine" class="org.opennms.netmgt.provision.detector.snmp.Win32ServiceDetector">
 <parameter key="retries" value="1"/>
 <parameter key="timeout" value="2000"/>
 <parameter key="win32ServiceName" value="Backup Excec Job Engine"/>
</detector>
<detector name="BE-Remote-Agent-for-Windows" class="org.opennms.netmgt.provision.detector.snmp.Win32ServiceDetector">
 <parameter key="retries" value="1"/>
 <parameter key="timeout" value="2000"/>
 <parameter key="win32ServiceName" value="Backup Excec Remote Agent for Windows Systems"/>
</detector>
<detector name="BE-Server" class="org.opennms.netmgt.provision.detector.snmp.Win32ServiceDetector">
 <parameter key="retries" value="1"/>
 <parameter key="timeout" value="2000"/>
 <parameter key="win32ServiceName" value="Backup Server"/>
</detector>

Note.png Added detectors doesn't need a OpenNMS restart! Just synchronize your requisition

Monitoring the services

To monitor the service state add the following lines to your $OPENNMS_HOME/etc/poller-configuration.xml:

  <!-- BackupExec Windows Services -->
  <service name="BE-Agent-Browser" interval="300000" user-defined="false" status="on">
      <parameter key="retry" value="6"/>
      <parameter key="timeout" value="4950"/>
      <parameter key="port" value="161"/>
      <parameter key="service-name" value="Backup Exec Agent Browser"/>
  </service>
  <service name="BE-Device-Media-Service" interval="300000" user-defined="false" status="on">
      <parameter key="retry" value="6"/>
      <parameter key="timeout" value="4950"/>
      <parameter key="port" value="161"/>
      <parameter key="service-name" value="Backup Exec Device * Media Service"/>
  </service>
  <service name="BE-Job-Engine" interval="300000" user-defined="false" status="on">
      <parameter key="retry" value="6"/>
      <parameter key="timeout" value="4950"/>
      <parameter key="port" value="161"/>
      <parameter key="service-name" value="Backup Exec Job Engine"/>
  </service>
  <service name="BE-Remote-Agent-for-Windows" interval="300000" user-defined="false" status="on">
      <parameter key="retry" value="6"/>
      <parameter key="timeout" value="4950"/>
      <parameter key="port" value="161"/>
      <parameter key="service-name" value="Backup Exec Remote Agent for Windows Systems"/>
  </service>
  <service name="BE-Server" interval="300000" user-defined="false" status="on">
      <parameter key="retry" value="6"/>
      <parameter key="timeout" value="4950"/>
      <parameter key="port" value="161"/>
      <parameter key="service-name" value="Backup Exec Server"/>
  </service>

  <monitor service="BE-Agent-Browser" class-name="org.opennms.netmgt.poller.monitors.Win32ServiceMonitor"/>
  <monitor service="BE-Device-Media-Service" class-name="org.opennms.netmgt.poller.monitors.Win32ServiceMonitor"/>
  <monitor service="BE-Job-Engine" class-name="org.opennms.netmgt.poller.monitors.Win32ServiceMonitor"/>
  <monitor service="BE-Remote-Agent-for-Windows" class-name="org.opennms.netmgt.poller.monitors.Win32ServiceMonitor"/>
  <monitor service="BE-Server" class-name="org.opennms.netmgt.poller.monitors.Win32ServiceMonitor"/>

Change your timeouts and retry settings to your needs, I have some heavy load machines and on with higher timeouts and more retries I have a lot less 30 second outages.

Note.png The Poller daemon needs a restart to apply the configuration change!

Events

Per default OpenNMS is able to translate the following SNMP traps:

uei.opennms.org/vendor/BackupExec/traps/beNTLoaded
uei.opennms.org/vendor/BackupExec/traps/beNTUnloaded
uei.opennms.org/vendor/BackupExec/traps/jobFailure
uei.opennms.org/vendor/BackupExec/traps/jobAborted
uei.opennms.org/vendor/BackupExec/traps/jobSuccess
uei.opennms.org/vendor/BackupExec/traps/jobSuccessExcept
uei.opennms.org/vendor/BackupExec/traps/jobStarted
uei.opennms.org/vendor/BackupExec/traps/multipleTapesNeeded
uei.opennms.org/vendor/BackupExec/traps/retriedAutomatically
uei.opennms.org/vendor/BackupExec/traps/copyDRFile
uei.opennms.org/vendor/BackupExec/traps/fullBackupComplete
uei.opennms.org/vendor/BackupExec/traps/ofoFailed
uei.opennms.org/vendor/BackupExec/traps/ofoCouldNotInit
uei.opennms.org/vendor/BackupExec/traps/loaderNeedsAttention
uei.opennms.org/vendor/BackupExec/traps/driveNeedsAttention

To activate them follow the official documentation provided by Symantec.


Definitions

OpenNMS provides out of the box all Symantec Backup Exec 10 trap definitions. So there is no need to customize your configuration.

Notifications

To get notified if Backup Exec sends traps to your OpenNMS you can use the following notification examples. Just copy them into $OPENNMS_HOME/etc/notifications.xml.

<notification name="TRAP - BackupExec-beNTLoaded" status="on" writeable="yes">
  <uei>uei.opennms.org/vendor/BackupExec/traps/beNTLoaded</uei>
  <rule>(IPADDR IPLIKE *.*.*.*)</rule>
  <destinationPath>email-admin</destinationPath>
  <text-message>%descr%</text-message>
  <subject>#%noticeid%: The application has started on %nodelabel%.</subject>
  <numeric-message>%logmsg%</numeric-message>
</notification>
<notification name="TRAP - BackupExec-beNTUnLoaded" status="on" writeable="yes">
  <uei>uei.opennms.org/vendor/BackupExec/traps/beNTUnloaded</uei>
  <rule>(IPADDR IPLIKE *.*.*.*)</rule>
  <destinationPath>email-admin</destinationPath>
  <text-message>%descr%</text-message>
  <subject>#%noticeid%: The application has stopped on %nodelabel%.</subject>
  <numeric-message>%logmsg%</numeric-message>
</notification>
<notification name="TRAP - BackupExec-jobFailure" status="on" writeable="yes">
  <uei>uei.opennms.org/vendor/BackupExec/traps/jobFailure</uei>
  <rule>(IPADDR IPLIKE *.*.*.*)</rule>
  <destinationPath>email-admin</destinationPath>
  <text-message>%descr%</text-message>
  <subject>#%noticeid%: Job failed on %nodelabel%.</subject>
  <numeric-message>%logmsg%</numeric-message>
</notification>
<notification name="TRAP - BackupExec-jobAborted" status="on" writeable="yes">
  <uei>uei.opennms.org/vendor/BackupExec/traps/jobAborted</uei>
  <rule>(IPADDR IPLIKE *.*.*.*)</rule>
  <destinationPath>email-admin</destinationPath>
  <text-message>%descr%</text-message>
  <subject>#%noticeid%: Job aborted on %nodelabel%.</subject>
  <numeric-message>%logmsg%</numeric-message>
</notification>
<notification name="TRAP - BackupExec-jobSuccess" status="on" writeable="yes">
  <uei>uei.opennms.org/vendor/BackupExec/traps/jobSuccess</uei>
  <rule>(IPADDR IPLIKE *.*.*.*)</rule>
  <destinationPath>email-admin</destinationPath>
  <text-message>%descr%</text-message>
  <subject>#%noticeid%: Job succeeded on %nodelabel%.</subject>
  <numeric-message>%logmsg%</numeric-message>
</notification>
<notification name="TRAP - BackupExec-jobSuccessExcept" status="on" writeable="yes">
  <uei>uei.opennms.org/vendor/BackupExec/traps/jobSuccessExcept</uei>
  <rule>(IPADDR IPLIKE *.*.*.*)</rule>
  <destinationPath>email-admin</destinationPath>
  <text-message>%descr%</text-message>
  <subject>#%noticeid%: Job succeeded with exceptions on %nodelabel%.</subject>
  <numeric-message>%logmsg%</numeric-message>
</notification>
<notification name="TRAP - BackupExec-jobStarted" status="on" writeable="yes">
  <uei>uei.opennms.org/vendor/BackupExec/traps/jobStarted</uei>
  <rule>(IPADDR IPLIKE *.*.*.*)</rule>
  <destinationPath>email-admin</destinationPath>
  <text-message>%descr%</text-message>
  <subject>#%noticeid%: Job started on %nodelabel%.</subject>
  <numeric-message>%logmsg%</numeric-message>
</notification>
<notification name="TRAP - BackupExec-multipleTapesNeeded" status="on" writeable="yes">
  <uei>uei.opennms.org/vendor/BackupExec/traps/multipleTapesNeeded</uei>
  <rule>(IPADDR IPLIKE *.*.*.*)</rule>
  <destinationPath>email-admin</destinationPath>
  <text-message>%descr%</text-message>
  <subject>#%noticeid%: Multiple tapes needed on %nodelabel%.</subject>
  <numeric-message>%logmsg%</numeric-message>
</notification>
<notification name="TRAP - BackupExec-retriedAutomatically" status="on" writeable="yes">
  <uei>uei.opennms.org/vendor/BackupExec/traps/retriedAutomatically</uei>
  <rule>(IPADDR IPLIKE *.*.*.*)</rule>
  <destinationPath>email-admin</destinationPath>
  <text-message>%descr%</text-message>
  <subject>#%noticeid%: failed Low Administration Backup on %nodelabel%.</subject>
  <numeric-message>%logmsg%</numeric-message>
</notification>
<notification name="TRAP - BackupExec-copyDRFile" status="on" writeable="yes">
  <uei>uei.opennms.org/vendor/BackupExec/traps/copyDRFile</uei>
  <rule>(IPADDR IPLIKE *.*.*.*)</rule>
  <destinationPath>email-admin</destinationPath>
  <text-message>%descr%</text-message>
  <subject>#%noticeid%: Disaster Recovery is not complete on %nodelabel%.</subject>
  <numeric-message>%logmsg%</numeric-message>
</notification>
<notification name="TRAP - BackupExec-fullBackupComplete" status="on" writeable="yes">
  <uei>uei.opennms.org/vendor/BackupExec/traps/fullBackupComplete</uei>
  <rule>(IPADDR IPLIKE *.*.*.*)</rule>
  <destinationPath>email-admin</destinationPath>
  <text-message>%descr%</text-message>
  <subject>#%noticeid%: Disaster Recovery completed on %nodelabel%.</subject>
  <numeric-message>%logmsg%</numeric-message>
</notification>
<notification name="TRAP - BackupExec-ofoFailed" status="on" writeable="yes">
  <uei>uei.opennms.org/vendor/BackupExec/traps/ofoFailed</uei>
  <rule>(IPADDR IPLIKE *.*.*.*)</rule>
  <destinationPath>email-admin</destinationPath>
  <text-message>%descr%</text-message>
  <subject>#%noticeid%: Open File Option failed on %nodelabel%.</subject>
  <numeric-message>%logmsg%</numeric-message>
</notification>
<notification name="TRAP - BackupExec-ofoCouldNotInit" status="on" writeable="yes">
  <uei>uei.opennms.org/vendor/BackupExec/traps/ofoCouldNotInit</uei>
  <rule>(IPADDR IPLIKE *.*.*.*)</rule>
  <destinationPath>email-admin</destinationPath>
  <text-message>%descr%</text-message>
  <subject>#%noticeid%: Open File Option wasn't initialized on %nodelabel%.</subject>
  <numeric-message>%logmsg%</numeric-message>
</notification>
<notification name="TRAP - BackupExec-LoaderNeedsAttention" status="on" writeable="yes">
  <uei>uei.opennms.org/vendor/BackupExec/traps/loaderNeedsAttention</uei>
  <rule>(IPADDR IPLIKE *.*.*.*)</rule>
  <destinationPath>email-admin</destinationPath>
  <text-message>%descr%</text-message>
  <subject>#%noticeid%: Loader needs attention on %nodelabel%.</subject>
  <numeric-message>%logmsg%</numeric-message>
</notification>
<notification name="TRAP - BackupExec-DriveNeedsAttention" status="on" writeable="yes">
  <uei>uei.opennms.org/vendor/BackupExec/traps/driveNeedsAttention</uei>
  <rule>(IPADDR IPLIKE *.*.*.*)</rule>
  <destinationPath>email-admin</destinationPath>
  <text-message>%descr%</text-message>
  <subject>#%noticeid%: Drive needs attention on %nodelabel%.</subject>
  <numeric-message>%logmsg%</numeric-message>
</notification>