Vii. command line interface (cli) protocol, Prompts, Control commands – SurgeX SX-20NE-RT-AR User Manual

Page 19: Device commands

Advertising
background image

SX-20NE-RT-AR User Manual

Page 18


VII. Command Line Interface (CLI) Protocol

The Command Line Interface provides complete setup of all functions of the AR. The CLI may be accessed through the Telnet
protocol, and requires a Telnet client program. Some commands of the CLI require administrative rights; these are indicated in the
following tables.

Prompts

Prompt

Description

User>

Prompts the user to enter the user name (either user or admin).

Password>

Prompts the user to enter the password.

Axess Ready>

Prompt displayed while logged in.

Axess Ready Reboot Required>

Prompt displayed after changes have been made that require a reboot. This
prompt will remain active until the AR has been rebooted.

Control Commands

Command

Description

Admin

Fact Def

get outlet

Returns the current status of the outlet.

No

set outlet < on | off | cycle >

Sets the outlet to the selected state.

No

Device Commands

Command

Description

Admin

Fact Def

get location

Returns the location ID.

Yes

Axess
Ready

set location < 20 character max >

Sets the location ID.

Yes

get cycle

Returns the cycle time currently in use in seconds.

Yes

10

set cycle < 1-999 >

Sets the cycle time in seconds.

Yes

get upgrade enable

Returns the upgrade enable status.

No

Disabled

set upgrade enable < yes | no >

Enables or disables the ability to upload new
firmware.

Yes

Logout

Terminates the telnet session.

No

Reboot

Reboots the AR.

Yes

Advertising