From 6813a7c3080f7a73b8b25cf5a989c0d251d2e524 Mon Sep 17 00:00:00 2001 From: Thorsten Spille Date: Fri, 11 Nov 2022 20:57:41 +0100 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 148c966..4ec03a2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # check-unifi-controller Checkmk special agent for checking unifi controller + +### Usage: +Login into your checkmk instnace user on your checkmk server (e.g. via SSH). +Download and install the checkmk agent: +~~~ +wget https://github.com/bashclub/check-unifi-controller/releases/download/v0.87/unifi_controller-0.87.mkp +mkp install ./unifi_controller-0.87.mkp +~~~ + +### Configure Agent +Login into your checkmk website and go to "Setup" -> "Agents" -> "Other integrations" (Datasource programs). Under the category "Hardware" click on "Unifi Controller via API" and create a new rule. +Fill in the credentials of your Unifi controller, set the HTTPS Port, define the site name (if other than default), check "Ignore certificate validation" if using a self signed certificate, select Hostname or IP for storing piggyback data. +Under "Conditions" assign an "Explicit host" with your Unifi Controller Machine. +The agent will carry piggyback data for switches and access points and you can create new hosts to monitor, where piggyback data will be assignesd on exact match (IP or hostname).