Download details

check_unifi check_unifi.php Beliebt

Download
featured_red_star
Informationen
Erstelldatum 22.12.2020
Änderungsdatum 10.08.2022
Version 1.20220810
Dateigröße 38.07 KB
Downloads 2.119
Lizenz MIT Lizenz external
Preis Donate PayPal

 

Nagios Plugin to check a Unifi Controller (Accesspoints and Switches).

API Version 1.1.79
You need to install php-curl

Thanks to https://github.com/Art-of-WiFi 
 
Note:

Support for UniFi OS-based controllers (UniFi Dream Machine Pro or Cloud Key Gen2/Cloud Key Gen2 Plus with firmware version 2.0.24 or higher) has been added as of API version 1.1.47. The class automatically detects UniFi OS devices and adjusts URLs and several functions/methods accordingly. If your own code applies strict validation of the URL that is passed to the constructor, please adapt your logic to allow URLs without a port suffix when dealing with a UniFi OS-based controller.

 In case of my script use -P 443 and -s 

If you find a bug or have a request, write me.

/usr/bin/php ./check_unifi.php -H 192.168.2.213 -P 8443 -u nagios -p nagios -s -m uplink -a AP02 -w 200 -c 100
OK - Uplink: AP01 - signal=-67%  tx_rate=234 Mbps  rx_rate=526.5 Mbps | tx_rate=234;rx_rate=526.5;signal=67
 
/usr/bin/php ./check_unifi.php -H 192.168.2.213 -P 8443 -u nagios -p nagios -s -m cpu AP02 -w 80 -c 90
OK - 10.4% (load average: 0.01, 0.05, 0.05) | load=0.01;;;; load5=0.05;;;; load15=0.05;;;;
 
/usr/bin/php ./check_unifi.php -H 192.168.2.213 -P 8443 -u nagios -p nagios -s -m ap -w 0 -c 1
OK - AP [unifi.jhoerter.com]: 3 (Online: 3, Offline: 0) | AP=3 Online=3 Offline=0;0;1;;
 
/usr/bin/php ./check_unifi.php -H 192.168.2.213 -P 8443 -u nagios -p nagios -s  -m switch -c 0
OK - Switch [unifi.jhoerter.com]: 1 (Online: 1 / Offline: 0) | Switch=1 Online=1 Offline=0;0;0;;
 
/usr/bin/php ./check_unifi.php -H 192.168.2.213 -P 8443 -u nagios -p nagios -s  -m uplink -a AP01
OK - Uplink SWITCH01 (wire) - speed=1000 Mbps | speed=1000
 
/usr/bin/php ./check_unifi.php -C -m mem -a AP03 -w 80 -c 90
OK - 54.09 MB | Total=122.66MB;98.13;110.39;0;122.66 Used=54.09MB;;;; Free=40.37MB;;;; Caches=28.20MB;;;;
 
/usr/bin/php ./check_unifi.php -C -m mem% -a AP03 -w 80 -c 90
OK - 44.10% (54.09 MB) | Total=100%;80;90;0;100 Used=44.10%;;;; Free=32.91%;;;; Caches=22.99%;;;;
 
/usr/bin/php ./check_unifi.php -C -a AP01 -m clients_name_guest
OK - Clients [unifi.jhoerter.com]: 5/User:5/Guest:0 (2GHz: 2/U:2/G:0, 5GHz: 3/U:3/G:0) MACBOOK(5) VIRTUAL-WLAN(5) CAM01(2) TABLETT04(5) PRS01(2) | Clients=5;;;; 2GHz=2 5GHz=3
 
/usr/bin/php ./check_unifi.php -C -a AP01 -m channels
OK - 2GHz: auto (11(13,-1)) HT40 - 5GHz: auto (58(64,-1)) VHT80| 2GHz=11 5GHz=58
 
/usr/bin/php ./check_unifi.php -C -a AP01 -m transfer
OK - RX: 5,09 Mbit - TX: 166,84 Kbit | RX=5215,38Kbit;;;; TX=166,84Kbit;;;;
 
