Command Line Interface; Generic Command - Eaton Network Management Card User Manual

6.4 Command Line Interface

Command Line Interface (CLI) API provides functions for building and processing a user-defined HMI. To use the
CLI, the parameter "HMI type" has to be equal to "CLI".
When opening a new session, TELNET or SSH, a specific prompt "#>" is sent to the client. The user can enter a
command. If the command is recognized, it is processed, else a warning message is sent to the client.
The syntax used is based on that already implemented for the XML description of objects. The blank character is
not allowed in command arguments except for the strings. The strings are in double quotes ("").
The code colour is the following:
•
Setting in read-write or write-only mode: light green
•
Setting in read-only mode: yellow
•
Warning message: green
•
Error message: light red
The recognized commands are given in the following chapters and may be updated later.
6.4.1

Generic command

6.4.1.1 "help" and "?"
Purpose Display help about a specific command.
Syntax help [command] or [command] ?
Examples #> help getNetwork
#> getNetwork ?
6.4.1.2 "setEcho"
Purpose Hide, or not, all characters. If hidden, each character entered is replaced by an '*'
Syntax setEcho [option]
option :
ON
OFF
Examples #> setEcho ON
6.4.1.3 "quit"
Purpose Close a current CLI session
Syntax quit
Examples #> quit
6.4.1.4 "reset"
Purpose Software reset
Syntax reset
Network Management Card
– User Manual 34003991XT_EN/EF
Page
92/127