X25AM Management Programming Manual Abstract This manual is for programmers. It describes the management-programming interfaces to the X25AM subsystem and how to use them. Product Version X25AM F40 Supported Release Version Updates (RVUs) This manual supports G03.00 and all subsequent G-series RVUs until otherwise indicated in a new edition.
Document History Part Number Product Version Published 84135 X25AM C00 November 1987 17465 X25AM C20 March 1989 528037-001 X25AM F40 April 2004
X25AM Management Programming Manual Index Examples What’s New in This Manual vii Manual Information vii New and Changed Information About This Manual ix Who Should Use This Manual What’s in This Manual ix Related Manuals x Notation Conventions xi Figures Tables vii ix 1. Introduction Objects Controlled by the X25AM Subsystem Required Management Functions 1-1 Relationship with Other Subsystems 1-2 Architecture of the X25AM Subsystem 1-2 1-1 2.
3. Elements for SPI Messages for the X25AM Subsystem (continued) Contents 3. Elements for SPI Messages for the X25AM Subsystem (continued) Components of a Command 3-6 Components of a Response 3-6 Components of an Event Message 3-6 4. SPI Programming Considerations for the X25AM Subsystem Building the Command Buffer 4-1 Discontinuing a Command in Progress 4-2 Receiving and Decoding the Response Buffer Error Handling 4-3 Security 4-3 4-2 5.
6. Commands and Responses (continued) Contents 6. Commands and Responses (continued) GETVERSION Command 6-64 INFO Command 6-67 LISTOBJECTS Command (All Objects) 6-88 LISTOBJECTS Command (Lines or Subdevices) RESETSTATS Command 6-95 START Command 6-110 STATISTICS Command 6-114 STATUS Command 6-128 STOP Command 6-137 SWITCH Command 6-141 TRACE Command 6-145 Examples of Commands and Responses 6-149 6-91 7.
7. Event Management (continued) Contents 7. Event Management (continued) 147: ZX25-EVT-CSS-PROBE-ERROR 7-44 152: ZX25-EVT-CSS-CLB-CMD-REJECT 7-47 156: ZX25-EVT-CSS-NO-RESPONSE 7-49 157: ZX25-EVT-CSS-FRAME-ERROR 7-51 158: ZX25-EVT-CSS-UNEXPECTED-BKPT 7-53 160: ZX25-EVT-CSS-LIU-CONFIG-ERROR 7-55 220: ZX25-EVT-CALL-TIMEOUT 7-57 224: ZX25-EVT-SVC-OUT-OF-ORDER 7-59 225: ZX25-EVT-PVC-OUT-OF-ORDER 7-61 226: ZX25-EVT-LCN-OPERATIONAL 7-63 229: ZX25-EVT-NO-MEMORY 7-65 Examples of Filters 7-66 A.
Tables (continued) Contents Tables (continued) Table 5-1. Table 5-2. Table 5-3. Table 6-1. Table 7-1. Table B-1. Table B-2.
Contents X25AM Management Programming Manual—528037-001 vi
What’s New in This Manual Manual Information X25AM Management Programming Manual Abstract This manual is for programmers. It describes the management-programming interfaces to the X25AM subsystem and how to use them. Product Version X25AM F40 Supported Release Version Updates (RVUs) This manual supports G03.00 and all subsequent G-series RVUs until otherwise indicated in a new edition.
What’s New in This Manual • • ° ° New and Changed Information 95 on page 7-2 96 on page 7-2 Added the event-message descriptions for these new events: ° ° ° ° ° ° 91: ZX25-EVT-SU-CLR-IND on page 7-27 92: ZX25-EVT-SU-CLR-REQ on page 7-28 93: ZX25-EVT-LINE-SUSPEND on page 7-29 94: ZX25-EVT-LINE-IS-NOT-READY on page 7-29 95: ZX25-EVT-ACTIVEPATH-ISSUED on page 7-30 96: ZX25-EVT-FRMR-OCCURED on page 7-31 Rebranded, and updated for new release terminology and manual titles.
About This Manual This manual provides subsystem-specific programming information about the management-programming interface provided by HP for managing the X25AM subsystem. This interface is based on the Subsystem Programmatic Interface (SPI) and the Event Management System (EMS). This manual serves as both a reference manual and a programmer's guide for the development of management applications that use the X25AM subsystem.
Related Manuals About This Manual Table i. Summary of Contents (page 2 of 2) Section 7, Event Management Describes the event messages that the X25AM subsystem can issue and the specific programming considerations for dealing with X25AM event messages in an application. Section A, Error Numbers and Error Lists Describes the error numbers that are provided by the X25AM subsystem (that is, the values whose symbolic names begin with ZX25-ERR-).
Notation Conventions About This Manual Notation Conventions Hypertext Links Blue underline is used to indicate a hypertext link within text. By clicking a passage of text with a blue underline, you are taken to the location described. For example: This requirement is described under Backup DAM Volumes and Physical Disk Drives on page 3-2. General Syntax Notation This list summarizes the notation conventions for syntax presentation in this manual. UPPERCASE LETTERS.
General Syntax Notation About This Manual { } Braces. A group of items enclosed in braces is a list from which you are required to choose one item. The items in the list can be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines. For example: LISTOPENS PROCESS { $appl-mgr-name } { $process-name } ALLOWSU { ON | OFF } | Vertical Line.
Notation for Messages About This Manual a blank line. This spacing distinguishes items in a continuation line from items in a vertical list of selections. For example: ALTER [ / OUT file-spec / ] LINE [ , attribute-spec ]… !i and !o. In procedure calls, the !i notation follows an input parameter (one that passes data to the called procedure); the !o notation follows an output parameter (one that returns data to the calling program).
Notation for Management Programming Interfaces About This Manual lowercase italic letters. Lowercase italic letters indicate variable items whose values are displayed or returned. For example: p-register process-name [ ] Brackets. Brackets enclose items that are sometimes, but not always, displayed.
Change Bar Notation About This Manual UPPERCASE LETTERS. Uppercase letters indicate names from definition files. Type these names exactly as shown. For example: ZCOM-TKN-SUBJ-SERV lowercase letters. Words in lowercase letters are words that are part of the notation, including Data Definition Language (DDL) keywords. For example: token-type !r. The !r notation following a token or field name indicates that the token or field is required. For example: ZCOM-TKN-OBJNAME !o. token-type ZSPI-TYP-STRING.
Change Bar Notation About This Manual X25AM Management Programming Manual—528037-001 xvi
1 Introduction X.25, a recommendation of the International Telegraph and Telephone Consultive Committee (CCITT), is an international standard for packet-switching networks that defines the relationship between data terminal equipment (DTE) and data circuitterminating equipment (DCE). HP provides a software package called the X.25 Access Method (X25AM), that manages remote data communications in a packet-switching mode. Once X25AM is installed on your system, you can connect to public X.
Relationship with Other Subsystems Introduction • • • • • Clear virtual circuits. Obtain statistics about the execution history of lines and subdevices. Reinitialize the counters used to save statistics for lines and subdevices. Obtain the names of lines and subdevices known to the subsystem. Trace the actions of lines. Relationship with Other Subsystems No other subsystems control the objects that the X25AM subsystem controls.
Introduction • • • • Architecture of the X25AM Subsystem The Communications Management Interface (CMI), which can be used to configure, control, and collect information from the X25AM subsystem. The Communications Utility Program (CUP), which allows you to obtain statistics and status information about X25AM lines and subdevices; alter the attributes of lines, subdevices, and line-handler processes; add and delete subdevices; start and stop subdevices; and clear virtual circuits.
Introduction Architecture of the X25AM Subsystem X25AM Management Programming Manual—528037-001 1 -4
2 Management Programming for the X25AM Subsystem As explained in Section 1, Introduction, there are several different interfaces, both interactive and programmatic, to the X25AM subsystem.
Management Programming for the X25AM Subsystem How Applications Fit into the Architecture How Applications Fit into the Architecture An application uses the control-and-inquiry interface to the X25AM subsystem by sending requests (commands) to and receiving responses from SCP. An application uses the Event Management System (EMS) to retrieve event messages generated by the X25AM subsystem by sending commands to and receiving responses from an EMS distributor process. Figure 2-1.
Management Programming for the X25AM Subsystem Commands an Application Can Issue Table 2-1. X25AM Programmatic Commands (page 2 of 2) DISCONNECT Clears a virtual circuit set up by a call request. FORBIDOPENS Prevents subdevices from being opened by other applications. GETVERSION Returns the server version of the X25AM subsystem. INFO Returns the current values of the attributes of a line and subdevices. LISTOBJECTS Returns the names of a line and subdevices known to the X25AM subsystem.
Management Programming for the X25AM Subsystem Commands an Application Can Issue Table 2-2.
Management Programming for the X25AM Subsystem Commands an Application Can Issue Table 2-3.
Management Programming for the X25AM Subsystem Event Messages Table 2-3. CMI Commands and Programmatic Commands (page 2 of 2) CMI Command and Object Type Programmatic Command and Object Type None ZCOM-CMD-STOP ZCOM-OBJ-LINE STOP SUBDEVICE ZCOM-CMD-STOP ZCOM-OBJ-SU TRACE LINE ZCOM-CMD-TRACE ZCOM-OBJ-LINE Event Messages In addition to sending commands and receiving responses, a management application can obtain notification of events that occur in the X25AM subsystem.
3 Elements for SPI Messages for the X25AM Subsystem The Subsystem Programmatic Interface (SPI) is used for building commands to, decoding responses from, and obtaining event messages issued by the X25AM subsystem. The procedures used by an application to perform these tasks are described in the SPI Programming Manual. Using SPI messages to communicate with the X25AM subsystem through SCP is described in the SPI Common Extensions Manual.
Elements for SPI Messages for the X25AM Subsystem Naming Rules and Guidelines for Applications TAL programmers should always source in the entire definition file, and TACL always loads the entire definition file. For further information on how definition files are accessed by an application, see the SPI Programming Manual. An application that communicates with the X25AM subsystem needs the following definition files in the appropriate programming language: 1. The SPI definition file. 2.
Elements for SPI Messages for the X25AM Subsystem Command Numbers Command Numbers In the X25AM subsystem, command numbers are represented by symbolic names of the form ZCOM-CMD- name, where name identifies the command. The X25AM subsystem supports the following commands: ABORT LISTOBJECTS ADD RESETSTATS ALLOWOPENS START ALTER STATISTICS DELETE STATUS DISCONNECT STOP FORBIDOPENS SWITCH GETVERSION TRACE INFO These commands are described in Section 6, Commands and Responses.
Elements for SPI Messages for the X25AM Subsystem Event Numbers a subdevice name is always qualified by the name of its line; that is, preceded by the name of its line and a period (.). An example of a valid subdevice name is "$LN01.#ITI5". There is no object name associated with the null object type. Some X25AM commands accept multiple object names. In addition, some X25AM commands accept or even require the subordinate-modifier token, ZCOM-TKN-SUB.
Elements for SPI Messages for the X25AM Subsystem Other Tokens Token Types The token types used by the X25AM subsystem are represented by symbolic names of the form subsys-TYP- name, where subsys is a four-character subsystem abbreviation and name identifies the token type. For example, the token type ZSPI-TYP-CHAR50 represents a string of 50 ASCII characters. The X25AM subsystem does not define any private token types; that is, no token types have names of the form ZX25-TYP- name.
Elements for SPI Messages for the X25AM Subsystem Constructs Involving Multiple Tokens name identifies the field type. For example, the field type ZSPI-DDL-BOOLEAN represents the Boolean data type. Throughout this manual, when a field is described, its field type is given. Constructs Involving Multiple Tokens The X25AM subsystem supports data lists and error lists as described in the SPI Programming Manual. Components of a Command This topic is discussed in the SPI Common Extensions Manual.
4 SPI Programming Considerations for the X25AM Subsystem The SPI Common Extensions Manual discusses general programming considerations for writing applications that use the Subsystem Programmatic Interface (SPI) to communicate with data communications subsystems like the X25AM subsystem. This section discusses SPI programming considerations that are specific to the X25AM subsystem.
SPI Programming Considerations for the X25AM Subsystem Discontinuing a Command in Progress will continue to work if it is compiled with new definition files that add new fields to the token. The only tokens that can appear more than once in an X25AM command are ZSPITKN-COMMENT, ZCOM-TKN-OBJNAME, and ZCOM-TKN-TRACE-OPT. ZSPI-TKNCOMMENT is the comment token, described in the SPI Programming Manual. ZCOMTKN-OBJNAME is the object-name token, described in Section 5, Common Definitions.
SPI Programming Considerations for the X25AM Subsystem Error Handling The X25AM subsystem also supports the use of the token ZSPI-TKN-RESPONSETYPE, which allows an application to specify, in a command operating on multiple objects, which kinds of response records should be returned--one for every object, or only those for objects on which errors or warnings occurred. If no value is specified for this token, the X25AM subsystem returns a response record for every object.
SPI Programming Considerations for the X25AM Subsystem X25AM Management Programming Manual—528037-001 4 -4 Security
5 Common Definitions The management-programming interfaces to the X25AM subsystem make use of definitions from four different sources: the SPI standard definitions, the EMS standard definitions, the data communications standard definitions, and the X25AM definitions. This section discusses the definitions from these four sources that can be used in a management application to communicate with the X25AM subsystem.
SPI Standard Definitions Common Definitions Table 5-1.
SPI Standard Definitions Common Definitions Table 5-1. SPI Standard Definitions Used by the X25AM Subsystem (page 2 of 2) ZSPI-DDL-ENUM ZSPI-DDL-FNAME ZSPI-DDL-FNAME32 ZSPI-DDL-INT ZSPI-DDL-INT-PAIR ZSPI-DDL-INT2 ZSPI-DDL-TIMESTAMP ZSPI-DDL-UINT All SPI standard definitions are fully described in the SPI Programming Manual. Information about these definitions that is specific to the X25AM subsystem is given below. ZSPI-SSN-ZX25 is the subsystem number assigned to the X25AM subsystem.
EMS Standard Definitions Common Definitions ZSPI-TKN-SERVER-VERSION contains the server version of the X25AM subsystem. ZSPI-TKN-SSID contains ZX25-VAL-SSID, the subsystem ID of the X25AM subsystem. ZX25-VALSSID has the following structure definition: def ZX25-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. 02 Z-NUMBER type ZSPI-DDL-INT value is ZSPI-SSN-ZX25. 02 Z-VERSION type ZSPI-DDL-UINT value is ZX25-VAL-VERSION. end.
Data Communications Standard Definitions Common Definitions Table 5-2. EMS Standard Definitions Used by the X25AM Subsystem (page 2 of 2) ZEMS-TKN-USERID Extensible Structured Tokens ZEMS-MAP-EXIOADDR All EMS standard definitions are fully described in the EMS Manual. Information about these definitions that is specific to the X25AM subsystem is given below.
Data Communications Standard Definitions Common Definitions Table 5-3.
Data Communications Standard Definitions Common Definitions ZCOM-OBJ-LINE is a data communications line connected through a modem to an X.25 network. ZCOM-OBJ-NULL does not represent an X25AM object. It is used as the object type in commands that do not require an object-name token. ZCOM-OBJ-PROCESS is an X25AM line-handler process running on a NonStop system. ZCOM-OBJ-SU is an X25AM subdevice that can be opened in the GUARDIAN environment. ZCOM-TKN-OBJNAME contains the name of an X25AM object.
Data Communications Standard Definitions Common Definitions Some X25AM commands require that this token appear and that it have the value ZCOM-VAL-SUB-ONLY. ZCOM-TKN-SWITCH-CPU indicates that the ALTER PROCESS command or the SWITCH command is to switch a process between processors, and which processor to switch to. For more information, refer to the descriptions of these commands in Section 6, Commands and Responses.
Common Definitions for the X25AM Subsystem Common Definitions ZCOM-VAL-SUMSTATE-DIAG is a value of the field ZSTATE of the extensible structured tokens ZX25-MAPSTATUS-LINE and ZX25-MAP-STATUS-SU. It indicates that an X25AM line or subdevice is in the DIAGNOSING summary state. For more information, see the STATUS command in Section 6, Commands and Responses. ZCOM-VAL-SUMSTATE-STARTED is a value of the field ZSTATE of the extensible structured tokens ZX25-MAPSTATUS-LINE and ZX25-MAP-STATUS-SU.
Private Token and Field Types Common Definitions def ZX25-DDL-MSG-BUFFER. 02 Z-MSGCODE type ZSPI-DDL-INT. 02 Z-BUFLEN type ZSPI-DDL-UINT. 02 Z-OCCURS type ZSPI-DDL-UINT. 02 Z-FILLER type ZSPI-DDL-BYTE occurs 0 to ZX25-VAL-BUFLEN times depending on Z-OCCURS. end. ZX25-DDL-MSG-MAXBUFFER is a message buffer whose size is that recommended for responses in which each reply message contains multiple response records. def ZX25-DDL-MSG-MAXBUFFER. 02 Z-MSGCODE type ZSPI-DDL-INT. 02 Z-BUFLEN type ZSPI-DDL-UINT.
Predefined Token and Field Values Common Definitions Predefined Token and Field Values The X25AM subsystem defines the following token and field values. ZX25-VAL-BUFLEN is the recommended buffer size in bytes for command messages sent to the X25AM subsystem and for responses in which each reply message contains a single response record. ZX25-VAL-EVT-BUFLEN is the buffer size in bytes for event messages issued by the X25AM subsystem.
Tokens in Error Lists Common Definitions Tokens in Error Lists The error numbers defined by the X25AM subsystem are described in Section A, Error Numbers and Error Lists. Tokens in Event Messages The tokens defined by the X25AM subsystem that appear in X25AM event messages are described in Section 7, Event Management.
6 Commands and Responses This section describes the syntax and semantics for all commands and responses in the programmatic control-and-inquiry interface to the X25AM subsystem.
Commands and Responses Table 6-1.
Commands by Object Type Commands and Responses Commands by Object Type The following X25AM commands accept the LINE object type: ABORT RESETSTATS ALLOWOPENS START ALTER STATISTICS DELETE STATUS FORBIDOPENS STOP INFO SWITCH LISTOBJECTS TRACE The following commands accept the NULL object type: GETVERSION LISTOBJECTS The following commands accept the PROCESS object type: ALTER SWITCH The following commands accept the SUBDEVICE object type: ABORT INFO ADD LISTOBJECTS ALLOWOPENS RESETSTA
Command Descriptions Commands and Responses ALTER STOP DELETE SWITCH DISCONNECT TRACE Nonsensitive commands do not change the summary state of an object, and these commands can be issued by any user. The following X25AM commands are nonsensitive commands: GETVERSION STATISTICS INFO STATUS LISTOBJECTS Command Descriptions On the following pages, each X25AM command and its response is described in detail. The command descriptions appear in alphabetical order.
Commands and Responses Command Descriptions other than its null value, and no notation means that the field may or may not have a value other than its null value. Data lists and error lists are indicated in the box by following each of the tokens ZSPITKN-DATALIST and ZSPI-TKN-ERRLIST, respectively, by an ellipsis (...) and the token ZSPI-TKN-ENDLIST. The token ZSPI-TKN-ENDLIST is indented to show that it is present only if the list token is present.
ABORT Command Commands and Responses ABORT Command The ABORT command terminates the operation of lines and subdevices as quickly as possible--only enough processing is done to ensure the integrity of the subsystem. Command ZCOM-CMD-ABORT Object Type ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-STRING. !{} token-type ZSPI-TYP-TIMESTAMP. ZCOM-MAP-REQID def ZCOM-DDL-REQID.
ABORT Command Commands and Responses Tokens in Command Buffer ZSPI-TKN-MANAGER is a standard SPI manager token that contains the name of an X25AM line. This token is not required to be present in the command, and duplicate occurrences are not allowed. ZSPI-TKN-MANAGER is described in Section 5, Common Definitions. ZCOM-TKN-OBJNAME is an object-name token that indicates which lines and subdevices are to be terminated. This token must be present in the command.
ABORT Command Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST is a standard SPI data list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST. ZCOM-TKN-OBJNAME is an object-name token that contains the name of a line or subdevice that was terminated by the command. If there is no error, this token is present in every response record. ZCOM-TKN-OBJNAME is described in Section 5, Common Definitions.
Commands and Responses ABORT Command ZSPI-TKN-ERRLIST is a standard SPI error list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST. ZSPI-TKN-CONTEXT is the standard SPI context token described in the SPI Programming Manual. Operational Notes • • • • • • • ABORT is a sensitive command. The lines and subdevices are placed in the STOPPED summary state.
ADD Command Commands and Responses ADD Command The ADD command adds a subdevice to the X25AM subsystem. Command ZCOM-CMD-ADD Object Type ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32. ZX25-MAP-ADD-SU def ZX25-DDL-ADD-SU.
ADD Command Commands and Responses 02 ZRMT-NET 02 ZREXMIT-TIMEOUT 02 ZREVRS-CHG 02 ZTHRUPUT 02 02 02 02 02 02 02 02 02 ZLOCAL-ADDR-EXT ZREMOTE-ADDR-EXT ZLOCAL-ADDR-EXT-TYPE ZREMOTE-ADDR-EXT-TYPE ZPAGE6520-BLOCK-SIZE ZAUTO-DEL-SU ZCUG-TYPE ZBCUG ZRPOA 02 ZRPOA-DNIC-CNT 02 ZTRANSIT-DELAY end. ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT type ZSPI-DDL-ENUM. type ZSPI-DDL-TIMESTAMP. type ZSPI-DDL-BOOLEAN spi-null 0. type ZSPI-DDL-INT-PAIR spi-null 255. type ZSPI-DDL-CHAR40. type ZSPI-DDL-CHAR40.
ADD Command Commands and Responses Tokens in Command Buffer ZSPI-TKN-MANAGER is a standard SPI manager token that contains the name of an X25AM line. This token is not required to be present in the command, and duplicate occurrences are not allowed. ZSPI-TKN-MANAGER is described in Section 5, Common Definitions. ZX25-MAP-ADD-SU is an extensible structured token that describes the attribute values for the added subdevice. It has the token number ZX25-TNM-ADD-SU and the DDL definition ZX25-DDL-ADD-SU.
ADD Command Commands and Responses ZPROTO specifies the protocol to be used by the subdevice. This field is required and must be assigned one of the following values: ZX25-VAL-PROTO-ITI The Interactive Terminal Interface (ITI) protocol will be used. ZX25-VAL-PROTO-NAM The Network Access Method (NAM) protocol will be used. ZX25-VAL-PROTO-PTP The Process-to-Process (PTP) will be used. ZREC-SIZE specifies the maximum length in bytes of records sent or received by the subdevice.
ADD Command Commands and Responses by the value of the field ZCONV-PAD-CNT. PAD parameters are valid only if the protocol is ITI. ZCUG specifies the closed user group (CUG) identification that might be included as a facility in call-request packets. The value assigned to this field must be in the range 0 through 9999. If no value is assigned to this field, the value of the CUG identification attribute of the associated line is sent in call-request packets.
ADD Command Commands and Responses ZNEGOT-THRUPUT specifies whether or not a call-request packet containing an unacceptable value for the network-interface characteristic THRUPUT is accepted. This field can be assigned the following values: ZSPI-VAL-TRUE The call request is accepted, and a call-accept packet containing an acceptable value for THRUPUT is sent to the network. ZSPI-VAL-FALSE The call request is denied, and a call-cleared packet is sent to the network.
ADD Command Commands and Responses Parity checking is disabled by default. If enabled, parity checking is performed as specified by the value of the field ZPARITY. This field is valid only if the protocol is ITI. ZPORT specifies the logical port number to be used by the subdevice. This field can be assigned a value in the range 0 through 9999; the default value is 0. ZPRI-CALL specifies whether or not the capability of making priority calls is enabled. This field applies only to DATAPAC.
ADD Command Commands and Responses ZX25-VAL-NETID-X25 The addressing conventions of the generic netid X25 are used. ZX25-VAL-NETID-X25NP The addressing conventions of the generic netid X25NP are used. ZX25-VAL-NETID-X25SA The addressing conventions of the generic netid X25SA are used. ZX25-VAL-NETID-X25UD The addressing conventions of the generic netid X25UD are used. ZX25-VAL-NETID-X25XA The addressing conventions of the generic netid X25XA are used.
ADD Command Commands and Responses This field can be assigned the following values: 0 Full NSAP 1 Reserved 2 Non-OSI 3 Reserved ZREMOTE-ADDR-EXT-TYPE specifies the status of ZREMOTE-ADDR-EXT. This field can be assigned the following values: 0 Full NSAP 1 Reserved 2 Non-OSI 3 Reserved ZPAGE6520-BLOCK-SIZE specifies the block size used in the ITI protocol. This modifier supports terminals that emulate the HP 6520 or 6530 terminal with a nonstandard block size in block mode.
Commands and Responses ADD Command ZBCUG specifies the bilateral closed user group ID sent in every call-request packet. The range is 0 through 9999. RESET means no BCUG is assigned and BCUG has the value -1. ZRPOA specifies the Recognized Private Operating Agency (RPOA) transit network(s) in the facility field of a call-request packet. An RPOA transit network is indicated by the Data Network Identification Code (DNIC), which is an integer in the range 0 through 9999.
ADD Command Commands and Responses ZCOM-TKN-OBJNAME is an object-name token that contains the name of the subdevice that was added by the command. If there is no error, this token is present in every response record. ZCOM-TKN-OBJNAME is described in Section 5, Common Definitions. ZCOM-TKN-OBJTYPE is an object-type token that contains the value ZCOM-OBJ-SU. This token is present in every response record, and it is described in the SPI Common Extensions Manual.
Commands and Responses ADD Command Operational Notes • • • • ADD is a sensitive command. A subdevice that is successfully added is in the STARTED summary state. The name given to an added subdevice must be unique. Subdevices can be removed from the X25AM subsystem by using the DELETE command.
ALLOWOPENS Command Commands and Responses ALLOWOPENS Command The ALLOWOPENS command allows the designated subdevices to be opened by applications other than the issuing application. Command ZCOM-CMD-ALLOWOPENS Object Type ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-STRING. !{} token-type ZSPI-TYP-TIMESTAMP. ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. type ZSPI-DDL-CRTPID.
Commands and Responses ALLOWOPENS Command Tokens in Command Buffer ZSPI-TKN-MANAGER is a standard SPI manager token that contains the name of an X25AM line. This token is not required to be present in the command, and duplicate occurrences are not allowed. ZSPI-TKN-MANAGER is described in Section 5, Common Definitions. ZCOM-TKN-OBJNAME is an object-name token that indicates which subdevices are to be affected by this command. This token must be present in the command.
Commands and Responses ALLOWOPENS Command Tokens in Response Buffer ZSPI-TKN-DATALIST is a standard SPI data list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST. ZCOM-TKN-OBJNAME is an object-name token that contains the name of a subdevice that was affected by the command. If there is no error, this token is present in every response record. ZCOM-TKN-OBJNAME is described in Section 5, Common Definitions.
Commands and Responses ALLOWOPENS Command ZSPI-TKN-CONTEXT is the standard SPI context token described in the SPI Programming Manual. Operational Notes • • • • ALLOWOPENS is a sensitive command. The line must not be in the DIAGNOSING summary state when this command is issued. To open a subdevice exclusively, so that other applications are unable to open it, use the FORBIDOPENS command. No summary-state transition is associated with this command.
ALTER LINE Command Commands and Responses ALTER LINE Command The ALTER LINE command changes the values of the attributes of an X25AM line. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-LINE Tokens in Command Buffer ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32. ZX25-MAP-ALTER-LINE def ZX25-DDL-ALTER-LINE.
ALTER LINE Command Commands and Responses 02 ZBCUG 02 ZRPOA 02 ZRPOA-DNIC-CNT 02 ZTRANSIT-DELAY end. ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT type ZSPI-DDL-INT. type ZSPI-DDL-INT occurs 7 times. type ZSPI-DDL-INT. type ZSPI-DDL-TIMESTAMP. token-type ZSPI-TYP-STRING. !{} token-type ZSPI-TYP-TIMESTAMP. ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. ZSPI-TKN-MAXRESP ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-COMMENT type ZSPI-DDL-CRTPID. type ZSPI-DDL-INT.
ALTER LINE Command Commands and Responses attribute corresponding to that field. If no value is assigned to a field, the corresponding attribute is not altered. ZX25-MAP-ALTER-LINE contains the following fields: ZNETID specifies the X.25 Public Data Network (PDN) that the X25AM subsystem is communicating with. This value is used to establish the addressing conventions required by the network.
ALTER LINE Command Commands and Responses ZX25-VAL-NETID-X25SA The addressing conventions of the generic netid X25SA are used. This value corresponds to the SYSGEN modifier X25SA. ZX25-VAL-NETID-X25UD The addressing conventions of the generic netid X25UD are used. This value corresponds to the SYSGEN modifier X25UD. ZX25-VAL-NETID-X25XA The addressing conventions of the generic netid X25XA are used. This value corresponds to the SYSGEN modifier X25XA. ZSRC-ADDR specifies the X.
ALTER LINE Command Commands and Responses ZSPI-VAL-TRUE The network address is sent as the calling address in outgoing call-request packets. The port number is concatenated if needed. This value corresponds to the SYSGEN modifier SENDCALLINGADDR. ZSPI-VAL-FALSE A null calling address is sent in outgoing call-request packets. This value is intended for use with networks that fill in the DTE address when the DTE transmits a call request with a null calling address.
ALTER LINE Command Commands and Responses ZCONV-PAD-CNT specifies the number of parameter pairs that appear in the field ZCONV-PADPARAMS. This field can be assigned a value in the range 0 through 63, or the value -1. If the value is 0, it indicates that the conversational-mode PAD parameters are not to be altered. The value -1 must be used to clear all explicitly specified conversational-mode PAD parameters. This field has no corresponding SYSGEN modifier.
ALTER LINE Command Commands and Responses ZEXT-CALL-FORMAT specifies whether or not the reception of larger-than-normal packets using the fast-select feature is enabled. This field can be assigned the following values: ZSPI-VAL-TRUE The reception of larger-than-normal packets is enabled. This value corresponds to the SYSGEN modifier EXTFORMAT. The packet size must be greater than or equal to 256. ZSPI-VAL-FALSE The reception of larger-than-normal packets is disabled.
Commands and Responses ALTER LINE Command ZL3-WINDOW specifies the number of packets that can be outstanding without an acknowledgment from the network. If the modulus for the packet counters indicated by field ZL3-MOD is 8, ZL3-WINDOW can be assigned a value in the range 2 through 7; otherwise, it can be assigned a value in the range 1 through 15. This field corresponds to the SYSGEN modifier L3WINDOW. ZPROG specifies the file name of the program to be downloaded to the CLIP.
ALTER LINE Command Commands and Responses ZSYNCS specifies the number of SYN characters that will be transmitted before each frame. The value assigned to this field must be in the range 1 through 15. This field applies only to the 6201 controller, and it corresponds to the SYSGEN modifier SYNCS. ZTHRES specifies the number of frames to be sent and received before line quality is checked. This field corresponds to the SYSGEN modifier LINEQUALITYTHRESHOLD. ZCUG-TYPE specifies which CUG facility is selected.
Commands and Responses ALTER LINE Command ZTRANSIT-DELAY specifies the transit delay in the facility field of a call-request packet. The line TRANSITDELAY establishes a default value that is used when the subdevice TRANSITDELAY attribute is not specified. The value is in TIMESTAMP format with a range of 0 through 6553 hundredths of a second. ZCOM-TKN-OBJNAME is an object-name token that contains the name of the line whose attributes are to be altered.
ALTER LINE Command Commands and Responses Some values of RETCODE that are likely to occur in response to the ALTER LINE command are the following: -30 (ZCOM-ERR-TKN-VAL-INV): A supported token had an improper value. -17 (ZCOM-ERR-OBJ-NOT-FOUND): The specified object cannot be found. -14 (ZCOM-ERR-NO-MEM-SPACE): The X25AM subsystem cannot obtain enough memory space to process the command. -12 (ZCOM-ERR-MAX-LIMIT-EXCEEDED): A configuration limit or fixed limit was exceeded.
Commands and Responses ALTER LINE Command Error-Handling Notes • • The error identified by the error number ZCOM-ERR-NO-MEM-SPACE is returned if the block-mode or conversational-mode PAD parameters are to be altered and the X25AM subsystem cannot obtain enough memory space to perform the alteration. If an attempt is made to alter the attributes of a line that is not in the STOPPED summary state, the error identified by the error number ZCOM-ERR-CMD-INV-INSUMSTATE is returned.
ALTER PROCESS Command Commands and Responses ALTER PROCESS Command The ALTER PROCESS command changes the values of the attributes of an X25AM line-handler process. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-PROCESS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-SWITCH-CPU ZCOM-TKN-SWITCH-PATH ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-INT. !{A} ZSPI-TYP-ENUM. !{A} ZSPI-TYP-STRING.!{} ZSPI-TYP-TIMESTAMP.
ALTER PROCESS Command Commands and Responses Tokens in Command Buffer ZSPI-TKN-MANAGER is a standard SPI manager token that contains the name of an X25AM line. This token is not required to be present in the command, and duplicate occurrences are not allowed. ZSPI-TKN-MANAGER is described in Section 5, Common Definitions.
Commands and Responses ALTER PROCESS Command Tokens in Response Buffer ZSPI-TKN-DATALIST is a standard SPI data list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST. ZCOM-TKN-OBJNAME is an object-name token that contains the object name of the line-handler process whose attributes were altered by the command. If there is no error, this token is present in every response record. ZCOM-TKN-OBJNAME is described in Section 5, Common Definitions.
Commands and Responses ALTER PROCESS Command Operational Notes • • • • ALTER PROCESS is a sensitive command. The line controlled by the line-handler process must not be in the DIAGNOSING summary state when this command is issued. To determine which processor or CIU path is currently being used by a process, use the STATUS command on the line controlled by the process. No summary-state transition is associated with this command.
Commands and Responses ALTER SUBDEVICE Command ALTER SUBDEVICE Command The ALTER SUBDEVICE command changes the values of the attributes of a subdevice. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZX25-MAP-ALTER-SU def ZX25-DDL-ALTER-SU.
ALTER SUBDEVICE Command Commands and Responses 02 02 02 02 02 02 02 02 ZREMOTE-ADDR-EXT ZLOCAL-ADDR-EXT-TYPE ZREMOTE-ADDR-EXT-TYPE ZPAGE6520-BLOCK-SIZE ZAUTO-DEL-SU ZCUG-TYPE ZBCUG ZRPOA 02 ZRPOA-DNIC-CNT 02 ZTRANSIT-DELAY end. ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT type ZSPI-DDL-CHAR40. type ZSPI-DDL-INT. type ZSPI-DDL-INT. type ZSPI-DDL-INT. type ZSPI-DDL-INT. type ZSPI-DDL-INT. type ZSPI-DDL-INT. type ZSPI-DDL-INT occurs 7 times. type ZSPI-DDL-INT. type ZSPI-DDL-TIMESTAMP. token-type ZSPI-TYP-STRING.
ALTER SUBDEVICE Command Commands and Responses token must be present in the command, and duplicate occurrences are not allowed. There is a field in ZX25-MAP-ALTER-SU for each subdevice attribute that can be altered by the ALTER SUBDEVICE command. If a field of this token is assigned a value other than its null value, the ALTER SUBDEVICE command assigns that value to the attribute corresponding to that field. If no value is assigned to a field, the corresponding attribute is not altered.
ALTER SUBDEVICE Command Commands and Responses ZACCEPT-CHG specifies whether or not an incoming call request asking that the recipient pay the charge will be accepted. This field can be assigned the following values: ZSPI-VAL-TRUE Charges will be accepted. ZSPI-VAL-FALSE Charges will not be accepted. By default, charges will not be accepted. ZBLOCK-PAD-CNT specifies the number of parameter pairs that appear in the field ZBLOCK-PADPARAMS.
ALTER SUBDEVICE Command Commands and Responses outgoing call-request packets will have a zero-length called address, or it can contain a string of from 1 through 15 decimal-digit characters. ZFILLER acts as filler and is not associated with any subdevice attribute. ZNEGOT-L3-WINDOW specifies whether or not a call-request packet containing an unacceptable value for the network-interface characteristic L3WINDOW is accepted.
ALTER SUBDEVICE Command Commands and Responses ZNULL-FILL specifies whether or not the X25AM subsystem will send the string "EOT NUL" to set a terminal into block mode or conversational mode. This token can be assigned the following values: ZSPI-VAL-TRUE The first two characters in the five-character sequence that sets a terminal into block or conversational mode are "EOT NUL" (hex "0400").
Commands and Responses ALTER SUBDEVICE Command The capability of making priority calls is disabled by default. This field applies only to the DATAPAC network. ZPVC specifies the channel number of the Permanent Virtual Circuit (PVC) that the subdevice is bound with. This field can be assigned a value in the range 0 through 4095, or the value -1. The value -1 must be used to clear an explicitly specified PVC. The value must be within the line PVCRANGE.
ALTER SUBDEVICE Command Commands and Responses ZREXMIT-TIMEOUT specifies the amount of time a block-mode ITI terminal has in which to respond. This time interval is 20 seconds by default. ZREVRS-CHG specifies whether or not outgoing call requests will ask that the recipient pay the charges. This field can be assigned the following values: ZSPI-VAL-TRUE The recipient will be requested to pay the charges. ZSPI-VAL-FALSE The recipient will not be requested to pay the charges.
Commands and Responses ALTER SUBDEVICE Command ZPAGE6520-BLOCK-SIZE specifies the block size used in the ITI protocol. This modifier supports terminals that emulate the HP 6520 or 6530 terminal with a nonstandard block size in block mode. The range is 0 through 8000. The default is 256. ZAUTO-DEL-SU specifies that the PTP subdevice is automatically deleted when the last opener closes the subdevice. ZCUG-TYPE specifies which CUG facility is selected.
Commands and Responses ALTER SUBDEVICE Command ZTRANSIT-DELAY specifies the transit delay in the facility field of a call-request packet. The value is in TIMESTAMP format with a range of 0 through 6533 hundredths of a second. ZCOM-TKN-OBJNAME is an object-name token that contains the name of the subdevice whose attributes are to be altered. This token must be present in the command, and duplicate occurrences are not allowed. ZCOM-TKN-OBJNAME is described in Section A, Error Numbers and Error Lists.
Commands and Responses ALTER SUBDEVICE Command ZSPI-TKN-RETCODE is the standard SPI return token described in the SPI Programming Manual. Some values of RETCODE that are likely to occur in response to the ALTER SUBDEVICE command are the following: -17 (ZCOM-ERR-OBJ-NOT-FOUND): The specified object cannot be found. -14 (ZCOM-ERR-NO-MEM-SPACE): The X25AM subsystem cannot obtain enough memory space to process the command.
DELETE Command Commands and Responses DELETE Command The DELETE command removes subdevices from the X25AM subsystem. Command ZCOM-CMD-DELETE Object Type ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-STRING. !{} token-type ZSPI-TYP-TIMESTAMP. ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. type ZSPI-DDL-CRTPID. type ZSPI-DDL-INT.
Commands and Responses DELETE Command Tokens in Command Buffer ZSPI-TKN-MANAGER is a standard SPI manager token that contains the name of an X25AM line. This token is not required to be present in the command, and duplicate occurrences are not allowed. ZSPI-TKN-MANAGER is described in Section 5, Common Definitions. ZCOM-TKN-OBJNAME is an object-name token that indicates which subdevices are to be deleted. This token must be present in the command.
DELETE Command Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST is a standard SPI data list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST. ZCOM-TKN-OBJNAME is an object-name token that contains the name of a subdevice that was deleted by the command. If there is no error, this token is present in every response record. ZCOM-TKN-OBJNAME is described in Section 5, Common Definitions.
Commands and Responses DELETE Command ZSPI-TKN-CONTEXT is the standard SPI context token described in the SPI Programming Manual. Operational Notes • • • • DELETE is a sensitive command. The subdevices must be in the STOPPED summary state when this command is issued. Subdevices can be added to the X25AM subsystem by using the ADD command. No summary-state transition is associated with this command.
DISCONNECT Command Commands and Responses DISCONNECT Command The DISCONNECT command clears a virtual circuit set up by a call request. Command ZCOM-CMD-DISCONNECT Object Type ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-STRING. !{} token-type ZSPI-TYP-TIMESTAMP. ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID type ZSPI-DDL-CRTPID. 02 ZPAID type ZSPI-DDL-INT. end.
DISCONNECT Command Commands and Responses occurrences are not allowed. ZCOM-TKN-OBJNAME is described in Section 5, Common Definitions. ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard data communications tokens that are described in the SPI Common Extensions Manual. Duplicate occurrences of these tokens are not allowed. (ZSPI-TKN-) MAXRESP, RESPONSE-TYPE, ALLOW-TYPE, and COMMENT are standard SPI tokens described in the SPI Programming Manual.
DISCONNECT Command Commands and Responses 512 (ZX25-ERR-OBJ-NAME-NOT-SUPP): The object name is not supported by the X25AM subsystem. 516 (ZX25-ERR-DISCON-PVC-NOT-SUP): The DISCONNECT command is not supported when the circuit is PVC. 4999 (ZX25-ERR-EMPTY-RESPONSE): The empty response record is being returned. For command-specific information about these error numbers, see Error-Handling Notes on page 6-59. For descriptions of all X25AM error numbers, see Appendix A, Error Numbers and Error Lists.
FORBIDOPENS Command Commands and Responses FORBIDOPENS Command The FORBIDOPENS command allows the designated subdevices to be opened exclusively, so that applications other than the issuing application cannot open them. Command ZCOM-CMD-FORBIDOPENS Object Type ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-STRING. !{} token-type ZSPI-TYP-TIMESTAMP. ZCOM-MAP-REQID def ZCOM-DDL-REQID.
Commands and Responses FORBIDOPENS Command Tokens in Command Buffer ZSPI-TKN-MANAGER is a standard SPI manager token that contains the name of an X25AM line. This token is not required to be present in the command, and duplicate occurrences are not allowed. ZSPI-TKN-MANAGER is described in Section 5, Common Definitions. ZCOM-TKN-OBJNAME is an object-name token that indicates which subdevices are to be opened exclusively. This token must be present in the command.
Commands and Responses FORBIDOPENS Command Tokens in Response Buffer ZSPI-TKN-DATALIST is a standard SPI data list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST. ZCOM-TKN-OBJNAME is an object-name token that contains the name of a subdevice that was affected by the command. If there is no error, this token is present in every response record.
Commands and Responses FORBIDOPENS Command ZSPI-TKN-CONTEXT is the standard SPI context token described in the SPI Programming Manual. Operational Notes • • • • FORBIDOPENS is a sensitive command. The subdevices must not be in the DIAGNOSING summary state when this command is issued. To allow other applications to open a subdevice, use the ALLOWOPENS command. No summary-state transition is associated with this command.
GETVERSION Command Commands and Responses GETVERSION Command The GETVERSION command returns the server version and server-banner string of the X25AM subsystem. Command ZCOM-CMD-GETVERSION Object Type ZCOM-OBJ-NULL Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-TIMESTAMP. ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. type ZSPI-DDL-CRTPID. type ZSPI-DDL-INT.
GETVERSION Command Commands and Responses (ZSPI-TKN-) MAXRESP, RESPONSE-TYPE, ALLOW-TYPE, and COMMENT are standard SPI tokens described in the SPI Programming Manual. With the exception of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are not allowed. Tokens in Response Buffer ZSPI-TKN-DATALIST is a standard SPI data list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST.
Commands and Responses GETVERSION Command Operational Notes • • • All users can issue the GETVERSION command. The server version of the X25AM subsystem is returned in the header token ZSPITKN-SERVER-VERSION. No summary-state transition is associated with this command. Error-Handling Notes • • The error identified by the error number ZCOM-ERR-TKN-CODE-INV is returned if the token ZCOM-TKN-OBJNAME appears in the command.
INFO Command Commands and Responses INFO Command The INFO command returns the current values of the attributes of lines and subdevices. Command ZCOM-CMD-INFO Object Type ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-STRING. !{} token-type ZSPI-TYP-TIMESTAMP. ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. type ZSPI-DDL-CRTPID. type ZSPI-DDL-INT.
INFO Command Commands and Responses 02 ZCUG 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 02 ZDEBUG ZDSR-TIMEOUT ZEXT-CALL-FORMAT ZFRAME-MODE ZIDLE-TIMEOUT ZIDLE-CMD-RR ZINTRF ZL2-DISC ZL2-WINDOW ZL3-MOD ZL3-WINDOW ZLINE-TYPE ZNETID ZPKT-SIZE ZPAGE6520-BLOCK-SIZE ZPROG ZPVC-RANGE 02 02 02 02 02 02 ZRETRIES ZREXMIT-TIMEOUT ZSTART-DOWN ZSRC-ADDR ZFILLER ZSVC-RANGE 02 02 02 02 02 ZSYNCS ZTHRES ZCUG-TYPE ZBCUG ZRPOA 02 ZRPOA-DNIC-CNT 02 ZTRANSIT-DELAY 02 ZMAX-IO-SIZE end.
INFO Command Commands and Responses 02 ZCONV-PAD-CNT 02 ZCONV-PAD-PARAMS type ZSPI-DDL-INT. type ZSPI-DDL-INT-PAIR occurs 63 times spi-null 255. 02 ZCUG type ZSPI-DDL-INT spi-null 250. 02 ZDEST-ADDR type ZX25-DDL-CHAR15 spi-null " ". 02 ZFILLER type ZX25-DDL-FILLER. 02 ZNEGOT-L3-WINDOW type ZSPI-DDL-BOOLEAN spi-null 0. 02 ZNEGOT-PKT-SIZE type ZSPI-DDL-BOOLEAN spi-null 0. 02 ZNEGOT-THRUPUT type ZSPI-DDL-BOOLEAN spi-null 0. 02 ZNULL-FILL type ZSPI-DDL-BOOLEAN spi-null 0. 02 ZPARITY type ZSPI-DDL-ENUM.
INFO Command Commands and Responses Tokens in Command Buffer ZSPI-TKN-MANAGER is a standard SPI manager token that contains the name of an X25AM line. This token is not required to be present in the command, and duplicate occurrences are not allowed. ZSPI-TKN-MANAGER is described in Section 5, Common Definitions. ZCOM-TKN-OBJNAME is an object-name token that indicates which lines and subdevices are to have their attribute values returned. This token must be present in the command.
INFO Command Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST is a standard SPI data list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST. ZX25-MAP-INFO-LINE and ZX25-MAP-INFO-SU are extensible structured tokens that contain the current values of the attributes of a line and a subdevice, respectively. Only one of these tokens is present in every response record.
INFO Command Commands and Responses ZCALLS indicates the types of call requests allowed. This field can have one of the following values: ZX25-VAL-INCOMING-CALLS Only incoming call requests are allowed. This value corresponds to the SYSGEN modifier INCOMINGCALLS, NOOUTGOINGCALLS. ZX25-VAL-NO-CALLS No call requests are allowed. This value corresponds to the SYSGEN modifier NOCALLS. ZX25-VAL-OUTGOING-CALLS Only outgoing call requests are allowed.
INFO Command Commands and Responses ZCUG contains the closed user group (CUG) identification that is sent in every callrequest packet. This value establishes a default value that is used when the CUG identification attribute of a subdevice is not specified. If this field contains its null value, there is no explicitly specified CUG identification. This field corresponds to the SYSGEN modifier CUG.
INFO Command Commands and Responses ZIDLE-TIMEOUT contains the time interval to wait before transmitting level-2 Receive Ready (RR). This field corresponds to the SYSGEN modifier L2IDLETIMEOUT. ZIDLE-CMD-RR indicates whether or not a command RR is sent when the line is idle. This field can have one of the following values: ZSPI-VAL-TRUE A command RR is sent when the line is idle. ZSPI-VAL-FALSE A response RR is sent when the line is idle. ZINTRF indicates the electrical interface of the controller.
INFO Command Commands and Responses ZLINE-TYPE is a pair of integers that contains the type and subtype of the line. The line type is 61. The subtype is 63 for 6100 CSS controllers, 62 for 3681 MFC controllers, and 0 through 61 for other controllers. ZNETID indicates the X.25 Public Data Network (PDN) that the X25AM subsystem is communicating with. This value is used to establish the addressing conventions required by the network.
INFO Command Commands and Responses ZX25-VAL-NETID-X25SA The addressing conventions of the generic netid X25SA are being used. This value corresponds to the SYSGEN modifier X25SA. ZX25-VAL-NETID-X25UD The addressing conventions of the generic netid X25UD are being used. This value corresponds to the SYSGEN modifier X25UD. ZX25-VAL-NETID-X25XA The addressing conventions of the generic netid X25XA are being used. This value corresponds to the SYSGEN modifier X25XA. ZPKT-SIZE contains the packet size.
INFO Command Commands and Responses This field corresponds to the SYSGEN modifier STARTDOWN. ZSRC-ADDR contains the X.25 network address for your system. This field has no corresponding SYSGEN modifier. ZFILLER acts as a filler and is not associated with any line attribute. This field has no corresponding SYSGEN modifier. ZSVC-RANGE is a pair of integers that contains the range of logical channels that are used for Switched Virtual Circuits (SVCs).
Commands and Responses INFO Command If the CUG ID is configured to be greater than 99, then the CUGTYPE must be EXT or EXTOA. The default in this case is EXT. ZBCUG specifies the bilateral closed user group ID sent in every call-request packet. The line BCUG establishes a default value that is used when the subdevice BCUG attribute is not specified. The range is 0 through 9999. ZRPOA specifies the Recognized Private Operating Agency (RPOA) transit network(s) in the facility field of a call-request packet.
INFO Command Commands and Responses The second integer is the subtype, which depends on the protocol and terminal being represented. ZDEV-TYPE contains one of the following pairs of integers: (6,0) The subdevice is an Interactive Terminal Interface (ITI) conversational-mode terminal; it cannot be changed to block mode. (6,1) The subdevice is an ITI 6510 (ADM-2) terminal. (6,2) The subdevice is an ITI 6520 (Zentec) terminal. (6,4) The subdevice is an ITI 6530 (HP) terminal.
INFO Command Commands and Responses ZBLOCK-PAD-PARAMS contains from 0 through 63 pairs of integers that specify the block-mode X.29 PAD parameters. The number of integer pairs in this field is given by the value of the field ZBLOCK-PAD-CNT. PAD parameters are meaningful only if the protocol is ITI. ZCONV-PAD-CNT contains the number of parameter pairs that appear in the field ZCONV-PADPARAMS.
INFO Command Commands and Responses ZNEGOT-PKT-SIZE indicates whether or not a call-request packet containing an unacceptable value for the network-interface characteristic PACKETSIZE is accepted. This field can have one of the following values: ZSPI-VAL-TRUE The call request is accepted, and a call-accept packet containing an acceptable value for PACKETSIZE is sent to the network. ZSPI-VAL-FALSE The call request is denied, and a call-cleared packet is sent to the network.
INFO Command Commands and Responses ZPARITY-CHECK indicates whether or not parity checking is enabled. This field can have one of the following values: ZSPI-VAL-TRUE Parity checking is enabled. ZSPI-VAL-FALSE Parity checking is disabled. If enabled, parity checking is performed as specified by the value of the field ZPARITY. This field is meaningful only if the protocol is ITI. ZPORT contains the logical port number being used by the subdevice.
INFO Command Commands and Responses ZX25-VAL-NETID-TRANSPAC The addressing conventions for the TRANSPAC network are being used. ZX25-VAL-NETID-TYMNET The addressing conventions for the TYMNET network are being used. ZX25-VAL-NETID-X25 The addressing conventions of the generic netid X25 are being used. ZX25-VAL-NETID-X25NP The addressing conventions of the generic netid X25NP are being used. ZX25-VAL-NETID-X25SA The addressing conventions of the generic netid X25SA are being used.
INFO Command Commands and Responses ZLOCAL-ADDR-EXT-TYPE specifies the status of ZLOCAL-ADDR-EXT. This field can be assigned the following values: 0 Full NSAP 1 Reserved 2 Non-OSI 3 Reserved ZREMOTE-ADDR-EXT-TYPE specifies the status of ZREMOTE-ADDR-EXT. This field can be assigned the following values: 0 Full NSAP 1 Reserved 2 Non-OSI 3 Reserved ZPAGE6520-BLOCK-SIZE specifies the block size used in the ITI protocol.
INFO Command Commands and Responses ZBCUG specifies the bilateral closed user group ID sent in every call-request packet. The range is 0 through 9999. RESET means no BCUG is assigned and BCUG has the value -1. ZRPOA specifies the Recognized Private Operating Agency (RPOA) transit network(s) in the facility field of a call-request packet. An RPOA transit network is indicated by the Data Network Identification Code (DNIC), which is an integer in the range 0 through 9999.
INFO Command Commands and Responses Some values of RETCODE that are likely to occur in response to the INFO command are the following: -30 (ZCOM-ERR-TKN-VAL-INV): A supported token had an improper value. -25 (ZCOM-ERR-SUB-NOT-FOUND): No subordinate objects were found. -17 (ZCOM-ERR-OBJ-NOT-FOUND): The specified object cannot be found. -5 (ZCOM-ERR-CMD-NOT-SUPP): An invalid, unknown, or unsupported command token was found.
Commands and Responses INFO Command Error-Handling Notes • • • • If the token ZCOM-TKN-SUB is present when the object type is ZCOM-OBJ-SU and the value is not ZCOM-VAL-SUB-NONE, the error identified by the error number ZCOM-ERR-TKN-VAL-INV is returned.
LISTOBJECTS Command (All Objects) Commands and Responses LISTOBJECTS Command (All Objects) This form of the LISTOBJECTS command returns the names of all lines and subdevices known to the X25AM subsystem. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-NULL Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-TIMESTAMP. ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end.
LISTOBJECTS Command (All Objects) Commands and Responses ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard data communications tokens that are described in the SPI Common Extensions Manual. Duplicate occurrences of these tokens are not allowed. (ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and COMMENT are standard SPI tokens described in the SPI Programming Manual. With the exception of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are not allowed.
LISTOBJECTS Command (All Objects) Commands and Responses A value of RETCODE that is likely to occur in response to this form of the LISTOBJECTS command is the following: -26 (ZCOM-ERR-TKN-CODE-INV): An invalid, unknown, or unsupported token code was found. -25 (ZCOM-ERR-SUB-NOT-FOUND): No subordinate objects were found. -17 (ZCOM-ERR-OBJ-NOT-FOUND): The specified object cannot be found. 4999 (ZX25-ERR-EMPTY-RESPONSE): The empty response record is being returned.
Commands and Responses LISTOBJECTS Command (Lines or Subdevices) LISTOBJECTS Command (Lines or Subdevices) This form of the LISTOBJECTS command returns the names of the subdevices that are subordinate to the specified line. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-STRING. !{} token-type ZSPI-TYP-TIMESTAMP. ZCOM-MAP-REQID def ZCOM-DDL-REQID.
LISTOBJECTS Command (Lines or Subdevices) Commands and Responses Tokens in Command Buffer ZSPI-TKN-MANAGER is a standard SPI manager token that contains the name of an X25AM line. This token is not required to be present in the command, and duplicate occurrences are not allowed. ZSPI-TKN-MANAGER is described in Section 5, Common Definitions. ZCOM-TKN-OBJNAME is an object-name token that indicates which names are to be returned. This token must be present in the command.
LISTOBJECTS Command (Lines or Subdevices) Commands and Responses (ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and COMMENT are standard SPI tokens described in the SPI Programming Manual. With the exception of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are not allowed. Tokens in Response Buffer ZSPI-TKN-DATALIST is a standard SPI data list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST.
Commands and Responses LISTOBJECTS Command (Lines or Subdevices) Some values of RETCODE that are likely to occur in response to this form of the LISTOBJECTS command are the following: -30 (ZCOM-ERR-TKN-VAL-INV): A supported token had an improper value. -25 (ZCOM-ERR-SUB-NOT-FOUND): No subordinate objects were found. -17 (ZCOM-ERR-OBJ-NOT-FOUND): The specified object cannot be found. 4999 (ZX25-ERR-EMPTY-RESPONSE): The empty response record is being returned.
RESETSTATS Command Commands and Responses RESETSTATS Command The RESETSTATS command returns statistical information about the execution history of lines and subdevices--dynamic information such as the numbers of packets sent and received, numbers of errors, and so forth--and then restores the statistics counters to their initial values.
RESETSTATS Command Commands and Responses 02 ZDRV. 04 ZBCC-ERR 04 ZNO-BUF-ERR 04 ZLINE-QUAL 04 ZFRAME-CNT 04 ZERR-CNT 02 ZMODEM. 04 ZOVERRUN-CNT 04 ZERR-CNT 02 ZFRAME-OVERALL. 04 ZI-SENT 04 ZI-RECV 04 ZS-SENT 04 ZS-RECV 04 ZU-SENT 04 ZU-RECV 02 ZFRAME-DETL.
RESETSTATS Command Commands and Responses 02 ZPKT-DETL. 04 ZPKT-SENT. 06 ZDIAG-SENT 06 ZRESTART-REQS-SENT 06 ZRESTART-CONF-SENT 06 ZCLEAR-REQS-SENT 06 ZCLEAR-CONF-SENT 06 ZCALL-REQS-SENT 06 ZCALL-CONF-SENT 06 ZRESET-REQS-SENT 06 ZRESET-CONF-SENT 06 ZINTRPT-REQS-SENT 06 ZINTRPT-CONF-SENT 06 ZDATA-PKT-SENT 06 ZRR-PKT-SENT 06 ZRNR-PKT-SENT 06 ZREJ-PKT-SENT 04 ZPKT-RECV.
RESETSTATS Command Commands and Responses Tokens in Command Buffer ZSPI-TKN-MANAGER is a standard SPI manager token that contains the name of an X25AM line. This token is not required to be present in the command, and duplicate occurrences are not allowed. ZSPI-TKN-MANAGER is described in Section 5, Common Definitions. ZCOM-TKN-OBJNAME is an object-name token that indicates which lines and subdevices are to have their statistics returned and their statistics counters reinitialized.
Commands and Responses RESETSTATS Command (ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and COMMENT are standard SPI tokens described in the SPI Programming Manual. With the exception of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are not allowed. Tokens in Response Buffer ZSPI-TKN-DATALIST is a standard SPI data list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST.
Commands and Responses RESETSTATS Command ZFAIL is the number of times the X25AM subsystem was forced to wait to secure local pool space. ZDRV is a structure that contains information about the number of errors in received frames. This information is meaningful only for lines that are not 6100 X25AM lines. ZDRV consists of the following fields: ZBCC-ERR contains the total number of Block-Check Character (BCC) errors detected in driver frames received.
Commands and Responses RESETSTATS Command ZI-SENT contains the total number of I-frames sent. ZI-RECV contains the total number of I-frames received. ZS-SENT contains the total number of S-frames sent. ZS-RECV contains the total number of S-frames received. ZU-SENT contains the total number of U-frames sent. ZU-RECV contains the total number of U-frames received. ZFRAME-DETL is a structure that contains more detailed frame-level statistics. The frame-level counters reflect the quality of the link level.
Commands and Responses ZRNR-SENT contains the total number of RNR frames sent. ZREJ-SENT contains the total number of REJ frames sent. ZSREJ-SENT contains the total number of SREJ frames sent. ZRR-RECV contains the total number of RR frames received. ZRNR-RECV contains the total number of RNR frames received. ZREJ-RECV contains the total number of REJ frames received. ZSREJ-RECV contains the total number of SREJ frames received. ZSABM-SENT contains the total number of SABM frames sent.
Commands and Responses RESETSTATS Command ZUA-RECV contains the total number of UA frames received. ZDM-SENT contains the total number of DM frames sent. ZDM-RECV contains the total number of DM frames received. ZCLIP-DRV is a structure that contains error statistics that are meaningful only for 6100 X25AM lines. It consists of the following fields: ZFCS-ERR contains the number of frames received with errors in the Frame-Check Sequence (FCS).
Commands and Responses RESETSTATS Command ZPKT-OVERALL is a structure that contains overall packet-level statistics. These statistics count the current number and types of packets sent and received by level 3. This structure consists of the following fields: ZPKTS-SENT contains the number of packets sent. ZPKTS-RECV contains the number of packets received. ZINV-RECV contains the number of packets received that have a nonexistent LCN. ZDISCARDED-PKTS is not currently used.
Commands and Responses RESETSTATS Command ZCALL-REQS-SENT contains the number of call-request packets sent. ZCALL-CONF-SENT contains the number of call-confirmation packets sent. ZRESET-REQS-SENT contains the number of reset-request packets sent. ZRESET-CONF-SENT contains the number of reset-confirmation packets sent. ZINTRPT-REQS-SENT contains the number of interpret-request packets sent. ZINTRPT-CONF-SENT contains the number of interpret-confirmation packets sent.
Commands and Responses RESETSTATS Command ZRESTART-CONF-RECV contains the number of restart-confirmation packets received. ZCLEAR-REQS-RECV contains the number of clear-request packets received. ZCLEAR-CONF-RECV contains the number of clear-confirmation packets received. ZCALL-REQS-RECV contains the number of call-request packets received. ZCALL-CONF-RECV contains the number of call-confirmation packets received. ZRESET-REQS-RECV contains the number of reset-request packets received.
RESETSTATS Command Commands and Responses ZTMSTP contains the time that the statistics counters were read. ZTMSTP-LAST is the time that the statistics counters were reset. ZCKT-NUM contains the circuit number or LCN number. ZMSG-SENT contains the number of packets sent during the life of this circuit. ZMSG-RECV contains the number of packets received during the life of this circuit.
RESETSTATS Command Commands and Responses -14 (ZCOM-ERR-NO-MEM-SPACE): The X25AM subsystem cannot obtain enough memory space to process the command. 512 (ZX25-ERR-OBJ-NAME-NOT-SUPP): The object name is not supported by the X25AM subsystem. 4999 (ZX25-ERR-EMPTY-RESPONSE): The empty response record is being returned. For command-specific information about these error numbers, see Error-Handling Notes. For descriptions of all X25AM error numbers, see Appendix A, Error Numbers and Error Lists.
Commands and Responses RESETSTATS Command modifier token ZCOM-TKN-SUB is present and contains the value ZCOM-VALSUB-ONLY, and the specified line has no subordinate subdevices. • The error identified by the error number ZCOM-ERR-OBJ-NOT-FOUND is returned if the object type in the command is ZCOM-OBJ-SU and a specified subdevice cannot be found.
START Command Commands and Responses START Command The START command initiates the operation of lines and subdevices. Command ZCOM-CMD-START Object Type ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-STRING. !{} token-type ZSPI-TYP-TIMESTAMP. ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. type ZSPI-DDL-CRTPID. type ZSPI-DDL-INT.
START Command Commands and Responses ZCOM-TKN-OBJNAME is an object-name token that indicates which lines and subdevices are to be started. This token must be present in the command. If the object type in the command is ZCOM-OBJ-LINE, only one object-name token, containing the name of a line, can be present in the command (see ZCOMTKN-SUB). If the object type in the command is ZCOM-OBJ-SU, the command can contain as many object-name tokens as will fit into the command buffer.
START Command Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST is a standard SPI data list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST. ZCOM-TKN-OBJNAME is an object-name token that contains the name of a line or subdevice that was started by the command. If there is no error, this token is present in every response record. ZCOM-TKN-OBJNAME is described in Section 5, Common Definitions.
Commands and Responses START Command For command-specific information about these error numbers, see Error-Handling Notes. For descriptions of all X25AM error numbers, see Appendix A, Error Numbers and Error Lists. ZSPI-TKN-ERRLIST is a standard SPI error list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST. ZSPI-TKN-CONTEXT is the standard SPI context token described in the SPI Programming Manual. Operational Notes • • • • • • START is a sensitive command.
STATISTICS Command Commands and Responses STATISTICS Command The STATISTICS command returns statistical information about the execution history of lines and subdevices--dynamic information such as the numbers of packets sent and received, numbers of errors, and so forth. Command ZCOM-CMD-STATISTICS Object Type ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-STRING.
STATISTICS Command Commands and Responses 04 ZLINE-QUAL 04 ZFRAME-CNT 04 ZERR-CNT 02 ZMODEM. 04 ZOVERRUN-CNT 04 ZERR-CNT 02 ZFRAME-OVERALL. 04 ZI-SENT 04 ZI-RECV 04 ZS-SENT 04 ZS-RECV 04 ZU-SENT 04 ZU-RECV 02 ZFRAME-DETL.
STATISTICS Command Commands and Responses 02 ZPKT-DETL. 04 ZPKT-SENT. 06 ZDIAG-SENT 06 ZRESTART-REQS-SENT 06 ZRESTART-CONF-SENT 06 ZCLEAR-REQS-SENT 06 ZCLEAR-CONF-SENT 06 ZCALL-REQS-SENT 06 ZCALL-CONF-SENT 06 ZRESET-REQS-SENT 06 ZRESET-CONF-SENT 06 ZINTRPT-REQS-SENT 06 ZINTRPT-CONF-SENT 06 ZDATA-PKT-SENT 06 ZRR-PKT-SENT 06 ZRNR-PKT-SENT 06 ZREJ-PKT-SENT 04 ZPKT-RECV.
STATISTICS Command Commands and Responses Tokens in Command Buffer ZSPI-TKN-MANAGER is a standard SPI manager token that contains the name of an X25AM line. This token is not required to be present in the command, and duplicate occurrences are not allowed. ZSPI-TKN-MANAGER is described in Section 5, Common Definitions. ZCOM-TKN-OBJNAME is an object-name token that indicates which lines and subdevices are to have their statistics returned. This token must be present in the command.
Commands and Responses STATISTICS Command Tokens in Response Buffer ZSPI-TKN-DATALIST is a standard SPI data list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST. ZX25-MAP-STATS-LINE and ZX25-MAP-STATS-SU are extensible structured tokens that contain the statistical information for a line and a subdevice, respectively. Only one of these tokens is present in every response record.
Commands and Responses STATISTICS Command ZDRV is a structure that contains information about the number of errors in received frames. This information is meaningful only for lines that are not 6100 X25AM lines. ZDRV consists of the following fields: ZBCC-ERR contains the total number of Block-Check Character (BCC) errors detected in driver frames received. ZNO-BUF-ERR contains the total number of buffer-allocation errors. ZLINE-QUAL contains the total number of line-quality errors.
Commands and Responses STATISTICS Command ZS-SENT contains the total number of S-frames sent. ZS-RECV contains the total number of S-frames received. ZU-SENT contains the total number of U-frames sent. ZU-RECV contains the total number of U-frames received. ZFRAME-DETL is a structure that contains more detailed frame-level statistics. The frame-level counters reflect the quality of the link level.
Commands and Responses ZSREJ-SENT contains the total number of SREJ frames sent. ZRR-RECV contains the total number of RR frames received. ZRNR-RECV contains the total number of RNR frames received. ZREJ-RECV contains the total number of REJ frames received. ZSREJ-RECV contains the total number of SREJ frames received. ZSABM-SENT contains the total number of SABM frames sent. ZSABM-RECV contains the total number of SABM frames received. ZDISC-SENT contains the total number of DISC frames sent.
Commands and Responses STATISTICS Command ZDM-RECV contains the total number of DM frames received. ZCLIP-DRV is a structure that contains error statistics that are meaningful only for 6100 X25AM lines. It consists of the following fields: ZFCS-ERR contains the number of frames received with errors in the Frame-Check Sequence (FCS). ZT1-TIMEOUT contains the number of frames that timed out before acknowledgment was received. ZMODEM-ERR contains the number of modem-signal handshaking errors.
Commands and Responses STATISTICS Command ZPKTS-SENT contains the number of packets sent. ZPKTS-RECV contains the number of packets received. ZINV-RECV contains the number of packets received that have a nonexistent LCN. ZDISCARDED-PKTS is not currently used. ZPKT-DETL is a structure that contains more detailed packet-level statistics. The information in this structure is divided into statistics for packets sent and for packets received.
Commands and Responses STATISTICS Command ZRESET-REQS-SENT contains the number of reset-request packets sent. ZRESET-CONF-SENT contains the number of reset-confirmation packets sent. ZINTRPT-REQS-SENT contains the number of interpret-request packets sent. ZINTRPT-CONF-SENT contains the number of interpret-confirmation packets sent. ZDATA-PKT-SENT contains the number of data packets sent. ZRR-PKT-SENT contains the number of RR packets sent. ZRNR-PKT-SENT contains the number of RNR packets sent.
Commands and Responses STATISTICS Command ZCLEAR-CONF-RECV contains the number of clear-confirmation packets received. ZCALL-REQS-RECV contains the number of call-request packets received. ZCALL-CONF-RECV contains the number of call-confirmation packets received. ZRESET-REQS-RECV contains the number of reset-request packets received. ZRESET-CONF-RECV contains the number of reset-confirmation packets received. ZINTRPT-REQS-RECV contains the number of interpret-request packets received.
STATISTICS Command Commands and Responses ZCKT-NUM contains the circuit number or LCN number. ZMSG-SENT contains the number of packets sent during the life of this circuit. ZMSG-RECV contains the number of packets received during the life of this circuit. ZCOM-TKN-OBJNAME is an object-name token that contains the name of the line or subdevice whose statistics are returned in this response record. If there is no error, this token is present in every response record.
Commands and Responses STATISTICS Command For command-specific information about these error numbers, see Error-Handling Notes. For descriptions of all X25AM error numbers, see Appendix A, Error Numbers and Error Lists. ZSPI-TKN-ERRLIST is a standard SPI error list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST. ZSPI-TKN-CONTEXT is the standard SPI context token described in the SPI Programming Manual.
STATUS Command Commands and Responses STATUS Command The STATUS command returns information about the current state of lines and subdevices--information such as the summary state, the CLIP path being used, the record size of the subdevice, and so forth. Command ZCOM-CMD-STATUS Object Type ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-STRING. !{} token-type ZSPI-TYP-TIMESTAMP.
STATUS Command Commands and Responses 02 ZTOTAL-SU-NUM type ZSPI-DDL-INT. 02 ZLAST-ERR type ZSPI-DDL-INT. 02 ZCLIP-LINE. 04 ZDEBUG type ZSPI-DDL-BOOLEAN. 04 ZPATH type ZSPI-DDL-ENUM. 04 ZCU-PRIM type ZSPI-DDL-INT. 04 ZCU-BKUP type ZSPI-DDL-INT. 04 ZCTS type ZSPI-DDL-BOOLEAN. 04 ZDCD type ZSPI-DDL-BOOLEAN. 04 ZDSR type ZSPI-DDL-BOOLEAN. 02 ZPCHANNEL type ZSPI-DDL-INT. 02 ZPCONTROL type ZSPI-DDL-INT. 02 ZPUNIT type ZSPI-DDL-INT. 02 ZBCHANNEL type ZSPI-DDL-INT. 02 ZBCONTROL type ZSPI-DDL-INT.
STATUS Command Commands and Responses If the object type in the command is ZCOM-OBJ-SU, the command can contain as many object-name tokens as will fit into the command buffer. Each object-name token contains one subdevice name. This token is described in Section 5, Common Definitions. ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard data communications tokens that are described in the SPI Common Extensions Manual. Duplicate occurrences of these tokens are not allowed.
STATUS Command Commands and Responses and the DDL definition ZX25-DDL-STATUS-LINE. This token contains the following fields: ZLDEV contains the logical device number of the line. ZIN-USE indicates whether or not the line is in use. This field can have the following values: ZSPI-VAL-TRUE The line is currently in use. ZSPI-VAL-FALSE The line is not currently in use. ZSTATE indicates the current summary state of the line.
STATUS Command Commands and Responses ZBPID contains the backup process ID of the X25AM subsystem. ZTOTAL-SU-NUM contains the total number of subdevices for the line. ZLAST-ERR contains the error number of the last detected error on the line. ZCLIP-LINE is a structure that contains information that is meaningful only for 6100 or 6105 X25AM lines. It consists of the following fields: ZDEBUG indicates the state of the DEBUG attribute.
STATUS Command Commands and Responses ZDCD indicates the status of the modem signal Carrier Detect on 6100 X25AM lines. This field can have the following values: ZSPI-VAL-TRUE The signal is ON. ZSPI-VAL-FALSE The signal is OFF. If the line is not a 6100 X25AM line, this field always contains ZSPI-VALFALSE. ZDSR indicates the status of the modem signal Data Set Ready on 6100 X25AM lines. This field can have the following values: ZSPI-VAL-TRUE The signal is ON. ZSPI-VAL-FALSE The signal is OFF.
STATUS Command Commands and Responses ZSTATE indicates the current summary state of the subdevice. This field can have the following values: ZCOM-VAL-SUMSTATE-DIAG The subdevice is in the DIAGNOSING summary state. ZCOM-VAL-SUMSTATE-STARTED The subdevice is in the STARTED summary state. ZCOM-VAL-SUMSTATE-STOPPED The subdevice is in the STOPPED summary state. ZSU-NUM contains the identifying subdevice number of the subdevice.
STATUS Command Commands and Responses Some values of RETCODE that are likely to occur in response to the STATUS command are the following: -30 (ZCOM-ERR-TKN-VAL-INV): A supported token had an improper value. -25 (ZCOM-ERR-SUB-NOT-FOUND): No subordinate objects were found. -17 (ZCOM-ERR-OBJ-NOT-FOUND): The specified object cannot be found. -14 (ZCOM-ERR-NO-MEM-SPACE): The X25AM subsystem cannot obtain enough memory space to process the command.
Commands and Responses STATUS Command Error-Handling Notes • • • If the token ZCOM-TKN-SUB is present when the object type is ZCOM-OBJ-SU and the value is not ZCOM-VAL-SUB-NONE, the error identified by the error number ZCOM-ERR-TKN-VAL-INV is returned.
STOP Command Commands and Responses STOP Command The STOP command terminates the operation of lines and subdevices. Command ZCOM-CMD-STOP Object Type ZCOM-OBJ-LINE or ZCOM-OBJ-SU Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-STRING. !{} token-type ZSPI-TYP-TIMESTAMP. ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. type ZSPI-DDL-CRTPID. type ZSPI-DDL-INT.
STOP Command Commands and Responses ZCOM-TKN-OBJNAME is an object-name token that indicates which lines and subdevices are to be terminated. This token must be present in the command. If the object type in the command is ZCOM-OBJ-LINE, only one object-name token, containing the name of a line, can be present in the command (see ZCOMTKN-SUB). If the object type in the command is ZCOM-OBJ-SU, the command can contain as many object-name tokens as will fit into the command buffer.
STOP Command Commands and Responses ZCOM-TKN-OBJNAME is an object-name token that contains the name of a line or subdevice that was terminated by the command. If there is no error, this token is present in every response record. ZCOM-TKN-OBJNAME is described in Section 5, Common Definitions. ZCOM-TKN-OBJTYPE is an object-type token that indicates the type of the object named in ZCOM-TKNOBJNAME. This token can have the following values: ZCOM-OBJ-LINE The object is a line.
Commands and Responses STOP Command ZSPI-TKN-ERRLIST is a standard SPI error list, as described in the SPI Programming Manual. The list ends with the token ZSPI-TKN-ENDLIST. ZSPI-TKN-CONTEXT is the standard SPI context token described in the SPI Programming Manual. Operational Notes • • • • • • • STOP is a sensitive command. The lines and subdevices are left in the STOPPED summary state.
SWITCH Command Commands and Responses SWITCH Command The SWITCH command switches an X25AM line-handler process either between two processors or between two Communications Interface Unit (CIU) paths. Command ZCOM-CMD-SWITCH Object Type ZCOM-OBJ-LINE or ZCOM-OBJ-PROCESS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-SWITCH-CPU ZCOM-TKN-SWITCH-PATH ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-INT. !{A} ZSPI-TYP-ENUM.
SWITCH Command Commands and Responses ZCOM-TKN-SWITCH-CPU and ZCOM-TKN-SWITCH-PATH are standard data communications tokens that describe what the process is to be switched to. One token or the other, but not both, must be present in the command, and duplicate occurrences are not allowed. If ZCOM-TKN-SWITCH-CPU is present, the line-handler process is to be switched between processors, and the value of this token is an integer indicating the primary processor the process is to be switched to.
SWITCH Command Commands and Responses every response record. ZCOM-TKN-OBJNAME is described in Section 5, Common Definitions. ZCOM-TKN-OBJTYPE is an object-type token that contains the object type that was present in the command. This token can have the following values: ZCOM-OBJ-LINE The object type in the command was ZCOM-OBJ-LINE. ZCOM-OBJ-PROCESS The object type in the command was ZCOM-OBJPROCESS.
Commands and Responses SWITCH Command Operational Notes • • • • SWITCH is a sensitive command. The line controlled by the line-handler process must not be in the DIAGNOSING summary state when this command is issued. To determine which processor or CIU path is currently being used by a process, use the STATUS command on the line controlled by the process. No summary-state transition is associated with this command.
TRACE Command Commands and Responses TRACE Command The TRACE command initiates, modifies, or terminates trace mode on an X25AM line. Command ZCOM-CMD-TRACE Object Type ZCOM-OBJ-LINE Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-CMD-TIMEOUT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-TIMESTAMP. ZCOM-MAP-REQID def ZCOM-DDL-REQID. 02 ZCRTPID 02 ZPAID end. type ZSPI-DDL-CRTPID. type ZSPI-DDL-INT. ZCOM-MAP-TRACE-MODIF def ZCOM-DDL-TRACE-MODIF.
TRACE Command Commands and Responses Tokens in Command Buffer ZSPI-TKN-MANAGER is a standard SPI manager token that contains the name of an X25AM line. This token is not required to be present in the command, and duplicate occurrences are not allowed. ZSPI-TKN-MANAGER is described in Section 5, Common Definitions. ZCOM-TKN-OBJNAME is an object-name token that contains the name of the line to be affected by the command. This token must be present in the command, and duplicate occurrences are not allowed.
TRACE Command Commands and Responses ZX25-VAL-TRACE-OPT-CLIPDI CLIP inbound frames are to be traced. (This option is valid only for 6100 X25AM lines). The option ZX25-VAL-TRACE-OPT-CLIP must also be selected for this tracing to occur. ZX25-VAL-TRACE-OPT-CLIPDO CLIP outbound frames are to be traced. (This option is valid only for 6100 X25AM lines). The option ZX25-VAL-TRACE-OPT-CLIP must also be selected for this tracing to occur. ZX25-VAL-TRACE-OPT-CLIPL2 CLIP level-2 events are to be traced.
TRACE Command Commands and Responses ZSPI-TKN-RETCODE is the standard SPI return token described in the SPI Programming Manual. Some values of RETCODE that are likely to occur in response to the TRACE command are the following: -14 (ZCOM-ERR-NO-MEM-SPACE): The X25AM subsystem cannot obtain enough memory space to process the command. 4999 (ZX25-ERR-EMPTY-RESPONSE): The empty response record is being returned. ZSPI-TKN-ERRLIST is a standard SPI error list, as described in the SPI Programming Manual.
Commands and Responses Examples of Commands and Responses Examples of Commands and Responses The following example program, written in TAL, illustrates the basic tasks that must be performed in an application that sends commands and retrieves responses to the X25AM subsystem.
Commands and Responses Examples of Commands and Responses ! *************************************************************** ! * Sample program to demonstrate giving commands and ! * receiving responses. ! *************************************************************** ?symbols, inspect ?nocode, nomap, nolmap ! The SPI standard definitions ?nolist, source $system.zspidef.zspital ?list ! The data communications standard definitions ?nolist, source $system.zspidef.
Examples of Commands and Responses Commands and Responses ? DEBUG, FILEINFO, INITIALIZER); ?list ! External declarations for SPI procedures ?nolist, source $system.system.
Examples of Commands and Responses Commands and Responses ! *************************************************************** ! * call^scp * ! *************************************************************** INT PROC call^scp; BEGIN ! This procedure sends a command to SCP and retrieves the ! response. The value returned by call^scp is the value of ! the return token in the response.
Examples of Commands and Responses Commands and Responses ! get the value of the return token sserror := SSGETTKN(buffer, zspi^tkn^retcode, return^token); IF sserror THEN CALL handle^spi^error(sserror); ! error on the call RETURN return^token; END; ! of call^scp ! *************************************************************** ! * build^cmd * ! *************************************************************** PROC build^cmd(cmd, obj^type); INT cmd, ! the command number obj^type; ! the object type BEG
Examples of Commands and Responses Commands and Responses CALL handle^spi^error(sserror); ! error on the call ! Put the subordinate-modifier token in the buffer sub^value := zcom^val^sub^none; sserror := SSPUTTKN(buffer, zcom^tkn^sub, sub^value); IF sserror THEN CALL handle^spi^error(sserror); ! error on the call return^token := call^scp; IF return^token <> zspi^err^ok THEN ! an error occurred ! Handle the possible errors for the START LINE command END; ! of start^line ! ****************************
Examples of Commands and Responses Commands and Responses ! *************************************************************** ! * alter^line * ! *************************************************************** PROC alter^line(obj^name); INT .obj^name; ! the object name of the line whose ! attributes are to be altered BEGIN INT sserror, ! returned by call on SPI procedure return^token; ! the value of the return token INT .
Examples of Commands and Responses Commands and Responses IF sserror THEN CALL handle^spi^error(sserror); ! error on the call return^token := call^scp; IF return^token <> zspi^err^ok THEN ! an error occurred ! Handle the possible errors for the ALTER LINE command END; ! of alter^line ! *************************************************************** ! * info^line * ! *************************************************************** PROC info^line(obj^name); INT .
Examples of Commands and Responses Commands and Responses ! Handle the possible errors for the INFO LINE ! command and exit this procedure RETURN; END; ! get the value of the extensible structured token ! zx25^map^info^line sserror := SSGET(buffer, zx25^map^info^line^resp, tkn^value, 1); IF sserror THEN CALL handle^spi^error(sserror); ! error on the call ! save some of the information @info^line^value := @tkn^value; net^id := info^line^value.znetid; calling^address := info^line^value.
Examples of Commands and Responses Commands and Responses IF error THEN CALL DEBUG; ! Set up the manager name to contain the name of an ! X25AM line manager^name ':=' ["\SYS01 $X25LN03 "]; ! Set up the object name to contain the name of the line to ! be affected by the commands obj^name[0] := 8; obj^name[1] ':=' ["$LN08 "]; ! Issue commands CALL info^line(obj^name); CALL stop^line(obj^name); CALL alter^line(obj^name); CALL start^line(obj^name); CALL info^line(obj^name); ! Close SCP CALL CLOSE(scp^fil
7 Event Management The X25AM subsystem provides information about events that it detects by issuing event messages. A management application can obtain these event messages by opening an Event Management System (EMS) distributor process and requesting the messages. The application can also specify that a filter be applied to select certain event messages.
Critical Events Event Management Table 7-1.
Event-Management Programming Event Management Event-Management Programming The buffer size for an X25AM event message is 512 bytes. X25AM event messages are made up of individual tokens, each containing one piece of information about the event. There are no extensible structured tokens or lists in X25AM event messages. All X25AM event messages are reported to EMS and none are reported to the HP Tandem Maintenance and Diagnostic System (TMDS).
Event Management Event-Message Descriptions actually appear in an event message. The token ZEMS-TKN-SUBJECT-MARK always immediately precedes the subject token of an event message. For more information on the subject token, see the EMS Manual. Following the box, the event-message tokens are described in the same order in which they appeared in the box. However, because HP internal tokens are intended for HP use only, they are not described.
3: ZX25-EVT-IOBUS-ERROR Event Management 3: ZX25-EVT-IOBUS-ERROR An I/O-bus error occurred during a data transfer. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 03.
3: ZX25-EVT-IOBUS-ERROR Event Management ZEMS-TKN-LDEV is the logical device number of the X25AM line that is the subject of this event message. It corresponds to the value ldev in the text message. This token is described in the EMS Manual. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual.
Event Management 3: ZX25-EVT-IOBUS-ERROR This event can be caused by a controller generating a continuous I/O power-on interrupt. In this case, the application that is trying to communicate with the line receives an error code (usually #231, I/O power on) in response to its I/O request. This event can occur on a NonStop VLX system during a transfer between $OSP (ldev has the value 3) and the RMI. In this case, the operation is simply retried. Recovery.
4: ZX25-EVT-DEV-ERROR Event Management 4: ZX25-EVT-DEV-ERROR An error occurred on the indicated line. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 04.
4: ZX25-EVT-DEV-ERROR Event Management ZEMS-TKN-LDEV is the logical device number of the X25AM line that is the subject of this event message. It corresponds to the value ldev in the text message. This token is described in the EMS Manual. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual.
4: ZX25-EVT-DEV-ERROR Event Management Bit Meaning .7 Data set ready sensed .8 Channel parity error .9 Channel abort . 10 Character overrun . 11 Device parity error . 12 Byte count termination . 13 ETX compare . 14 Character compare . 15 Break For the byte-synchronous controller, the bits of the status word that are equal to 1 can be interpreted as follows: Bit Meaning (Write Unit) Meaning (Read Unit) .0 Power on Power on .1 Channel underrun Device overrun .
4: ZX25-EVT-DEV-ERROR Event Management If no modem loss was detected or, for a read unit, no vertical redundancy check error was reported, bits 7 through 15 of the status word have the following meanings: Bit Meaning (Write Unit) Meaning (Read Unit) .7 Byte count termination Byte count termination .8 ETB/ETX sensed .9 SOH/STX sensed . 10 . 11 State count . 12 State count . 13 . 14 .
4: ZX25-EVT-DEV-ERROR Event Management If modem loss was detected, bits 8 through 15 of the status word indicate modem status as follows: Bit Meaning .8 Data set ready (inverted) .9 Carrier detect (inverted) . 10 Clear to send (inverted) . 11 Transmit overrun . 12 RS-422 . 13 Maintenance mode . 14 Request to send . 15 Data terminal ready If no modem loss was detected, bits 8 through 15 of the status word have the following meanings: Bit Meaning (Write Unit) Meaning (Read Unit) .
6: ZX25-EVT-DEV-UP Event Management 6: ZX25-EVT-DEV-UP The operator successfully brought up the X25AM subsystem. This event is not a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 06.
6: ZX25-EVT-DEV-UP Event Management ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-FALSE, indicating that this event is not a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual. (ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the EMS Manual. In the message text, ldev corresponds to the value of ZEMS-TKN-LDEV.
7: ZX25-EVT-DEV-DOWN Event Management 7: ZX25-EVT-DEV-DOWN The indicated line has been brought down. 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 07.
7: ZX25-EVT-DEV-DOWN Event Management ZEMS-TKN-EMPHASIS contains one of the following values: ZSPI-VAL-TRUE This event is a critical event, because the X25AM subsystem brought down the line as the result of errors. ZSPI-VAL-FALSE This event is not a critical event, because the operator brought down the line. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual.
33: ZX25-EVT-LINE-QUALITY Event Management 33: ZX25-EVT-LINE-QUALITY A change in line quality has occurred on the indicated line. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 33.
33: ZX25-EVT-LINE-QUALITY Event Management ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual. (ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the EMS Manual. In the message text, ldev corresponds to the value of ZEMS-TKN-LDEV.
44: ZX25-EVT-LINE-READY Event Management 44: ZX25-EVT-LINE-READY The indicated line is now ready to accept network requests. This event is not a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 44.
44: ZX25-EVT-LINE-READY Event Management ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-FALSE, indicating that this event is not a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual. (ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the EMS Manual. In the message text, ldev corresponds to the value of ZEMS-TKN-LDEV. Cause.
45: ZX25-EVT-LINE-NOT-READY Event Management 45: ZX25-EVT-LINE-NOT-READY The modem or frame level (level 2) is not ready on the indicated line. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 45.
45: ZX25-EVT-LINE-NOT-READY Event Management ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual. (ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the EMS Manual. In the message text, ldev corresponds to the value of ZEMS-TKN-LDEV.
74: ZX25-EVT-INTERNAL-ERROR Event Management 74: ZX25-EVT-INTERNAL-ERROR 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.
74: ZX25-EVT-INTERNAL-ERROR Event Management ZEMS-TKN-LDEV is the logical device number of the X25AM line that is the subject of this event message. It corresponds to the value ldev in the text message. This token is described in the EMS Manual. ZEMS-TKN-EMPHASIS contains one of the following values: ZSPI-VAL-TRUE This event is a critical event. ZSPI-VAL-FALSE This event is not a critical event. The event message is debugging information for a following event.
90: ZX25-EVT-PROCESS-ABEND Event Management 90: ZX25-EVT-PROCESS-ABEND A missing, incorrect, or inconsistent SYSGEN parameter has been detected. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 90.
90: ZX25-EVT-PROCESS-ABEND Event Management ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual. (ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the EMS Manual. In the message text, ldev corresponds to the value of ZEMS-TKN-LDEV.
91: ZX25-EVT-SU-CLR-IND Event Management 91: ZX25-EVT-SU-CLR-IND A CLEAR INDICATION packet has been received on the Virtual Circuit in response to an already transmitted CLEAR REQUEST packet. Tokens ZSPI-TKN-SSID ZX25-TKN-SD-NAME ZX25-TKN-CLR-CAUSE ZX25-TKN-CLR-DIAG ZX25-TKN-CALLING-ADDR ZX25-TKN-CALLED-ADDR token-type token type token type token type token type token type ZSPI-TYP-SSID.
92: ZX25-EVT-SU-CLR-REQ Event Management 92: ZX25-EVT-SU-CLR-REQ A CLEAR REQUEST packet has been transmitted on the Virtual Circuit. Upon receiving a CLEAR INDICATION packet in response, the Switched Virtual Circuit (SVC) is disconnected. Tokens ZSPI-TKN-SSID ZX25-TKN-SD-NAME ZX25-TKN-CLR-CAUSE ZX25-TKN-CLR-DIAG ZX25-TKN-CALLING-ADDR ZX25-TKN-CALLED-ADDR token-type token type token type token type token type token type ZSPI-TYP-SSID.
93: ZX25-EVT-LINE-SUSPEND Event Management 93: ZX25-EVT-LINE-SUSPEND The line has entered a SUSPENDED state which might be due to a multiple path failure, or to CONMGR errors. Tokens ZSPI-TKN-SSID token-type ZSPI-TYP-SSID. Event-Message Text LDEV ldev : LINE SUSPENDED ZSPI-TKN-SSID is the X25AM subsystem ID, and its value is ZX25-VAL-SSID. This token is described in the SPI Programming Manual. In the message text, ldev corresponds to the value of ZEMS-TKN-LDEV. Cause.
95: ZX25-EVT-ACTIVEPATH-ISSUED Event Management 95: ZX25-EVT-ACTIVEPATH-ISSUED The status of the activate path request issued by the line. Tokens ZX25-TKN-REQ-STATUS ZX25-TKN-PATH-NAME ZCOM-TKN-NEW-CPU token type ZSPI-TYP-ENUM token type ZSPI-TYP-ENUM token type ZSPI-TYP- Event-Message Text X25 LINE : ACTIVATE PATH REQUEST IS {"SUCCESSFULLY ISSUED" | "FAILED"} On PATH {A | B} From CPU cpuno ZX25-TKN-REQ-STATUS represents whether the activate path request is successful. This token has two values.
96: ZX25-EVT-FRMR-OCCURED Event Management 96: ZX25-EVT-FRMR-OCCURED The occurrence of an FRMR condition on an X25AM line.
96: ZX25-EVT-FRMR-OCCURED Event Management ZX25-TKN-FRMR-SU-NAME is a conditional token and, if present, it represents the subdevice name corresponding to the Virtual Circuit on which an illegal packet has been transmitted. ZX25-TKN-FRMR-LCI is a conditional token and, if present, it represents the Logical Channel Identifier (LCI) of the Virtual Circuit on which an illegal packet has been transmitted. ZX25-TKN-FRMR-DTE-ADDR is a conditional token and, if present, represents the address of the called DTE.
109: ZX25-EVT-LCN-ERROR Event Management 109: ZX25-EVT-LCN-ERROR The X25AM subsystem detected an error on the specified logical circuit. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 109.
109: ZX25-EVT-LCN-ERROR Event Management ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual. (ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the EMS Manual. In the message text, ldev corresponds to the value of ZEMS-TKN-LDEV.
114: ZX25-EVT-RESTART-FAILED Event Management 114: ZX25-EVT-RESTART-FAILED A RESTART packet was sent repeatedly without receiving an appropriate response. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 114.
114: ZX25-EVT-RESTART-FAILED Event Management ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual. (ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the EMS Manual. In the message text, ldev corresponds to the value of ZEMS-TKN-LDEV. Cause.
115: ZX25-EVT-RESET-FAILED Event Management 115: ZX25-EVT-RESET-FAILED A RESET packet was sent repeatedly on the specified logical circuit without receiving an appropriate response. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 115.
115: ZX25-EVT-RESET-FAILED Event Management ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual. (ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the EMS Manual. In the message text, ldev corresponds to the value of ZEMS-TKN-LDEV.
116: ZX25-EVT-CLEAR-FAILED Event Management 116: ZX25-EVT-CLEAR-FAILED A CLEAR packet was sent repeatedly on the specified logical circuit without receiving an appropriate response. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 116.
116: ZX25-EVT-CLEAR-FAILED Event Management ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual. (ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the EMS Manual. In the message text, ldev corresponds to the value of ZEMS-TKN-LDEV.
146: ZX25-EVT-CSS-UNIT-ERROR Event Management 146: ZX25-EVT-CSS-UNIT-ERROR The 6100 Communications Subsystem (CSS) hardware failed while attempting to download the Communications Line Interface Processor (CLIP) or the Communications Interface Unit (CIU). This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 146.
146: ZX25-EVT-CSS-UNIT-ERROR Event Management ZEMS-TKN-LDEV is the logical device number of the X25AM line that is the subject of this event message. It corresponds to the value ldev in the text message. This token is described in the EMS Manual. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual.
146: ZX25-EVT-CSS-UNIT-ERROR Event Management 1018 The named object has been activated, and the requested operation requires that the object be suspended. 1021 The user tried to initiate a trace on a data link with a trace already in progress. 1022 The Communications Management Interface (CMI) request contained an invalid message TYPE. 1023 CSM received an attribute value that was invalid for one or more of the following reasons: 1. The value exceeded the allowed range. 2.
147: ZX25-EVT-CSS-PROBE-ERROR Event Management Recovery. Analyze the failure by looking at the CSM error code given by param3 in the text message and at the accompanying event or error message. Then issue a CMI STOP command against the object before trying to start it again. 147: ZX25-EVT-CSS-PROBE-ERROR The 6100 Communications Subsystem Manager (CSM) received a status probe response from the Communications Line Interface Processor (CLIP) indicating it is in the boot state instead of the run state.
147: ZX25-EVT-CSS-PROBE-ERROR Event Management ZEMS-TKN-LDEVNAME is the name of the X25AM line that is the subject of this event message. This token is described in the EMS Manual. ZEMS-TKN-LDEV is the logical device number of the X25AM line that is the subject of this event message. It corresponds to the value ldev in the text message. This token is described in the EMS Manual. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event.
147: ZX25-EVT-CSS-PROBE-ERROR Event Management If the In Boot bit is equal to 1, the CLIP is operating from the bootstrap, where the command set is limited. The Error field typically reports fatal errors; that is, errors that force the CLIP to reenter the bootstrap from running code.
152: ZX25-EVT-CSS-CLB-CMD-REJECT Event Management 152: ZX25-EVT-CSS-CLB-CMD-REJECT The Break Out Board (BOB) of the 6100 Communications Subsystem (CSS) was not properly synchronized with the host. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 152.
152: ZX25-EVT-CSS-CLB-CMD-REJECT Event Management ZEMS-TKN-LDEV is the logical device number of the X25AM line that is the subject of this event message. It corresponds to the value ldev in the text message. This token is described in the EMS Manual. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual.
156: ZX25-EVT-CSS-NO-RESPONSE Event Management 156: ZX25-EVT-CSS-NO-RESPONSE The Communications Line Interface Processor (CLIP) failed to respond to a periodic probe by a line-handler process. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 156.
156: ZX25-EVT-CSS-NO-RESPONSE Event Management ZEMS-TKN-LDEV is the logical device number of the X25AM line that is the subject of this event message. It corresponds to the value ldev in the text message. This token is described in the EMS Manual. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual.
157: ZX25-EVT-CSS-FRAME-ERROR Event Management 157: ZX25-EVT-CSS-FRAME-ERROR An invalid frame was received. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 157.
157: ZX25-EVT-CSS-FRAME-ERROR Event Management ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual. (ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the EMS Manual. In the message text, ldev corresponds to the value of ZEMS-TKN-LDEV.
158: ZX25-EVT-CSS-UNEXPECTED-BKPT Event Management 158: ZX25-EVT-CSS-UNEXPECTED-BKPT The Communications Line Interface Processor (CLIP) of the 6100 Communications Subsystem (CSS) encountered an unexpected break-point. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 158.
158: ZX25-EVT-CSS-UNEXPECTED-BKPT Event Management ZEMS-TKN-LDEV is the logical device number of the X25AM line that is the subject of this event message. It corresponds to the value ldev in the text message. This token is described in the EMS Manual. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual.
160: ZX25-EVT-CSS-LIU-CONFIG-ERROR Event Management 160: ZX25-EVT-CSS-LIU-CONFIG-ERROR 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 a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 160.
160: ZX25-EVT-CSS-LIU-CONFIG-ERROR Event Management ZEMS-TKN-LDEV is the logical device number of the X25AM line that is the subject of this event message. It corresponds to the value ldev in the text message. This token is described in the EMS Manual. ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual.
220: ZX25-EVT-CALL-TIMEOUT Event Management 220: ZX25-EVT-CALL-TIMEOUT The remote system did not respond to a call request. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 220.
220: ZX25-EVT-CALL-TIMEOUT Event Management ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual. (ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the EMS Manual. In the text message, ldev corresponds to the value of ZEMS-TKN-LDEV.
224: ZX25-EVT-SVC-OUT-OF-ORDER Event Management 224: ZX25-EVT-SVC-OUT-OF-ORDER The switched virtual circuit could not be cleared. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 224.
224: ZX25-EVT-SVC-OUT-OF-ORDER Event Management ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual. (ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the Event Management System (EMS) Manual. In the message text, ldev corresponds to the value of ZEMS-TKN-LDEV.
225: ZX25-EVT-PVC-OUT-OF-ORDER Event Management 225: ZX25-EVT-PVC-OUT-OF-ORDER The permanent virtual circuit could not be reset. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 225.
225: ZX25-EVT-PVC-OUT-OF-ORDER Event Management ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual. (ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the EMS Manual. In the message text, ldev corresponds to the value of ZEMS-TKN-LDEV.
226: ZX25-EVT-LCN-OPERATIONAL Event Management 226: ZX25-EVT-LCN-OPERATIONAL A problem with an LCN reported by an earlier event message has been solved. This event is not a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 226.
226: ZX25-EVT-LCN-OPERATIONAL Event Management ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-FALSE, indicating that this event is not a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual. (ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the EMS Manual.
229: ZX25-EVT-NO-MEMORY Event Management 229: ZX25-EVT-NO-MEMORY The X25AM subsystem cannot allocate packet buffers. This event is a critical event, and the event message is reported to the EMS collector, $0. This event message is equivalent to console message 229.
Examples of Filters Event Management ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating that this event is a critical event. This token is described in the EMS Manual. ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This token is described in the EMS Manual. (ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and USERID are standard EMS tokens described in the EMS Manual. The value nnn in the text message does not correspond to the value of a token in the event message. Cause.
Examples of Filters Event Management Example 1 The following filter selects all of the X25AM event messages. -- Filter that selects only event messages issued by the -- X25AM subsystem.
Examples of Filters Event Management Example 2 The following filter selects all critical X25AM event messages that have a particular line as their subject.
A Error Numbers and Error Lists This appendix describes the error numbers that are provided by the X25AM subsystem (that is, the values whose symbolic names begin with ZX25-ERR-). These error numbers can occur as values of the return token, ZSPI-TKN-RETCODE, and as part of the value of the error token, ZSPI-TKN-ERROR.
510: ZX25-ERR-SUBDEV-OPEN Error Numbers and Error Lists 510: ZX25-ERR-SUBDEV-OPEN This error number indicates that the STOP command is not completed because the subdevice is open. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ENDLIST token-type token-type token-type token-type token-type ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-SSCTL. ZSPI-TKN-ERROR is the standard SPI error token, as described in the SPI Programming Manual.
511: ZX25-ERR-ATTRIBUTES-INCONSIST Error Numbers and Error Lists 511: ZX25-ERR-ATTRIBUTES-INCONSIST This error number indicates that attributes are inconsistent. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-PARM-ERR ZSPI-TKN-ENDLIST token-type token-type token-type token-type token-type token-type ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-PARM-ERR. ZSPI-TYP-SSCTL.
512: ZX25-ERR-OBJ-NAME-NOT-SUPP Error Numbers and Error Lists 512: ZX25-ERR-OBJ-NAME-NOT-SUPP This error number indicates that the object name is not supported by the X25AM subsystem. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ENDLIST token-type token-type token-type token-type token-type ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-SSCTL. ZSPI-TKN-ERROR is the standard SPI error token, as described in the SPI Programming Manual.
513: ZX25-ERR-TKN-VAL-COMB-INV Error Numbers and Error Lists 513: ZX25-ERR-TKN-VAL-COMB-INV This error number indicates that the command was rejected because of an invalid token values combination. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-PARM-ERR ZSPI-TKN-ENDLIST token-type token-type token-type token-type token-type token-type ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-PARM-ERR. ZSPI-TYP-SSCTL.
514: ZX25-ERR-TRACE-BKUP-UNKNOWN Error Numbers and Error Lists 514: ZX25-ERR-TRACE-BKUP-UNKNOWN This error number indicates that the command was rejected because of an unknown trace return error. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ENDLIST token-type token-type token-type token-type token-type ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-SSCTL. ZSPI-TKN-ERROR is the standard SPI error token, as described in the SPI Programming Manual.
515: ZX25-ERR-TRACE-FUNC-UNKNOWN Error Numbers and Error Lists 515: ZX25-ERR-TRACE-FUNC-UNKNOWN This error number indicates that the command was rejected because of an unknown trace function error. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ENDLIST token-type token-type token-type token-type token-type ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-SSCTL. ZSPI-TKN-ERROR is the standard SPI error token, as described in the SPI Programming Manual.
516: ZX25-ERR-DISCON-PVC-NOT-SUPP Error Numbers and Error Lists 516: ZX25-ERR-DISCON-PVC-NOT-SUPP This error number indicates that the DISCONNECT command is not supported when the circuit is PVC. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ENDLIST token-type token-type token-type token-type token-type ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-SSCTL. ZSPI-TKN-ERROR is the standard SPI error token, as described in the SPI Programming Manual.
517: ZX25-ERR-EXTFORMAT-NOT-ALLOW Error Numbers and Error Lists 517: ZX25-ERR-EXTFORMAT-NOT-ALLOW This error number indicates that using SPI to turn on EXTFORMAT is not allowed. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ENDLIST token-type token-type token-type token-type token-type ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-SSCTL. ZSPI-TKN-ERROR is the standard SPI error token, as described in the SPI Programming Manual.
Error Numbers and Error Lists 4999: ZX25-ERR-EMPTY-RESPONSE 4999: ZX25-ERR-EMPTY-RESPONSE This error number indicates an empty response record. No error list is associated with this error number. Cause. This error number is returned in the following two cases: 1. You have assigned the value ZSPI-VAL-ERR-AND-WARN to the token ZSPI-TKNRESPONSE-TYPE (meaning that you want to see a response only if there is an error or warning), and no errors or warnings occurred during processing of the command.
B Token Codes and Token Maps Table B-1 is a summary table of all token codes that are specific to the X25AM subsystem (that is, token codes whose names begin with ZX25-TKN-). For each token code, the token type is given. The symbolic name of the token number of a token code can be derived from the name of the token code by replacing -TKN- with -TNM-; for example, token code ZX25-TKNX1 has the token number ZX25-TNM-X1.
Token Codes and Token Maps X25AM Management Programming Manual—528037-001 B- 2
Index A ABORT command 6-6 Action events 7-3 Activate path request 7-30 ADD command 6-10 ALLOWOPENS command 6-22 ALTER LINE command 6-26 ALTER PROCESS command 6-38 ALTER SUBDEVICE command 6-42 Application relationship to architecture 2-2 Applications naming rules and guidelines for 3-2 obtaining event messages 2-6 programmatic commands used by 2-2 using letter Z in 3-2 Architecture of X25AM subsystem 1-2 relationship of application to 2-2 Attributes inconsistent A-3 B Buffer declarations 5-9 Buffer size for
D Index Commands (continued) STATUS 6-128 STOP 6-137 subordinate-modifier token in 4-1 SWITCH 6-141 symbolic names of 6-1 TRACE 6-145 Commands and responses description 6-1 examples of 6-149 Common definitions 5-1 Common syntax elements 3-2 Communications Management Interface 1-3 Communications Utility Program 1-3 Conditional tokens 7-3 Console messages 7-4 Constructs involving multiple tokens 3-6 Continuation of commands 4-1 of responses 4-2 Control-and-inquiry interface 1-3 Critical events 7-2 CUP 1-3
F Index Event messages (continued) text version of 7-4 unconditional tokens in 7-3 X25AM subsystem ID in 7-1 Event numbers 3-4 Events action 7-3 critical 7-2 management of 7-1 noncritical 7-2 processes that report 7-1 Event-Management Programming 7-3 Event-management programming 7-3 Event-number token 5-5 Examples of commands and responses 6-149 of filters 7-66 Examples of Filters 7-66 Extensible structured tokens definition 3-5 in commands 3-5 in event messages 7-3 in responses 3-5 using SSNULL to initia
M Index Line-handler processes (continued) switching between CIU paths 6-141 switching between processors 6-141 line-handler processes X25AM subsystem 1-1 link state not ready 7-29 LISTOBJECTS command of all objects 6-88 of lines or subdevices 6-91 Lists data lists 3-6 error lists 3-6 in event messages 7-3 M Management application See Applications Management functions, required 1-1 Management programming 2-1 Manager token 5-3 Manuals, prerequisite 2-6 Multiple tokens, constructing involving 3-6 N Names
R Index PUP 1-3 R Receiving the response buffer 4-2 Required management functions 1-1 RESETSTATS command 6-95 Response buffer, receiving and decoding 4-2 Response records duplicate occurrences of tokens in 4-2 empty 4-3 multiple 4-2 number of in one reply message 4-2 number of objects described in 4-3 selecting kind to be returned 4-3 tokens in 6-4 Responses components of 3-6 continuation of 4-2 decoding the buffer for 4-2 description 6-1 examples of 6-149 extensible structured tokens in 3-5 notation use
T Index SWITCH command 6-141 Syntax elements, common 3-2 T Token codes defined by X25AM subsystem B-1 Token maps defined by X25AM subsystem B-1 definition 3-5 Token numbers, symbolic names of B-1 Token value combination invalid A-5 Tokens categories of in event messages 7-3 conditional 7-3 constructs involving multiple 3-6 definition 3-1 duplicate occurrences of in commands 6-7 extensible structured in one response record 6-4 optional 6-4 order of in commands 6-4 order of in event messages 7-3 order of i
Z Index X25AM subsystem (continued) data communications standard definitions used by 5-5 definitions provided by 5-9 elements of SPI messages for 3-1 EMS definitions used by 5-4 error handling in 4-3 error lists issued by A-1 error numbers issued by A-1 event message subject issued by 3-4 event messages issued by 7-1 format of object names for 3-3 interfaces to 1-2 management programming for 2-1 object types supported by 3-3 objects controlled by 1-1 obtaining server version of 6-64 programming considerat
Z Index ZCOM-ERR- (continued) MAX-LIMIT-EXCEEDED in ADD command 6-20 NO-MEM-SPACE in ADD command 6-20 in ALTER LINE command 6-36 in ALTER SUBDEVICE command 6-52 in RESETSTATS command 6-108 in STATISTICS command 6-126 in STATUS command 6-135 in TRACE command 6-148 OBJNAME-INV in DISCONNECT command 6-58 OBJ-ALRDY-IN-SUMSTATE in ABORT command 6-8 in START command 6-112 in STOP command 6-139 OBJ-NOT-FOUND in ABORT command 6-8 in ALLOWOPENS command 6-24 in ALTER LINE command 6-36 in ALTER SUBDEVICE command 6-5
Z Index ZCOM-OBJLINE 5-7 NULL 5-7 PROCESS 5-7 SU 5-7 ZCOM-TKNNEW-CPU 7-30 OBJNAME 5-7 OBJTYPE 5-7 SUB 5-7 SWITCH-CPU in ALTER PROCESS command 6-39 in SWITCH command 6-142 SWITCH-PATH in ALTER PROCESS command 6-39 in SWITCH command 6-142 TRACE-OPT 6-146 ZCOM-VALPATH-A 5-8 PATH-B 5-8 SUB-ALL 5-8 SUB-NONE 5-8 SUB-ONLY 5-8 SUMSTATE-DIAG 5-9 SUMSTATE-STARTED 5-9 SUMSTATE-STOPPED 5-9 ZEMS-TKNCONSOLE-PRINT 5-5 EMPHASIS 7-6 EVENTNUMBER 5-5 LDEV 5-5 LDEVNAME 5-5 SUBJECT-MARK 7-5 ZPVC field 6-16 ZSPI-ERROK 4-3 ZSPI
Z Index ZX25-EVTACTIVEPATH-ISSUED 7-30 CALL-TIMEOUT 7-57 CLEAR-FAILED 7-39 CSS-CLB-CMD-REJECT 7-47 CSS-FRAME-ERROR 7-51 CSS-LIU-CONFIG-ERROR 7-55 CSS-NO-RESPONSE 7-49 CSS-PROBE-ERROR 7-44 CSS-UNEXPECTED-BKPT 7-53 CSS-UNIT-ERROR 7-41 DEV-DOWN 7-15 DEV-ERROR 7-8 DEV-UP 7-13 FRMR-OCCURED 7-31 INTERNAL-ERROR 7-23 IOBUS-ERROR 7-5 LCN-ERROR 7-33 LCN-OPERATIONAL 7-63 LINE-IS-NOT-READY 7-29 LINE-NOT-READY 7-21 LINE-QUALITY 7-17 LINE-READY 7-19 LINE-SUSPEND 7-29 NO-MEMORY 7-65 PROCESS-ABEND 7-25 PVC-OUT-OF-ORDER 7
Z Index ZX25-MAP- (continued) ZBLOCK-PAD-PARAMS fields 6-29 ZCALLING-ADDR fields 6-29 ZCALLS fields 6-30 ZCHAR-SET fields 6-30 ZCONV-PAD-CNT field 6-31 ZCONV-PAD-PARAMS field 6-31 ZCUG field 6-31 ZCUG-TYPE field 6-34 ZDEBUG field 6-31 ZDSR-TIMEOUT field 6-31 ZEXT-CALL-FORMAT field 6-32 ZFILLER field 6-29 ZFRAME-MODE field 6-32 ZIDLE-TIMEOUT field 6-32 ZINTRF field 6-32 ZL3-MOD field 6-32 ZL3-WINDOW field 6-33 ZNETID field 6-28 ZPROG field 6-33 ZPVC-RANGE field 6-33 ZRETRIES field 6-33 ZREXMIT-TIMEOUT fiel
Z Index ZX25-MAP- (continued) ZCKT-NUM field 6-72 ZCONV-PAD-CNT field 6-72 ZCONV-PAD-PARAMS field 6-72 ZCUG field 6-73 ZCUG-TYPE field 6-77 ZDEBUG field 6-73 ZDSR-TIMEOUT field 6-73 ZEXT-CALL-FORMAT field 6-73 ZFILLER field 6-77 ZFRAME-MODE field 6-73 ZIDLE-CMD-RR field 6-74 ZIDLE-TIMEOUT field 6-74 ZINTRF field 6-74 ZL2-DISC field 6-74 ZL2-WINDOW field 6-74 ZL3-MOD field 6-74 ZL3-WINDOW field 6-74 ZLINE-TYPE field 6-75 ZMAX-IO-SIZE field 6-78 ZNETID field 6-75 ZPAGE6520-BLOCK-SIZE field 6-76 ZPKT-SIZE fi
Z Index ZX25-MAP- (continued) RSTATS-LINE description of 6-99 structure of 6-95 ZBAD-ADDR-ERR field 6-103 ZBAD-LEN-ERR field 6-103 ZBCC-ERR field 6-100 ZCALL-CONF-RECV field 6-106 ZCALL-CONF-SENT field 6-105 ZCALL-REQS-RECV field 6-106 ZCALL-REQS-SENT field 6-105 ZCLEAR-CONF-RECV field 6-106 ZCLEAR-CONF-SENT field 6-104 ZCLEAR-REQS-RECV field 6-106 ZCLEAR-REQS-SENT field 6-104 ZCLIP-DRV structure 6-103 ZDATA-PKT-RECV field 6-106 ZDATA-PKT-SENT field 6-105 ZDIAG-RECV field 6-105 ZDIAG-SENT field 6-104 ZDIS
Z Index ZX25-MAP- (continued) ZRESTART-REQS-SENT field 6-104 ZRNR-PKT-RECV field 6-106 ZRNR-PKT-SENT field 6-105 ZRNR-RECV field 6-102 ZRNR-SENT field 6-102 ZRR-PKT-RECV field 6-106 ZRR-PKT-SENT field 6-105 ZRR-RECV field 6-102 ZRR-SENT field 6-101 ZSABM-RECV field 6-102 ZSABM-SENT field 6-102 ZSREJ-RECV field 6-102 ZSREJ-SENT field 6-102 ZS-RECV field 6-101 ZS-SENT field 6-101 ZT1-TIMEOUT field 6-103 ZTMSTP field 6-99 ZTMSTP-LAST field 6-99 ZTOTAL-AVAIL field 6-99 ZUA-RECV field 6-103 ZUA-SENT field 6-10
Z Index ZX25-MAP- (continued) ZI-P-SENT field 6-120 ZI-RECV field 6-119 ZI-SENT field 6-119 ZLINE-QUAL field 6-119 ZLOCALPOOL structure 6-118 ZMODEM structure 6-119 ZMODEM-ERR field 6-122 ZNO-BUF-ERR field 6-119, 6-122 ZOVERRUN-CNT field 6-119 ZOVERRUN-ERR field 6-122 ZPKTS-RECV field 6-123 ZPKTS-SENT field 6-123 ZPKT-DETL structure 6-123 ZPKT-OVERALL structure 6-122 ZPKT-RECV structure 6-124 ZPKT-SENT structure 6-123 ZRECV-ABORTS field 6-122 ZREJ-PKT-RECV field 6-125 ZREJ-PKT-SENT field 6-124 ZREJ-RECV f
Z Index ZX25-MAP- (continued) ZIN-USE field 6-131 ZLAST-ERR field 6-132 ZLDEV field 6-131 ZLINK-STATE field 6-131 ZPATH field 6-132 ZPPID field 6-131 ZSTATE field 6-131 ZTOTAL-SU-NUM field 6-132 STATUS-SU description of 6-133 structure of 6-129 ZDEV-TYPE field 6-134 ZLAST-ERR field 6-134 ZREC-SIZE field 6-134 ZSTATE field 6-134 ZSU-NUM field 6-134 ZX25-TKNCALLED-ADDR 7-27 CALLING-ADDR 7-27 CLR-CAUSE 7-27 CLR-DIAG 7-27 FRMR-COUNT 7-32 FRMR-CURR-VR 7-31 FRMR-CURR-VS 7-31 FRMR-DTE-ADDR 7-32 FRMR-FRAME-TYPE 7
Z Index ZX25-VAL- (continued) EVEN 6-15, 6-47, 6-81 NONE 6-15, 6-47, 6-81 ODD 6-15, 6-47, 6-81 PROTOITI 6-13, 6-44, 6-79 NAM 6-13, 6-44, 6-79 PTP 6-13, 6-44, 6-79 SSID description of 5-11 structure of 5-4 TRACE-OPTCLBI 6-146 ZX25-VAL- (continued) CLBO 6-146 CLIP 6-146 CLIPDI 6-147 CLIPDO CLIP 6-147 CLIPL2 6-147 L0 6-146 L1 6-146 L2 6-146 L3 6-146 L4 6-146 TWO-WAY-CALLS 6-30, 6-72 VERSION 5-11 Z, using in applications 3-2 X25AM Management Programming Manual—528037-001 Index -17
Z Index X25AM Management Programming Manual—528037-001 Index -18
