How to Integrate MultiTech MTR API with Nagios XI

Picture of Ayoub Louragli
Ayoub Louragli
MultiTech MTR API with Nagios XI

Nagios XI is a robust network monitoring system that can be extended with various integrations to enhance its functionality. One such integration is with MultiTech’s MultiConnect® rCell Series Router (MTR) API, allowing administrators to send SMS notifications directly from Nagios XI.

This guide will walk you through the process of integrating the MultiTech MTR API with Nagios XI, covering configuration, installation, and enabling SMS alerts for users.

Prerequisites

Before proceeding with the integration, ensure you have the following:

  • Nagios XI (version 5.5 or newer) installed and running.
  • MultiConnect rCell Series Router from MultiTech.
  • Administrator access to both Nagios XI and the MultiTech MTR device.
  • Network access between the Nagios XI server and the MTR device.

Step 1: Configure MultiTech MTR

Picture4
MTR

Enable HTTPS Access

Nagios XI communicates with the MultiTech MTR device via HTTPS (port 443 by default). Ensure this is enabled in the router settings:

  1. Login to the MTR device.
  2. Navigate to Administration > Access Configuration > Web Server > HTTPS.
  3. Ensure the port is set to 443 (or another preferred port).

Enable SMS Functionality

For SMS alerts to work, ensure that SMS functionality is enabled on the MTR device:

  1. Go to SMS > SMS Configuration > SMS Settings.
  2. Enable SMS messaging if it is not already active.

Create a Dedicated User for Nagios XI

To avoid authentication conflicts, create an administrator account specifically for Nagios XI:

  1. Navigate to Administration > User Accounts.
  2. Create a new user account for Nagios XI.

Step 2: Install the MTR Component in Nagios XI

To integrate MultiTech MTR API with Nagios XI, you need to install the Nagios XI MTR Component:

  1. Download the MTR component:
  2. Login to Nagios XI as an administrator.
  3. Navigate to Admin > System Extensions > Manage Components.
  4. Upload the mtr.zip file.

Step 3: Configure the MTR Component in Nagios XI

Once the component is installed, configure it as follows:

  1. Navigate to Admin > System Extensions > Manage Components.
  2. Locate the MultiTech MTR Component and click the settings icon.
  3. On the MultiTech MTR Integration screen, configure the following:
    • Enable Integration: Check this box.
    • IP Address or Hostname: Enter the IP address or domain of the MTR device.
    • HTTPS Port: Ensure this matches the MTR configuration (default 443).
    • Username and Password: Enter the credentials for the dedicated Nagios XI user.
  4. Click Apply Settings to save the configuration.
Picture5
Component configuration

Step 4: Enable SMS Alerts for Users

Each user in Nagios XI who wants to receive SMS notifications must enable them manually:

  1. Navigate to User Account Settings.
  2. Select Notification Methods and click the MTR tab.
  3. Check the SMS Text Message option.
  4. Enter the mobile phone number where alerts should be sent.
  5. Click Update Settings to enable SMS notifications.

Step 5: Customize SMS Alert Messages

Nagios XI allows users to customize SMS alerts using notification macros:

  1. Navigate to User Account Settings.
  2. Click on Notification Messages and go to the MTR tab.
  3. Customize the format for host and service alerts using macros.
  4. Save the changes.

For more details on macros, refer to:
Understanding Nagios XI Notification Variables

Conclusion

Integrating MultiTech MTR API with Nagios XI allows administrators to send SMS alerts directly from Nagios XI, enhancing real-time monitoring and response capabilities. By following the steps outlined above, you can successfully configure and enable this integration.

For additional support, visit:

Share: