|
|
United States-English | |
|
|
 |
|
ACC Utilities Reference Guide > Chapter 4 ZTERM
- Interactive Routine Interface
ZTERM Available Commands |
|
|
The commands available in ZTERM (displayed by entering ?) are: ZTERM> ? If more details of a particular command format are needed, enter the two letter command identifier after the ? and ZTERM will display more information. For example: ZTERM> ?? TX Further explanation of the available commands is in alphabetic order. As most of the commands use ZCOM routine calls, more information on each is available under the specific routine call as documented in the ACC Programmer’s Reference Guide. ZTERM ignores the case of the letters in most commands (case insensitive). Only the SE (send) and CW (control write) are case sensitive. For these two commands the data string, prompted by the command, is sent as entered (without any case conversion). Format: /E This command terminates ZTERM, closing its ZLU. This command has the same effect as EX. Format: CL,ZLU Closes the specified program ZLU. Returns the ZLU to the ZCOM subsystem for reuse. Uses the zclos routine call. Format:CN,ZLU1,ZLU2,req,[mode],[port,type,poll,select],[t1,t2] The CN command is used to send control requests to terminal ZLUs in the range ZLU1 to ZLU2. The valid requests (req) available under the CN command are:
The port, type, poll, and select parameters are only used for “SE” request, and the terminal must be disabled before they can be changed. They are described under zcntl in the ACC Programmer’s Reference Guide. See under zsend in that manual for a detailed description of mode. A terminal must be both enabled and activated before it can send and receive messages. Format: CW,ZLU,mode,tag1,tag2 Functions in the same way as the SE command but in this case the zcntl routine is used to generate a control write request, rather than zsend (which generates a write request). ZTERM responds with:
Enter text for the control write, then press <return>. Format: DI,on/off/error Controls the display of messages by commands that send or receive messages (e.g., RE - read, RX - receive, RL - receive and loopback, TX - transmit). If the display is set off, then all the messages are suppressed. If error is used then only messages containing non-zero status codes are displayed. If on is used, the full message display is restored. Format: DL,ZLU1 [,ZLU2] [,+Q] Displays the logical terminal information for the specified terminal ZLU or range of ZLUs. The information is in hexadecimal and ASCII. The +Q option suppresses the hexadecimal listing. See under “Terminal Table Pages” in the section on Tables and Data Structures in the ACC Programmer’s Reference Guide, for the logical terminal table layout. ZTERM> dl 10 Format: DP,ZLU,[ZLU2],[+Q] Displays the physical terminal information for the specified terminal ZLU, or range of ZLUs, in hexadecimal and ASCII. The +Q option suppresses the display of the hexadecimal data. See under “Physical Terminal Table” in the section on Table and Data Structures in the ACC Programmer’s Reference Guide, for the physical terminal table layout. Example ZTERM> dp 601 Format: DZ,ZLU Displays the information for the specified ZLU from the ZLU table (in hexadecimal and ASCII) in the following format. Example ZTERM> dz 10 The ZLU table field descriptions are detailed in the “ZLU Tables” section in the Tables and Data Structures section of the ACC Programmer’s Reference Guide. Format: /E This command terminates ZTERM, closing its ZLU. This command has the same effect as /E. Format: IT,card This command displays the interface table information for the specified ACC card, in hexadecimal and ASCII, as per the DZ command. The contents of the interface table are discussed under Interface Table in the Tables and Data Structures section of the ACC Programmer’s Reference Guide. Example ,0 Format: LG,zlu,[queue] This command retrieves logical terminal queue data from the specified logical terminal data queue. If the queue number is omitted, the number will be defaulted to the queue number from the last data queue command (LQ, LG or LP). The retrieved data will be displayed on the terminal. Format: LP,zlu,[queue] This command puts a test message (of length 100 bytes) on the specified logical terminal data queue. If the queue number is omitted, it will be defaulted to the queue number from the last data queue command (LQ, LG or LP). Format: LQ,appl,label
This command requests a logical terminal data queue for the given terminal application with the given label. If this label is already allocated for this application, then the existing queue number will be returned. This command may be used to set the logical queue number for subsequent LG and LP commands. Format: LS,appl,label,size
This command will find an existing storage for this application with matching label and size. If the storage is not already allocated then the command will allocate it if this is specified. In either case, the command returns the logical terminal table offset of the storage. This offset may be used in the LU command. Format: LU,ZLU,INDX,[len] LU is allows the logical terminal table to be updated. Access is only allowed into the User data portion of the table. The value INDX is the offset into the table relative to the origin at 0. The index is in 16-bit words. If an index value is given that is before the start of the User area or beyond the end of the table, an error is returned. If the length plus the offset will fall beyond the end of the table, an error is also returned. If the [len] field is specified, then each 16-bit word is prompted one at a time. When all words have been entered, the routine zltup is used to update the logical terminal table. Format: MG,TZLU,NZLU The terminal multiplexing capability of the ZCOM system allows multiple logical terminals to link to a single physical terminal. This command re-links an existing logical terminal (referred to by TZLU) to a different physical terminal (referred to by NZLU). The source terminal cannot be the only terminal linked to the original physical terminal; otherwise an error will be returned. This command uses the zltmg routine. Format: MP,ZLU,MZLU Sets up a ZLU mapping. All messages for the ZLU are mapped to the MZLU as specified in the command. Uses the zmapr routine call. Format: MV,[zlu],[dzlu] Moves message between queues. If the first zlu is not specified, then the ZTERM primary program ZLU is assumed. If the destination dzlu is not specified, then the message is discarded, otherwise it is moved to the destination queue. This command moves the first message only from the head of the first ZLU queue. Uses the zqmve routine call. Format: MX,TZLU,MODE Used to enable or disable multiplexing for a logical terminal. Mode values:
Format: ND,[node,[timeout]] This command sets up the node number to be used in subsequent ZTERM commands. The node number will be used in the ZTERM commands that can be executed in a remote node (e.g. SE, DZ). Those that can only be executed in the local node are not affected (e.g. OP, RE). If “node” is not specified, ZTERM displays the default node without change. If “timeout” is specified with the node number, the default timeout for that node is set to that value in seconds. This node number is set up to the local node when ZTERM starts up. Format: ND, node DN displays the node entry for node number “node”. DNI displays the node entry for node index “index”. Note that node index ranges from 0, 1, ... Format: NM,name,[node] Retrieves the ZLU from the name only. Enter the name of the ZLU, (8 bytes maximum). If there is a ZLU of that name, the system will respond with “ZLU is nnn”. The remote node call is not currently implemented. Uses the zname routine call. Format: OP,[name],[PRIM] Opens a program ZLU. If PRIM is not specified, then the program ZLU will be an auxiliary. The name of the ZLU must be specified if more than one ZLU is being opened. Uses the zopen routine call. Format: PE,[wait] Peeks at the ZTERM primary ZLU. This command does not remove the message from the head of the queue. If wait specified, then the program will display the messages as they are received. If no messages are received then an INT signal can be used to interrupt the wait (this can usually be generated by using a ^C). Uses the zpeek routine call. ZTERM> pe The PE command can also be used to display the header of the message by using the command modifier HD. ZTERM> pehd Format: PT,card,port,rcode,param,[config1],[config2] Sets port parameters. The parameters are similar to those used in the zport call. See under zport in the ACC Programmer’s Reference Guide. All terminals on the port must be disabled before this command is used.
(an “H” suffix indicates a hex value):
Format: PU,ZLU,INDX,[len] Updates the physical terminal table user data area. This command prompts for each of the words (16-bit values) in turn. When [len] words have been read, ZTERM uses the zptup routine to update the physical terminal table. If [len] is not specified 1 is assumed. ZTERM> pu 10 96 2 Format: PZ,ZLU,[wait] Format: PZHD,ZLU,[wait] Peeks at any program ZLU. This command is the same as the PE command, except that any program ZLU can be entered. If wait is specified, then the program will display the messages as they are received. If no messages are received then an INT signal can be used to interrupt the wait (this can usually be generated by using a ^C). ZTERM> pz 802 The PZ command can also be used to display the header of the message by using the command modifier HD. ZTERM> pzhd 802 Format: RC,ZLU1,[ZLU2],[rzlu],[rnode],[mode] Sets up either the ZTERM primary ZLU as receiver for the specified terminal ZLU1 or range of terminal ZLUs (ZLU1 to ZLU2 inclusive), or can be used to set up an alternate program ZLU (rzlu & rnode) to be receiver for the terminal ZLU. If rnode is not supplied, it defaults to the local node. Uses the zrcvr routine call. Format: RE,[wait] Format: REHD,[wait] Reads the ZTERM program primary ZLU. If wait is specified, then the program will continue to read the ZLU display the messages as they are received. If no messages are received then an INT signal can be used to interrupt the wait (this can usually be generated by using a ^C). ZTERM> re The RE command can also be used to display the header of the message by using the command modifier HD. ZTERM> rehd Format:- RL,[LIst/LAtency],[sendmode],[dzlu],[AC],[maxtime] Reads the ZTERM primary ZLU in a loop re-transmitting each received message and produces timing statistics. (Use RC to set up the primary ZLU as a receiver first if the test is on a terminal). Any messages received are returned to either their source or, if specified, to the destination ZLU (dzlu). The options have the following meanings:
The display of the message information is controlled by the DI (display) command. This is a blocking command and will remain active until a ZCOM call error is encountered (such as ZCOM shutdown, ierr=-2), or until a sigint (usually ^C) is received by ZTERM. It accumulates the number of messages received for the duration of the command and the elapsed time in milliseconds. This information is displayed when the command is stopped or completes. Format: RV,[LI],[AC],[maxtime] Receive and validate messages from primary ZLU. This command works in conjunction with the TV command in another copy of ZTERM to validate both message content and sequence. Optionally LI may be specified to list the incoming data in hex as it is received. AC may also be specified if the protocol module requires reactivation after each received message. The command optionally has a maximum runtime set in the [maxtime] parameter. If this is zero then the command runs without a time limit, otherwise it will terminate after [maxtime] seconds. The RV command will also terminate if it received a start message, and then receives end messages from all the terminal ZLUs from which it has received messages - see the TV command. Format:- RX,[LIst],[ACtivate],[maxtime] RX receives and displays messages received on ZTERM’s program ZLU. This is a blocking command and will remain active until a ZCOM call error is encountered (such as ZCOM shutdown, ierr=-2), or until a SIGINT (usually ^C) is received by ZTERM. It accumulates the number of messages received for the duration of the command and the elapsed time in milliseconds. This information is displayed when the command is stopped or completes. The options have the following meanings:
Format: RZ,ZLU,[wait] Format: RZHD,ZLU,[wait] Reads any program ZLU. This command functions in exactly the same way as the RE command, however as a ZLU number is entered, any program ZLU can be read. Uses the zread routine call. Format: S7, [OF] This command enables special processing for SS7 Level-1 devices. S7,OF disables the SS7 processing. When SS7 processing is enabled the RV, TX, RX, XM, and RL commands are modified for testing with an SS7 level-1 protocol. In particular, the first 2 bytes of all transmitted frames are sequenced to ensure that any two consecutive frames will always contain different data in these bytes. The sequence number used for TX, XM and RL is reset to zero by the S7 command. Any received frames 3 bytes long or shorter are discarded (assumed to be FISUs or illegal for SS7). While SS7 processing is enabled, the prompt is changed to “Z.SS7>” as a reminder. Format: SE,ZLU,mode,tag1,tag2 Sends a message to the indicated ZLU number. The ZLU may be either a terminal or a program ZLU. Use ZSCAN to find out the ZLU numbers of the programs, if necessary. The mode and tag parameters are as described under zsend in the ZCOM routine calls section. ZTERM responds to the above command with: Input message (max 80 chars) Enter the message to be sent, and press <return>. Uses the zsend routine call. Format: ST,ZLU Displays the physical terminal status. The ST command is used to determine the status of the particular terminal ZLU. For example: ZTERM> st 10 ST translates some of the physical terminal table fields (as provided in the DP command) into the above information. Format: SW,ZLUA,ZLUB The physical terminal table data and associated logical terminals are exchanged by this command. Makes use of the zxcpt call. Format: SZ,[zlu] Gets program queue size. Returns the number of messages queued to the specified program ZLU. (Cannot be a terminal ZLU.) If a ZLU is not entered, the ZTERM program ZLU is used. The system responds with “ZLU nnn has queue depth nnnn”. Uses the zqsze routine call. Format: TM,ZLU,time Sets the timeout on specific program ZLU in seconds. The timeout may be cancelled by setting the time value to zero. Uses the ztimr routine call. Format: TR,[CommandFileName] Transfers to a command file (commandfilename) that contains a sequence of ZTERM commands. Allows for recurring sequences of events to be automated. Format: Transmit verification messages to a range of ZLUs. This command is used in conjunction with the RV command in another copy of ZTERM to validate both message content and sequence. The parameters have the following meanings:
If the command is issued as TVFL rather than TV then a flag message is sent 1 second before the first data message, and on completion of the test a termination message is sent to every terminal ZLU which has been used in the test. The completion message contains the number of messages sent to that ZLU. These message are used by the receiving copy of ZTERM to delimit the start and end of the test and to verify that all messages have been received. The receiver resets it’s statistics when the start message arrives and terminates the RV command when the end message arrives. The command optionally has a maximum runtime set in the [maxtime] parameter. If this is zero then the command runs without a time limit, otherwise it will terminate after [maxtime] seconds. If the [apno] field is used then only terminal ZLUs whose logical terminal table application number “ltapno” field matches the [apno] field are used. If [apno] is not set then all terminals in the range are used. Format:- TX,ZLU,[len],[mode],[total],[window],[tagp],[apno] The TX command is used for a general transmit test. The parameters have the following meanings:
The test proceeds until the total number of messages are sent or the test is interrupted using sigint (usually ^C). The test message sent to the terminal (up to “len” length) is ’ABCDEFGHIjKLMNOPQRStUVWXYZabcDefghijklmNopqrstuvwXyz’ etc The messages that appear on the terminal running ZTERM depend on the mode chosen. If the mode requests a definite response then the status of the send will be reported to the screen from which ZTERM is running. Uses the zsend routine, and the zread if any windows are specified. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
 Printable version |
|
|
|
|
|
|||||||||||||||
|
|||||||||||||||
