1 cli syntax – GAI-Tronics VoIP Telephone Software Configuration Guide User Manual

Page 73

Advertising
background image

GAI-TRONICS

VoIP Telephone Configuration Guide

Page 73 of 88

9.1 CLI

Syntax


The Command Line interface will provide a Command Line Prompt as shown below: -

[UNIT IDENTIFIER]>>


The unit identifier is a configuration option that provides a user configurable name up to a
maximum of 32 characters that can be used to identify the unit. By default the Unit identifier
is set to "UNNAMED".

The command line interface syntax consists of three parts, a module name, an action verb
and a variable set of action parameters. Each command is terminated by a carriage return.

[Module Name] < Action Verb > < Parameter List > [CR]


Although each module name or action verb may consist of several letters, only sufficient
letters to uniquely identify the module name or action verb are required. For example to enter
the module name LOCAL, only three characters LOC are required to differentiate it from the
module name LOGIC.

The module names are the same as the section names listed in section 6.1.

If a module name is entered without an action verb to follow, the command line focus enters
the module name given, for example the command: -

UNIT [CR]


Will cause the command line interface focus to enter the UNIT module, and the Command
line prompt will change to:

[UNIT IDENTIFIER]>>UNIT>>


When the Command line focus is within a specific module, then only the action verbs specific
to that module will be effective. To return focus to the highest level, use:

EXIT [CR]


A list of all the commands applicable to the current module can be obtained by:

HELP [CR]


Some commands allow multiple parameters. For example to set both KEY SET INHIBIT
DIGIT and KEY SET INHIBIT MEMORY, enter them together in one command by placing a +
sign between the parameters, as KEY SET INHIBIT DIGIT + MEMORY. Entering KEY SET
INHIBIT DIGIT and KEY SET INHIBIT MEMORY separately would cause the last entered
command to overwrite the earlier one.

Command parameters that can be combined in this way are indicated by a + sign following
their definition.

A history of the last 100 commands issued can be obtained by using:

HISTORY[CR]


The history list is accessed using the up and down arrows on your keyboard.

In all of the following actions where the action is SET, the SET can be replaced with SHOW
along with the first parameter to display the individual configuration information.

3XE

D

Advertising