Online Help

Determining the command syntax for CLI and REST interface

The syntax of the available commands can easy be found out using the auto-complete function of the CLI.

The following describes the proceeding for determining the commands for manually enabling the Info LED. Below listed sections and parameters depend on the router and the version of the application and may differ.

• Open a CLI session
• Press the Tab key
  >
  exit
  status
  interfaces
  wan
  routing
  netfilter
  services
  events
  administration
  help
  All available sections from the first level are displayed (comparable to the main menu entries in the web interface).
• Enter "h" and press the Tab key
  > help.
• Press the Tab key
  > help.
  debug
  support
  oss_licenses
  All available sections from the second level are displayed (only one here, comparable to the sub-menu entries in the web interface).
• Enter "d" and press the Tab key
  > help.debug.
• Press the Tab key
  > 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
  All available manual actions are displayed.
• Enter "i" and press the Tab key
  > help.debug.info_led.
• Press the Tab key
  > help.debug.info_led.
  info_led
  submit
  All available parameters for manual setting of the Info LED are displayed. The parameter "submit" is only relevant for CLI operation since it serves for triggering the command.
• Enter "i", press the Tab key, append an "=" and press the Tab key twice
  > help.debug.info_led.info_led=
  flash
  off
  on
  All available options for setting the Info LED are displayed.

Therefore, the following syntax results for enabling of the Info LED via REST:
POST /api/v2_0/operation
{
 "method" : "manual_action",
 "params" : {
  "type" : "info_led",
  "options" : {
   "info_led" : "on"
  }
 }
}

Then, the CLI commands for enabling of the Info LED have the following syntax:
> help.debug.info_led.info_led=on
> help.debug.info_led.submit

Back to overview