Macro, Xstatusio and xstatusoi – Thinklogical Router - ASCII-API User Manual
Page 9
Macro
Sends a sequence of connect and disconnect commands as one command line. The syntax of this command is different
from the other commands. This command combines connects and disconnects in one string and also combines upper
and lower case commands. While the connect and disconnect have upper and lower case versions, there is only an upper
case 'M'. The break between the two chassis is done with a semi-colon (;). All commands before the semi-colon affect
the Upstream/Upper ports, and the command after the semi-colon affect the Downstream/Lower ports. If a router only
has one set of ports (such as the Vx40), then the semi-colon may be omitted.
Format
:
MiiiiOOOOiiiiOOOO...[;iiiiOOOOiiiiOOOO...]
iiii - input port number
oooo - output port number
an input number of
0000 (all zeros) will disconnect the listed output port (same as the
DO command)
an output number of
0000 (all zeros) will disconnect the listed input port from all
connected outputs (same as the DI command)
an output number of
9999 will broadcast the input port to all outputs
unlike the XPUT command, the router is not reset before the command is executed
To turn off all the ports, set the input to all zeros and the output to 9999.
a 'M' without inputs or outputs is valid. This allows external systems to determine if the
API version supports the macro command.
Example:
M0000001101230000;00230008
•
disconnect (upper) output 11
•
disconnect (upper) input 123
•
connect (lower) input 23 to output 8
Example: M00009999;00009999
•
disconnect all ports (the semi-colon section is not needed if
the router only has one chassis – such as the VX80 or VX320-
video)
Example Results:
R0003OK or R0007ERnnnn
XSTATUSIO and XSTATUSOI
Similar to the XGET command, these commands return the current switch connection state. The switch state is returned
as pairs of ports, input port and output port for the 'IO' command and output port and input port for the 'OI' command. A
data pair is returned for each active connection. For bi-directional switches (example: Vx160 and Vx320), the upper
chassis pairs are listed first, then a semi-colon (;), then the lower chassis pairs. The semi-colon is always present in an
'OK' response.
The XGET command encodes the port information as hexadecimal values, these commands use four digit, zero filled
decimal values. For example: the value 12 is encoded as: 0012. Unlike the XGET, there is only one 'I' or 'O' in the
response. It is immediately after the 'OK' and is there to identify which port (input or output) appears first in the data
pair.
F
ormat:
XSTATUSIO
Format:
XSTATUSOI
This will return a (very) long string listing every connection. The connection list consists
of pairs of port numbers.
Example Results:
XSTATUSIO: R0027OKI0010012300120015;00030005
XSTATUSOI: R0027OKO0015001201230010;00050003
XSTATUSOI: R0011OKO;00050003
XSTATUSOI: R0019OKO0015001201230010;
R0005OKI; or R0005OKO; or R0007ERnnnn
Jun 12, 2014
Router ASCII API: V4.5-1
8/33