Befehlsreferenz

REST-Schnittstelle

Die Dokumentation der REST-Schnittstelle kann als Befehlsreferenz herangezogen werden. Die REST API (Programmierschnittstelle) ist in einer JSON-Datei gemäß der OpenAPI-Spezifikation 3.0 dokumentiert.
Sie können die Dokumentation der REST API im Menü Administration → Konfigurationszugriff im Abschnitt Kommandozeile herunterladen.

Bitte beachten Sie!

Die Dokumentation enthält sämtliche Befehle, die in den verschiedenen Konfigurationen und Ausstattungsvarianten des Routers verfügbar sind. Nicht alle enthaltenen Befehle werden von Ihrem Router unterstützt.
Die REST API-Dokumentation gilt nur für Router mit derselben Firmware.

Die Befehle und verfügbaren Optionen lassen sich leicht über die REST API-Dokumentation ermitteln, indem diese Dokumentationsdatei mit einem OpenAPI-Werkzeug geöffnet wird.

Die Vorgehensweise dafür ist am Beispiel der Werkzeuge Swagger und Postman in diesem Configuration Guide beschrieben.

Kommandozeilen-Schnittstelle (CLI)

Die verfügbaren Sektionen und Parameter eines Routers können in der CLI mit Hilfe der Autovervollständigung durch die Tabulator-Taste bequem angezeigt werden. Ein Druck auf die Tabulator-Taste zeigt alle verfügbaren Sektionen der ersten Ebene an (entspricht den Menüs im klassischen Web-Interface). Die Eingabe des/der ersten Anfangsbuchstaben einer Sektion gefolgt von der Tabulator-Taste vervollständigt die Sektion und ein weiterer Druck auf die Tabulator-Taste zeigt alle verfügbaren Sektionen der nächsten Ebene an (entspricht den Seiten dieses Menüs im  Web-Interface). Ein weiterer Druck auf die Tabulator-Taste zeigt mögliche weitere Sektionen oder die verfügbaren Parameter an. Bei Listen wird automatisch die geöffnete eckige Klammer ([) ausgegeben. Wenn diese durch einen Punkt ersetzt wird, gibt ein weiterer Druck auf die  Tabulator-Taste die verfügbaren Listen-Funktionen aus.

Im Folgenden ist die Vorgehensweise für das Ermitteln der Befehle zum manuellen Einschalten der Info-LED beschrieben. Die unten aufgeführten Sektionen und Parameter hängen vom Router und der Version der Applikation ab und können unterschiedlich sein.

1. Öffnen Sie eine CLI-Sitzung

2. Drücken Sie die Tabulator-Taste

   >
   exit
   status
   interfaces
   wan
   routing
   netfilter
   services
   events
   administration
   help 

   Alle verfügbaren Sektionen der ersten Ebene werden angezeigt (vergleichbar mit den Haupt-Menü-Einträgen im Web-Interface).

3. Geben Sie h ein und drücken Sie die Tabulator-Taste

   > help.

4. Drücken Sie die Tabulator-Taste

   > help.
   debug
   support
   oss_licenses 

   Alle verfügbaren Sektionen der zweiten Ebene werden angezeigt (hier nur einer, vergleichbar mit den Unter-Menü-Einträgen im Web-Interface).

5. Geben Sie d ein und drücken Sie die Tabulator-Taste

   > help.debug.

6. Drücken Sie die Tabulator-Taste

   > help.debug.
   ntp_sync
   reboot
   info_led
   message
   sms
   email
   wan_chain
   modem_state
   container_state
   auto_update
   firmware
   profile
   ascii
   timer
   counter
   output
   serge
   port_mirror
   tool 

   Alle verfügbaren manuellen Aktionen werden angezeigt.

7. Geben Sie i ein und drücken Sie die Tabulator-Taste

   > help.debug.info_led.

8. Drücken Sie die Tabulator-Taste

   > help.debug.info_led.
   info_led
   submit 

   Alle verfügbaren Parameter für das manuelle Setzen der Info-LED werden aufgelistet. Der Parameter "submit" ist nur für die Bedienung über das CLI relevant, da er zum Auslösen des Befehls erforderlich ist.

9. Geben Sie i ein, drücken Sie die Tabulator-Taste, hängen Sie ein = an und die drücken Sie die Tabulator-Taste zweimal

   > help.debug.info_led.info_led=
   flash
   off
   on 

   Alle verfügbaren Optionen Setzen der Info-LED werden aufgelistet.

Für das Einschalten der Info-LED über die REST-Schnittstelle ergibt sich also folgende Syntax:

POST /api/v2_0/operation
{
 "method" : "manual_action",
 "params" : {
  "type" : "info_led",
  "options" : {
   "info_led" : "on"
  }
 }
}

Die CLI-Befehle zum Einschalten der Info-LED haben dann folgende Syntax:

> help.debug.info_led.info_led=on   
> help.debug.info_led.submit