Command line interface (cli) protocol, 1 prompts, 2 syntax – SurgeX SX-AX20E User Manual

Page 21: 3 responses, 4 cli documentation notation, User manual

Advertising
background image

© 2015 SurgeX/Electronic Systems Protection, Inc. | Technical Support: 800-645-9721 | surgex.com 21

User Manual

Firmware Version v2.04.281

6. Command Line Interface (CLI) Protocol

The Command Line Interface provides complete setup of all functions of the Axess Elite. The CLI may be accessed either via the network interface using Telnet, or via
the serial port using a terminal emulator program. Some commands of the CLI require administrative rights; these are indicated in the following tables.

6.1

Prompts

Prompt

Description

User>

Prompt to enter a valid User Name. Not case sensitive.

Password>

Prompt to enter the Password associated with the User Name. Case sensitive.

Axess ELITE>

Standard prompt while logged in.

Axess ELITE Reboot Required>

Prompt after making a change which requires a reboot to take effect.

6.2

Syntax

Command

Description

Standard Syntax

Set

This command is used to change a parameter.

set <variable> <specifier>

<value>

Get

This command is used to return the value of a parameter.

get <variable>

Add

This command adds an entry row to any array of variables.

add <array> <newentry>

Ren

This command renames an entry in an array.

ren <array> <oldname>

<newname>

Del

This command deletes an entry from an array.

del <array> <entryname>

6.3

Responses

Response

Description

OK

The command was received and the syntax was validated.

Error

The syntax could not be validated.

Bad command or parameter

An incorrect command or parameter was received.

Invalid Command

An invalid command was received.

6

.4

CLI Documentation Notation

Notation

Description

Text without brackets

Items you must type as shown

<Text inside angle brackets>

Placeholder for which you must supply a value

Hyphen: -

Range of acceptable numeric values

Vertical Bar: |

Separator for mutually exclusive items; choose one

Advertising
This manual is related to the following products: