Command language

Introduction

Abilis CPX configuration and supervision are made through the Control Port: after opening the connection, it is possible to send commands and get answers. This paragraph describes the main rules that set up the command language of the Control Port commands interpreter.

Login levels of the Control Port

it is possible to log in to the Control Port by using three different privilege levels, each of them has got a set of allowed operations:

• User login level (USER): it is possible to execute only some supervision operations; execution of commands not allowed for the user login level will cause the message "COMMAND NOT ALLOWED FOR USER LOGIN LEVEL" to be displayed.
• Administrator login level (ADMINISTRATOR): user is allowed, with some restrictions, to execute all the configuration and supervision commands; execution of commands not allowed for the administrator login level will cause the message "COMMAND NOT ALLOWED FOR ADMINISTRATOR LOGIN LEVEL" to be displayed.
• Super-User login level (SUPERUSER): user is able to completely manage the system; execution of any configuration or supervision command is possible.

The following paragraphs will show the login level that can execute the commands provided by the Control Port commands interpreter.

Commands

A command is represented by a series of characters, ending with <CR> (carriage return), sent to Abilis CPX.
The answer is a series of characters sent by Abilis CPX, which contains the requested information; every answer is ended by a line containing the prompt of the Control Port commands interpreter.

In the following examples the highlighted characters are sent to Abilis CPX, the others are sent by Abilis CPX.

[11:33:39] ABILIS_CPX: D P PO:1 <CR>

PO:1   ------------------------------------------------------------------------
SYNC   LOG:DS      int:V35     CLK:INT        SP:19200     CODING:NRZ   MPX:NO 
       IDLE:FLAG   FDCD:500    FCTS:500       mode:FULL    RTSDLY:0     CD:NO  
       E1-FRAMING:CRC4         HAUL:SHORT                                      
       CH:0-31                                                                 
       frame:2100  d-rxbuf:14  dma-rxbuf:10   dma-txbuf:1                      

[11:33:39] ABILIS_CPX: S P PO:1 SP:19200 <CR>

COMMAND EXECUTED

[11:33:39] ABILIS_CPX: S P PO:1 FRAME:4000 <CR>

PO:1 INVALID VALUE 'FRAME:4000'

Commands are divided into the following groups:

Excluding the system commands, each command executes its action on objects.

Objects are divided into the following classes:

Excluding the system commands, the others observe the following simple rule for setting the command:

<group ID>_< class ID>_[parameter:value]_..._[parameter:value]

where "_" stands for space character.

Each class can accept all the commands groups or only a part of them; a detailed list in given later on. Regarding parameters and the allowed values for each coupling group/class, it is necessary refer to the proper section, which deal with them.

System commands do not follow the rules above mentioned. The consequences, those commands could have on system operating mode, suggested to ask for their extended digitation, in such way, to reduce to the minimum the chances to send them by mistake.

System commands are, in alphabetic order, the following:

Help online

For all commands, either if they are system commands or not, a contextual online help function is available. By typing the "?" character, all the information, needed to correctly compose the commands, are displayed.

As already mentioned, the help function is contextual, this means the help message displayed depends on the "?" character position in the command line. If, for example, only the "?" character is digitated, a list of key words that can be placed at the beginning of the command row is displayed. A brief description of them is also given:

[11:33:39] ABILIS_CPX: ?

ALARM          Alarm operations
A              Add operations
BOOT           Boot operations
C              Clear operations
CALL           Open a Connection
CLOSE          Close current CP session
CONFLOG        Configuration and log files backup/restore
COPY           Copy port configuration
D              Display operations
DEBUG          Debug operations
DISC           Close a Connection
F              Find operations
FILE           File copy/delete/get/put operations
INIT           Init operations
IPTRACE        TCP/IP Trace operations
LIST           Lists operations
LOGIN          Log-in operations
LOGOUT         Log-out operations
M              Move operations
PAR            Active Parameter operations
PING           Ping command
RESTART        System Restart operations
R              Restart operations
S              Set operations
SAVE           Save operations
SOUND          Sound disable/enable operations
START          Start real-time logging operations
SYS            System operations
TRACE          Trace operations
TRACERT        Trace route command
VALIDATE       Current configuration validation
WARM           System warm start operations

