Online-Hilfe

Ermitteln der Befehls-Syntax für CLI und REST-Schnittstelle

Die Syntax der verfügbaren Befehle lässt sich leicht über die Autovervollständigung im CLI herausfinden.

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.

  • Eine CLI-Sitzung öffnen
  • Tabulator-Taste drücken
    >
    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).
  • "h" eingeben und Tabulator-Taste drücken
    > help.
  • Tabulator-Taste drücken
    > 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).
  • "d" eingeben und Tabulator-Taste drücken
    > help.debug.
  • Tabulator-Taste drücken
    > 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.
  • "i" eingeben und Tabulator-Taste drücken
    > help.debug.info_led.
  • Tabulator-Taste drücken
    > 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.
  • "i" eingeben, Tabulator-Taste drücken, ein "=" anhängen und die Tabulator-Taste zweimal drücken
    > 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 REST 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

Zurück zur Übersicht