diff --git a/front/plugins/arp_scan/README_DE.md b/front/plugins/arp_scan/README_DE.md new file mode 100755 index 00000000..1a4c0844 --- /dev/null +++ b/front/plugins/arp_scan/README_DE.md @@ -0,0 +1,12 @@ +## Übersicht + +ARP-Scan ist ein Kommandozeilen Werkzeug welches das ARP-Protokoll nutzt, um IP-Hosts im lokalen Netzwerk zu erkennen und identifizieren. Eine Alternative zum ARP-Scan ist die Aktivierung der PiHole-Integration (`PIHOLE_RUN`) in den Einstellungen. Die Dauer des ARP-Scan (und andere Netzwerkscan-Plugins, welche die `SCAN_SUBNETS`-Einstellung nutzen) ist abhängig von der Anzahl der zu prüfenden IP-Adressen. Daher ist es wichtig, dies mit größter Vorsicht und den korrekten Netzwerkmasken und -interfaces zu konfigurieren. Die [Subnetz-Dokumentation](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/SUBNETS.md) ansehen für mehr Hilfe zum Aufsetzen von VLANs, welche VLANs unterstützt werden und zum Herausfinden der Netzwerkmaske und -interfaces. + +### Verwendung + +- Zur Einstellungen-Seite gehen und die `SCAN_SUBNETS`-Einstellung anhand der [Subnetz-Dokumentation](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/SUBNETS.md) konfigurieren +- Das Plugin aktivieren indem der `RUN`-Parameter von `disabled` auf den gewünschten Ausführzeitpunkt gesetzt wird (normalerweise: `schedule`) + - Zeitplan in der `ARPSCAN_RUN_SCHD`-Einstellung setzen +- Zeitlimit nach Bedarf in der `ARPSCAN_RUN_TIMEOUT`-Einstellung setzen +- SPEICHERN +- Auf Ausführung des nächsten Scans warten diff --git a/front/plugins/arp_scan/config.json b/front/plugins/arp_scan/config.json index dce575d7..730ae03c 100755 --- a/front/plugins/arp_scan/config.json +++ b/front/plugins/arp_scan/config.json @@ -3,19 +3,22 @@ "unique_prefix": "ARPSCAN", "enabled": true, "data_source": "script", - "mapped_to_table": "CurrentScan", + "mapped_to_table": "CurrentScan", "data_filters": [ { - "compare_column" : "Object_PrimaryID", - "compare_operator" : "==", - "compare_field_id": "txtMacFilter", - "compare_js_template": "'{value}'.toString()", - "compare_use_quotes": true + "compare_column": "Object_PrimaryID", + "compare_operator": "==", + "compare_field_id": "txtMacFilter", + "compare_js_template": "'{value}'.toString()", + "compare_use_quotes": true } ], "show_ui": true, - "localized": ["display_name", "description", "icon"], - + "localized": [ + "display_name", + "description", + "icon" + ], "display_name": [ { "language_code": "en_us", @@ -28,7 +31,7 @@ { "language_code": "de_de", "string": "ARP-Scan (Netzwerkscan)" - } + } ], "icon": [ { @@ -58,54 +61,71 @@ "string": "Dieses Plugin wird genutzt, um einen ARP-Scan auf dem lokalen Netzwerk durchzuführen" } ], - "params" : [ + "params": [ { - "name" : "subnets", - "type" : "setting", - "value" : "SCAN_SUBNETS", - "base64": true - }], - + "name": "subnets", + "type": "setting", + "value": "SCAN_SUBNETS", + "base64": true + } + ], "settings": [ { - "function": "RUN", - "type": "text.select", - "default_value":"schedule", - "options": ["disabled", "once", "schedule", "always_after_scan", "on_new_device"], - "localized": ["name", "description"], - "events": ["run"], - "name" :[ - { - "language_code":"en_us", - "string" : "When to run" - }, - { - "language_code":"es_es", - "string" : "Cuando ejecutar" - }, - { - "language_code":"de_de", - "string" : "Wann ausführen" - }], - "description": [{ - "language_code":"en_us", - "string" : "Specify when your Network-discovery scan will run. Typical setting would be schedule and then you specify a cron-like schedule in the ARPSCAN_RUN_SCHDsetting " - }, - { - "language_code":"es_es", - "string" : "Especifique cuándo se ejecutará su análisis de descubrimiento de red. La configuración típica sería schedule y luego se especifica una programación similar a cron en la configuración ARPSCAN_RUN_SCHD " - }, - { - "language_code":"de_de", - "string" : "Auswählen wann der Netzwerkscan laufen soll. Typischerweise wird schedule ausgewählt und ein cron-Intervall in der ARPSCAN_RUN_SCHDEinstellung gesetzt." - }] - }, + "function": "RUN", + "type": "text.select", + "default_value": "schedule", + "options": [ + "disabled", + "once", + "schedule", + "always_after_scan", + "on_new_device" + ], + "localized": [ + "name", + "description" + ], + "events": [ + "run" + ], + "name": [ + { + "language_code": "en_us", + "string": "When to run" + }, + { + "language_code": "es_es", + "string": "Cuando ejecutar" + }, + { + "language_code": "de_de", + "string": "Wann ausführen" + } + ], + "description": [ + { + "language_code": "en_us", + "string": "Specify when your Network-discovery scan will run. Typical setting would be schedule and then you specify a cron-like schedule in the ARPSCAN_RUN_SCHDsetting " + }, + { + "language_code": "es_es", + "string": "Especifique cuándo se ejecutará su análisis de descubrimiento de red. La configuración típica sería schedule y luego se especifica una programación similar a cron en la configuración ARPSCAN_RUN_SCHD " + }, + { + "language_code": "de_de", + "string": "Auswählen wann der Netzwerkscan laufen soll. Typischerweise wird schedule ausgewählt und ein cron-Intervall in der ARPSCAN_RUN_SCHDEinstellung gesetzt." + } + ] + }, { "function": "CMD", "type": "readonly", "default_value": "python3 /home/pi/pialert/front/plugins/arp_scan/script.py userSubnets={subnets}", "options": [], - "localized": ["name", "description"], + "localized": [ + "name", + "description" + ], "name": [ { "language_code": "en_us", @@ -118,7 +138,7 @@ { "language_code": "de_de", "string": "Befehl" - } + } ], "description": [ { @@ -135,13 +155,15 @@ } ] }, - { "function": "RUN_TIMEOUT", "type": "integer", "default_value": 300, "options": [], - "localized": ["name", "description"], + "localized": [ + "name", + "description" + ], "name": [ { "language_code": "en_us", @@ -154,7 +176,7 @@ { "language_code": "de_de", "string": "Zeitlimit" - } + } ], "description": [ { @@ -172,86 +194,118 @@ ] }, { - "function": "RUN_SCHD", - "type": "text", - "default_value":"*/5 * * * *", - "options": [], - "localized": ["name", "description"], - "name" : [{ - "language_code":"en_us", - "string" : "Schedule" - }, - { - "language_code":"es_es", - "string" : "Schedule" + "function": "RUN_SCHD", + "type": "text", + "default_value": "*/5 * * * *", + "options": [], + "localized": [ + "name", + "description" + ], + "name": [ + { + "language_code": "en_us", + "string": "Schedule" }, { - "language_code":"de_de", - "string" : "Zeitplan" - }], - "description": [{ - "language_code":"en_us", - "string" : "Only enabled if you select schedule in the ARPSCAN_RUN setting. Make sure you enter the schedule in the correct cron-like format (e.g. validate at crontab.guru). For example entering */3 * * * * will run the scan every 3 minutes. 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." - }, - { - "language_code":"es_es", - "string" : "Solo está habilitado si selecciona schedule en la configuración ARPSCAN_RUN. Asegúrese de ingresar la programación en el formato similar a cron correcto (por ejemplo, valide en crontab.guru). Por ejemplo, ingresar */3 * * * * ejecutará el escaneo cada 3 minutos. Se ejecutará la PRÓXIMA vez que pase el tiempo.
Se recomienda utilizar el mismo intervalo de programación para todos los complementos que analizan su red." + "language_code": "es_es", + "string": "Schedule" }, { - "language_code":"de_de", - "string" : "Nur aktiv, wenn schedule in der ARPSCAN_RUN Einstellung ausgewählt wurde. Sichergehen, dass das Intervall in einem korrekten cron-ähnlichen Format angegeben wurde (z.B. auf crontab.guru testen). */3 * * * * würde den Scan alle 3 Minuten starten. Wird erst beim NÄCHSTEN Intervall ausgeführt.
Es wird empfohlen, das Intervall aller Plugins, welche nach neuen Geräten suchen, auf den gleichen Wert zu setzen." - }] + "language_code": "de_de", + "string": "Zeitplan" + } + ], + "description": [ + { + "language_code": "en_us", + "string": "Only enabled if you select schedule in the ARPSCAN_RUN setting. Make sure you enter the schedule in the correct cron-like format (e.g. validate at crontab.guru). For example entering */3 * * * * will run the scan every 3 minutes. 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." + }, + { + "language_code": "es_es", + "string": "Solo está habilitado si selecciona schedule en la configuración ARPSCAN_RUN. Asegúrese de ingresar la programación en el formato similar a cron correcto (por ejemplo, valide en crontab.guru). Por ejemplo, ingresar */3 * * * * ejecutará el escaneo cada 3 minutos. Se ejecutará la PRÓXIMA vez que pase el tiempo.
Se recomienda utilizar el mismo intervalo de programación para todos los complementos que analizan su red." + }, + { + "language_code": "de_de", + "string": "Nur aktiv, wenn schedule in der ARPSCAN_RUN Einstellung ausgewählt wurde. Sichergehen, dass das Intervall in einem korrekten cron-ähnlichen Format angegeben wurde (z.B. auf crontab.guru testen). */3 * * * * würde den Scan alle 3 Minuten starten. Wird erst beim NÄCHSTEN Intervall ausgeführt.
Es wird empfohlen, das Intervall aller Plugins, welche nach neuen Geräten suchen, auf den gleichen Wert zu setzen." + } + ] }, { - "function": "WATCH", - "type": "text.multiselect", - "default_value":["Watched_Value1", "Watched_Value2"], - "options": ["Watched_Value1","Watched_Value2","Watched_Value3","Watched_Value4"], - "localized": ["name", "description"], - "name" :[{ - "language_code":"en_us", - "string" : "Watched" - }, - { - "language_code":"es_es", - "string" : "Watched" + "function": "WATCH", + "type": "text.multiselect", + "default_value": [ + "Watched_Value1", + "Watched_Value2" + ], + "options": [ + "Watched_Value1", + "Watched_Value2", + "Watched_Value3", + "Watched_Value4" + ], + "localized": [ + "name", + "description" + ], + "name": [ + { + "language_code": "en_us", + "string": "Watched" }, { - "language_code":"de_de", - "string" : "Überwacht" - }] , - "description":[{ - "language_code":"en_us", - "string" : "Send a notification if selected values change. Use CTRL + Click to select/deselect. " - }, - { - "language_code":"es_es", - "string" : "Envía una notificación si los valores seleccionados cambian. Utilice CTRL + clic para seleccionar/deseleccionar. " + "language_code": "es_es", + "string": "Watched" }, { - "language_code":"de_de", - "string" : "Sende eine Benachrichtigung, wenn ein ausgwählter Wert sich ändert. STRG + klicken zum aus-/abwählen. " - }] + "language_code": "de_de", + "string": "Überwacht" + } + ], + "description": [ + { + "language_code": "en_us", + "string": "Send a notification if selected values change. Use CTRL + Click to select/deselect. " + }, + { + "language_code": "es_es", + "string": "Envía una notificación si los valores seleccionados cambian. Utilice CTRL + clic para seleccionar/deseleccionar. " + }, + { + "language_code": "de_de", + "string": "Sende eine Benachrichtigung, wenn ein ausgwählter Wert sich ändert. STRG + klicken zum aus-/abwählen. " + } + ] }, { "function": "REPORT_ON", "type": "text.multiselect", - "default_value": ["new"], - "options": ["new", "watched-changed", "watched-not-changed", "missing-in-last-scan"], - "localized": ["name", "description"], + "default_value": [ + "new" + ], + "options": [ + "new", + "watched-changed", + "watched-not-changed", + "missing-in-last-scan" + ], + "localized": [ + "name", + "description" + ], "name": [ { "language_code": "en_us", "string": "Report on" }, - { + { "language_code": "es_es", "string": "Informar sobre" }, { "language_code": "de_de", "string": "Benachrichtige wenn" - } + } ], "description": [ { @@ -269,181 +323,205 @@ ] } ], - - "database_column_definitions": - [ + "database_column_definitions": [ { "column": "Object_PrimaryID", - "mapped_to_column": "cur_MAC", + "mapped_to_column": "cur_MAC", "css_classes": "col-sm-2", "show": true, - "type": "device_name_mac", - "default_value":"", + "type": "device_name_mac", + "default_value": "", "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "MAC" - }, - { - "language_code":"es_es", - "string" : "MAC" - }, - { - "language_code":"de_de", - "string" : "MAC" - }] - }, - { - "column": "Watched_Value1", - "mapped_to_column": "cur_IP", - "css_classes": "col-sm-2", - "show": true, - "type": "device_ip", - "default_value":"", - "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "IP" - }, - { - "language_code":"es_es", - "string" : "IP" - }, - { - "language_code":"de_de", - "string" : "IP" - }] + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "MAC" + }, + { + "language_code": "es_es", + "string": "MAC" + }, + { + "language_code": "de_de", + "string": "MAC" + } + ] }, { - "column": "Watched_Value2", - "mapped_to_column": "cur_Vendor", - "css_classes": "col-sm-2", - "show": true, - "type": "label", - "default_value":"", - "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "Vendor" - }, - { - "language_code":"es_es", - "string" : "Proveedor" - }, - { - "language_code":"de_de", - "string" : "Hersteller" - }] - } , - { - "column": "Dummy", - "mapped_to_column": "cur_ScanMethod", - "mapped_to_column_data": { - "value": "arp-scan" - }, + "column": "Watched_Value1", + "mapped_to_column": "cur_IP", "css_classes": "col-sm-2", "show": true, - "type": "label", - "default_value":"", + "type": "device_ip", + "default_value": "", "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "Scan method" - }, - { - "language_code":"es_es", - "string" : "Método de escaneo" - }, - { - "language_code":"de_de", - "string" : "Scanmethode" - }] - } , + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "IP" + }, + { + "language_code": "es_es", + "string": "IP" + }, + { + "language_code": "de_de", + "string": "IP" + } + ] + }, + { + "column": "Watched_Value2", + "mapped_to_column": "cur_Vendor", + "css_classes": "col-sm-2", + "show": true, + "type": "label", + "default_value": "", + "options": [], + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "Vendor" + }, + { + "language_code": "es_es", + "string": "Proveedor" + }, + { + "language_code": "de_de", + "string": "Hersteller" + } + ] + }, + { + "column": "Dummy", + "mapped_to_column": "cur_ScanMethod", + "mapped_to_column_data": { + "value": "arp-scan" + }, + "css_classes": "col-sm-2", + "show": true, + "type": "label", + "default_value": "", + "options": [], + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "Scan method" + }, + { + "language_code": "es_es", + "string": "Método de escaneo" + }, + { + "language_code": "de_de", + "string": "Scanmethode" + } + ] + }, { "column": "DateTimeCreated", "css_classes": "col-sm-2", "show": true, - "type": "label", - "default_value":"", + "type": "label", + "default_value": "", "options": [], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "Created" - }, - { - "language_code":"es_es", - "string" : "Creado" - }, - { - "language_code":"de_de", - "string" : "Erstellt" - }] - }, + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "Created" + }, + { + "language_code": "es_es", + "string": "Creado" + }, + { + "language_code": "de_de", + "string": "Erstellt" + } + ] + }, { - "column": "DateTimeChanged", - "css_classes": "col-sm-2", - "show": true, - "type": "label", - "default_value":"", - "options": [], - "localized": ["name"], - "name":[ - { - "language_code":"en_us", - "string" : "Changed" - }, - { - "language_code":"es_es", - "string" : "Cambiado" - }, - { - "language_code":"de_de", - "string" : "Geändert" - } - ] - }, + "column": "DateTimeChanged", + "css_classes": "col-sm-2", + "show": true, + "type": "label", + "default_value": "", + "options": [], + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "Changed" + }, + { + "language_code": "es_es", + "string": "Cambiado" + }, + { + "language_code": "de_de", + "string": "Geändert" + } + ] + }, { - "column": "Status", - "css_classes": "col-sm-1", - "show": true, - "type": "replace", - "default_value":"", - "options": [ - { - "equals": "watched-not-changed", - "replacement": "
" - }, - { - "equals": "watched-changed", - "replacement": "
" - }, - { - "equals": "new", - "replacement": "
" - }, - { - "equals": "missing-in-last-scan", - "replacement": "
" - } - ], - "localized": ["name"], - "name":[{ - "language_code":"en_us", - "string" : "Status" - }, - { - "language_code":"es_es", - "string" : "Estado" - }, - { - "language_code":"de_de", - "string" : "Status" - }] - } + "column": "Status", + "css_classes": "col-sm-1", + "show": true, + "type": "replace", + "default_value": "", + "options": [ + { + "equals": "watched-not-changed", + "replacement": "
" + }, + { + "equals": "watched-changed", + "replacement": "
" + }, + { + "equals": "new", + "replacement": "
" + }, + { + "equals": "missing-in-last-scan", + "replacement": "
" + } + ], + "localized": [ + "name" + ], + "name": [ + { + "language_code": "en_us", + "string": "Status" + }, + { + "language_code": "es_es", + "string": "Estado" + }, + { + "language_code": "de_de", + "string": "Status" + } + ] + } ] -} +} \ No newline at end of file