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

Page 16

Advertising
background image

Page 15

SX-AX15 (20) User Manual



VI. Command Line Interface (CLI) Protocol

(continued)

User Commands


Command

Description

Admin

Fact Def

get users

Return a list of all current users.

Yes

get user <username>

Returns the selected user’s details.

Yes

add user <username>

Add a user to the root Axess user table. 16 users
maximum. 20 Characters max.

Note: the new user’s password will default to the same as
the username.

Users default to no rights to any outlets. Add user rights to
outlets and groups.

Yes

del user <username>

Deletes the selected user from the root Axess user table.

Yes

ren user <username> <newname>

Renames the selected user in the root Axess user table.

20 character max.

Yes

set user <username> device <#1

‐#16 | devname | all>

outlet <1

‐8 | all> <yes | no>

Sets the user’s right to the selected outlet on a specific
device.

Yes

No Rights

set user <username> group <name> <yes | no>

Sets the user’s rights to the selected group.

Yes

No Rights

set user <username> role <admin | user>

Sets the user’s role.

Yes

User

set user <username> password <password> <confirm>

Sets the user’s password. 20 characters max.

Yes

User’s Name

set user <username> email <address>

Sets the user’s email address for the root Axess to send
alerts to. 64 characters max.

Yes

set user <username> sendmail <yes | no>

Enables or disables the user’s receipt of email alerts.

Yes

No

set user <username> pin <pin>

Sets the user PIN for DTMF control. 4 – 10 digits.

Yes

Advertising
This manual is related to the following products: