Add german readme to arp_scan plugin, format config file

This commit is contained in:
Markus Lorenz
2023-10-09 11:32:55 +02:00
parent dcf785b900
commit 1a02d34e85
2 changed files with 358 additions and 268 deletions

View File

@@ -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

View File

@@ -6,16 +6,19 @@
"mapped_to_table": "CurrentScan", "mapped_to_table": "CurrentScan",
"data_filters": [ "data_filters": [
{ {
"compare_column" : "Object_PrimaryID", "compare_column": "Object_PrimaryID",
"compare_operator" : "==", "compare_operator": "==",
"compare_field_id": "txtMacFilter", "compare_field_id": "txtMacFilter",
"compare_js_template": "'{value}'.toString()", "compare_js_template": "'{value}'.toString()",
"compare_use_quotes": true "compare_use_quotes": true
} }
], ],
"show_ui": true, "show_ui": true,
"localized": ["display_name", "description", "icon"], "localized": [
"display_name",
"description",
"icon"
],
"display_name": [ "display_name": [
{ {
"language_code": "en_us", "language_code": "en_us",
@@ -58,54 +61,71 @@
"string": "Dieses Plugin wird genutzt, um einen ARP-Scan auf dem lokalen Netzwerk durchzuführen" "string": "Dieses Plugin wird genutzt, um einen ARP-Scan auf dem lokalen Netzwerk durchzuführen"
} }
], ],
"params" : [ "params": [
{ {
"name" : "subnets", "name": "subnets",
"type" : "setting", "type": "setting",
"value" : "SCAN_SUBNETS", "value": "SCAN_SUBNETS",
"base64": true "base64": true
}], }
],
"settings": [ "settings": [
{ {
"function": "RUN", "function": "RUN",
"type": "text.select", "type": "text.select",
"default_value":"schedule", "default_value": "schedule",
"options": ["disabled", "once", "schedule", "always_after_scan", "on_new_device"], "options": [
"localized": ["name", "description"], "disabled",
"events": ["run"], "once",
"name" :[ "schedule",
{ "always_after_scan",
"language_code":"en_us", "on_new_device"
"string" : "When to run" ],
}, "localized": [
{ "name",
"language_code":"es_es", "description"
"string" : "Cuando ejecutar" ],
}, "events": [
{ "run"
"language_code":"de_de", ],
"string" : "Wann ausführen" "name": [
}], {
"description": [{ "language_code": "en_us",
"language_code":"en_us", "string": "When to run"
"string" : "Specify when your Network-discovery scan will run. Typical setting would be <code>schedule</code> and then you specify a cron-like schedule in the <a href=\"#ARPSCAN_RUN_SCHD\"><code>ARPSCAN_RUN_SCHD</code>setting</a> " },
}, {
{ "language_code": "es_es",
"language_code":"es_es", "string": "Cuando ejecutar"
"string" : "Especifique cuándo se ejecutará su análisis de descubrimiento de red. La configuración típica sería <code>schedule</code> y luego se especifica una programación similar a cron en la configuración <a href=\"#ARPSCAN_RUN_SCHD\"><code>ARPSCAN_RUN_SCHD</code></a> " },
}, {
{ "language_code": "de_de",
"language_code":"de_de", "string": "Wann ausführen"
"string" : "Auswählen wann der Netzwerkscan laufen soll. Typischerweise wird <code>schedule</code> ausgewählt und ein cron-Intervall in der <a href=\"#ARPSCAN_RUN_SCHD\"><code>ARPSCAN_RUN_SCHD</code>Einstellung</a> gesetzt." }
}] ],
}, "description": [
{
"language_code": "en_us",
"string": "Specify when your Network-discovery scan will run. Typical setting would be <code>schedule</code> and then you specify a cron-like schedule in the <a href=\"#ARPSCAN_RUN_SCHD\"><code>ARPSCAN_RUN_SCHD</code>setting</a> "
},
{
"language_code": "es_es",
"string": "Especifique cuándo se ejecutará su análisis de descubrimiento de red. La configuración típica sería <code>schedule</code> y luego se especifica una programación similar a cron en la configuración <a href=\"#ARPSCAN_RUN_SCHD\"><code>ARPSCAN_RUN_SCHD</code></a> "
},
{
"language_code": "de_de",
"string": "Auswählen wann der Netzwerkscan laufen soll. Typischerweise wird <code>schedule</code> ausgewählt und ein cron-Intervall in der <a href=\"#ARPSCAN_RUN_SCHD\"><code>ARPSCAN_RUN_SCHD</code>Einstellung</a> gesetzt."
}
]
},
{ {
"function": "CMD", "function": "CMD",
"type": "readonly", "type": "readonly",
"default_value": "python3 /home/pi/pialert/front/plugins/arp_scan/script.py userSubnets={subnets}", "default_value": "python3 /home/pi/pialert/front/plugins/arp_scan/script.py userSubnets={subnets}",
"options": [], "options": [],
"localized": ["name", "description"], "localized": [
"name",
"description"
],
"name": [ "name": [
{ {
"language_code": "en_us", "language_code": "en_us",
@@ -135,13 +155,15 @@
} }
] ]
}, },
{ {
"function": "RUN_TIMEOUT", "function": "RUN_TIMEOUT",
"type": "integer", "type": "integer",
"default_value": 300, "default_value": 300,
"options": [], "options": [],
"localized": ["name", "description"], "localized": [
"name",
"description"
],
"name": [ "name": [
{ {
"language_code": "en_us", "language_code": "en_us",
@@ -172,79 +194,111 @@
] ]
}, },
{ {
"function": "RUN_SCHD", "function": "RUN_SCHD",
"type": "text", "type": "text",
"default_value":"*/5 * * * *", "default_value": "*/5 * * * *",
"options": [], "options": [],
"localized": ["name", "description"], "localized": [
"name" : [{ "name",
"language_code":"en_us", "description"
"string" : "Schedule" ],
}, "name": [
{ {
"language_code":"es_es", "language_code": "en_us",
"string" : "Schedule" "string": "Schedule"
}, },
{ {
"language_code":"de_de", "language_code": "es_es",
"string" : "Zeitplan" "string": "Schedule"
}],
"description": [{
"language_code":"en_us",
"string" : "Only enabled if you select <code>schedule</code> in the <a href=\"#ARPSCAN_RUN\"><code>ARPSCAN_RUN</code> setting</a>. Make sure you enter the schedule in the correct cron-like format (e.g. validate at <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a>). For example entering <code>*/3 * * * *</code> will run the scan every 3 minutes. Will be run NEXT time the time passes. <br/> 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 <code>schedule</code> en la configuración <a href=\"#ARPSCAN_RUN\"><code>ARPSCAN_RUN</code></a>. Asegúrese de ingresar la programación en el formato similar a cron correcto (por ejemplo, valide en <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a>). Por ejemplo, ingresar <code>*/3 * * * *</code> ejecutará el escaneo cada 3 minutos. Se ejecutará la PRÓXIMA vez que pase el tiempo. <br/> Se recomienda utilizar el mismo intervalo de programación para todos los complementos que analizan su red."
}, },
{ {
"language_code":"de_de", "language_code": "de_de",
"string" : "Nur aktiv, wenn <code>schedule</code> in der <a href=\"#ARPSCAN_RUN\"><code>ARPSCAN_RUN</code> Einstellung</a> ausgewählt wurde. Sichergehen, dass das Intervall in einem korrekten cron-ähnlichen Format angegeben wurde (z.B. auf <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a> testen). <code>*/3 * * * *</code> würde den Scan alle 3 Minuten starten. Wird erst beim NÄCHSTEN Intervall ausgeführt. <br/>Es wird empfohlen, das Intervall aller Plugins, welche nach neuen Geräten suchen, auf den gleichen Wert zu setzen." "string": "Zeitplan"
}] }
],
"description": [
{
"language_code": "en_us",
"string": "Only enabled if you select <code>schedule</code> in the <a href=\"#ARPSCAN_RUN\"><code>ARPSCAN_RUN</code> setting</a>. Make sure you enter the schedule in the correct cron-like format (e.g. validate at <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a>). For example entering <code>*/3 * * * *</code> will run the scan every 3 minutes. Will be run NEXT time the time passes. <br/> 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 <code>schedule</code> en la configuración <a href=\"#ARPSCAN_RUN\"><code>ARPSCAN_RUN</code></a>. Asegúrese de ingresar la programación en el formato similar a cron correcto (por ejemplo, valide en <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a>). Por ejemplo, ingresar <code>*/3 * * * *</code> ejecutará el escaneo cada 3 minutos. Se ejecutará la PRÓXIMA vez que pase el tiempo. <br/> 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 <code>schedule</code> in der <a href=\"#ARPSCAN_RUN\"><code>ARPSCAN_RUN</code> Einstellung</a> ausgewählt wurde. Sichergehen, dass das Intervall in einem korrekten cron-ähnlichen Format angegeben wurde (z.B. auf <a href=\"https://crontab.guru/\" target=\"_blank\">crontab.guru</a> testen). <code>*/3 * * * *</code> würde den Scan alle 3 Minuten starten. Wird erst beim NÄCHSTEN Intervall ausgeführt. <br/>Es wird empfohlen, das Intervall aller Plugins, welche nach neuen Geräten suchen, auf den gleichen Wert zu setzen."
}
]
}, },
{ {
"function": "WATCH", "function": "WATCH",
"type": "text.multiselect", "type": "text.multiselect",
"default_value":["Watched_Value1", "Watched_Value2"], "default_value": [
"options": ["Watched_Value1","Watched_Value2","Watched_Value3","Watched_Value4"], "Watched_Value1",
"localized": ["name", "description"], "Watched_Value2"
"name" :[{ ],
"language_code":"en_us", "options": [
"string" : "Watched" "Watched_Value1",
}, "Watched_Value2",
{ "Watched_Value3",
"language_code":"es_es", "Watched_Value4"
"string" : "Watched" ],
"localized": [
"name",
"description"
],
"name": [
{
"language_code": "en_us",
"string": "Watched"
}, },
{ {
"language_code":"de_de", "language_code": "es_es",
"string" : "Überwacht" "string": "Watched"
}] ,
"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 IP</li><li><code>Watched_Value2</code> is Vendor</li><li><code>Watched_Value3</code> is Interface </li><li><code>Watched_Value4</code> is N/A </li></ul>"
},
{
"language_code":"es_es",
"string" : "Envía una notificación si los valores seleccionados cambian. Utilice <code>CTRL + clic</code> para seleccionar/deseleccionar. <ul> <li><code>Valor_observado1</code> es IP</li><li><code>Valor_observado2</code> es Proveedor</li><li><code>Valor_observado3</code> es Interfaz </li><li><code>Valor_observado4</code> es N/A </li></ul>"
}, },
{ {
"language_code":"de_de", "language_code": "de_de",
"string" : "Sende eine Benachrichtigung, wenn ein ausgwählter Wert sich ändert. <code>STRG + klicken</code> zum aus-/abwählen. <ul> <li><code>Watched_Value1</code> ist die IP</li><li><code>Watched_Value2</code> ist der Hersteller</li><li><code>Watched_Value3</code> ist das Interface </li><li><code>Watched_Value4</code> ist nicht in Verwendung </li></ul>" "string": "Überwacht"
}] }
],
"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 IP</li><li><code>Watched_Value2</code> is Vendor</li><li><code>Watched_Value3</code> is Interface </li><li><code>Watched_Value4</code> is N/A </li></ul>"
},
{
"language_code": "es_es",
"string": "Envía una notificación si los valores seleccionados cambian. Utilice <code>CTRL + clic</code> para seleccionar/deseleccionar. <ul> <li><code>Valor_observado1</code> es IP</li><li><code>Valor_observado2</code> es Proveedor</li><li><code>Valor_observado3</code> es Interfaz </li><li><code>Valor_observado4</code> es N/A </li></ul>"
},
{
"language_code": "de_de",
"string": "Sende eine Benachrichtigung, wenn ein ausgwählter Wert sich ändert. <code>STRG + klicken</code> zum aus-/abwählen. <ul> <li><code>Watched_Value1</code> ist die IP</li><li><code>Watched_Value2</code> ist der Hersteller</li><li><code>Watched_Value3</code> ist das Interface </li><li><code>Watched_Value4</code> ist nicht in Verwendung </li></ul>"
}
]
}, },
{ {
"function": "REPORT_ON", "function": "REPORT_ON",
"type": "text.multiselect", "type": "text.multiselect",
"default_value": ["new"], "default_value": [
"options": ["new", "watched-changed", "watched-not-changed", "missing-in-last-scan"], "new"
"localized": ["name", "description"], ],
"options": [
"new",
"watched-changed",
"watched-not-changed",
"missing-in-last-scan"
],
"localized": [
"name",
"description"
],
"name": [ "name": [
{ {
"language_code": "en_us", "language_code": "en_us",
"string": "Report on" "string": "Report on"
}, },
{ {
"language_code": "es_es", "language_code": "es_es",
"string": "Informar sobre" "string": "Informar sobre"
}, },
@@ -269,75 +323,85 @@
] ]
} }
], ],
"database_column_definitions": [
"database_column_definitions":
[
{ {
"column": "Object_PrimaryID", "column": "Object_PrimaryID",
"mapped_to_column": "cur_MAC", "mapped_to_column": "cur_MAC",
"css_classes": "col-sm-2", "css_classes": "col-sm-2",
"show": true, "show": true,
"type": "device_name_mac", "type": "device_name_mac",
"default_value":"", "default_value": "",
"options": [], "options": [],
"localized": ["name"], "localized": [
"name":[{ "name"
"language_code":"en_us", ],
"string" : "MAC" "name": [
}, {
{ "language_code": "en_us",
"language_code":"es_es", "string": "MAC"
"string" : "MAC" },
}, {
{ "language_code": "es_es",
"language_code":"de_de", "string": "MAC"
"string" : "MAC" },
}] {
"language_code": "de_de",
"string": "MAC"
}
]
}, },
{ {
"column": "Watched_Value1", "column": "Watched_Value1",
"mapped_to_column": "cur_IP", "mapped_to_column": "cur_IP",
"css_classes": "col-sm-2", "css_classes": "col-sm-2",
"show": true, "show": true,
"type": "device_ip", "type": "device_ip",
"default_value":"", "default_value": "",
"options": [], "options": [],
"localized": ["name"], "localized": [
"name":[{ "name"
"language_code":"en_us", ],
"string" : "IP" "name": [
}, {
{ "language_code": "en_us",
"language_code":"es_es", "string": "IP"
"string" : "IP" },
}, {
{ "language_code": "es_es",
"language_code":"de_de", "string": "IP"
"string" : "IP" },
}] {
"language_code": "de_de",
"string": "IP"
}
]
}, },
{ {
"column": "Watched_Value2", "column": "Watched_Value2",
"mapped_to_column": "cur_Vendor", "mapped_to_column": "cur_Vendor",
"css_classes": "col-sm-2", "css_classes": "col-sm-2",
"show": true, "show": true,
"type": "label", "type": "label",
"default_value":"", "default_value": "",
"options": [], "options": [],
"localized": ["name"], "localized": [
"name":[{ "name"
"language_code":"en_us", ],
"string" : "Vendor" "name": [
}, {
{ "language_code": "en_us",
"language_code":"es_es", "string": "Vendor"
"string" : "Proveedor" },
}, {
{ "language_code": "es_es",
"language_code":"de_de", "string": "Proveedor"
"string" : "Hersteller" },
}] {
} , "language_code": "de_de",
"string": "Hersteller"
}
]
},
{ {
"column": "Dummy", "column": "Dummy",
"mapped_to_column": "cur_ScanMethod", "mapped_to_column": "cur_ScanMethod",
@@ -347,103 +411,117 @@
"css_classes": "col-sm-2", "css_classes": "col-sm-2",
"show": true, "show": true,
"type": "label", "type": "label",
"default_value":"", "default_value": "",
"options": [], "options": [],
"localized": ["name"], "localized": [
"name":[{ "name"
"language_code":"en_us", ],
"string" : "Scan method" "name": [
}, {
{ "language_code": "en_us",
"language_code":"es_es", "string": "Scan method"
"string" : "Método de escaneo" },
}, {
{ "language_code": "es_es",
"language_code":"de_de", "string": "Método de escaneo"
"string" : "Scanmethode" },
}] {
} , "language_code": "de_de",
"string": "Scanmethode"
}
]
},
{ {
"column": "DateTimeCreated", "column": "DateTimeCreated",
"css_classes": "col-sm-2", "css_classes": "col-sm-2",
"show": true, "show": true,
"type": "label", "type": "label",
"default_value":"", "default_value": "",
"options": [], "options": [],
"localized": ["name"], "localized": [
"name":[{ "name"
"language_code":"en_us", ],
"string" : "Created" "name": [
}, {
{ "language_code": "en_us",
"language_code":"es_es", "string": "Created"
"string" : "Creado" },
}, {
{ "language_code": "es_es",
"language_code":"de_de", "string": "Creado"
"string" : "Erstellt" },
}] {
"language_code": "de_de",
"string": "Erstellt"
}
]
}, },
{ {
"column": "DateTimeChanged", "column": "DateTimeChanged",
"css_classes": "col-sm-2", "css_classes": "col-sm-2",
"show": true, "show": true,
"type": "label", "type": "label",
"default_value":"", "default_value": "",
"options": [], "options": [],
"localized": ["name"], "localized": [
"name":[ "name"
{ ],
"language_code":"en_us", "name": [
"string" : "Changed" {
}, "language_code": "en_us",
{ "string": "Changed"
"language_code":"es_es", },
"string" : "Cambiado" {
}, "language_code": "es_es",
{ "string": "Cambiado"
"language_code":"de_de", },
"string" : "Geändert" {
} "language_code": "de_de",
] "string": "Geändert"
}
]
}, },
{ {
"column": "Status", "column": "Status",
"css_classes": "col-sm-1", "css_classes": "col-sm-1",
"show": true, "show": true,
"type": "replace", "type": "replace",
"default_value":"", "default_value": "",
"options": [ "options": [
{ {
"equals": "watched-not-changed", "equals": "watched-not-changed",
"replacement": "<div style='text-align:center'><i class='fa-solid fa-square-check'></i><div></div>" "replacement": "<div style='text-align:center'><i class='fa-solid fa-square-check'></i><div></div>"
}, },
{ {
"equals": "watched-changed", "equals": "watched-changed",
"replacement": "<div style='text-align:center'><i class='fa-solid fa-triangle-exclamation'></i></div>" "replacement": "<div style='text-align:center'><i class='fa-solid fa-triangle-exclamation'></i></div>"
}, },
{ {
"equals": "new", "equals": "new",
"replacement": "<div style='text-align:center'><i class='fa-solid fa-circle-plus'></i></div>" "replacement": "<div style='text-align:center'><i class='fa-solid fa-circle-plus'></i></div>"
}, },
{ {
"equals": "missing-in-last-scan", "equals": "missing-in-last-scan",
"replacement": "<div style='text-align:center'><i class='fa-solid fa-question'></i></div>" "replacement": "<div style='text-align:center'><i class='fa-solid fa-question'></i></div>"
} }
], ],
"localized": ["name"], "localized": [
"name":[{ "name"
"language_code":"en_us", ],
"string" : "Status" "name": [
}, {
{ "language_code": "en_us",
"language_code":"es_es", "string": "Status"
"string" : "Estado" },
}, {
{ "language_code": "es_es",
"language_code":"de_de", "string": "Estado"
"string" : "Status" },
}] {
"language_code": "de_de",
"string": "Status"
}
]
} }
] ]
} }