Networking and Data Communications Library SNAX/HLS Management Programming Manual Abstract Part Number Edition SNAX/HLS provides a general, high-level interface for application programs to communicate with intelligent SNA devices and software products. This manual provides information on setting up and operating SNAX/HLS. 104708 Third Published December 1994 Product Version SNAX/HLS D30 Release ID Supported Releases D30 This manual supports D30.
Document History Edition Part Number Product Version Earliest Supported Release Published First Update 1 Second Update 1 Third 84255 018998 063744 068526 104708 SNAX/HLS C10 SNAX/HLS C20 SNAX/HLS C30.06 SNAX/HLS D10 SNAX/HLS D30 C10 C20 C30.06 D10 D30 May 1988 March 1989 December 1991 February 1993 December 1994 New editions incorporate any updates issued since the previous edition.
New and Changed Information The changes to the SNAX/HLS Management Programming Manual in this version (part number 104708) override the changes in the previous version (part number 063744). The majority of the changes are to style and wording. Major changes are described below: All changes, whether new additions, style changes, or text changes, are noted with a change bar. The changes are as follows: The Guardian 90 operating system is now called the Tandem NonStop Kernel.
New and Changed Information (This page left intentionally blank) iv 104708 Tandem Computers Incorporated
Contents About This Manual ix Notation Conventions Section 1 xi Introduction Objects Controlled by the SNAX/HLS Subsystem SNAX/HLS Management Functions Section 2 1-1 1-1 Management Programming for SNAX/HLS Relationship of Applications to the SNAX/HLS Subsystem 2-1 Introduction to SNAX/HLS Programmatic Interface Commands Event Management Support in SNAX/HLS 2-2 Section 3 Communicating With the SNAX/HLS Manager Process 3-1 Section 4 Elements of SPI Messages for SNAX/HLS SNAX/HLS Definition Fil
Contents Extensible Structured Tokens 6-10 Tokens in Error and Event Messages 6-10 Standard SNAX/HLS Definitions 6-11 Subsystem Token and Field Types 6-11 Predefined Token and Field Values 6-20 Simple Tokens 6-21 Extensible Structured Tokens 6-23 Tokens in Event Messages 6-57 Section 7 Commands and Responses Command Buffer Sizes General Comments 7-1 7-1 Command Summary 7-2 Commands by Object Type 7-3 SNAX/HLS Response Buffers Segmented Responses 7-3 7-4 SNAX/HLS Subsystem Command Descriptions
Contents Section 8 Event Management Subsystem Processes That Report Events Potentially Critical Events 8-2 8-2 Event Management Programming Considerations Event Management Strategies 8-3 8-3 Event Message Descriptions 8-3 1: ZHLS–EVT–BAD–RDT–DEV 8-4 2: ZHLS–EVT–BUF–OVERLOAD 8-6 3: ZHLS–EVT–CUST–ERR 8-8 4: ZHLS–EVT–INV–MU–RECVED 8-10 5: ZHLS–EVT–INV–MU–SENT 8-13 6: ZHLS–EVT–INV–RSP–RECVED 8-15 7: ZHLS–EVT–NEG–RSP–RECVED 8-18 8: ZHLS–EVT–NEG–RSP–SENT 8-21 9: ZHLS–EVT–NO–MEM–FOR–RU 8-24 10: ZHLS–EVT–OL
Contents Appendix A Error Numbers and Error Lists Notation Used A-1 SNAX/HLS Errors A-1 1: ZHLS–ERR–BAD–RDT–DEV A-2 2: ZHLS–ERR–OLD–RDT–VSN A-3 3: ZHLS–ERR–ALLOC–SEG–RDT A-4 4: ZHLS–ERR–TRACING–ACT A-5 5: ZHLS–ERR–NO–TRACE–FILE A-6 6: ZHLS–ERR–TRACE–FILE–ERR A-7 ZCOM Data Communications Errors A-8 –33: ZCOM–ERR–EMPT–RSP A-8 –36: ZCOM–ERR–TKN–CNTXT–VAL–INV Appendix B A-9 D-Series Operating System Considerations Overview of D-Series SNAX/HLS GETVERSION Command New Token B-1 B-1 B-2 Glossary Glossar
About This Manual SNAX High-Level Support (SNAX/HLS) software provides a simple application programming interface for Tandem application programs to communicate with Systems Network Architecture (SNA) devices and SNA host software. SNAX/HLS can be managed programmatically using the Subsystem Programmatic Interface (SPI) and the Event Management Service (EMS). This manual provides subsystem–specific information about these programmatic management interfaces to SNAX/HLS.
About This Manual Related Manuals (This page left intentionally blank) x 104708 Tandem Computers Incorporated
Notation Conventions The following list summarizes the conventions for syntax presentation in this manual. Notation Meaning UPPERCASE LETTERS Uppercase letters represent keywords and reserved words; enter these items exactly as shown. Lowercase italic letters represent variable items that you supply. Brackets enclose optional syntax items. A group of vertically aligned items enclosed in brackets represents a list of selections from which you can choose one, several, or none.
Notation Conventions The following list summarizes the conventions used in 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; enter these names exactly as shown. Lowercase letters represent words that are part of the notation, including DDL keywords. This symbol, placed to the right of a token or field name, indicates that the token or field is required.
1 Introduction SNAX High-Level Support (SNAX/HLS) consists of several programs and support files that jointly form a subsystem. The purpose of this subsystem is to allow easy communication between Tandem application programs and a wide range of SNA devices and software products (including software running in an IBM host). The management programming interfaces to SNAX/HLS permit control of the SNAX/HLS subsystem.
Introduction SNAX/HLS Management Functions (This page left intentionally blank) 1–2 104708 Tandem Computers Incorporated
2 Management Programming for SNAX/HLS The management programming interfaces to the SNAX/HLS subsystem enable applications to execute configuration commands programmatically and to obtain configuration and statistical information about SNAX/HLS. Relationship of Management programming applications do not communicate directly with the Applications to the SNAX/HLS subsystem.
Management Programming for SNAX/HLS Event–Management Support in SNAX/HLS Event Management Support in SNAX/HLS An application can collect SNAX/HLS event messages by communicating with an Event Management Service (EMS) consumer distributor or printing distributor process. The application specifies a filter for the distributor to use. An application requests event messages by issuing a GETEVENT command to the consumer distributor.
3 Communicating With the SNAX/HLS Manager Process SNAX/HLS commands are processed and responses are generated by the SNAX/HLS process. However, your applications do not communicate directly with the SNAX/HLS subsystem; instead, applications communicate with the Subsystem Control Point (SCP), which routes commands to specific data communications subsystems and routes responses back to the appropriate applications. SCP uses the manager token, ZSPI–TKN–MANAGER, to determine the destination subsystem.
Communicating with the SNAX/HLS Manager Process (This page left intentionally blank) 3–2 104708Tandem Computers Incorporated
4 Elements of SPI Messages for SNAX/HLS This section describes the portions of Subsystem Programmatic Interface (SPI) messages that have specific meaning to SNAX/HLS. SNAX/HLS Definition The tokens and other definitions for SNAX/HLS are provided by the following six Files definition files: ZSPIDEF. ZHLSCOB contains COBOL85 definitions. ZSPIDEF. ZHLSDDL contains DDL definitions. ZSPIDEF. ZHLSTACL contains TACL definitions. ZSPIDEF. ZHLSTAL contains TAL definitions. ZSPIDEF. ZHLSC contains C definitions.
Elements of SPI Messages for SNAX/HLS Objects NULL Object Type The NULL object type, ZCOM–OBJ–NULL, is used only in the GETVERSION and LISTOBJECTS commands, where it has a special meaning. The NULL object type has no other use in SNAX/HLS. Object Hierarchy Sessions are considered subordinate to the SNAX/HLS process. No other hierarchy is assumed by SNAX/HLS. Object Names All object names generated by the SNAX/HLS process consist of uppercase characters.
Elements of SPI Messages for SNAX/HLS Objects If the session was established using a SNAX/CDF APPL to gain access to the SNA network, the qualifiers are a converted form of the OPENNAME of the APPL. For example, if the SNAX/CDF process is $CDF and the OPENNAME of the APPL is #APPL1 then the session name on a stand-alone Tandem system would be: $HLS.#CDF.
Elements of SPI Messages for SNAX/HLS Objects For SNAX/XF: $HLS—process.#line—spec.lu—spec $process is the name of the SNAX/HLS process, either with or without an explicit system name. #line—spec is the name of an SNA line, consisting of a pound sign (#) followed by one through seven alphanumeric characters, the first of which must be a letter. lu—spec is the name of an SNA LU, consisting of one through seven alphanumeric characters, the first of which must be a letter. For SNAX/CDF: $HLS—process.
Elements of SPI Messages for SNAX/HLS Objects The SUB Modifier SNAX/HLS accepts the SUB modifier in all commands. Because sessions are considered subordinate to the SNAX/HLS process, you can affect all sessions by specifying that a command apply to all objects subordinate to the SNAX/HLS process. You specify the subordinate modifier by using ZCOM–TKN–SUB.
Elements of SPI Messages for SNAX/HLS Objects Object Summary States SNAX/HLS reports a summary state for each object it manages. Summary states of SESSION objects reflect a summary of SNA states. The summary state of the SNAX/HLS process is artificially reported as STARTED. The five summary states for SESSION objects are: DEFINED STARTED STARTING STOPPING SUSPENDED DEFINED Summary State This summary state indicates that a session has been defined but has not yet begun.
Elements of SPI Messages for SNAX/HLS Subjects of Event Messages SUSPENDED Summary State This summary state indicates that a session is active but no data traffic can flow. In SNA terms, this summary state might exist briefly at session startup, indicating that the BIND message has been sent but the SDT message has not.
Elements of SPI Messages for SNAX/HLS Subjects of Event Messages (This page left intentionally blank) 4–8 104708 Tandem Computers Incorporated
5 SPI Programming Considerations for SNAX/HLS Applications use SPI procedures to build the command buffer and to extract data from the response buffer. Support of Security The SNAX/HLS subsystem controls its own security. The purpose of this security is not to prevent unauthorized access (there is really nothing to protect), but rather to prevent mistakes. Three levels of security access are recognized: the highest level, a medium level, and no security.
SPI Programming Considerations for SNAX/HLS (This page left intentionally blank) 5–2 104708Tandem Computers Incorporated
6 Common Definitions This section presents the definitions used in the SNAX/HLS management programming interfaces and the methods for using the definitions. The standard definitions for SPI (ZSPI), EMS (ZEMS), data communications (ZCOM), and ZCMK follow. See the Communications Management Programming Manual for detailed descriptions of the ZCMK tokens. Standard Subsystem Definitions whose names begin with ZSPI– are standard SPI.
Common Definitions Standard SPI Definitions ZSPI–TKN–ERROR is the error token used in responses and in some events. For descriptions of all SNAX/HLS error numbers, their associated error lists, and the data communications errors that can be issued by SNAX/HLS, see Appendix A, "Error Numbers and Error Lists." ZSPI–TKN–MANAGER contains the name of the SNAX/HLS process. ZSPI–TKN–MORE–DATA provides support as described in the Distributed Systems Management (DSM) Programming Manual.
Common Definitions Standard SPI Definitions ZSPI–TKN–SEGMENTATION provides support, as described in the Distributed Systems Management (DSM) Programming Manual. The token type is ZSPI–TYP–BOOLEAN. It is returned with a value of ZSPI–VAL–TRUE by SNAX/HLS in response to a GETVERSION command, to indicate that SNAX/HLS can return a segmented response if the command asks for one. See Section 7, "Commands and Responses" for more information on how and when SNAX/HLS implements segmented responses.
Common Definitions Standard EMS Definitions Standard EMS Definitions Definitions whose names begin with ZEMS– are standard Event Management Service (EMS) definitions. The standard EMS definitions used in the management programming interfaces to SNAX/HLS consist of simple tokens used in SNAX/HLS event messages and header tokens available to all applications using EMS. All standard EMS definitions are fully described in the Event Management Service (EMS) Manual.
Common Definitions Standard EMS Definitions ZCOM–TKN–OBJNAME contains the name of a SNAX/HLS object in a response or event, or a name template in a command. For information on these names, see “Object Names” in Section 4, “Elements of SPI Messages for SNAX/HLS.” ZCOM–TKN–OBJTYPE contains the object–type number of a SNAX/HLS object. ZCOM–TKN–SEL–SUMSTATE contains a pair of values indicating that the action of a command is restricted to those objects either in or not in a designated summary state.
Common Definitions Standard ZCMK Definitions Standard ZCMK Definitions Definitions whose names begin with ZCMK– are discussed below. Standard ZCMK definitions consists of simple tokens and extensible structured tokens used in SNAX/HLS commands, responses, event messages, and error lists. For information about error numbers, error lists, tokens for commands and responses, and events, see the Communications Management Programming Manual.
Common Definitions Standard ZCMK Definitions ZCMK–VAL–FILE–ROLE–IN occurs in the ZCMK–TKN–FILE–ROLE token. It specifies the file is used as the standard input file. ZCMK–VAL–FILE–ROLE–OUT occurs in the ZCMK–TKN–FILE–ROLE token. It specifies the file is used as the standard output file. ZCMK–VAL–FILE–ROLE–LOG occurs in the ZCMK–TKN–FILE–ROLE token. It specifies the file is used as the event log. ZCMK–VAL–FILE–ROLE–MEM–SWAP occurs in the ZCMK–TKN–FILE–ROLE token.
Common Definitions Standard ZCMK Definitions Simple Tokens The following simple tokens are described in more detail in the Communications Management Programming Manual. ZCMK–TKN–ALTER–BKUP–CPU changes the current SNAX/HLS process backup CPU assignment. ZCMK–TKN–BKUP–STATE reports the state of the backup process. ZCMK–TKN–CHFILE–MAPNAME identifies a charactermap in the charactermap file. ZCMK–TKN–CHFILE–MAPNOTE identifies the notes associated with a charactermap.
Common Definitions Standard ZCMK Definitions ZCMK–TKN–EMS–XFNAME–3 identifies or changes the identity of alternate EMS collector number 3. ZCMK–TKN–LIB–FILE–MOD records the modification timestamp of the file in use as the user library. ZCMK–TKN–LIB–XFNAME identifies the file in use as the user library. ZCMK–TKN–LISTOP–PNAM records the process name that opened the HLS process. ZCMK–TKN–LISTOP–QUALIFS records the qualifiers used when the HLS process was opened.
Common Definitions Standard ZCMK Definitions Extensible Structured Tokens The SNAX/HLS subsystem defines the following ZCMK extensible structured tokens. See the Communications Management Programming Manual for detailed descriptions of these tokens. ZCMK–MAP–ALTER is included in the ALTER request to change selected features of the subsystem. ZCMK–MAP–INFO is included in the response to the INFO request addressed to the process; it reports configured options of the process environment of the subsystem.
Common Definitions Standard SNAX/HLS Definitions ZCMK–TKN–FNUM contains the file number of the file involved in an error. ZCMK–TKN–PARAM–NAME names a defective parameter discovered in the startup protocol. ZCMK–TKN–PARAM–VAL provides the first 80 characters of an invalid parameter value. ZCMK–TKN–PGM–ERR identifies the particular program error that occurred in the ZCMK–EVT–PGM– ERR event. ZCMK–TKN–PROC–ORD contains the identification code of a procedure referred to in the error.
Common Definitions Standard SNAX/HLS Definitions def ZHLS–DDL–HS–PROTO. 05 ZMAX–RU 05 ZPACING–WINDOW 05 ZCHAIN–PROTO 05 ZCHAIN–USE 05 ZCMPRSS–IND 05 ZEB–SEND 05 ZRQ–MODE 05 ZTWO–PHASE–COMMIT type type type type type type type type ZSPI–DDL–INT. ZSPI–DDL–INT. ZSPI–DDL–ENUM. ZSPI–DDL–ENUM. ZSPI–DDL–BOOLEAN. ZSPI–DDL–BOOLEAN. ZSPI–DDL–ENUM. ZSPI–DDL–BOOLEAN. ZMAX–RU records the maximum–sized RU that can be sent by the half session.
Common Definitions Standard SNAX/HLS Definitions ZCHAIN–PROTO specifies the chaining protocol used by the half session. This is established by the BIND record, and is one of the following enumerated values: ZHLS–VAL–CHAIN–PROTO–ANY specifies that both exception and definite response chains are used. This protocol allows the message sender to choose whether to use definite or exception response chains on a message–by–message basis.
Common Definitions Standard SNAX/HLS Definitions When chaining is disabled, the size of messages is limited to the value given by the ZMAX–RU value. The actual value indicated here corresponds to the value included on the BIND record. Selecting some FM profiles overrides the value of this field. This field can have the following enumerated values: ZHLS–VAL–CHAIN–USE–MULTI specifies that multiple–element chains are used. ZHLS–VAL–CHAIN–USE–SINGL specifies that only single–element chains are used.
Common Definitions Standard SNAX/HLS Definitions ZHLS–VAL–RQ–MODE–IMM specifies that immediate request mode is used. This protocol allows only one outstanding definite response chain at any one time. ZTWO–PHASE–COMMIT records whether the half session uses two–phase commit for syncpoint control. This value is used only for TS–profile 4 and is neither checked nor processed by SNAX/HLS.
Common Definitions Standard SNAX/HLS Definitions ZRU–CNT records the number of RUs waiting to be sent or processed. ZSENSE–CODES records the last sense bytes received from or sent to the partner, either in a negative response or in an LUSTAT. Note that the data is presented in raw 32–bit format. COBOL programs might have trouble decoding this information. ZSEQNUM records the next expected sequence number from or to the partner. This value is an unsigned 16–bit number, wrapping from 65,535 to 0.
Common Definitions Standard SNAX/HLS Definitions ZFSM–CBSM–RSP reports the SNAX/HLS implementation of FSM_CONTROL_BSM_RSP. This FSM controls the responses to brackets. It is employed to pass signals to the bracket state manager when a response to the current chain is detected. Note that when this field appears in ZHLS–MAP–STATUS–SESS–SEND, it reports the processing of received responses; with ZHLS–MAP–STATUS–SESS–RECV, it reports the processing of sent responses.
Common Definitions Standard SNAX/HLS Definitions ZHLS–VAL–FSM–CHDX–RSP–RESET indicates that no user message (SNA chain) is in progress. ZFSM–EBCD reports the SNAX/HLS implementation of FSM_EBCD. This FSM enforces a check that prevents processing a message that carries end brackets (END–TRANSACTION–IND = Y) from having the change direction indicator (CDI) set (PREPARE–TO–RECEIVE = YES) at end of chain. In other words, at the end of a chain that ends a transaction, the CDI cannot be set.
Common Definitions Standard SNAX/HLS Definitions ZHLS–VAL–FSM–IMM–RQ–NULL indicates that this FSM is not yet initialized or is not used in the current session. Such is the case when the half session uses delayed request mode. ZHLS–VAL–FSM–IMM–RQ–RESET indicates that no definite response is owed. ZFSM–QEC reports the SNAX/HLS implementation of FSM_QEC. This FSM enforces the quiesce protocol.
Common Definitions Standard SNAX/HLS Definitions When interpreted in the ZHLS–MAP–STATUS–SESS–SEND token, this field refers to the sender of the SBI request. When interpreted in the ZHLS–MAP–STATUS–SESS–RECV token, it refers to the receiver of the SBI request. This field can have the following enumerated values: ZHLS–VAL–FSM–SBI–NOBB indicates that the response to the BIS request has been processed. The implied half session has agreed not to begin any new brackets.
Common Definitions Standard SNAX/HLS Definitions ZHLS–VAL–SSID is the subsystem ID for the SNAX/HLS subsystem. For more information about subsystem IDs, see the Distributed Systems Management (DSM) Programming Manual. ZHLS–VAL–VERSION is the version number of this version of the SNAX/HLS subsystem. Simple Tokens The following simple tokens are used in the SNAX/HLS subsystem commands: ZHLS–TKN–INFO–PROC–RDT–BANNER token–type ZSPI–TYP–STRING.
Common Definitions Standard SNAX/HLS Definitions ZHLS–TKN–TELL–TEXT token–type ZSPI–TYP–STRING. ZHLS–TKN–TELL–TEXT is used in the TELL command and applied to sessions to convey the text to be enqueued to the indicated LUs. Any character text can be included; the maximum number of characters is 80. The data is presented to the application without any translation. That means even if the PROFILE translation attribute is enabled (TRANSLATE = YES), this text is not modified.
Common Definitions Standard SNAX/HLS Definitions ZHLS–TKN–SSCP–TEXT–SIZE token–type ZSPI–TYP–INT. ZHLS–TKN–SSCP–TEXT–SIZE records the upper limit on the size of SSCP-LU messages that will be handled by SNAX/HLS when the application processes unformatted SSCP-LU messages (as set by the WANT-SSCP-TEXT profile option). Valid values are between 256 and 30720. Note that the value given here is the RUsize value.
Common Definitions Standard SNAX/HLS Definitions ZSNAX–IN specifies whether customization routines are invoked when data is received from the SNALU interface. ZSNAX–OUT specifies whether customization routines are invoked when messages are sent to the SNALU interface. ZBUF–SIZE specifies the amount of storage, in bytes, allocated for the use of the customization routines. ZVRFY-BIND-RSP specifies whether a customization routine is invoked before a positive response is sent for the BIND RU.
Common Definitions Standard SNAX/HLS Definitions ZHLS–MAP–INFO–SESS This extensible structured token conveys much of the response to the INFO command when applied to sessions. def ZHLS–DDL–INFO–SESS. 05 ZFM–PROF 05 ZMAX–REQS 05 ZSESSID 05 ZTS–PROF 05 ZALTCODE–ID type type type type type ZSPI–DDL–INT. ZSPI–DDL–INT. ZSPI–DDL–INT. ZSPI–DDL–INT. ZSPI–DDL–ENUM. 05 05 05 05 05 ZALTCODE–USE ZAPPLNAME ZBIND–QUEUING ZBIS–SENT ZBRKT–RESET type type type type type ZSPI–DDL–BOOLEAN.
Common Definitions Standard SNAX/HLS Definitions ZFM–PROF records the function management profile number carried in the BIND RU. The values of 2, 3, 4,7, and 18 are normal. ZMAX–REQS indicates the limit on the number of work requests that can be simultaneously outstanding on one session. This value exists to prevent a malfunctioning application from taking all the storage resources of SNAX/HLS. This value is set in the PROFILE. The value 2 is the default.
Common Definitions Standard SNAX/HLS Definitions ZAPPLNAME specifies the PLU name carried in the BIND. If the LU is type PLU, then the PLU name sent in the BIND is the name in the APPLICATION–NAME field of the OPEN–SESSION or HLS–OPEN verb. If this field is empty, then the PLU–NAME in the BIND record in the RDT table is used.
Common Definitions Standard SNAX/HLS Definitions ZBRKT–TERM specifies how brackets are terminated. The ZHLS–VAL–BRKT–TERM–UNCOND value indicates that brackets are terminated regardless of the response to the chain bearing the end brackets indicator. This value is also used when brackets are not used. In IBM documentation, this is also known as bracket termination rule 2.
Common Definitions Standard SNAX/HLS Definitions ZHDX–FF–RESET–SENDER specifies which partner, in half–duplex flip–flop sessions, acquires the right to send data after a reset. This value is meaningful only for half–duplex flip–flop sessions that do not use brackets or whose reset state is INB. This field has the following enumerated values: ZHLS–VAL–HS–PLRTY–PRIM indicates that the primary half session has the right to send data after a reset.
Common Definitions Standard SNAX/HLS Definitions ZOMIT–MODEM–WAIT specifies whether SNAX/HLS waits for the SNAX/XF line to become operative prior to starting to open the session. A value of ZSPI–VAL–TRUE indicates that no line wait occurs; a value of ZSPI–VAL–FALSE indicates that line wait occurs. ZOPEN–MODE records whether this session is an acquire or accept session. This value is set by the PROFILE selected in the verb that allocated the session.
Common Definitions Standard SNAX/HLS Definitions ZSEND–RECV controls the flow of chains in the session. This value is set when the BIND record is processed. This field can have the following enumerated values: ZHLS–VAL–SEND–RECV–FDUX specifies full–duplex transmission. Messages flow in each direction independently. ZHLS–VAL–SEND–RECV–HDUX–CONT specifies half–duplex with contention.
Common Definitions Standard SNAX/HLS Definitions ZXLATE records whether code translation is in effect. A value of ZSPI–VAL–TRUE indicates that code set translation will occur in the SNAX/HLS product. A value of FALSE indicates that it will not. For more information on charactermaps and code set translation in SNAX/HLS, refer to the SNAX/HLS Application Programming Manual and the definition of the TRANSLATE PROFILE attribute in the SNAX/HLS Configuration and Control Manual.
Common Definitions Standard SNAX/HLS Definitions ZWANT–FLOW–CTL records whether certain flow–control messages are passed to the application program (ZSPI–VAL–TRUE) or processed automatically by SNAX/HLS (ZSPI–VAL–FALSE). This value is specified by the PROFILE, although the issuance of certain application requests can change the value from ZSPI–VAL–FALSE to ZSPI–VAL–TRUE. The messages involved are QEC, QC, RELQ, SBI, BIS, and RTR.
Common Definitions Standard SNAX/HLS Definitions ZFORCE–RTS records whether the REQUEST–SEND–STATE verb causes an SNA SIG request (signal code %H0001) to be sent dependent on the send/receive state of the normal SNA session flows, or regardless of these states. A value of ZSPI–VAL–FALSE means the SNA request is only sent if the local session partner does not already have the right to send data on the normal SNA flow. A value of ZSPI–VAL–TRUE means the SNA request is sent whenever the verb is issued.
Common Definitions Standard SNAX/HLS Definitions ZHLS–MAP–INFO–SESS–SEC This extensible structured token specifies the half–session protocol imposed on the secondary side of the session. The information contained here is derived from byte 5 and bytes 8 through 10 of the BIND message. This token has the following definition: def ZHLS–DDL–INFO–SESS–SEC type ZHLS–DDL–HS–PROTO. This extensible structured token is defined using the extensible structured token ZHLS–DDL–HS–PROTO.
Common Definitions Standard SNAX/HLS Definitions ZHLS–MAP–STATS–PROC–SESS This extensible structured token reports the condition of the number of sessions known to SNAX/HLS. It occurs in the responses to the STATISTICS and RESETSTATS commands when applied to the SNAX/HLS process. Note that in the RESETSTATS command, only the ZMAX and ZRESET–TIME values are reset. This token has the following definition: def ZHLS–DDL–STATS–PROC–SESS type ZCMK–DDL–INT–STATS.
Common Definitions Standard SNAX/HLS Definitions ZSAMPLE–TIME records when the actual session count was sampled. ZHLS–MAP–STATUS–SESS This extensible structured token conveys most of the information returned in the response to the STATUS command when applied to sessions. def ZHLS–DDL–STATUS–SESS. 05 ZALLOC–CNT type 05 ZOPEN–CNT type 05 ZSESSID type 05 ZVERB type 05 ZFSM–DT type 05 ZFSM–SESS type 05 ZFSM–STSN type 05 ZFSM–BSM type 05 ZFSM–HDX type 05 ZFSM–RTR type 05 ZFSM–SHUTD type end. ZSPI–DDL–INT.
Common Definitions Standard SNAX/HLS Definitions ZFSM–DT reports the SNAX/HLS implementation of FSM_DT. This field records the value of the data traffic finite state machine. This FSM indicates whether the session can transfer application data. The condition of this FSM controls the summary state reported for bound sessions. When the FSM has the value ZHLS–VAL–FSM–DT–ACTV, the session is in the STARTED summary state.
Common Definitions Standard SNAX/HLS Definitions ZHLS–VAL–FSM–SESS–ACTV indicates that the BIND message and response have flowed. The session is active. Further state information is contained in other FSMs. ZHLS–VAL–FSM–SESS–NULL indicates that this FSM is not yet initialized or is not used in the current session. ZHLS–VAL–FSM–SESS–P–ACTV indicates that the BIND message has been sent (or received), but the response has not been received (or sent).
Common Definitions Standard SNAX/HLS Definitions ZFSM–BSM reports the SNAX/HLS implementation of FSM_BSM. This finite state machine reflects the bracket state manager states. SNAX/HLS uses the bracket state manager rules appropriate to the half session. This field has the following enumerated values: ZHLS–VAL–FSM–BSM–BETB indicates that the session is between brackets.
Common Definitions Standard SNAX/HLS Definitions ZHLS–VAL–FSM–BSM–P–TERM–S indicates a request carrying EB (end bracket) indicator has been sent, while a transaction (SNA bracket) is in progress (bracket state INB). The bracket is terminated (transition to between bracket state, BETB) at the end of the chain, or if a definite response is requested when that response to the EB chain is received. If the EB chain is cancelled, the bracket state reverts to INB.
Common Definitions Standard SNAX/HLS Definitions ZHLS–VAL–FSM–HDX–INB–SEND indicates that either a user message is being sent and the session is in brackets or the BIND request specified that the reset state of the session was this state. ZHLS–VAL–FSM–HDX–NULL indicates that this FSM is not yet initialized or is not used in the current session. ZHLS–VAL–FSM–HDX–RECV–081B indicates a negative response with SNA sense value %H081B (meaning that the resource is unavailable) has been received.
Common Definitions Standard SNAX/HLS Definitions ZHLS–VAL–FSM–SHUTD–P–SHUTC indicates that the secondary half session has received the SHUTD request and should send the SHUTC request when prepared to terminate the session. There are no restrictions, however, on the primary half session. ZHLS–VAL–FSM–SHUTD–QUIESCED indicates that the SHUTC request has been sent and confirmed. The secondary half session cannot send new normal–flow chains.
Common Definitions Standard SNAX/HLS Definitions controlling session is using user–controlled responses and has a number of responses to send. A large value for the send correlation count implies that delayed request mode is being used and the partner has a number of responses to send. ZPACING–CNT records the current pacing count, indicating the number of RUs that can be sent or received before a pacing response is sent or received. ZRU–CNT records the number of RUs waiting to be sent or processed.
Common Definitions Standard SNAX/HLS Definitions ZHLS–VAL–FSM–CHAIN–PURGE indicates that the remainder of the current chain is being discarded. This purging ceases when the end chain indicator (ECI) is detected. This condition occurs only on the receive data flow. ZFSM–CBSM–RSP reports the SNAX/HLS implementation of FSM_CONTROL_BSM_RSP. This finite state machine (FSM) controls the responses to brackets.
Common Definitions Standard SNAX/HLS Definitions ZHLS–VAL–FSM–CHDX–RSP–NEG–SEEN indicates that a negative response to the current chain is being processed and the send state manager or receive state manager is being called with the negative response as input. This value should never be visible to requesters; it is an internal state only. ZHLS–VAL–FSM–CHDX–RSP–NULL indicates that this FSM is not yet initialized or is not used in the current session.
Common Definitions Standard SNAX/HLS Definitions ZHLS–VAL–FSM–IMM–RQ–DR–NCNCL indicates that a definite response chain (other than CANCEL) has been received but not yet responded to. ZHLS–VAL–FSM–IMM–RQ–INC indicates that a chain is being processed. ZHLS–VAL–FSM–IMM–RQ–INC–RSP indicates that a chain is being processed but the response (presumably negative) has already been processed. ZHLS–VAL–FSM–IMM–RQ–NULL indicates that this FSM is not yet initialized or is not used in the current session.
Common Definitions Standard SNAX/HLS Definitions ZHLS–VAL–FSM–QEC–QUIESCED indicates that the response to the QEC message has been seen, indicating that the session is now quiesced. In this state, no normal–flow messages can be sent by the quiesced half session until the partner releases the quiesce operation with the RELQ request. ZHLS–VAL–FSM–QEC–RESET indicates that a quiesce operation is not in progress. ZFSM–FSM–QRI–CHAIN is reserved. ZFSM–SBI reports the SNAX/HLS implementation of FSM_SBI.
Common Definitions Standard SNAX/HLS Definitions ZHLS–MAP–STATUS–SESS–SEND This extensible structured token records the status of the half–session with regard to the sending of requests and receiving of responses. This token has the following definition: def ZHLS–DDL–STATUS–SESS–SEND type ZHLS–DDL–SEND–RECV–STATUS This token is defined using the extensible structured token ZHLS–DDL–SEND–RECV–STATUS, shown below. def ZHLS–DDL–SEND–RECV–STATUS.
Common Definitions Standard SNAX/HLS Definitions ZSENSE–CODES records the last sense bytes received from or sent to the partner, either in a negative response or in an LUSTAT. Note that the data is presented in raw 32–bit format. COBOL programs might have trouble decoding this information. ZSEQNUM records the next expected sequence number from or to the partner. This value is an unsigned 16–bit number, wrapping from 65,535 to 0. ZWORK–CNT records the number of verbs queued to the session.
Common Definitions Standard SNAX/HLS Definitions it reports the processing of received responses; with ZHLS–MAP–STATUS–SESS–RECV, it reports the processing of sent responses. This field can have the following enumerated values: ZHLS–VAL–FSM–CBSM–RSP–INC indicates that a user message (SNA chain) is being processed. ZHLS–VAL–FSM–CBSM–RSP–NEG–SEEN indicates that a negative response to the current chain is being processed and the bracket state manager is being called with the negative response as input.
Common Definitions Standard SNAX/HLS Definitions ZFSM–EBCD reports the SNAX/HLS implementation of FSM_EBCD. This FSM enforces a check that prevents processing a message that carries end–brackets (END–TRANSACTION–IND = Y) from having the CDI set (PREPARE–TO–RECEIVE = YES) at end of chain. In other words, at the end of a chain that ends a transaction, the CDI cannot be set. Such a request violates SNA protocol.
Common Definitions Standard SNAX/HLS Definitions ZHLS–VAL–FSM–IMM–RQ–RESET indicates that no definite response is owed. ZFSM–QEC reports the SNAX/HLS implementation of FSM_QEC. This FSM enforces the quiesce protocol. The quiesce protocol allows either session partner to stop the flow of messages from the other partner (HLS–FLOW–CONTROL, operation is set to SM, stop messages).
Common Definitions Standard SNAX/HLS Definitions ZFSM–SBI reports the SNAX/HLS implementation of FSM_SBI. This FSM enforces the stop– bracket–initiation protocol. It is used only for LU session type 6.1. When interpreted in the ZHLS–MAP–STATUS–SESS–SEND token, this field refers to the sender of the SBI request. When interpreted in the ZHLS–MAP–STATUS–SESS–RECV token, it refers to the receiver of the SBI request.
Common Definitions Standard SNAX/HLS Definitions ZHLS–MAP–TRACE–CTL This extensible structured token is used both to request tracing and to report the current state of tracing. This token occurs in the TRACE command applied to the SNAX/HLS process and in the response to the INFO command applied to the SNAX/HLS process. def ZHLS–DDL–TRACE–CTL. 05 ZSIZE type ZSPI–DDL–INT. 05 ZSTATE type ZSPI–DDL–BOOLEAN. end. ZSIZE reports the size of the trace file currently in use.
Common Definitions Standard SNAX/HLS Definitions ZHLS–MAP–TRACE–OPT This extensible structured token is used to control and report the tracing functions within the process. This token occurs in the TRACE command and in the response to the INFO command both for the SNAX/HLS process and for sessions. def ZHLS–DDL–TRACE–OPT. 05 ZSNAX type 05 ZDFC type 05 ZLUSVM type 05 ZVERBS type end. ZSPI–DDL–BOOLEAN. ZSPI–DDL–BOOLEAN. ZSPI–DDL–BOOLEAN. ZSPI–DDL–BOOLEAN.
Common Definitions Standard SNAX/HLS Definitions Tokens in Event Messages The following tokens are used in event messages generated by SNAX/HLS: ZHLS–TKN–MAX–LUS token–type ZSPI–TYP–INT. ZHLS–TKN–MAX–LUS conveys the configured value for the MAX^LUS parameter, reflecting the maximum number of LUs for which SNAX/HLS is configured. ZHLS–TKN–MAX–POCBS token–type ZSPI–TYP–INT. ZHLS–TKN–MAX–POCBS conveys the configured value for the MAX^POCB startup parameter. ZHLS–TKN–MAX–TBLS token–type ZSPI–TYP–INT2.
Common Definitions Standard SNAX/HLS Definitions ZHLS–TKN–MUT token–type ZSPI–TYP–STRING. ZHLS–TKN–MUT conveys the printable representation of the information carried in the token ZHLS–TKN–MU, including appropriately positioned blanks. This token is ZSPI–TYP–STRING type , which can be at most 255 characters long. ZHLS–TKN–POCB–SIZE token–type ZSPI–TYP–INT. ZHLS–TKN–POCB–SIZE conveys the base size, in bytes, of each open table in the current implementation of SNAX/HLS.
7 Commands and Responses This section defines the syntax and semantics for all the commands and responses supported by the SNAX/HLS subsystem. Some tokens occur in multiple commands or responses. These common tokens are described in Section 6, “Common Definitions.
Commands and Responses Command Summary Command Summary Table 7–1 shows the commands that can be used in the management programming interfaces to SNAX/HLS. Table 7–1.
Commands and Responses Commands by Object Type Commands by Object ZCOM–OBJ–SESSION can be the target object type in the following SNAX/HLS Type subsystem commands: ABORT INFO LISTOBJECTS LISTOPENS STATUS TELL TRACE ZCOM–OBJ–PROCESS can be the target object type in the following SNAX/HLS subsystem commands: ALTER GETVERSION INFO LISTOBJECTS LISTOPENS RESETSTATS STATISTICS STATUS SWITCH TRACE ZCOM–OBJ–NULL can be the target object type in the following SNAX/HLS subsystem commands: GETVERSION LISTOBJECTS
Commands and Responses Commands by Object Type Segmented Responses As stated above, SNAX/HLS can (if requested) return segmented responses to two commands : LISTOPENS INFO process The structure of the segment list returned by SNAX/HLS is : Token Value –––––––––––––––––––––––––––––––––––––––––––––––––––––––––– ZSPI–TKN–SEGLIST Start Segment ZCMK–TKN–SEGTYPE Segment Type . (data) . . ZSPI–TKN–ERRLIST Error list (if present) . .
Commands and Responses SNAX/HLS Subsystem Command Descriptions SNAX/HLS Subsystem On the following pages, each SNAX/HLS command and its response is described in Command detail. The command descriptions appear in alphabetical order by command name.
Commands and Responses SNAX/HLS Subsystem Command Descriptions ABORT Command The ABORT command causes all operations on the identified session to cease. Command ZCOM–CMD–ABORT Object Type ZCOM–OBJ–SESSION Tokens in Command Buffer ZSPI–TKN–MANAGER 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 ZSPI–TYP–FNAME32. !o ZSPI–TYP–INT. !o ZSPI–TYP–BYTESTRING.!o ZSPI–TYP–ENUM. !o ZSPI–TYP–ENUM.
Commands and Responses SNAX/HLS Subsystem Command Descriptions Tokens in Command Buffer The tokens in the command buffer sent by the ABORT command are described in Section 6, “Common Definitions.” Tokens in Response Buffer The tokens in the response buffer received through an ABORT command are described in Section 6, “Common Definitions.” Operational Notes The session is unbound and closed, and all resources allocated to it are deleted.
Commands and Responses SNAX/HLS Subsystem Command Descriptions ALTER Command The ALTER command allows the modification of certain characteristics of the SNAX/HLS process. Command ZCOM–CMD–ALTER Object Type ZCOM–OBJ–PROCESS Tokens in Command Buffer ZSPI–TKN–MANAGER 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 ZSPI–TYP–FNAME32. !o ZSPI–TYP–INT. !o ZSPI–TYP–BYTESTRING.!o ZSPI–TYP–ENUM.
Commands and Responses SNAX/HLS Subsystem Command Descriptions ZCMK–TKN–EMS–XFNAME–3 ZCMK–TKN–MSG–XFNAME ZCMK–TKN–LOG–XFNAME ZHLS–TKN–RDT–XFNAME ZHLS–TKN–TWO–STEP ZHLS–TKN–SSCP–TEXT–SIZE token–type token–type token–type token–type token–type token–type ZSPI–TYP–STRING. ZSPI–TYP–STRING. ZSPI–TYP–STRING. ZSPI–TYP–STRING. ZSPI–TYP–INT. ZSPI–TYP–INT. token–type token–type token–type token–type token–type ZSPI–TYP–LIST. ZSPI–TYP–STRING. ZSPI–TYP–ENUM. ZSPI–TYP–ENUM. ZSPI–TYP–LIST.
Commands and Responses SNAX/HLS Subsystem Command Descriptions ZCMK–TKN–EMS–XFNAME–1 is included only to change the alternate EMS collector number 1. If the name is empty, the associated collector is turned off, causing all events directed to that collector to be discarded. ZCMK–TKN–EMS–XFNAME–2 is included only to change the alternate EMS collector number 2. If the name is empty, the associated collector is turned off, causing all events directed to that collector to be discarded.
Commands and Responses SNAX/HLS Subsystem Command Descriptions GETVERSION Command The GETVERSION command retrieves the version information and banners of the SNAX/HLS process. Command ZCOM–CMD–GETVERSION Object Type ZCOM–OBJ–NULL ZCOM–OBJ–PROCESS Tokens in Command Buffer ZSPI–TKN–MANAGER ZSPI–TKN–MAXRESP ZSPI–TKN–RESPONSE–TYPE ZSPI–TKN–ALLOW–TYPE ZSPI–TKN–COMMENT token–type token–type token–type token–type token–type ZSPI–TYP–FNAME32. ZSPI–TYP–INT. ZSPI–TYP–ENUM. ZSPI–TYP–ENUM. ZSPI–TYP–STRING.
Commands and Responses SNAX/HLS Subsystem Command Descriptions Tokens in Command Buffer The tokens in the command buffer sent by the GETVERSION command are described in Section 6, “Common Definitions.” Tokens in Response Buffer Most of the tokens in the buffer received in response to an GETVERSION command are described in Section 6, “Common Definitions.” The individual token descriptions that follow provide explanations of unique or extensible structured tokens for particular objects.
Commands and Responses SNAX/HLS Subsystem Command Descriptions INFO Command The INFO command is valid when applied to PROCESS or SESSION object types. The target object type is determined by the object type specified to SSINIT and the value of ZCOM–TKN–SUB, as described in the “Object Types” discussion in Section 4, "Elements of SPI Messages for SNAX/HLS.
Commands and Responses SNAX/HLS Subsystem Command Descriptions Tokens in Response Buffer ZSPI–TKN–DATALIST ZCOM–TKN–OBJNAME ZCOM–TKN–OBJTYPE token–type ZSPI–TYP–LIST. token–type ZSPI–TYP–STRING. token–type ZSPI–TYP–ENUM. ZSPI–TKN–RETCODE token–type ZSPI–TYP–ENUM. ZSPI–TKN–SEGLIST token–type ZSPI–TYP–LIST. ZSPI–TKN–ERRLIST ZSPI–TKN–ENDLIST token–type ZSPI–TYP–LIST. token–type ZSPI–TYP–SSCTL. ZSPI–TKN–ENDLIST token–type ZSPI–TYP–SSCTL. ZSPI–TKN–MORE–DATA token–type ZSPI–TYP–BOOLEAN.
Commands and Responses SNAX/HLS Subsystem Command Descriptions Additional Tokens in Response Buffer ZCMK–MAP–INFO def ZCMK–DDL–INFO. 02 ZBKUP–CPU 02 ZBKUP–DEBUG 02 ZBUF–SWAPVOL 02 ZDEBUG–ON–ERR 02 ZMEM–SWAPVOL end. type type type type type ZSPI–DDL–INT. ZSPI–DDL–BOOLEAN. ZSPI–DDL–DEVICE. ZSPI–DDL–BOOLEAN. ZSPI–DDL–DEVICE.
Commands and Responses SNAX/HLS Subsystem Command Descriptions ZHLS–TKN–INFO–PROC–RDT–BANNER token–type ZSPI–TYP–STRING. ZHLS–MAP–TRACE–CTL def ZHLS–DDL–TRACE–CTL. 02 ZSIZE type ZSPI–DDL–INT. 02 ZSTATE type ZSPI–DDL–BOOLEAN. end. ZHLS–MAP–TRACE–OPT def ZHLS–DDL–TRACE–OPT. 02 ZDFC type 02 ZLUSVM type 02 ZSNAX type 02 ZVERBS type end.
Commands and Responses SNAX/HLS Subsystem Command Descriptions ZCMK–TKN–CHMAP–NAME provides the name of the default charactermap. This token is included only if a charactermap other than the standard ASCII–to–EBCDIC translation is in use. ZCMK–TKN–CHMAP–NOTE provides the notes associated with the default charactermap. These notes reflect the comments provided when the charactermap was created. Typically, these notes explain the nature and function of the conversion table.
Commands and Responses SNAX/HLS Subsystem Command Descriptions ZCMK–TKN–PROG–FILE–MOD records the modification timestamp of the program file. The tokens that begin with ZHLS– are described in detail in Section 6, “Common Definitions.” ZHLS–TKN–RDT–XFNAME and ZHLS–TKN–RDT–FILE–MOD contain the name and modification timestamp of the RDT database. ZHLS–MAP–INFO–PROC–CUST is included only if customization routines have been enabled in the SNAX/HLS server.
Commands and Responses SNAX/HLS Subsystem Command Descriptions Or a charactermap file has been configured using the CHARMAPFILE configuration parameter. If a segmented response is requested in the command, then these two tokens are returned inside a segment list. There is one segment for each charactermap in the charactermap file. (For more information about segmented responses, refer to the Distributed Systems Programming Manual.
Commands and Responses SNAX/HLS Subsystem Command Descriptions INFO (Session) The INFO command returns information about individual sessions known to the SNAX/HLS process. Additional Tokens in Response Buffer ZHLS–MAP–INFO–SESS def ZHLS–DDL–INFO–SESS. 02 ZFM–PROF 02 ZMAX–REQS 02 ZSESSID 02 ZTS–PROF 02 ZALTCODE–ID type type type type type ZSPI–DDL–INT. ZSPI–DDL–INT. ZSPI–DDL–INT. ZSPI–DDL–INT. ZSPI–DDL–ENUM.
Commands and Responses SNAX/HLS Subsystem Command Descriptions 02 ZBID–REJECTION 02 ZACCEPT–BIND 02 ZFORCE–RTS end. type type type ZSPI–DDL–ENUM. ZSPI–DDL–BOOLEAN. ZSPI–DDL–BOOLEAN. ZHLS–MAP–INFO–SESS–PRI def ZHLS–MAP–INFO–SESS–PRI type ZHLS–DDL–HS–PROTO. def ZHLS–DDL–HS–PROTO. 02 ZMAX–RU 02 ZPACING–WINDOW 02 ZCHAIN–PROTO 02 ZCHAIN–USE 02 02 02 02 end. ZSPI–DDL–INT. ZSPI–DDL–INT. ZSPI–DDL–ENUM. ZSPI–DDL–ENUM. type type type type ZSPI–DDL–BOOLEAN. ZSPI–DDL–BOOLEAN. ZSPI–DDL–ENUM. ZSPI–DDL–BOOLEAN.
Commands and Responses SNAX/HLS Subsystem Command Descriptions ZHLS–MAP–INFO–SESS returns information about the session. ZHLS–MAP–INFO–SESS–PRI and ZHLS–MAP–INFO–SESS–SEC are included only if the BIND message has been processed. ZHLS–MAP–TRACE–OPT is included in the response record only if one or more of the fields has a value other than its default value that is, if one or more of the trace options is selected. ZCMK–TKN–CHMAP–NAME identifies the name of the character mapping table in use by this session.
Commands and Responses SNAX/HLS Subsystem Command Descriptions LISTOBJECTS Command The LISTOBJECTS command returns a list of all object types supported by SNAX/HLS, as well as the names of each object. The target object type is determined by the object type specified to SSINIT and the value of ZCOM–TKN–SUB, as described the “Object Types.
Commands and Responses SNAX/HLS Subsystem Command Descriptions Tokens in Command Buffer The tokens in the command buffer sent by the LISTOBJECTS command are described in Section 6, “Common Definitions.” Tokens in Response Buffer The tokens in the buffer received in response to an LISTOBJECTS command are described in Section 6, “Common Definitions.
Commands and Responses SNAX/HLS Subsystem Command Descriptions LISTOPENS Command The LISTOPENS command is valid when applied to PROCESS or SESSION objects. The target object type is determined by the object type specified to SSINIT and the value of ZCOM–TKN–SUB, as described in the “Object Types” discussion in Section 4, “Elements of SPI Messages for SNAX/HLS.
Commands and Responses SNAX/HLS Subsystem Command Descriptions Tokens in Response Buffer ZSPI–TKN–DATALIST ZCOM–TKN–OBJNAME ZCOM–TKN–OBJTYPE token–type ZSPI–TYP–LIST. token–type ZSPI–TYP–STRING. token–type ZSPI–TYP–ENUM. ZSPI–TKN–RETCODE token–type ZSPI–TYP–ENUM. ZSPI–TKN–SEGLIST ZSPI–TKN–SEGTYPE ZCMK–MAP–LISTOP token–type ZSPI–TYP–LIST. token–type ZSPI–DDL–ENUM. def ZCMK–DDL–LISTOP. 02 ZBKUP–CPU 02 ZBKUP–FNUM 02 ZBKUP–PIN 02 ZNODE 02 ZPRIM–CPU 02 ZPRIM–FNUM 02 ZPRIM–PIN 02 ZPROTO end.
Commands and Responses SNAX/HLS Subsystem Command Descriptions If segmentation is not requested on the command, information on as many opens as will fit in the response buffer is returned. If there are too many opens to fit in the response buffer, an error is returned. Tokens in Command Buffer The tokens in the command buffer sent by the LISTOPENS command are described in Section 6, “Common Definitions.
Commands and Responses SNAX/HLS Subsystem Command Descriptions RESETSTATS and STATISTICS Commands The RESETSTATS command, when applied to the SNAX/HLS process, returns statistical information about the SNAX/HLS process and resets any statistics counters that can be reset. The STATISTICS command, when applied to the SNAX/HLS process, returns statistical information about the SNAX/HLS process.
Commands and Responses SNAX/HLS Subsystem Command Descriptions ZCMK–MAP–STATS–MEM def ZCMK–DDL–POOL–STATS. 02 ZCONFIG type 02 ZCURR type 02 ZCURR–FRAG type 02 ZFAIL type 02 ZGROWTH–CNT type 02 02 02 02 02 end. ZGROWTH–TIME ZMAX ZMAX–FRAG ZRESET–TIME ZSAMPLE–TIME ZSPI–DDL–INT2. ZSPI–DDL–INT2. ZSPI–DDL–INT. ZSPI–DDL–INT. ZSPI–DDL–UNIT. type type type type type ZSPI–DDL–TIMESTAMP. ZSPI–DDL–INT2. ZSPI–DDL–INT. ZSPI–DDL–TIMESTAMP. ZSPI–DDL–TIMESTAMP. def ZCMK–DDL–INT–STATS.
Commands and Responses SNAX/HLS Subsystem Command Descriptions def ZCMK–DDL–INT–STATS. 02 ZCONFIG type 02 ZCURR type 02 ZMAX type 02 ZRESET–TIME type 02 ZSAMPLE–TIME type end. ZSPI–TKN–RETCODE ZSPI–TKN–ERRLIST ... ZSPI–TKN–ENDLIST ZSPI–TKN–ENDLIST ZSPI–DDL–INT. ZSPI–DDL–INT. ZSPI–DDL–INT. ZSPI–DDL–TIMESTAMP. ZSPI–DDL–TIMESTAMP. token–type ZSPI–TYP–ENUM. token–type ZSPI–TYP–LIST. token–type ZSPI–TYP–SSCTL. token–type ZSPI–TYP–SSCTL.
Commands and Responses SNAX/HLS Subsystem Command Descriptions STATUS Command The STATUS command is valid when applied to PROCESS or SESSION objects. The target object type is determined by the object type specified to SSINIT and the value of ZCOM–TKN–SUB, as described in the “Object Types” discussion in Section 4, “Elements of SPI Messages for SNAX/HLS.
Commands and Responses SNAX/HLS Subsystem Command Descriptions Tokens in Response Buffer ZSPI–TKN–DATALIST ZCOM–TKN–OBJNAME ZCOM–TKN–OBJTYPE ZCOM–TKN–OBJSTATE token–type token–type token–type token–type ZSPI–TYP–LIST. ZSPI–TYP–STRING. ZSPI–TYP–ENUM. ZSPI–TYP–ENUM. ZSPI–TKN–RETCODE ZSPI–TKN–ERRLIST ... ZSPI–TKN–ENDLIST ZSPI–TKN–ENDLIST ZSPI–TKN–CONTEXT token–type ZSPI–TYP–ENUM. token–type ZSPI–TYP–LIST. token–type ZSPI–TYP–SSCTL. token–type ZSPI–TYP–SSCTL. token–type ZSPI–TYP–BYTESTRING.
Commands and Responses SNAX/HLS Subsystem Command Descriptions STATUS (Session) This form of the STATUS command returns status information about individual sessions known to the SNAX/HLS process. Additional Tokens in Response Buffer ZHLS–MAP–STATUS–SESS def ZHLS–DDL–STATUS–SESS. 02 ZALLOC–CNT type 02 ZOPEN–CNT type 02 ZSESSID type 02 ZVERB type 02 02 02 02 ZFSM–DT ZFSM–SESS ZFSM–STSN ZFSM–BSM 02 ZFSM–HDX 02 ZFSM–RTR 02 ZFSM–SHUTD end. type type type type ZSPI–DDL–INT. ZSPI–DDL–INT. ZSPI–DDL–INT.
Commands and Responses SNAX/HLS Subsystem Command Descriptions 02 ZFSM–QRI–CHAIN 02 ZFSM–SBI end. type ZSPI–DDL–ENUM. type ZSPI–DDL–ENUM. ZHLS–MAP–STATUS–SESS–SEND def ZHLS–DDL–STATUS–SESS–SEND. type ZHLS–DDL–SEND–RECV–STATUS. def ZHLS–DDL–SEND–RECV–STATUS. 02 ZCORR–CNT type ZSPI–DDL–INT. 02 ZPACING–CNT type ZSPI–DDL–INT. 02 ZRU–CNT type ZSPI–DDL–INT. 02 ZSENSE–CODES type ZSPI–DDL–INT2. 02 02 02 02 ZSEQNUM ZWORK–CNT ZFSM–CHAIN ZFSM–CBSM–RSP type type type type ZSPI–DDL–UINT. ZSPI–DDL–INT.
Commands and Responses SNAX/HLS Subsystem Command Descriptions SWITCH Command The SWITCH command transfers control to the backup SNAX/HLS process (if any). Command ZCOM–CMD–SWITCH Object Type ZCOM–OBJ–PROCESS Tokens in Command Buffer ZSPI–TKN–MANAGER ZSPI–TKN–MAXRESP ZSPI–TKN–RESPONSE–TYPE ZSPI–TKN–ALLOW–TYPE ZSPI–TKN–COMMENT token–type token–type token–type token–type token–type ZSPI–TYP–FNAME32. ZSPI–TYP–INT. ZSPI–TYP–ENUM. ZSPI–TYP–ENUM. ZSPI–TYP–STRING.
Commands and Responses SNAX/HLS Subsystem Command Descriptions Tokens in Command Buffer The tokens in the command buffer sent by the SWITCH PROCESS command are described in Section 6, “Common Definitions.” ZCOM–TKN–SWITCH–CPU contains the number of the CPU in which the backup process is running. Tokens in Response Buffer The tokens in the buffer received in response to a SWITCH PROCESS command are described in Section 6, “Common Definitions.
Commands and Responses SNAX/HLS Subsystem Command Descriptions TELL Command The TELL command delivers a text string of up to 80 characters to the application program controlling the specified sessions. Command ZCOM–CMD–TELL Object Type ZCOM–OBJ–SESSION Tokens in Command Buffer ZSPI–TKN–MANAGER 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 ZSPI–TYP–FNAME32. !o ZSPI–TYP–INT.
Commands and Responses SNAX/HLS Subsystem Command Descriptions Tokens in Command Buffer The tokens in the command buffer sent by the TELL SESSION command are described in Section 6, “Common Definitions.” ZHLS–TKN–TELL–TEXT contains the text to be delivered to the target sessions. Tokens in Response Buffer The tokens in the buffer received in response to a TELL SESSION command are described in Section 6, “Common Definitions.
Commands and Responses SNAX/HLS Subsystem Command Descriptions TRACE Command The TRACE command is valid when applied to objects of type PROCESS or SESSION.
Commands and Responses SNAX/HLS Subsystem Command Descriptions Tokens in Command Buffer Most of the tokens in the command buffer sent by the TRACE command are described in Section 6, “Common Definitions.” The individual TRACE command descriptions that follow provide explanations of the fields in the extensible structured tokens for particular objects. Tokens in Response Buffer Most of the tokens in the buffer received in response to an TRACE command are described in Section 6, “Common Definitions.
Commands and Responses SNAX/HLS Subsystem Command Descriptions TRACE (Process) When applied to the process, the TRACE command controls the tracing facilities of the SNAX/HLS process. Additional Tokens in Command Buffer ZHLS–MAP–TRACE–CTL !o def ZHLS–DDL–TRACE–CTL. 02 ZSIZE type ZSPI–DDL–INT. 02 ZSTATE type ZSPI–DDL–BOOLEAN. end. ZHLS–MAP–TRACE–OPT !o def ZHLS–DDL–TRACE–OPT. 02 ZDFC type 02 ZLUSVM type 02 ZSNAX type 02 ZVERBS type end. ZHLS–TKN–TRACE–XFNAME !o !o ZSPI–DDL–BOOLEAN. ZSPI–DDL–BOOLEAN.
Commands and Responses SNAX/HLS Subsystem Command Descriptions TRACE (Session) This form of the TRACE command specifies which events of a session are to be noted in the trace file. Additional Tokens in Command Buffer ZHLS–MAP–TRACE–OPT def ZHLS–DDL–TRACE–OPT. 02 ZDFC type 02 ZLUSVM type 02 ZSNAX type 02 ZVERBS type end. !o ZSPI–DDL–BOOLEAN. ZSPI–DDL–BOOLEAN. ZSPI–DDL–BOOLEAN. ZSPI–DDL–BOOLEAN.
8 Event Management The SNAX/HLS subsystem provides information about events that occur in the subsystem 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. For more information about subsystem IDs, refer to the Distributed Systems Management (DSM) Programming Manual.
Event Management Subsystem Processes That Report Events Subsystem Processes SNAX/HLS generates event messages for events that involve objects under its control. That Report Events Table 8–1 lists the SNAX/HLS event messages. Table 8–1.
Event Management Event Message Descriptions Event Management Programming Considerations All SNAX/HLS event messages are reported to EMS and none are reported to the Tandem maintenance and diagnostic system (TMDS). When the standard token ZEMS–TKN–CONSOLE–PRINT contains the value ZSPI–VAL–TRUE, messages are also displayed on the operator console controlled by the compatibility distributor ($Z0). The SNAX/HLS subsystem does not report any events as action events (events that require operator intervention).
Event Management Event Message Descriptions The box also contains the text version of the event message, which can be obtained by using the EMSTEXT procedure. When you use the EMSTEXT procedure to get the text version of an event message, you request either the display format or the console– compatible format, as described in the Event Management Service (EMS) Manual. In the case of most SNAX/HLS event messages, there is no difference between the two versions.
Event Management Event Message Descriptions Unconditional Tokens ZSPI–TKN–SSID is the subsystem ID for SNAX/HLS, as described in the Distributed Systems Management (DSM) Programming Manual. ZEMS–TKN–EVENTNUMBER is the event number. Its value is ZHLS–EVT–BAD–RDT–DEV. ZEMS–TKN–SUBJECT–MARK serves to mark the token that follows it in the event message buffer as the subject of the event message. In this message, the subject token is ZCOM–TKN–SUBJ–PROC.
Event Management Event Message Descriptions 2: ZHLS–EVT–BUF–OVERLOAD This event occurs whenever the line handler of the Tandem access method you are using, for example, SNAX/XF, rejects an outbound request because of temporary memory congestion. Unconditional Tokens ZSPI–TKN–SSID ZEMS–TKN–EVENTNUMBER ZEMS–TKN–SUBJECT–MARK ZCOM–TKN–SUBJ–SESS ZSPI–TKN–MANAGER token–type token–type token–type token–type token–type ZSPI–TYP–SSID. ZSPI–TYP–ENUM. ZSPI–TYP–MARK. ZSPI–TYP–STRING. ZSPI–TYP–FNAME32.
Event Management Event Message Descriptions ZSPI–TKN–MANAGER is the name of the SNAX/HLS process. ZEMS–TKN–EMPHASIS contains the value ZSPI–VAL–FALSE, indicating that this is not considered a critical event. ZEMS–TKN–CONSOLE–PRINT contains the value ZSPI–VAL–TRUE. This token is described in the Event Management Service (EMS) Manual. (ZEMS–TKN–) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the Event Management Service (EMS) Manual. Cause.
Event Management Event Message Descriptions 3: ZHLS–EVT–CUST–ERR This event occurs whenever the installation–supplied customization routines violate one or more of the rules. Unconditional Tokens ZSPI–TKN–SSID ZEMS–TKN–EVENTNUMBER ZEMS–TKN–SUBJECT–MARK ZCOM–TKN–SUBJ–PROC ZSPI–TKN–MANAGER token–type token–type token–type token–type token–type ZSPI–TYP–SSID. ZSPI–TYP–ENUM. ZSPI–TYP–MARK. ZSPI–TYP–STRING. ZSPI–TYP–FNAME32.
Event Management Event Message Descriptions ZSPI–TKN–MANAGER is the name of the SNAX/HLS process. ZEMS–TKN–EMPHASIS contains the value ZSPI–VAL–TRUE, indicating that this is a potentially critical event. ZEMS–TKN–CONSOLE–PRINT contains the value ZSPI–VAL–TRUE. This token is described in the Event Management Service (EMS) Manual. (ZEMS–TKN–) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the Event Management Service (EMS) Manual. Cause.
Event Management Event Message Descriptions 4: ZHLS–EVT–INV–MU–RECVED This event occurs whenever SNAX/HLS receives a message unit (MU) from the session partner that violates SNA protocol. The first 16 bytes of the message are presented. Unconditional Tokens ZSPI–TKN–SSID ZEMS–TKN–EVENTNUMBER ZEMS–TKN–SUBJECT–MARK ZCOM–TKN–SUBJ–SESS ZSPI–TKN–MANAGER token–type token–type token–type token–type token–type ZSPI–TYP–SSID. ZSPI–TYP–ENUM. ZSPI–TYP–MARK. ZSPI–TYP–STRING. ZSPI–TYP–FNAME32.
Event Management Event Message Descriptions ZCOM–TKN–SUBJ–SESS is the name of the session that is the subject of this event message, as described in Section 6, “Common Definitions.” The value of this token corresponds to the value <1> in the text message. ZSPI–TKN–MANAGER is the name of the SNAX/HLS process. ZEMS–TKN–EMPHASIS contains the value ZSPI–VAL–TRUE, indicating that this is a potentially critical event. ZEMS–TKN–CONSOLE–PRINT contains the value ZSPI–VAL–TRUE.
Event Management Event Message Descriptions ZCMK-TKN-SNAERR If present, this token conveys the SNA sense data (2 bytes) with which the request RU was rejected. The value of this token corresponds to the value <4> in the text message. Value <2> in the text message is the text of the sense data.
Event Management Event Message Descriptions 5: ZHLS–EVT–INV–MU–SENT This event occurs whenever SNAX/HLS attempts to send a message unit that does not comply with SNA protocol. The first 16 bytes of the message are presented. Unconditional Tokens ZSPI–TKN–SSID ZEMS–TKN–EVENTNUMBER ZEMS–TKN–SUBJECT–MARK ZCOM–TKN–SUBJ–SESS ZSPI–TKN–MANAGER token–type token–type token–type token–type token–type ZSPI–TYP–SSID. ZSPI–TYP–ENUM. ZSPI–TYP–MARK. ZSPI–TYP–STRING. ZSPI–TYP–FNAME32.
Event Management Event Message Descriptions ZCOM–TKN–SUBJ–SESS is the name of the session that is the subject of this event message, as described in Section 6, “Common Definitions.” The value of this token corresponds to the value <1> in the text message. ZSPI–TKN–MANAGER is the name of the SNAX/HLS process. ZEMS–TKN–EMPHASIS contains the value ZSPI–VAL–TRUE, indicating that this is a potentially critical event. ZEMS–TKN–CONSOLE–PRINT contains the value ZSPI–VAL–TRUE.
Event Management Event Message Descriptions ZCMK-TKN-SNAERR If present, it conveys the SNA sense data (2 bytes) with which the request RU was rejected. The value of this token corresponds to the value <4> in the text message. Value <2> in the text message is the text of the sense data. 6: ZHLS–EVT–INV–RSP–RECVED This event occurs whenever an invalid response is received.
Event Management Event Message Descriptions ZEMS–TKN–SUBJECT–MARK serves to mark the token that follows it in the event message buffer as the subject of the event message. In this message, the subject token is ZCOM–TKN–SUBJ–SESS. ZCOM–TKN–SUBJ–SESS is the name of the session that is the subject of this event message, as described in Section 6, “Common Definitions.” The value of this token corresponds to the value <1> in the text message. ZSPI–TKN–MANAGER is the name of the SNAX/HLS process.
Event Management Event Message Descriptions To help isolate the problem, run a SNAX/HLS trace for that session in which the MU was received. To aid in discovering the cause of the violation, the SNA sense codes may be located with the help of the definition of the ZHLS–TKN–MU token in Section 6, “Common Definitions.” ZCMK-TKN-SNAERR If present, it conveys the SNA sense data (2 bytes) with which the request RU was rejected. The value of this token corresponds to the value <4> in the text message.
Event Management Event Message Descriptions 7: ZHLS–EVT–NEG–RSP–RECVED This event occurs whenever a negative response is received by SNAX/HLS. Unconditional Tokens ZSPI–TKN–SSID ZEMS–TKN–EVENTNUMBER ZEMS–TKN–SUBJECT–MARK ZCOM–TKN–SUBJ–SESS ZSPI–TKN–MANAGER token–type token–type token–type token–type token–type ZSPI–TYP–SSID. ZSPI–TYP–ENUM. ZSPI–TYP–MARK. ZSPI–TYP–STRING. ZSPI–TYP–FNAME32.
Event Management Event Message Descriptions Unconditional Tokens ZSPI–TKN–SSID is the subsystem ID for SNAX/HLS, as described in the Distributed Systems Management (DSM) Programming Manual. ZEMS–TKN–EVENTNUMBER is the event number. Its value is ZHLS–EVT–NEG–RSP–RECVED. ZEMS–TKN–SUBJECT–MARK serves to mark the token that follows it in the event message buffer as the subject of the event message. In this message, the subject token is ZCOM–TKN–SUBJ–SESS.
Event Management Event Message Descriptions ZCMK–TKN–SNAERR conveys the SNA sense code (just 2 bytes) carried in the negative response. It is an explanation of this that corresponds to the value <2> in the text message. ZCMK-TKN-SNAERR If present, it conveys the SNA sense data (two bytes) with which the request RU was rejected. The value of this token corresponds to the value <4> in the text message. Value <2> in the text message is text of the sense data. Cause.
Event Management Event Message Descriptions 8: ZHLS–EVT–NEG–RSP–SENT This event occurs whenever a negative response is sent by the local application or by SNAX/HLS. Unconditional Tokens ZSPI–TKN–SSID ZEMS–TKN–EVENTNUMBER ZEMS–TKN–SUBJECT–MARK ZCOM–TKN–SUBJ–SESS ZSPI–TKN–MANAGER token–type token–type token–type token–type token–type ZSPI–TYP–SSID. ZSPI–TYP–ENUM. ZSPI–TYP–MARK. ZSPI–TYP–STRING. ZSPI–TYP–FNAME32.
Event Management Event Message Descriptions Unconditional Tokens ZSPI–TKN–SSID is the subsystem ID for SNAX/HLS, as described in the Distributed Systems Management (DSM) Programming Manual. ZEMS–TKN–EVENTNUMBER is the event number. Its value is ZHLS–EVT–NEG–RSP–SENT. ZEMS–TKN–SUBJECT–MARK serves to mark the token that follows it in the event message buffer as the subject of the event message. In this message, the subject token is ZCOM–TKN–SUBJ–SESS.
Event Management Event Message Descriptions ZCMK–TKN–SNAERR conveys the SNA sense code (just 2 bytes) carried in the negative response. It is an explanation of this that corresponds to the value <2> in the text message. Cause. A negative response has been sent by the local application or by SNAX/HLS. Effect. If the session is being established, the establishment fails. If data traffic is active, the negative response is sent to the partner. This message is intended to provide an audit trail. Recovery.
Event Management Event Message Descriptions 9: ZHLS–EVT–NO–MEM–FOR–RU This event occurs whenever an inbound message is discarded because of memory congestion. Unconditional Tokens ZSPI–TKN–SSID ZEMS–TKN–EVENTNUMBER ZEMS–TKN–SUBJECT–MARK ZCOM–TKN–SUBJ–SESS ZSPI–TKN–MANAGER token–type token–type token–type token–type token–type ZSPI–TYP–SSID. ZSPI–TYP–ENUM. ZSPI–TYP–MARK. ZSPI–TYP–STRING. ZSPI–TYP–FNAME32.
Event Management Event Message Descriptions ZSPI–TKN–MANAGER is the name of the SNAX/HLS process. ZEMS–TKN–EMPHASIS contains the value ZSPI–VAL–TRUE, indicating that this is a potentially critical event. ZEMS–TKN–CONSOLE–PRINT contains the value ZSPI–VAL–TRUE. This token is described in the Event Management Service (EMS) Manual. (ZEMS–TKN–) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the Event Management Service (EMS) Manual. Cause.
Event Management Event Message Descriptions 10: ZHLS–EVT–OLD–RDT–VSN This message occurs whenever an attempt is made to load or switch to an back–level RDT database. Unconditional Tokens ZSPI–TKN–SSID ZEMS–TKN–EVENTNUMBER ZEMS–TKN–SUBJECT–MARK ZCOM–TKN–SUBJ–PROC ZSPI–TKN–MANAGER token–type token–type token–type token–type token–type ZSPI–TYP–SSID. ZSPI–TYP–ENUM. ZSPI–TYP–MARK. ZSPI–TYP–STRING. ZSPI–TYP–FNAME32.
Event Management Event Message Descriptions ZSPI–TKN–MANAGER is the name of the SNAX/HLS process. ZEMS–TKN–EMPHASIS contains the value ZSPI–VAL–TRUE, indicating that this is a potentially critical event. ZEMS–TKN–CONSOLE–PRINT contains the value ZSPI–VAL–TRUE. This token is described in the Event Management Service (EMS) Manual. (ZEMS–TKN–) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the Event Management Service (EMS) Manual.
Event Management Event Message Descriptions 11: ZHLS–EVT–RECV–DATA–OVERRUN This message occurs whenever the number of inbound messages on a session exceeds 255. Unconditional Tokens ZSPI–TKN–SSID ZEMS–TKN–EVENTNUMBER ZEMS–TKN–SUBJECT–MARK ZCOM–TKN–SUBJ–SESS ZSPI–TKN–MANAGER token–type token–type token–type token–type token–type ZSPI–TYP–SSID. ZSPI–TYP–ENUM. ZSPI–TYP–MARK. ZSPI–TYP–STRING. ZSPI–TYP–FNAME32.
Event Management Event Message Descriptions ZSPI–TKN–MANAGER is the name of the SNAX/HLS process. ZEMS–TKN–EMPHASIS contains the value ZSPI–VAL–TRUE, indicating that this is a potentially critical event. ZEMS–TKN–CONSOLE–PRINT contains the value ZSPI–VAL–TRUE. This token is described in the Event Management Service (EMS) Manual. (ZEMS–TKN–) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the Event Management Service (EMS) Manual. Cause.
Event Management Event Message Descriptions 12: ZHLS–EVT–TOO–MANY–POCBS–LUS This event occurs whenever a number of POCBs and LUs requested, while individually within legal bounds, require the allocation of too much memory. Unconditional Tokens ZSPI–TKN–SSID ZEMS–TKN–EVENTNUMBER ZEMS–TKN–SUBJECT–MARK ZCOM–TKN–SUBJ–PROC ZSPI–TKN–MANAGER token–type token–type token–type token–type token–type ZSPI–TYP–SSID. ZSPI–TYP–ENUM. ZSPI–TYP–MARK. ZSPI–TYP–STRING. ZSPI–TYP–FNAME32.
Event Management Event Message Descriptions Unconditional Tokens ZSPI–TKN–SSID is the subsystem ID for SNAX/HLS, as described in the Distributed Systems Management (DSM) Programming Manual. ZEMS–TKN–EVENTNUMBER is the event number. Its value is ZHLS–EVT–TOO–MANY–POCBS–LUS. ZEMS–TKN–SUBJECT–MARK serves to mark the token that follows it in the event message buffer as the subject of the event message. In this message, the subject token is ZCOM–TKN–SUBJ–PROC.
Event Management Event Message Descriptions ZHLS–TKN–TCB–SIZE conveys the amount of memory, in bytes, required in the current implementation of SNAX/HLS to have vital information for each session. It is used to explain why allocation attempts fail. The value of this token corresponds to the value <5> in the text message. This value is subject to change from release to release, or IPM to IPM.
Event Management Event Message Descriptions 14: ZHLS–EVT–UNEXP–PR–RECVED This event occurs whenever an unexpected pacing response is received. Unconditional Tokens ZSPI–TKN–SSID ZEMS–TKN–EVENTNUMBER ZEMS–TKN–SUBJECT–MARK ZCOM–TKN–SUBJ–SESS ZSPI–TKN–MANAGER token–type token–type token–type token–type token–type ZSPI–TYP–SSID. ZSPI–TYP–ENUM. ZSPI–TYP–MARK. ZSPI–TYP–STRING. ZSPI–TYP–FNAME32.
Event Management Event Message Descriptions ZEMS–TKN–EMPHASIS contains the value ZSPI–VAL–TRUE, indicating that this is a potentially critical event. ZEMS–TKN–CONSOLE–PRINT contains the value ZSPI–VAL–TRUE. This token is described in the Event Management Service (EMS) Manual. (ZEMS–TKN–) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the Event Management Service (EMS) Manual.
Appendix A Error Numbers and Error Lists This appendix describes the SNAX/HLS (ZHLS–) and data communications (ZCOM–) error numbers and their associated error lists that can be returned by SNAX/HLS. For information on the ZCMK–EVT (events), refer to the Communications Management Programming Manual. See the SNAX/HLS Configuration and Control Manual for descriptions of HLSCOM error messages.
Error Numbers and Error Lists SNAX/HLS Errors 1: ZHLS–ERR–BAD–RDT–DEV An attempt was made to load a RDT file from a device other than disk. ZSPI–TKN–ERRLIST ZSPI–TKN–ERROR ZCOM–TKN–OBJNAME ZSPI–TKN–ENDLIST token–type token–type token–type token–type ZSPI–TYP–LIST. ZSPI–TYP–ERROR. ZSPI–TYP–STRING. ZSPI–TYP–SSCTL. Tokens ZSPI–TKN–ERROR is the standard SPI error token, as described in the Distributed Systems Management (DSM) Programming Manual.
Error Numbers and Error Lists SNAX/HLS Errors 2: ZHLS–ERR–OLD–RDT–VSN An attempt to load a RDT file was rejected because the file was compiled with a down–level version of the HLSRDT program. ZSPI–TKN–ERRLIST ZSPI–TKN–ERROR ZCOM–TKN–OBJNAME ZSPI–TKN–ENDLIST token–type token–type token–type token–type ZSPI–TYP–LIST. ZSPI–TYP–ERROR. ZSPI–TYP–STRING. ZSPI–TYP–SSCTL. Tokens ZSPI–TKN–ERROR is the standard SPI error token, as described in the Distributed Systems Management (DSM) Programming Manual.
Error Numbers and Error Lists SNAX/HLS Errors 3: ZHLS–ERR–ALLOC–SEG–RDT An attempt to load a RDT file was rejected because the attempt to allocate the extended segment failed. ZSPI–TKN–ERRLIST ZSPI–TKN–ERROR ZCOM–TKN–OBJNAME ZSPI–TKN–ENDLIST token–type token–type token–type token–type ZSPI–TYP–LIST. ZSPI–TYP–ERROR. ZSPI–TYP–STRING. ZSPI–TYP–SSCTL. Tokens ZSPI–TKN–ERROR is the standard SPI error token, as described in the Distributed Systems Management (DSM) Programming Manual.
Error Numbers and Error Lists SNAX/HLS Errors 4: ZHLS–ERR–TRACING–ACT Tracing is already active. ZSPI–TKN–ERRLIST ZSPI–TKN–ERROR ZCOM–TKN–OBJNAME ZSPI–TKN–ENDLIST token–type token–type token–type token–type ZSPI–TYP–LIST. ZSPI–TYP–ERROR. ZSPI–TYP–STRING. ZSPI–TYP–SSCTL. Tokens ZSPI–TKN–ERROR is the standard SPI error token, as described in the Distributed Systems Management (DSM) Programming Manual. Its value consists of the SNAX/HLS subsystem ID and the error number ZHLS–ERR–TRACING–ACT.
Error Numbers and Error Lists SNAX/HLS Errors 5: ZHLS–ERR–NO–TRACE–FILE An attempt was made to start tracing without having specified a trace file. ZSPI–TKN–ERRLIST ZSPI–TKN–ERROR ZCOM–TKN–OBJNAME ZSPI–TKN–ENDLIST token–type token–type token–type token–type ZSPI–TYP–LIST. ZSPI–TYP–ERROR. ZSPI–TYP–STRING. ZSPI–TYP–SSCTL. Tokens ZSPI–TKN–ERROR is the standard SPI error token, as described in the Distributed Systems Management (DSM) Programming Manual.
Error Numbers and Error Lists SNAX/HLS Errors 6: ZHLS–ERR–TRACE–FILE–ERR A trace file error has occurred. ZSPI–TKN–ERRLIST ZSPI–TKN–ERROR ZCOM–TKN–OBJNAME ZSPI–TKN–ENDLIST token–type token–type token–type token–type ZSPI–TYP–LIST. ZSPI–TYP–ERROR. ZSPI–TYP–STRING. ZSPI–TYP–SSCTL. Tokens ZSPI–TKN–ERROR is the standard SPI error token, as described in the Distributed Systems Management (DSM) Programming Manual. Its value consists of the SNAX/HLS subsystem ID and the error number ZHLS–ERR–TRACE–FILE–ERR.
Error Numbers and Error Lists ZCOM Data Communications Errors ZCOM Data SNAX/HLS may return the following ZCOM data communications errors: Communications –4: ZCOM–ERR–CMD–MISMATCH Errors –5: –17: –22: –23: –24: –26: –27: –29: –30: –32: –33: –36: ZCOM–ERR–CMP–NOT–SUPP ZCOM–ERR–OBJ–NOT–FOUND ZCOM–ERR–SECUR–VIOL ZCOM–ERR–SPI–ERR ZCOM–ERR–SSID–INV ZCOM–ERR–TKN–CODE–INV ZCOM–ERR–TKN–DUP ZCOM–ERR–TKN–REQ ZCOM–ERR–TKN–VAL–INV ZCOM–ERR–VSN–INCOMP ZCOM–ERR–EMPT–RSP ZCOM–ERR–TKN–CNTXT–VAL–INV These errors are desc
Error Numbers and Error Lists ZCOM Data Communications Errors –36: ZCOM–ERR–TKN–CNTXT–VAL–INV A token contains a value invalid in this context. ZSPI–TKN–ERRLIST ZSPI–TKN–ERROR ZSPI–TKN–PARM–ERR ZSPI–TKN–ENDLIST token–type token–type token–type token–type ZSPI–TYP–LIST. ZSPI–TYP–ERROR. ZSPI–TYP–PARM–ERR. ZSPI–TYP–SSCTL. Tokens ZSPI–TKN–ERROR is the standard SPI error token, as described in the Distributed Systems Management (DSM) Programming Manual.
Error Numbers and Error Lists ZCOM Data Communications Errors (This page left intentionally blank) A–10 104708 Tandem Computers Incorporated
Appendix B Supplemental Information for D-Series Systems This appendix provides specific information about D-series SNAX/HLS relevant to the SNAX/HLS Management Programming Manual.
Supplemental Information for D-Series Systems New Token The variable length token ZCOM-TKN-XMGR identifies the SNAX/HLS process name. It is present only in a request buffer. Both ZSPI-TKN-XMGR and ZSPI-TKNMANAGER should not be present in the same request buffer. In a response buffer, ZCOM-TNK-XMGR can appear only in an error list. For additional information refer to the D-series supplement to Tandem’s Communications Management Programming Manual.
Glossary This glossary defines terms used and referred to in SNA and SNAX/HLS. Several definitions have been borrowed from IBM’s Dictionary of Computing (SC20–1699) and IBM’s Network Program Products: General Information (GC30–3350). $SSCP. Process name of the SNAX/XF Service Manager. ANSI. American National Standards Institute. application prototyping and simulation. A SNAX/HLS tool used by software developers to quickly and easily determine how their applications work. APS.
Glossary communication interface unit (CIU). A hardware unit that, together with the SNAXLink software and the CAU, provides a direct channel link between a Tandem system and an IBM system. The CIU controller attaches directly to the Tandem processor through a standard I/O card slot. Communications Management Interface (CMI). A Tandem subsystem that is used for configuring and controlling communications subsystems such as SNAX/XF. See also Subsystem Control Facility. configuration.
Glossary DTE. See data–terminal equipment. EIO. See execute I/O. EMS. See event management service. event. An event is an uncontrolled or unplanned transmission. Critical events are those conditions that applications cannot handle and that cause processes or even sessions to terminate. Noncritical events are conditions that applications can handle and from which they can recover. Action events are those events that require operator intervention. Event Management Service.
Glossary HLSTAP. Trace Analysis Program for SNAX/HLS. HLSTAP formats SNAX/HLS requests and responses in terms that do not require a detailed understanding of SNAX/HLS. HLSRDT. Constructs the resource definition table (RDT) for SNAX/HLS. The RDT is the configuration database for SNAX/HLS. Each RDT PROFILE contains the required SNA–specific information necessary to configure and initiate a session. This information includes such SNA parameters as the BIND and INIT–SELF. host.
Glossary microcode. A code representing the instructions of an instruction set that is implemented in a part of storage that is not program–addressable. MICROCODE_FILES paragraph. A paragraph within the SYSGEN configuration file that is used to indicate the location of the downloadable microcode for controllers and other devices. NAU. Network addressable unit. NCP. Network control program. network. A group of interconnected computer systems and devices, and the hardware and software used to connect them.
Glossary PERIPHERALS paragraph. A paragraph within the SYSGEN configuration file that is used to define the SNAX/XF $SSCP process (Service Manager) and the SNAX/XF lines. physical unit. That part of a device (hardware or software) that provides control functions for its own node and for the other less intelligent device nodes attached to the PU. pipelining. A session is pipelined if it can be accessed by more than one requester.
Glossary session. In SNA, a temporary logical connection between two NAUs for the purpose of exchanging data and control information in accordance with ground rules that have been agreed upon for that exchange. A session can be activated, tailored to provide various protocols, and deactivated, as requested. session passthrough. A SNAX/XF feature that allows the SNA host to control SNA devices on Tandem NonStop systems as if they were directly connected to the host. site update tape (SUT).
Glossary SSCP–SSCP session. In SNA, a session between the SSCP in one domain and the SSCP in another domain. An SSCP–SSCP session is used to initiate and terminate cross– domain LU–LU sessions. static passthrough. A passthrough mode that allows SLUs connected to a Tandem system to take the initiative in establishing sessions with host application programs. With static passthrough, the host SSCP can send USS messages to devices connected to a Tandem system. subsystem.
Glossary Systems Network Architecture Communications Services/Extended Facility (SNAX/XF). A Tandem software product that provides a gateway between Tandem NonStop systems and SNA systems and devices. With SNAX/XF, Tandem systems can function as fully integrated components of an SNA network. SNAX/XF allows SNA devices attached to a NonStop system either directly or through a switched line to use Tandem applications.
Glossary (This page left intentionally blank) Glossary–10 104708 Tandem Computers Incorporated
Index A ABORT command 7-6 ABORT SESSION command, security of 2-1, 5-1 ALTER command 7-8 Application, naming rules 4-1 Applications, relationship to SNAX/HLS 2-1 Asterisk (*), wild–card character 4-3 C Chaining protocol, token 6-12 Chains (single–RU or multiple–RU), token 6-13 Command buffer, sizes 7-1 Command summary 7-2 Commands programmatic, introduction to 2-1 SNAX/HLS subsystem 7-1 Common definitions 6-1 Common kernel, standard definitions 6-6 Critical events 8-2 D Data compression, token 6-14 Data–comm
Index Event Management Service (EMS), support in SNAX/HLS 2-2 Event management strategies 8-3 Event message descriptions 8-3 Event messages collecting 2-2 subjects of 4-7 ZHLS–TKN–MU 6-57 F Files, SNAX/HLS subsystem definition 4-1 G GETVERSION command 7-11 H Half–session protocols, extensible structured token 6-11 Hierarchy, of SNAX/HLS subsystem objects 4-2 I INFO command 7-13 for SNAX/HLS process 7-14 for SNAX/HLS session 7-20 L LISTOBJECTS command 7-23 LISTOPENS command 7-25 M Management functions 1-1 M
Index O Object names 4-2 summary states 4-6 types, SNAX/HLS subsystem 4-1 Objects commands that affect 7-3 of SNAX/HLS subsystem 4-1, 4-7 referencing 4-3 Object–name templates 4-3 P Pacing window, token 6-12 Potentially critical events 8-2 PROCESS object type 4-1 Programming considerations, event management 8-3 Q Question mark (?), wild–card character 4-3 R Receive status, extensible structured token 6-15 Request mode, token 6-14 RESETSTATS command 7-28 S Security 2-1 highest level 5-1 medium level 5-1 non
Index SNAX/HLS errors A-1 ZHLS–ERR– ALLOC–SEG–RDT A-4 BAD–RDT–DEV A-2 NO–TRACE–FILE A-6 OLD–RDT–VSN A-3 TRACE–FILE–ERR A-7 TRACING–ACT A-5 SNAX/HLS manager process, communicating with 3-1 SNAX/HLS response buffers 7-3 SNAX/HLS subsystem definition files 4-1 relationship to applications 2-1 security 5-1 standard definitions 6-11 SNAX/HLS subsystem commands 7-5 SPI See Subsystem Programmatic Interface Standard definitions data communications 6-4 EMS 6-4 SNAX/HLS 6-11 SPI 6-1 ZCMK 6-6 STARTED summary state 4-
Index Subsystem Programmatic Interface naming rules for applications 4-1 object hierarchy 4-2 object names 4-2 object summary states 4-6 objects types 4-1 object–name templates 4-3 referencing objects 4-3 standard definitions 6-1 SUB modifier 4-5 ZCOM–TKN–SUB 4-5 SUSPENDED summary state 4-7 SWITCH command 7-35 SWITCH PROCESS command, security of 2-1 T TELL command 7-37 TRACE command 7-39 of session 7-42 W Wild–card characters, in object name templates 4-3 Z ZACCEPT–BIND 6-33 ZCMK-TKN– CHFILE–MAPNAME 6-8 CH
Index ZCMK–MAP– ALTER 6-10 INFO 6-10, 7-16 LISTOP 6-10, 7-27 STATS–BUF 6-10 STATS–MEM 6-10 STATS–OPNR 6-10 STATS–RECV 6-10 ZCMK–MAP–LISTOP 7-26 ZCMK–TKN– ALTER–BKUP–CPU 6-8, 7-9 BKUP–STATE 6-8 CHMAP–BANNER 6-8, 7-16 CHMAP–FILE–MOD 6-8, 7-16 CHMAP–NAME 6-8, 7-9, 7-17, 7-22 CHMAP–NOTE 6-8, 7-17, 7-22 CHMAP–XFNAME 6-8, 7-9, 7-17 CMD–CODE 6-10 CPU 6-10 EMS–XFNAME 6-8, 7-9, 7-17 EMS–XFNAME–1 7-10, 7-17 EMS–XFNAME–2 7-10, 7-17 EMS–XFNAME–3 6-9, 7-10, 7-17 FILE–ROLE 6-10 FNUM 6-10 LIB–FILE–MOD 6-9, 7-17 LIB–XFNAM
Index ZCMK–TKN– (continued) TKOVR–CNT 6-9 XFNAME 6-11, 8-5, 8-27 XPNAME 6-11 ZCMK–TKN–LISTOP–QUALIFS 7-26 ZCMK–TKN–LISTOP–XPNAME 7-26 ZCMK–TKN–PROG– FILE–MOD 7-18 ZCMK–TKN–SEGTYPE 7-26 ZCMK–VAL–FILE–ROLE– BKUP–PROC 6-6 EMS 6-6 EMS–1 6-6 EMS–2 6-6 EMS–3 6-6 IN 6-6 MEM–SWAP 6-7 MSG 6-7 NULL 6-7 OUT 6-7 TRACE 6-7 ZCMK–VAL–SEGTYPE–CHFILE 6-7 ZCMK–VAL–SEGTYPE–LOPNS 6-7 ZCOM data–communications errors A-8 ZCOM–, standard definitions 6-4 ZCOM–CMD– ABORT 7-6 ALTER 7-8 GETVERSION 7-11 INFO 7-13 LISTOBJECTS 7-23 LIS
Index ZCOM–OBJ–SESSION 4-5 ZCOM–TKN– OBJNAME 6-4 OBJTYPE 6-5 SEL–SUMSTATE 4-5, 6-5 SUB 6-5 enumerated values 4-5 SUBJ–PROC 6-5 SUBJ–SESS 6-5 SWITCH–CPU 6-5 ZCOM–VAL–SUB– ALL 4-5 NONE 4-5 ONLY 4-5 ZEMS–, standard definitions 6-4 ZEMS–TKN– CONSOLE–PRINT 6-4 EVENTNUMBER 6-4 ZFIL definition files 4-1 ZGRD definition files 4-1 ZHLS definition files 4-1 ZHLS–DDL– HS–PROTO 6-11 INFO–PROC–CUST 6-23 INFO–SESS 6-25 SEND–RECV–STATUS 6-15 STATUS–SESS 6-37 TRACE–CTL 6-55 TRACE–OPT 6-56 ZFLAGS 7-16 ZHLS–EVT– BAD–RDT–DEV
Index ZHLS–EVT– (continued) RECV–DATA–OVERRUN 8-28 TOO–MANY–POCB–LUS 8-30 UNEXP–PR–RECVED 8-33 ZHLS–MAP– INFO–PROC–CUST 7-18 description of 6-23 structure of 6-23 INFO–SESS 7-22 description of 6-25 structure of 6-25 INFO–SESS–PRI 7-22 description of 6-34 structure of 6-34 INFO–SESS–SEC 7-22 definition of 6-34 structure of 6-35 STATS–PROC–SESS description of 6-36 structure of 6-36 STATUS–SESS description of 6-37 structure of 6-37 STATUS–SESS–RECV description of 6-43, 6-49 structure of 6-43, 6-49 STATUS–SESS
Index ZHLS–TKN– INFO–PROC–RDT–BANNER 6-21, 7-18 MAX–LUS 8-30, 8-31 MAX–POCBS 8-31 MAX–TBLS 8-30, 8-32 MU 8-11, 8-14, 8-16, 8-20, 8-23 MUT 8-11, 8-14, 8-16, 8-20, 8-23 POCB–SIZE 8-30, 8-32 RDT–FILE–MOD 6-21, 7-18 RDT–XFNAME 6-21, 7-10, 7-18 SSCP–TEXT–SIZE 7-10, 7-18 TCB–SIZE 8-30, 8-31 TELL–TEXT 6-22 TEXT–SIZE 6-23 TRACE–XFNAME 6-22, 7-18 TWO–STEP 6-22 TWO–STEP–SIZE 7-10, 7-18 ZHLS–VAL– ALTCODE–ID– ASCII–7 6-26 ASCII–8 6-26 BID–REJECTION– AUTO 6-33 NO–RTR 6-33 USER 6-33 BIND–DATA– ALL 6-32 NONE 6-32 USER–DA
Index ZHLS–VAL– (continued) OPEN–MODE– ACCEPT 6-30 ACQUIRE 6-30 RECOV–MODE– LOSER 6-30 SYMM 6-30 RQ–MODE– DELAYED 6-14 IMM 6-14 SEND–RECV– FDUX 6-31 HDUX–CONT 6-31 HDUX–FF 6-31 SSID 6-20 VERSION 6-21 ZHLS–VAL–CHAIN–PROTO– ANY 6-13 DEF 6-13 EXCPT 6-13 NONE 6-13 ZHLS–VAL–CHAIN–USE– MULTI 6-14 SINGL 6-14 ZHLS–VAL–FSM– BSM– BETB 6-40 INB 6-40 NULL 6-40 P–BB 6-40 P–INB 6-40 P–TERM–R 6-40 P–TERM–S 6-40 CBSM–RSP– INC 6-17, 6-45, 6-51 NEG–SEEN 6-17, 6-45, 6-51 NULL 6-17, 6-45, 6-51 RESET 6-17, 6-45, 6-51 104708 T
Index ZHLS–VAL–FSM– (continued) CHAIN– BETC 6-16, 6-44, 6-50 INC 6-16, 6-44, 6-50 NULL 6-16, 6-44, 6-50 PURGE 6-16, 6-44, 6-50 CHDX–RSP– INC 6-17, 6-45, 6-51 NEG–SEEN 6-17, 6-45, 6-51 NULL 6-17, 6-46, 6-51 RESET 6-17, 6-46, 6-51 DT– ACTV 6-38 NULL 6-38 P–ACTV 6-38 RESET 6-38 EBCD– INC 6-18, 6-46, 6-52 NULL 6-18, 6-46, 6-52 RESET 6-18, 6-46, 6-52 HDX– CONT 6-41 CONT–RECV 6-41 CONT–SEND 6-41 ERP–RECV 6-41 ERP–SEND 6-41 INB–RECV 6-41 INB–SEND 6-41 NULL 6-42 RECV–081B 6-42 IMM–RQ– DR–CNCL 6-18, 6-46, 6-52 DR–N
Index ZHLS–VAL–FSM– (continued) RTR– NULL 6-42 PEND 6-42 RESET 6-42 SBI– NOBB 6-20, 6-48, 6-54 NULL 6-20, 6-48, 6-54 P–NOBB 6-20, 6-48, 6-54 RESET 6-20, 6-48, 6-54 SESS– ACTV 6-38 NULL 6-39 P–ACTV 6-39 P–RESET 6-39 RESET 6-39 SHUTD– NULL 6-42 P–SHUTC 6-42 QUIESCED 6-43 RESET 6-43 STSN– NULL 6-39 PEND 6-39 RESET 6-39 ZSPI-TKNSEGLIST 6-2 SEGMENTATION 6-2 ZSPIDEF subvolume 4-1 ZSPI–, standard definitions 6-1 ZSPI–SSN–ZHLS 6-1 104708 Tandem Computers Incorporated Index–13
Index ZSPI–TKN– ALLOW–TYPE 6-1 COMMAND 6-1 ERROR 6-1 MANAGER 6-2 MORE–DATA 6-2 OBJECT–TYPE 6-2 RESPONSE–TYPE 6-2 RETCODE 6-2 SERVER–BANNER 6-3 SERVER–VERSION 6-3 SSID 6-3 ZSPI–TKN–ALLOW 6-1 Index–14 104708 Tandem Computers Incorporated