Inserting the "?" character in a more advanced position in the command line, only those key words and their description, allowed by the command language to be place in that position and after on, will be displayed.

For example, if "?" is digitated after the key word "ALARM", a list of all the key words, allowed to be placed after "ALARM", is displayed:

[10:07:11] ABILIS_CPX: ALARM ?

VIEW           Alarm view
RESET          Alarm reset

The following example shows how it is possible, through digitation "?" in successively different positions, to have a complete description of setting the "Add" SVC routing command:

[11:36:27] ABILIS_CPX: A ?

CRKEY:         Encryption/Decryption key identifier [1..63]
D              IP and/or CPX ports description
DHCP           DHCP profile/subnet/host
EG             EIR Group
ER             EIR Routing
FTP            FTP Virtual root paths/path's access Rights
HTTP           HTTP Virtual root paths/path's access Rights
IPACL          IP Access List
IPAD           IP Routing Administrative Distance
IPP:           IP Port identifier [0..63]
IPR            IP Routing
LIST:          CPX list name
NAT            NAT alias entry
OSPF           OSPF area/range/neigh/host/external route
PVC            PVC Connection
R              SVC Routing
RIP            RIP external route
TDM            TDM Switch
USER:          User name. Max. 32 ASCII characters.
VD             VOICE Data port
VG             VOICE Group
VR             VOICE Routing
WGB            WG Bridge Routing

[11:36:31] ABILIS_CPX: A R ?

PR:            SVC Routing priority [0..99]

[11:36:31] ABILIS_CPX: A R PR: ?

SVC Routing parameters:

