Thinklogical Router - ASCII-API User Manual
Page 2
Table of Contents
Overview.................................................................................................................................................................. 3
HDX switch support.............................................................................................................................................3
MX switch support............................................................................................................................................... 3
XOPTIONS command......................................................................................................................................... 3
Conventions............................................................................................................................................................. 4
Port numbers...................................................................................................................................................... 4
Results................................................................................................................................................................ 4
Upper vs. Lower case..........................................................................................................................................5
Commands.............................................................................................................................................................. 6
Connection commands........................................................................................................................................ 6
Connect.......................................................................................................................................................... 6
Disconnect..................................................................................................................................................... 6
Frame Synchronize........................................................................................................................................ 6
Status............................................................................................................................................................. 7
XGET............................................................................................................................................................. 7
XPUT............................................................................................................................................................. 7
Macro............................................................................................................................................................. 8
XSTATUSIO and XSTATUSOI........................................................................................................................ 8
System Information commands...........................................................................................................................9
XVERSION..................................................................................................................................................... 9
XINSTALLED.................................................................................................................................................. 9
XDCSTYPE.................................................................................................................................................... 9
XMAXPORTS................................................................................................................................................. 9
XLASTEVENT.............................................................................................................................................. 10
XPORTCONFIG........................................................................................................................................... 10
XALARM...................................................................................................................................................... 10
XRESET....................................................................................................................................................... 10
XCRON and XCROFF.................................................................................................................................. 11
XMAXCARDS............................................................................................................................................... 11
XQUIT.......................................................................................................................................................... 11
XOPTIONS................................................................................................................................................... 12
XHELP......................................................................................................................................................... 12
XSYNCSTATUS........................................................................................................................................... 13
VxRouter Port Numbering...................................................................................................................................... 14
Error and Status Codes.......................................................................................................................................... 26
API V3 Commands Removed from Version 4.........................................................................................................27
Changing from V3 to V4 API commands................................................................................................................28
Appendix A: Switch Status Broadcast.....................................................................................................................29
Appendix B: Sample Commands............................................................................................................................29
Appendix C: Connecting Extenders........................................................................................................................30
A) VEL-24DH through a VX80........................................................................................................................... 30
B) VEL-4 and VEL-24 through a VX160.............................................................................................................31
Appendix D: Point-to-Point Connection mode.........................................................................................................32
API Manual Revision History..................................................................................................................................33
Index of Tables
Table 1: Upper vs. Lower case................................................................................................................................. 5
Table 2: XMAXCARDS return values......................................................................................................................11
Table 3: V3 vs. V4 commands................................................................................................................................ 28
Jun 12, 2014
Router ASCII API: V4.5-1
1/33