/usr/bin/php ./check_unifi.php -C -a AP01 -m experience -w 30 -c 20
OK - WIFI Experience: 99% | Experience=99%;30;20;;
 
/usr/bin/php ./check_unifi.php -C -a JHSAP01 -m utilisation -w 75,75 -c 85,85
OK - 2GHz Utilized: 11% (RX Frames: 9%, TX Frames: 1%, Interference: 1%) - 5GHz Utilized: 8% (RX Frames: 6%, TX Frames: 2%, Interference: 0%)| 2GHz=11;75;85;; RX=9;;;; TX=1;;;; Interference=1 5GHz=8;75;85;; RX=6;;;; TX=2;;;; Interference=0
 
/usr/bin/php  ./check_unifi.php -C -a AP01 -m linux_cpu -w 75 -c 85
OK - 10.2% | cpu=10.2%;75;85;0;100
 
/usr/bin/php  ./check_unifi.php -C -a AP01 -m linux_load -w 0.5,0.5,0.5 -c 1,1,1
OK - load average: 0.22, 0.08, 0.07 | load=0.22;0.5;1;; load5=0.08;0.5;1;; load15=0.07;0.5;1;;
 
/usr/bin/php ./check_unifi.php -C -m update -a AP02 -w 1,1,1 -c 1,5,10
CRITICAL - firmware upgradable from version 4.3.28.11361 to 5.43.30.12622
 
/usr/bin/php ./check_unifi.php -C -m site
---------+------------------------------------
Site ID  | Site Name
---------+------------------------------------
default  | unifi.jhoerter.com
a1uobpaz | Test
 
/usr/bin/php ./check_unifi.php -H 192.168.2.213 -P 8443 -s -u nagios -p nagios -S default -m uptime -a AP01
OK - UniFi AP-AC-Lite [unifi.jhoerter.com] - 0 days, 3 hours, 44 mins.| Uptime=13445
 
/usr/bin/php ./check_unifi.php -C -m client_transfer+ -a PC05 -r 0
OK - RX: 2.743 KB/s - TX: 16.066 KB/s (AP: AP03) | RX=2.743KByte;;;; TX=16.066KByte;;;;
 
/usr/bin/php ./check_unifi.php -C -m client_uplink -a MACBOOK
OK - Uplink: JHSAP01 (JH/ 5GHz) - signal: -78% TX: 650 Mbps RX: 260 Mbps | TX=650;0;0;; RX=260;0;0;; Signal=78
 
/usr/bin/php ./check_unifi.php -C -m client_uptime -a PHONE04
OK - 0 days, 0 hours, 18 mins.| Uptime=1124
 
/usr/bin/php ./check_unifi.php -C -m clients_count_guest
OK - Clients [unifi.jhoerter.com]: 13/ User:11/ Guest:2 (2GHz: 8/U:8/G:0, 5GHz: 5/U:3/G:2) | Clients=13;;;; 2GHz=8;;;; 5GHz=5;;;; User=11;;;; 2GhzU=8;;;; 5GhzU=3;;;; Guest=0;;;; 2GhzG=0;;;; 5GhzG=2;;;;
 
/usr/bin/php ./check_unifi.php -C -m clients_all
OK - Clients [unifi.jhoerter.com]: 32 (Wired: 21, Wifi: 11) | Clients=32;;;; Wired=21;;;; Wifi=11;;;;
 
/usr/bin/php ./check_unifi.php -C -m ap_unifi_name -w 0 -c 1
WARNING - AP: 4 (Online: 3, Offline: 1 (AP03-OLD)) | AP=4 Online=3 Offline=1;0;1;;
  
/usr/bin/php ./check_unifi.php -C -m clients_count_ssid -a WLAN
OK - SSID WLAN Client: 12 (2GHz: 7, 5GHz: 5) | Clients=12;;;; 2GHz=7 5GHz=5
 
/usr/bin/php ./check_unifi.php -C -m clients_wifi
OK - WiFi [default]: 13 (WiFi6=1, WiFi5=3, WiFi4=8) | WiFi=13;;;; WiFi6=1 Wifi5=3 WiFi4=8
 