POI:       Input port [0..999, *, NONE]
CGI:       Input calling address [0..9, *, #, ?, 'list']
CDI:       Input called address [0..9, *, #, ?, 'list']
UDI:       Input user data field [0..9, a..z, A..Z, *, #, ?, 'list']
PIDI:      Input PID [Hexadecimal, *, #]
POO:       Output port [0..999, *, #, NONE]
CGO:       Output calling address [0..9, *, #]
CDO:       Output called address [0..9, *, #]
UDO:       Output user data field [0..9, a..z, A..Z, *, #]
PIDO:      Output PID [Hexadecimal, *, #]
FFO:       Output Facility field [Hexadecimal, *, #]
COMP:      Compression protocol [NO, MBIT, QLLC]
NEXT:      Alternative routing indication [N or NO, Y or YES]
IPDEST:    Destination Ip Address [0-126.x.x.x, 128.x.x.x-223.x.x.x, #]
IPSRC:     Source Ip Address [0-126.x.x.x, 128.x.x.x-223.x.x.x, *, 'list']

[11:36:31] ABILIS_CPX: A R PR:1 POI:301 POO:302

COMMAND EXECUTED

Configuration validating

Configuration validating has been introduced to ensure correct Abilis CPX configurations.

By validation it is meant the explicit execution of a series of congruence controls made by Abilis CPX on all the configuration information.

Base controls on the type and the interval of values, allowed by the configuration parameters, are implicitly carried out by configuration commands, however exists a series of verifications that cannot be executed during the normal routine of configuration. That's why is available a procedure that activates a set of deepened and more complete controls. Particularly, configuration parameters of cards and boards are subject to validation.

The output of the validating procedure can be positive without demanding modifications to the configuration, or it is possible that the validation detects some incongruency or imprecision in the configuration.

If the validation detects imprecision that it can directly correct, the outcome of the command is however positive. But in such case, the procedure expects the displaying of informative messages which signal the changes, made on the configuration during the validation, to the User.

If the validation detects serious incongruencies, in the configuration, that cannot automatically be corrected, the outcome of the command is negative. In such case the procedure expects the displaying of error messages for signalling the detected errors to the User.

A command for the explicit execution of the validating procedure exists; moreover configuration commands implicitly execute configuration validating before saving it on disk. The commands, which execute this procedure, are:

Here are some examples about the execution of implicit and explicit validation.

Example N.1

The following example shows a successful explicit validation; the procedure required some changes in the configuration (changing parameters values owing to other parameters values either of the same port or different ports connected to it; or caused by incongruency with the port

[11:36:31] ABILIS_CPX: VALIDATE

VALIDATION IN PROGRESS ...
PO:201 changed "N1" from 144 to 528 because PO:301 "PS" = 512
PO:1 changed "FRAME" from 144 to 528 because PO:201 "N1" = 528
PO:1 changed "CODING" from NRZI to NRZ because PO:201 is LAPB
VALIDATION SUCCESSFULLY EXECUTED

The procedure has modified the value of the parameter "N1:" of port 201 since it is in relation with parameter "PS:" of port 301 connected to it.

The procedure has modified the value of parameter "FRAME:" of port 1 since it is in relation with the parameter "N1:" of port 201 connected to it.

The procedure has modified the value of parameter "CODING:" of port 1 since it is in relation with the type of port 201 connected to it.

Example N.2

The following example shows an explicit validation failed because of some, particularly serious, errors detected in the configuration (inconsistent setting of two parameters of the same port, incongruency between the parameter and the port type, sharing resources among two or more ports):

[11:36:31] ABILIS_CPX: VALIDATE

VALIDATION IN PROGRESS ...
ERROR: PO:1 conflicting setting between "CODING" = NRZ and "CLK" = PCLK
ERROR: PO:302 invalid "LOWPO" = 321 type
ERROR: PO:321 "LOWPO" = 1 crossed setting
VALIDATION FAILED

The procedure has detected a conflict between the value assigned to the parameter "CODING:" and the one given to "CLK:" of port 1.

The procedure has detected the type of port 321, connected to port 302 through the parameter "LOWPO:", to be not valid.

The procedure has detected that the parameter "LOWPO:" of port 321 has been assigned to a number of port already in use.

Example N.3

The following example shows an unsuccessful configuration saving because the implicit validation procedure, that has been executed, failed:

[11:36:31] ABILIS_CPX: SAVE CONF

VALIDATION IN PROGRESS ...
ERROR: PO:1 conflicting setting between "CODING" = NRZ and "CLK" = PCLK
ERROR: PO:302 invalid "LOWPO" = 321 type
ERROR: PO:321 "LOWPO" = 1 crossed setting
PO:202 changed "LOWPO" from 2 to NONE because PO:202 not used
VALIDATION FAILED

SAVE NOT EXECUTED

The saving procedure of current configuration has implicitly executed the validating configuration.

The validation procedure has detected, in the current configuration, some errors not recoverable: it failed.

The saving procedure has not been executed.

Example N.4

The following example shows a saving procedure of configuration for testing it. It is successful, even if the implicit validation procedure, executed by it, has detected some configuration incongruency:

[11:36:31] ABILIS_CPX: SAVE CONF TEST

VALIDATION IN PROGRESS ...
PO:1 changed "FRAME" from 144 to 2100 because PO:321 is SDLC
PO:1 changed "L1RXBUF" from 14 to 10 because PO:321 is SDLC
PO:201 changed "LOWPO" from 1 to NONE because PO:201 not used
VALIDATION SUCCESSFULLY EXECUTED

SAVE TEST EXECUTED

The saving procedure of configuration for testing has implicitly executed a validation of configuration.

The validation has detected recoverable incongruency in the current configuration, it made the needed changes and it was successful.

The saving procedure of configuration for test aim has been executed.

Complete list of commands in alphabetical order

Print this page