Networking and Data Communications Library AM3270 Management Programming Manual Abstract Part Number This manual describes the control-and-inquiry interface and the event messages available to an application program controlling and monitoring the AM3270 subsystem. This manual is for programmers.
Document History Edition Part Number Product Version Operating System Version Date First Edition 11168 AM3270 C20 GUARDIAN 90 C20 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 AM3270 .................................. 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 AM3270 Subsystem .............. 5-17 AM3270 Buffer Declarations ............................. 5-17 AM3270 Predefined Token and Field Values ............... 5-18 AM3270 Simple Tokens ...................................
CONTENTS 158: ZAM3-EVT-CSS-UNEXP-BRKPT .......................... 160: ZAM3-EVT-CSS-LIU-CONFIG-ERR ....................... 164: ZAM3-EVT-CSS-LINE-ERR ............................. 165: ZAM3-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. AM3270 Subsystem Architecture ......................... 1-5 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 AM3270 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, AM3270 provides application programs with the ability to communicate with IBM 3270-family devices. This manual provides subsystem-specific information for application programmers using the management-programming interfaces to manage the AM3270 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 AM3270 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 AM3270 subsystem in the 6100 CSS environment. Some of the concepts discussed are the types of objects controlled by the AM3270 subsystem and the available monitoring and control functions.
INTRODUCTION Required Management Functions Utility Program (COUP) commands available through the Dynamic System Configuration (DSC) facility. Refer to the Dynamic System Configuration Manual for details. Note that a LINE is considered to be added or deleted because there is a oneto-one correspondence between a process and a line in the AM3270 subsystem. In fact, you are adding or deleting a process.
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 AM3270 subsystem is closely related to the TR3271 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 AM3270 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 AM3270 subsystem and the various interfaces to the subsystem.
INTRODUCTION Subsystem Architecture You can manage the AM3270 subsystem through both interactive and programmatic interfaces. The interactive interfaces for managing the AM3270 subsystem are the following: • The Subsystem Control Facility (SCF), which can be used to monitor, configure, and control the AM3270 subsystem. SCF provides an operator interface to the Subsystem Control Point (SCP) which provides an interface to the AM3270 subsystem.
SECTION 2 MANAGEMENT PROGRAMMING FOR AM3270 You can manage the AM3270 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 AM3270 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 AM3270 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 AM3270 subsystem.
MANAGEMENT PROGRAMMING FOR AM3270 Commands COMMANDS Table 2-1 lists and briefly describes the commands that a management application can send to the AM3270 subsystem using the control-and-inquiry interface. For detailed descriptions of these commands as they relate to the AM3270 subsystem, refer to Section 6, "Commands and Responses.
MANAGEMENT PROGRAMMING FOR AM3270 Commands Table 2-1. COMMAND AM3270 Programmatic Commands (Page 2 of 2) DESCRIPTION LISTOBJECTS Returns the names of a line and subdevices known to the AM3270 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 AM3270 Commands Table 2-2.
MANAGEMENT PROGRAMMING FOR AM3270 Commands Table 2-2.
MANAGEMENT PROGRAMMING FOR AM3270 Commands Table 2-3 shows the correspondence between the Communications Management Interface (CMI) commands a human operator issues to control and monitor the AM3270 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 AM3270 Commands Table 2-3.
MANAGEMENT PROGRAMMING FOR AM3270 Event Messages Table 2-3.
MANAGEMENT PROGRAMMING FOR AM3270 Communicating With the AM3270 Subsystem 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. Figure 2-1 illustrates the flow of data between the AM3270 subsystem and a management application in the EMS environment. For AM3270-specific event management information, refer to Section 7, "Event Management.
MANAGEMENT PROGRAMMING FOR AM3270 Communicating With the AM3270 Subsystem Regardless of the language you are using, the tasks an application must perform when communicating with either SCP or the EMS distributor process (DP) are as follows: 1. Establish communication with SCP or the EMS DP. 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. Decode the response. 7.
SECTION 3 ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEMS The Subsystem Programmatic Interface (SPI) procedures facilitate the communication between a management application and the AM3270 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 SUBSYSTEMS 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 AM3270 subsystem.
ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEMS Definition Files A management application that communicates with the AM3270 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 SUBSYSTEMS 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 SUBSYSTEMS 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 AM3270 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 SUBSYSTEMS 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 AM3270 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 SUBSYSTEMS Event Numbers Event Numbers Event numbers identify event messages issued by the AM3270 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 AM3270 subsystem has a different event number assigned to it. The AM3270 event numbers and their associated event messages are described in Section 7, "Event Management.
ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEMS Tokens Tokens The AM3270 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 SUBSYSTEMS 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 SUBSYSTEMS Tokens ZSPI-TYP-FNAME ZSPI-TYP-FNAME32 ZSPI-TYP-TIMESTAMP ZSPI-TYP-TOKENCODE ZSPI-TYP-UINT The AM3270 subsystem does not define any private token types; that is, no token types have names of the form ZAM3-TYP-name. Predefined Value Names The predefined values used by the AM3270 subsystem are represented by symbolic names Zsubsys-VAL-name, where subsys is a three-character subsystem abbreviation and name identifies the predefined value.
ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEMS Constructs Involving Multiple Tokens Constructs Involving Multiple Tokens The AM3270 subsystem supports two kinds of constructs that involve multiple tokens: data lists and error lists. For the AM3270 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 AM3270 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 AM3270 subsystem. This section discusses SPI programming considerations that are specific to the AM3270 subsystem.
SPI PROGRAMMING CONSIDERATIONS FOR AM3270 Discontinuing a Command in Progress than its null value. For example, in the ALTER command, if a field of the extensible structured token that describes the line attributes contains a value other than its null value, that value is assigned to the attribute corresponding to that field.
SPI PROGRAMMING CONSIDERATIONS FOR AM3270 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 AM3270 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 AM3270 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 AM3270 Command Protocol COMMAND PROTOCOL Table 4-1 shows the state transitions of objects as a result of some of the AM3270 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, AM3270 subsystem use definitions definitions, EMS standard standard definitions, and AM3270 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 AM3270 subsystem.
COMMON DEFINITIONS SPI Standard Definitions The SPI definitions applicable to the AM3270 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 AM3270 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 AM3270 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 AM3270 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 AM3270 is ZAM3-VAL-SSID. ZAM3-VAL-SSID has the following structure definition: def ZAM3-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 AM3270 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 address support supersedes the subchannel-type I/O address 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 console. The value of this token for the AM3270 subsystem is always ZSPI-VAL-TRUE.
COMMON DEFINITIONS Data-Communications Standard Definitions 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 AM3270 subsystem process. DATA-COMMUNICATIONS STANDARD DEFINITIONS Definitions whose names begin with ZCOM- are data-communications standard definitions. These definitions are available to all data-communications subsystems, such as AM3270, and are found in the ZSPIDEF.ZCOMDDL definition file.
COMMON DEFINITIONS Data-Communications Standard Definitions Table 5-3.
COMMON DEFINITIONS Data-Communications Standard Definitions ZCOM-MAP-REQID provides security checking in addition 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 AM3270 I/O process running on a Tandem NonStop system. ZCOM-OBJ-SU specifies the subdevice (SU) object type for the AM3270 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 AM3270 command that supports the select-state modifier.
COMMON DEFINITIONS Data-Communications Standard Definitions 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). ZCOM-VAL-PATH-A is a value that represents Communications Interface Unit (CIU) path A.
COMMON DEFINITIONS AM3270 Buffer Declarations COMMON DEFINITIONS FOR THE AM3270 SUBSYSTEM Definitions whose names begin with ZAM3- are AM3270 definitions. The definitions that appear in several commands or responses are described in this section. Information that is specific to particular commands or responses is discussed in Section 6, "Commands and Responses." Definitions are listed in alphabetical order within each category.
COMMON DEFINITIONS AM3270 Predefined Token and Field Values AM3270 Predefined Token and Field Values The AM3270 subsystem defines the following token and field values. ZAM3-VAL-EVT-BUFLEN is the buffer size in bytes for event messages issued by the AM3270 subsystem. ZAM3-VAL-SSID is the subsystem ID for the AM3270 subsystem. Its structure definition is given earlier in this section, under "SPI Standard Definitions.
COMMON DEFINITIONS AM3270 Tokens in Event Messages AM3270 Tokens in Error Lists The AM3270 subsystem defines several error numbers. See Appendix A for detailed descriptions.
SECTION 6 COMMANDS AND RESPONSES This section describes each of the commands and responses in the programmatic command interface to the AM3270 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 AM3270 subsystem Table 6-1 lists the commands that are available in the programmatic control-and-inquiry interface to the AM3270 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 AM3270 subsystem recognizes four object types in commands.
COMMANDS AND RESPONSES Commands by Object Type The AM3270 subsystem accepts the PROC object type only in the following commands: GETVERSION SWITCH The AM3270 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 AM3270 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 an AM3270 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-SSID is an echo of the subsystem ID value provided by your application. This token is described in "SPI Standard Definitions" in Section 5, "Common Definitions," and the Distributed Systems Management (DSM) Programming Manual. ZSPI-TKN-SERVER-VERSION indicates the software release version of the AM3270 subsystem.
COMMANDS AND RESPONSES ABORT Command The possible nonzero values of RETCODE in response to the ABORT command are as follows: ZCOM-ERR-EMPT-RSP (-33) ZCOM-ERR-TKN-REQ (-29) ZCOM-ERR-TKN-DUP (-27) ZCOM-ERR-TKN-CODE-INV (-26) ZCOM-ERR-SUB-NOT-FOUND (-25) ZCOM-ERR-SSID-INV (-24) ZCOM-ERR-SECUR-VIOL (-22) ZCOM-ERR-OBJNAME-INV (-19) ZCOM-ERR-OBJ-NOT-SUPP (-18) ZCOM-ERR-OBJ-NOT-FOUND (-17) ZCOM-ERR-OBJ-ALRDY-IN-SUMSTATE (-16) ZCOM-ERR-FNAME-INV (-9) ZCOM-ERR-CMD-TIMED-OUT (-7) ZCOM-ERR-CMD-MISMATCH (-4) ZCOM-ERR-
COMMANDS AND RESPONSES ABORT Command • To initiate the operation of lines and subdevices, use the START command. • Use the STATUS command to determine the summary states of the objects.
COMMANDS AND RESPONSES ADD Command ADD Command The ADD command adds a subdevice to the AM3270 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 summary state when you attempt to add a subdevice. If the line is not in the STARTED summary state, the AM3270 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 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: ZAM3-VAL-PROTO-CRT The CRT protocol will be used. ZAM3-VAL-PROTO-PTR The printer (PTR) protocol will be used. ZAM3-VAL-PROTO-PTP The pass-through protocol (PTP) will be used ZAM3-VAL-PROTO-ITI The Interactive Terminal Interface (ITI) protocol will be used. ZAM3-VAL-PROTO-QUO The QUOTRON (QUO) protocol will be used.
COMMANDS AND RESPONSES ADD Command ZREPOLL-INTVL specifies the time interval, in units of .01 seconds, that the AM3270 subsystem repolls the control unit when the control unit times out on poll. This is an optional field. The valid range is 0 through 32767. The default value is zero. 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.
COMMANDS AND RESPONSES ADD 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 ADD 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 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. For details on the AM3270 error numbers and associated error lists, see Appendix A in this manual.
COMMANDS AND RESPONSES ADD Command ZAM3-ERR-ADDR-ALRDY-USED (6) Your management application attempted to add a subdevice at an address already in use by another object. Reissue the command using a value for the ZADDR field that has not been previously assigned. 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. Operational Notes • ADD is a sensitive command.
COMMANDS AND RESPONSES ALTER Command ALTER Command The ALTER command changes attribute values associated with the specified object. You can change attributes for a line and a subdevice, but not a process. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZAM3-MAP-ALTER-LINE !{A} !OBJ-LINE def ZAM3-DDL-ALTER-LINE. !Specify one or more fields. 02 ZAUTOLOAD type ZSPI-DDL-BOOLEAN. 02 ZBCCTYPE type ZSPI-DDL-ENUM. 02 ZCHARSET type ZSPI-DDL-ENUM.
COMMANDS AND RESPONSES ALTER Command ZAM3-MAP-ALTER-SU !{A} !OBJ-SU def ZAM3-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 ZREPOLL-INTVL type ZSPI-DDL-TIMESTAMP. 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 ZAM3-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 ZAM3-TNM-ALTER-LINE and the DDL definition ZAM3-DDL-ALTER-LINE. This token must be in the command when the specified object type 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 ZCONSL-MSG A Boolean variable that specifies whether the slowpoll message is printed on the console. If the value is ZSPI-VAL-TRUE, the message is printed on the console. If the value is ZSPIVAL-FALSE, the message is not printed on the console. The default value is ZSPI-VAL-TRUE. ZCTL-RTS A Boolean variable that specifies whether the Carrier Detect (CD) signal is dropped before the Request To Send (RTS) signal is raised.
COMMANDS AND RESPONSES ALTER Command ZNO-GP-AFTER-WACK A Boolean variable that specifies whether the AM3270 subsystem does general polling after receiving a wait for acknowledgement (WACK) in response to a SELECT. If the value is ZSPIVAL-TRUE, the subsystem does not do a general poll after receiving a WACK. If the value is ZSPI-VAL-FALSE, the subsystem does a general poll. The default value is ZSPI-VAL-FALSE. This field is ignored for printers.
COMMANDS AND RESPONSES ALTER Command ZTHRES An integer that specifies the statistics threshold value. This value defines the number of frames to be transmitted and received before line quality is checked. The value must be in the range 0 through 15. If the value is 0, the threshold is ignored. The default value is 0. ZTIMEOUT The line I/O timeout value, in units of .01 second. This value defines how long the I/O process waits before retrying when a data link error occurs.
COMMANDS AND RESPONSES ALTER Command Each attribute is defined in a separate field. At least one field must be specified. The fields are as follows: ZADDR A pair of integers that specifies the address to be assigned to the subdevice. The first integer is the address of the control unit. The second integer is the address of the subdevice. Both integers should be in the range 0 through 31. ZPROTO An enumerated value that specifies the protocol to be used by the subdevice. There is no default value.
COMMANDS AND RESPONSES ALTER Command ZREPOLL-INTVL A timestamp that specifies the time interval the AM3270 subsystem repolls the control unit when the control unit times out on poll. The default is value is 0. The valid range is 0 through 32767. ZTYPE A pair of integers that specifies the device type and subtype of the subdevice to be altered. 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.
COMMANDS AND RESPONSES ALTER 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 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 ZAM3-ERR-ADDR-ALRDY-USED (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. 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 CONNECT Command CONNECT Command The CONNECT command creates a link between an AM3270 subdevice and a TR3271 subdevice. Only subdevices can be connected. Once this command is successfully completed, data can pass between AM3270 terminals and an IBM host through the TR3271 subsystem. When you use the CONNECT command, the subsystem checks that both the AM3270 subdevice and the target TR3271 subdevice are in the STARTED summary state.
COMMANDS AND RESPONSES CONNECT Command ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT token-type ZSPI-TYP-ENUM. token-type ZSPI-TYP-ENUM. token-type ZSPI-TYP-STRING. 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-UINT. ZSPI-TYP-LIST. ZSPI-TYP-STRING.
COMMANDS AND RESPONSES CONNECT 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 CONNECT 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 CONNECT Command ZCOM-ERR-CMD-INV-IN-SUMSTATE (-3) Your management application tried to connect a subdevice while the target TR3271 subdevice or the AM3270 subdevice was not in the STARTED summary state. Or, the line associated with one of the subdevices is in the DIAG (diagnosing) or STOPPED summary state. ZAM3-ERR-TARGET-OBJ-NOT-FOUND (3) Your management application tried to build a link to a TR3271 subdevice that does not exist.
COMMANDS AND RESPONSES DELETE Command DELETE Command The DELETE command removes subdevices from the AM3270 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-SSID ZSPI-TKN-SERVER-VERSION 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 ZCOM-TKN-OBJTYPE specifies the type of object whose name appears in ZCOM-TKN-OBJNAME. This token can have the following values: ZCOM-OBJ-LINE The object is a line. ZCOM-OBJ-SU The object is a subdevice. 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.
COMMANDS AND RESPONSES DELETE Command ZCOM-ERR-OBJ-NOT-SUPP (-18) Your management application tried to delete not supported by the AM3270 subsystem. The by the AM3270 subsystem are PROC, LINE, and DELETE command, you must specify the object or ZCOM-OBJ-SU. an object that is objects supported SU. For the type ZCOM-OBJ-LINE ZCOM-ERR-CMD-MISMATCH (-4) Your management application tried to delete a process by using the object type ZCOM-OBJ-PROC.
COMMANDS AND RESPONSES DISCONNECT Command DISCONNECT Command The DISCONNECT command deletes a link between an AM3270 subdevice and a TR3271 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-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-UINT. ZSPI-TYP-LIST. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-LIST. token-type ZSPI-TYP-SSCTL.
COMMANDS AND RESPONSES DISCONNECT Command (ZSPI-TKN-) MANAGER, SSID, MAXRESP, 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 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 ZAM3-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. ZAM3-ERR-TARGET-OBJNAME-INV (10) The object name for the target TR3271 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 AM3270 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, AM3270- T9371C20 - 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-UINT. 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. This token is described in "SPI Standard Definitions" in Section 5, "Common Definitions," and the Distributed Systems Management (DSM) Programming Manual. ZSPI-TKN-SERVER-VERSION indicates the software release version of the AM3270 subsystem.
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 AM3270 subsystem to return the values of the configurable attributes of the specified objects. These values are returned in the ZAM3-MAP-INFO-LINE and ZAM3-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.
COMMANDS AND RESPONSES INFO Command 02 02 02 02 02 02 02 02 02 02 02 02 02 ZDROP-RTS ZEOT-IF-NO-READ ZNO-GP-AFTER-WACK ZPACE ZPOLL-TYPE ZPROG ZRETRY ZSYNCS ZTEST-INTVL ZTHRES ZTIMEOUT ZXLATE ZXLATE-IN 02 ZXLATE-OUT type ZSPI-DDL-BOOLEAN. type ZSPI-DDL-BOOLEAN. type ZSPI-DDL-BOOLEAN. type ZSPI-DDL-INT. type ZSPI-DDL-ENUM. type ZSPI-DDL-FNAME. type ZSPI-DDL-INT. type ZSPI-DDL-INT. type ZSPI-DDL-TIMESTAMP. type ZSPI-DDL-INT. type ZSPI-DDL-TIMESTAMP. type ZSPI-DDL-BOOLEAN.
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. This token is described in "SPI Standard Definitions" in Section 5, "Common Definitions," and the Distributed Systems Management (DSM) Programming Manual. ZSPI-TKN-SERVER-VERSION indicates the software release version of the AM3270 subsystem.
COMMANDS AND RESPONSES INFO Command ZCONF-WRITE A Boolean variable that specifies how a write is confirmed. If the value is ZSPI-VAL-TRUE, a job sent to a printer will be considered successful after the DEVICE END status is received. If the value is ZSPI-VAL-FALSE, a job sent to a printer will be considered successful when the text is delivered to the controller. The default value is ZSPI-VALFALSE. ZCONSL-MSG A Boolean variable that specifies whether the slowpoll message is printed on the console.
COMMANDS AND RESPONSES INFO Command ZEOT-IF-NO-READ A Boolean variable that specifies whether the AM3270 subsystem sends an end-of-text (EOT) character when it receives text from a subdevice that does not have a read outstanding. If the value is ZSPI-VAL-TRUE, the subsystem sends the EOT. If the value is ZSPI-VAL-FALSE, the subsystem sends a Reverse Interrupt (RVI) instead. Whenever a subdevice sends text without a read outstanding, the subsystem discards the text. The default value is ZSPI-VAL-FALSE.
COMMANDS AND RESPONSES INFO Command ZTEST-INTVL A timestamp that specifies the interval, in units of .01 second, at which the status probe is issued to the CLIP. The value must be in the range 0 through 32767. If the value is 0, no status probe will be issued. The default value is 300 (30 seconds). ZTHRES An integer that specifies the statistics threshold value. This value defines the number of frames to be transmitted and received before line quality is checked.
COMMANDS AND RESPONSES INFO Command ZAM3-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 ZAM3-TNM-INFO-SU and the DDL definition ZAM3-DDL-INFO-SU. This token must be in the response when the specified type object is ZCOM-OBJ-SU or the object type ZCOM-OBJ-LINE has been specified with the subordinate modifier with the value ZCOM-VAL-SUB-ALL or ZCOM-VAL-SUB-ONLY.
COMMANDS AND RESPONSES INFO Command PTP subdevice The defined screen size is as follows: Screen Size Record Size 480 960 1920 2560 3440 Printer 512 1024 2048 3072 4095 The printer line length is used as the record size. ZREPOLL-INTVL A timestamp that specifies the time interval the AM3270 subsystem repolls the control unit when the control unit times out on poll. The default is value is 0. The valid range is 0 through 32767.
COMMANDS AND RESPONSES INFO Command (10,x) The subdevice is a CRT or QUOTRON terminal. The value of x is an integer in the range 1 through 5 and is associated with the following screen sizes: ZTYPE (10,1) (10,2) (10,3) (10,4) (10,5) (60,0) Screen Size 12 24 32 43 12 x x x x x 40 80 80 80 80 The subdevice is a pass-through protocol (PTP) subdevice. ZSPI-TKN-DATALIST indicates the beginning of a data list. "SPI Standard Definitions" in Section 5 for details.
COMMANDS AND RESPONSES INFO Command The possible nonzero values of RETCODE in response to the INFO command are as follows: ZCOM-ERR-EMPT-RSP (-33) ZCOM-ERR-TKN-REQ (-29) ZCOM-ERR-TKN-DUP (-27) ZCOM-ERR-TKN-CODE-INV (-26) ZCOM-ERR-SUB-NOT-FOUND (-25) ZCOM-ERR-SSID-INV (-24) ZCOM-ERR-OBJNAME-INV (-19) ZCOM-ERR-OBJ-NOT-SUPP (-18) ZCOM-ERR-OBJ-NOT-FOUND (-17) ZCOM-ERR-NO-MEM-SPACE (-14) ZCOM-ERR-FNAME-INV (-9) ZCOM-ERR-CMD-TIMED-OUT (-7) ZCOM-ERR-TKN-VAL-INV (-30) Your management application specified the SUB
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 AM3270 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 AM3270 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 AM3270 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. "SPI Standard Definitions" in Section 5 for details. See ZCOM-TKN-OBJNAME specifies the name of the AM3270 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 or ZCOM-VAL-SUB-ALL for the SU object. The SU object accepts only the value ZCOM-VAL-SUBNONE. 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 (NULL object), ZCOMOBJ-LINE (LINE object), or ZCOM-OBJ-SU (SU object).
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-UINT. 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 Tokens in Response Buffer ZSPI-TKN-SSID is an echo of the subsystem ID value provided by your application. This token is described in "SPI Standard Definitions" in Section 5, "Common Definitions," and the Distributed Systems Management (DSM) Programming Manual. ZSPI-TKN-SERVER-VERSION indicates the software release version of the AM3270 subsystem.
COMMANDS AND RESPONSES LOAD Command The possible nonzero values of RETCODE in response to the LOAD 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-OBJ-NOT-SUPP (-18) ZCOM-ERR-OBJ-NOT-FOUND (-17) ZCOM-ERR-FNAME-INV (-9) ZCOM-ERR-CMD-TIMED-OUT (-7) ZCOM-ERR-CMD-MISMATCH (-4) ZCOM-ERR-CMD-INV-IN-SUMSTATE (-3) Your management
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-UINT. 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 AM3270 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. "SPI Standard Definitions" in Section 5 for details. See ZCOM-TKN-OBJNAME specifies the name of the AM3270 line that is to be reset.
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 (LINE object). 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 DIAG (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-UINT. token-type ZSPI-TYP-LIST. !{} !{} !... ZAM3-MAP-RSTATS-LINE !OBJ-LINE !SUB def ZAM3-DDL-RSTATS-LINE. !All fields are present. 02 ZTMSTP type ZSPI-DDL-TIMESTAMP. 02 ZTMSTP-LAST type ZSPI-DDL-TIMESTAMP. 02 ZAM3-LINE-CLB.
COMMANDS AND RESPONSES RESETSTATS Command ZSPI-TKN-ERRLIST ... ZSPI-TKN-ENDLIST ZSPI-TKN-RETCODE ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT 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. Your application must provide this token in the command.
COMMANDS AND RESPONSES RESETSTATS Command ZCOM-VAL-SUB-NONE If the object type and reset counters If the object type and reset counters is LINE, return information for the named line only. is SU, return information for the named subdevice. 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.
COMMANDS AND RESPONSES RESETSTATS Command ZTOTAL-FRAME is the number of CLB frames that were sent from and received by the AM3270 subsystem for the specified line. ZBCC-ERR is the number of BCC errors that occurred at the CLB level for the specified line. ZFRAME-ERR is the number of frame errors that occurred at the CLB level for the specified line. ZNO-BUF is the number of times the AM3270 subsystem could not allocate a buffer for a request made by the specified line.
COMMANDS AND RESPONSES RESETSTATS Command ZMSG-L1024-SENT is the number of messages, which were between 256 and 1024 bytes in length, that the AM3270 subsystem sent to the specified line. ZMSG-L1024-RECVED is the number of messages, which were between 256 and 1024 bytes in length, that the AM3270 subsystem received from the specified line. ZMSG-G1024-SENT is the number of messages, which were greater than 1024 bytes in length, that the AM3270 subsystem sent to the specified line.
COMMANDS AND RESPONSES RESETSTATS Command ZCOM-TKN-OBJTYPE specifies the type of object for which information was requested. This token can have the value ZCOM-OBJLINE (LINE object) or ZCOM-OBJ-SU (SU object). 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. "SPI Standard Definitions" in Section 5 for details.
COMMANDS AND RESPONSES RESETSTATS 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. See "SPI Standard Definitions" in Section 5 for details.
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 DIAG (diagnosing) or the STARTED summary state.
COMMANDS AND RESPONSES START Command 02 ZPAID end. 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. ZSPI-TYP-STRING.
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 AM3270 subsystem starts the line first, then the associated subdevices. If the object type is SU, the named subdevice is started.
COMMANDS AND RESPONSES START Command ZCOM-TKN-OBJNAME specifies the name of the AM3270 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 Definitons" 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 (LINE object) or ZCOM-OBJ-SU (SU object). ZCOM-ERR-CMD-INV-IN-SUMSTATE (-3) Your management application tried to start a line or a subdevice while the line was in the DIAG (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 AM3270 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-UINT. token-type ZSPI-TYP-LIST. ZAM3-MAP-STATS-LINE !OBJ-LINE !SUB !All fields are present. type ZSPI-DDL-TIMESTAMP. type ZSPI-DDL-TIMESTAMP.
COMMANDS AND RESPONSES STATISTICS 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 it to return statistical information.
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 ZNO-BUF is the number of times the AM3270 subsystem could not allocate a buffer for a request made by the specified line. ZAM3-LINE-L2 is a structure that contains information about level 2 for the specified line. ZAM3-LINE-L2 consists of the following fields: ZTOTAL-MSG is the total number of messages that were sent from and received by the AM3270 subsytem for 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 AM3270 subsystem received from the specified line. ZAM3-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 ZAM3-TNM-STATSSU and the DDL definition ZAM3-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 AM3270 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 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 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 AM3270 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. This token is described in "SPI Standard Definitions" in Section 5, "Common Definitions," and the Distributed Systems Management (DSM) Programming Manual. ZSPI-TKN-SERVER-VERSION indicates the software release version of the AM3270 subsystem.
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. ZAM3-MAP-STATUS-SU is the extensible structured token that contains status information for the subdevices that have been queried. It has the token number ZAM3-TNM-STATUS-SU and the DDL definition ZAM3-DDL-STATUS-SU.
COMMANDS AND RESPONSES STATUS Command Bit 7 indicates a two-step READ is pending. Bit 8 indicates the subdevice is waiting for a real READ. Bit 9 is for internal use only. 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.
COMMANDS AND RESPONSES STATUS Command ZCOM-TKN-OBJNAME specifies the name of the AM3270 line or subdevice for which information was requested. Unless there is an error that prevents the STATUS 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 queried.
COMMANDS AND RESPONSES STATUS Command ZCOM-ERR-CMD-MISMATCH (-4) Your management application tried to inquire about a process by using the value ZCOM-OBJ-PROC. The command is valid only for the values ZCOM-OBJ-LINE (LINE object) or ZCOM-OBJ-SU (SU object). ZAM3-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.
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 AM3270 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 "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 or ZCOM-VAL-SUB-ALL for the SU object. The SU object only accepts the value ZCOM-VAL-SUBNONE 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 (LINE object) and ZCOM-OBJ-SU (SU object).
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 AM3270 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 (PROC object) or ZCOM-OBJ-LINE (LINE object). 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-CMD-INV-IN-SUMSTATE (-3) Your management application tried to switch a process or line while the line was in the DIAG summary state. The DIAG summary state prevents processing of the SWITCH command for the process or line object. 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.
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 AM3270 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 AM3270 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-UINT. 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 ZAM3-VAL-TRACE-OPT-CLBI Trace CLB inbound frames. ZAM3-VAL-TRACE-OPT-CLBO Trace CLB outbound frames. ZAM3-VAL-TRACE-OPT-CLIP Enables CLIP tracing. This bit must be set on, if one or more bits in the 16 through 29 range are to be set. ZAM3-VAL-TRACE-OPT-CLIPDI Trace CLIP inbound frames. ZAM3-VAL-TRACE-OPT-CLIPDO Trace CLIP outbound frames. ZAM3-VAL-TRACE-OPT-CLIPL2 Trace CLIP level-2 events. ZAM3-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 AM3270 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 AM3270 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 EVENT MANAGEMENT The AM3270 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.
EVENT MANAGEMENT Subsystem Processes That Report Events Table 7-1.
EVENT MANAGEMENT Critical Events CRITICAL EVENTS Events reported by the AM3270 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.
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.
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.
EVENT MANAGEMENT 3: ZAM3-EVT-IOBUS-ERR 3: ZAM3-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.
EVENT MANAGEMENT 3: ZAM3-EVT-IOBUS-ERR Unconditional Tokens ZSPI-TKN-SSID is the AM3270 subsystem ID, and its value is ZAM3-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 ZAM3-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 AM3270 line that is the subject of this event message.
EVENT MANAGEMENT 3: ZAM3-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 ZAM3-TKN-FILE-ERR.
EVENT MANAGEMENT 3: ZAM3-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.
EVENT MANAGEMENT 4: ZAM3-EVT-CIU-ERR 4: ZAM3-EVT-CIU-ERR An error occurred on the indicated AM3270 line and the I/O retry did not succeed. Another path or CPU is tried. If a path or CPU is not available, the line goes down. This event is critical, and the event message is reported to the EMS collector ($0). This event message is equivalent to console message 04.
EVENT MANAGEMENT 4: ZAM3-EVT-CIU-ERR Unconditional Tokens ZSPI-TKN-SSID is the AM3270 subsystem ID, and its value is ZAM3-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 ZAM3-EVT- ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
EVENT MANAGEMENT 4: ZAM3-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 ZAM3-TKN-CIU-STATUS.
EVENT MANAGEMENT 4: ZAM3-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 .
EVENT MANAGEMENT 4: ZAM3-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.
EVENT MANAGEMENT 6: ZAM3-EVT-OBJ-STARTED 6: ZAM3-EVT-OBJ-STARTED The AM3270 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.
EVENT MANAGEMENT 6: ZAM3-EVT-OBJ-STARTED ZEMS-TKN-LDEVNAME is the name of the AM3270 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the AM3270 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 critical. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. ZEMS-TKN-CPU is the CPU of the AM3270 subsystem.
EVENT MANAGEMENT 6: ZAM3-EVT-OBJ-STARTED Probable Cause The AM3270 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 AM3270, 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.
EVENT MANAGEMENT 7: ZAM3-EVT-OBJ-STOPPED 7: ZAM3-EVT-OBJ-STOPPED The indicated AM3270 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.
EVENT MANAGEMENT 7: ZAM3-EVT-OBJ-STOPPED Unconditional Tokens ZSPI-TKN-SSID is the AM3270 subsystem ID, and its value is ZAM3-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 ZAM3-EVT- ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
EVENT MANAGEMENT 7: ZAM3-EVT-OBJ-STOPPED 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.
EVENT MANAGEMENT 67: ZAM3-EVT-SUBDEV-ERR 67: ZAM3-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.
EVENT MANAGEMENT 67: ZAM3-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 AM3270 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the AM3270 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-TRUE, indicating that this event is critical.
EVENT MANAGEMENT 67: ZAM3-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 ZAM3-TKN-SU, and file-err corresponds to the value of ZAM3-TKN-FILE-ERR. Probable Cause An operation or a request to the indicated AM3270 subdevice is incorrect.
EVENT MANAGEMENT 74: ZAM3-EVT-INTL-ERR 74: ZAM3-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.
EVENT MANAGEMENT 74: ZAM3-EVT-INTL-ERR Unconditional Tokens ZSPI-TKN-SSID is the AM3270 subsystem ID, and its value is ZAM3-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 ZAM3-EVT- ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
EVENT MANAGEMENT 74: ZAM3-EVT-INTL-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 the remaining values are internal tokens.
EVENT MANAGEMENT 90: ZAM3-EVT-PROC-ABEND 90: ZAM3-EVT-PROC-ABEND The AM3270 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).
EVENT MANAGEMENT 90: ZAM3-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 AM3270 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the AM3270 line that is the subject of this event message. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is critical. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE.
EVENT MANAGEMENT 90: ZAM3-EVT-PROC-ABEND Probable Cause The necessary system resources could not be allocated to the AM3270 I/O process or a COUP parameter is incorrect or inconsistent. The I/O process stops and cannot be used. The AM3270 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.
EVENT MANAGEMENT 90: ZAM3-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.
EVENT MANAGEMENT 106: ZAM3-EVT-INSUFF-BUF 106: ZAM3-EVT-INSUFF-BUF The dedicated buffer space for the AM3270 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.
EVENT MANAGEMENT 106: ZAM3-EVT-INSUFF-BUF ZEMS-TKN-LDEVNAME is the name of the AM3270 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the AM3270 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-TRUE, indicating that this event is critical. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. ZEMS-TKN-CPU is the CPU of the AM3270 subsystem.
EVENT MANAGEMENT 106: ZAM3-EVT-INSUFF-BUF 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. The MAXLOCALAREA specifies the largest buffer obtainable from the local pool. The default is 2048 words.
EVENT MANAGEMENT 111: ZAM3-EVT-REPOLL-STATE 111: ZAM3-EVT-REPOLL-STATE A SLOWPOLL state changed for the indicated subdevice. This is not a critical event, and the event message is reported to the EMS collector ($0). This event message is equivalent to console message 111.
EVENT MANAGEMENT 111: ZAM3-EVT-REPOLL-STATE ZEMS-TKN-LDEVNAME is the name of the AM3270 line that is the subject of this event message. ZEMS-TKN-LDEV is the logical device number of the AM3270 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 critical. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. ZEMS-TKN-CPU is the CPU of the AM3270 subsystem.
EVENT MANAGEMENT 111: ZAM3-EVT-REPOLL-STATE Probable Cause A subdevice that has a non-zero SLOWPOLL interval defined has either been placed on the repoll list or removed from the repoll list because it is not responding to polls. The repoll interval can be defined using the ALTER or ADD command, see Section 6, "Commands and Responses," for a description of the ZREPOLL-INTVL field. The value of the SLOWPOLL state determines whether the device has been placed onto or removed from the repoll list.
EVENT MANAGEMENT 141: ZAM3-EVT-CLIP-DWLOAD 141: ZAM3-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.
EVENT MANAGEMENT 141: ZAM3-EVT-CLIP-DWLOAD Unconditional Tokens ZSPI-TKN-SSID is the AM3270 subsystem ID, and its value is ZAM3-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 ZAM3-EVT- ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
EVENT MANAGEMENT 141: ZAM3-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.
EVENT MANAGEMENT 147: ZAM3-EVT-CSS-PROBE-ERR 147: ZAM3-EVT-CSS-PROBE-ERR The AM3270 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).
EVENT MANAGEMENT 147: ZAM3-EVT-CSS-PROBE-ERR Unconditional Tokens ZSPI-TKN-SSID is the AM3270 subsystem ID, and its value is ZAM3-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 ZAM3-EVTCSS-PROBE-ERR (147). ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
EVENT MANAGEMENT 147: ZAM3-EVT-CSS-PROBE-ERR ZAM3-TKN-PROBE-ERR is the type of probe error. It corresponds to the value probe-err in the message text. See below for information on the possible values. 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.
EVENT MANAGEMENT 147: ZAM3-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.
EVENT MANAGEMENT 157: ZAM3-EVT-CSS-FRAME-ERR 157: ZAM3-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.
EVENT MANAGEMENT 157: ZAM3-EVT-CSS-FRAME-ERR Unconditional Tokens ZSPI-TKN-SSID is the AM3270 subsystem ID, and its value is ZAM3-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 ZAM3-EVTCSS-FRAME-ERR (157). ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
EVENT MANAGEMENT 157: ZAM3-EVT-CSS-FRAME-ERR ZAM3-TKN-ADDR-CTL is the A and C fields. value param1 in the message text. It corresponds to the ZAM3-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.
EVENT MANAGEMENT 157: ZAM3-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 contains th
EVENT MANAGEMENT 158: ZAM3-EVT-CSS-UNEXP-BRKPT 158: ZAM3-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.
EVENT MANAGEMENT 158: ZAM3-EVT-CSS-UNEXP-BRKPT Unconditional Tokens ZSPI-TKN-SSID is the AM3270 subsystem ID, and its value is ZAM3-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 ZAM3-EVTCSS-UNEXP-BRKPT (158). ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
EVENT MANAGEMENT 158: ZAM3-EVT-CSS-UNEXP-BRKPT Volatile Tokens ZEMS-TKN-CU is a standard EMS token that contains the controller and unit number. This token is present in the event buffer only if the controller uses subchannel-type I/O addressing.
EVENT MANAGEMENT 160: ZAM3-EVT-CSS-LIU-CONFIG-ERR 160: ZAM3-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.
EVENT MANAGEMENT 160: ZAM3-EVT-CSS-LIU-CONFIG-ERR Unconditional Tokens ZSPI-TKN-SSID is the AM3270 subsystem ID, and its value is ZAM3-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 ZAM3-EVTCSS-LIU-CONFIG-ERR (160). ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
EVENT MANAGEMENT 160: ZAM3-EVT-CSS-LIU-CONFIG-ERR ZAM3-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.
EVENT MANAGEMENT 164: ZAM3-EVT-CSS-LINE-ERR 164: ZAM3-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 AM3270 I/O This event is to the EMS collector This event message is equivalent to console message 164.
EVENT MANAGEMENT 164: ZAM3-EVT-CSS-LINE-ERR Unconditional Tokens ZSPI-TKN-SSID is the AM3270 subsystem ID, and its value is ZAM3-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 ZAM3-EVTCSS-LINE-ERR (164). ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
EVENT MANAGEMENT 164: ZAM3-EVT-CSS-LINE-ERR ZAM3-TKN-CLIP-SU is the CLIP subdevice number. the value param3 in the message text. It corresponds to ZAM3-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.
EVENT MANAGEMENT 164: ZAM3-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.
EVENT MANAGEMENT 165: ZAM3-EVT-CSS-SUBDEV-ERR 165: ZAM3-EVT-CSS-SUBDEV-ERR The Communications Line Interface Processor (CLIP) of the 6100 Communications Subsystem (CSS) responded to the AM3270 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.
EVENT MANAGEMENT 165: ZAM3-EVT-CSS-SUBDEV-ERR Unconditional Tokens ZSPI-TKN-SSID is the AM3270 subsystem ID, and its value is ZAM3-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 ZAM3-EVTCSS-SUBDEV-ERR (165). ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
EVENT MANAGEMENT 165: ZAM3-EVT-CSS-SUBDEV-ERR ZAM3-TKN-CLIP-SU is the CLIP subdevice number. the value param1 in the message text. It corresponds to ZAM3-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.
EVENT MANAGEMENT 165: ZAM3-EVT-CSS-SUBDEV-ERR 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 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 parameters in the me
EVENT MANAGEMENT -1: ZCOM-EVT-CPU-SWITCH -1: ZCOM-EVT-CPU-SWITCH The AM3270 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).
EVENT MANAGEMENT -1: ZCOM-EVT-CPU-SWITCH Unconditional Tokens ZSPI-TKN-SSID is the AM3270 subsystem ID, and its value is ZAM3-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.
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.
EVENT MANAGEMENT -2: ZCOM-EVT-PATH-SWITCH -2: ZCOM-EVT-PATH-SWITCH The AM3270 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).
EVENT MANAGEMENT -2: ZCOM-EVT-PATH-SWITCH Unconditional Tokens ZSPI-TKN-SSID is the AM3270 subsystem ID, and its value is ZAM3-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.
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.
EVENT MANAGEMENT -2: ZCOM-EVT-PATH-SWITCH Probable Cause The AM3270 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.
EVENT MANAGEMENT -3: ZCOM-EVT-SUMSTATE-CHG -3: ZCOM-EVT-SUMSTATE-CHG The state of an AM3270 object has changed. This event is not critical, and the event message is reported to the EMS collector ($0).
EVENT MANAGEMENT -3: ZCOM-EVT-SUMSTATE-CHG Unconditional Tokens ZSPI-TKN-SSID is the AM3270 subsystem ID, and its value is ZAM3-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.
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.
EVENT MANAGEMENT Examples of Filters EXAMPLES OF FILTERS The following two examples illustrate simple filters that could be created to select AM3270 event messages. For both examples, the following assumptions have been made: 1. All AM3270 definitions used in the filters have been loaded into TACL before compilation. 2. All subsystem IDs that are not initialized in the filter have been initialized by other means. For more information on filters, refer to the Event Management Service (EMS) Manual.
EVENT MANAGEMENT Example 2 Example 2 The following filter selects all the critical AM3270 event messages that have a particular line as their subject. -- Filter that selects only critical AM3270 event messages -- that have as their subject token a particular line name. [#SET zam3^val^ssid [zspi^val^tandem].[zspi^ssn^zam3].
APPENDIX A ERROR NUMBERS AND ERROR LISTS This appendix describes the error numbers and associated error lists that are provided by the AM3270 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 AM3270-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: ZAM3-ERR-CLIP-PROB 2: ZAM3-ERR-CLIP-PROB The command failed because of an internal CLIP problem. When this error occurs, the AM3270 subsystem sends event message 164 or 165 to the EMS collector, $0.
ERROR NUMBERS AND ERROR LISTS 3: ZAM3-ERR-TARGET-OBJ-NOT-FOUND 3: ZAM3-ERR-TARGET-OBJ-NOT-FOUND The CONNECT or DISCONNECT command has been issued, but the specified target TR3271 subdevice does not exist.
ERROR NUMBERS AND ERROR LISTS 5: ZAM3-ERR-NOT-PTP-SU 5: ZAM3-ERR-NOT-PTP-SU The CONNECT command has been issued, but the AM3270 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: ZAM3-ERR-ADDR-ALRDY-USED 6: ZAM3-ERR-ADDR-ALRDY-USED The ADD or ALTER command has been issued and the ZADDR field contains an address already being used by another subdevice.
ERROR NUMBERS AND ERROR LISTS ZAM3-ERR-NO-OBJ-IN-SEL-STATE 7: 7: ZAM3-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: ZAM3-ERR-OPENED-SU-EXIST 8: ZAM3-ERR-OPENED-SU-EXIST The STOP command has been issued for the LINE object type, an application has one or more subordinate subdevices opened. This error does not apply when the subordinate modifier has been specified in the command.
ERROR NUMBERS AND ERROR LISTS ZAM3-ERR-TARGET-OBJNAME-INV 10: 10: ZAM3-ERR-TARGET-OBJNAME-INV The CONNECT or DISCONNECT command has been issued, but an invalid name was specified for the target TR3271 subdevice.
ERROR NUMBERS AND ERROR LISTS 11: ZAM3-ERR-NO-OWNER 11: ZAM3-ERR-NO-OWNER A file-system request was sent to the the AM3270 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: ZAM3-ERR-CONN-EXIST 12: ZAM3-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: ZAM3-ERR-SU-OPENED 13: ZAM3-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, ITI, and QUO subdevices.
APPENDIX B AM3270 SUBSYSTEM DDL This appendix contains a listing of the AM3270 subsystem-specific DDL. You are provided with this DDL and other DDL files in the AM3270 software package. !----------------------------------------------------------! file name: zam3ddl -- source DDL file for AM3270 !----------------------------------------------------------?SECTION constants ?SETSECTION constants ! AM3270 version definition, value change with each release. ! CONSTANT ZAM3-VAL-VERSION VALUE IS VERSION "C20".
AM3270 SUBSYSTEM DDL !--------------------------------------------------------------! ! ! ! begin of TOKENs definition section. ! ! ! !--------------------------------------------------------------! ! ! AM3270 specific tokens for configurations. ! CONSTANT ZAM3-TNM-CONFIG-BASE VALUE IS 751. CONSTANT ZAM3-TNM-CONFIG-LAST VALUE IS 999. ?PAGE "AM3270 specific STRUCT token numbers" ! ! AM3270 specific STRUCT token numbers. ! CONSTANT ZAM3-TNM-STRUCT-BASE VALUE IS 2000.
AM3270 SUBSYSTEM DDL ?PAGE "AM3270 ERROR definitions" !--------------------------------------------------------------! ! ! ! ERRORs definition. ! ! ! !--------------------------------------------------------------! ! ! CONSTANT ZAM3-ERR-clip-prob VALUE 2. CONSTANT ZAM3-ERR-Target-Obj-Not-Found VALUE 3. CONSTANT ZAM3-ERR-attr-confl-su VALUE 4. CONSTANT ZAM3-ERR-not-ptp-su VALUE 5. CONSTANT ZAM3-ERR-addr-alrdy-used VALUE 6. CONSTANT ZAM3-ERR-no-obj-in-sel-state VALUE 7.
AM3270 SUBSYSTEM DDL ! CONFIRM WRITE ! CONSTANT ZAM3-VAL-CONF-WRITE-OFF CONSTANT ZAM3-VAL-CONF-WRITE-ON ! ! SLOWPOLL CONSOLE MESSAGE ! CONSTANT ZAM3-VAL-CONSL-OFF CONSTANT ZAM3-VAL-CONSL-ON ! ! CONTROL RTS ! CONSTANT ZAM3-VAL-CTL-RTS-OFF CONSTANT ZAM3-VAL-CTL-RTS-ON ! ! CONTROL SET ! CONSTANT ZAM3-VAL-CTL-SET-ASCII CONSTANT ZAM3-VAL-CTL-SET-EBCDIC ! ! DEBUG ! CONSTANT ZAM3-VAL-DEBUG-OFF CONSTANT ZAM3-VAL-DEBUG-ON ! ! DROP RTS ! CONSTANT ZAM3-VAL-DROP-RTS-OFF CONSTANT ZAM3-VAL-DROP-RTS-ON ! ! EOT IF NO READ
AM3270 SUBSYSTEM DDL ! Trace ! CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT options. ZAM3-VAL-Trace-Opt-L0 ZAM3-VAL-Trace-Opt-L1 ZAM3-VAL-Trace-Opt-L2 ZAM3-VAL-Trace-Opt-L3 ZAM3-VAL-Trace-Opt-L4 ZAM3-VAL-Trace-Opt-DI ZAM3-VAL-Trace-Opt-DO ZAM3-VAL-Trace-Opt-CLBI ZAM3-VAL-Trace-Opt-CLBO CONSTANT ZAM3-VAL-Trace-Opt-CLIP CONSTANT ZAM3-VAL-Trace-Opt-CLIPDI CONSTANT ZAM3-VAL-Trace-Opt-CLIPDO VALUE VALUE VALUE VALUE VALUE VALUE VALUE VALUE VALUE 0. 1. 2. 3. 4. 8. 9. 10.
AM3270 SUBSYSTEM DDL ?PAGE "common DDL definitions exclusive for AM3270" !--------------------------------------------------------------! ! ! ! begin of common DDL definition. ! ! ! !--------------------------------------------------------------! ! ! Error info definition. ! DEF ZAM3-DDL-ERR-INFO. 02 Z-Tkn-Code TYPE ZSPI-DDL-INT2. 02 Z-Index TYPE ZSPI-DDL-INT. 02 Z-Offset TYPE ZSPI-DDL-INT. END. ! ! Message buffer definition for COBOL, both min and max size ! DEFINITION ZAM3-DDL-MSG-BUFFER.
AM3270 SUBSYSTEM DDL ?PAGE "AM3270 STRUCT definitions for PROCESS object" !--------------------------------------------------------------! ! ! ! STRUCTs definition for PROCESS object. ! ! ! !-------------------------------------------------------------! ?PAGE "AM3270 ALTER command STRUCT for LINE object" !-------------------------------------------------------------! ! ! ! STRUCTs/MAP definition for LINE object.
AM3270 SUBSYSTEM DDL ?PAGE "AM3270 INFO command STRUCT for LINE object" ?SECTION ZAM3-DDL-INFO-LINE ?SETSECTION ZAM3-DDL-INFO-LINE ?TALBOUND 0 ! ! ZAM3-DDL-INFO-LINE : ! ! This DDL is returned to requester from AM3270 whenever an ! INFO LINE command is processed. ! DEF ZAM3-DDL-INFO-LINE. 02 ZAutoload TYPE ZSPI-DDL-Boolean. 02 ZBCCType TYPE ZSPI-DDL-Enum. 02 ZCharset TYPE ZSPI-DDL-Enum. 02 ZConf-write TYPE ZSPI-DDL-Boolean. 02 ZConsl-msg TYPE ZSPI-DDL-Boolean. 02 ZCtl-RTS TYPE ZSPI-DDL-Boolean.
AM3270 SUBSYSTEM DDL ?PAGE "AM3270 RESETSTAT/STATISTICS command STRUCT for LINE object" ?SECTION ZAM3-DDL-STATS-LINE ?SETSECTION ZAM3-DDL-STATS-LINE ?TALBOUND 0 ! ! ZAM3-DDL-STATS-LINE : ! ! This DDL is returned to requester from AM3270 whenever a ! RESETSTAT LINE and STATISTICS commands are processed. ! DEF ZAM3-DDL-STATS-LINE. ! ! For Time Stamp. ! 02 ZTmStp TYPE ZSPI-DDL-TimeStamp. 02 ZTmStp-Last TYPE ZSPI-DDL-TimeStamp. ! ! For CLB Level ! 02 ZAM3-Line-CLB. 04 Ztotal-Frame TYPE ZSPI-DDL-Int.
AM3270 SUBSYSTEM DDL DEF ZAM3-DDL-RSTATS-LINE. ! ! For Time Stamp. ! 02 ZTmStp 02 ZTmStp-Last ! ! For CLB Level ! 02 ZAM3-Line-CLB. 04 Ztotal-Frame 04 ZBCC-Err 04 ZFrame-Err 04 Zno-buf ! ! For L2 ! 02 ZAM3-Line-L2. 04 ZTotal-Msg 04 ZMsg-Sent 04 ZMsg-Recved 04 Zl2-err 04 ZNak 04 ZBCC-Err 04 ZFrmt-Err 04 ZRetry 04 ZMsg-L256-Sent 04 ZMsg-L256-Recved 04 ZMsg-L1024-Sent 04 ZMsg-L1024-Recved 04 ZMsg-G1024-Sent 04 ZMsg-G1024-Recved END. TYPE ZSPI-DDL-TimeStamp. TYPE ZSPI-DDL-TimeStamp.
AM3270 SUBSYSTEM DDL ?PAGE "AM3270 STATUS command STRUCT for LINE object" ?SECTION ZAM3-DDL-STATUS-LINE ?SETSECTION ZAM3-DDL-STATUS-LINE ?TALBOUND 0 ! ! ZAM3-DDL-STATUS-LINE : ! ! This DDL is returned to requester from AM3270 whenever a ! STATUS LINE command is processed. ! DEF ZAM3-DDL-STATUS-LINE. 02 ZState TYPE ZSPI-DDL-Enum. 02 ZLdev TYPE ZSPI-DDL-Int. 02 ZPpid. 04 Zcpu 04 Zpin TYPE ZSPI-DDL-Int. TYPE ZSPI-DDL-Int. 02 ZBpid. 04 Zcpu 04 Zpin TYPE ZSPI-DDL-Int. TYPE ZSPI-DDL-Int.
AM3270 SUBSYSTEM DDL ?PAGE "AM3270 ADD command STRUCT for SUBDEVICE object" !-------------------------------------------------------------! ! ! ! STRUCTs/MAPs definition for SU object. ! ! ! !-------------------------------------------------------------! ?SECTION ZAM3-DDL-ADD-SU ?SETSECTION ZAM3-DDL-ADD-SU ?TALBOUND 0 ! ! ZAM3-DDL-ADD-SU : ! ! This DDL is sent to AM3270 whenever an ADD SU command is ! requested. DEF ZAM3-DDL-ADD-SU. 02 ZAddr TYPE ZSPI-DDL-Int-Pair SPI-NULL 255.
AM3270 SUBSYSTEM DDL ?PAGE "AM3270 INFO command STRUCT for SUBDEVICE object" ?SECTION ZAM3-DDL-INFO-SU ?SETSECTION ZAM3-DDL-INFO-SU ?TALBOUND 0 ! ! ZAM3-DDL-INFO-SU : ! ! This DDL is returned to requester from AM3270 whenever an ! INFO SU command is processed. ! DEF ZAM3-DDL-INFO-SU TYPE ZAM3-DDL-ADD-SU. TOKEN-MAP ZAM3-MAP-INFO-SU VALUE IS ZAM3-TNM-INFO-SU DEF IS ZAM3-DDL-INFO-SU. VERSION "C20" FOR ZAddr THRU ZType. END.
AM3270 SUBSYSTEM DDL ?PAGE "AM3270 STATISTICS command STRUCT for SU object" ?SECTION ZAM3-DDL-STATS-SU ?SETSECTION ZAM3-DDL-STATS-SU ?TALBOUND 0 ! ! ZAM3-DDL-STATS-SU : ! ! This DDL is returned to requester from AM3270 whenever a ! STATISTICS SU command is processed. ! DEF ZAM3-DDL-STATS-SU TYPE ZAM3-DDL-RSTATS-SU. TOKEN-MAP ZAM3-MAP-STATS-SU VALUE IS ZAM3-TNM-STATS-SU DEF IS ZAM3-DDL-STATS-SU. VERSION "C20" FOR ZTmStp THRU ZMsg-Recved. END.
AM3270 SUBSYSTEM DDL !--------------------------------------------------------------! ! ! ! AM3 EMS event definitions ! ! ! !--------------------------------------------------------------! CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT zam3-evt-iobus-err VALUE IS zems-evt-iobusmess. zam3-evt-ciu-err VALUE IS zems-evt-errormess. zam3-evt-obj-started VALUE IS zems-evt-upmess. zam3-evt-obj-stopped VALUE IS zems-evt-downmess.
AM3270 SUBSYSTEM DDL CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT CONSTANT zam3-tnm-clip-status zam3-tnm-addr-ctl zam3-tnm-type-seq zam3-tnm-config-err zam3-tnm-ciu-status zam3-tnm-abendnum zam3-tnm-probe-err zam3-tnm-repoll-state zam3-tnm-frame-err TOKEN-CODE zam3-tkn-p-reg TOKEN-CODE zam3-tkn-e-reg TOKEN-CODE zam3-tkn-x1 TOKEN-CODE zam3-tkn-x2 TOKEN-CODE zam3-tkn-x3 TOKEN-CODE zam3-tkn-x4 TOKEN-CODE zam3-tkn-su TOKEN-CODE zam3-tkn-clip-su TOKEN-CODE zam3-tkn-file-err TOKEN-CO
INDEX ABORT command 6-8 Action events 7-3 ADD command 6-14 Allow type token 5-4 ALTER command 6-21 AM3270 definitions 5-17 buffer declarations 5-17 extensible structured tokens 5-18 field values 5-18 token values 5-18 tokens in error lists 5-19 tokens in event messages 5-19 AM3270 subsystem command numbers supported 3-5 commands accepted by 6-1 common syntax elements 3-4 data-communications definitions 5-12 definitions provided by 5-17 elements of SPI messages 3-1 EMS definitions 5-9 event messages 7-1 obj
INDEX Buffer declarations AM3270 5-17 Buffer size for an event message 7-3 recommended for commands 4-1 recommended for responses 4-3 Building the command buffer 4-1 Checksum token 5-4 CLIP downloading 6-69 placing in boot state 6-73 CMI corresponding commands of 2-8 Command buffer, building 4-1 Command numbers 3-4 Command timeout token 5-14 Command-number token 5-4 Commands 6-1 ABORT 6-8 ADD 6-14 ALTER 6-21 building the buffer for 4-1 by object type 6-4 compared to CMI commands 2-8 compared to SCF command
INDEX STATUS 6-98 STOP 6-109 subordinate-modifier token in 4-1 SWITCH 6-115 symbolic names 6-2 TRACE 6-120 Commands and responses 6-1 Comment token 5-5 Common definitions 5-1 Common syntax elements 3-4 CONNECT command 6-32 Console messages 7-5 Console print token 5-10 Constructs involving multiple tokens 3-11 Context token 5-5 Continuation of commands 4-1 of responses 4-3 Continuing despite errors 5-4 CPU token 5-10 Critical events 7-3 CU token use of 7-4 Data lists 3-11 representation of in responses 6-7
INDEX Error numbers with no error lists 4-4 Event management AM3270 7-1 filters 7-72 Event messages 2-10 AM3270 subsystem 7-1 AM3270 subsystem ID 7-1 buffer size 7-3 console-compatible-format text 7-5 display-format text 7-5 displayed on operator console 7-3 event numbers of 3-7 filters 7-3 notation 7-4 obtaining 7-1 order of tokens 7-4 relationship to console messages 7-5 reported to EMS 7-3 reported to TMDS 7-3 standard header in text version 7-5 subjects 3-7 Tandem internal tokens 7-4 text version 7-5 u
INDEX Filters 7-3 example 7-72 selecting AM3270 events 7-72 selecting critical AM3270 events GETVERSION command Header type token 7-73 6-47 5-6 I/O process event messages reported 7-1 I/O processes commands affecting 6-5 object names 5-14 INFO command 6-51 Initializing structured tokens 4-1 Letter Z, using in applications 3-4 LINE object See Lines Lines aborting 6-8 altering 6-21 commands affecting 6-5 current status 6-98 format of object names 3-6 loading 6-69 monitoring statistics 6-90 object names 5-
INDEX Names of objects, See Object names of values 3-10 Naming rules and guidelines 3-4 Noncritical events 7-3 Nonsensitive commands 6-6 GETVERSION 6-47 INFO 6-51 LISTOBJECTS 6-64 STATISTICS 6-90 STATUS 6-98 NULL format of object name 3-5 getting release version 6-47 NULL object 5-14 commands affecting 6-5 Object names format 3-6 I/O processes 5-14 lines 5-14 number accepted in commands 3-6 subdevices 5-14 when required in a command 5-14 Object types 3-5 commands listed by 6-4 I/O processes 5-14 NULL objec
INDEX Receiving the response buffer 4-3 release version 6-47 Requester ID 5-13 Reserved subdevice names #DEBUG 6-14 #ZSPI 6-14 RESET command 6-73 RESETSTATS command 6-77 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 in 4-3 selecting 4-3 tokens in 6-7 Response type token 5-7 Responses 6-1 components 3-11 continuation of 4-3 decoding the buffer 4-3 extensible structured tokens
INDEX SPI messages, elements 3-1 SPI programming considerations 4-1 SPI standard definitions 5-1 SSID description 5-18 structure definition 5-8 SSNULL procedure 4-1 START command 6-85 STATISTICS command 6-90 STATUS command 6-98 STOP command 6-109 Structured tokens See Extensible structured tokens SU object See Subdevices Subchannel-type addressing 7-4 SUBDEVICE object See Subdevices Subdevices aborting 6-8 adding 6-14 altering 6-21 commands affecting 6-5 connecting 6-32 current status 6-98 deleting 6-37 di
INDEX Tokens 3-2, 3-8 constructs involving multiple 3-11 duplicate occurrences 4-2, 4-3 extensible structured 3-9 in one response record 6-7 order in event messages 7-4 order of in commands 6-7 order of in responses 6-7 predefined value names 3-10 simple 3-8 Tandem internal 7-4 token codes 3-8 token maps 3-9 token types 3-9 unconditional 7-4 volatile 7-4 TRACE command 6-120 Trace mode 6-120 Trace token 5-13 Types objects 3-5 of fields 3-10 of tokens 3-9 Unconditional tokens 7-4 Value names, predefined VI
INDEX ZAM3-EVTCIU-ERROR 7-10 CLIP-DWLOAD 7-37 CSS-FRAME-ERR 7-44 CSS-LINE-ERR 7-54 CSS-LIU-CONFIG-ERR 7-51 CSS-PROBE-ERR 7-40 CSS-SUBDEV-ERR 7-58 CSS-UNEXP-BRKPT 7-48 INSUFF-BUF 7-31 INTL-ERR 7-24 IOBUS-ERR 7-6 OBJ-STARTED 7-15 OBJ-STOPPED 7-18 PROC-ABEND 7-27 REPOLL-STATE 7-34 SUBDEV-ERR 7-21 ZAM3-TKNABENDNUM 7-28 ADDR-CTL 7-46 CIU-STATUS 7-11 CLIP-FUNC 7-49, 7-53, 7-55, 7-59 CLIP-STATUS 7-56, 7-60 CLIP-SU 7-56, 7-60 CONFIG-ERR 7-52 E-REG 7-24 FILE-ERR 7-7, 7-22 FRAME-ERR 7-45 P-REG 7-24 PROBE-ERR 7-42 RE
INDEX GETVERSION 6-47 INFO 6-52 LISTOBJECTS 6-65 LOAD 6-69 RESET 6-73 RESETSTATS 6-77 START 6-85 STATISTICS 6-90 STATUS 6-99 STOP 6-110 SWITCH 6-115 TRACE 6-121 ZCOM-EVTCPU-SWITCH 7-62 PATH-SWITCH 7-65 SUMSTATE-CHG 7-69 ZCOM-MAPREQID 5-13 TRACE-MODIF 5-13 ZCOM-OBJLINE 5-14 NULL 5-14 PROC 5-14 SU 5-14 ZCOM-TKNCMD-TIMEOUT 5-14 OBJNAME 5-14 OBJTYPE 5-14 SEL-SUMSTATE 5-15 SUB 5-15 SWITCH-CPU 5-15 SWITCH-PATH 5-15 TARGET-OBJNAME 5-15 TARGET-OBJTYPE 5-15 TRACE-OPT 5-16 ZCOM-VALPATH-A 5-16 PATH-B 5-16 PATH-UNDEF
INDEX EVENTNUMBER 5-10 GENTIME 5-10 LDEV 5-10 LDEVNAME 5-10 LOGTIME 5-10 PIN 5-10 SUBJECT-MARK 7-4 SYSTEM 5-11 USERID 5-11 ZSPI-ERROK 4-4 ZSPI-SSNZAM3 5-3 ZSPI-TKNALLOW-TYPE 4-2, 5-4 CHECKSUM 5-4 COMMAND 5-4 COMMENT 5-5 CONTEXT 5-5 DATALIST 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 RETCODE 5-7 SERVER-BANNER 5-7 SERVER-VERSION 5-7 SSID 5-8 #DEBUG 6-14 #ZSPI 6-14 Index-12