/usr/bin/php ./check_unifi.php -C -m ap_unifi_name -w 0 -c 1 -a AP02-OLD,AP03-OLD
WARNING - AP: 3 (Online: 3, Offline: 0 | AP=3 Online=3 Offline=1;0;1;;
 
/usr/bin/php ./check_unifi.php -C -a PHONE01 -m client_experience -w 30 -c 20
OK - WIFI Experience: 99% | Experience=99%;30;20;;
 
/usr/bin/php ./check_unifi.php -C -m udm_temperature -a DREAMMACHINE -w 55,50,55 -c 60,60,60
WARNING - Temperature (CPU: 53 °C , Local: 50.75 °C , PHY: 53 °C) | CPU=53;55;60;; Local=50.75;50;60;; PHY=53;55;60;;
 
/usr/bin/php ./check_unifi.php -C -m lte -a LTEPRO
OK - LTE eutran-20 [o2 - de+] | connected=1
 
/usr/bin/php ./check_unifi.php -C -m lte_uplink -a LTEPRO -w -90,-15,-100 -c -100,-20,-110
CRITICAL - LTE-Uplink - RSSI: -80 dBm, RSRQ: -12 db, RSRP: -113dBm | RSSI=-80;-90;-100;; RSRQ=-12;-15;-20;; RSRP=-113;-100;-110;;
 
/usr/bin/php ./check_unifi.php -C -m lte_failover -a LTEPRO
OK - mode failover: off | failover=1
 
/usr/bin/php ./check_unifi.php -C -m alarms_count
OK - no active Alarms (Archiv: 403) | Alarms=0;;;;
 
/usr/bin/php ./check_unifi.php -C -m clients_ssid -r 1 -i 
WARNING - SSID Clients [unifi.jhoerter.com] - JH: 8, GUEST(G): enabled, CAM: 2 | Total=10 JH=8 GUEST=0 CAM=2
 
/usr/bin/php ./check_unifi.php -C -m switch_transfer+ -a SWITCH01 -n 3
OK - Port 3: NAS-LAN (1000 Mbit/s) - rx: 71.446 KB/s - tx: 2.301 MB/s | rx=71.446KB;;;; tx=2356.719KB;;;;
 
 
 
Usage:

Usage: /usr/bin/php check_unifi.php -H [controller] -u [controlleruser] -p [controllerpassword] -P [controllerport] -m [mode] -a [Accesspoint/Switch/Client/SSID] -w [Warning] -c [Critical] ( -S [site] -s =https -C [configfile] -r [nagios result] -i =invers nagios result -d =debug)

 
nag

controller 
= Controller Version

site
= list all Site ID and Name

clients  
= list all clients (console)

clients_wifi
= list all wifi clients with connection speed (console)

devices_console
= list all devices (only use in console)

clients_all
= count all clients (wired/wifi)

clients_name ( + Accesspoint)
= count and list all wifi clients (or off one accesspoint)

clients_name_guest ( + Accesspoint)
= count list all wifi clients and guests (or off one accesspoint)

clients_count ( + Accesspoint)
= count wifi clients (or off one accesspoint)

clients_count_guest ( + Accesspoint)
= count wifi clients and guests (or off one accesspoint)

channels + Accesspoint
= channels 2GHz/5GHz off an accesspoint

client_transfer + Clientname or IP
= rx/tx transfer off a Client (KBit/MBit)

client_transfer+ + Clientname or IP
= rx/tx transfer off a Client (KByte/MByte)

client_uplink + Clientname or IP
= uplink off a wifi client

client_uptime
= uptime off a client (connection uptime)

transfer + Accesspoint
= rx/tx transfer off an accesspoint (Kbit/Mbit)  

transfer+ + Accesspoint
= rx/tx transfer off an accesspoint (Kbyte/Mbyte)

swtich_transfer + Switch
= rx/tx transfer off a swtich (KBit/MBit)

switch_transfer+ + Switch
= rx/tx transfer off a switch (KByte/MByte)

uptime + Accesspoint/Switch
= uptime off an accesspoint/switch

update + Accesspoint/Switch
= update firmware is available off an accesspointi/switch (point release, major version, minor version)

uplink + Accesspoint warn crit
= uplink off an accesspoint (wireless: with connection speed and warn/critical)

experience + Accesspoint warn crit
= wireless experience off an accesspoint with warn/critical

utilisation + Accesspoint warn crit
= wireless utilisation off an accesspoint with warn/critical (2GHz,5GHz)

mem + Accesspoint warn crit
= memory usage output Mb off an accesspoint or a switch with warn/critical percent

mem% + Accesspoint warn crit
= memory usage output percent off an accesspoint or a switch with warn/critical percent

cpu + Accesspoint/Switch warn crit
= cpu and load combination usage off an accesspoint or a switch with warn/critical procent

cpu% + Accesspoint/Switch warn crit
= cpu usage off an accesspoint or a switch with warn/critical procent

load + Accesspoint/Switch warn crit
= linux_load usage off an accesspoint or a switch with warn/critical 1,5,15

temperature + Switch
= temperature off a switch with warn/critical

ap warn crit
= count Accesspoint (Online and Offline) with warn and critical offline Accesspoints

switch warn crit
= count Switch (Online and Offline) with warn and critical offline Switch

clients_ssid ( + SSID Name)
= count all ssid clients for every ssid or one ssid

clients_count_ssid + SSID Name
= count all wifi clients for one ssid

clients_count_guest_ssid + SSID Name
= count all wifi clients and guests for one ssid

clients_wifi                             
= count all clients WiFi standards for one site

 

Count over all sites:
ap_unifi warn crit
= count Accesspoint (Online and Offline) with warn and critical offline Accesspoints

switch_unifi warn crit
= count Switch (Online and Offline) with warn and critical offline Switch

ap_unifi_name warn crit
= count Accesspoint (Online and Offline) with warn and critical named offline Accesspoints

switch_unifi_name warn crit
= count Switch (Online and Offline) with warn and critical named offline Switch

clients_unifi
= count all clients

clients_count_unifi
= count all wifi clients

clients_count_guest_unifi
= count all wifi clients and guests

clients_wifi_unifi
 = count all clients WiFi standards

lte_uplink
= lte uplink off a LTE AP with warn and critical rssi,rsrq,rsrp

lte_failover
= lte failover off a LTE AP

lte
= lte connection off a LTE AP

alarms_count
= count all alarm messages
-r   controller/client_transfer/client_transfer+/client_uplink/clients_ssid
result nagios - new controller version/if a client not present/or if a guest ssid is enabled or disabled
0 - OK (default)
1 - WARNING
2 - CRITICAL
-i inverse -r (only clients_ssid, if the guest ssid is enabled or disabled)
-C config file (default=unifi.php) instead off the controller parameters -H, -u, -p, -P, -s, -S (you can specify any file with path)
        
example (unifi.php):

<?php
 $host='192.168.2.213';
 $prot='https';      
 $port='8443';
 $user='nagios';
 $pass='nagios';
 $siteid='default';
 $dir_unifi_client='';
 $status_ap=array(
0=>'CRITICAL'  # offline
1=>'OK',       # connected
2=>'WARNING',  # pending adoption
4=>'WARNING',  # updating
5=>'WARNING',  # provisionig
6=>'CRITICAL', # unreachable
7=>'WARNING',  # adopting
9 =>'CRITICAL',# adoption error
11=>'CRITICAL' # isolated
);
?>
 
  
 
unifi_load unifi_mem2 unifi_experience3 unifi_transfer4 unifi_channel_usage5 unifi_nagios6 unifi_clients_ssid7 unifi_clients8 unifi_clients_wifi9
Version 1.20220810
add mode switch_transfer/switch_transfer+
bug fix counts_client_unifi, transfer/transfer+
client_transfer, client_transfer+
Version 1.20220626
change controller to use -r
change clients_ssid to use -r and -i for guest wifi
minor bug fixes
Thanks's to Gaston, Florian and Patrick
Version 1.20220614
add mode alarms_count
Thank's to Patrick St. Jean
Version 1.20220610
clients_name list clients sorted
ap_name, switch_name, ap_unifi_name,
switch_unifi_name list sorted
Version 1.20220511
add console check devices_console
add checks udm_temperature, lte, lte_failover, lte_uplink
Version 1.20220415
add client_experience
Version 1.20220406
New API Version 1.1.79
Version 1.20220322
New API Version 1.1.78
rewrite mode update
Version 1.20220216
exclude one or more AP or Swtich from check
(ap, switch, ap_unifi, swich_unifi, ap_unifi_name
and switch_unifi_name)
Version 1.20220117
add clients_wifi and clients_wifi_unifi
Version 1.20220103
New API Version 1.1.76
1.20211216
correct mode update
changed mode clients_transfer+
change test config file exist 

Version 1.20211206
help added version and contact

Version 1.20211129
add warning and critical wire uplink

Version 1.20211119
corrected mem% (warning and critical)
Thanks's to Artur (via mail)

Version 1.20211109
New API Version 1.1.74

Version 1.20211007
corrected performance data client_uplink

Version 1.20210930
New API Version 1.1.71

Version 1.20210623
corrected clients_name_guest count 2GHz clients if there is a guest 

Version 1.20210601
add clients_ssid (count all clients for every ssid)
add clients_count_ssid/clients_count_guest_ssid

Version 1.20210520
corrected ap/switch name if there no alias and ap/switch is offline

Version 1.20210519
corrected count offline ap/switch if more then one ap/switch is offline

Version 1.20210517
Count over all sites
ap_unifi/switch_unifi
ap_name_unifi/switch_name_unifi
clients_unifi/clients_count_unifi/clients_count_guest_unifi

Version 1.20210511
corrected sum clients_count/clients_count_guest
used for accesspoints

Version 1.20210507
corrected client_transfer+ (if KByte > 1024)

Version 1.20210429
add clients_all (count all wired/wifi clients)

Version 1.20210427
over all clients count for mode 
client_name/client_name_guest/ 
client_count/clients_count_guest
Thanks to "SysAdmRBE" from exchange.nagios.com

Version 1.20210426
corrected uplink/client_uplink
add client_uptime

Version 1.20210422
corrected mem/mem%

Version 1.20210405
add client_uplink

Version 1.20210323
change status of accesspoints in config file (-C) for mode
client_name/client_name_guest/ client_count/clients_count_guest
you can set OK/WARNING/CRITICAL
new API Version 1.1.70

Version 1.20210316
add client_transfer/client_transfer+ (it will take 30 seconds to get a check result)

Version 1.20210308
corrected status code (Warning/Critical) for mode ap and switch
Thanks to "kemecs" from exchange.nagios.com

Version 1.20210305
corrected mem%
changed transfer/transfer+ (it will take 30 seconds to get a check result)

Version 1.20210227
change help 
add client bands to clients_name/clients_name_guest

Version 1.20210225
corrected channels (-1/+1)
corrected $dir_unifi_client

Version 1.20210219
model is integrated in Api
update ap/switch now with warning and critical
add site (to find the sideid)
add multisite (-S)

Version 1.20210211
minor bugs fixes
add transfer+ 

Version 1.20210211
minor bugs fixes
change Client.php to unifi_client.php
change default path from /usr/local/nagios/libexec to the path of the script 
change modes:
linux_load to load
linux_cpu to cpu%

Version 1.20210210
add following checks:
- transfer
- experience
- utilisation
- clients_name_guest
- clients_count_guest
- linux_load
- linux_cpu
- update

Thank's again to Keith from UK for the input.

Version 1.20210204
-C - config file unifi.php instead of the controller parameter -H,-u,-p,-P
and -s
add mem% output memory percent
perfdata uptime (seconds)

Thank's to Keith from UK for the input.

Version 1.20210130
uplink accesspoint now also wire

Version 1.20210127
new API Version 1.1.68
count Accesspoint and count Switch

Version 1.20210124
minor bugs fixes

Version 1.20210118
new API Version 1.1.63

Version 1.20210106
cpu now with warn and crit percent

Version 1.20210104
mapping short label type to real name (uptime)

Zurück
Powered by jDownloads

Would you like to support me?
Then donate to PayPal...