Page 1 Networking and Data Communications Library TR3271 Management Programming Manual Abstract This manual describes the control-and-inquiry interface and the event messages available to an application program controlling or monitoring the TR3271 subsystem. This manual is for programmers. Part Number 14948 Tandem Computers Incorporated...
Page 2 Part Number Product Version Operating System Version Date First Edition 14948 TR3271 C20 GUARDIAN 90C20 March 1989 New editions incorporate any updates issued since the previous edition. Copyright All rights reserved. No part of this document may be reproduced in any form, including photocopying or translation to another language, without the prior written consent of Tandem Computers Incorporated.
Page 3: Table Of Contents
MANAGEMENT PROGRAMMING FOR TR3271 ....2-1 How a Management Application Fits Into the Architecture ... 2-2 Commands ..........2-4 Event Messages ........... 2-10 Communicating With the TR3271 Subsystem ....2-11 SECTION 3. ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEM ..3-1 Definition Files .......... 3-2 Naming Rules and Guidelines for Applications ....
Page 4 SPI Standard Definitions ........5-1 EMS Standard Definitions ........5-9 Data-Communications Standard Definitions ....5-11 Common Definitions for the TR3271 Subsystem ....5-17 TR3271 Buffer Declarations ......5-17 TR3271 Predefined Token and Field Values ....5-18 TR3271 Simple Tokens ........5-18 TR3271 Extensible Structured Tokens ....
Page 5 ZTR3-ERR-CLIP-PROB ......... A-3 ZTR3-ERR-TARGET-OBJ-NOT-FOUND ...... A-4 ZTR3-ERR-ATTR-CONFL-SU ......A-5 ZTR3-ERR-NOT-PTP-SU ........ A-7 ZTR3-ERR-ALRDY-USING-ADDR ......A-8 ZTR3-ERR-NO-OBJ-IN-SEL-STATE ....... A-9 ZTR3-ERR-OPENED-SU-EXIST ......A-10 ZTR3-ERR-TARGET-OBJNAME-INV ....... A-11 ZTR3-ERR-NO-OWNER ......... A-12 ZTR3-ERR-CONN-EXIST ....... A-13 ZTR3-ERR-SU-OPENED ........ A-14 APPENDIX B. TR3271 SUBSYSTEM DDL ......B-1...
Page 6 CONTENTS FIGURES 1-1. TR3271 Subsystem Architecture ......1-6 2-1. How an Application Fits Into the Architecture ..2-3 TABLES 2-1. TR3271 Programmatic Commands ......2-4 2-2. SCF Commands and Programmatic Commands ....2-6 2-3. CMI Commands and Programmatic Commands ....2-8 4-1.
Page 7: Preface
The seven sections and two appendixes of this manual contain information as follows: Section 1 introduces the TR3271 subsystem and the objects it controls. It also describes the required management functions, the relationship of the subsystem to other subsystems, and the architecture of the TR3271 subsystem.
Page 8 To use this manual, you should be familiar with Tandem system architecture, have a reading knowledge of DDL, and have a working knowledge of TR3271 and the language in which you are working: TAL, COBOL85, TACL, and C. In addition, you should be familiar with distributed systems management.
Page 9: Notation Conventions
NOTATION CONVENTIONS The following list summarizes the conventions used in this manual, including the boxed descriptions of programmatic commands, event messages, and error lists in this manual. Notation Meaning UPPERCASE Uppercase letters represent names from the LETTERS definition files, SCF commands, or CMI commands; enter these names exactly as shown.
Page 10 NOTATION CONVENTIONS Response Message This token or field is always present. !... This token or field can occur multiple times. ! name The presence or absence of this token or field depends on the token, field, or value identified by name . the text for the exact nature of the dependency.
Page 11: Introduction
(PTP). While in pass-through mode, data can be passed between an AM3270 device and a host by means of TR3271 without requiring an intervening application program. OBJECTS CONTROLLED BY THE SUBSYSTEM The TR3271 subsystem controls a process, line, and subdevices (SUs).
Page 12: Required Management Functions
READ and WRITE. PTP subdevices are handled differently from other subdevices. Once added and started, a TR3271 PTP subdevice must be connected to an AM3270 PTP subdevice using the CONNECT command through the control-and-inquiry interface or the CONTROL CONNECT command through the Communications Management Interface (CMI).
Page 13 Terminating the operation of a line and subdevices Adding subdevices to the subsystem Changing certain attributes of a line and subdevices Establishing or clearing the link between a TR3271 subdevice and an AM3270 subdevice when using the pass-through configura- tion...
Page 14: Relationship With Other Subsystems
TR3271 subdevice. When linked in this way, data from AM3270 terminals can be passed to the host through TR3271, and data from the host can be passed to the AM3270 terminals through AM3270 without the necessity for an intervening application program.
Page 15: Subsystem Architecture
INTRODUCTION Subsystem Architecture SUBSYSTEM ARCHITECTURE The TR3271 subsystem consists of one process controlling one line. However, the subsystem can be combined to provide a pass- through function between AM3270 terminals and a host by means of TR3271. Figure 1-1 illustrates the architecture of the TR3271 subsystem and the various interfaces to the subsystem.
Page 16 TR3271 subsystem. provides an operator interface to the Subsystem Control Point (SCP) which provides an interface to the TR3271 subsystem. SCF can be used for the TR3271 subsystem only in 6100 CSS environments. The Communications Management Interface (CMI), which can be...
Page 17: Management Programming For Tr3271
COUP has limited application to the TR3271 subsystem; you can only add or delete a process or line using this facility. The division of management tasks between operator control and programmatic control depends upon the subsystem configuration, the subsystem environment, and your needs as a subsystem user.
Page 18: How A Management Application Fits Into The Architecture
A management application uses Subsystem Programmatic Interface (SPI) messages to communicate with the TR3271 subsystem. messages are passed between the management application and the TR3271 subsystem by means of the Subsystem Control Point (SCP) or the EMS interface. The function of an SPI message determines whether the message is passed through SCP or EMS.
Page 19: How An Application Fits Into The Architecture
The communication between EMS and your management applica- tion is unidirectional and occurs asynchronously. A management application using EMS can monitor events that occur in the TR3271 subsystem. The application can thereby handle problems occurring in the subsystem or track the current status of the subsystem.
Page 20: Commands
TR3271 subsystem using the control-and-inquiry interface. For detailed descriptions of these commands as they relate to the TR3271 subsystem, refer to Section 6, "Commands and Responses." For a description of these commands as they relate to all data-communications subsystems,...
Page 21 Table 2-2 shows the correspondence between the Subsystem Control Facility (SCF) commands a human operator issues to control and monitor the TR3271 subsystem and the programmatic commands a management application sends to the subsystem. For clarity, the table contains the command and object names in the form that you must use in applications.
Page 22: Scf Commands And Programmatic Commands
MANAGEMENT PROGRAMMING FOR TR3271 Commands Table 2-2. SCF Commands and Programmatic Commands (Page 1 of 2) SCF COMMAND PROGRAMMATIC COMMAND AND OBJECT TYPE AND OBJECT TYPE ABORT LINE ZCOM-CMD-ABORT ZCOM-OBJ-LINE ABORT SU ZCOM-CMD-ABORT ZCOM-OBJ-SU ADD SU ZCOM-CMD-ADD ZCOM-OBJ-SU ALTER LINE...
Page 23 MANAGEMENT PROGRAMMING FOR TR3271 Commands Table 2-2. SCF Commands and Programmatic Commands (Page 2 of 2) SCF COMMAND PROGRAMMATIC COMMAND AND OBJECT TYPE AND OBJECT TYPE PRIMARY PROCESS ZCOM-CMD-SWITCH ZCOM-OBJ-PROC START LINE ZCOM-CMD-START ZCOM-OBJ-LINE START SU ZCOM-CMD-START ZCOM-OBJ-SU STATS LINE...
Page 24: Cmi Commands And Programmatic Commands
Table 2-3 shows the correspondence between the Communications Management Interface (CMI) commands a human operator issues to control and monitor the TR3271 subsystem and the programmatic commands a management application sends to the subsystems. clarity, the table contains the command and object names in the form that you must use in applications.
Page 25 MANAGEMENT PROGRAMMING FOR TR3271 Commands Table 2-3. CMI Commands and Programmatic Commands (Page 2 of 3) CMI COMMAND PROGRAMMATIC COMMAND AND OBJECT TYPE AND OBJECT TYPE DELETE SU ZCOM-CMD-DELETE ZCOM-OBJ-LINE* ZCOM-CMD-DELETE ZCOM-OBJ-SU CONTROL SU, ZCOM-CMD-DISCONNECT ZCOM-OBJ-SU DISCONNECT None ZCOM-CMD-GETVERSION ZCOM-OBJ-NULL...
Page 26: Event Messages
An event message describes an event that has occurred in a subsystem, such as a hardware error or a software error. event messages are in SPI message format. All event messages issued by the TR3271 subsystem are sent to the EMS collector process ($0). These event messages are then placed into the user-specified log files.
Page 27: Communicating With The Tr3271 Subsystem
Figure 2-1 illustrates the flow of data between the TR3271 subsystem and a management application in the EMS environment. For detailed descriptions of event messages and event management as they relate to the TR3271 subsystem, refer to Section 7, "Event Management."...
Page 28 Manual and the Distributed Systems Management (DSM) Programming Manual . For details on communicating with the EMS distributor process for the TR3271 subsystem, refer to Section 7, "Event Management." For general information about communicating with the EMS distributor process, refer to the Event Management Service (EMS) Manual .
Page 29: Elements Of Spi Messages For The Subsystem
SECTION 3 ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEM The Subsystem Programmatic Interface (SPI) procedures facilitate the communication between a management application and the TR3271 subsystem. These procedures allow a management application to build commands in SPI message format to be sent through SCP to the subsystem.
Page 30: Definition Files
In addition, each source of definitions, such as the TR3271 subsystem or SPI, has associated with it a set of five definition files: one in TAL, one in COBOL85, one in TACL, one in C, and one in DDL.
Page 31 If the application communicates with other subsystems, the definition file ZSPIDEF.Z subsysxxx for each of the other subsystems must also be included. An example of the definition files needed by an TR3271 applica- tion written in COBOL85 that retrieves event messages is as follows: ZSPIDEF.ZSPICOB...
Page 32: Naming Rules And Guidelines For Applications
Communications Management Programming Manual . Command Numbers Command numbers specify a command to the TR3271 subsystem or a response to a management application. The management application uses a symbolic name to express the command number to the TR3271 subsystem and the subsystem uses the symbolic name to identify the corresponding response.
Page 33: Object Types
The TR3271 subsystem supports the following object types: PROCESS LINE NULL The objects controlled by the TR3271 subsystem are organized in a hierarchy by object type. In descending order, the hierarchy is PROCESS, LINE, and SU. The NULL object type is not within the hierarchy and applies to only two commands, GETVERSION and LISTOBJECTS.
Page 34: Object Names
PROCESS, LINE, or SU. The NULL object type does not have an object name associated with it. In the TR3271 subsystem, there is a one-to-one correspondence between a process and a line. Therefore, you can identify a process by using the same object name associated with the line controlled by the process.
Page 35: Event Numbers
Operator Messages: Console Format . Each event message that can be reported by the TR3271 subsystem has a different event number assigned to it. The TR3271 event numbers and their associated event messages are described in Section 7, "Event Management."...
Page 36: Tokens
Simple tokens are tokens whose values are single fields or fixed structures. The token codes for the simple tokens used by the TR3271 subsystem are represented by symbolic names of the form Z subsys -TKN- name , where subsys is a three-character subsystem abbreviation and name identifies the token code.
Page 37 RESETSTATS STATISTICS STATUS Token Types The token types used by the TR3271 subsystem are represented by symbolic names of the form Z subsys -TYP- name , where subsys is a three-character subsystem abbreviation and name identifies the token type. The token types used by the TR3271 subsystem are as...
Page 38 For example, the field type ZSPI-DDL-BOOLEAN represents the Boolean data type. Some field types are defined by SPI; others are private field types defined by the subsystem. The field types that can be used by the TR3271 subsystem are as follows: ZSPI-DDL-BOOLEAN ZSPI-DDL-FNAME32...
Page 39: Constructs Involving Multiple Tokens
ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEM Constructs Involving Multiple Tokens Constructs Involving Multiple Tokens The TR3271 subsystem supports two kinds of constructs that involve multiple tokens: data lists and error lists. For the TR3271 subsystem, these constructs are found only in responses from the subsystem.
Page 40: Spi Programming Considerations For Tr3271
TR3271 subsystem. BUILDING THE COMMAND BUFFER The following programming considerations apply when an applica- tion builds the command buffer for an TR3271 command. The recommended buffer length in bytes for a command is a predefined value with the symbolic name ZCOM-VAL-MAXBUFLEN.
Page 41: Discontinuing A Command In Progress
If no value is specified for this token, the TR3271 subsystem continues to the next object only if no errors or warnings occurred on the previous one. The possible values for this token are ZSPI-VAL-WARN-AND-NORM and ZSPI-VAL-NORM-ONLY.
Page 42: Receiving And Decoding The Response Buffer
The following programming considerations apply when an applica- tion receives and decodes the response buffer. In responses to TR3271 commands that operate on objects, a response record always contains response information for the operation of the command on a single object.
Page 43: Error Handling
SPI PROGRAMMING CONSIDERATIONS FOR TR3271 Error Handling ERROR HANDLING General programming considerations for handling errors that occur when using the management-programming interfaces are discussed in the Communications Management Programming Manual . In the programmatic control-and-inquiry interface to the subsystem, there are two values for the return token that indicate that the response record does not contain an error list.
Page 44: Command Protocol
SPI PROGRAMMING CONSIDERATIONS FOR TR3271 Command Protocol COMMAND PROTOCOL Table 4-1 shows the state transitions of objects as a result of some of the TR3271 commands. Table 4-1. Command Protocol Summary State Changes COMMAND OLD STATE NEW STATE START STOPPED...
Page 45: Common Definitions
Many of the definitions are used in multiple commands, responses, event messages, or error lists. This section contains general information that applies to all uses of the common definitions in the interfaces to the TR3271 subsystem. Information about a definition that is specific to a particular command, response, event message, or error list is given in the description for that item.
Page 46: Spi Standard Definitions
COMMON DEFINITIONS SPI Standard Definitions The SPI definitions applicable to the TR3271 subsystem consist of the following: Header tokens Simple tokens Names of token and field values Token types Fixed structures Table 5-1. SPI Standard Definitions (Page 1 of 2)
Page 47 All SPI standard definitions are fully described in the Distributed Systems Management (DSM) Programming Manual . Information about these definitions that is specific to the TR3271 subsystem is given below. ZSPI-SSN-ZTR3 specifies the subsystem number assigned to the TR3271 subsystem.
Page 48 ZSPI-TKN-COMMAND specifies the command number of a TR3271 com- mand. The value of this token is always ZCOM-CMD- name , where name specifies the command to be performed. The commands supported by TR3271 are described in Section 6, "Commands and Responses."...
Page 49 COMMON DEFINITIONS SPI Standard Definitions ZSPI-TKN-COMMENT allows your management application to include information of its own which is not acted upon by the TR3271 subsystem or returned by the subsystem. A management application can include as many as 80 bytes of comment in every command.
Page 50 MAXRESP token, the manage- ment application must specify a value using the SSPUT procedure. The TR3271 subsystem provides full support for the MAXRESP token; that is, the management application can specify any of the...
Page 51 The meaning of each error number is subsystem-specific and possibly command-specific. descriptions of all TR3271 error numbers, refer to Appendix A. For descriptions of all common data-communications error numbers, refer to the Communications Management Programming Manual .
Page 52 ZSPI-TKN-USEDLEN is greater than the count-read value, then the TR3271 subsystem rejects the command because the command length was too long. ZSPI-VAL-TANDEM indicates that the destination subsystem is on a Tandem system.
Page 53: Ems Standard Definitions
It does not list EMS error numbers or definitions used only in error lists. For a description of all EMS standard definitions, refer to the Event Management Service (EMS) Manual . The EMS definitions used by the TR3271 subsystem consist of the following: Header tokens Simple tokens Extensible structured tokens Table 5-2.
Page 54 ZEMS-TKN-CONSOLE-PRINT specifies whether the event messages are processed by the compatibility distributor for printing on the consoe. The value of this token for the TR3271 subsystem is always ZSPI-VAL-TRUE. The ZSPI-VAL-TRUE value causes all TR3271 event messages to print on the operator console.
Page 55: Data-Communications Standard Definitions
COMMON DEFINITIONS Data-Communications Standard Definitions ZEMS-TKN-PIN is the PIN of the TR3271 subsystem that reported the event. ZEMS-TKN-SYSTEM is the EXPAND system number of the system (node) on which the event was reported. ZEMS-TKN-USERID specifies the user ID of the TR3271 subsystem process.
Page 56: Data-Communications Standard Definitions
ZCOM-VAL-SUB-NONE ZCOM-VAL-SUB-ONLY ZCOM-VAL-SUMSTATE-DIAG ZCOM-VAL-SUMSTATE-STARTED ZCOM-VAL-SUMSTATE-STOPPED All data-communications standard definitions are fully described in the Communications Management Programming Manual . Information about these definitions that is specific to the TR3271 subsystem is given below. Definitions are listed in alphabetical order. 5-12...
Page 57 COMMON DEFINITIONS Data-Communications Standard Definitions ZCOM-MAP-REQID provides security checking additional to the sensitive/nonsensitive command implementation. This token con- tains the GUARDIAN 90 Process ID and the PAID of the application issuing the command. The REQID is valid only if the requester is the SUPER.SUPER user ID.
Page 58 The SU object can be opened in the GUARDIAN 90 environment. ZCOM-TKN-CMD-TIMEOUT is the maximum amount of time the management application wants to wait for a response from the TR3271 subsystem. If the specified time elapses before a response is received, SCP cancels the command that was sent to the TR3271 subsystem and sends the error ZCOM-ERR-CMD-TIMED-OUT to the management application.
Page 59 If the value ZCOM-VAL-SUB-ONLY is specified, only the objects subordinate to the line are affected. The objects subordinate to an TR3271 line are the subdevices on the line. If the value ZCOM-VAL-SUB-ALL is specified, the objects subordinate to the line as well as the LINE object itself are affected by the command.
Page 60 ZCOM-VAL-SUMSTATE-DIAG is a value of the field ZSTATE of the extensible structured tokens ZTR3-MAP-STATUS-LINE. It indicates that a TR3271 line is in the DIAGNOSING summary state. ZCOM-VAL-SUMSTATE-STARTED is a value of the field ZSTATE of the extensible structured tokens ZTR3-MAP-STATUS-LINE and ZTR3-MAP- STATUS-SU.
Page 61: Common Definitions For The Tr3271 Subsystem
ZCOM-VAL-SUMSTATE-STOPPED is a value of the field ZSTATE of the extensible structured tokens ZTR3-MAP-STATUS-LINE and ZTR3-MAP- STATUS-SU. It indicates that a TR3271 line or subdevice is in the STOPPED summary state. COMMON DEFINITIONS FOR THE TR3271 SUBSYSTEM Definitions whose names begin with ZTR3- are TR3271 definitions.
Page 62: Tr3271 Predefined Token And Field Values
TR3271 Simple Tokens The TR3271 subsystem only defines simple tokens that appear in event messages. These tokens include internal tokens, which appear in the ZTR3-EVT-INTERNAL-ERROR (74) event message.
Page 63: Tr3271 Extensible Structured Tokens
COMMON DEFINITIONS TR3271 Tokens in Error Lists TR3271 Extensible Structured Tokens The extensible structured tokens defined by the TR3271 subsystem are as follows: ZTR3-MAP-ADD-SU ZTR3-MAP-INFO-SU ZTR3-MAP-ALTER-LINE ZTR3-MAP-STATS-LINE ZTR3-MAP-ALTER-SU ZTR3-MAP-STATS-SU ZTR3-MAP-RSTATS-LINE ZTR3-MAP-STATUS-LINE ZTR3-MAP-RSTATS-SU ZTR3-MAP-STATUS-SU ZTR3-MAP-INFO-LINE These tokens are described with the commands and responses they appear in.
Page 64: Tr3271 Tokens In Event Messages
ZTR3-TKN-CLIP-STATUS ZTR3-TKN-TYPE-SEQ ZTR3-TKN-CLIP-SU ZTR3-TKN-X1* ZTR3-TKN-CONFIG-ERR ZTR3-TKN-X2* ZTR3-TKN-E-REG* ZTR3-TKN-X3* ZTR3-TKN-FILE-ERR ZTR3-TKN-X4* The tokens defined by the TR3271 subsystem that appear in event messages are described in Section 7, "Event Management," within the description of the event in which they appear. 5-20...
Page 65: Commands And Responses
The commands available in the programmatic interface allow an application to do the following: Change the attributes of TR3271 objects Start and stop the operation of TR3271 objects Add a subdevice to or remove a subdevice from the TR3271 subsystem Obtain attribute values Obtain statistical and status information...
Page 66: Commands And Their Symbolic Names
COMMANDS AND RESPONSES Establish or break a link between a TR3271 subdevice and an AM3270 subdevice Initiate a download of a Communications Line Interface Processor (CLIP) Obtain the version of the TR3271 subsystem Table 6-1 lists the commands that are available in the program- matic control-and-inquiry interface to the TR3271 subsystem and gives their symbolic names.
Page 67 COMMANDS AND RESPONSES Table 6-1. Commands and Their Symbolic Names (Page 2 of 3) SYMBOLIC NAME OF COMMAND COMMAND AND OBJECT INFO ZCOM-CMD-INFO ZCOM-OBJ-LINE ZCOM-OBJ-SU LISTOBJECTS ZCOM-CMD-LISTOBJECTS ZCOM-OBJ-LINE ZCOM-OBJ-NULL ZCOM-OBJ-SU LOAD ZCOM-CMD-LOAD ZCOM-OBJ-LINE RESET ZCOM-CMD-RESET ZCOM-OBJ-LINE RESETSTATS ZCOM-CMD-RESETSTATS ZCOM-OBJ-LINE ZCOM-OBJ-SU START ZCOM-CMD-START ZCOM-OBJ-LINE...
Page 68: Commands By Object Type
One or more object types are valid for each command. Three of the object types have a hierarchical relationship. TR3271 subsystems these three object types are PROC, LINE, and SU (subdevice), where SU is subordinate to LINE and LINE is subordinate to PROC.
Page 69 COMMANDS AND RESPONSES Commands by Object Type The TR3271 subsystem accepts the PROC object type only in the following commands: GETVERSION SWITCH The TR3271 subsystem accepts the LINE object type only in the following commands: ABORT RESETSTATS ALTER START DELETE...
Page 70: Sensitive And Nonsensitive Commands
SUPER user group or users in the same group as the owner of the process with which the target object is associated. Nonsensitive commands can be issued by any valid user. The sensitive commands available to a TR3271 subsystem user are as follows: ABORT RESET RESETSTATS...
Page 71 COMMANDS AND RESPONSES Command Descriptions With the exception of the tokens ZSPI-TKN-DATALIST, ZSPI-TKN- ERRLIST, and ZSPI-TKN-ENDLIST, the order of the tokens in the lists of tokens in the command buffer and response buffer is not necessarily the order in which they will actually appear in a command or response.
Page 72: Abort Command
If you issue this command while the line is in the DIAG summary state, the TR3271 subsystem returns an error. When your management application issues the ABORT command for a line, the subsystem checks for the optional subordinate-modifier token.
Page 73 COMMANDS AND RESPONSES ABORT Command Command ZCOM-CMD-ABORT Object Type ZCOM-OBJ-LINE ZCOM-OBJ-SU Tokens in Command Buffer ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZCOM-MAP-REQID !MAP is optional, but if present, !fields are required. def ZCOM-DDL-REQID. 02 ZCRTPID type ZSPI-DDL-CRTPID. 02 ZPAID type ZSPI-DDL-INT. end. ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-TIMESTAMP.
Page 74 COMMANDS AND RESPONSES ABORT Command Tokens in Command Buffer ZCOM-TKN-OBJNAME specifies the name of a TR3271 line or subdevice that is to be terminated. Your application must provide this token in the command. This token is described in "Data- Communications Standard Definitions" in Section 5 and the Communications Management Programming Manual .
Page 75 "SPI Standard Definitions" in Section 5 and the Distributed Systems Management (DSM) Programming Manual . ZCOM-TKN-OBJNAME specifies the name of a TR3271 line or subdevice that was terminated by the command. Unless there is an error that prevents the ABORT command from being attempted at all, this token is present in every response record.
Page 76 COMMANDS AND RESPONSES ABORT Command ZCOM-ERR-TKN-VAL-INV (-30) Your management application specified the SU object and the the SUB modifier with a value ZCOM-VAL-SUB-ONLY. The SU object accepts only the value ZCOM-VAL-SUB-NONE or ZCOM-VAL- SUB-ALL for the SUB modifier. ZSPI-TKN-ENDLIST indicates the end of a data list or an error list.
Page 77: Add Command
The line must be in the STARTED or STOPPED summary state when you attempt to add a subdevice. If the line is not in one of these summary states, the TR3271 subsystem returns an error. When the subsystem finishes processing the command (without errors), the subdevice is placed in the STOPPED summary state.
Page 78 COMMANDS AND RESPONSES ADD Command def ZCOM-DDL-REQID. 02 ZCRTPID type ZSPI-DDL-CRTPID. 02 ZPAID type ZSPI-DDL-INT. end. ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-TIMESTAMP. ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32. ZSPI-TKN-SSID token-type ZSPI-TYP-SSID. ZSPI-TKN-MAXRESP token-type ZSPI-TYP-INT. ZSPI-TKN-RESPONSE-TYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ALLOW-TYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-COMMENT token-type ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SERVER-VERSION token-type ZSPI-TYP-INT.
Page 79 ZSPI-VAL-FALSE, it is not. The default is ZSPI- VAL-FALSE. Transparent-text mode can only be enabled if the TR3271 line is configured with the EBCDIC character set and transparent-text mode enabled. 6-15...
Page 80 COMMANDS AND RESPONSES ADD Command ZTYPE is a pair of integers that specifies the device type and subtype of the subdevice to be added. The first integer is the device type, which depends on the protocol being used. The second integer is the subtype, which depends on the terminal being represented.
Page 81 "Common Error Numbers and Error Lists" in the Communications Management Programming Manual . details on the TR3271 error numbers and associated error lists, see Appendix A in this manual. The possible nonzero values of RETCODE in response to the ADD...
Page 82 COMMANDS AND RESPONSES ADD Command ZCOM-ERR-MAX-LIMIT-EXCEEDED (-12) Your management application attempted to add more than 253 subdevices on a single line. Typically, you can define as many as 255 subdevices; however, two subdevices are reserved: #ZSPI and #DEBUG. ZCOM-ERR-CMD-MISMATCH (-4) Your management application tried to add a process or a line by using the object type ZCOM-OBJ-PROC or ZCOM-OBJ-LINE.
Page 83 COMMANDS AND RESPONSES ADD Command The name given to a subdevice must be unique on the line. You can add a maximum of 253 subdevices to a line. To remove a subdevice, stop the SU, then use the DELETE command. To add a line or a process, use the Dynamic System Configuration (DSC) facility.
Page 84: Alter Command
COMMANDS AND RESPONSES ALTER Command ALTER Command The ALTER command changes attribute values associated with the specified object. You can change attributes for a line and a subdevice, but not a process. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-LINE ZCOM-OBJ-SU Tokens in Command Buffer ZTR3-MAP-ALTER-LINE !{A} !OBJ-LINE...
Page 85 COMMANDS AND RESPONSES ALTER Command ZTR3-MAP-ALTER-SU !{A} !OBJ-SU def ZTR3-DDL-ALTER-SU. !Specify one or more fields. 02 ZADDR type ZSPI-DDL-INT-PAIR. 02 ZPROTO type ZSPI-DDL-ENUM. 02 ZRECSIZE type ZSPI-DDL-INT. 02 ZXPARENT type ZSPI-DDL-BOOLEAN. 02 ZTYPE type ZSPI-DDL-INT-PAIR. end. ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZCOM-MAP-REQID !MAP is optional, but if present, !fields are required.
Page 86 COMMANDS AND RESPONSES ALTER Command Tokens in Command Buffer ZTR3-MAP-ALTER-LINE is the extensible structured token that defines the configurable attributes that are to be altered for the line. It has the token number ZTR3-TNM-ALTER-LINE and the DDL definition ZTR3-DDL-ALTER-LINE. This token must be in the command when the specified object is ZCOM-OBJ-LINE.
Page 87 The default value is ZSPI-VAL-FALSE. ZINIT-STATUS A 32-bit integer that specifies the initial IBM status that the TR3271 subsystem returns when it receives a SELECT for a subdevice that has not been OPENed or CONNECTed. The possible values are as follows:...
Page 88 ZSPI-VAL-FALSE, it does not. default is ZSPI-VAL-FALSE. ZOFFLINE-TIMER A timestamp that specifies the period of time, in .01 seconds, that the TR3271 subsystem waits to receive a signal from the host. If the TR3271 subsystem does not receive anything within this interval, the host is considered down and a timeout error is reported.
Page 89 COMMANDS AND RESPONSES ALTER Command ZRETRY An integer that specifies the number of times the TR3271 retransmits data as a result of data link errors before returning an error. The value must be in the 1 through 14 range. The default is 3.
Page 90 COMMANDS AND RESPONSES ALTER Command ZWACK-DELAY A timestamp that specifies the period of time, in .01 seconds, that the TR3271 subsystem waits before sending a wait for acknowledgement (WACK) to the host in response to a SELECT. The value must be in the 0 through 32767 range.
Page 91 VAL-TRUE, transparent-text mode is enabled for the subdevice; if the value is ZSPI-VAL-FALSE, it is not. The default is ZSPI-VAL-FALSE. Transparent-text mode can only be enabled if the TR3271 line is configured with the EBCDIC character set and control set, and transparent-text mode is enabled for the line.
Page 92 "SPI Standard Definitions" in Section 5, "Common Definitions," and the Distributed Systems Management (DSM) Programming Manual . ZCOM-TKN-OBJNAME specifies the name of a TR3271 line or subdevice that was altered by the command. Unless there is an error that prevents the ALTER command from being attempted at all, this token is present in every response record.
Page 93 "Common Error Numbers and Error Lists" in the Communications Management Programming Manual . details on the TR3271 error number and their associated error lists, see Appendix A in this manual. The possible nonzero values of RETCODE in response to the ALTER...
Page 94 COMMANDS AND RESPONSES ALTER Command ZTR3-ERR-ALRDY-USING-ADDR (6) Your management application attempted to alter the address of a subdevice, but the address specified in ZADDR is already in use by another subdevice. The ZADDR field must have a value not previously assigned. ZTR3-ERR-ATTR-CONFL-SU (4) An SU attribute conflicts with a LINE attribute.
Page 95: Connect Command
DSM, you can use the CMI ALTER SUBDEVICE command. Refer to the Communications Management (CMI) Operator’s Guide for more information. The lines for the TR3271 and targeted AM3270 subdevice must be in the STARTED summary state. Command ZCOM-CMD-CONNECT Object Type...
Page 96 ZSPI-TKN-RETCODE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL. Tokens in Command Buffer ZCOM-TKN-OBJNAME specifies the TR3271 subdevice that is to be connected to the target subdevice. Your application must provide this token in the command. This token is described in "Data-Communications Standard Definitions" in Section 5 and the Communications Management Programming Manual .
Page 97 For details on the data-communications error numbers and their associated error lists, see "Common Error Numbers and Error Lists" in the Communications Management Programming Manual . details on the TR3271 error numbers and their associated error lists, see Appendix A in this manual. 6-33...
Page 98 ZCOM-ERR-OBJ-NOT-SUPP (-18) Your management application has tried to build a link either from an object that is not supported by the TR3271 subsystem, or to an object not supported by the AM3270 subsystem. CONNECT command is valid only for the object type ZCOM-OBJ-SU.
Page 99 The line and subdevice must be in the STARTED summary state when this command is issued. When the command is completed, the lines and subdevices remain in the STARTED summary state. To disconnect the link between the AM3270 and TR3271 subdevices, use the DISCONNECT command. 6-35...
Page 100: Delete Command
COMMANDS AND RESPONSES DELETE Command DELETE Command The DELETE command removes subdevices from the TR3271 subsystem. You can delete subdevices, but not a process or line. When you use the DELETE command, the subdevices to be deleted must be in the STOPPED summary state.
Page 101 COMMANDS AND RESPONSES DELETE Command ZSPI-TKN-MAXRESP token-type ZSPI-TYP-INT. ZSPI-TKN-CONTEXT token-type ZSPI-TYP-BYTESTRING. ZSPI-TKN-RESPONSE-TYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ALLOW-TYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-COMMENT token-type ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SERVER-VERSION token-type ZSPI-TYP-INT. ZSPI-TKN-SSID token-type ZSPI-TYP-SSID. ZSPI-TKN-DATALIST token-type ZSPI-TYP-LIST. !... ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZCOM-TKN-OBJTYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ERRLIST token-type ZSPI-TYP-LIST.
Page 102 "SPI Standard Definitions" in Section 5, "Common Definitions," and the Distributed Systems Management (DSM) Programming Manual . ZCOM-TKN-OBJNAME specifies either the name of the TR3271 line whose subdevices were deleted or the name of the subdevice that was deleted.
Page 103 Your management application tried to delete an object that is not supported by the TR3271 subsystem. The objects supported by the TR3271 subsystem are PROC, LINE, and SU. For the DELETE command, you must specify the object type ZCOM-OBJ-LINE or ZCOM-OBJ-SU.
Page 104 COMMANDS AND RESPONSES DELETE Command ZCOM-ERR-CMD-INV-IN-SUMSTATE (-3) Your management application tried to delete a subdevice while the line was in the DIAG summary state or when the subdevice to be deleted was not in the STOPPED summary state. ZSPI-TKN-ENDLIST indicates the end of a data list or an error list.
Page 105: Disconnect Command
The DISCONNECT command deletes a link between a TR3271 subdevice and an AM3270 subdevice. You can disconnect only subdevices. Once this command is successfully completed, data can no longer pass between AM3270 terminals and an IBM host through the TR3271 subsystem. However, subdevices remain in the STARTED summary state.
Page 106: Spi Standard Definitions
ZSPI-TKN-RETCODE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL. Tokens in Command Buffer ZCOM-TKN-OBJNAME specifies the TR3271 subdevice that is to be disconnected from the AM3270 subdevice. Your application must provide this token in the command. This token is described in "SPI Standard Definitions" in Section 5 and the Communications Management Programming Manual .
Page 107 This token is described in "SPI Standard Definitions" in Section 5 and the Distributed Systems Management (DSM) Programming Manual . ZCOM-TKN-OBJNAME specifies the name of the TR3271 subdevice that was trying to delete the link to the AM3270 subdevice. Unless there is an error that prevents the DISCONNECT command from being attempted at all, this token is present in every response record.
Page 108 "Common Error Numbers and Error Lists" inthe Communications Management Programming Manual . details on the TR3271 error numbers and associated error lists, see Appendix A in this manual. The possible nonzero values of RETCODE in response to the...
Page 109 The line and subdevices must be in the STARTED summary state when this command is issued. When the command is completed, the line and subdevices remain in the STARTED summary state. To establish a link between an AM3270 and TR3271 subdevice, use the CONNECT command. 6-45...
Page 110: Getversion Command
COMMANDS AND RESPONSES GETVERSION Command GETVERSION Command The GETVERSION command causes the TR3271 subsystem to return its server version and server-banner string. The server banner string reflects the product name, product number, and release date; for example, TR3271- T9372C20 - 15FEB89 The string can be a maximum of 50 bytes in length.
Page 111 ZSPI-TYP-CHAR50. ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL. Tokens in Command Buffer ZCOM-TKN-OBJNAME specifies the name of the TR3271 process that is to return the version information. The process name is the same as the line name. Your application must provide this token only if the value ZCOM-OBJ-PROC has been specified.
Page 112 5 for details. ZSPI-TKN-DATALIST indicates the beginning of a data list. "SPI Standard Definitions" in Section 5 for details. ZCOM-TKN-OBJNAME specifies the name of the TR3271 process to which the command was sent. The process name corresponds to the line name.
Page 113 COMMANDS AND RESPONSES GETVERSION Command ZCOM-ERR-CMD-MISMATCH (-4) Your management application tried to obtain version informa- tion for a line or subdevice using the value ZCOM-OBJ-LINE or ZCOM-OBJ-SU, respectively. This command is valid only for the object types ZCOM-OBJ-PROC and ZCOM-OBJ-NULL. ZSPI-TKN-SERVER-BANNER specifies the 50-byte character string that contains the server product name, product number, and release date.
Page 114: Info Command
COMMANDS AND RESPONSES INFO Command INFO Command The INFO command causes the TR3271 subsystem to return the values of the configurable attributes of the specified objects. These values are returned in the ZTR3-MAP-INFO-LINE and ZTR3-MAP-INFO- SU extensible structured tokens. When your management application issues the INFO command for a line, the subsystem checks for the optional subordinate-modifier token.
Page 115 COMMANDS AND RESPONSES INFO Command Command ZCOM-CMD-INFO Object Type ZCOM-OBJ-LINE ZCOM-OBJ-SU Tokens in Command Buffer ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZCOM-MAP-REQID !MAP is optional, but if present, !fields are required. def ZCOM-DDL-REQID. 02 ZCRTPID type ZSPI-DDL-CRTPID. 02 ZPAID type ZSPI-DDL-INT. end. ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-TIMESTAMP.
Page 116 COMMANDS AND RESPONSES INFO Command 02 ZMULTI-BLOCK type ZSPI-DDL-BOOLEAN. 02 ZOFFLINE-TIMER type ZSPI-DDL-TIMESTAMP. 02 ZPROG type ZSPI-DDL-FNAME. 02 ZREAD-CMD type ZSPI-DDL-ENUM. 02 ZRETRY type ZSPI-DDL-INT. 02 ZSYNCS type ZSPI-DDL-INT. 02 ZTEST-INTVL type ZSPI-DDL-TIMESTAMP. 02 ZTHRES type ZSPI-DDL-INT. 02 ZTIMEOUT type ZSPI-DDL-TIMESTAMP. 02 ZXLATE type ZSPI-DDL-BOOLEAN.
Page 117 COMMANDS AND RESPONSES INFO Command Tokens in Command Buffer ZCOM-TKN-OBJNAME specifies the line or subdevice for which information is to be returned. Your application must provide this token in the command. This token is described in "Data- Communications Standard Definitions" in Section 5, "Common Definitions,"...
Page 118 See "SPI Standard Definitions" in Section 5 for details. ZSPI-TKN-SERVER-VERSION indicates the software release version of the TR3271 subsystem. See "SPI Standard Definitions" in Section 5 for details. ZTR3-MAP-INFO-LINE is the extensible structured token that lists the current values of the configurable attributes for a line.
Page 119 RTS signal will not be dropped. The default value is ZSPI-VAL-FALSE. ZINIT-STATUS A 32-bit integer that specifies the initial IBM status that the TR3271 subsystem returns when it receives a SELECT for a subdevice that has not been OPENed or CONNECTed. The possible values are:...
Page 120 ZSPI-VAL-FALSE, it does not. default is ZSPI-VAL-FALSE. ZOFFLINE-TIMER A timestamp that specifies the period of time, in .01 seconds, that the TR3271 subsystem waits to receive a signal from the host. If the TR3271 subsystem does not receive anything within this interval, the host is considered down and a timeout error is reported.
Page 121 The default value for this field is ZTR3-VAL-READ-NONE. ZRETRY An integer that specifies the number of times the TR3271 retransmits data as a result of data link errors before returning an error. The value must be in the 1 through 14 range.
Page 122 EBCDIC character set. ZWACK-DELAY A timestamp that specifies the period of time, in .01 seconds, that the TR3271 subsystem waits before sending a wait for acknowledgement (WACK) to the host in response to a SELECT.
Page 123 COMMANDS AND RESPONSES INFO Command ZTR3-MAP-INFO-SU is the extensible structured token that lists the current values of the configurable attributes for a subde- vice. It has the token number ZTR3-TNM-INFO-SU and the DDL definition ZTR3-DDL-INFO-SU. This token must be in the response when the specified object is ZCOM-OBJ-SU or the LINE object has been specified with the subordinate modifier with the value ZCOM- VAL-SUB-ALL or ZCOM-VAL-SUB-ONLY.
Page 124 VAL-FALSE, it is not. The default is ZSPI-VAL- FALSE. Transparent-text mode can only be enabled if the TR3271 line is configured with the EBCDIC character set and transparent-text mode enabled. ZTYPE A pair of integers that specifies the device type and subtype of the subdevice.
Page 125 COMMANDS AND RESPONSES INFO Command ZSPI-TKN-ERRLIST indicates the beginning of an error list. "SPI Standard Definitions" in Section 5 for details. ZSPI-TKN-RETCODE specifies the return code for the command. This token is described in "SPI Standard Definitions" in Section 5 and the Distributed Systems Management (DSM) Programming Manual .
Page 126 COMMANDS AND RESPONSES INFO Command Operational Notes INFO is a nonsensitive command. The state of the line does not affect obtaining information for a line or subdevice. When the command is completed, the line and subdevice remain in the same summary state they were in before the command was executed.
Page 127: Listobjects Command
The objects listed depend on the value of the ZSPI-TKN-OBJECT-TYPE, ZCOM-TKN-OBJNAME, and ZSPI-TKN-SUB tokens. When your management application specifies the NULL object, all object types and object names known to the TR3271 subsystem are listed. The OBJNAME token must either have a zero length or not be present.
Page 128 COMMANDS AND RESPONSES LISTOBJECTS Command Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-NULL ZCOM-OBJ-LINE ZCOM-OBJ-SU Tokens in Command Buffer ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZCOM-MAP-REQID !MAP is optional, but if present, !fields are required. def ZCOM-DDL-REQID. 02 ZCRTPID type ZSPI-DDL-CRTPID. 02 ZPAID type ZSPI-DDL-INT. end. ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-TIMESTAMP.
Page 129 COMMANDS AND RESPONSES LISTOBJECTS Command Tokens in Command Buffer ZCOM-TKN-OBJNAME specifies the name of the object to be listed. Your application must provide this token in the command. This token is described in "Data-Communications Standard Definitions" in Section 5, "Common Definitions," and the Communications Management Programming Manual .
Page 130 5 for details. ZSPI-TKN-DATALIST indicates the beginning of a data list. "SPI Standard Definitions" in Section 5 for details. ZCOM-TKN-OBJNAME specifies the name of the TR3271 line or subdevice that was listed by the command. Unless there is an error that prevents the LISTOBJECTS command from being attempted at all, this token is present in every response record.
Page 131 COMMANDS AND RESPONSES LISTOBJECTS Command ZCOM-ERR-TKN-VAL-INV (-30) Your management application specified the SUB modifier with the value ZCOM-VAL-SUB-ONLY for the SU object. The SU object accepts only the value ZCOM-VAL-SUB-NONE or ZCOM-VAL-SUB-ALL for the SUB modifier. ZCOM-ERR-CMD-MISMATCH (-4) Your management application tried to list the name of a process by using the value ZCOM-OBJ-PROC.
Page 132: Load Command
COMMANDS AND RESPONSES LOAD Command LOAD Command The LOAD command causes the specified software to be downloaded to the Communications Line Interface Processor (CLIP). You can only specify the LINE object in the LOAD command. When your management application issues the LOAD command, the line must be in the STOPPED summary state and must not already be loaded.
Page 133 COMMANDS AND RESPONSES LOAD Command Tokens in Response Buffer ZSPI-TKN-SSID token-type ZSPI-TYP-SSID. ZSPI-TKN-SERVER-VERSION token-type ZSPI-TYP-INT. ZSPI-TKN-DATALIST token-type ZSPI-TYP-LIST. !... ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZCOM-TKN-OBJTYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ERRLIST token-type ZSPI-TYP-LIST. !... ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL. ZSPI-TKN-RETCODE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL. ZSPI-TKN-CONTEXT token-type ZSPI-TYP-BYTESTRING. Tokens in Command Buffer ZCOM-TKN-OBJNAME specifies the line for which the CLIP is to be downloaded.
Page 134 ZSPI-TKN-DATALIST indicates the beginning of a data list. "SPI Standard Definitions" in Section 5, "Common Definitions," and the Distributed Systems Management (DSM) Programming Manual . ZCOM-TKN-OBJNAME specifies the name of the TR3271 line for which the CLIP was downloaded. Unless there is an error that prevents the LOAD command from being attempted at all, this token is present in every response record.
Page 135 COMMANDS AND RESPONSES LOAD Command ZSPI-TKN-ENDLIST indicates the end of a data list or an error list. See "SPI Standard Definitions" in Section 5 for details. Operational Notes LOAD is a sensitive command. When the command is completed, the line remains in the STOPPED summary state.
Page 136: Reset Command
COMMANDS AND RESPONSES RESET Command RESET Command The RESET command places the CLIP in the boot state. The boot state allows your management application to download software to the CLIP. This command must be issued before you download a CLIP, unless the NOLOAD modifier is specified at system generation time.
Page 137 COMMANDS AND RESPONSES RESET Command Tokens in Response Buffer ZSPI-TKN-SSID token-type ZSPI-TYP-SSID. ZSPI-TKN-SERVER-VERSION token-type ZSPI-TYP-INT. ZSPI-TKN-DATALIST token-type ZSPI-TYP-LIST. !... ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZCOM-TKN-OBJTYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ERRLIST token-type ZSPI-TYP-LIST. !... ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL. ZSPI-TKN-RETCODE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL. ZSPI-TKN-CONTEXT token-type ZSPI-TYP-BYTESTRING. Tokens in Command Buffer ZCOM-TKN-OBJNAME specifies the line that is to be reset.
Page 138 5 for details. ZSPI-TKN-DATALIST indicates the beginning of a data list. "SPI Standard Definitions" in Section 5 for details. ZCOM-TKN-OBJNAME specifies the name of the TR3271 line that is to be reset. Unless there is an error that prevents the RESET command from being attempted at all, this token is present in every response record.
Page 139 COMMANDS AND RESPONSES RESET Command ZCOM-ERR-CMD-MISMATCH (-4) Your management application tried to reset a process by using the value ZCOM-OBJ-PROC or a subdevice by using the value ZCOM-OBJ-SU. The command is valid only for the value ZCOM- OBJ-LINE. ZCOM-ERR-CMD-INV-IN-SUMSTATE (-3) Your management application tried to reset a line that was not in the STOPPED summary state.
Page 140: Resetstats Command
The sample period is indicated by the ZRESET-TIME and ZSAMPLE-TIME fields. You can issue this command for a line or a subdevice, but not a process. The line summary state is not checked by the TR3271 subsystem when you issue the RESETSTATS command. Command ZCOM-CMD-RESETSTATS...
Page 141 COMMANDS AND RESPONSES RESETSTATS Command ZSPI-TKN-ALLOW-TYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-COMMENT token-type ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SSID token-type ZSPI-TYP-SSID. ZSPI-TKN-SERVER-VERSION token-type ZSPI-TYP-INT. ZSPI-TKN-DATALIST token-type ZSPI-TYP-LIST. !... ZTR3-MAP-RSTATS-LINE !OBJ-LINE !SUB def ZTR3-DDL-RSTATS-LINE. !All fields are present. 02 ZRESET-TIME type ZSPI-DDL-TIMESTAMP. 02 ZSAMPLE-TIME type ZSPI-DDL-TIMESTAMP.
Page 142 COMMANDS AND RESPONSES RESETSTATS Command ZCOM-TKN-OBJTYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ERRLIST token-type ZSPI-TYP-LIST. !... ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL. ZSPI-TKN-RETCODE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL. ZSPI-TKN-CONTEXT token-type ZSPI-TYP-BYTESTRING. Tokens in Command Buffer ZCOM-TKN-OBJNAME specifies the line and subdevices for which the subsystem is to return statistical information and reset counters.
Page 143 Each counter is defined in a separate field. The fields in the ZTR3-MAP-RSTATS-LINE token are as follows: ZRESET-TIME is the time that the TR3271 subsystem read the counters. This time indicates the end of the sample period. ZSAMPLE-TIME is the last time that the counters were reset.
Page 144 ZRETRY is the number of retries attempted by the TR3271 subsystem at level 2 for the specified line. ZMSG-L256-SENT is the number of messages, which were less than 256 bytes in length, that the TR3271 subsystem sent to the specified line. ZMSG-L256-RECVED is the number of messages, which were less than 256 bytes in length, that the TR3271 subsystem received from the specified line.
Page 145 COMMANDS AND RESPONSES RESETSTATS Command ZMSG-G1024-SENT is the number of messages, which were greater than 1024 bytes in length, that the TR3271 subsys- tem sent to the specified line. ZMSG-G1024-RECVED is the number of messages, which were greater than 1024 bytes in length, that the TR3271 subsys- tem received from the specified line.
Page 146 COMMANDS AND RESPONSES RESETSTATS Command ZSPI-TKN-RETCODE specifies the return code for the command. This token is described in "SPI Standard Definitions" in Section 5 and the Distributed Systems Management (DSM) Programming Manual . For details on the data-communications error numbers and their associated error lists, see "Common Error Numbers and Error Lists"...
Page 147 COMMANDS AND RESPONSES RESETSTATS Command Operational Notes RESETSTATS is a sensitive command. When the command is completed, the line and subdevices remain in the same summary state they were in before the command was executed. The summary state of the line is not checked when the command is issued.
Page 148: Start Command
COMMANDS AND RESPONSES START Command START Command The START command initiates the operation of lines and subde- vices. When the subsystem completes processing this command, the specified object is placed in the STARTED summary state. You can start a line or a subdevice, but not a process. When you are using the START command, the line must be in the STOPPED summary state;...
Page 149 COMMANDS AND RESPONSES START Command 02 ZCRTPID type ZSPI-DDL-CRTPID. 02 ZPAID type ZSPI-DDL-INT. end. ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-TIMESTAMP. ZCOM-TKN-SUB token-type ZSPI-TYP-ENUM. ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32. ZSPI-TKN-SSID token-type ZSPI-TYP-SSID. ZSPI-TKN-MAXRESP token-type ZSPI-TYP-INT. ZSPI-TKN-CONTEXT token-type ZSPI-TYP-BYTESTRING. ZSPI-TKN-RESPONSE-TYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ALLOW-TYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-COMMENT token-type ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SSID token-type ZSPI-TYP-SSID.
Page 150 ZCOM-VAL-SUB-ALL If the object type is LINE, start the named line and all its subordinate subdevices. TR3271 subsystem starts the line first, then the associated subdevices. If the object type is SU, start the named subdevice only; the line must already be in the STARTED summary state.
Page 151 COMMANDS AND RESPONSES START Command ZCOM-TKN-OBJNAME specifies the name of the TR3271 line or subdevice that was started by the command. Unless there is an error that prevents the START command from being attempted at all, this token is present in every response record.
Page 152 COMMANDS AND RESPONSES START Command ZCOM-ERR-CMD-MISMATCH (-4) Your management application tried to start a process by using the value ZCOM-OBJ-PROC. The command is valid only for the values ZCOM-OBJ-LINE or ZCOM-OBJ-SU. ZCOM-ERR-CMD-INV-IN-SUMSTATE (-3) Your management application tried to start a line or a subdevice while the line was in the DIAGNOSING summary state.
Page 153: Statistics Command
You can issue this command for a line or a subdevice, but not a process. The line summary state is not checked by the TR3271 subsystem when you issue the STATISTICS command. All valid users can issue the STATISTICS command.
Page 154 COMMANDS AND RESPONSES STATISTICS Command ZSPI-TKN-CONTEXT token-type ZSPI-TYP-BYTESTRING. ZSPI-TKN-RESPONSE-TYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ALLOW-TYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-COMMENT token-type ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SSID token-type ZSPI-TYP-SSID. ZSPI-TKN-SERVER-VERSION token-type ZSPI-TYP-INT. ZSPI-TKN-DATALIST token-type ZSPI-TYP-LIST. !... ZTR3-MAP-STATS-LINE !OBJ-LINE !SUB def ZTR3-DDL-STATS-LINE. !All fields are present. 02 ZRESET-TIME type ZSPI-DDL-TIMESTAMP.
Page 155 COMMANDS AND RESPONSES STATISTICS Command ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZCOM-TKN-OBJTYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ERRLIST token-type ZSPI-TYP-LIST. !... ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL. ZSPI-TKN-RETCODE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL. ZSPI-TKN-CONTEXT token-type ZSPI-TYP-BYTESTRING. Tokens in Command Buffer ZCOM-TKN-OBJNAME specifies the line and subdevices for which the subsystem it to return statistical information. Your application must provide this token in the command.
Page 156 Each counter is defined in a separate field. The fields in the ZTR3-MAP-STATS-LINE token are as follows: ZRESET-TIME is the time that the TR3271 subsystem read the counters. This time indicates the end of the sample period. ZSAMPLE-TIME is the last time that the counters were reset.
Page 157 ZRETRY is the number of retries attempted by the TR3271 subsystem at level 2 for the specified line. ZMSG-L256-SENT is the number of messages, which were less than 256 bytes in length, that the TR3271 subsystem sent to the specified line. ZMSG-L256-RECVED is the number of messages, which were less than 256 bytes in length, that the TR3271 subsystem received from the specified line.
Page 158 COMMANDS AND RESPONSES STATISTICS Command ZMSG-G1024-RECVED is the number of messages, which were greater than 1024 bytes in length, that the TR3271 subsys- tem received from the specified line. ZTR3-MAP-STATS-SU is the extensible structured token that lists the statistical counters obtained during the sample period for the specified subdevice.
Page 159 COMMANDS AND RESPONSES STATISTICS Command ZSPI-TKN-RETCODE specifies the return code for the command. This token is described in "SPI Standard Definitions" in Section 5 and the Distributed Systems Management (DSM) Programming Manual . For details on the data-communications error numbers and their associated error lists, see "Common Error Numbers and Error Lists"...
Page 160 COMMANDS AND RESPONSES STATISTICS Command Operational Notes STATISTICS is a nonsensitive command; any valid user can issue this command. The summary state of the line does not prevent the successful completion of the STATISTICS command. To initialize the statistical counters after the reply message is built, use the RESETSTATS command.
Page 161: Status Command
You can inquire about the status of a line or a subdevice, but not a process. When your management application issues the STATUS command, the TR3271 checks for the SUB modifier and the select-state modifier. The SUB modifier allows your management application to determine whether the command affects subordinate objects.
Page 162 COMMANDS AND RESPONSES STATUS Command Command ZCOM-CMD-STATUS Object Type ZCOM-OBJ-LINE ZCOM-OBJ-SU Tokens in Command Buffer ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZCOM-MAP-REQID !MAP is optional, but if present, !fields are required. def ZCOM-DDL-REQID. 02 ZCRTPID type ZSPI-DDL-CRTPID. 02 ZPAID type ZSPI-DDL-INT. end. ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-TIMESTAMP.
Page 163 COMMANDS AND RESPONSES STATUS Command 04 ZPIN type ZSPI-DDL-INT. 02 ZBPID. 04 ZCPU type ZSPI-DDL-INT. 04 ZPIN type ZSPI-DDL-INT. 02 ZPATH type ZSPI-DDL-ENUM. 02 ZCSM-LDEV type ZSPI-DDL-INT. 02 ZCU-PRIM type ZSPI-DDL-INT. 02 ZCU-BKUP type ZSPI-DDL-INT. 02 ZDEBUG type ZSPI-DDL-BOOLEAN. 02 ZTRACE type ZSPI-DDL-BOOLEAN.
Page 164 COMMANDS AND RESPONSES STATUS Command Tokens in Command Buffer ZCOM-TKN-OBJNAME specifies the line and subdevices for which information is requested. Your application must provide this token in the command. This token is described in "Data- Communications Standard Definitions" in Section 5, "Common Definitions,"...
Page 165 COMMANDS AND RESPONSES STATUS Command The STATUS command is the only TR3271 command that supports the select-state modifier. The possible values are as follows: TRUE STARTED Return information for the named object in the STARTED summary state. If the SUB modifier...
Page 166 See "SPI Standard Definitions" in Section 5 for details. ZSPI-TKN-SERVER-VERSION indicates the software release version of the TR3271 subsystem. See "SPI Standard Definitions" in Section 5 for details. ZTR3-MAP-STATUS-LINE is the extensible structured token that contains status information for a line that has been queried.
Page 167 COMMANDS AND RESPONSES STATUS Command ZBPID is a structure that contains the process ID information for the backup process. ZBPID consists of the following fields: ZCPU is the CPU in which the backup process is executing. ZPIN is the Process Identification Number assigned by the operating system to identify the backup process in the CPU.
Page 168 COMMANDS AND RESPONSES STATUS Command ZIO-ADDR-PRIM is the I/O address of the primary process. ZIO-ADDR-BKUP is the I/O address of the backup process. ZTR3-MAP-STATUS-SU is the extensible structured token that con- tains status information for the subdevices that have been queried.
Page 169 The subdevice is a PTP device. ZSPI-VAL-FALSE The subdevice is not a PTP device. ZHIS-SYS-NUM is the number of the system on which the TR3271 subdevice resides. This field applies only to PTP subdevices. ZHIS-LDEV is the number of the line to which the TR3271 subdevice is subordinate.
Page 170 "Common Error Numbers and Error Lists" in the Communications Management Programming Manual . details on the TR3271 error numbers and their associated error lists, see Appendix A in this manual. The possible nonzero values of RETCODE in response to the STATUS...
Page 171 COMMANDS AND RESPONSES STATUS Command ZTR3-ERR-NO-OBJ-IN-SEL-STATE (7) Your management application has specified the select-state modifier, but there are no objects currently in the selected state. ZSPI-TKN-ENDLIST indicates the end of a data list or an error list. See "SPI Standard Definitions" in Section 5 for details. ZSPI-TKN-CONTEXT specifies whether there are more reply messages to be received for a response.
Page 172: Stop Command
If there are subdevices open or there is an AM3270 subdevice connected to a TR3271 subdevice, the subsystem rejects the command and returns an error. This command cannot be issued when the line is in the STARTED summary state with subdevices open or connected, or when the line is in the DIAGNOSING state.
Page 173 COMMANDS AND RESPONSES STOP Command Command ZCOM-CMD-STOP Object Type ZCOM-OBJ-LINE ZCOM-OBJ-SU Tokens in Command Buffer ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZCOM-MAP-REQID !MAP is optional, but if present, !fields are required. def ZCOM-DDL-REQID. 02 ZCRTPID type ZSPI-DDL-CRTPID. 02 ZPAID type ZSPI-DDL-INT. end. ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-TIMESTAMP.
Page 174 COMMANDS AND RESPONSES STOP Command Tokens in Command Buffer ZCOM-TKN-OBJNAME specifies the line and subdevices that are to be terminated. Your application must provide this token in the command. This token is described in "Data-Communications Standard Definitions" in Section 5, "Common Definitions," and the Communications Management Programming Manual .
Page 175 "Common Error Numbers and Error Lists" in the Communications Management Programming Manual . details on the TR3271 error numbers and their associated error lists, see Appendix A in this manual. The possible nonzero values of RETCODE in response to the STOP...
Page 176 LINE or SU object type, but a PTP subdevice is currently connected to a TR3271 subdevice. Your management application must disconnect the TR3271 subdevice before stopping it. ZTR3-ERR-SU-OPENED (13) Your management application has issued the STOP command but an SU is currently opened by an application.
Page 177 COMMANDS AND RESPONSES STOP Command ZSPI-TKN-ENDLIST indicates the end of a data list or an error list. See "SPI Standard Definitions" in Section 5 for details. ZSPI-TKN-CONTEXT specifies whether there are more reply messages to be received for a response. If this token is present, the response continues to the next reply message.
Page 178: Switch Command
The SWITCH command switches a process to another CPU or a line to another path. However, if the TR3271 I/O process is running in a single-port CIU-based implementation of 6100 CSS, both the CPU and path are switched when your management application issues the SWITCH command.
Page 179 COMMANDS AND RESPONSES SWITCH Command def ZCOM-DDL-REQID. 02 ZCRTPID type ZSPI-DDL-CRTPID. 02 ZPAID type ZSPI-DDL-INT. end. ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-TIMESTAMP. ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32. ZSPI-TKN-SSID token-type ZSPI-TYP-SSID. ZSPI-TKN-MAXRESP token-type ZSPI-TYP-INT. ZSPI-TKN-RESPONSE-TYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ALLOW-TYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-COMMENT token-type ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SSID token-type ZSPI-TYP-SSID.
Page 180 5 for details. ZSPI-TKN-DATALIST indicates the beginning of a data list. "SPI Standard Definitions" in Section 5 for details. ZCOM-TKN-OBJNAME specifies the name of the process or TR3271 line that was switched by the command. The process name is the same as the line name in the TR3271 subsystem.
Page 181 COMMANDS AND RESPONSES SWITCH Command ZCOM-TKN-OBJTYPE specifies the type of object that was switched. This token can have the value ZCOM-OBJ-PROC or ZCOM-OBJ-LINE. This token is described in "Data-Communications Standard Definitions" in Section 5, "Common Definitions," and the Communications Management Programming Manual . ZSPI-TKN-ERRLIST indicates the beginning of an error list.
Page 182 COMMANDS AND RESPONSES SWITCH Command ZCOM-ERR-ALRDY-USING-RES (-1) Your management application has tried to switch to the current CPU or the current path. This is a warning. A ZSPI-TKN- RETCODE of 0 is returned; however, a -1 is within the error list.
Page 183: Trace Command
Instead, your management application issues the command to SCP, which then invokes the CMP Trace Collector (CMPTC). The CMPTC sends a CMP-format LCB to the TR3271 subsystem to start tracing the selected records. When your management application issues the TRACE command, the specified line enters trace mode.
Page 184 COMMANDS AND RESPONSES TRACE Command Command ZCOM-CMD-TRACE Object Type ZCOM-OBJ-LINE Tokens in Command Buffer ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZCOM-MAP-TRACE-MODIF def ZCOM-DDL-TRACE-MODIF. !All fields must be specified. 02 ZSTOP type ZSPI-DDL-BOOLEAN. 02 ZPRIM type ZSPI-DDL-BOOLEAN. 02 ZREC-SIZE type ZSPI-DDL-INT. 02 ZCNT type ZSPI-DDL-INT2. 02 ZXDS-PAGES type ZSPI-DDL-INT.
Page 185 COMMANDS AND RESPONSES TRACE Command Tokens in Response Buffer ZSPI-TKN-SSID token-type ZSPI-TYP-SSID. ZSPI-TKN-SERVER-VERSION token-type ZSPI-TYP-INT. ZSPI-TKN-DATALIST token-type ZSPI-TYP-LIST. ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZCOM-TKN-OBJTYPE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ERRLIST token-type ZSPI-TYP-LIST. ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL. ZSPI-TKN-RETCODE token-type ZSPI-TYP-ENUM. ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSCTL. Tokens in Command Buffer ZCOM-TKN-OBJNAME specifies the line that is to be traced.
Page 186 COMMANDS AND RESPONSES TRACE Command ZTR3-VAL-TRACE-OPT-CLBI Trace CLB inbound frames. ZTR3-VAL-TRACE-OPT-CLBO Trace CLB outbound frames. ZTR3-VAL-TRACE-OPT-CLIP Enables CLIP tracing. This bit must be set on, if one or more bits in the 16 through 29 range is to be set. ZTR3-VAL-TRACE-OPT-CLIPDI Trace CLIP inbound frames.
Page 187 This token is described in the Distributed Systems Management (DSM) Programming Manual . ZCOM-TKN-OBJNAME specifies the name of the TR3271 line that was traced. Unless there is an error that prevents the TRACE command from being attempted at all, this token is present in every response record.
Page 188 COMMANDS AND RESPONSES TRACE Command ZSPI-TKN-ENDLIST indicates the end of a data list or an error list. See "SPI Standard Definitions" in Section 5 for details. ZSPI-TKN-CONTEXT specifies whether there are more reply messages to be received for a response. If this token is present, the response continues to the next reply message.
Page 189: Tr3271 Event Management
ID ZTR3-VAL-SSID which is described in "SPI Standard Definitions" in Section 5. For more information about subsystem IDs, refer to the Distributed Systems Management (DSM) Programming Manual . Table 7-1 lists the event messages that the TR3271 subsystem can issue.
Page 190: Tr3271 Event Messages
TR3271 Event Messages EVENT SYMBOLIC NAME DESCRIPTION NUMBER (ZTR3-EVT-) IOBUS-ERR I/O-bus error CIU-ERR CIU-status error OBJ-STARTED TR3271 line brought up OBJ-STOPPED TR3271 line brought down SUBDEV-ERR Subdevice error INTL-ERR Internal error PROC-ABEND SYSGEN parameter error INSUFF-BUF Line handler buffer too...
Page 191: Critical Events
If the value is ZSPI-VAL-FALSE, the event is not critical. EVENT-MANAGEMENT PROGRAMMING The buffer size for a TR3271 event message is 512 bytes. value ZTR3-VAL-EVT-BUFLEN defines the buffer size for TR3271. TR3271 event messages are made up of individual tokens, each containing one piece of information about the event.
Page 192: Event-Message Descriptions
TR3271 EVENT MANAGEMENT Event-Management Programming Any of the tokens in an event message can be used for selecting the event messages returned to an application. You can create filters that return only critical event messages, all event messages associated with a particular device, all event messages with a certain event number, and so forth.
Page 193 ZEMS-MAP-EXIOADDR token results because the physical I/O address without conversion will not fit into the ZEMS-TKN-CU token; the TR3271 subsystem will not place the ZEMS-TKN-CU into the event message buffer because the token would be meaningless. The formatting for the display is done using display-text procedures which are the application interface to the DSM Template Services.
Page 194: 3: Ztr3-Evt-Iobus-Err
TR3271 EVENT MANAGEMENT 3: ZTR3-EVT-IOBUS-ERR ZTR3-EVT-IOBUS-ERR An I/O-bus error occurred during a data transfer. This event is critical and the event message is reported to the EMS collector ($0). This event message is equivalent to console message 03. Unconditional Tokens ZSPI-TKN-SSID token-type ZSPI-TYP-SSID.
Page 195 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 196 Probable Cause An I/O-bus error occurred during a data transfer with the indicated line. The TR3271 subsystem switches to the backup process and aborts all requests. Note that the backup process does not retry the operation once the switch has occurred.
Page 197 TR3271 EVENT MANAGEMENT 3: ZTR3-EVT-IOBUS-ERR Recommended Action Errors 215 and 216 indicate there is a possible problem with the application or access method software. Report this message and other related console messages to your Tandem representative. The remaining errors indicate a possible hardware problem.
Page 198: 4: Ztr3-Evt-Ciu-Err
TR3271 EVENT MANAGEMENT 4: ZTR3-EVT-CIU-ERR ZTR3-EVT-CIU-ERR An error occurred on the indicated TR3271 line and the I/O retry did not succeed. This event is critical, and the event message is reported to the EMS collector ($0). Another path or CPU is tried.
Page 199 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 200 If another path or processor is not available, the system brings down the line. The value ciu-status in the text message indicates CIU-status information. For a TR3271 communications line, this information is the status word returned by the controller, in the format described below. 7-12...
Page 201 (ABORT) reserved--should not happen (ABORT) reserved--should not happen (ABORT) reserved--should not happen (ABORT) reserved--should not happen (ABORT) The values of param 1 , param 2 , and param 3 are always 0. They are meaningless for the TR3271 subsystem. 7-13...
Page 202 TR3271 EVENT MANAGEMENT 4: ZTR3-EVT-CIU-ERR Recommended Action The information given by the value ciu-status in the text message usually indicates a hardware problem; contact your Tandem representative. 7-14...
Page 203: 6: Ztr3-Evt-Obj-Started
Event-Message Text Display and Console-Compatible Format: LDEV ldev ldevname UP Unconditional Tokens ZSPI-TKN-SSID is the TR3271 subsystem ID, and its value is ZTR3-VAL-SSID. This token is described in the Distributed Systems Management (DSM) Programming Manual . ZEMS-TKN-EVENTNUMBER is the event number.
Page 204 TR3271 EVENT MANAGEMENT 6: ZTR3-EVT-OBJ-STARTED ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message. It corresponds to the value ldev in the text message.
Page 205 START command, or interactively using the SCF or CMI START LINE command. For a description of the programmatic START command for TR3271, see "START Command" in Section 6, "Commands and Responses." The operation is completed.
Page 206: 7: Ztr3-Evt-Obj-Stopped
TR3271 EVENT MANAGEMENT 7: ZTR3-EVT-OBJ-STOPPED ZTR3-EVT-OBJ-STOPPED The indicated TR3271 line has been brought down. This event can be a critical or a noncritical event, depending on the cause of the line being brought down. However, the EMPHASIS token always has the value ZSPI-VAL-TRUE.
Page 207 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 208 The TR3271 line has been brought down programmatically with the STOP or ABORT command or interactively with the SCF or CMI STOP or ABORT command, or the TR3271 subsystem brought down the line because of errors. All activity on the line stops.
Page 209: 67: Ztr3-Evt-Subdev-Err
Display and Console-Compatible Format: LDEV ldev ldevname SUBDEV # ddd ERROR # file-err Unconditional Tokens ZSPI-TKN-SSID is the TR3271 subsystem ID, and its value is ZTR3-VAL-SSID. This token is described in "SPI Standard Definitions" in Section 5. ZEMS-TKN-EVENTNUMBER is the event number.
Page 210 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 211 ZTR3-TKN-SU, and file-err corresponds to the value of ZTR3-TKN-FILE-ERR. Probable Cause An operation or a request to the indicated TR3271 subdevice is The value ldev identifies the TR3271 line, the value incorrect. ddd identifies the subdevice, and the value file-err identifies the file-system error number.
Page 212: 74: Ztr3-Evt-Intl-Err
TR3271 EVENT MANAGEMENT 74: ZTR3-EVT-INTL-ERR ZTR3-EVT-INTL-ERR An internal error has been detected. This event can be both a critical and a noncritical event, and the event message is reported to the EMS collector ($0). This event message is equivalent to console message 74.
Page 213 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 214 After this event message is issued, application requests are aborted and the TR3271 subsystem recovers. Recommended Action If the TR3271 subsystem can recover from the internal error, you can continue to run. Otherwise, report this and other related event messages to your Tandem representative.
Page 215: 90: Ztr3-Evt-Proc-Abend
Display and Console-Compatible Format: LDEV ldev ldevname I/O PROCESS ABEND CODE: # nnnnn Unconditional Tokens ZSPI-TKN-SSID is the TR3271 subsystem ID, and its value is This token is described in the Distributed ZTR3-VAL-SSID. Systems Management (DSM) Programming Manual . ZEMS-TKN-EVENTNUMBER is the event number.
Page 216 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 217 TR3271 EVENT MANAGEMENT 90: ZTR3-EVT-PROC-ABEND Probable Cause The necessary system resources could not be allocated to the TR3271 I/O process or a COUP parameter is incorrect or inconsis- tent. The I/O process stops and cannot be used. The TR3271 process deletes itself.
Page 218 TR3271 EVENT MANAGEMENT 90: ZTR3-EVT-PROC-ABEND Recommended Action If the error code is memory-related (1-999), take a memory dump and contact your Tandem representative. If the error code is configuration-related (1000-1999), reconfigure the process correctly using COUP commands, and restart the process.
Page 219: 106: Ztr3-Evt-Insuff-Buf
TR3271 EVENT MANAGEMENT 106: ZTR3-EVT-INSUFF-BUF 106: ZTR3-EVT-INSUFF-BUF The dedicated buffer space for the TR3271 line handler was too small. The line-handler cannot operate properly. This event is critical, and the event message is reported to the EMS collector ($0). This event message is equivalent to console message 106.
Page 220 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 221 TR3271 EVENT MANAGEMENT 106: ZTR3-EVT-INSUFF-BUF Event-Message Text In the text message, ldev corresponds to the value of ZEMS-TKN- LDEV and ldevname corresponds to the value of ZEMS-TKN-LDEVNAME. Probable Cause The MAXLOCALAREA modifier defined in SYSGEN does not specify the necessary buffer space.
Page 222: 112: Ztr3-Evt-Discard-Err
112: ZTR3-EVT-DISCARD-ERR 112: ZTR3-EVT-DISCARD-ERR Data sent from the host to a TR3271 subdevice has been discarded. This event is critical, and the event message is reported to the EMS collector ($0). This event message is equivalent to console message 112.
Page 223 TR3271 EVENT MANAGEMENT 112: ZTR3-EVT-DISCARD-ERR ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message. It corresponds to the value ldev in the message text.
Page 224 ALTER command described in Section 8, or the SCF or CMI ALTER command. An INITSTATUS of %177777 causes the TR3271 subsystem to respond to SELECTs, sent from a host to subdevices that are neither OPENed nor CONNECTed, with an ACK0.
Page 225: 141: Ztr3-Evt-Clip-Dwload
TR3271 EVENT MANAGEMENT 141: ZTR3-EVT-CLIP-DWLOAD 141: ZTR3-EVT-CLIP-DWLOAD The Communications Line Interface Processor (CLIP) of the 6100 Communications Subsystem (CSS) was successfully downloaded. This is a noncritical event, and the event message is reported to the EMS collector ($0). This event message is equivalent to console message 141.
Page 226 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 227 TR3271 EVENT MANAGEMENT 141: ZTR3-EVT-CLIP-DWLOAD Volatile Tokens ZEMS-TKN-CU is a standard EMS token that contains the controller and unit number. This token is present in the event buffer only if the controller uses subchannel-type I/O addressing. Event-Message Text In the text message, ldev corresponds to the value of ZEMS-TKN- LDEV, n,n,%nn,%nnn corresponds to the value of ZEMS-MAP-EXIOADDR, and ldevname corresponds to the value of ZEMS-TKN-LDEVNAME.
Page 228: 147: Ztr3-Evt-Css-Probe-Err
TR3271 EVENT MANAGEMENT 147: ZTR3-EVT-CSS-PROBE-ERR 147: ZTR3-EVT-CSS-PROBE-ERR The TR3271 I/O process did not receive a status probe response from the Communications Line Interface Processor (CLIP). Typically, this indicates the CLIP is in the boot state instead of the run state.
Page 229 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 230 CLIP indicating that it is in the boot state instead of the run state. The TR3271 subsystem attempts to download the CLIP again. If this cannot be done on the primary path, TR3271 attempts a download on another path. The value path indicates the primary path.
Page 231 TR3271 EVENT MANAGEMENT 147: ZTR3-EVT-CSS-PROBE-ERR Recommended Action Decode the CLIP status byte given by the value probe-err of the message text to determine which error occurred, and note the error for your Tandem representative. If the CLIP does not restart automatically, try to restart it manually.
Page 232: 157: Ztr3-Evt-Css-Frame-Err
TR3271 EVENT MANAGEMENT 157: ZTR3-EVT-CSS-FRAME-ERR 157: ZTR3-EVT-CSS-FRAME-ERR An invalid frame was received. The IOP may detect this error when the CLIP resets itself. The CLIP may reset itself as a result of a problem it detects. This event is critical, and the event message is reported to the EMS collector ($0).
Page 233 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 234 TR3271 EVENT MANAGEMENT 157: ZTR3-EVT-CSS-FRAME-ERR ZTR3-TKN-ADDR-CTL is the A and C fields. It corresponds to the value param1 in the message text. ZTR3-TKN-TYPE-SEQ is the T and S fields. It corresponds to the value param2 in the message text. For details on any of the EMS tokens, refer to the Event Management Service (EMS) Manual .
Page 235 TR3271 EVENT MANAGEMENT 157: ZTR3-EVT-CSS-FRAME-ERR The value frame-err in the message text indicates the reason for the error, and it can have the following values: Unexpected frame Invalid A field (address) Invalid C field (control) Invalid T field (type) Invalid S field (sequence number)
Page 236: Ztr3-Evt-Css-Unexp-Brkpt
TR3271 EVENT MANAGEMENT 158: ZTR3-EVT-CSS-UNEXP-BRKPT 158: ZTR3-EVT-CSS-UNEXP-BRKPT The Communications Line Interface Processor (CLIP) of the 6100 Communications Subsystem (CSS) encountered an unexpected break- point. This event is critical, and the event message is reported to the EMS collector ($0). This event message is equivalent to console message 158.
Page 237 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 238 TR3271 EVENT MANAGEMENT 158: ZTR3-EVT-CSS-UNEXP-BRKPT Volatile Tokens ZEMS-TKN-CU is a standard EMS token that contains the controller and unit number. This token is present in the event buffer only if the controller uses subchannel-type I/O addressing. Event-Message Text In the message text, ldev corresponds to the value of ZEMS-...
Page 239: Ztr3-Evt-Css-Liu-Config-Err
TR3271 EVENT MANAGEMENT 160: ZTR3-EVT-CSS-LIU-CONFIG-ERR 160: ZTR3-EVT-CSS-LIU-CONFIG-ERR The Communications Line Interface Processor (CLIP) of the 6100 Communications Subsystem (CSS) received a line configuration different from that in the I/O process. This event is critical, and the event message is reported to the EMS collector ($0).
Page 240 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 241 TR3271 EVENT MANAGEMENT 160: ZTR3-EVT-CSS-LIU-CONFIG-ERR ZTR3-TKN-CONFIG-ERR is the type of configuration error that has occurred. It corresponds to the value config-err in the message text. ZTR3-TKN-CLIP-FUNC is the CLIP function and modifier. corresponds to the value param1 in the message text.
Page 242: Ztr3-Evt-Css-Line-Err
164: ZTR3-EVT-CSS-LINE-ERR 164: ZTR3-EVT-CSS-LINE-ERR The Communications Line Interface Processor (CLIP) of the 6100 Communications Subsystem (CSS) responded to the TR3271 I/O process with an invalid function modifier. This event is critical, and the event message is reported to the EMS collector ($0).
Page 243 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 244 TR3271 EVENT MANAGEMENT 164: ZTR3-EVT-CSS-LINE-ERR ZTR3-TKN-CLIP-SU is the CLIP subdevice number. It corresponds to the value param3 in the message text. ZTR3-TKN-CLIP-STATUS is the status returned by the CLIP. corresponds to the value param2 in the message text. Volatile Tokens ZEMS-TKN-CU is a standard EMS token that contains the controller and unit number.
Page 245 TR3271 EVENT MANAGEMENT 164: ZTR3-EVT-CSS-LINE-ERR Value Meaning Modem error or loss BCC error Not used Not used Invalid response for protocol No buffer space in device Improper buffer format Read buffer too small Reset request received EOT received Unknown device status...
Page 246: Ztr3-Evt-Css-Subdev-Err
165: ZTR3-EVT-CSS-SUBDEV-ERR The Communications Line Interface Processor (CLIP) of the 6100 Communications Subsystem (CSS) responded to the TR3271 I/O process with an invalid subdevice state. This event is critical, and the event message is reported to the EMS collector ($0).
Page 247 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 248 TR3271 EVENT MANAGEMENT 165: ZTR3-EVT-CSS-SUBDEV-ERR ZTR3-TKN-CLIP-SU is the CLIP subdevice number. It corresponds to the value param1 in the message text. ZTR3-TKN-CLIP-STATUS is the status returned by the CLIP. corresponds to the value param3 in the message text. Volatile Tokens ZEMS-TKN-CU is a standard EMS token that contains the controller and unit number.
Page 249 TR3271 EVENT MANAGEMENT 165: ZTR3-EVT-CSS-SUBDEV-ERR Value Meaning No response Modem error or loss BCC error Not used Not used Invalid response for protocol No buffer space in device Improper buffer format Read buffer too small Reset request received EOT received...
Page 250: Zcom-Evt-Cpu-Switch
TR3271 EVENT MANAGEMENT -1: ZCOM-EVT-CPU-SWITCH ZCOM-EVT-CPU-SWITCH The TR3271 I/O process has switched to its backup CPU. This event is not critical, and the event message is reported to the EMS collector ($0). Unconditional Tokens ZSPI-TKN-SSID token-type ZSPI-TYP-SSID. ZEMS-TKN-EVENTNUMBER token-type ZSPI-TYP-ENUM.
Page 251 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 252 ZCOM-TKN-NEW-CPU, and reason corresponds to the value of ZCOM-TKN-CAUSE-CPU-SWITCH. Probable Cause The TR3271 I/O process switches to the backup CPU as a result of a SWITCH command or as a result of a software or hardware error.
Page 253: Zcom-Evt-Path-Switch
TR3271 EVENT MANAGEMENT -2: ZCOM-EVT-PATH-SWITCH ZCOM-EVT-PATH-SWITCH The TR3271 I/O process has switched to its backup CIU path or the CIU path has been activated for the first time. This event is not critical, and the event message is reported to the EMS collector ($0).
Page 254 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 255 TR3271 EVENT MANAGEMENT -2: ZCOM-EVT-PATH-SWITCH ZCOM-TKN-OLD-PATH is the primary PATH before the switch took place. It corresponds to the value of path1 in the message text. The possible values are ZCOM-VAL-PATH-A (displayed as A), ZCOM- VAL-PATH-B (displayed as B), and ZCOM-VAL-PATH-UNDEF (undefined).
Page 256 TR3271 EVENT MANAGEMENT -2: ZCOM-EVT-PATH-SWITCH Probable Cause The TR3271 I/O process switches to the backup PATH as a result of a SWITCH command or as a result of a software or hardware error. The SWITCH command can be issued programmatically or interactively.
Page 257: Zcom-Evt-Sumstate-Chg
TR3271 EVENT MANAGEMENT -3: ZCOM-EVT-SUMSTATE-CHG ZCOM-EVT-SUMSTATE-CHG The state of a TR3271 object has changed. This event is not critical, and the event message is reported to the EMS collector ($0). Unconditional Tokens ZSPI-TKN-SSID token-type ZSPI-TYP-SSID. ZEMS-TKN-EVENTNUMBER token-type ZSPI-TYP-ENUM. ZEMS-TKN-SUBJECT-MARK token-type ZSPI-TYP-MARK.
Page 258 ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME. ZEMS-TKN-LDEVNAME is the name of the TR3271 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the TR3271 line that is the subject of this event message.
Page 259 ZCOM-TKN-OBJSTATE, and reason corre- sponds to the value of ZCOM-TKN-CAUSE-SUMSTATE-CHG. Probable Cause The summary state of a TR3271 object has changed. This can be as a result of a command or an error. Recommended Action If a command caused the state change, no action is necessary.
Page 260: Examples Of Filters
TR3271 event messages. For both examples, the following assumptions have been made: All TR3271 definitions used in the filters have been loaded into TACL before compilation. All subsytem IDs that are not initialized in the filter have been initialized by other means.
Page 261: Example 2
TR3271 EVENT MANAGEMENT Example 2 Example 2 The following filter selects all the critical TR3271 event messages that have a particular line as their subject. -- Filter that selects only critical TR3271 event messages -- that have as their subject token a particular line name.
Page 262: Appendix A. Error Numbers And Error Lists
ZSPI-TKN-RETCODE for each of the commands in Section 6, "Commands and Responses." For a description of the common errors returned by the TR3271 subsystem, refer to "Common Error Numbers and Error Lists" in the Communications Management Programming Manual .
Page 263 ERROR NUMBERS AND ERROR LISTS Notation Used The tokens ZSPI-TKN-ERRLIST and ZSPI-TKN-ENDLIST serve the same function in all error lists. They are not described in this section. Information about these tokens can be found in the Distributed Systems Management (DSM) Programming Manual .
Page 264: Ztr3-Err-Clip-Prob
ERROR NUMBERS AND ERROR LISTS ZTR3-ERR-CLIP-PROB ZTR3-ERR-CLIP-PROB The command failed because of an internal CLIP problem. When this error occurs, the TR3271 subsystem sends event message 164 or 165 to the EMS collector, $0. ZSPI-TKN-ERRLIST type ZSPI-TYP-LIST ZSPI-TKN-ERROR type ZSPI-TYP-ERROR...
Page 265: Ztr3-Err-Target-Obj-Not-Found
ERROR NUMBERS AND ERROR LISTS ZTR3-ERR-TARGET-OBJ-NOT-FOUND ZTR3-ERR-TARGET-OBJ-NOT-FOUND The CONNECT or DISCONNECT command has been issued, but the specified target AM3270 subdevice does not exist. ZSPI-TKN-ERRLIST type ZSPI-TYP-LIST ZSPI-TKN-ERROR type ZSPI-TYP-ERROR ZCOM-TKN-OBJNAME type ZSPI-TYP-STRING ZCOM-TKN-OBJTYPE type ZSPI-TYP-ENUM ZSPI-TKN-ENDLIST type ZSPI-TYP-SSCTL Tokens ZSPI-TKN-ERROR is the standard SPI error token described in the Distributed Systems Management (DSM) Programming Manual .
Page 266: Ztr3-Err-Attr-Confl-Su
ERROR NUMBERS AND ERROR LISTS ZTR3-ERR-ATTR-CONFL-SU ZTR3-ERR-ATTR-CONFL-SU A LINE attribute conflicts with an SU attribute. The ZXPARENT field for an SU is defined as ZSPI-VAL-TRUE, but the LINE attributes defined by the ZCHARSET, ZCTL-SET, ZXLATE, and ZXPARENT fields are not properly specified. If an SU is defined to function in transparent mode, the LINE attributes must be defined as follows:...
Page 267 ERROR NUMBERS AND ERROR LISTS ZTR3-ERR-ATTR-CONFL-SU Recommended Action Redefine the LINE and SU attributes so that they will be consistent.
Page 268: Ztr3-Err-Not-Ptp-Su
ERROR NUMBERS AND ERROR LISTS ZTR3-ERR-NOT-PTP-SU ZTR3-ERR-NOT-PTP-SU The CONNECT command has been issued, but the TR3271 subdevice from which you want to make the connection is not defined as a PTP subdevice. It must be defined as a PTP subdevice.
Page 269: Ztr3-Err-Alrdy-Using-Addr
ERROR NUMBERS AND ERROR LISTS ZTR3-ERR-ALRDY-USING-ADDR ZTR3-ERR-ALRDY-USING-ADDR The ADD or ALTER command has been issued and the ZADDR field contains an address already being used by another subdevice. ZSPI-TKN-ERRLIST type ZSPI-TYP-LIST ZSPI-TKN-ERROR type ZSPI-TYP-ERROR ZCOM-TKN-OBJNAME type ZSPI-TYP-STRING ZCOM-TKN-OBJTYPE type ZSPI-TYP-ENUM ZSPI-TKN-ENDLIST type ZSPI-TYP-SSCTL Tokens...
Page 270: Ztr3-Err-No-Obj-In-Sel-State
ERROR NUMBERS AND ERROR LISTS ZTR3-ERR-NO-OBJ-IN-SEL-STATE ZTR3-ERR-NO-OBJ-IN-SEL-STATE The STATUS command has been issued with the SEL-SUMSTATE modi- fier. There are no objects currently in the selected summary state. ZSPI-TKN-ERRLIST type ZSPI-TYP-LIST ZSPI-TKN-ERROR type ZSPI-TYP-ERROR ZCOM-TKN-OBJNAME type ZSPI-TYP-STRING ZCOM-TKN-OBJTYPE type ZSPI-TYP-ENUM ZSPI-TKN-ENDLIST type ZSPI-TYP-SSCTL Tokens...
Page 271: Ztr3-Err-Opened-Su-Exist
ERROR NUMBERS AND ERROR LISTS ZTR3-ERR-OPENED-SU-EXIST ZTR3-ERR-OPENED-SU-EXIST The STOP command has been issued for the LINE object type, but one or more subordinate subdevices have been opened by an application. This error does not apply when the subordinate modifier has been specified in the command. ZSPI-TKN-ERRLIST type ZSPI-TYP-LIST ZSPI-TKN-ERROR...
Page 272: Ztr3-Err-Target-Objname-Inv
ERROR NUMBERS AND ERROR LISTS ZTR3-ERR-TARGET-OBJNAME-INV ZTR3-ERR-TARGET-OBJNAME-INV The CONNECT or DISCONNECT command has been issued, but the an invalid name was specified for the target AM3270 subdevice. ZSPI-TKN-ERRLIST type ZSPI-TYP-LIST ZSPI-TKN-ERROR type ZSPI-TYP-ERROR ZCOM-TKN-OBJNAME type ZSPI-TYP-STRING ZCOM-TKN-OBJTYPE type ZSPI-TYP-ENUM ZSPI-TKN-ENDLIST type ZSPI-TYP-SSCTL Tokens ZSPI-TKN-ERROR is the standard SPI error token described in the...
Page 273: Ztr3-Err-No-Owner
ZTR3-ERR-NO-OWNER ZTR3-ERR-NO-OWNER A file-system request was sent to the the TR3271 IOP, but before the CAP sent the data to the controller, a CPU switch occurred. The IOP to which the request was sent is now the backup IOP and no longer owns the controller.
Page 274: Ztr3-Err-Conn-Exist
ERROR NUMBERS AND ERROR LISTS ZTR3-ERR-CONN-EXIST ZTR3-ERR-CONN-EXIST The STOP command has been issued for a PTP subdevice that is currently connected. ZSPI-TKN-ERRLIST type ZSPI-TYP-LIST ZSPI-TKN-ERROR type ZSPI-TYP-ERROR ZCOM-TKN-OBJNAME type ZSPI-TYP-STRING ZCOM-TKN-OBJTYPE type ZSPI-TYP-ENUM ZSPI-TKN-ENDLIST type ZSPI-TYP-SSCTL Tokens ZSPI-TKN-ERROR is the standard SPI error token described in the Distributed Systems Management (DSM) Programming Manual .
Page 275: Ztr3-Err-Su-Opened
ERROR NUMBERS AND ERROR LISTS ZTR3-ERR-SU-OPENED ZTR3-ERR-SU-OPENED The STOP command has been issued, but an SU is currently opened by an application. This error is returned only when the LINE object has been specified with the subordinate modifier (ZCOM- VAL-SUB-ONLY) or the SU object has been specified. This applies only to CRT subdevices.
Page 276 This appendix contains a listing of the TR3271 subsystem-specific DDL. You are provided with this DDL and other DDL files in the TR3271 software package. !----------------------------------------------------------- ! file name: ztr3ddl -- source DDL file for TR3271 !----------------------------------------------------------- This DDL file depends on ZSPIDDL. ?SECTION constants...
Page 277 TR3271 SUBSYSTEM DDL !---------------------------------------------------------------! begin of TOKEN definitions section. !---------------------------------------------------------------! ! TR3271 specific STRUCT token numbers. CONSTANT ZTR3-TNM-STRUCT-BASE VALUE IS 2000. CONSTANT ZTR3-TNM-ADD-SU VALUE IS 2000. CONSTANT ZTR3-TNM-ALTER-LINE VALUE IS 2010. CONSTANT ZTR3-TNM-ALTER-PROC VALUE IS 2020. CONSTANT ZTR3-TNM-ALTER-SU VALUE IS 2030.
Page 278 TR3271 SUBSYSTEM DDL ?PAGE "TR3271 CONSTANT definitions for LINE object" !--------------------------------------------------------------! begin of LINE object section. !--------------------------------------------------------------! CONSTANTs definition for LINE object. !--------------------------------------------------------------! BCCTYPE CONSTANT ZTR3-VAL-BCC-LRC8 VALUE 0. CONSTANT ZTR3-VAL-BCC-CRC16 VALUE 1. CONSTANT ZTR3-VAL-BCC-CCITT VALUE 2. CHARACTER SET CONSTANT ZTR3-VAL-CHARSET-ASCII VALUE 0.
Page 279 TR3271 SUBSYSTEM DDL ?PAGE "TR3271 CONSTANT definitions for SUBDEVICE object" !--------------------------------------------------------------! CONSTANTs definition for SU object. !- ------------------------------------------------------------! CONSTANT ZTR3-VAL-Proto-CRT VALUE 1. CONSTANT ZTR3-VAL-Proto-PTP VALUE 4. ?PAGE "common DDL definitions exclusive for TR3271" !--------------------------------------------------------------! begin of common DDL definition. !--------------------------------------------------------------! DEF ZTR3-DDL-filler PIC X SPI-NULL "...
Page 280 !--------------------------------------------------------------! STRUCTs/MAP definition for LINE object. !--------------------------------------------------------------! ?SECTION ZTR3-DDL-ALTER-LINE ?SETSECTION ZTR3-DDL-ALTER-LINE ?TALBOUND ! ZTR3-DDL-ALTER-LINE : This DDL is sent to TR3271 whenever an ALTER LINE command is requested. DEF ZTR3-DDL-ALTER-LINE. 02 Zbcctype TYPE ZSPI-DDL-Enum SPI-NULL 255. 02 Zcharset TYPE ZSPI-DDL-Enum SPI-NULL 255.
Page 281 ?PAGE "TR3271 INFO command STRUCT for LINE object" ?SECTION ZTR3-DDL-INFO-LINE ?SETSECTION ZTR3-DDL-INFO-LINE ?TALBOUND ! ZTR3-DDL-INFO-LINE : This DDL is returned to the requester from TR3271 whenever an INFO LINE command is processed. DEF ZTR3-DDL-INFO-LINE. 02 Zbcctype TYPE ZSPI-DDL-Enum. 02 Zcharset TYPE ZSPI-DDL-Enum.
Page 282 ?PAGE "TR3271 STATISTICS command STRUCT for LINE object" ?SECTION ZTR3-DDL-STATS-LINE ?SETSECTION ZTR3-DDL-STATS-LINE ?TALBOUND ! ZTR3-DDL-STATS-LINE : This DDL is returned to the requester from TR3271 whenever a STATISTICS LINE command is processed. DEF ZTR3-DDL-STATS-LINE. For Time Stamp. 02 Zreset-time TYPE ZSPI-DDL-TimeStamp.
Page 283 ?PAGE "TR3271 RESETSTAT command STRUCT for LINE object" ?SECTION ZTR3-DDL-RSTATS-LINE ?SETSECTION ZTR3-DDL-RSTATS-LINE ?TALBOUND ! ZTR3-DDL-RSTATS-LINE : This DDL is returned to the requester from TR3271 whenever a RESETSTAT LINE command is processed. DEF ZTR3-DDL-RSTATS-LINE. For Time Stamp. 02 Zreset-time TYPE ZSPI-DDL-TimeStamp.
Page 284 ?PAGE "TR3271 STATUS command STRUCT for LINE object" ?SECTION ZTR3-DDL-STATUS-LINE ?SETSECTION ZTR3-DDL-STATUS-LINE ?TALBOUND ! ZTR3-DDL-STATUS-LINE : This DDL is returned to requester from TR3271 whenever a STATUS LINE command is processed. DEF ZTR3-DDL-STATUS-LINE. 02 ZState TYPE ZSPI-DDL-Enum. 02 ZLdev TYPE ZSPI-DDL-INT.
Page 285 !--------------------------------------------------------------! STRUCTs/MAPs definition for SU object. !--------------------------------------------------------------! ?SECTION ZTR3-DDL-ADD-SU ?SETSECTION ZTR3-DDL-ADD-SU ?TALBOUND ! ZTR3-DDL-ADD-SU : !This DDL is sent to TR3271 whenever an ADD SU command is !requested. DEF ZTR3-DDL-ADD-SU. 02 ZAddr TYPE ZSPI-DDL-Int-Pair SPI-NULL 255. 02 ZProto TYPE ZSPI-DDL-Enum SPI-NULL 255.
Page 286 ?PAGE "TR3271 INFO command STRUCT for SUBDEVICE object" ?SECTION ZTR3-DDL-INFO-SU ?SETSECTION ZTR3-DDL-INFO-SU ?TALBOUND ! ZTR3-DDL-INFO-SU : This DDL is returned to requester from TR3271, whenever an INFO SU command is processed. DEF ZTR3-DDL-INFO-SU TYPE ZTR3-DDL-ADD-SU. TOKEN-MAP ZTR3-MAP-INFO-SU VALUE IS ZTR3-TNM-INFO-SU IS ZTR3-DDL-INFO-SU.
Page 287 ?PAGE "TR3271 STATUS command STRUCT for SU object" ?SECTION ZTR3-DDL-STATUS-SU ?SETSECTION ZTR3-DDL-STATUS-SU ?TALBOUND ! ZTR3-DDL-STATUS-SU : This DDL is returned to requester from TR3271 whenever a STATUS SU command is processed. DEF ZTR3-DDL-STATUS-SU. 02 ZSDN TYPE ZSPI-DDL-Int. 02 ZState TYPE ZSPI-DDL-Enum.
Page 288 VALUE IS zems-evt-csslineerr. CONSTANT ztr3-evt-css-subdev-err VALUE IS zems-evt-csssubdeverr. !--------------------------------------------------------------! TR3 EMS misc constants !--------------------------------------------------------------! CONSTANT ztr3-val-evt-buflen VALUE IS 512. ! bytes ?PAGE "TR3271 EMS definitions" !--------------------------------------------------------------! TR3271 EMS token definitions !--------------------------------------------------------------! CONSTANT ztr3-tnm-p-reg VALUE IS 1. CONSTANT ztr3-tnm-e-reg VALUE IS 2.
Page 289 TR3271 SUBSYSTEM DDL TOKEN-CODE ztr3-tkn-p-reg VALUE IS ztr3-tnm-p-reg TOKEN-TYPE IS zspi-typ-uint. TOKEN-CODE ztr3-tkn-e-reg VALUE IS ztr3-tnm-e-reg TOKEN-TYPE IS zspi-typ-uint. TOKEN-CODE ztr3-tkn-x1 VALUE IS ztr3-tnm-x1 TOKEN-TYPE IS zspi-typ-uint. TOKEN-CODE ztr3-tkn-x2 VALUE IS ztr3-tnm-x2 TOKEN-TYPE IS zspi-typ-uint. TOKEN-CODE ztr3-tkn-x3 VALUE IS ztr3-tnm-x3 TOKEN-TYPE IS zspi-typ-uint.
Page 290 ADD command 6-13 ALTER command 6-20 Applications naming rules and guidelines for obtaining event messages using letter Z Buffer declarations TR3271 5-18 Buffer size for an event message recommended for commands recommended for responses Building the command buffer CLIP downloading...
Page 291 Critical events CU token use of Data lists 3-12, 5-5 representation of in responses Data-communications standard definitions 5-11 Decoding the response buffer Definition files Definitions common data-communications standard 5-11 EMS standard files SPI standard TR3271 subsystem 5-18 Index-2...
Page 292 EMS reported to TMDS standard header in text version subjects Tandem internal tokens text version TR3271 subsystem TR3271 subsystem ID unconditional tokens volatile tokens Event numbers Event-management programming Event-number token 5-10 Events 2-10...
Page 293 Field types 3-10 Fields initializing null values of types of 3-10 Files, definition Filters example 7-78 selecting critical TR3271 events 7-79 selecting TR3271 events 7-78 GETVERSION command 6-48 I/O process event messages reported I/O processes commands affecting object names 5-14...
Page 294 INDEX Logical device name Logical device number Manager token Maximum field version token Maximum response token Monitoring statistics 6-93 Multiple tokens, constructs involving 3-12 Names of objects, See Object names of values 3-10 Naming rules and guidelines Noncritical events Nonsensitive commands GETVERSION 6-48 INFO...
Page 295 INDEX PROC object See I/O processes Process format of object name switching 6-119 Processes that report events Programming considerations Programming for event management Receiving the response buffer release version 6-48 Reserved subdevice names #DEBUG 6-13 #ZSPI 6-13 RESET command 6-75 RESETSTATS command 6-79 Response buffer, receiving and decoding...
Page 296 INDEX Sensitive commands (continued) RESETSTATS 6-79 START 6-88 STOP 6-113 SWITCH 6-119 Server banner token Server version token Simple tokens SPI messages, elements SPI programming considerations SPI standard definitions SSNULL procedure START command 6-88 STATISTICS command 6-93 STATUS command 6-102 STOP command 6-113 Structured tokens...
Page 297 SPI messages EMS definitions event messages object names object types supported responses issued by SPI definitions SPI programming considerations subsystem number TR3271 subsystem ID in event messages TRACE command 6-125 Trace mode 6-125 Types objects of fields 3-10...
Page 298 INDEX Z, using in applications ZCOM-CMD- ABORT 6-13 ALTER 6-20 CONNECT 6-33 DELETE 6-38 DISCONNECT 6-43 GETVERSION 6-48 INFO 6-53 LISTOBJECTS 6-66 LOAD 6-71 RESET 6-75 RESETSTATS 6-79 START 6-88 STATISTICS 6-93 STATUS 6-103 STOP 6-114 SWITCH 6-119 TRACE 6-126 ZCOM-EVT- CPU-SWITCH 7-67...
Page 299 INDEX ZEMS-MAP- EXIOADDR 5-10, 7-6 ZEMS-TKN EMPHASIS 5-10 ZEMS-TKN- CONSOLE-PRINT 5-10 5-10 CRTPID 5-10 5-10, 7-6 EMPHASIS EVENTNUMBER 5-10 GENTIME 5-10 LDEV 5-10 LDEVNAME 5-10 LOGTIME 5-10 5-11 SUBJECT-MARK SYSTEM 5-11 USERID 5-11 ZSPI-ERR- ZSPI-SSN- ZTR3 ZSPI-TKN- ALLOW-TYPE 4-2, 5-4 CHECKSUM COMMAND COMMENT...
Page 300 INDEX ZTR3-DDL- MSG-BUFFER 5-18 MSG-MAXBUF 5-19 ZTR3-ERR- ALRDY-USING-ADDR ATTR-CONFL-SU CLIP-PROB CONN-EXIST A-13 NO-OBJ-SEL-STATE NO-OWNER A-12 NOT-PTP-SU OPENED-SU-EXIST A-10 SU-OPENED A-14 TARGET-OBJ-NOT-FOUND TARGET-OBJNAME-INV A-11 ZTR3-EVT- CIU-ERROR 7-12 CLIP-DWLOAD 7-39 CSS-FRAME-ERR 7-47 CSS-LINE-ERR 7-57 CSS-LIU-CONFIG-ERR 7-54 CSS-PROBE-ERR 7-42 CSS-SUBDEV-ERR 7-62 CSS-UNEXP-BRKPT 7-51 DISCARD-ERR 7-36 INSUFF-BUF...
Page 301 INDEX ZTR3-VAL- EVT-BUFLEN 5-19 PROTO-CRT 6-15 PROTO-PTP 6-15 SSID description 5-19 structure definition VERSION 5-19 #DEBUG 6-13 #ZSPI 6-13 Index-12...

HP TR3271 Programming Manual

Quick Links

Related Manuals for HP TR3271

Summary of Contents for HP TR3271

Table of Contents