Networking and Data Communications Library TR3271 Management Programming Manual Abstract Part Number 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.
Document History Edition 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. Copyright 1989 Tandem Computers Incorporated.
CONTENTS PREFACE ..................................................... vii NOTATION CONVENTIONS ......................................... ix SECTION 1. INTRODUCTION .................................... Brief Overview of TR3271 .................................. Objects Controlled by the Subsystem ....................... Required Management Functions ............................. Relationship With Other Subsystems ........................ Subsystem Architecture ....................................
CONTENTS SECTION 5. COMMON DEFINITIONS .............................. 5-1 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 ...................................
CONTENTS 158: ZTR3-EVT-CSS-UNEXP-BRKPT .......................... 160: ZTR3-EVT-CSS-LIU-CONFIG-ERR ....................... 164: ZTR3-EVT-CSS-LINE-ERR ............................. 165: ZTR3-EVT-CSS-SUBDEV-ERR ........................... -1: ZCOM-EVT-CPU-SWITCH ................................ -2: ZCOM-EVT-PATH-SWITCH ............................... -3: ZCOM-EVT-SUMSTATE-CHG .............................. Examples of Filters ...................................... Example 1 ..................................
CONTENTS FIGURES 1-1. 2-1. TR3271 Subsystem Architecture ......................... 1-6 How an Application Fits Into the Architecture ......... 2-3 TABLES 2-1. 2-2. 2-3. 4-1. 5-1. 5-2. 5-3. 6-1. 7-1. vi TR3271 Programmatic Commands .......................... 2-4 SCF Commands and Programmatic Commands ................ 2-6 CMI Commands and Programmatic Commands ................ 2-8 Command Protocol Summary State Changes ................ 4-5 SPI Standard Definitions ..............................
PREFACE In the Tandem environment, TR3271 provides application programs with the ability to communicate with IBM hosts and IBM 3270-family devices. This manual provides subsystem-specific information for application programmers using the managementprogramming interfaces to manage the TR3271 subsystem. The management-programming interfaces are based on the Subsystem Programmatic Interface (SPI).
PREFACE • Section 4 describes SPI programming considerations for the subsystem. This description includes information about building the command buffer, canceling commands, receiving and decoding response buffers, error handling, version compatibility, and security. • Section 5 summarizes standard SPI definitions, EMS definitions, and data-communications definitions used by the subsystem in multiple commands, responses, or event messages.
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 LETTERS Uppercase letters represent names from the definition files, SCF commands, or CMI commands; enter these names exactly as shown. lowercase letters Lowercase letters represent words that are part of the notation. Ellipsis ...
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. See the text for the exact nature of the dependency. Event Message !... 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.
SECTION 1 INTRODUCTION This section describes management concepts applicable to the TR3271 subsystem in the 6100 CSS environment. Although the utilities available in a non-6100 environment are mentioned, this section is oriented to the application programmer responsible for managing the TR3271 subsystem in the 6100 CSS environment. Some of the concepts discussed are the types of objects controlled by the TR3271 subsystem and the available monitoring and control functions.
INTRODUCTION Required Management Functions on the other hand, are defined at system-generation time, but can be dynamically added or deleted using Configuration Utility Program (COUP) commands available through the Dynamic System Configuration (DSC) facility. Refer to the Dynamic System Configuration Manual for details. In the TR3271 subsystem, a Tandem system communicates with an individual physical device by means of physical communications lines.
INTRODUCTION Required Management Functions Monitoring your subsystem includes such tasks as the following: • Obtaining the version level of the subsystem software • Obtaining current attribute values for a line and subdevices • Obtaining the names of lines and subdevices known to the subsystem • Obtaining the current values of the statistics counters for lines and subdevices • Obtaining information about the current states of the line and subdevices • Retrieving information about events occurrin
INTRODUCTION Relationship With Other Subsystems RELATIONSHIP WITH OTHER SUBSYSTEMS The TR3271 subsystem is closely related to the AM3270 subsystem. The two subsystems can be linked by connecting an AM3270 subdevice with a 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.
INTRODUCTION Subsystem Architecture SUBSYSTEM ARCHITECTURE The TR3271 subsystem consists of one process controlling one line. However, the subsystem can be combined to provide a passthrough 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.
INTRODUCTION Subsystem Architecture You can manage the TR3271 subsystem through both interactive and programmatic interfaces. The interactive interfaces for managing the TR3271 subsystem are the following: • The Subsystem Control Facility (SCF), which can be used to monitor, configure, and control the TR3271 subsystem. SCF provides an operator interface to the Subsystem Control Point (SCP) which provides an interface to the TR3271 subsystem.
SECTION 2 MANAGEMENT PROGRAMMING FOR TR3271 You can manage the TR3271 subsystem interactively or programmatically. For 6100 CSS environments, the Subsystem Control Facility (SCF), the Communications Management Interface (CMI), and VIEWPOINT provide interactive subsystem management, while the control-and-inquiry interface and the Event Management Service (EMS) interface provide programmatic subsystem management.
MANAGEMENT PROGRAMMING FOR TR3271 How a Management Application Fits Into the Architecture Managing a subsystem programmatically can mean a more efficient use of resources as follows: • If routine management tasks are performed programmatically instead of interactively, the human operator can spend more time on tasks that require more judgment and creativity. • Where appropriate, a management application can standardize responses to errors or other information obtained from the subsystem.
MANAGEMENT PROGRAMMING FOR TR3271 How a Management Application Fits Into the Architecture The EMS interface requires the subsystem to initiate the communication. The subsystem reports event information when events happen, not in response to a request from a management application. The communication between EMS and your management application is unidirectional and occurs asynchronously. A management application using EMS can monitor events that occur in the TR3271 subsystem.
MANAGEMENT PROGRAMMING FOR TR3271 Commands COMMANDS Table 2-1 lists and briefly describes the commands that a management application can send to the 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.
MANAGEMENT PROGRAMMING FOR TR3271 Commands Table 2-1. COMMAND TR3271 Programmatic Commands (Page 2 of 2) DESCRIPTION LISTOBJECTS Returns the names of a line and subdevices known to the TR3271 subsystem. LOAD Initiates a download of the Communications Line Interface Processor (CLIP). RESET Places the CLIP in the boot state. RESETSTATS Returns statistical information about a line and subdevices and then resets the statistics counters to the subsystem default values.
MANAGEMENT PROGRAMMING FOR TR3271 Commands Table 2-2.
MANAGEMENT PROGRAMMING FOR TR3271 Commands Table 2-2.
MANAGEMENT PROGRAMMING FOR TR3271 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. For clarity, the table contains the command and object names in the form that you must use in applications. Table 2-3.
MANAGEMENT PROGRAMMING FOR TR3271 Commands Table 2-3.
MANAGEMENT PROGRAMMING FOR TR3271 Event Messages Table 2-3.
MANAGEMENT PROGRAMMING FOR TR3271 Communicating With the TR3271 Subsystem The management application retrieves event messages by sending commands in SPI message format to an EMS consumer distributor. To select event messages, you can write a filter that is specific to your needs. If no filter is used, all event messages in the log file are passed to the management application by the consumer distributor.
MANAGEMENT PROGRAMMING FOR TR3271 Communicating With the TR3271 Subsystem Regardless of the language you are using, the tasks an application must perform when communicating with either SCP or the EMS distributor process are as follows: 1. Establish communication with SCP or the EMS distributor process. 2. Call SPI procedures to build a message. 3. Send the message to SCP or the EMS distributor process. 4. Receive the response. 5. Check for error codes and handle any error. 6.
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. These procedures also allow a management application to decode the responses from the subsystem that have been sent through SCP in SPI message format.
ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEM The commands sent to the subsystem and the responses and event messages received from the subsystem are made up of tokens. The concept of tokens is described in the Distributed Systems Management Manual . See Section 5, "Common Definitions," in this manual for an explanation of tokens present in multiple commands, responses, or event messages for the TR3271 subsystem.
ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEM Definition Files A management application that communicates with the TR3271 subsystem must include the following definition files in the appropriate programming language, where xxx represents one of four specific abbreviations for COBOL85, TAL, TACL, C, or DDL and subsys represents a subsystem identifier: • The SPI definition file, ZSPIDEF.ZSPIxxx . • The EMS definition file, ZSPIDEF.ZEMSxxx .
ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEM Naming Rules and Guidelines for Applications NAMING RULES AND GUIDELINES FOR APPLICATIONS All items in definition files are assigned symbolic names as well as numbers. Use the symbolic names to prevent transcription errors and to improve readability. Tandem uses names beginning with the letter Z for all definitions and all component fields of structures in its definition files.
ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEM Command Numbers Although all data-communications subsystems must use symbolic names of the form ZCOM-CMD-name , each subsystem defines which command numbers it supports. The TR3271 subsystem supports the following commands: ABORT ADD ALTER CONNECT DELETE DISCONNECT GETVERSION INFO LISTOBJECTS LOAD RESET RESETSTATS START STATISTICS STATUS STOP SWITCH TRACE These commands are described in Section 6, "Commands and Responses.
ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEM Object Names Object Names An object name identifies a specific object. The object specified by an object name belongs to one of the object types 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.
ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEM Event Numbers Event Numbers Event numbers identify event messages issued by the TR3271 subsystem and most event numbers correspond to the numbers that identify console messages which are described in the manual 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.
ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEM Tokens Tokens The TR3271 subsystem uses tokens for parameters in commands, responses to commands, and elements of event messages. Each token has a token code and token value associated with it. A token code is an identifying tag that programs refer to by name, and a token value is a data item that programs also refer to by name.
ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEM Tokens Extensible Structured Tokens Extensible structured tokens--tokens whose values are extensible structures--are identified by special token codes called token maps. The structures are defined in a DDL definition associated with each token map.
ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEM Tokens ZSPI-TYP-ENUM ZSPI-TYP-FNAME ZSPI-TYP-FNAME32 ZSPI-TYP-TIMESTAMP ZSPI-TYP-TOKENCODE ZSPI-TYP-UINT The TR3271 subsystem does not define any private token types; that is, no token types have names of the form ZTR3-TYP-name . Predefined Value Names The predefined values used by the TR3271 subsystem are represented by symbolic names Z subsys -VAL- name , where subsys is a three-character subsystem abbreviation and name identifies the predefined value.
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. A data list begins with the token ZSPI-TKNDATALIST, while an error list begins with the token ZSPI-TKNERRLIST; both end with the token ZSPI-TKN-ENDLIST.
SECTION 4 SPI PROGRAMMING CONSIDERATIONS FOR TR3271 The Communications Management Programming Manual discusses general programming considerations for writing applications that use the Subsystem Programmatic Interface (SPI) to communicate with data-communications subsystems like the TR3271 subsystem. This section discusses SPI programming considerations that are specific to the TR3271 subsystem.
SPI PROGRAMMING CONSIDERATIONS FOR TR3271 Discontinuing a Command in Progress The command buffers for all commands can contain extensible structured tokens. An extensible structured token that is to appear in a command should always be initialized by the SPI procedure SSNULL to ensure that every field of the token is initialized to its null value. This action is important because an operation will be performed if a field contains a value other than its null value.
SPI PROGRAMMING CONSIDERATIONS FOR TR3271 Receiving and Decoding the Response Buffer RECEIVING AND DECODING THE RESPONSE BUFFER The following programming considerations apply when an application 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. The subsystem supports multiple response records in a single reply message.
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. One is the value ZSPI-ERR-OK, which means that no error or warning occurred.
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.
SECTION 5 COMMON DEFINITIONS The management interfaces to the from four sources: SPI standard definitions, data-communications subsystem-specific definitions. in multiple commands, responses, TR3271 subsystem use definitions definitions, EMS standard standard definitions, and TR3271 Many of the definitions are used 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.
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.
COMMON DEFINITIONS SPI Standard Definitions Table 5-1.
COMMON DEFINITIONS SPI Standard Definitions ZSPI-TKN-ALLOW-TYPE within a command buffer indicates the conditions under which processing of a set of objects will continue. This token applies to commands that apply to multiple objects. The ALLOW-TYPE token controls whether the subsystem continues to the next object of a set when there is an error or warning during processing of the object. It does not control the response when the tokens within a command message are incorrect or missing.
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. If the comment exceeds this number of bytes and causes a a command to be too large for the server's read buffer, the server is not responsible. The TR3271 subsystem only guarantees 80 bytes.
COMMON DEFINITIONS SPI Standard Definitions ZSPI-TKN-HDRTYPE indicates whether the SPI buffer is for an event message or a command. If the buffer is for a command, the value of this token is ZSPI-VAL-CMDHDR; if the buffer is for an event the value of this token is ZSPI-VAL-EVTHDR. ZSPI-TKN-MAX-FIELD-VERSION contains the highest version associated with the nonnull fields within an extensible structured token. This value is compared to the server version.
COMMON DEFINITIONS SPI Standard Definitions ZSPI-TKN-RESPONSE-TYPE specifies which types of responses the management application wants returned. This token can apply to all commands supported by the TR3271 subsystem. The RESPONSETYPE token controls whether the subsystem returns a response for every object or returns only responses for objects that experience an error or warning.
COMMON DEFINITIONS SPI Standard Definitions ZSPI-TKN-SSID specifies the subsystem ID. This token is required in both the command and the response. The SSINIT procedure initializes the command buffer with this token using the value defined in the subsystem's DDL file. The value used for TR3271 is ZTR3-VAL-SSID. ZTR3-VAL-SSID has the following structure definition: def ZTR3-VAL-SSID tacl ssid. 02 Z-FILLER type character 8 value is ZSPI-VAL-TANDEM. 02 Z-OWNER redefines Z-FILLER type ZSPI-DDL-CHAR8.
COMMON DEFINITIONS EMS Standard Definitions EMS STANDARD DEFINITIONS Definitions whose names begin with ZEMS- are Event Management Service (EMS) standard definitions. These definitions are available to all subsystems that support EMS and can be found in the EMS DDL file, ZSPIDEF.ZEMSDDL. Table 5-2 lists only those EMS standard definitions that are used in the management-programming interfaces to the TR3271 subsystem. It does not list EMS error numbers or definitions used only in error lists.
COMMON DEFINITIONS EMS Standard Definitions ZEMS-MAP-EXIOADDR is a Tandem internal extensible structured token. This token specifies the physical I/O address. This I/O I/O address scheme supersedes the subchannel-type I/O addresses previously supported using the ZEMS-TKN-CU. 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.
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. DATA-COMMUNICATIONS STANDARD DEFINITIONS Definitions whose names begin with ZCOM- are data-communications standard definitions.
COMMON DEFINITIONS Data-Communications Standard Definitions Table 5-3.
COMMON DEFINITIONS Data-Communications Standard Definitions ZCOM-MAP-REQID provides security checking additional to the sensitive/nonsensitive command implementation. This token contains 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. If the user is not the SUPER.
COMMON DEFINITIONS Data-Communications Standard Definitions ZCOM-OBJ-LINE specifies the line object type. ZCOM-OBJ-NULL is used as the object type in commands that do not require an object-name token. Only two commands use the NULL object, GETVERSION and LISTOBJECTS. ZCOM-OBJ-PROC specifies the process (PROC) object type for the TR3271 I/O process running on a Tandem NonStop system. ZCOM-OBJ-SU specifies the subdevice (SU) object type for the TR3271 subsytem.
COMMON DEFINITIONS Data-Communications Standard Definitions ZCOM-TKN-SEL-SUMSTATE specifies whether an object is selected based on its current summary state. This modifier consists of two fields, an enumerated field that indicates the summary state, and a Boolean field that indicates whether objects currently in that summary state are to be included in the information returned by the subsystem. The STATUS command is the only TR3271 command that supports the select-state modifier.
COMMON DEFINITIONS Data-Communications Standard Definitions ZCOM-TKN-TARGET-OBJTYPE specifies the type of object to which you want to build or or tear down a link. This token is required and must have the value ZCOM-OBJ-SU. ZCOM-TKN-TRACE-OPT indicates what items are to be traced by the TRACE command. For information on the possible values of this token, refer to the TRACE command in Section 6. SCP creates a bit mask from the trace options specified and sends it to the CMP Trace Collector (CMPTC).
COMMON DEFINITIONS TR3271 Buffer Declarations ZCOM-VAL-SUMSTATE-STOPPED is a value of the field ZSTATE of the extensible structured tokens ZTR3-MAP-STATUS-LINE and ZTR3-MAPSTATUS-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. The definitions that appear in several commands or responses are described in this section.
COMMON DEFINITIONS TR3271 Predefined Token and Field Values ZTR3-DDL-MSG-MAXBUF is a message buffer whose size is that recommended for responses in which each reply message contains multiple response records. def ZTR3-DDL-MSG-MAX-BUF. 02 Z-MSGCODE type ZSPI-TYP-INT. 02 Z-BUFLEN type ZSPI-TYP-UINT. 02 Z-OCCURS type ZSPI-DDL-UINT. 02 Z-FILLER type ZSPI-DDL-BYTE occurs 0 to ZCOM-VAL-MAXBUFLEN times depending on Z-OCCURS. end.
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-ALTER-LINE ZTR3-MAP-ALTER-SU ZTR3-MAP-RSTATS-LINE ZTR3-MAP-RSTATS-SU ZTR3-MAP-INFO-LINE ZTR3-MAP-INFO-SU ZTR3-MAP-STATS-LINE ZTR3-MAP-STATS-SU ZTR3-MAP-STATUS-LINE ZTR3-MAP-STATUS-SU These tokens are described with the commands and responses they appear in. See Section 6, "Commands and Responses.
COMMON DEFINITIONS TR3271 Tokens in Event Messages TR3271 Tokens in Event Messages The TR3271 subsystem defines the following simple tokens in event messages. The internal tokens are indicated with an asterisk (*).
SECTION 6 COMMANDS AND RESPONSES This section describes each of the commands and responses in the programmatic command interface to the TR3271 subsystem. Each description includes the syntax, object types, command tokens, response tokens, operational notes, and error handling associated with the commands. In this section, command numbers, object types, tokens, and token values are represented in DDL.
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 programmatic control-and-inquiry interface to the TR3271 subsystem and gives their symbolic names. Table 6-1.
COMMANDS AND RESPONSES Table 6-1.
COMMANDS AND RESPONSES Commands by Object Type Table 6-1. Commands and Their Symbolic Names (Page 3 of 3) SYMBOLIC NAME OF COMMAND AND OBJECT COMMAND STOP ZCOM-CMD-STOP ZCOM-OBJ-LINE ZCOM-OBJ-SU SWITCH ZCOM-CMD-SWITCH ZCOM-OBJ-LINE ZCOM-OBJ-PROC TRACE ZCOM-CMD-TRACE ZCOM-OBJ-LINE * The LINE object can be specified, but it must be specified with the subordinate modifier. COMMANDS BY OBJECT TYPE The TR3271 subsystem recognizes four object types in commands.
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 ALTER DELETE INFO LISTOBJECTS LOAD RESET RESETSTATS START STATISTICS STATUS STOP SWITCH TRACE The TR3271 subsystem accepts the SU object type only in the following commands: ABORT ADD ALTER CONNECT DELETE DISCONNECT INFO LISTOBJECTS RESETSTATS START STATISTICS STATUS STOP
COMMANDS AND RESPONSES Sensitive and Nonsensitive Commands SENSITIVE AND NONSENSITIVE COMMANDS Commands can be divided into two categories: sensitive and nonsensitive. Sensitive commands can change the state of the specified object; nonsensitive commands cannot change the state of the specified object.
COMMANDS AND RESPONSES Command Descriptions With the exception of the tokens ZSPI-TKN-DATALIST, ZSPI-TKNERRLIST, 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. • The token ZSPI-TKN-DATALIST, if present in a response, always appears at the beginning of a response record.
COMMANDS AND RESPONSES ABORT Command ABORT Command The ABORT command terminates the operation of the specified object and clears any existing connection to the object. When the subsystem finishes processing the command, the specified object is placed in the STOPPED summary state. You can abort a line or a subdevice, but not a process. When you use the ABORT command, note that the termination is done without regard to processing currently in progress for the specified object.
COMMANDS AND RESPONSES ABORT Command Command ZCOM-CMD-ABORT Object Type ZCOM-OBJ-LINE or 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 ZCOM-TKN-SUB token-type ZSPI-TYP-TIMESTAMP. token-type ZSPI-TYP-ENUM.
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 "DataCommunications Standard Definitions" in Section 5 and the Communications Management Programming Manual. ZCOM-MAP-REQID and ZCOM-TKN-CMD-TIMEOUT are standard datacommunications tokens that your application can optionally provide.
COMMANDS AND RESPONSES ABORT Command Tokens in Response Buffer ZSPI-TKN-DATALIST indicates the beginning of a data list. 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 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.
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-VALSUB-ALL for the SUB modifier. 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.
COMMANDS AND RESPONSES ADD Command ADD Command The ADD command adds a subdevice to the TR3271 subsystem. You can add only a subdevice; this command is not valid for the PROC or LINE object type. 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.
COMMANDS AND RESPONSES ADD Command def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. ZCOM-TKN-CMD-TIMEOUT ZSPI-TKN-MANAGER ZSPI-TKN-SSID ZSPI-TKN-MAXRESP ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT type ZSPI-DDL-CRTPID. type ZSPI-DDL-INT. token-type token-type token-type token-type token-type token-type token-type ZSPI-TYP-TIMESTAMP. ZSPI-TYP-FNAME32. ZSPI-TYP-SSID. !{} ZSPI-TYP-INT. ZSPI-TYP-ENUM. ZSPI-TYP-ENUM. ZSPI-TYP-STRING.
COMMANDS AND RESPONSES ADD Command ZPROTO specifies the protocol to be used by the subdevice. This required field must be assigned one of the following values: ZTR3-VAL-PROTO-CRT The CRT protocol will be used. ZTR3-VAL-PROTO-PTP The pass-through protocol (PTP) will be used Refer to the Device-Specific Access Methods--AM3270/TR3271 manual for more information about these protocols. ZRECSIZE specifies the maximum number of bytes the subdevice can send or receive in a record. This is a required field.
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. The possible integer pairs are as follows: (10,x) The subdevice uses the CRT protocol. The value of x is an integer in the 1 through 5 range and is associated with the following screen sizes.
COMMANDS AND RESPONSES ADD Command Tokens in Response Buffer ZSPI-TKN-DATALIST indicates the beginning of a data list. 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 added to the subsystem by the command. Unless there is an error that prevents the ADD command from being attempted at all, this token is present in every response record.
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. The command is valid only for the object type ZCOM-OBJ-SU.
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.
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 or ZCOM-OBJ-SU Tokens in Command Buffer ZTR3-MAP-ALTER-LINE !{A} !OBJ-LINE def ZTR3-DDL-ALTER-LINE. !Specify one or more fields. 02 ZBCCTYPE type ZSPI-DDL-ENUM. 02 ZCHARSET type ZSPI-DDL-ENUM. !ZCTL-SET !ZXLATE 02 ZCTL-RTS type ZSPI-DDL-BOOLEAN.
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. def ZCOM-DDL-REQID. 02 ZCRTPID type ZSPI-DDL-CRTPID. 02 ZPAID type ZSPI-DDL-INT. end.
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. It cannot be in the command when the object is ZCOM-OBJ-SU. Duplicate occurrences of this token are not allowed.
COMMANDS AND RESPONSES ALTER Command ZDROP-RTS A Boolean variable that specifies whether the Request To Send (RTS) signal is dropped when the software switches from a write operation to a read operation. If the value is ZSPI-VALTRUE, the signal will be dropped when switching operations. If the value is ZSPI-VAL-FALSE, the RTS signal will not be dropped. The default value is ZSPI-VAL-FALSE.
COMMANDS AND RESPONSES ALTER Command %value If the value of this field is any 16-bit octal value other than 0, %177776, or %177777, the TR3271 subsystem responds with a RVI. The value in this field is interpreted as IBM Status/Sense information. The TR3271 subsystem will send these bytes to the host when the host, after receiving the RVI, polls the subsystem. The value must be in the correct format. Refer to Appendix C in the Device-Specific Access Methods--AM3270/TR3271 for a list of appropriate values.
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. ZSYNCS An integer that specifies the number of SYN characters that precede each frame. The value must be in the 1 through 14 range. The default is 3. ZTEST-INTVL A timestamp that specifies the interval, in .
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. The default is 0. ZXLATE-IN A character value that must occur 256 times, once for each ASCII character. The character values together make up the translation table used for inbound data.
COMMANDS AND RESPONSES ALTER Command ZRECSIZE An integer that specifies the maximum number of bytes the subdevice can send or receive in a record. The recommended record size depends on the protocol used and the type of subdevice as follows: CRT terminal Use the defined screen size as the record size.
COMMANDS AND RESPONSES ALTER Command (60,x) The subdevice is a pass-through protocol (PTP) subdevice. The value of x can have the value of 1 or 2. Subtype 1 indicates a CRT subdevice, and subtype 2 indicates a printer. ZCOM-TKN-OBJNAME specifies the line or subdevice whose attribute values are to be altered. Your application must provide this token in the command.
COMMANDS AND RESPONSES ALTER 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" in the Communications Management Programming Manual.
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.
COMMANDS AND RESPONSES CONNECT Command CONNECT Command The CONNECT command creates a link between a TR3271 subdevice and a TR3271 subdevice. Only subdevices can be connected. Once this command is successfully completed, data can pass between TR3271 terminals and an IBM host through the TR3271 subsystem. When you use the CONNECT command, the subsystem checks that both the TR3271 subdevice and the target AM3270 subdevice are in the STARTED summary state.
COMMANDS AND RESPONSES CONNECT Command ZSPI-TKN-MAXRESP ZSPI-TKN-RESPONSE-TYPE token-type ZSPI-TYP-INT. token-type ZSPI-TYP-ENUM. ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT token-type ZSPI-TYP-ENUM. token-type ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SERVER-VERSION ZSPI-TKN-SSID token-type ZSPI-TYP-INT. token-type ZSPI-TYP-SSID. !{} !{} ZSPI-TKN-DATALIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ERRLIST ...
COMMANDS AND RESPONSES CONNECT Command ZCOM-MAP-REQID and ZCOM-TKN-CMD-TIMEOUT are standard datacommunications tokens that your application can optionally provide. These tokens are described in "Data-Communications Standard Definitions" in Section 5 and the Communications Management Programming Manual. (ZSPI-TKN-) MANAGER, SSID, MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and COMMENT are standard SPI tokens.
COMMANDS AND RESPONSES CONNECT Command The possible nonzero values of RETCODE in response to the CONNECT command are as follows: ZCOM-ERR-EMPT-RSP (-33) ZCOM-ERR-TKN-VAL-INV (-30) ZCOM-ERR-TKN-REQ (-29) ZCOM-ERR-TKN-DUP (-27) ZCOM-ERR-TKN-CODE-INV (-26) ZCOM-ERR-SSID-INV (-24) ZCOM-ERR-SECUR-VIOL (-22) ZCOM-ERR-OBJNAME-INV (-19) ZCOM-ERR-FNAME-INV (-9) ZCOM-ERR-CMD-TIMED-OUT (-7) ZCOM-ERR-PATH-DOWN (-20) There has been an unexpected loss of the link between the AM3270 and TR3271 subdevice.
COMMANDS AND RESPONSES CONNECT Command ZTR3-ERR-NOT-PTP-SU (5) Your management application tried to build a link from or to a subdevice that is not a PTP subdevice. The subdevices that you connect must both be capable of using the pass-through protocol. ZTR3-ERR-TARGET-OBJNAME-INV (10) The object name for the target AM3270 subdevice does not comply with the valid format. ZSPI-TKN-ENDLIST indicates the end of a data list or an error list.
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. In addition, when your management application issues the DELETE command using the LINE object, the subsystem checks for the subordinate-modifier token. This token must be present and its value must be ZCOM-VAL-SUBONLY.
COMMANDS AND RESPONSES DELETE Command ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type ZSPI-TYP-INT. ZSPI-TYP-BYTESTRING. ZSPI-TYP-ENUM. ZSPI-TYP-ENUM. ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SERVER-VERSION ZSPI-TKN-SSID token-type ZSPI-TYP-INT. token-type ZSPI-TYP-SSID. !{} !{} ZSPI-TKN-DATALIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ERRLIST ...
COMMANDS AND RESPONSES DELETE Command ZCOM-TKN-SUB specifies whether subordinate objects are to be affected by the DELETE command. This token must be used if the specified object type is ZCOM-OBJ-LINE. For the DELETE command, the possible values of this token are as follows: ZCOM-VAL-SUB-ONLY If the object type is LINE, delete the subdevices subordinate to the named line, but do not delete the line. This value is not valid with the SU object.
COMMANDS AND RESPONSES DELETE Command ZSPI-TKN-ERRLIST indicates the beginning of an error list. This token is described in "SPI Standard Definitions" in Section 5 and the Distributed Systems Management (DSM) Programming Manual. 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.
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. This token is described in "SPI Standard Definitions" in Section 5 and the Distributed Systems Management (DSM) Programming Manual .
COMMANDS AND RESPONSES DISCONNECT Command 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.
COMMANDS AND RESPONSES DISCONNECT Command ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT token-type ZSPI-TYP-ENUM. token-type ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SERVER-VERSION ZSPI-TKN-SSID token-type ZSPI-TYP-INT. token-type ZSPI-TYP-SSID. !{} !{} ZSPI-TKN-DATALIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-RETCODE ZSPI-TKN-ENDLIST token-type token-type token-type token-type !{} !{} !... ZSPI-TYP-LIST. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-LIST.
COMMANDS AND RESPONSES DISCONNECT Command ZCOM-MAP-REQID and ZCOM-TKN-CMD-TIMEOUT are standard datacommunications tokens that your application can optionally provide. These tokens are described in "Data-Communications Standard Definitions" in Section 5 and the Communications Management Programming Manual. (ZSPI-TKN-) MANAGER, SSID, MAXRESP, RESPONSE-TYPE, ALLOW-TYPE, and COMMENT are standard SPI tokens.
COMMANDS AND RESPONSES DISCONNECT 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" inthe Communications Management Programming Manual.
COMMANDS AND RESPONSES DISCONNECT Command ZTR3-ERR-NOT-PTP-SU (5) Your management application tried to delete a link from or to a subdevice that is not a PTP subdevice. The subdevices that you disconnect must both be capable of using the pass-through protocol. ZTR3-ERR-TARGET-OBJNAME-INV (10) The object name for the target AM3270 subdevice does not comply with the valid format. ZSPI-TKN-ENDLIST indicates the end of a data list or an error list.
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. Your management application can issue the GETVERSION command with the object type ZCOM-OBJ-NULL or ZCOM-OBJ-PROC.
COMMANDS AND RESPONSES GETVERSION Command Tokens in Response Buffer ZSPI-TKN-SSID token-type ZSPI-TKN-SERVER-VERSION token-type ZSPI-TKN-DATALIST token-type ZCOM-TKN-OBJNAME token-type ZCOM-TKN-OBJTYPE token-type ZSPI-TKN-ERRLIST token-type ... ZSPI-TKN-ENDLIST token-type ZSPI-TKN-RETCODE token-type ZSPI-TKN-SERVER-BANNER token-type ZSPI-TKN-ENDLIST token-type ZSPI-TYP-SSID. ZSPI-TYP-INT. ZSPI-TYP-LIST. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-LIST. !{} !{} ZSPI-TYP-SSCTL. ZSPI-TYP-ENUM.
COMMANDS AND RESPONSES GETVERSION Command Tokens in Response Buffer ZSPI-TKN-SSID is an echo of the subsystem ID value provided by your application. 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. ZSPI-TKN-DATALIST indicates the beginning of a data list. "SPI Standard Definitions" in Section 5 for details.
COMMANDS AND RESPONSES GETVERSION Command ZCOM-ERR-CMD-MISMATCH (-4) Your management application tried to obtain version information 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. ZSPI-TKN-ENDLIST indicates the end of a data list or an error list.
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-INFOSU extensible structured tokens. When your management application issues the INFO command for a line, the subsystem checks for the optional subordinate-modifier token.
COMMANDS AND RESPONSES INFO Command Command ZCOM-CMD-INFO Object Type ZCOM-OBJ-LINE or 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 ZCOM-TKN-SUB token-type ZSPI-TYP-TIMESTAMP. token-type ZSPI-TYP-ENUM.
COMMANDS AND RESPONSES INFO Command 02 02 02 02 02 02 02 02 02 02 02 02 02 ZMULTI-BLOCK ZOFFLINE-TIMER ZPROG ZREAD-CMD ZRETRY ZSYNCS ZTEST-INTVL ZTHRES ZTIMEOUT ZXLATE ZXPARENT ZWACK-DELAY ZXLATE-IN 02 ZXLATE-OUT type ZSPI-DDL-BOOLEAN. type ZSPI-DDL-TIMESTAMP. type ZSPI-DDL-FNAME. type ZSPI-DDL-ENUM. type ZSPI-DDL-INT. type ZSPI-DDL-INT. type ZSPI-DDL-TIMESTAMP. type ZSPI-DDL-INT. type ZSPI-DDL-TIMESTAMP. type ZSPI-DDL-BOOLEAN. type ZSPI-DDL-BOOLEAN. type ZSPI-DDL-TIMESTAMP.
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 "DataCommunications Standard Definitions" in Section 5, "Common Definitions," and the Communications Management Programming Manual . ZCOM-MAP-REQID and ZCOM-TKN-CMD-TIMEOUT are standard datacommunications tokens that your application can optionally provide.
COMMANDS AND RESPONSES INFO Command Tokens in Response Buffer ZSPI-TKN-SSID is an echo of the subsystem ID value provided by your application. 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.
COMMANDS AND RESPONSES INFO Command ZCTL-SET An enumerated value that specifies the bisynchronous control set. The value ZTR3-VAL-CTLSET-ASCII indicates that the ASCII control set will be used. The value ZTR3-VAL-CTL-SET-EBCDIC indicates that the EBCDIC control set will be used. The default value is ZTR3-VAL-CTL-SETEBCDIC. ZDEBUG A Boolean variable that enables the CLIP DEBUG interface. If the value is ZSPI-VAL-TRUE, the interface is enabled. If the value is ZSPI-VALFALSE, the interface is not enabled.
COMMANDS AND RESPONSES INFO Command %177777 The TR3271 subsystem responds with an ACK0 and acknowledges data from the host. Although acknowledged, the data is discarded because it was unsolicited. An event message 112 is sent to the EMS log indicating that data has been discarded (see the description of event message 112 in Section 7, "Event Management"). Data from the host continues to be discarded until an application OPENs or CONNECTs the subdevice.
COMMANDS AND RESPONSES INFO Command ZREAD-CMD An enumerated value that specifies whether the TR3271 subsystem accepts the Read Buffer and Read Modified command from the host. The value ZTR3-VAL-READ-NONE causes the subsystem to reject the Read Buffer and Read Modified commands. The value ZTR3-VAL-READ-ALL causes the subsystem to accept both the Read Buffer and Read Modified commands. ZTR3-VAL-READ-RDMOD causes the subsystem to accept the Read Modified command, but reject the Read Buffer command.
COMMANDS AND RESPONSES INFO Command ZXLATE A Boolean variable that specifies whether the TR3271 subsystem translates inbound and outbound data. If the value is ZSPI-VAL-TRUE, the TR3271 subsystem translates inbound data (from the line) from EBCDIC to ASCII, and translates outbound data (to the line) from ASCII to EBCDIC. If the value is ZSPI-VAL-FALSE, the TR3271 subsystem does not translate characters. The default is ZSPI-VAL-TRUE.
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 subdevice. 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 ZCOMVAL-SUB-ALL or ZCOM-VAL-SUB-ONLY. Duplicate occurrences of these fields are not allowed.
COMMANDS AND RESPONSES INFO Command ZXPARENT ZXPARENT is a Boolean value that controls transparent-text mode for the named subdevice. If the value is ZSPI-VAL-TRUE, transparent-text mode is enabled for the subdevice; if the value is ZSPIVAL-FALSE, it is not. The default is ZSPI-VALFALSE. Transparent-text mode can only be enabled if the TR3271 line is configured with the EBCDIC character set and transparent-text mode enabled.
COMMANDS AND RESPONSES INFO Command ZSPI-TKN-ERRLIST indicates the beginning of an error list. "SPI Standard Definitions" in Section 5 for details. See 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.
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. • All valid users on the system can issue the INFO command. • To change the values of the attributes, use the ALTER command.
COMMANDS AND RESPONSES LISTOBJECTS Command LISTOBJECTS Command The LISTOBJECTS command lists the names of objects known to the TR3271 subsystem. 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.
COMMANDS AND RESPONSES LISTOBJECTS Command Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-NULL or ZCOM-OBJ-LINE or 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 ZCOM-TKN-SUB token-type ZSPI-TYP-TIMESTAMP. token-type ZSPI-TYP-ENUM.
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. ZCOM-MAP-REQID and ZCOM-TKN-CMD-TIMEOUT are standard datacommunications tokens that your application can optionally provide.
COMMANDS AND RESPONSES LISTOBJECTS Command ZSPI-TKN-SERVER-VERSION indicates the software release version of the TR3271 subsystem. See "SPI Standard Definitions" in Section 5 for details. ZSPI-TKN-DATALIST indicates the beginning of a data list. "SPI Standard Definitions" in Section 5 for details. See ZCOM-TKN-OBJNAME specifies the name of the TR3271 line or subdevice that was listed by the command.
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. The command is valid only for the values ZCOM-OBJ-NULL, ZCOM-OBJ-LINE, or ZCOM-OBJ-SU.
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. Once the command is completed and the CLIP is loaded, start the CLIP. Typically, a RESET must be performed prior to command.
COMMANDS AND RESPONSES LOAD Command Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-RETCODE ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT token-type token-type token-type token-type token-type token-type ZSPI-TYP-SSID. ZSPI-TYP-INT. ZSPI-TYP-LIST. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-LIST. !{} !{} !... !{} !{} !... token-type token-type token-type token-type ZSPI-TYP-SSCTL. ZSPI-TYP-ENUM.
COMMANDS AND RESPONSES LOAD Command ZSPI-TKN-SERVER-VERSION indicates the software release version of the TR3271 subsystem. See "SPI Standard Definitions" in Section 5 for details. ZSPI-TKN-DATALIST indicates the beginning of a data list. See "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.
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. • The line must be in the STOPPED summary state when this command is issued. • Use the START command to start the line.
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. The line must be in the STOPPED summary state when your management application issues this command.
COMMANDS AND RESPONSES RESET Command Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-RETCODE ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT token-type token-type token-type token-type token-type token-type ZSPI-TYP-SSID. ZSPI-TYP-INT. ZSPI-TYP-LIST. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-LIST. !{} !{} !... !{} !{} !... token-type token-type token-type token-type ZSPI-TYP-SSCTL. ZSPI-TYP-ENUM.
COMMANDS AND RESPONSES RESET Command ZSPI-TKN-SERVER-VERSION indicates the software release version of the TR3271 subsystem. See "SPI Standard Definitions" in Section 5 for details. ZSPI-TKN-DATALIST indicates the beginning of a data list. "SPI Standard Definitions" in Section 5 for details. See 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.
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 ZCOMOBJ-LINE. ZCOM-ERR-CMD-INV-IN-SUMSTATE (-3) Your management application tried to reset a line that was not in the STOPPED summary state. The STARTED and DIAGNOSING summary states prevent processing of the RESET command.
COMMANDS AND RESPONSES RESETSTATS Command RESETSTATS Command The RESETSTATS command returns statistical information about the execution history for the specified object(s). The type of information returned by this command is the same as that returned by the STATISTICS command, but this command initializes the statistics counters after the information is placed in a reply message. This is a sensitive command.
COMMANDS AND RESPONSES RESETSTATS Command ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT token-type ZSPI-TYP-ENUM. token-type ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST token-type ZSPI-TYP-SSID. token-type ZSPI-TYP-INT. 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. 02 ZTR3-LINE-CLB.
COMMANDS AND RESPONSES RESETSTATS Command ZCOM-TKN-OBJTYPE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-RETCODE ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT token-type ZSPI-TYP-ENUM. token-type ZSPI-TYP-LIST. token-type token-type token-type token-type !{} !... ZSPI-TYP-SSCTL. ZSPI-TYP-ENUM. !{} ZSPI-TYP-SSCTL. 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.
COMMANDS AND RESPONSES RESETSTATS Command If this token is not present, and the LINE or SU object is specified, the command affects the named object only. (ZSPI-TKN-) MANAGER, SSID, MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and COMMENT are standard SPI tokens. With the exception of the ZSPI-TKN-SSID token, which your management application must pass to SSINIT, these tokens are optional.
COMMANDS AND RESPONSES RESETSTATS Command ZNO-BUF is the number of times the TR3271 subsystem could not allocate a buffer for a request made by the specified line. ZTR3-LINE-L2 is a structure that contains information about level 2 for the specified line. ZTR3-LINE-L2 consists of the following fields: ZTOTAL-MSG is the total number of messages that were sent from and received by the TR3271 subsytem for the specified line.
COMMANDS AND RESPONSES RESETSTATS Command ZMSG-G1024-SENT is the number of messages, which were greater than 1024 bytes in length, that the TR3271 subsystem sent to the specified line. ZMSG-G1024-RECVED is the number of messages, which were greater than 1024 bytes in length, that the TR3271 subsystem received from the specified line. ZTR3-MAP-RSTATS-SU is the extensible structured token that lists the statistical counters obtained during the sample period for the specified subdevice.
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" in the Communications Management Programming Manual.
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. • For statistical information without initializing the counters, use the STATISTICS command.
COMMANDS AND RESPONSES START Command START Command The START command initiates the operation of lines and subdevices. 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; it cannot be in the DIAGNOSING or the STARTED summary state.
COMMANDS AND RESPONSES START Command 02 ZCRTPID 02 ZPAID end. type ZSPI-DDL-CRTPID. type ZSPI-DDL-INT. ZCOM-TKN-CMD-TIMEOUT ZCOM-TKN-SUB token-type ZSPI-TYP-TIMESTAMP. token-type ZSPI-TYP-ENUM. ZSPI-TKN-MANAGER ZSPI-TKN-SSID ZSPI-TKN-MAXRESP ZSPI-TKN-CONTEXT ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-SSID. !{} ZSPI-TYP-INT. ZSPI-TYP-BYTESTRING. ZSPI-TYP-ENUM. ZSPI-TYP-ENUM.
COMMANDS AND RESPONSES START Command ZCOM-TKN-SUB specifies whether subordinates are to be affected by the START command. For the START command, the possible values of this token are as follows: ZCOM-VAL-SUB-ALL If the object type is LINE, start the named line and all its subordinate subdevices. The 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.
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. ZCOM-TKNOBJNAME is described in "Data-Communications Standard Definitions" in Section 5, "Common Definitions" and the Communications Management Programming Manual. ZCOM-TKN-OBJTYPE specifies the type of object that was started.
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.
COMMANDS AND RESPONSES STATISTICS Command STATISTICS Command The STATISTICS command returns statistical information about the execution history for the specified object(s). The type of information returned by this command is the same as that returned by the RESETSTATS command, but this command does not initialize the statistics counters after the TR3271 subsystem places the information in a reply message.
COMMANDS AND RESPONSES STATISTICS Command ZSPI-TKN-CONTEXT ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-BYTESTRING. ZSPI-TYP-ENUM. ZSPI-TYP-ENUM. ZSPI-TYP-STRING. Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST token-type ZSPI-TYP-SSID. token-type ZSPI-TYP-INT. token-type ZSPI-TYP-LIST. ZTR3-MAP-STATS-LINE def ZTR3-DDL-STATS-LINE. 02 ZRESET-TIME 02 ZSAMPLE-TIME 02 ZTR3-LINE-CLB.
COMMANDS AND RESPONSES STATISTICS Command ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-RETCODE ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-ENUM. token-type ZSPI-TYP-LIST. token-type token-type token-type token-type !{} !{} !... ZSPI-TYP-SSCTL. ZSPI-TYP-ENUM. !{} ZSPI-TYP-SSCTL. ZSPI-TYP-BYTESTRING.
COMMANDS AND RESPONSES STATISTICS Command (ZSPI-TKN-) MANAGER, SSID, MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and COMMENT are standard SPI tokens. With the exception of the ZSPI-TKN-SSID token, which your management application must pass to SSINIT, these tokens are optional. These tokens are described in "SPI Standard Definitions" in Section 5 and the Distributed Systems Management (DSM) Programming Manual .
COMMANDS AND RESPONSES STATISTICS Command ZTR3-LINE-L2 is a structure that contains information about level 2 for the specified line. ZTR3-LINE-L2 consists of the following fields: ZTOTAL-MSG is the total number of messages that were sent from and received by the TR3271 subsytem for the specified line. ZMSG-SENT is the number of messages that were sent from the TR3271 subsystem to the specified line. ZMSG-RECVED is the number of messages that were received by the TR3271 subsystem from the specified line.
COMMANDS AND RESPONSES STATISTICS Command ZMSG-G1024-RECVED is the number of messages, which were greater than 1024 bytes in length, that the TR3271 subsystem 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. It has the token number ZTR3-TNM-STATSSU and the DDL definition ZTR3-DDL-STATS-SU. Each counter is defined in a separate field.
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" in the Communications Management Programming Manual.
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.
COMMANDS AND RESPONSES STATUS Command STATUS Command The STATUS command returns information about the current summary state, the last detected error, and the environment of the specified objects. When the TR3271 subsystem completes processing this command, the specified object remains in the same summary state. You can inquire about the status of a line or a subdevice, but not a process.
COMMANDS AND RESPONSES STATUS Command Command ZCOM-CMD-STATUS Object Type ZCOM-OBJ-LINE or 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 ZCOM-TKN-SUB ZCOM-TKN-SEL-SUMSTATE token-type ZSPI-TYP-TIMESTAMP. token-type ZSPI-TYP-ENUM. token-type ZSPI-TYP-INT-PAIR.
COMMANDS AND RESPONSES STATUS Command 04 ZPIN 02 ZBPID. 04 ZCPU 04 ZPIN 02 ZPATH 02 ZCSM-LDEV 02 ZCU-PRIM 02 ZCU-BKUP 02 ZDEBUG 02 ZTRACE 02 ZTOTAL-SU 02 ZTOTAL-SU-OPENED 02 ZIO-ADDR-PRIM 02 ZIO-ADDR-BKUP end. type ZSPI-DDL-INT. type type type type type type type type type type type type ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-ENUM. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-BOOLEAN. ZSPI-DDL-BOOLEAN. ZSPI-DDL-INT. ZSPI-DDL-INT. ZSPI-DDL-EXIOADDR. ZSPI-DDL-EXIOADDR.
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 "DataCommunications Standard Definitions" in Section 5, "Common Definitions," and the Communications Management Programming Manual . ZCOM-MAP-REQID and ZCOM-TKN-CMD-TIMEOUT are standard datacommunications tokens that your application can optionally provide.
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 has been specified, the objects for which information is returned depends on the value of the SUB modifier. TRUE STOPPED Return information for the named object in the STOPPED summary state.
COMMANDS AND RESPONSES STATUS Command Tokens in Response Buffer ZSPI-TKN-SSID is an echo of the subsystem ID value provided by your application. 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.
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. ZPATH is the primary path to the CLIP. field can be one of the following: The value of this ZCOM-VAL-PATH-A Path A is the primary path to the CLIP.
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 contains status information for the subdevices that have been queried. It has the token number ZTR3-TNM-STATUS-SU and the DDL definition ZTR3-DDL-STATUS-SU.
COMMANDS AND RESPONSES STATUS Command Bit 10 indicates the subsystem is attempting to connect the subdevice. This applies to PTP subdevices only. Bit 11 indicates the subsystem is attempting to disconnect the subdevice. This applies to PTP subdevices only. Bit 12 is not used. Bit 13 is not used. Bit 14 is for internal use only. Bit 15 is for internal use only. ZLAST-ERR is the last error detected on the queried subdevice.
COMMANDS AND RESPONSES STATUS Command ZCOM-TKN-OBJTYPE specifies the type of object that was queried. This token can have the value ZCOM-OBJ-LINE or ZCOM-OBJ-SU. This token is described in "Data-Communications Standard Definitions" in Section 5, "Common Definitions," and the Distributed Systems Management Programming Manual. ZSPI-TKN-ERRLIST indicates the beginning of an error list. This token is described in "SPI Standard Definitions" in Section 5 and the Distributed Systems Management Programming Manual.
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. If this token is present, the response continues to the next reply message.
COMMANDS AND RESPONSES STOP Command STOP Command The STOP command terminates the operation of the specified object. You can stop a line or a subdevice, but not a process. When the subsystem completes processing the command, the specified object is placed in the STOPPED summary state. When you are using the STOP command, the termination is done in a more orderly fashion than the ABORT command. The subsystem checks for subdevices currently open before terminating the connection.
COMMANDS AND RESPONSES STOP Command Command ZCOM-CMD-STOP Object Type ZCOM-OBJ-LINE or 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 ZCOM-TKN-SUB token-type ZSPI-TYP-TIMESTAMP. token-type ZSPI-TYP-ENUM.
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. ZCOM-MAP-REQID and ZCOM-TKN-CMD-TIMEOUT are standard datacommunications tokens that your application can optionally provide.
COMMANDS AND RESPONSES STOP Command ZSPI-TKN-SERVER-VERSION indicates the software release version of the TR3271 subsystem. This token is described in "SPI Standard Definitions" in Section 5 and the Distributed System Management (DSM) Programming Manual . ZSPI-TKN-DATALIST indicates the beginning of a data list. This token is described in "SPI Standard Definitions" in Section 5 and the Distributed Systems Management (DSM) Programming Manual.
COMMANDS AND RESPONSES STOP 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 only accepts 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 stop a process by using the value ZCOM-OBJ-PROC. The command is valid only for the values ZCOM-OBJ-LINE and ZCOM-OBJ-SU.
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. If this token is not present, the reply message is the last to be received.
COMMANDS AND RESPONSES SWITCH Command 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. You cannot switch a subdevice. When the subsystem completes processing this command, the specified object remains in the same summary state it was in before the command was issued.
COMMANDS AND RESPONSES SWITCH Command def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. type ZSPI-DDL-CRTPID. type ZSPI-DDL-INT. ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-TIMESTAMP. ZSPI-TKN-MANAGER ZSPI-TKN-SSID ZSPI-TKN-MAXRESP ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-SSID. ZSPI-TYP-INT. ZSPI-TYP-ENUM. ZSPI-TYP-ENUM. ZSPI-TYP-STRING.
COMMANDS AND RESPONSES SWITCH Command If ZCOM-TKN-SWITCH-PATH is specified, the path (used by the line) to the CPU is to be switched. The value of this token is an enumerated value indicating the path leading to the CPU the line is to be switched to. This token can have the following values: ZCOM-VAL-PATH-A The line is to be switched to path A. ZCOM-VAL-PATH-B The line is to be switched to path B. This value corresponds to the SYSGEN modifier ALTERNATE_PATH.
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. This token is described in the Distributed Systems Management Programming Manual .
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-TKNRETCODE of 0 is returned; however, a -1 is within the error list. 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 • SWITCH is a sensitive command.
COMMANDS AND RESPONSES TRACE Command TRACE Command The TRACE command allows your management application to capture and store records that can be displayed using the PTRACE command. The TR3271 subsystem does not support the TRACE command directly. 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.
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. 02 ZCOLL type ZSPI-DDL-BOOLEAN. 02 FNAME type ZSPI-DDL-FNAME32. end.
COMMANDS AND RESPONSES TRACE Command Tokens in Response Buffer ZSPI-TKN-SSID ZSPI-TKN-SERVER-VERSION ZSPI-TKN-DATALIST ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-RETCODE ZSPI-TKN-ENDLIST token-type token-type token-type token-type token-type token-type ZSPI-TYP-SSID. ZSPI-TYP-INT. ZSPI-TYP-LIST. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-LIST. token-type ZSPI-TYP-SSCTL. token-type ZSPI-TYP-ENUM. token-type ZSPI-TYP-SSCTL.
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. ZTR3-VAL-TRACE-OPT-CLIPDO Trace CLIP outbound frames. ZTR3-VAL-TRACE-OPT-CLIPL2 Trace CLIP level-2 events. ZTR3-VAL-TRACE-OPT-CLIPL3 Trace CLIP level-3 events.
COMMANDS AND RESPONSES TRACE Command ZSPI-TKN-SERVER-VERSION indicates the software release version of the TR3271 subsystem. This token is described in "SPI Standard Definitions" in Section 5 and the Distributed Systems Management (DSM) Programming Manual . ZSPI-TKN-DATALIST indicates the beginning of a data list. 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.
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. If this token is not present, the reply message is the last to be received.
SECTION 7 TR3271 EVENT MANAGEMENT The TR3271 subsystem reports information about events it detects by issuing event messages. A management application can obtain these event messages by opening an Event Management Service (EMS) distributor process and requesting the messages. The application can also specify that a filter be applied to select certain event messages.
TR3271 EVENT MANAGEMENT Subsystem Processes That Report Events Table 7-1.
TR3271 EVENT MANAGEMENT Critical Events CRITICAL EVENTS Events reported by the TR3271 subsystem are divided into two classes: critical events and noncritical events. Critical events are errors and warnings for which the consequences could be serious, such as a hardware failure or a software error from which there is no recovery. Noncritical events are often expected events that are informational in nature, such as a line becoming ready.
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. For more information about filters, refer to the Event Management Service (EMS) Manual .
TR3271 EVENT MANAGEMENT Event-Message Descriptions If the event is for a controller that uses the I/O addressing that does not allow conversion from the physical I/O address to the subchannel CU address format, then the event message buffer will contain the ZEMS-MAP-EXIOADDR token only.
TR3271 EVENT MANAGEMENT 3: ZTR3-EVT-IOBUS-ERR 3: 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.
TR3271 EVENT MANAGEMENT 3: ZTR3-EVT-IOBUS-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. IOBUS-ERR (3). Its value is ZTR3-EVT- 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.
TR3271 EVENT MANAGEMENT 3: ZTR3-EVT-IOBUS-ERR 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-TKNLDEV, n,n,%nn,%nnn corresponds to the value of ZEMS-MAP-EXIOADDR, ldevname corresponds to the value of ZEMS-TKN-LDEVNAME, and fileerr corresponds to the value of ZTR3-TKN-FILE-ERR.
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. Report this message and other related console messages to your Tandem representative.
TR3271 EVENT MANAGEMENT 4: ZTR3-EVT-CIU-ERR 4: 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. the line goes down. If a path or CPU is not available, This event message is equivalent to console message 04.
TR3271 EVENT MANAGEMENT 4: ZTR3-EVT-CIU-ERR 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. DEV-ERROR (4). Its value is ZTR3-EVT- ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
TR3271 EVENT MANAGEMENT 4: ZTR3-EVT-CIU-ERR 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-TKNLDEV, n,n,%nn,%nnn corresponds to the value of ZEMS-MAP-EXIOADDR, ldevname corresponds to the value of ZEMS-TKN-LDEVNAME, and ciustatus corresponds to the value ZTR3-TKN-CIU-STATUS.
TR3271 EVENT MANAGEMENT 4: ZTR3-EVT-CIU-ERR For the CIU, the bits of the status word that are equal to 1 can be interpreted as follows: Bit .0 .1 .2 .3 .4:7 .8 .9 .10 .
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.
TR3271 EVENT MANAGEMENT 6: ZTR3-EVT-OBJ-STARTED 6: ZTR3-EVT-OBJ-STARTED The TR3271 line has been brought up successfully. This event is not critical, and the event message is reported to the EMS collector ($0). This event message is equivalent to console message 06.
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. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-FALSE, indicating that this event is not a critical event. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. ZEMS-TKN-CPU is the CPU of the TR3271 subsystem.
TR3271 EVENT MANAGEMENT 6: ZTR3-EVT-OBJ-STARTED Probable Cause The TR3271 line has been brought up successfully. The line can be brought up programmatically using the 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. Recommended Action This event message is an informative message only; no corrective action is needed.
TR3271 EVENT MANAGEMENT 7: ZTR3-EVT-OBJ-STOPPED 7: 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. The event message is reported to the EMS collector ($0). This event message is equivalent to console message 07.
TR3271 EVENT MANAGEMENT 7: ZTR3-EVT-OBJ-STOPPED 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. OBJ-STOPPED (7). Its value is ZTR3-EVT- ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
TR3271 EVENT MANAGEMENT 7: ZTR3-EVT-OBJ-STOPPED Event-Message Text In the text message, ldev corresponds to the value of ZEMS-TKNLDEV, n,n,%nn,%nnn corresponds to the value of ZEMS-MAP-EXIOADDR, and ldevname corresponds to the value of ZEMS-TKN-LDEVNAME. Probable Cause 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.
TR3271 EVENT MANAGEMENT 67: ZTR3-EVT-SUBDEV-ERR 67: ZTR3-EVT-SUBDEV-ERR An operation or a request to a subdevice was incorrect. This event is not critical, and the event message is reported to the EMS collector ($0). This event message is equivalent to console message 67.
TR3271 EVENT MANAGEMENT 67: ZTR3-EVT-SUBDEV-ERR 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. It corresponds to the value ldev in the text message.
TR3271 EVENT MANAGEMENT 67: ZTR3-EVT-SUBDEV-ERR Event-Message Text In the text message, ldev corresponds to the value of ZEMS-TKNLDEV, ldevname corresponds to the value of ZEMS-TKN-LDEVNAME, ddd corresponds to the value of 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 incorrect.
TR3271 EVENT MANAGEMENT 74: ZTR3-EVT-INTL-ERR 74: 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.
TR3271 EVENT MANAGEMENT 74: ZTR3-EVT-INTL-ERR 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. INTL-ERR (74). Its value is ZTR3-EVT- ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
TR3271 EVENT MANAGEMENT 74: ZTR3-EVT-INTL-ERR Event-Message Text In the text message, ldev corresponds to the value of ZEMS-TKNLDEV, n,n,%nn,%nnn corresponds to the value of ZEMS-MAP-EXIOADDR, ldevname corresponds to the value of ZEMS-TKN-LDEVNAME, and the remaining values are internal tokens. Probable Cause An internal error has been detected. After this event message is issued, application requests are aborted and the TR3271 subsystem recovers.
TR3271 EVENT MANAGEMENT 90: ZTR3-EVT-PROC-ABEND 90: ZTR3-EVT-PROC-ABEND The TR3271 I/O process abended during initialization because it could not obtain the system resources it needed, or a COUP parameter is incorrect or inconsistent. The I/O process can abend during a cold load or while using the DSC facility by means of COUP commands. This event is critical, and the event message is reported to the EMS collector ($0).
TR3271 EVENT MANAGEMENT 90: ZTR3-EVT-PROC-ABEND 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. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event.
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 inconsistent. The I/O process stops and cannot be used. The TR3271 process deletes itself. The value of nnnnn indicates the reason for the abend. The error codes in the 1 through 999 range indicate a memory-related error, while error codes in the 1000 through 1999 range indicate a COUP configuration error.
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.
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.
TR3271 EVENT MANAGEMENT 106: ZTR3-EVT-INSUFF-BUF 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. INSUFF-BUF (106). Its value is ZTR3-EVT- ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
TR3271 EVENT MANAGEMENT 106: ZTR3-EVT-INSUFF-BUF Event-Message Text In the text message, ldev corresponds to the value of ZEMS-TKNLDEV 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. The line handler does not accept any operations. Recommended Action Reconfigure the system specifying a larger buffer with the MAXLOCALAREA modifier.
TR3271 EVENT MANAGEMENT 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.
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. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. ZEMS-TKN-CPU is the CPU of the TR3271 subsystem.
TR3271 EVENT MANAGEMENT 112: ZTR3-EVT-DISCARD-ERR Probable Cause The INITSTATUS modifier was defined with a value of %177777 for the TR3271 subsystem. This modifier can be defined at system generation time, or altered dynamically using the control-andinquiry 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.
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.
TR3271 EVENT MANAGEMENT 141: ZTR3-EVT-CLIP-DWLOAD 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. CLIP-DWLOAD (141). Its value is ZTR3-EVT- ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
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-TKNLDEV, n,n,%nn,%nnn corresponds to the value of ZEMS-MAP-EXIOADDR, and ldevname corresponds to the value of ZEMS-TKN-LDEVNAME.
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. This event can also indicate that the IOP received an unexpected probe response or a nonzero CLB type in the response. This event is critical, and the event message is reported to the EMS collector ($0).
TR3271 EVENT MANAGEMENT 147: ZTR3-EVT-CSS-PROBE-ERR 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, as described in the Event Management Service (EMS) Manual. Its value is ZTR3-EVTCSS-PROBE-ERR (147). ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
TR3271 EVENT MANAGEMENT 147: ZTR3-EVT-CSS-PROBE-ERR For details on any of the EMS tokens, refer to the Event Management Service (EMS) Manual. 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.
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.
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). This event message is equivalent to console message 157.
TR3271 EVENT MANAGEMENT 157: ZTR3-EVT-CSS-FRAME-ERR 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, as described in the Event Management Service (EMS) Manual. Its value is ZTR3-EVTCSS-FRAME-ERR (157). ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
TR3271 EVENT MANAGEMENT 157: ZTR3-EVT-CSS-FRAME-ERR ZTR3-TKN-ADDR-CTL is the A and C fields. value param1 in the message text. It corresponds to the ZTR3-TKN-TYPE-SEQ is the T and S fields. value param2 in the message text. It corresponds to the For details on any of the EMS tokens, refer to the Event Management Service (EMS) Manual. Volatile Tokens ZEMS-TKN-CU is a standard EMS token that contains the controller and unit number.
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: 0 Unexpected frame 1 Invalid A field (address) 2 Invalid C field (control) 3 Invalid T field (type) 4 Invalid S field (sequence number) 5 Invalid function 6 Not the expected response to the command 7 Type-6 error message received from CLIP %10 Not the expected multiframe type received The value param1 in the text message cont
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 breakpoint. This event is critical, and the event message is reported to the EMS collector ($0). This event message is equivalent to console message 158.
TR3271 EVENT MANAGEMENT 158: ZTR3-EVT-CSS-UNEXP-BRKPT 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, as described in the Event Management Service (EMS) Manual. Its value is ZTR3-EVTCSS-UNEXP-BRKPT (158). ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
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.
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). This event message is equivalent to console message 160.
TR3271 EVENT MANAGEMENT 160: ZTR3-EVT-CSS-LIU-CONFIG-ERR 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, as described in the Event Management Service (EMS) Manual. Its value is ZTR3-EVTCSS-LIU-CONFIG-ERR (160).
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. It 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.
TR3271 EVENT MANAGEMENT 164: ZTR3-EVT-CSS-LINE-ERR 164: ZTR3-EVT-CSS-LINE-ERR The Communications Line Interface Processor Communications Subsystem (CSS) responded to process with an invalid function modifier. critical, and the event message is reported ($0). (CLIP) of the 6100 the TR3271 I/O This event is to the EMS collector This event message is equivalent to console message 164.
TR3271 EVENT MANAGEMENT 164: ZTR3-EVT-CSS-LINE-ERR 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, as described in the Event Management Service (EMS) Manual. Its value is ZTR3-EVTCSS-LINE-ERR (164). ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
TR3271 EVENT MANAGEMENT 164: ZTR3-EVT-CSS-LINE-ERR ZTR3-TKN-CLIP-SU is the CLIP subdevice number. the value param3 in the message text. It corresponds to ZTR3-TKN-CLIP-STATUS is the status returned by the CLIP. corresponds to the value param2 in the message text. It 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.
TR3271 EVENT MANAGEMENT 164: ZTR3-EVT-CSS-LINE-ERR Value 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 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 Line overran CLIP Not used Operation timeout Line not configured Invalid parameter SU not ready RVI received with status The value of param3 indicates the CLIP subdevice number.
TR3271 EVENT MANAGEMENT 165: 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). This event message is equivalent to console message 165.
TR3271 EVENT MANAGEMENT 165: ZTR3-EVT-CSS-SUBDEV-ERR 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, as described in the Event Management Service (EMS) Manual. Its value is ZTR3-EVTCSS-SUBDEV-ERR (165). ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
TR3271 EVENT MANAGEMENT 165: ZTR3-EVT-CSS-SUBDEV-ERR ZTR3-TKN-CLIP-SU is the CLIP subdevice number. the value param1 in the message text. It corresponds to ZTR3-TKN-CLIP-STATUS is the status returned by the CLIP. corresponds to the value param3 in the message text. It 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.
TR3271 EVENT MANAGEMENT 165: ZTR3-EVT-CSS-SUBDEV-ERR Value 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 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 Unknown device status Line overran CLIP Not used Operation timeout Line not configured Invalid parameter SU not ready RVI received with status Recommended Action Note the values of all the
TR3271 EVENT MANAGEMENT -1: ZCOM-EVT-CPU-SWITCH -1: 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).
TR3271 EVENT MANAGEMENT -1: ZCOM-EVT-CPU-SWITCH 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, as described in the Event Management Service (EMS) Manual. Its value is ZCOM-EVTCPU-SWITCH (-1). ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
TR3271 EVENT MANAGEMENT -1: ZCOM-EVT-CPU-SWITCH ZCOM-TKN-CAUSE-CPU-SWITCH is the reason the CPU was switched to the backup CPU. It corresponds to the value of reason in the message text. The possible values are: Value Corresponding Text ZCOM-VAL-OP-REQ OPERATOR REQUESTED ZCOM-VAL-HW of HARDWARE OR LOW LEVEL SOFTWARE PROBLEM ZCOM-VAL-TAKOVR TAKEN OVER BY PRIMARY Volatile Tokens ZEMS-TKN-CU is a standard EMS token that contains the controller and unit number.
TR3271 EVENT MANAGEMENT -2: ZCOM-EVT-PATH-SWITCH -2: 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).
TR3271 EVENT MANAGEMENT -2: ZCOM-EVT-PATH-SWITCH 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, as described in the Event Management Service (EMS) Manual. Its value is ZCOM-EVTPATH-SWITCH (-2). ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
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), ZCOMVAL-PATH-B (displayed as B), and ZCOM-VAL-PATH-UNDEF (undefined). ZCOM-TKN-CAUSE-PATH-SWITCH is the reason the PATH was switched to the backup path. It corresponds to the value of reason in the message text.
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. See Section 6, "Commands and Responses," for a description of the programmatic SWITCH command. Recommended Action If a command caused the switch, no action is necessary. If not, note the reason code and contact your Tandem representative.
TR3271 EVENT MANAGEMENT -3: ZCOM-EVT-SUMSTATE-CHG -3: 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).
TR3271 EVENT MANAGEMENT -3: ZCOM-EVT-SUMSTATE-CHG 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, as described in the Event Management Service (EMS) Manual. Its value is ZCOM-EVTSUMSTATE-CHG (-3). ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
TR3271 EVENT MANAGEMENT -3: ZCOM-EVT-SUMSTATE-CHG ZCOM-TKN-CAUSE-SUMSTATE-CHG is the reason the summary state has changed. It corresponds to the value of reason in the message text. The possible values are: Value Corresponding Text ZCOM-VAL-OP-REQ OPERATOR REQUESTED ZCOM-VAL-HW of HARDWARE OR LOW LEVEL SOFTWARE PROBLEM ZCOM-VAL-UNKWN of UNKNOWN REASON Volatile Tokens ZEMS-TKN-CU is a standard EMS token that contains the controller and unit number.
TR3271 EVENT MANAGEMENT Examples of Filters EXAMPLES OF FILTERS The following two examples illustrate simple filters that could be created to select TR3271 event messages. For both examples, the following assumptions have been made: 1. All TR3271 definitions used in the filters have been loaded into TACL before compilation. 2. All subsytem IDs that are not initialized in the filter have been initialized by other means.
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. [#SET ztr3^val^ssid [zspi^val^tandem].[zspi^ssn^ztr3].
APPENDIX A ERROR NUMBERS AND ERROR LISTS This appendix describes the error numbers and associated error lists that are provided by the TR3271 subsystem. These error numbers occur as values of the token ZSPI-TKN-RETCODE. These errors cannot occur for all commands. To determine which commands return these TR3271-specific errors, refer to the description of the ZSPI-TKN-RETCODE for each of the commands in Section 6, "Commands and Responses.
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.
ERROR NUMBERS AND ERROR LISTS 2: ZTR3-ERR-CLIP-PROB 2: 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.
ERROR NUMBERS AND ERROR LISTS 3: ZTR3-ERR-TARGET-OBJ-NOT-FOUND 3: ZTR3-ERR-TARGET-OBJ-NOT-FOUND The CONNECT or DISCONNECT command has been issued, but the specified target AM3270 subdevice does not exist.
ERROR NUMBERS AND ERROR LISTS 4: ZTR3-ERR-ATTR-CONFL-SU 4: 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.
ERROR NUMBERS AND ERROR LISTS 4: ZTR3-ERR-ATTR-CONFL-SU Recommended Action Redefine the LINE and SU attributes so that they will be consistent.
ERROR NUMBERS AND ERROR LISTS 5: ZTR3-ERR-NOT-PTP-SU 5: 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.
ERROR NUMBERS AND ERROR LISTS 6: ZTR3-ERR-ALRDY-USING-ADDR 6: 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.
7: 7: 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 modifier. There are no objects currently in the selected summary state.
ERROR NUMBERS AND ERROR LISTS 8: ZTR3-ERR-OPENED-SU-EXIST 8: 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.
ERROR NUMBERS AND ERROR LISTS 10: ZTR3-ERR-TARGET-OBJNAME-INV 10: 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.
ERROR NUMBERS AND ERROR LISTS 11: ZTR3-ERR-NO-OWNER 11: 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.
ERROR NUMBERS AND ERROR LISTS 12: ZTR3-ERR-CONN-EXIST 12: ZTR3-ERR-CONN-EXIST The STOP command has been issued for a PTP subdevice that is currently connected. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ENDLIST type ZSPI-TYP-LIST type ZSPI-TYP-ERROR type ZSPI-TYP-STRING type ZSPI-TYP-ENUM type ZSPI-TYP-SSCTL Tokens ZSPI-TKN-ERROR is the standard SPI error token described in the Distributed Systems Management (DSM) Programming Manual.
ERROR NUMBERS AND ERROR LISTS 13: ZTR3-ERR-SU-OPENED 13: 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 (ZCOMVAL-SUB-ONLY) or the SU object has been specified. This applies only to CRT subdevices.
APPENDIX B TR3271 SUBSYSTEM DDL 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 ?SETSECTION constants ! ! TR3271 version definition, value change with each release.
TR3271 SUBSYSTEM DDL !---------------------------------------------------------------! ! begin of TOKEN definitions section. ! !---------------------------------------------------------------! ! ! TR3271 specific STRUCT token numbers. ! CONSTANT ZTR3-TNM-STRUCT-BASE VALUE IS 2000.
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.
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.
TR3271 SUBSYSTEM DDL ?PAGE "TR3271 STRUCT definitions for PROCESS object" !--------------------------------------------------------------! ! STRUCTs definition for PROCESS object. ! !------------------------------------------------------------- ! ?PAGE "TR3271 ALTER command STRUCT for LINE object" !--------------------------------------------------------------! ! STRUCTs/MAP definition for LINE object.
TR3271 SUBSYSTEM DDL ?PAGE "TR3271 INFO command STRUCT for LINE object" ?SECTION ZTR3-DDL-INFO-LINE ?SETSECTION ZTR3-DDL-INFO-LINE ?TALBOUND 0 ! ! 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. 02 Zctl-rts TYPE ZSPI-DDL-Boolean. 02 Zctl-set TYPE ZSPI-DDL-Enum. 02 Zdebug TYPE ZSPI-DDL-Boolean. 02 Zdrop-rts TYPE ZSPI-DDL-Boolean.
TR3271 SUBSYSTEM DDL ?PAGE "TR3271 STATISTICS command STRUCT for LINE object" ?SECTION ZTR3-DDL-STATS-LINE ?SETSECTION ZTR3-DDL-STATS-LINE ?TALBOUND 0 ! ! 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. 02 Zsample-time TYPE ZSPI-DDL-TimeStamp. ! ! For CLB Level ! 02 ZTR3-Line-CLB. 04 Ztotal-Frame TYPE ZSPI-DDL-Int.
TR3271 SUBSYSTEM DDL ?PAGE "TR3271 RESETSTAT command STRUCT for LINE object" ?SECTION ZTR3-DDL-RSTATS-LINE ?SETSECTION ZTR3-DDL-RSTATS-LINE ?TALBOUND 0 ! ! 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. 02 Zsample-time TYPE ZSPI-DDL-TimeStamp. ! ! For CLB Level ! 02 ZTR3-Line-CLB. 04 Ztotal-Frame TYPE ZSPI-DDL-Int.
TR3271 SUBSYSTEM DDL ?PAGE "TR3271 STATUS command STRUCT for LINE object" ?SECTION ZTR3-DDL-STATUS-LINE ?SETSECTION ZTR3-DDL-STATUS-LINE ?TALBOUND 0 ! ! 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. 02 ZPpid. 04 Zcpu TYPE ZSPI-DDL-Int. 04 Zpin TYPE ZSPI-DDL-Int. 02 ZBpid. 04 Zcpu TYPE ZSPI-DDL-Int. 04 Zpin TYPE ZSPI-DDL-Int.
TR3271 SUBSYSTEM DDL ?PAGE "TR3271 ADD command STRUCT for SUBDEVICE object" !--------------------------------------------------------------! ! ! ! STRUCTs/MAPs definition for SU object. ! ! ! !--------------------------------------------------------------! ?SECTION ZTR3-DDL-ADD-SU ?SETSECTION ZTR3-DDL-ADD-SU ?TALBOUND 0 ! ! 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.
TR3271 SUBSYSTEM DDL ?PAGE "TR3271 INFO command STRUCT for SUBDEVICE object" ?SECTION ZTR3-DDL-INFO-SU ?SETSECTION ZTR3-DDL-INFO-SU ?TALBOUND 0 ! ! 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 DEF IS ZTR3-DDL-INFO-SU. VERSION "C20" FOR ZAddr THRU ZType. END.
TR3271 SUBSYSTEM DDL ?PAGE "TR3271 RESETSTATS command STRUCT for SU object" ?SECTION ZTR3-DDL-RSTATS-SU ?SETSECTION ZTR3-DDL-RSTATS-SU ?TALBOUND 0 ! ! ZTR3-DDL-RSTATS-SU : ! ! This DDL is returned to the requester from TR3271 ! whenever a RESETSTATS SU command is processed. ! DEF ZTR3-DDL-RSTATS-SU. 02 Zreset-time TYPE ZSPI-DDL-TimeStamp. 02 Zsample-time TYPE ZSPI-DDL-TimeStamp. 02 Zerr TYPE ZSPI-DDL-Int. 02 Zmsg-sent TYPE ZSPI-DDL-Int. 02 Zmsg-recved TYPE ZSPI-DDL-Int. END.
TR3271 SUBSYSTEM DDL !--------------------------------------------------------------! ! TR3 EMS event definitions ! !--------------------------------------------------------------! CONSTANT ztr3-evt-iobus-err VALUE IS zems-evt-iobusmess. CONSTANT ztr3-evt-ciu-err VALUE IS zems-evt-errormess. CONSTANT ztr3-evt-obj-started VALUE IS zems-evt-upmess. CONSTANT ztr3-evt-obj-stopped VALUE IS zems-evt-downmess. CONSTANT ztr3-evt-subdev-err VALUE IS zems-evt-sderrormess.
TR3271 SUBSYSTEM DDL TOKEN-CODE ztr3-tkn-p-reg TOKEN-CODE ztr3-tkn-e-reg TOKEN-CODE ztr3-tkn-x1 TOKEN-CODE ztr3-tkn-x2 TOKEN-CODE ztr3-tkn-x3 TOKEN-CODE ztr3-tkn-x4 TOKEN-CODE ztr3-tkn-su TOKEN-CODE ztr3-tkn-clip-su TOKEN-CODE ztr3-tkn-file-err TOKEN-CODE ztr3-tkn-clip-func TOKEN-CODE ztr3-tkn-clip-status TOKEN-CODE ztr3-tkn-addr-ctl TOKEN-CODE ztr3-tkn-type-seq TOKEN-CODE ztr3-tkn-config-err TOKEN-CODE ztr3-tkn-ciu-status TOKEN-CODE ztr3-tkn-abendnum TOKEN-CODE ztr3-tkn-probe-err TOKEN-CODE ztr3-tkn-frame
INDEX ABORT command 6-8 Action events 7-4 ADD command 6-13 ALTER command 6-20 Applications naming rules and guidelines for obtaining event messages 7-1 using letter Z 3-4 Buffer declarations TR3271 5-18 Buffer size for an event message 7-4 recommended for commands 4-1 recommended for responses 4-3 Building the command buffer 4-1 3-4 CLIP downloading 6-71 placing in boot state 6-75 CMI corresponding commands of 2-8 Command buffer, building 4-1 Command numbers 3-4 Command-number token 5-4 Commands 6-1 ABOR
INDEX Commands (continued) discontinuing 4-2 duplicate occurrences of tokens 4-2 extensible structured tokens in 3-9 GETVERSION 6-48 header type 5-6 INFO 6-52 list of 2-4 LISTOBJECTS 6-65 LOAD 6-71 multiple, in single request message 4-1 nonsensitive 6-6 notation used to describe 6-6 number of object names accepted in 3-6 numbers 3-4 order of tokens in 6-7 recommended buffer size for 4-1 RESET 6-75 RESETSTATS 6-79 sensitive 6-6 START 6-88 STATISTICS 6-93 STATUS 6-102 STOP 6-113 subordinate-modifier token i
INDEX DELETE command 6-38 DISCONNECT command 6-43 Discontinuing a command 4-2 Elements of SPI messages 3-1 Emphasis token 5-10 Empty response record 4-4 EMS standard definitions 5-9 Error handling 4-4 Error lists 3-12, 5-5 representation of in responses 6-7 Error numbers with no error lists 4-4 Event management filters 7-78 TR3271 7-1 Event messages 2-10 buffer size 7-4 console-compatible-format text 7-7 display-format text 7-7 displayed on operator console 7-4 event numbers of 3-7 filters 7-4 notation 7-6
INDEX Extensible structured tokens 3-9 in commands 3-9 in responses 3-9 using SSNULL to initialize 4-2 Field types 3-10 Fields initializing 4-2 null values of 4-2 types of 3-10 Files, definition 3-2 Filters 7-4 example 7-78 selecting critical TR3271 events selecting TR3271 events 7-78 GETVERSION command 7-79 6-48 I/O process event messages reported 7-1 I/O processes commands affecting 6-5 object names 5-14 INFO command 6-52 Initializing structured tokens 4-2 Letter Z, using in applications 3-4 LINE obje
INDEX Logical device name 3-7 Logical device number 3-7 Manager token 5-6 Maximum field version token 5-6 Maximum response token 5-6 Monitoring statistics 6-93 Multiple tokens, constructs involving 3-12 Names of objects, See Object names of values 3-10 Naming rules and guidelines 3-4 Noncritical events 7-4 Nonsensitive commands 6-6 GETVERSION 6-48 INFO 6-52 LISTOBJECTS 6-65 STATISTICS 6-93 STATUS 6-102 NULL format of object name 3-5 getting release version 6-48 NULL object commands affecting 6-5 object t
INDEX PROC object See I/O processes Process format of object name 3-6 switching 6-119 Processes that report events 7-1 Programming considerations 4-1 Programming for event management 7-4 Receiving the response buffer 4-3 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 Response records duplicate occurrences of tokens 4-3 empty 4-4 multiple 4-3 number of in one reply message 4-3 number of objects described
INDEX Sensitive commands (continued) RESETSTATS 6-79 START 6-88 STOP 6-113 SWITCH 6-119 Server banner token 5-7 Server version token 5-7 Simple tokens 3-8 SPI messages, elements 3-1 SPI programming considerations 4-1 SPI standard definitions 5-1 SSNULL procedure 4-2 START command 6-88 STATISTICS command 6-93 STATUS command 6-102 STOP command 6-113 Structured tokens See Extensible structured tokens SU object See Subdevices Subchannel-type addressing 7-6 SUBDEVICE object See Subdevices Subdevices aborting 6-
INDEX Tokens 3-2, 3-8 constructs involving multiple 3-12 duplicate occurrences 4-2, 4-3 extensible structured 3-9 in one response record 6-7 order in event messages 7-6 order of in commands 6-7 order of in responses 6-7 predefined value names 3-10 simple 3-8 Tandem internal 7-6 token codes 3-8 token maps 3-9 token types 3-9 unconditional 7-6 volatile 7-6 TR3271 definitions 5-18 buffer declarations 5-18 extensible structured tokens 5-20 field values 5-19 token values 5-19 tokens in error lists 5-21 tokens i
INDEX Z, using in applications 3-4 ZCOM-CMDABORT 6-9 ADD 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-EVTCPU-SWITCH 7-67 PATH-SWITCH 7-70 SUMSTATE-CHG 7-74 ZCOM-MAPREQID 5-13 TRACE-MODIF 5-13 ZCOM-OBJLINE 5-14 NULL 5-14 PROC 5-14 SU 5-14 ZCOM-TKNOBJNAME 5-14 OBJTYPE 5-14 SEL-SUMSTATE 5-15 SUB 5-15 SWITCH-CPU 5-15 SWITCH-PATH 5-15 TARGET
INDEX ZEMS-MAPEXIOADDR 5-10, 7-6 ZEMS-TKN EMPHASIS 5-10 ZEMS-TKNCONSOLE-PRINT 5-10 CPU 5-10 CRTPID 5-10 CU 5-10, 7-6 EMPHASIS 7-4 EVENTNUMBER 5-10 GENTIME 5-10 LDEV 5-10 LDEVNAME 5-10 LOGTIME 5-10 PIN 5-11 SUBJECT-MARK 7-6 SYSTEM 5-11 USERID 5-11 ZSPI-ERROK 4-4 ZSPI-SSNZTR3 5-3 ZSPI-TKNALLOW-TYPE 4-2, 5-4 CHECKSUM 5-4 COMMAND 5-4 COMMENT 5-5 CONTEXT 5-5 DATALIST 5-5, 6-7 ENDLIST 5-5, 6-7 ERRLIST 5-5, 6-7 HDRTYPE 5-6 MANAGER 5-6 MAX-FIELD-VERSION 5-6 MAXRESP 4-3, 5-6 OBJECT-TYPE 5-6 RESPONSE-TYPE 4-3, 5-7 R
INDEX ZTR3-DDLMSG-BUFFER 5-18 MSG-MAXBUF 5-19 ZTR3-ERRALRDY-USING-ADDR A-8 ATTR-CONFL-SU A-5 CLIP-PROB A-3 CONN-EXIST A-13 NO-OBJ-SEL-STATE A-9 NO-OWNER A-12 NOT-PTP-SU A-7 OPENED-SU-EXIST A-10 SU-OPENED A-14 TARGET-OBJ-NOT-FOUND A-4 TARGET-OBJNAME-INV A-11 ZTR3-EVTCIU-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 7-33 INTL-ERR 7-26 IOBUS-ERR 7-8 OBJ-STARTED 7-17 OBJ-STOPPED 7-
INDEX ZTR3-VALEVT-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 5-8
