check-unifi

Icinga 2 check plugin for UniFi Network Application

Icinga 2 check plugin for UniFi Network Application

Pylint

Table of Contents

  1. About
  2. License
  3. Support
  4. Requirements
  5. Installation
  6. Run
  7. Examples
  8. Screenshots

About

UniFi Network Application Build powerful home and enterprise networks with high-performance UniFi Switches, Gateways, and Wireless Access Points. Monitor client usage, set custom traffic rules, and much more.

This check plugin is written in Python and communicate with the REST-API of the controller. It allows you to check the following things:

  • Health state of the controller (Network Application)
  • Site health state and several stats

Additional features:

  • Performance data

License

Lincensed under the UNLICENSE, which is a license with no conditions whatsoever that dedicates works to the public domain.

Support

For bugs and feature requests please head over to the issue tracker.

Requirements

  • Python 3.x
  • requests Python library

Installation

pip install requests

Run

usage: check_unifi.py [--help] --host HOST [--port PORT] [--ssl] [--insecure]
                      [--mode MODE] [--site-id SITE_ID] [--user USER]
                      [--password PASSWORD] [--perfdata] [--timeout TIMEOUT]
                      [--version]

Check plugin for UniFi Network Application

options:
  --help, -h            Show this help message and quit
  --host HOST, -H HOST  Host name or IP address of the UniFi Controller
  --port PORT, -p PORT  The TCP port number, (default: 443)
  --ssl, -S             Use SSL for the connection
  --insecure, -k        Ingore ssl certificate errors (eg. self-sign cert)
  --mode MODE, -m MODE  Set the check mode: ["health", "stats"] (default:
                        health)
  --site-id SITE_ID     Site ID, (default: default)
  --user USER           Username to login
  --password PASSWORD   Password for user
  --perfdata            Enable performance data, (Default: false)
  --timeout TIMEOUT     Override the plugin timeout, (default: 10)
  --version, -v         Show version number and quit

Examples

Standard health check (no authorization for this endpoint needed)

# Example: ./check_unifi.py -H controller.fqdn.com --ssl
OK: Healthy - UniFi Network Application: v7.3.76

Screenshots

image image