mirror of
https://github.com/tomaae/homeassistant-mikrotik_router.git
synced 2025-06-23 17:28:51 +02:00
790 lines
28 KiB
Python
790 lines
28 KiB
Python
"""Mikrotik Controller for Mikrotik Router."""
|
|
|
|
import asyncio
|
|
import logging
|
|
from datetime import timedelta
|
|
|
|
from homeassistant.core import callback
|
|
from homeassistant.helpers.dispatcher import async_dispatcher_send
|
|
from homeassistant.helpers.event import async_track_time_interval
|
|
from homeassistant.util.dt import utcnow
|
|
|
|
from .const import (
|
|
DOMAIN,
|
|
CONF_TRACK_ARP,
|
|
DEFAULT_TRACK_ARP,
|
|
CONF_SCAN_INTERVAL,
|
|
CONF_UNIT_OF_MEASUREMENT,
|
|
DEFAULT_SCAN_INTERVAL,
|
|
DEFAULT_TRAFFIC_TYPE,
|
|
)
|
|
from .exceptions import ApiEntryNotFound
|
|
from .helper import from_entry, parse_api
|
|
from .mikrotikapi import MikrotikAPI
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
# ---------------------------
|
|
# MikrotikControllerData
|
|
# ---------------------------
|
|
class MikrotikControllerData:
|
|
"""MikrotikController Class"""
|
|
|
|
def __init__(
|
|
self,
|
|
hass,
|
|
config_entry,
|
|
name,
|
|
host,
|
|
port,
|
|
username,
|
|
password,
|
|
use_ssl,
|
|
traffic_type,
|
|
):
|
|
"""Initialize MikrotikController."""
|
|
self.name = name
|
|
self.hass = hass
|
|
self.host = host
|
|
self.config_entry = config_entry
|
|
self.traffic_type = traffic_type
|
|
|
|
self.data = {
|
|
"routerboard": {},
|
|
"resource": {},
|
|
"interface": {},
|
|
"arp": {},
|
|
"arp_tmp": {},
|
|
"nat": {},
|
|
"fw-update": {},
|
|
"script": {},
|
|
"queue": {},
|
|
"dns": {},
|
|
"dhcp-server": {},
|
|
"dhcp": {},
|
|
"host": {},
|
|
}
|
|
|
|
self.listeners = []
|
|
self.lock = asyncio.Lock()
|
|
|
|
self.api = MikrotikAPI(host, username, password, port, use_ssl)
|
|
|
|
self.nat_removed = {}
|
|
|
|
async_track_time_interval(
|
|
self.hass, self.force_update, self.option_scan_interval
|
|
)
|
|
async_track_time_interval(
|
|
self.hass, self.force_fwupdate_check, timedelta(hours=1)
|
|
)
|
|
|
|
def _get_traffic_type_and_div(self):
|
|
traffic_type = self.option_traffic_type
|
|
if traffic_type == "Kbps":
|
|
traffic_div = 0.001
|
|
elif traffic_type == "Mbps":
|
|
traffic_div = 0.000001
|
|
elif traffic_type == "B/s":
|
|
traffic_div = 0.125
|
|
elif traffic_type == "KB/s":
|
|
traffic_div = 0.000125
|
|
elif traffic_type == "MB/s":
|
|
traffic_div = 0.000000125
|
|
else:
|
|
traffic_type = "bps"
|
|
traffic_div = 1
|
|
return traffic_type, traffic_div
|
|
|
|
# ---------------------------
|
|
# force_update
|
|
# ---------------------------
|
|
@callback
|
|
async def force_update(self, _now=None):
|
|
"""Trigger update by timer"""
|
|
await self.async_update()
|
|
|
|
# ---------------------------
|
|
# force_fwupdate_check
|
|
# ---------------------------
|
|
@callback
|
|
async def force_fwupdate_check(self, _now=None):
|
|
"""Trigger hourly update by timer"""
|
|
await self.async_fwupdate_check()
|
|
|
|
# ---------------------------
|
|
# option_track_arp
|
|
# ---------------------------
|
|
@property
|
|
def option_track_arp(self):
|
|
"""Config entry option to not track ARP."""
|
|
return self.config_entry.options.get(CONF_TRACK_ARP, DEFAULT_TRACK_ARP)
|
|
|
|
# ---------------------------
|
|
# option_scan_interval
|
|
# ---------------------------
|
|
@property
|
|
def option_scan_interval(self):
|
|
"""Config entry option scan interval."""
|
|
scan_interval = self.config_entry.options.get(
|
|
CONF_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL
|
|
)
|
|
return timedelta(seconds=scan_interval)
|
|
|
|
# ---------------------------
|
|
# option_traffic_type
|
|
# ---------------------------
|
|
@property
|
|
def option_traffic_type(self):
|
|
"""Config entry option to not track ARP."""
|
|
return self.config_entry.options.get(
|
|
CONF_UNIT_OF_MEASUREMENT, DEFAULT_TRAFFIC_TYPE
|
|
)
|
|
|
|
# ---------------------------
|
|
# signal_update
|
|
# ---------------------------
|
|
@property
|
|
def signal_update(self):
|
|
"""Event to signal new data."""
|
|
return f"{DOMAIN}-update-{self.name}"
|
|
|
|
# ---------------------------
|
|
# connected
|
|
# ---------------------------
|
|
def connected(self):
|
|
"""Return connected state"""
|
|
return self.api.connected()
|
|
|
|
# ---------------------------
|
|
# hwinfo_update
|
|
# ---------------------------
|
|
async def hwinfo_update(self):
|
|
"""Update Mikrotik hardware info"""
|
|
try:
|
|
await asyncio.wait_for(self.lock.acquire(), timeout=10)
|
|
except:
|
|
return
|
|
|
|
await self.hass.async_add_executor_job(self.get_system_routerboard)
|
|
await self.hass.async_add_executor_job(self.get_system_resource)
|
|
self.lock.release()
|
|
|
|
# ---------------------------
|
|
# async_fwupdate_check
|
|
# ---------------------------
|
|
async def async_fwupdate_check(self):
|
|
"""Update Mikrotik data"""
|
|
await self.hass.async_add_executor_job(self.get_firmware_update)
|
|
async_dispatcher_send(self.hass, self.signal_update)
|
|
|
|
# ---------------------------
|
|
# async_update
|
|
# ---------------------------
|
|
async def async_update(self):
|
|
"""Update Mikrotik data"""
|
|
try:
|
|
await asyncio.wait_for(self.lock.acquire(), timeout=10)
|
|
except:
|
|
return
|
|
|
|
if "available" not in self.data["fw-update"]:
|
|
await self.async_fwupdate_check()
|
|
|
|
await self.hass.async_add_executor_job(self.get_interface)
|
|
await self.hass.async_add_executor_job(self.get_interface_traffic)
|
|
await self.hass.async_add_executor_job(self.get_interface_client)
|
|
await self.hass.async_add_executor_job(self.get_nat)
|
|
await self.hass.async_add_executor_job(self.get_system_resource)
|
|
await self.hass.async_add_executor_job(self.get_script)
|
|
await self.hass.async_add_executor_job(self.get_queue)
|
|
|
|
async_dispatcher_send(self.hass, self.signal_update)
|
|
|
|
self.lock.release()
|
|
|
|
# ---------------------------
|
|
# async_reset
|
|
# ---------------------------
|
|
async def async_reset(self):
|
|
"""Reset dispatchers"""
|
|
for unsub_dispatcher in self.listeners:
|
|
unsub_dispatcher()
|
|
|
|
self.listeners = []
|
|
return True
|
|
|
|
# ---------------------------
|
|
# set_value
|
|
# ---------------------------
|
|
def set_value(self, path, param, value, mod_param, mod_value):
|
|
"""Change value using Mikrotik API"""
|
|
return self.api.update(path, param, value, mod_param, mod_value)
|
|
|
|
# ---------------------------
|
|
# run_script
|
|
# ---------------------------
|
|
def run_script(self, name):
|
|
"""Run script using Mikrotik API"""
|
|
try:
|
|
self.api.run_script(name)
|
|
except ApiEntryNotFound as error:
|
|
_LOGGER.error("Failed to run script: %s", error)
|
|
|
|
# ---------------------------
|
|
# get_interface
|
|
# ---------------------------
|
|
def get_interface(self):
|
|
"""Get all interfaces data from Mikrotik"""
|
|
self.data["interface"] = parse_api(
|
|
data=self.data["interface"],
|
|
source=self.api.path("/interface"),
|
|
key="default-name",
|
|
vals=[
|
|
{"name": "default-name"},
|
|
{"name": "name", "default_val": "default-name"},
|
|
{"name": "type", "default": "unknown"},
|
|
{"name": "running", "type": "bool"},
|
|
{
|
|
"name": "enabled",
|
|
"source": "disabled",
|
|
"type": "bool",
|
|
"reverse": True,
|
|
},
|
|
{"name": "port-mac-address", "source": "mac-address"},
|
|
{"name": "comment"},
|
|
{"name": "last-link-down-time"},
|
|
{"name": "last-link-up-time"},
|
|
{"name": "link-downs"},
|
|
{"name": "tx-queue-drop"},
|
|
{"name": "actual-mtu"},
|
|
],
|
|
ensure_vals=[
|
|
{"name": "client-ip-address"},
|
|
{"name": "client-mac-address"},
|
|
{"name": "rx-bits-per-second", "default": 0},
|
|
{"name": "tx-bits-per-second", "default": 0},
|
|
],
|
|
)
|
|
|
|
# ---------------------------
|
|
# get_interface_traffic
|
|
# ---------------------------
|
|
def get_interface_traffic(self):
|
|
"""Get traffic for all interfaces from Mikrotik"""
|
|
interface_list = ""
|
|
for uid in self.data["interface"]:
|
|
interface_list += self.data["interface"][uid]["name"] + ","
|
|
|
|
interface_list = interface_list[:-1]
|
|
|
|
self.data["interface"] = parse_api(
|
|
data=self.data["interface"],
|
|
source=self.api.get_traffic(interface_list),
|
|
key_search="name",
|
|
vals=[
|
|
{"name": "rx-bits-per-second", "default": 0},
|
|
{"name": "tx-bits-per-second", "default": 0},
|
|
],
|
|
)
|
|
|
|
traffic_type, traffic_div = self._get_traffic_type_and_div()
|
|
|
|
for uid in self.data["interface"]:
|
|
self.data["interface"][uid][
|
|
"rx-bits-per-second-attr"] = traffic_type
|
|
self.data["interface"][uid][
|
|
"tx-bits-per-second-attr"] = traffic_type
|
|
self.data["interface"][uid]["rx-bits-per-second"] = round(
|
|
self.data["interface"][uid]["rx-bits-per-second"] * traffic_div
|
|
)
|
|
self.data["interface"][uid]["tx-bits-per-second"] = round(
|
|
self.data["interface"][uid]["tx-bits-per-second"] * traffic_div
|
|
)
|
|
|
|
# ---------------------------
|
|
# get_interface_client
|
|
# ---------------------------
|
|
def get_interface_client(self):
|
|
"""Get ARP data from Mikrotik"""
|
|
self.data["arp_tmp"] = {}
|
|
|
|
# Remove data if disabled
|
|
if not self.option_track_arp:
|
|
for uid in self.data["interface"]:
|
|
self.data["interface"][uid]["client-ip-address"] = "disabled"
|
|
self.data["interface"][uid]["client-mac-address"] = "disabled"
|
|
return
|
|
|
|
mac2ip = {}
|
|
bridge_used = False
|
|
mac2ip, bridge_used = self.update_arp(mac2ip, bridge_used)
|
|
|
|
if bridge_used:
|
|
self.update_bridge_hosts(mac2ip)
|
|
|
|
# Map ARP to ifaces
|
|
for uid in self.data["interface"]:
|
|
if uid not in self.data["arp_tmp"]:
|
|
continue
|
|
|
|
self.data["interface"][uid]["client-ip-address"] = from_entry(
|
|
self.data["arp_tmp"][uid], "address"
|
|
)
|
|
self.data["interface"][uid]["client-mac-address"] = from_entry(
|
|
self.data["arp_tmp"][uid], "mac-address"
|
|
)
|
|
|
|
# ---------------------------
|
|
# update_arp
|
|
# ---------------------------
|
|
def update_arp(self, mac2ip, bridge_used):
|
|
"""Get list of hosts in ARP for interface client data from Mikrotik"""
|
|
data = self.api.path("/ip/arp")
|
|
if not data:
|
|
return mac2ip, bridge_used
|
|
|
|
for entry in data:
|
|
# Ignore invalid entries
|
|
if entry["invalid"]:
|
|
continue
|
|
|
|
if "interface" not in entry:
|
|
continue
|
|
|
|
# Do not add ARP detected on bridge
|
|
if entry["interface"] == "bridge":
|
|
bridge_used = True
|
|
# Build address table on bridge
|
|
if "mac-address" in entry and "address" in entry:
|
|
mac2ip[entry["mac-address"]] = entry["address"]
|
|
|
|
continue
|
|
|
|
# Get iface default-name from custom name
|
|
uid = self.get_iface_from_entry(entry)
|
|
if not uid:
|
|
continue
|
|
|
|
_LOGGER.debug("Processing entry %s, entry %s", "/ip/arp", entry)
|
|
# Create uid arp dict
|
|
if uid not in self.data["arp_tmp"]:
|
|
self.data["arp_tmp"][uid] = {}
|
|
|
|
# Add data
|
|
self.data["arp_tmp"][uid]["interface"] = uid
|
|
self.data["arp_tmp"][uid]["mac-address"] = (
|
|
from_entry(entry, "mac-address") if "mac-address" not in self.data["arp_tmp"][uid] else "multiple"
|
|
)
|
|
self.data["arp_tmp"][uid]["address"] = (
|
|
from_entry(entry, "address") if "address" not in self.data["arp_tmp"][uid] else "multiple"
|
|
)
|
|
|
|
return mac2ip, bridge_used
|
|
|
|
# ---------------------------
|
|
# update_bridge_hosts
|
|
# ---------------------------
|
|
def update_bridge_hosts(self, mac2ip):
|
|
"""Get list of hosts in bridge for interface client data from Mikrotik"""
|
|
data = self.api.path("/interface/bridge/host")
|
|
if not data:
|
|
return
|
|
|
|
for entry in data:
|
|
# Ignore port MAC
|
|
if entry["local"]:
|
|
continue
|
|
|
|
# Get iface default-name from custom name
|
|
uid = self.get_iface_from_entry(entry)
|
|
if not uid:
|
|
continue
|
|
|
|
_LOGGER.debug(
|
|
"Processing entry %s, entry %s", "/interface/bridge/host", entry
|
|
)
|
|
# Create uid arp dict
|
|
if uid not in self.data["arp_tmp"]:
|
|
self.data["arp_tmp"][uid] = {}
|
|
|
|
# Add data
|
|
self.data["arp_tmp"][uid]["interface"] = uid
|
|
if "mac-address" in self.data["arp_tmp"][uid]:
|
|
self.data["arp_tmp"][uid]["mac-address"] = "multiple"
|
|
self.data["arp_tmp"][uid]["address"] = "multiple"
|
|
else:
|
|
self.data["arp_tmp"][uid]["mac-address"] = from_entry(entry,
|
|
"mac-address")
|
|
self.data["arp_tmp"][uid]["address"] = (
|
|
mac2ip[self.data["arp_tmp"][uid]["mac-address"]]
|
|
if self.data["arp_tmp"][uid]["mac-address"] in mac2ip
|
|
else ""
|
|
)
|
|
|
|
# ---------------------------
|
|
# get_iface_from_entry
|
|
# ---------------------------
|
|
def get_iface_from_entry(self, entry):
|
|
"""Get interface default-name using name from interface dict"""
|
|
uid = None
|
|
for ifacename in self.data["interface"]:
|
|
if self.data["interface"][ifacename]["name"] == entry["interface"]:
|
|
uid = ifacename
|
|
break
|
|
|
|
return uid
|
|
|
|
# ---------------------------
|
|
# get_nat
|
|
# ---------------------------
|
|
def get_nat(self):
|
|
"""Get NAT data from Mikrotik"""
|
|
self.data["nat"] = parse_api(
|
|
data=self.data["nat"],
|
|
source=self.api.path("/ip/firewall/nat"),
|
|
key=".id",
|
|
vals=[
|
|
{"name": ".id"},
|
|
{"name": "protocol", "default": "any"},
|
|
{"name": "dst-port", "default": "any"},
|
|
{"name": "in-interface", "default": "any"},
|
|
{"name": "to-addresses"},
|
|
{"name": "to-ports"},
|
|
{"name": "comment"},
|
|
{
|
|
"name": "enabled",
|
|
"source": "disabled",
|
|
"type": "bool",
|
|
"reverse": True,
|
|
},
|
|
],
|
|
val_proc=[
|
|
[
|
|
{"name": "name"},
|
|
{"action": "combine"},
|
|
{"key": "protocol"},
|
|
{"text": ":"},
|
|
{"key": "dst-port"},
|
|
]
|
|
],
|
|
only=[{"key": "action", "value": "dst-nat"}],
|
|
)
|
|
|
|
nat_uniq = {}
|
|
nat_del = {}
|
|
for uid in self.data["nat"]:
|
|
tmp_name = self.data["nat"][uid]["name"]
|
|
if tmp_name not in nat_uniq:
|
|
nat_uniq[tmp_name] = uid
|
|
else:
|
|
nat_del[uid] = 1
|
|
nat_del[nat_uniq[tmp_name]] = 1
|
|
|
|
for uid in nat_del:
|
|
if self.data["nat"][uid]["name"] not in self.nat_removed:
|
|
self.nat_removed[self.data["nat"][uid]["name"]] = 1
|
|
_LOGGER.error("Mikrotik %s duplicate NAT rule %s, entity will be unavailable.",
|
|
self.host, self.data["nat"][uid]["name"])
|
|
|
|
del self.data["nat"][uid]
|
|
|
|
# ---------------------------
|
|
# get_system_routerboard
|
|
# ---------------------------
|
|
def get_system_routerboard(self):
|
|
"""Get routerboard data from Mikrotik"""
|
|
self.data["routerboard"] = parse_api(
|
|
data=self.data["routerboard"],
|
|
source=self.api.path("/system/routerboard"),
|
|
vals=[
|
|
{"name": "routerboard", "type": "bool"},
|
|
{"name": "model", "default": "unknown"},
|
|
{"name": "serial-number", "default": "unknown"},
|
|
{"name": "firmware", "default": "unknown"},
|
|
],
|
|
)
|
|
|
|
# ---------------------------
|
|
# get_system_resource
|
|
# ---------------------------
|
|
def get_system_resource(self):
|
|
"""Get system resources data from Mikrotik"""
|
|
self.data["resource"] = parse_api(
|
|
data=self.data["resource"],
|
|
source=self.api.path("/system/resource"),
|
|
vals=[
|
|
{"name": "platform", "default": "unknown"},
|
|
{"name": "board-name", "default": "unknown"},
|
|
{"name": "version", "default": "unknown"},
|
|
{"name": "uptime", "default": "unknown"},
|
|
{"name": "cpu-load", "default": "unknown"},
|
|
{"name": "free-memory", "default": 0},
|
|
{"name": "total-memory", "default": 0},
|
|
{"name": "free-hdd-space", "default": 0},
|
|
{"name": "total-hdd-space", "default": 0},
|
|
],
|
|
)
|
|
|
|
if self.data["resource"]["total-memory"] > 0:
|
|
self.data["resource"]["memory-usage"] = round(
|
|
(
|
|
(
|
|
self.data["resource"]["total-memory"]
|
|
- self.data["resource"]["free-memory"]
|
|
)
|
|
/ self.data["resource"]["total-memory"]
|
|
)
|
|
* 100
|
|
)
|
|
else:
|
|
self.data["resource"]["memory-usage"] = "unknown"
|
|
|
|
if self.data["resource"]["total-hdd-space"] > 0:
|
|
self.data["resource"]["hdd-usage"] = round(
|
|
(
|
|
(
|
|
self.data["resource"]["total-hdd-space"]
|
|
- self.data["resource"]["free-hdd-space"]
|
|
)
|
|
/ self.data["resource"]["total-hdd-space"]
|
|
)
|
|
* 100
|
|
)
|
|
else:
|
|
self.data["resource"]["hdd-usage"] = "unknown"
|
|
|
|
# ---------------------------
|
|
# get_system_routerboard
|
|
# ---------------------------
|
|
def get_firmware_update(self):
|
|
"""Check for firmware update on Mikrotik"""
|
|
self.data["fw-update"] = parse_api(
|
|
data=self.data["fw-update"],
|
|
source=self.api.path("/system/package/update"),
|
|
vals=[
|
|
{"name": "status"},
|
|
{"name": "channel", "default": "unknown"},
|
|
{"name": "installed-version", "default": "unknown"},
|
|
{"name": "latest-version", "default": "unknown"},
|
|
],
|
|
)
|
|
|
|
if "status" in self.data["fw-update"]:
|
|
self.data["fw-update"]["available"] = (
|
|
True if self.data["fw-update"][
|
|
"status"] == "New version is available"
|
|
else False
|
|
)
|
|
else:
|
|
self.data["fw-update"]["available"] = False
|
|
|
|
# ---------------------------
|
|
# get_script
|
|
# ---------------------------
|
|
def get_script(self):
|
|
"""Get list of all scripts from Mikrotik"""
|
|
self.data["script"] = parse_api(
|
|
data=self.data["script"],
|
|
source=self.api.path("/system/script"),
|
|
key="name",
|
|
vals=[
|
|
{"name": "name"},
|
|
{"name": "last-started", "default": "unknown"},
|
|
{"name": "run-count", "default": "unknown"},
|
|
],
|
|
)
|
|
|
|
# ---------------------------
|
|
# get_queue
|
|
# ---------------------------
|
|
|
|
def get_queue(self):
|
|
"""Get Queue data from Mikrotik"""
|
|
self.data["queue"] = parse_api(
|
|
data=self.data["queue"],
|
|
source=self.api.path("/queue/simple"),
|
|
key="name",
|
|
vals=[
|
|
{"name": ".id"},
|
|
{"name": "name", "default": "unknown"},
|
|
{"name": "target", "default": "unknown"},
|
|
{"name": "max-limit", "default": "0/0"},
|
|
{"name": "limit-at", "default": "0/0"},
|
|
{"name": "burst-limit", "default": "0/0"},
|
|
{"name": "burst-threshold", "default": "0/0"},
|
|
{"name": "burst-time", "default": "0s/0s"},
|
|
{"name": "packet-marks", "default": "none"},
|
|
{"name": "parent", "default": "none"},
|
|
{"name": "comment"},
|
|
{
|
|
"name": "enabled",
|
|
"source": "disabled",
|
|
"type": "bool",
|
|
"reverse": True,
|
|
},
|
|
]
|
|
)
|
|
|
|
traffic_type, traffic_div = self._get_traffic_type_and_div()
|
|
|
|
for uid in self.data["queue"]:
|
|
upload_max_limit_bps, download_max_limit_bps = [int(x) for x in
|
|
self.data["queue"][uid]["max-limit"].split('/')]
|
|
self.data["queue"][uid]["upload-max-limit"] = \
|
|
f"{round(upload_max_limit_bps * traffic_div)} {traffic_type}"
|
|
self.data["queue"][uid]["download-max-limit"] = \
|
|
f"{round(download_max_limit_bps * traffic_div)} {traffic_type}"
|
|
|
|
upload_limit_at_bps, download_limit_at_bps = [int(x) for x in
|
|
self.data["queue"][uid]["limit-at"].split('/')]
|
|
self.data["queue"][uid]["upload-limit-at"] = \
|
|
f"{round(upload_limit_at_bps * traffic_div)} {traffic_type}"
|
|
self.data["queue"][uid]["download-limit-at"] = \
|
|
f"{round(download_limit_at_bps * traffic_div)} {traffic_type}"
|
|
|
|
upload_burst_limit_bps, download_burst_limit_bps = [int(x) for x in
|
|
self.data["queue"][uid]["burst-limit"].split('/')]
|
|
self.data["queue"][uid]["upload-burst-limit"] = \
|
|
f"{round(upload_burst_limit_bps * traffic_div)} {traffic_type}"
|
|
self.data["queue"][uid]["download-burst-limit"] = \
|
|
f"{round(download_burst_limit_bps * traffic_div)} {traffic_type}"
|
|
|
|
upload_burst_threshold_bps,\
|
|
download_burst_threshold_bps = [int(x) for x in self.data["queue"][uid]["burst-threshold"].split('/')]
|
|
|
|
self.data["queue"][uid]["upload-burst-threshold"] = \
|
|
f"{round(upload_burst_threshold_bps * traffic_div)} {traffic_type}"
|
|
self.data["queue"][uid]["download-burst-threshold"] = \
|
|
f"{round(download_burst_threshold_bps * traffic_div)} {traffic_type}"
|
|
|
|
upload_burst_time, download_burst_time = self.data["queue"][uid]["burst-time"].split('/')
|
|
self.data["queue"][uid]["upload-burst-time"] = upload_burst_time
|
|
self.data["queue"][uid]["download-burst-time"] = download_burst_time
|
|
|
|
# ---------------------------
|
|
# get_arp
|
|
# ---------------------------
|
|
def get_arp(self):
|
|
"""Get ARP data from Mikrotik"""
|
|
self.data["arp"] = parse_api(
|
|
data=self.data["arp"],
|
|
source=self.api.path("/ip/arp"),
|
|
key="mac-address",
|
|
vals=[
|
|
{"name": "mac-address"},
|
|
{"name": "address"},
|
|
{"name": "interface"},
|
|
],
|
|
)
|
|
|
|
# ---------------------------
|
|
# get_dns
|
|
# ---------------------------
|
|
def get_dns(self):
|
|
"""Get static DNS data from Mikrotik"""
|
|
self.data["dns"] = parse_api(
|
|
data=self.data["dns"],
|
|
source=self.api.path("/ip/dns/static"),
|
|
key="name",
|
|
vals=[
|
|
{"name": "name"},
|
|
{"name": "address"},
|
|
],
|
|
)
|
|
|
|
# ---------------------------
|
|
# get_dhcp
|
|
# ---------------------------
|
|
def get_dhcp(self):
|
|
"""Get DHCP data from Mikrotik"""
|
|
|
|
self.data["dhcp-server"] = parse_api(
|
|
data=self.data["dhcp-server"],
|
|
source=self.api.path("/ip/dhcp-server"),
|
|
key="name",
|
|
vals=[
|
|
{"name": "name"},
|
|
{"name": "interface", "default": ""},
|
|
]
|
|
)
|
|
|
|
self.data["dhcp"] = parse_api(
|
|
data=self.data["dhcp"],
|
|
source=self.api.path("/ip/dhcp-server/lease"),
|
|
key="mac-address",
|
|
vals=[
|
|
{"name": "mac-address"},
|
|
{"name": "address", "default": "unknown"},
|
|
{"name": "host-name", "default": "unknown"},
|
|
{"name": "status", "default": "unknown"},
|
|
{"name": "last-seen", "default": "unknown"},
|
|
{"name": "server", "default": "unknown"},
|
|
{"name": "comment", "default": ""},
|
|
],
|
|
ensure_vals=[
|
|
{"name": "interface"},
|
|
{"name": "available", "type": "bool", "default": False},
|
|
]
|
|
)
|
|
|
|
for uid in self.data["dhcp"]:
|
|
self.data["dhcp"][uid]["interface"] = \
|
|
self.data["dhcp-server"][self.data["dhcp"][uid]["server"]]["interface"]
|
|
|
|
# ---------------------------
|
|
# process_host
|
|
# ---------------------------
|
|
def process_host(self):
|
|
"""Get host tracking data"""
|
|
# Add hosts from DHCP
|
|
for uid, vals in self.data["dhcp"].items():
|
|
if uid not in self.data["host"]:
|
|
self.data["host"][uid] = {}
|
|
self.data["host"][uid]["source"] = "dhcp"
|
|
|
|
for key, key_data in zip(
|
|
["address", "mac-address", "interface"],
|
|
["address", "mac-address", "interface"],
|
|
):
|
|
if key not in self.data["host"][uid] or self.data["host"][uid][key] == "unknown":
|
|
self.data["host"][uid][key] = vals[key_data]
|
|
|
|
# Process hosts
|
|
for uid, vals in self.data["host"].items():
|
|
# Add missing default values
|
|
for key, default in zip(
|
|
["address", "mac-address", "interface", "hostname", "last-seen", "available"],
|
|
["unknown", "unknown", "unknown", "unknown", False],
|
|
):
|
|
if key not in self.data["host"][uid]:
|
|
self.data["host"][uid][key] = default
|
|
|
|
# Resolve hostname
|
|
if vals["hostname"] == "unknown":
|
|
if vals["address"] != "unknown":
|
|
for dns_uid, dns_vals in self.data["dns"].items():
|
|
if dns_vals["address"] == vals["address"]:
|
|
self.data["host"][uid]["hostname"] = dns_vals["name"].split('.')[0]
|
|
break
|
|
|
|
if self.data["host"][uid]["hostname"] == "unknown" \
|
|
and uid in self.data["dhcp"] and self.data["dhcp"][uid]["comment"] != "":
|
|
self.data["host"][uid]["hostname"] = self.data["dhcp"][uid]["comment"]
|
|
|
|
elif self.data["host"][uid]["hostname"] == "unknown" \
|
|
and uid in self.data["dhcp"] and self.data["dhcp"][uid]["host-name"] != "unknown":
|
|
self.data["host"][uid]["hostname"] = self.data["dhcp"][uid]["host-name"]
|
|
|
|
elif self.data["host"][uid]["hostname"] == "unknown":
|
|
self.data["host"][uid]["hostname"] = uid
|
|
|
|
# Check host availability
|
|
if vals["address"] != "unknown" and vals["interface"] != "unknown":
|
|
self.data["host"][uid]["available"] = \
|
|
self.api.arp_ping(vals["address"], vals["interface"])
|
|
|
|
# Update last seen
|
|
if self.data["host"][uid]["available"]:
|
|
self.data["host"][uid]["last-seen"] = utcnow()
|