Nakivo Monitoring Plugins (Nagios / Icinga)

This repository provides a set of Bash-based monitoring plugins for Nakivo Backup & Replication, designed for use with Nagios, Icinga, and NRPE.

The plugins use the Nakivo CLI to retrieve system information and evaluate the health and status of key components.

Table of Contents

• Included Checks
• Requirements
• Installation
• NRPE Integration
• Usage
  • Repository Check
  • Jobs Check
  • Transporter Check
• Threshold Semantics
• Example Outputs
  • Repository Check
  • Jobs Check
  • Transporter Check
• Return Codes
• Notes and Limitations
• License

Included Checks

Requirements

• Nakivo Director with CLI available: /opt/nakivo/director/bin/cli.sh

• Linux system with:

  • bash
  • awk
  • grep
  • sed
  • tr

• Nagios / Icinga (or compatible monitoring system)

• NRPE (for remote execution)

Installation

1. Copy scripts to your plugins directory: /usr/lib/nagios/plugins/

2. Set executable permissions: chmod 755 check_nakivo*.sh

3. Create configuration file: /etc/nagios/nakivo.conf

Example:

NAKIVO_USER="monitoring_user"
NAKIVO_PASS="supersecret"
NAKIVO_HOST="localhost"
NAKIVO_PORT="4443"

4. Secure the configuration file: chmod 600 /etc/nagios/nakivo.conf

NRPE Integration

Example /etc/nagios/nrpe.cfg:

command[check_nakivoJobs]=/usr/lib/nagios/plugins/check_nakivoJobs.sh
command[check_nakivoRepoState]=/usr/lib/nagios/plugins/check_nakivoRepoState.sh $ARG1$
command[check_nakivoTransporter]=/usr/lib/nagios/plugins/check_nakivoTransporter.sh $ARG1$

(Arguments are passed by Icinga Check command)

Restart NRPE after changes

Usage

Repository Check

check_nakivoRepoState.sh  [--warn-reclaim ] [--crit-reclaim ] [--warn-free ]    [--crit-free ] [--warn-alloc ]   [--crit-alloc ]

Example:

check_nakivoRepoState.sh repository-01 --warn-free 8000 --crit-free 5000 --warn-reclaim 10000 --crit-reclaim 15000

Jobs Check

check_nakivoJobs.sh

Transporter Check

check_nakivoTransporterState.sh  [--warn-load ] [--crit-load ]

Example:

check_nakivoTransporterState.sh transporter-01 --warn-load 2 --crit-load 4

Threshold Semantics

Example:

--warn-free 8000 --crit-free 5000

• ≤ 8000 → WARNING
• ≤ 5000 → CRITICAL

Example Outputs

Repository Check

repository-01 [OK]: 12 backups, 9500.00 GB free, 12000.00 GB allocated, 2000.00 GB reclaimable | repository_01_backups=12;;;; repository_01_free_gb=9500.00;8000;5000;; repository_01_allocated_gb=12000.00;;; repository_01_reclaimable_gb=2000.00;10000;15000;;

Jobs Check

[OK]: ID 1 | Daily Backup | OK; ID 2 | Weekly Backup | OK

[WARNING]: ID 1 | Daily Backup | OK; ID 2 | Monthly Backup | PENDING

[CRITICAL]: ID 1 | Daily Backup | OK; ID 2 | Offsite Copy | CRITICAL

Transporter Check

[OK]: Transporter transporter-01 (192.168.1.10), load: 1/4, state: OK, status: Running | transporter_transporter_01_load=1;2;4;0;4

[WARNING]: Transporter transporter-01 (192.168.1.10), load: 3/4, state: OK, status: Running | transporter_transporter_01_load=3;2;4;0;4

[CRITICAL]: Transporter transporter-01 (192.168.1.10), load: 4/4, state: OK, status: Running | transporter_transporter_01_load=4;2;4;0;4

Return Codes

Notes and Limitations

• The plugins rely on Nakivo CLI output parsing. Changes in CLI output format may break parsing.
• No official API is used (Reason: Licensing)
• Each check follows a single responsibility principle.
• Credentials are passed via CLI and should be protected via file permissions.

License

MIT