vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2025-12-07 09:36:05 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Merge pull request #401 from tuhriel/unifi-scanner-bugfix

Browse Source 
enable unifi scanner to show online state of devices - thanks so much @tuhriel 🙏
This commit is contained in:
jokob-sk
2023-08-27 20:50:56 +00:00
committed by GitHub
parent a794170adf 8ffc07a110
commit 61df3ec581
2 changed files with 153 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
front/plugins/unifi_import/config.json
View File

@@ -38,6 +38,10 @@
{
"language_code":"es_es",
"string" : "Este plugin se utiliza para importar dispositivos desde un controlador UNIFI."
},
{
"language_code":"de_de",
"string" : "Dieses Plugin imporiert die Geräte von einem UNIFI Controller."
}],
"params" : [
{
@@ -93,7 +97,12 @@
{
"language_code":"es_es",
"string" : "N/A"
}]
},
{
"language_code":"de_de",
"string" : "N/A"
}
]
} ,
{
"column": "Plugin",
@@ -110,6 +119,10 @@
{
"language_code":"es_es",
"string" : "N/A"
},
{
"language_code":"de_de",
"string" : "N/A"
}]
},
{
@@ -128,6 +141,10 @@
{
"language_code":"es_es",
"string" : "Dirección MAC"
},
{
"language_code":"de_de",
"string" : "MAC Adresse"
}]
},
{
@@ -146,7 +163,12 @@
{
"language_code":"es_es",
"string" : "IP"
}]
},
{
"language_code":"de_de",
"string" : "IP"
}
]
} ,
{
"column": "DateTimeCreated",
@@ -163,6 +185,10 @@
{
"language_code":"es_es",
"string" : "Creado"
},
{
"language_code":"de_de",
"string" : "Erstellt"
}]
},
{
@@ -181,6 +207,10 @@
{
"language_code":"es_es",
"string" : "Cambiado"
},
{
"language_code":"de_de",
"string" : "Angepasst"
}]
},
{
@@ -199,6 +229,10 @@
{
"language_code":"es_es",
"string" : "Nombre de host"
},
{
"language_code":"de_de",
"string" : "Name des Hosts"
}]
},
{
@@ -216,6 +250,10 @@
{
"language_code":"es_es",
"string" : "Proveedor"
},
{
"language_code":"de_de",
"string" : "Hersteller"
}]
},
{
@@ -233,6 +271,10 @@
{
"language_code":"es_es",
"string" : "Tipo"
},
{
"language_code":"de_de",
"string" : "Typ"
}]
} ,
{
@@ -250,6 +292,10 @@
{
"language_code":"es_es",
"string" : "¿Online?"
},
{
"language_code":"de_de",
"string" : "Online?"
}]
} ,
{
@@ -267,6 +313,10 @@
{
"language_code":"es_es",
"string" : "Comentarios"
},
{
"language_code":"de_de",
"string" : "Kommentar"
}]
},
{
@@ -284,6 +334,10 @@
{
"language_code":"es_es",
"string" : "Red"
},
{
"language_code":"de_de",
"string" : "Netzwerk"
}]
},
{
@@ -318,6 +372,10 @@
{
"language_code":"es_es",
"string" : "Estado"
},
{
"language_code":"de_de",
"string" : "Status"
}]
}
],
@@ -335,6 +393,10 @@
{
"language_code":"es_es",
"string" : "Cuándo ejecutar"
},
{
"language_code":"de_de",
"string" : "Ausführungszeitpunkt"
}],
"description": [{
"language_code":"en_us",
@@ -343,7 +405,11 @@
{
"language_code":"es_es",
"string" : "Habilite la importación de dispositivos desde un controlador UNIFI. Si selecciona <code>schedule</code>, se aplican las configuraciones de programación de abajo. Si selecciona <code>once</code>, el análisis se ejecuta solo una vez al iniciar la aplicación (contenedor) o después de actualizar su configuración."
}]
},
{
"language_code":"de_de",
"string" : "Aktiviere den Import von einem UNIFI controller. Bei <code>schedule</code> werden die Richtzeiten von weiter unten verwendet. Bei der Auswahl <code>once</code> der Import wird einmalig beim Start der Applikation (container), oder nach einem Update der Einstellungen durchgeführt."
}]
},
{
"function": "CMD",
@@ -358,6 +424,10 @@
{
"language_code":"es_es",
"string" : "Comando"
},
{
"language_code":"de_de",
"string" : "Befehl"
}],
"description": [{
"language_code":"en_us",
@@ -366,6 +436,10 @@
{
"language_code":"es_es",
"string" : "Comando para ejecutar. No se recomienda cambiar."
},
{
"language_code":"de_de",
"string" : "Befehl der ausgeführt wird. Anpassung nicht empfohlen"
}]
},
{
@@ -577,6 +651,10 @@
{
"language_code":"es_es",
"string" : "Tiempo máximo en segundos para esperar a que finalice el script. Si se supera este tiempo, el script se cancela."
},
{
"language_code":"de_de",
"string" : "Maximale Laufzeit des Scripts. Nach Ablauf der Zeit wird das Script abgebrochen."
}]
},
{
@@ -595,11 +673,11 @@
}] ,
"description":[{
"language_code":"en_us",
"string" : "Send a notification if selected values change. Use <code>CTRL + Click</code> to select/deselect. <ul> <li><code>Watched_Value1</code> is Hostname </li><li><code>Watched_Value2</code> is Vendor </li><li><code>Watched_Value3</code> is Type </li><li><code>Watched_Value4</code> is Network </li></ul>"
"string" : "Send a notification if selected values change. Use <code>CTRL + Click</code> to select/deselect. <ul> <li><code>Watched_Value1</code> is Hostname </li><li><code>Watched_Value2</code> is Vendor </li><li><code>Watched_Value3</code> is Type </li><li><code>Watched_Value4</code> is Online </li></ul>"
},
{
"language_code":"es_es",
"string" : "Envíe una notificación si los valores seleccionados cambian. Utilice <code>CTRL + clic</code> para seleccionar/deseleccionar. <ul> <li><code>Watched_Value1</code> es el nombre de host </li><li><code>Watched_Value2</code> es el proveedor </li><li><code>Watched_Value3</code> es el tipo </li><li><code>Watched_Value4</code> es Red </li></ul>"
"string" : "Envíe una notificación si los valores seleccionados cambian. Utilice <code>CTRL + clic</code> para seleccionar/deseleccionar. <ul> <li><code>Watched_Value1</code> es el nombre de host </li><li><code>Watched_Value2</code> es el proveedor </li><li><code>Watched_Value3</code> es el tipo </li><li><code>Watched_Value4</code> es Online </li></ul>"
}]
},
{
@@ -627,3 +705,4 @@
}
]
}

