Online-Hilfe

Einfügen von Werten in Meldungen und Pfade

Status-Informationen, Ereignis-abhängige Informationen sowie die Parameter der Konfiguration können als Variablen im Nachrichtentext von SMS- und E-Mail-Meldungen, in der Betreff-Zeile einer E-Mail-Nachricht sowie in Endpunkt und Request-Body von HTTP-Requests eingesetzt werden. Ereignis-abhängige Informationen können nur von dem Ereignis verwendet werden, durch das die Meldung ausgelöst wurde. Es ist außerdem möglich, Werte in den Pfad für die Download-Liste auf einem Auto-Update-Server einzubinden.

Das Einfügen der Werte erfolgt durch CLI-Befehle im Ausdruck $cli() oder REST-Anfragen im Ausdruck $rest(). Groß- und Kleinschreibung wird dabei berücksichtigt.

Einfügen in Meldungen und HTTP-Requests

Dabei wird der Ausdruck für die Variable mit der Rückgabe eines CLI-Befehls oder einer REST-Anfrage ersetzt. Während mit dem CLI-Ausdruck die Rückgaben sämtlicher CLI-Befehle in den Text eingefügt werden können, können mit der REST-Anfrage nur die Rückgaben von Status-Endpunkten eingefügt werden. Folgende Einschränkungen gelten für die jeweiligen Meldungstypen:

CLI-BefehlREST-Anfrage
SMS-Nachrichtentext    
E-Mail-Betreff    
E-Mail-Nachrichtentext    
HTTP-Request-Endpunkt    
HTTP-Request-Body    

Beispiel für einen Meldungstext, der die aktuelle Systemzeit im Router in einer Meldung ausgibt:
Die aktuelle Systemzeit ist $cli(status.sysdetail.system.date).

Beispiel für einen Meldungstext, der mit Hilfe Ereignis-abhängiger Informationen in einer Meldung ausgibt, wann sich welcher Benutzer an welchem Standort anmeldet:
Der Benutzer $cli(events.info[username]) meldete sich um $cli(administration.time.time) am Standort $cli(administration.hostnames.location) an.
Dazu muss die Meldung durch ein Ereignis Anmeldungsversuch erkannt - erfolgreich im Rahmen einer Aktion ausgelöst werden.

Beispiel für einen Meldungstext, der mit Hilfe verschachtelter Ereignis-abhängiger Informationen in einer Meldung ausgibt, welches Ereignis aufgetreten ist:
Das Ereignis $cli(events.event_config.event[$cli(events.info[event_id])].description) ist aufgetreten.
Dabei wird die Nummer des abgefragten Ereignisses über die Ereignis-abhängiger Information $cli(events.info[event_id]) in die Abfrage der Beschreibung des Ereignisses eingesetzt.

Wenn zum Beispiel in einen Meldungstext der Ausdruck $rest(/status/sysdetail/system) eingefügt wird, wird an Stelle des Ausdrucks folgende Rückgabe eingesetzt:
{
 "status": {
  "unique": {
   "location": "Regensburg",
   "date": "2025-02-27 11:32:30",
   "uptime": "21 min 1 s",
   "load": "3.30 2.95 1.96",
   "ram": "30964 kByte free",
   "hash": "2C637FC2",
   "mac": "00:05:B6:06:82:61",
   "remote_management": "inactive",
   "remote_management_uptime": "",
   "time_status": "manually_set",
   "signature_required": "inactive",
   "device_virgin": "0",
   "profile_mode": "permanent",
   "flash_mode": "SLC",
   "flash_status": "OK",
   "hostname": "insys",
   "classic_ui_active": "1",
   "device_note": "",
   "minimum_fw_version": "6.9",
   "boots_since_production": "2406",
   "boots_since_reset": "1",
   "operating_hours": "735h:45m",
   "online_count_since_production": "1056",
   "online_count_since_reset": "0",
   "online_count_since_boot": "0",
   "last_online_time": "never"
  }
 }
}

Einfügen in einen Pfad

Beispiel für die Verwendung der Seriennummer des Routers, um einen gerätespezifischen Pfad auf dem Auto-Update-Server zu generieren:
/updates/$cli(status.device_info.slot[1].serial_number)/list.txt

In diesem Fall wäre der resultierende Pfad: /updates/12345678/list.txt (bei einer angenommenen Seriennummer von 12345678)

Zurück zur Übersicht