Terminal (Program Port/Telnet) Commands
105
NX-Series Controllers - WebConsole & Programming Guide
Terminal Commands
The Terminal commands listed in the following table can be sent directly to the Master via either a Program Port or a Telnet terminal
session (with the exception of the "
Help Security
" and "
Resetadminpassword
" commands, which are only available to a Program
Port (RS232) connection.
In your terminal program, type "
Help
" or a question mark ("
?
") and <
Enter
> to access the Help Menu, and display the Program
port commands described below:
Terminal Commands
Command
Description
----- Help ----- <D:P:S>
(Extended diag messages are OFF)
<D:P:S>
: Device:Port:System. If omitted, assumes Master.
? or Help
Displays this list of commands.
ADD AUDIT SERVER [D:P:P]
Adds a remote syslog server for audit messages.
- D: IP address or host name of the remote server
- P: Port number
- P: Protocol (UDP, TCP, or RELP)
Example:
>ADD AUDIT SERVER REMOTESVR:514:UDP
AUTO LOCATE
(ENABLE|DISABLE|STATUS)
Enables/Disables/queries the auto locate feature on the Master.
Auto locate adds additional broadcast information for use by AMX Touch Panel devices configured
in
Auto connect
mode.
BOOT STATUS
Returns the current boot state of the master.
Response is either "Boot in progress." or "Boot complete."
CHANGE PASSWORD
Change your password (requires login).
CLEAR AUDIT
Removes all locally-stored audit records.
See the
CLEAR HTTPS REDIRECT
Clears the HTTPS redirect flag.
See the
CLEAR MAX BUFFERS
Reset the max buffers high-water counters to zero.
CLEAR PERSISTENT VARS
Clear out the persistent/non-volatile variable values without having to download a new NetLinx
program.
CPU USAGE
Diagnostic tool to calculate a running average of the current CPU usage of the Master.
DATE
Displays the current date and day of the week.
Example:
>DATE
10/31/2004 Wed
DATE/TIME ON|OFF
ENABLES/DISABLES the addition of a date time stamp to the terminal logs displayed via "
msg on
"
DATE/TIME is Off by default at the start of each Terminal/Telnet session.
DEVICE DEBUG
Turns the device side traffic debug messages on or off.
DEVICE HOLDOFF ON|OFF
Sets the Master to holdoff devices (i.e. does not allow them to report ONLINE) until all objects in
the NetLinx program have completed executing the
DEFINE_START
section.
If set to
ON
, any messages to devices in
DEFINE_START
will be lost, however, this prevents
incoming messages being lost in the Master upon startup.
When
DEVICE_HOLDOFF
is
ON
, you must use
ONLINE
events to trigger device startup
SEND_COMMAND
s.
By default,
DEVICE_HOLDOFF
is
OFF
to maintain compatibility with Axcess systems where devices
are initialized in
DEFINE_START.
NOTE:
This command sets the state of the device holdoff. The GET DEVICE HOLDOFF command
reveals whether the state is On or Off (see page 107).
Example:
>Device Holdoff ON
Device Holdoff Set.
DEVICE STATUS <D:P:S>
Displays a list of all active (on) channels for the specified D:P:S.
DIPSWITCH
Displays the current state of the Master's hardware dip switches.
DISK FREE
Displays the total bytes of free space available on the Master.
Example:
>DISK FREE
The disk has 2441216 bytes of free space.