"
+ },
+ {
+ "equals": "watched-changed",
+ "replacement": "
"
+ },
+ {
+ "equals": "new",
+ "replacement": "
"
+ },
+ {
+ "equals": "missing-in-last-scan",
+ "replacement": "
"
+ }
+ ],
+ "localized": ["name"],
+ "name": [{"language_code": "en_us", "string": "Status"}]
+ }
+ ],
+ "settings": [
+ {
+ "function": "RUN",
+ "events": ["run"],
+ "type": {
+ "dataType": "string",
+ "elements": [{"elementType": "select", "elementOptions": [], "transformers": []}]
+ },
+ "default_value": "disabled",
+ "options": [
+ "disabled",
+ "once",
+ "schedule",
+ "always_after_scan",
+ "on_new_device"
+ ],
+ "localized": ["name", "description"],
+ "name": [{"language_code": "en_us", "string": "When to run"}],
+ "description": [
+ {
+ "language_code": "en_us",
+ "string": "Enable import of devices from
Kea API. If you select
schedule the scheduling settings from below are applied. If you select
once the scan is run only once on start of the application (container) or after you update your settings. ⚠ Use the same schedule if you have multiple
Device scanners enabled."
+ }
+ ]
+ },
+ {
+ "function": "CMD",
+ "type": {
+ "dataType": "string",
+ "elements": [
+ { "elementType": "input", "elementOptions": [], "transformers": [] }
+ ]
+ },
+ "default_value": "python3 /app/front/plugins/kea_api/script.py",
+ "options": [],
+ "localized": ["name", "description"],
+ "name": [{"language_code": "en_us", "string": "Command"}],
+ "description": [{"language_code": "en_us", "string": "Command to run"}]
+ },
+ {
+ "function": "URL",
+ "localized": ["name", "description"],
+ "name": [{"language_code": "en_us", "string": "API URL"}],
+ "description": [{"language_code": "en_us", "string": "Kea Control Agent URL"}],
+ "type": {
+ "dataType": "string",
+ "elements": [
+ {
+ "elementType": "input",
+ "elementOptions": [],
+ "transformers": []
+ }
+ ]
+ },
+ "default_value": "http://127.0.0.1:8000"
+ },
+ {
+ "function": "USER",
+ "localized": ["name", "description"],
+ "name": [{"language_code": "en_us", "string": "API User"}],
+ "description": [{"language_code": "en_us", "string": "Basic Auth Username"}],
+ "type": {
+ "dataType": "string",
+ "elements": [
+ {
+ "elementType": "input",
+ "elementOptions": [],
+ "transformers": []
+ }
+ ]
+ },
+ "default_value": "kea-api"
+ },
+ {
+ "function": "PASS",
+ "localized": ["name", "description"],
+ "name": [{"language_code": "en_us", "string": "API Password"}],
+ "description": [{"language_code": "en_us", "string": "Basic Auth Password"}],
+ "type": {
+ "dataType": "string",
+ "elements": [
+ {
+ "elementType": "input",
+ "elementOptions": [{"type": "password"}],
+ "transformers": []
+ }
+ ]
+ },
+ "default_value": ""
+ },
+ {
+ "function": "RUN_SCHD",
+ "type": {
+ "dataType": "string",
+ "elements": [
+ {
+ "elementType": "span",
+ "elementOptions": [
+ {
+ "cssClasses": "input-group-addon validityCheck"
+ },
+ {
+ "getStringKey": "Gen_ValidIcon"
+ }
+ ],
+ "transformers": []
+ },
+ {
+ "elementType": "input",
+ "elementOptions": [
+ {
+ "focusout": "validateRegex(this)"
+ },
+ {
+ "base64Regex": "Xig/OlwqfCg/OlswLTldfFsxLTVdWzAtOV18WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlswLTldfDFbMC05XXwyWzAtM118WzAtOV0rLVswLTldK3xcKi9bMC05XSspKVxzKyg/OlwqfCg/OlsxLTldfFsxMl1bMC05XXwzWzAxXXxbMC05XSstWzAtOV0rfFwqL1swLTldKykpXHMrKD86XCp8KD86WzEtOV18MVswLTJdfFswLTldKy1bMC05XSt8XCovWzAtOV0rKSlccysoPzpcKnwoPzpbMC02XXxbMC02XS1bMC02XXxcKi9bMC05XSspKSQ="
+ }
+ ],
+ "transformers": []
+ }
+ ]
+ },
+ "default_value": "0 2 * * *",
+ "options": [],
+ "localized": ["name", "description"],
+ "name": [
+ {
+ "language_code": "en_us",
+ "string": "Schedule"
+ }
+ ],
+ "description": [
+ {
+ "language_code": "en_us",
+ "string": "Only enabled if you select
schedule in the
KEALSS_RUN setting. Make sure you enter the schedule in the correct cron-like format (e.g. validate at
crontab.guru). For example entering
0 4 * * * will run the scan after 4 am in the
TIMEZONE you set above. Will be run NEXT time the time passes.
It's recommended to use the same schedule interval for all plugins responsible for discovering new devices."
+ }
+ ]
+ },
+ {
+ "function": "RUN_TIMEOUT",
+ "type": {
+ "dataType": "integer",
+ "elements": [
+ {
+ "elementType": "input",
+ "elementOptions": [{ "type": "number" }],
+ "transformers": []
+ }
+ ]
+ },
+ "default_value": 10,
+ "options": [],
+ "localized": ["name", "description"],
+ "name": [
+ {
+ "language_code": "en_us",
+ "string": "Run timeout"
+ }
+ ],
+ "description": [
+ {
+ "language_code": "en_us",
+ "string": "Maximum time in seconds to wait for the script to finish. If this time is exceeded the script is aborted."
+ }
+ ]
+ },
+ {
+ "function": "SET_ALWAYS",
+ "type": {
+ "dataType": "array",
+ "elements": [
+ {
+ "elementType": "select",
+ "elementOptions": [{ "multiple": "true", "orderable": "true"}],
+ "transformers": []
+ }
+ ]
+ },
+ "default_value": ["devMac", "devLastIP"],
+ "options": [
+ "devMac",
+ "devLastIP"
+ ],
+ "localized": ["name", "description"],
+ "name": [
+ {
+ "language_code": "en_us",
+ "string": "Set always columns"
+ }
+ ],
+ "description": [
+ {
+ "language_code": "en_us",
+ "string": "These columns are treated as authoritative and will overwrite existing values, including those set by other plugins, unless the current value was explicitly set by the user (
Source = USER or
Source = LOCKED)."
+ }
+ ]
+ },
+ {
+ "function": "SET_EMPTY",
+ "type": {
+ "dataType": "array",
+ "elements": [
+ {
+ "elementType": "select",
+ "elementOptions": [{ "multiple": "true", "orderable": "true" }],
+ "transformers": []
+ }
+ ]
+ },
+ "default_value": [],
+ "options": [
+ "devMac",
+ "devLastIP",
+ "devName",
+ "devSourcePlugin"
+ ],
+ "localized": ["name", "description"],
+ "name": [
+ {
+ "language_code": "en_us",
+ "string": "Set empty columns"
+ }
+ ],
+ "description": [
+ {
+ "language_code": "en_us",
+ "string": "These columns are only overwritten if they are empty (
NULL / empty string) or if their Source is set to
NEWDEV"
+ }
+ ]
+ },
+ {
+ "function": "WATCH",
+ "type": {
+ "dataType": "array",
+ "elements": [
+ {
+ "elementType": "select",
+ "elementOptions": [{ "multiple": "true", "orderable": "true"}],
+ "transformers": []
+ }
+ ]
+ },
+ "default_value": ["watchedValue1", "watchedValue4"],
+ "options": [
+ "watchedValue1",
+ "watchedValue2",
+ "watchedValue4"
+ ],
+ "localized": ["name", "description"],
+ "name": [
+ {
+ "language_code": "en_us",
+ "string": "Watched"
+ }
+ ],
+ "description": [
+ {
+ "language_code": "en_us",
+ "string": "Send a notification if selected values change. Use
CTRL + Click to select/deselect.
watchedValue1 is Active watchedValue2 is Hostname watchedValue4 is State
"
+ }
+ ]
+ },
+ {
+ "function": "REPORT_ON",
+ "type": {
+ "dataType": "array",
+ "elements": [
+ {
+ "elementType": "select",
+ "elementOptions": [{ "multiple": "true", "orderable": "true"}],
+ "transformers": []
+ }
+ ]
+ },
+ "default_value": ["new", "watched-changed"],
+ "options": [
+ "new",
+ "watched-changed",
+ "watched-not-changed",
+ "missing-in-last-scan"
+ ],
+ "localized": ["name", "description"],
+ "name": [
+ {
+ "language_code": "en_us",
+ "string": "Report on"
+ }
+ ],
+ "description": [
+ {
+ "language_code": "en_us",
+ "string": "Send a notification only on these statuses.
new means a new unique (unique combination of PrimaryId and SecondaryId) object was discovered.
watched-changed means that selected
watchedValueN columns changed."
+ }
+ ]
+ }
+ ]
+}
\ No newline at end of file
diff --git a/front/plugins/kea_api/script.py b/front/plugins/kea_api/script.py
new file mode 100644
index 000000000..9dc72d8ce
--- /dev/null
+++ b/front/plugins/kea_api/script.py
@@ -0,0 +1,75 @@
+#!/usr/bin/env python3
+import os
+import sys
+import requests
+
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), '../../server'))
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), '../plugins'))
+
+from plugin_helper import Plugin_Objects, mylog, handleEmpty, is_mac
+from helper import get_setting_value
+from const import logPath
+
+pluginName = 'KEALSS'
+LOG_PATH = logPath + '/plugins'
+LOG_FILE = os.path.join(LOG_PATH, f'script.{pluginName}.log')
+RESULT_FILE = os.path.join(LOG_PATH, f'last_result.{pluginName}.log')
+
+plugin_objects = Plugin_Objects(RESULT_FILE)
+
+
+def main():
+ try:
+ url = get_setting_value(f'{pluginName}_URL')
+ user = get_setting_value(f'{pluginName}_USER')
+ password = get_setting_value(f'{pluginName}_PASS')
+ timeout = get_setting_value(f'{pluginName}_RUN_TIMEOUT')
+
+ mylog('verbose', [f'[{pluginName}] Querying Kea API at {url}'])
+
+ payload = {'command': 'lease4-get-all', 'service': ['dhcp4']}
+
+ response = requests.post(url, json=payload, auth=(user, password), timeout=max(1, timeout - 1))
+ response.raise_for_status()
+ data = response.json()
+
+ count = 0
+ for entry in data:
+ text = entry.get('text', '[API provided no text]')
+ # Result: 0 (success), 1 (error), or 3 (empty).
+ if entry['result'] == 0:
+ leases = entry['arguments']['leases']
+ for lease in leases:
+ mac = lease['hw-address']
+ state = lease['state']
+ if is_mac(mac):
+ plugin_objects.add_object(
+ primaryId = mac,
+ secondaryId = lease['ip-address'],
+ # Active or not, similar to watched1 of DHCPLSS plugin
+ watched1 = state == 0,
+ watched2 = lease['hostname'],
+ watched3 = None,
+ # Default (or assigned) (0), declined (1), expired-reclaimed (2), released (3), and registered (4)).
+ watched4 = state,
+ extra = None,
+ foreignKey = mac
+ )
+ count += 1
+ plugin_objects.write_result_file()
+
+ mylog('verbose', [f'[{pluginName}] Kea API response: {text}'])
+ mylog('verbose', [f'[{pluginName}] Successfully imported {count} devices reported by Kea API'])
+ elif entry['result'] == 1:
+ mylog('none', [f'[{pluginName}] ⚠ ERROR: Kea API indicated error: {text}'])
+ elif entry['result'] == 3:
+ mylog('verbose', [f'[{pluginName}] Kea API indicates no entries found: {text}'])
+
+
+ except Exception as e:
+ mylog('none', [f'[{pluginName}] ⚠ ERROR: {str(e)}'])
+
+
+
+if __name__ == '__main__':
+ main()