108
front/plugins/unifi_import/script.py
View File

@@ -2,23 +2,23 @@
# Inspired by https://github.com/stevehoek/Pi.Alert
# Example call
# python3 /home/pi/pialert/front/plugins/unifi_import/script.py username=pialert password=passw0rd host=192.168.1.1 site=default protocol=https:// port=8443 version='UDMP-unifiOS'
# python3 /home/pi/pialert/front/plugins/unifi_import/script.py username=pialert password=passw0rd host=192.168.1.1 sites=sdefault port=8443 verifyssl=false version=v5
from __future__ import unicode_literals
from time import sleep, time, strftime
import requests
from requests import Request, Session, packages
from requests import Request, Session, packages
import pathlib
import threading
import subprocess
import socket
import json
import argparse
import io
import sys
import logging
from requests.packages.urllib3.exceptions import InsecureRequestWarning
import pwd
import os
from pyunifi.controller import Controller
@@ -26,17 +26,33 @@ curPath = str(pathlib.Path(__file__).parent.resolve())
log_file = curPath + '/script.log'
last_run = curPath + '/last_result.log'
logging.basicConfig(
filename=log_file,
level=logging.INFO,
format='%(asctime)s:%(levelname)s:%(name)s:%(message)s'
)
unifi_logger = logging.getLogger('[UNIFI]')
unifi_logger.setLevel(logging.DEBUG)
requests.packages.urllib3.disable_warnings(InsecureRequestWarning)
# Workflow
def main():
unifi_logger.info('Start scan')
# init global variables
global UNIFI_USERNAME, UNIFI_PASSWORD, UNIFI_HOST, UNIFI_SITES, PORT, VERIFYSSL, VERSION
last_run_logfile = open(last_run, 'a')
# empty file
last_run_logfile.write("")
unifi_logger.debug('Purging old values')
with open(last_run, 'w') as last_run_logfile:
last_run_logfile.write("")
parser = argparse.ArgumentParser(description='Import devices from an UNIFI controller')
@@ -53,6 +69,7 @@ def main():
# parse output
newEntries = []
unifi_logger.debug(f'Check if all login information is available: {values}')
if values.username and values.password and values.host and values.sites:
UNIFI_USERNAME = values.username.split('=')[1]
@@ -62,15 +79,15 @@ def main():
PORT = values.port.split('=')[1]
VERIFYSSL = values.verifyssl.split('=')[1]
VERSION = values.version.split('=')[1]
newEntries = get_entries(newEntries)
unifi_logger.debug(f'Print {len(newEntries)} to monitoring log')
for e in newEntries:
# Insert list into the log
service_monitoring_log(e.primaryId, e.secondaryId, e.created, e.watched1, e.watched2, e.watched3, e.watched4, e.extra, e.foreignKey )
unifi_logger.info(f'Scan finished, added {len(newEntries)} devices')
# -----------------------------------------------------------------------------
def get_entries(newEntries):
@@ -93,6 +110,8 @@ def get_entries(newEntries):
c = Controller(UNIFI_HOST, UNIFI_USERNAME, UNIFI_PASSWORD, port=PORT, version=VERSION, ssl_verify=VERIFYSSL, site_id=site )
unifi_logger.debug('identify Unifi Devices')
# get all Unifi devices
for ap in c.get_aps():
# print(f'{json.dumps(ap)}')
@@ -125,8 +144,12 @@ def get_entries(newEntries):
newEntries.append(tmpPlugObj)
unifi_logger.debug(f'Found {len(newEntries)} Unifi Devices')
# print(f'>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>')
online_macs = set()
# get_clients() returns all clients which are currently online.
for cl in c.get_clients():
# print(f'{json.dumps(cl)}')
@@ -137,40 +160,37 @@ def get_entries(newEntries):
if name == 'null' and hostName != 'null':
name = hostName
tmpPlugObj = plugin_object_class(
cl['mac'],
get_unifi_val(cl, 'ip'),
name,
get_unifi_val(cl, 'oui'),
'Other',
1,
get_unifi_val(cl, 'connection_network_name')
)
online_macs.add(cl['mac'])
unifi_logger.debug(f'Found {len(online_macs)} Online Clients')
# print(f'>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>')
for us in c.get_clients():
# get_users() returns all clients known by the controller
for user in c.get_users():
# print(f'{json.dumps(us)}')
# print(f'{json.dumps(user)}')
name = get_unifi_val(us, 'name')
hostName = get_unifi_val(us, 'hostname')
name = get_unifi_val(user, 'name')
hostName = get_unifi_val(user, 'hostname')
if name == 'null' and hostName != 'null':
name = hostName
name = set_name(name, hostName)
status = 1 if user['mac'] in online_macs else 0
tmpPlugObj = plugin_object_class(
us['mac'],
get_unifi_val(us, 'ip'),
user['mac'],
get_unifi_val(user, 'last_ip'),
name,
get_unifi_val(us, 'oui'),
get_unifi_val(user, 'oui'),
'Other',
1,
get_unifi_val(us, 'connection_network_name')
status,
get_unifi_val(user, 'last_connection_network_name')
)
newEntries.append(tmpPlugObj)
unifi_logger.debug(f'Found {len(newEntries)} Clients overall')
return newEntries
@@ -179,20 +199,29 @@ def get_unifi_val(obj, key):
res = ''
if key in obj:
res = obj[key]
res = obj.get(key, None)
if res not in ['','None']:
if res not in ['','None', None]:
return res
if obj.get(key) is not None:
res = obj.get(key)
if res not in ['','None']:
return res
return 'null'
# -----------------------------------------------------------------------------
def set_name(name: str, hostName: str) -> str:
if name != 'null':
return name
elif name == 'null' and hostName != 'null':
return hostName
else:
return 'null'
# -------------------------------------------------------------------
class plugin_object_class:
def __init__(self, primaryId = '',secondaryId = '', watched1 = '',watched2 = '',watched3 = '',watched4 = '',extra = '',foreignKey = ''):
@@ -211,7 +240,7 @@ class plugin_object_class:
self.foreignKey = foreignKey
# -----------------------------------------------------------------------------
def service_monitoring_log(primaryId, secondaryId, created, watched1, watched2 = 'null', watched3 = 'null', watched4 = 'null', extra ='null', foreignKey ='null' ):
def service_monitoring_log(primaryId, secondaryId, created, watched1, watched2 = 'null', watched3 = 'null', watched4 = 'null', extra ='null', foreignKey ='null'):
if watched1 == '':
watched1 = 'null'
@@ -226,6 +255,7 @@ def service_monitoring_log(primaryId, secondaryId, created, watched1, watched2 =
if foreignKey == '':
foreignKey = 'null'
unifi_logger.debug(f'Adding entry to monitoring log:\n{primaryId}, {secondaryId}, {created}, {watched1}, {watched2}, {watched3}, {watched4}, {extra}')
with open(last_run, 'a') as last_run_logfile:
last_run_logfile.write("{}|{}|{}|{}|{}|{}|{}|{}|{}\n".format(
primaryId,