Thinklogical Router - ASCII-API - Manual (Page 13)

XOPTIONS
This command returns a numeric response that is a bit map of options available in the version of the api. The value
returned is a four digit decimal number of the binary bit map. For example if the value returned was 0015, then bits 0, 1,
2, and 3 would be on (bit 0 is the lsb).
The following bits are defined:
0 HDX Sync card may be installed. This is set for the HDXRouters.
1 XTEST2 command is allowed. This is set for the Vx320 Router.
2 only upper case commands are allowed.
3 XMAXCARDS returns the total number of cards allowed in the router, not ½ the number.
This is set for the Mx family of routers.
4 Router supports point-to-point connection mode.
Format: XOPTIONS
Example Results:
 R0007OK0007
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.
Sample response:
C,D,S - upstream to downstream or upper shelf path
c,d,s - downstream to upstream or lower shelf path
{C|c}IxxxxOyyyyO... - Connect Input O9999 broadcasts port xxxx
{D|d}Ixxxx... - Disconnect Input(s) I9999 disconnects all
{D|d}Oyyyy... - Disconnect Output(s) O9999 disconnects all
{S|s}Ixxxx - return list of output ports
{S|s}Oyyyy - return input port
XGET - return switch status of all the ports
XPUT{I|i}xxxxyyyy... - restore switch status (from XGET)
I - upstream to downstream or upper shelf path
i - downstream to upstream or lower shelf path
MiiiiOOOO...[;iiiiOOOO...] - Macro command ports after the 'M' are the upper ports,
after the ';' are the lower ports
iiii equal to zero means disconnect the output
oooo equal to zero means disconnect the input
XVERSION - return software version
XINSTALLED - return list of installed cards
XMAXCARDS - return max. num of cards
XMAXPORTS - return max. num of ports
XDCSTYPE - return Vx160Router
XLASTEVENT - return timestamp of when VxRouter status last changed
XPORTCONFIG - returns a string with 3 numeric values: NU,NB,OFF
NU = number of uni-directional paths
NB = number of bi-directional paths
OFF = is not used and returns 0
A VxRouter contains 1*NU or 2*NB paths
XRESET - resets the switch hardware to the initial poweron state
XALARM - returns an alarm bit mask (0 means no alarms), bits are system
dependant
XTEST1 - diagnostic test 1 - connect 1 to 1, 2 to 2, ... n to n
XCRON - turn on CR's
XCROFF - turn off CR's
Jun 12, 2014 Router ASCII API: V4.5-1 12/33