CLI usage

Using the command-line

The shell command interpreter stores typed commands in a circular memory. Typed commands can be recalled with the UP/DOWN keys and may be modified with LEFT/RIGHT/INS/DEL keys.

The TAB key may be used to complete a non ambiguous partial command. In case the partial command is ambiguous, hitting TAB twice gives the list of possible commands.

Getting help

The CLI provides a comprehensive help system, which can be invoked in different ways.

Displaying the syntax and detailed help of a specific command

router{}help [full|COMMAND]
full
Give the list of all available commands. This is the default value.
COMMAND
CLI command for which help is expected.

Displaying the list of possible valid entries

router{}COMMAND <?>
COMMAND

Partial CLI command for which you want to know the possible valid entries.

These commands can be called from any context of the CLI.

Examples

router{conf:running-dns}help
Valid commands are:
  delete forwarder all|A.B.C.D|X:X::X:X
  delete log dns SESSION
  delete nameserver all|A.B.C.D|X:X::X:X
  domainname NAME
  forwarder A.B.C.D|X:X::X:X
  help [full|COMMAND]
  log dns SESSION_NAME [SEVERITY]
  nameserver A.B.C.D|X:X::X:X
  proxy enable|disable

router{conf:running-dns}help log dns
Configure DNS log service
Syntax: log dns SESSION [SEVERITY]
  log        Add log to a log session
  dns        Configure log for DNS
  SESSION    Log session name
  SEVERITY   Log session severity
    Possible values for SEVERITY are:
    emergency   Panic condition messages
    alert       Immediate problem condition messages
    critical    Critical condition messages
    error       Error messages
    warning     Warning messages
    notice      Special condition messages
    info        Informational messages
    debug       Debug messages

router{conf:running-dns}

router{conf:running-dns}<?>
Valid entries at this position are:
  delete                   Delete file or configuration item
  domainname               Configure router domain name
  forwarder                Configure DNS forwarder
  help                     Display help information
  log                      Add log to a log session
  nameserver               Configure DNS server
  proxy                    Enable or disable proxy

router{conf:running-dns}log <?>
Valid entries at this position are:
  <Enter>   Execute command
  dns       Configure log for DNS

router{conf:running-dns}log dns <?>
Valid entry at this position is:
  SESSION   Log session name

router{conf:running-dns}log dns session1 <?>
Valid entries at this position are:
  <Enter>     Execute command
  emergency   Panic condition messages
  alert       Immediate problem condition messages
  critical    Critical condition messages
  error       Error messages
  warning     Warning messages
  notice      Special condition messages
  info        Informational messages
  debug       Debug messages

router{conf:running-dns}