beautypg.com

Vi. command line interface (cli) protocol, Outlet commands – SurgeX SX-AX20 User Manual

Page 15

background image

SX-AX15 (20) User Manual

Page 14


VI. Command Line Interface (CLI) Protocol

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

Outlet Commands

Command

Description

Admin

Fact Def

get outlets

Returns the status of ALL the outlets the user has rights to.

Displays all devices and outlets in a cluster configuration.

No

get outlet <1

‐8>

Returns the status of the selected outlet. The user must have
rights to the selected outlet.

No

set outlet <1

‐8>

Sets the selected outlet to the selected state. The user must
have rights to the selected outlet. This command is for units not
used in a cluster configuration. If used in a cluster, it is the
same as device #1.

No

get device <#1

‐#16 | devname> outlet <1‐8>

Returns the status of the selected outlet on the selected Axess.
Device is either the number of the device <#1 to #16> or the
name of the device, as set. Number sign (#) required. The user
must have rights to the selected outlet.

No

set device <#1

‐#16 | devname> outlet <1‐8> Sets the selected outlet on the selected Axess to the selected

state. The user must have rights to the selected outlet.

No

set device <#1

‐#16 | devname> outlet <1‐8> name

Sets the name of the selected outlet of the selected Axess. 20
characters max.

Yes

Outlet <#>

get device <#1

‐#16 | devname> outlet <1‐8> initial.state

Get or set the initial state of the selected outlet of the currently
selected Axess. Initial state is the condition of the outlet when
the Axess is powered up.

Yes

Last

set device <#1

‐#16 | devname> outlet <1‐8> initial.state

This manual is related to the following products: