![background image](http://html.mh-extra.com/html/bang-and-olufsen/ml-gateway/ml-gateway_installation-manual_471057048.webp)
Appendix 48
Command line interface
In addition to the web-based interface, ML Gateway contains a command-line based interface (CLI). Use CLI for:
- Monitoring for events / macros / commands in real time, and without occupying the web-based interface.
- Basic setup of ML Gateway: network settings, MLGW protocol availability, time and date settings.
- Obtaining service information.
- Automating configuration of multiple ML Gateway units.
To access the CLI, use any Telnet client to connect to ML Gateway. The IP address or host name to use is the same as for the web-based interface:
use the IP address of ML Gateway, or the host name mlgw.local if your system implements multicast DNS.
Configure your telnet client for UTF-8 encoding to correctly show international characters. On connection, you will get a log-in prompt. Type the
ML Gateway password to proceed. Several CLI connections may be active simultaneously.
Use the
TAB
key to check for available commands, automatically complete the commands, and getting help for a command. Use the
Esc
key to
cancel a command and get a new prompt.
Available commands
Commands have optional arguments, with the following properties:
- Arguments between brackets ( ‘[‘ and ‘]’ ) are optional.
- Arguments separated by a vertical bar ( ‘c’ ) are mutually exclusive.
- Command names and arguments are case insensitive, except for passwords which are case sensitive.
- Arguments shown in uppercase indicate a literal value.
- Arguments shown in lowercase indicate values you should supply.
HELP [ command ]
- Provides usage information for a command.
- With no arguments, provides help on using the command line interface.
LOGOUT [ ALL |
OTHER ]
- Terminates the CLI session. Ctrl-D can be used equivalently.
- With an argument, terminates all, or all other CLI sessions.
- The
INFO
command shows the number of active CLI sessions.