Matrix CLI
The Matrix command line interface offers control of the appliance and software that can be scripted or entered manually for those who prefer terminal windows over graphical interfaces.
Although many command line interfaces share similarities, each is also unique to the product. Use this section to learn about how to start a CLI session; the command structure, command completion, control characters; the online help and the conventions used to document the Matrix CLI.
 
Conventions used in this document:
Commands typed by the user will be shown in Bold Courier
Output from the CLI will be display in Courier
The CLI command prompt will be shown by '#'
Commands are written in red.
Angled brackets < and > surround required arguments.
Square brackets [ and ] surround optional arguments.
Parentheses ( and ) denote a choice.
Choices are separated by a vertical bar |.
Where multiple parameters may be specified an ellipsis is used.
Double quotes " " are required for any name or description containing a space.
 
 
Starting a CLI session
A new session can be started from a Linux terminal session using the following command:
ssh username@ipaddress
Example: $ ssh admin@10.0.64.33
Example: $ ssh -l admin 10.0.64.33
On Windows, putty can be used start a new CLI session with the Matrix.
 
 
CLI Command Structure
The commands in the CLI are organized in a hierarchical structure which groups together common commands under a parent command name. A list of all commands with description (that are available to the user) can be viewed by typing help all. Only commands available in the current operating mode and privilege level can be executed and viewed. Each command may have one or more additional arguments.
Only the first part of the command needs to be typed if it uniquely identifies the command in the CLI. For example, the command to set terminal timeout can be typed as:
matrix_host# terminal timeout
3600

matrix_host# terminal t
3600

matrix_host# term time
3600

matrix_host# t t 3600
Each command and argument must be separated by at least one space. If the argument includes a space in the value, then it must be enclosed in double quotes (" ").
Some commands that take a variable number of arguments have the format id=value. Where id is the setting and value is the value to set. If the value contains a space, then it must be enclosed by quotes: id="This is a value with spaces".
 
 
Command Help
Help and usage information can be displayed for each of the CLI commands.
To display a short 1-line description of the command type the command string immediately followed by a '?'.
Example:
matrix_host#  terminal timeout?
timeout Set timeout period for this session
To display the usage description of the command, type the command string followed by a space and '?'.
Example:
matrix_host# terminal timeout ?
Usage:
terminal timeout <TimeOut>


Description:
Set terminal timeout value in seconds. The CLI will timeout after this number of
seconds have elapsed with no user activity.


Parameters:
TimeOut Timeout period in seconds (0=disable timeout)


Examples:
1) Set timeout period to 1 hour
matrix_host# terminal timeout 3600
2) Disable timeout
matrix_host# terminal timeout 0
The usage description of the command shows usage information of the command, a full command description, a description for each argument and examples.
 
 
Command Completion
Only the first part of a command that uniquely identifies a command needs to be typed in order for it to be recognized. A partially entered command can be completed by typing a single TAB. If unique, the full command will be displayed on the command line. To show a list of sub commands or a list of commands that complete a partially entered command, press TAB twice.
If a full command has been entered on the command line and the there are required arguments. Double TAB will either show a list of acceptable arguments or will display the current setting for that argument.
 
 
Control Characters
There are a number of special control characters that serve special purposes in the CLI.
Ctrl-A Moves cursor to start of line.
Ctrl-B Moves cursor left one character (left-arrow).
Ctrl-C Kills the CLI session if it in unresponsive.
Ctrl-D Ends CLI session.
Ctrl-E Moves cursor to end of line.
Ctrl-F Moves cursor right one character (right-arrow).
Ctrl-H Deletes one character to the left of the cursor (Backspace).
Ctrl-K Deletes characters from cursor to end of line.
Ctrl-L Redraws line.
Ctrl-N Recalls next history line (down-arrow).
Ctrl-P Recalls previous history line (up-arrow).
Ctrl-U Clears line.
Ctrl-W Deletes left to the next word boundary.
Ctrl-X Cancels the current operation.