TLX Matrix Switch ASCII API V5 14 Rev. I, January 2019
XHELP
Print a list of valid commands. This is a multi-line response that does NOT start with OK or ER or end with a
length. It is intended as a debugging aid and not for use in a production environment. It does not follow
the format rules for command responses. Format: XHELP
Sample response:
Version: V5.07.07 (build: 8)
Usage: tlx320api [options]
---- network options ----
-L|--listen[=]port listen on this port, all addresses (default: 17567)
-N|--connections[=]n set the maximum number of open connections allowed (default: 128)
--mcast[=IP address] replace broadcasts with multicast to this IP address (default:
239.255.13.9)
--noexternalapi only listen on 'localhost' for API connections
--noexternalbcast send the port status only on 'localhost'
---- serial options ----
-S|--serial=device use this serial device (default: /dev/ttymxc1)
--serial=none disables the API serial port /dev/ttymxc1
-B|--baud[=]speed sets serial baud rate (default: 9600)
---- generic options ----
--CR output CRLF instead of just LF (network connection only)
--facility[=]name syslog facility reporting level (default is local4)
valid names: auth, daemon, user, local0 through local7
see the man page for rsyslog.conf for more information
-D|--debug write debug messages to the log file (multiple options increase the
debug level)
--api write API messages received to the log file (level: NOTICE)
--avr write control commands to the log file (level: NOTICE)
--clog write connection status changes to the log file (level: NOTICE)
--log_ip include the IP address with each API message that is logged (level:
NOTICE)
--delay[=]delay in ms, how long an output must remain off, default is 300 ms.
minimum is 50ms, maximum is 1000ms, 0 will disable the delay
-b|--bcast[=]period in ms, how long between port status broadcasts, default is 4000 ms.
minimum is 500, maximum is 15000, 0 will disable the broadcast
if multicast is enabled, it will use this time setting
--bcast=0 will disable: broadcasts, multicasts, and the 'restore
connections' feature to disable network broadcasts but keep the
'restore' feature, use the --noexternalbcast option
--idle[=]seconds network connections idle for at least these many seconds are
candidates to be forcibly closed when a new connection is made and there
are no available sockets. Setting it to 0 will disable this feature. The
default setting is 60 seconds.
-V|--verbose enable error text in responses
-h|--help display this help and exit
-v|--version output version information and exit
Default (no options) is to listen on socket 17567 at all IP addresses
send to socket 27567 at 127.0.0.1
accept commands from the RS232 port
broadcast switch status every 4000 milliseconds on port 17564
signal SIGUSR1 will toggle api debug logging (--api)
signal SIGUSR2 will toggle control debug logging (--avr)
signal SIGHUP will force the API to reread the P2P csv files located in /var/local/router/p2p/
To Next Page
Loading...
Need help?
General