OSI/MHS Management Programming Manual

ManualsBrandsHP ManualsServerHP NonStop G-Series

OSI/MHS Management

Programming Manual

Abstract

This manual provides subsystem-specific information about the management

programming interfaces to the Compaq OSI/MHS subsystem. You should read this

manual if you are an experienced Transaction Application Language (TAL), C, or

COBOL85 programmer writing applications that need to control or monitor the

OSI/MHS subsystems or a TACL user writing macros or routines that control or monitor

the OSI/MHS subsystem.

Product Version

OSI/MHS D42

Supported Releases

This manual supports G06 and D41 releases and all subsequent releases until otherwise

indicated in a new edition.

Part Number Published

424824-001 December 1999

Summary of content (864 pages)

PAGE 1
OSI/MHS Management Programming Manual Abstract This manual provides subsystem-specific information about the management programming interfaces to the Compaq OSI/MHS subsystem. You should read this manual if you are an experienced Transaction Application Language (TAL), C, or COBOL85 programmer writing applications that need to control or monitor the OSI/MHS subsystems or a TACL user writing macros or routines that control or monitor the OSI/MHS subsystem.
PAGE 2
Document History Part Number Product Version Published 069673 Vol 1 095220 Vol 2 OSI/MHS C32 March 1993 099932 OSI/MHS D20 September 1993 104441 OSI/MHS D21 May 1994 112154 OSI/MHS D22 June 1995 132298 OSI/MHS D41 February 1997 424824-001 OSI/MHS D42 December 1999 Ordering Information For manual ordering information: domestic U.S. customers, call 1-800-243-6886; international customers, contact your local sales representative.
PAGE 3
OSI/MHS Management Programming Manual Glossary Index Figures Tables What’s New in This Manual xv Manual Information xv New and Changed Information xv About This Manual xvii Who Should Read This Manual? xvii What’s in This Manual? xviii The OSI/MHS Manual Set xviii xx Related Manuals Your Comments Invited xxiii Notation Conventions xxiii Abbreviations xvii 1.
PAGE 4
1. Introduction to Management Programming for OSI/MHS (continued) Contents 1.
PAGE 5
3. SPI Programming Considerations for OSI/MHS (continued) Contents 3.
PAGE 6
4. Common Definitions (continued) Contents 4. Common Definitions (continued) Extensible Structures 4-30 Fixed Structures 4-31 Predefined Token and Field Values 4-32 Other Tokens 4-34 5.
PAGE 7
5. Commands and Responses (continued) Contents 5.
PAGE 8
5. Commands and Responses (continued) Contents 5.
PAGE 9
5. Commands and Responses (continued) Contents 5. Commands and Responses (continued) STATUS SUBSYS STOP APPL 5-281 5-283 STOP CLASS 5-285 STOP GROUP 5-287 STOP MON 5-289 5-291 STOP SUBSYS SUSPEND APPL SWITCH MON TRACE MON 5-293 5-295 5-297 TRACE PROCESS 5-300 6.
PAGE 10
6. Event Messages (continued) Contents 6.
PAGE 11
7. Password Server Interfaces Contents 7.
PAGE 12
A. Errors and Error Lists (continued) Contents A.
PAGE 13
C. Examples (continued) Contents C. Examples (continued) 5. Start EMS Printing Distributor Password Server Example C-28 C-29 Prerequisites C-30 Overview of Tasks C-30 Example in C C-31 Password Server Database C-58 D. Reason and Diagnostic Codes Reason Codes D-1 Diagnostic Codes D-2 Glossary Index Figures Figure i. OSI/MHS Manual Set xviii Figure ii. Related Documentation xx Figure 1-1. Command and Response Interface 1-2 Figure 1-2.
PAGE 14
Tables Contents Tables Table 1-1. Process Objects in Each Group and Class 1-13 Table 1-2. Interactive (SCF) Commands and Programmatic Commands (page 1 of 5) 1-17 Table 4-1. SPI Standard Definitions for Header Tokens Table 4-2. SPI Standard Definitions for Other Simple Tokens (page 1 of 2) Table 4-3. SPI Standard Definitions for Token Types Table 4-4. SPI Standard Definitions for Fixed Structures Table 4-5. SPI Standard Definitions for Value Names 4-4 Table 4-6.
PAGE 15
Tables (continued) Contents Tables (continued) Table 7-7. OSI/MHS Event Messages, MS Password Server Interface— Register-MS 7-19 Table 7-8. OSI/MHS Event Messages, MS Password Server Interface—MHS Manager Process 7-19 Table 7-9. Contents of Audit Trail File 7-24 Table 7-10. MPS Files on ISV (page 1 of 2) 7-65 Table A-1. OSI/MHS Errors (page 1 of 2) Table B-1. OSI/MHS Token Codes and Token Types (page 1 of 5) Table B-2.
PAGE 16
Contents OSI/MHS Management Programming Manual—424824-001 xiv
PAGE 17
What’s New in This Manual Manual Information Abstract This manual provides subsystem-specific information about the management programming interfaces to the Compaq OSI/MHS subsystem. You should read this manual if you are an experienced Transaction Application Language (TAL), C, or COBOL85 programmer writing applications that need to control or monitor the OSI/MHS subsystems or a TACL user writing macros or routines that control or monitor the OSI/MHS subsystem.
PAGE 18
What’s New in This Manual New and Changed Information OSI/MHS Management Programming Manual—424824-001 xvi
PAGE 19
About This Manual The OSI/MHS Management Programming Manual provides subsystem-specific information about the management programming interfaces to the Compaq OSI/MHS subsystem. These interfaces are based on the Subsystem Programmatic Interface (SPI) and the Event Management Service (EMS). They allow applications to send commands to, and monitor events reported by, the OSI/MHS subsystem. This manual serves as both a reference manual and a programmer’s guide.
PAGE 20
What’s in This Manual? About This Manual What’s in This Manual? In this manual, the following sections give background information and programming considerations: • • • • • The architecture of the OSI/MHS subsystem and how a management application fits into it (Section 1, Introduction to Management Programming for OSI/MHS) The types of objects managed by OSI/MHS and the operations necessary to manage these objects (Section 1, Introduction to Management Programming for OSI/MHS) The kinds of events report
PAGE 21
About This Manual • • • • • • • The OSI/MHS Manual Set OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide contains information to teach TAL and C programmers how to use the Compaq OSI/MHS GPI product effectively. OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual contains reference information for TAL and C programmers using the GPI library procedures.
PAGE 22
Related Manuals About This Manual Figure i. OSI/MHS Manual Set OSI/MHS Orientation Guide Concepts OSI/MHS GPI Programming Guide OSI/MHS GPI Reference Manual OSI/MHS Configuration and Management Manual OSI/MHS Administrative Utility (AU) Manual OSI/MHS P7 API Manual Programming Management Methods and Tools Management Reference for Operators Operator Messages Manual Reference for Automating Management OSI/MHS Management Programming Manual OSI/MHS SCF Reference Manual CDT 999.
PAGE 23
Related Manuals About This Manual • • • Guardian Programmer’s Guide describes how to use the operating system procedure calls, including the file-system procedures. Guardian Procedure Calls Reference Manual gives the syntax and procedurespecific programming considerations for all the operating system procedure calls.
PAGE 24
Related Manuals About This Manual Figure ii.
PAGE 25
Your Comments Invited About This Manual Your Comments Invited After using this manual, please take a moment to send us your comments. You can do this by returning a Reader Comment Card or by sending an Internet mail message. A Reader Comment Card is located at the back of printed manuals and as a separate file on the User Documentation disc. You can either fax or mail the card to us. The fax number and mailing address are provided on the card.
PAGE 26
General Syntax Notation About This Manual each side of the list, or horizontally, enclosed in a pair of brackets and separated by vertical lines. For example: FC [ num ] [ -num] [ text] K [ X | D ] address-1 { } 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 may 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.
PAGE 27
Notation for Messages About This Manual Line Spacing. If the syntax of a command is too long to fit on a single line, each continuation line is indented three spaces and is separated from the preceding line by 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 / ] CONTROLLER [ , attribute-spec ]... !i and !o.
PAGE 28
Notation for Messages 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. For example: Event number = number [ Subject = first-subject-value ] A group of items enclosed in brackets is a list of all possible items that can be displayed, of which one or none might actually be displayed.
PAGE 29
Abbreviations About This Manual Abbreviations ADMD. Administration management domain API. Application program interface APIA. Application Program Interface Association ASN.1. Abstract Syntax Notation One AU. Access unit BER. Basic encoding rules CCITT. International Telegraph and Telephone Consultative Committee DDL. Data Definition Language (Compaq term) DSM. Distributed Systems Management (Compaq term) EDI. electronic data interchange EDIM. EDI message EDIMG. EDI messaging EDIMS.
PAGE 30
Abbreviations About This Manual IM. Interpersonal messaging IPC. Interprocess communication IPM. Interpersonal message IPN. Interpersonal notification ISO. International Organization for Standards MD. Management domain MH. Message handling MHS. Message handling system MOTIS. Message-Oriented Text Interchange System MPDU. Message protocol data unit MR. Message relay MRP. Message relay process MS. Message store MTA. Message transfer agent MTS. Message transfer system NBPS. Nonbasic parameters OM.
PAGE 31
Abbreviations About This Manual PRMD. Private management domain RTS. Reliable transfer service RTSE. Reliable Transfer Service Entity SC. Store cleaner SCF. Subsystem Control Facility (Compaq term) SCP. Subsystem Control Point (Compaq term) SPI. Subsystem Programmatic Interface (Compaq term) TAL. Transaction Application Language (Compaq term) TMF. Transaction Management Facility (Compaq term) UA. User agent UTC. Universal Coordinated Time XAPIA. X.
PAGE 32
Abbreviations About This Manual OSI/MHS Management Programming Manual—424824-001 xxx
PAGE 33
1 Introduction to Management Programming for OSI/MHS The Compaq Open Systems Interconnection/Message Handling System (OSI/MHS) enables people and application processes to exchange messages within a network of computer systems. OSI/MHS is based on the CCITT X.400 series of recommendations. Your Compaq implementation may contain several OSI/MHS subsystems connected across a complex computer network.
PAGE 34
Introduction to Management Programming for OSI/MHS What Is Management Programming? by a management program that automates operator functions. In either case, the Subsystem Programmatic Interface (SPI) is used to communicate with the subsystem. What Is Management Programming? Management programming is a way to automate many routine management tasks and free human operators to do work requiring judgement and creativity.
PAGE 35
Introduction to Management Programming for OSI/MHS How Does Management Programming Apply to OSI/MHS? Figure 1-2. Event Message or Accounting Message Interface Event Message or Accounting Message OSI/MHS Human Operator Or Application Program Subsystem CDT 002.CDD The programs that perform these functions are called management applications or programmed operators.
PAGE 36
Introduction to Management Programming for OSI/MHS Why Use Management Programming for OSI/MHS? Why Use Management Programming for OSI/MHS? In some situations, it is desirable to use a programmatic interface, rather than an interactive interface, to manage a subsystem such as OSI/MHS.
PAGE 37
Introduction to Management Programming for OSI/MHS • OSI/MHS Subsystem Architecture PAM (for G06 and above releases) If your OSI/MHS system includes RFC-1006 support, it can communicate with the Internet by running TCP/IP over TLAM or X25AM or PAM. OSI/MHS provides the following gateway interfaces: • • Transfer X400 gateway Gives Compaq Transfer PS mail users access to the X.400 network Gateway programmatic interface (GPI) Gives proprietary messaging system users access to the X.
PAGE 38
Introduction to Management Programming for OSI/MHS OSI/MHS Subsystem Architecture Figure 1-3. Architectural Overview of OSI/MHS User User PS Mail Transfer Subsystem Proprietary Message System Transfer X400 Gateway GPI X.400 Gateway OSI/MHS Subsystem GI Group RS Group GIP User User Local UA Local UA LO Group RS LO MR Group MS Group SC MRP MS RTS OSI/AS OSI/TS TCP/IP X25AM X25AM TLAM Internet X.
PAGE 39
Introduction to Management Programming for OSI/MHS Control-and-Inquiry Interface Control-and-Inquiry Interface All of the processes in OSI/MHS are controlled by the MHS manager. The MHS manager is a key component in the control-and-inquiry interface. Figure 1-4 shows the management interface to OSI/MHS for commands and responses. The management of the OSI/MHS subsystem requires the Subsystem Control Point (SCP) process.
PAGE 40
Introduction to Management Programming for OSI/MHS Event-Management Interface Event-Management Interface Event and accounting messages from OSI/MHS are made available to management applications by the Event Management Service (EMS). EMS collects, logs, and distributes event messages that provide information to help you monitor the OSI/MHS subsystem, analyze failures, and recognize and handle critical problems.
PAGE 41
Introduction to Management Programming for OSI/MHS Event-Management Interface Figure 1-5. OSI/MHS Event Management Interface OSI/MHS Subsystem LO Group MR Group MS Group GI Group RS Group MHS Manager Event Management Service (EMS) Accounting Messages Event Messages Alternate Collector Primary Collector Event Log Event Log Distributor Management Application Filter CDT 105.CDD Figure 1-6 shows the following sequence of events: 1. An event occurs in the subsystem environment. 2.
PAGE 42
Introduction to Management Programming for OSI/MHS OSI/MHS Object Types 5. The application can then open an EMS consumer distributor and request an event message. 6. The distributor reads the log and returns to the application the next event message that satisfies the conditions of the filter. 7. The application can present the message to the operator or take action itself. Figure 1-6.
PAGE 43
Introduction to Management Programming for OSI/MHS APPL Object The OSI/MHS object types are: APPL GATEWAY CLASS GROUP CUG MON CUGMEMBER MTA DLIST PROCESS DLISTMEMBER ROUTE ENTRY SUBSYS In addition, the NULL object type is defined for use in commands that do not require specification of a particular object type. The OSI/MHS object types are described on the following pages.
PAGE 44
Introduction to Management Programming for OSI/MHS CLASS Object CLASS Object The CLASS object type identifies a group class to the OSI/MHS subsystem. It is used to configure and control individual OSI/MHS groups.
PAGE 45
Introduction to Management Programming for OSI/MHS ENTRY Object ENTRY Object The ENTRY object type inquires about OSI/MHS queues where messages may be pending. Three types are valid for the ENTRY object: #LINKRETRY, #ROUTERETRY, and #DEFERRED.
PAGE 46
Introduction to Management Programming for OSI/MHS MON Object The group name can have an optional node name, but it must be the same as the name of the node on which the MHS manager resides. If the node name is omitted, the local system is assumed. Examples of group names include: $ZMHS.#MS.GRP1 $ZMHS.#MR.\COMM.GRP1. MON Object The MON object type enables you to address commands to the MHS manager. The MON object name identifies the MHS manager. It has the same name as the null object.
PAGE 47
Introduction to Management Programming for OSI/MHS ROUTE Object ROUTE Object The ROUTE object type defines primary and alternate routing information to the OSI/MHS subsystem. It is used to access the routing database for routing information about users and to reconfigure users. Examples of ROUTE object names include: $ZMHS.#NEWYORK.PROUTE $ZMHS.#TOKYO.VIAEAST $ZMHS.#HN.VIASATELLITE SUBSYS Object The SUBSYS object type identifies an entire OSI/MHS subsystem.
PAGE 48
Introduction to Management Programming for OSI/MHS OSI/MHS Commands The NULL object type does not correspond to any actual object, but is used in commands that allow you to obtain information about all of the objects in a subsystem. Figure 1-7. Hierarchy of Object Types SUBSYS CLASS GATEWAY APPL GROUP MON DLIST CUG MTA DLISTMEMBER CUGMEMBER ROUTE ENTRY PROCESS CDT 007.
PAGE 49
Introduction to Management Programming for OSI/MHS • • • • • • • OSI/MHS Commands Obtain current status information about the subsystem and its processes, applications, classes, and groups Obtain information about the product name and release version of the OSI/MHS subsystem and its components Obtain statistics about the subsystem and its processes Reinitialize the counters used to collect statistics information for the subsystem’s processes Start and stop tracing of subsystem process activity Generate a
PAGE 50
Introduction to Management Programming for OSI/MHS OSI/MHS Commands Table 1-2.
PAGE 51
Introduction to Management Programming for OSI/MHS OSI/MHS Commands Table 1-2.
PAGE 52
Introduction to Management Programming for OSI/MHS OSI/MHS Commands Table 1-2.
PAGE 53
Introduction to Management Programming for OSI/MHS OSI/MHS Event and Accounting Messages Table 1-2.
PAGE 54
Introduction to Management Programming for OSI/MHS Password Server Interfaces For descriptions of the displayed form of these messages, see the manual Operator Messages Manual. Password Server Interfaces OSI/MHS has two password server programmatic interfaces: one for the MTA bind process and one for the MS bind process. The MTA bind password server interface supports the generation and validation of authentication parameters used during MTA association establishment.
PAGE 55
2 Communicating with the OSI/MHS Processes A management application communicates with OSI/MHS through the Subsystem Programmatic Interface (SPI). It retrieves event messages from OSI/MHS through the Event Management Service (EMS).
PAGE 56
Segmented Responses Communicating with the OSI/MHS Processes Figure 2-1 shows these steps. Figure 2-1. Communicating Through SCP Command Sequence SCP OPEN 1 5 command Management Application 3 2 4 OPEN command security check MHS Manager Response Sequence 7 response Management Application 8 CLOSE SCP 6 response MHS Manager CDT 008.CDD Usually the MHS manager remains open, once opened by SCP, even if SCP is closed by the application.
PAGE 57
Communicating with the OSI/MHS Processes Running the OSI/MHS Subsystem Processes All base-group tokens appear in the first segment, and are not repeated in later segments of the record. Each instance of the repeating group is enclosed in a segment list, which starts with ZSPI-TKN-SEGLIST and ends with ZSPI-TKN-ENDLIST. Segment lists follow the base-group tokens. A segmented response always contains at least one segment list (which is empty if the server has no information to return).
PAGE 58
Communicating with the OSI/MHS Processes Running an EMS Consumer Distributor management application. You need to open the consumer distributor for SPI communication, and then specify the source of event messages with a CONTROL command. The EMS Manual provides full details. To avoid receiving all event messages from all subsystems (something you will rarely want to do), you must install a filter to select only those messages your application intends to act upon.
PAGE 59
3 SPI Programming Considerations for OSI/MHS Once your subsystem and EMS processes are running and your management application has established communication with them, the main business of your management application is to format and send commands, decode responses and act on the results, and interpret event messages and act on their information. The SPI Common Extensions Manual provides general instructions for formatting commands, and decoding responses and event messages, for subsystems such as OSI/MHS.
PAGE 60
SPI Programming Considerations for OSI/MHS Definition Files command interpreter always loads the entire definition file. For further information about how definition files are used by an application, see the SPI Programming Manual. Definition files are named according to the following convention: ZSPIDEF.ZsubsysC ZSPIDEF.ZsubsysCOB ZSPIDEF.ZsubsysDDL ZSPIDEF.ZsubsysTACL ZSPIDEF.
PAGE 61
Message Elements for the OSI/MHS Subsystem SPI Programming Considerations for OSI/MHS Likewise, a management application written in C that sends commands to and retrieves event messages issued by the OSI/MHS subsystem would need the following include statements: #include #include #include #include #include #include #include "zspidef.zspic" "zspidef.zcomc" "zspidef.zmhsc" "zspidef.zemsc" "zspidef.zgrdc" "zspidef.zcmkc" "zspidef.
PAGE 62
Object Types SPI Programming Considerations for OSI/MHS ALTER RESETSTATS SWITCH DELETE START TRACE GETVERSION STATISTICS Programmatic commands for the OSI/MHS subsystem are identified by command numbers with symbolic names of the form ZCOM-CMD-name, where name identifies the command. (The separator character varies with the language; hyphens are shown throughout this and other DSM manuals because hyphens are used in DDL.
PAGE 63
SPI Programming Considerations for OSI/MHS Event Numbers The LISTOBJECTS command accepts object-name templates (wild-card names), which designate a set of objects to be operated on by the command. Valid object-name templates contain only the asterisk (*) wild-card character; the question mark character (?) is not allowed. The object-name templates accepted by LISTOBJECTS for each OSI/MHS object type are described in the LISTOBJECTS command descriptions in Section 5, Commands and Responses.
PAGE 64
SPI Programming Considerations for OSI/MHS Building and Sending a Command Message For more information on creating, sending, retrieving and decoding SPI commands and responses, see the SPI Programming Manual. The SPI Common Extensions Manual provides additional information for subsystems that, like OSI/MHS, are based on the common SPI extensions. Building and Sending a Command Message The following is a summary of the steps your application must take to build and send a command message: 1.
PAGE 65
SPI Programming Considerations for OSI/MHS Discontinuing a Command in Progress For the OSI/MHS subsystem, only the LISTOBJECTS PROCESS and LISTOBJECTS SUBSYS commands support the subordinate names option (ZCOM-TKN-SUB) to select subordinate objects. In addition to ZCOM-TKN-OBJNAME, a few other tokens can appear more than once in an OSI/MHS command. These tokens are identified in the command descriptions in Section 5, Commands and Responses.
PAGE 66
SPI Programming Considerations for OSI/MHS Error Handling requested names of objects that are of a given object type (and that fit into a single response buffer) in a single response record. The recommended buffer size (in bytes) for all commands sent to the OSI/MHS subsystem is ZMHS-VAL-BUFLEN. The maximum buffer size that OSI/MHS accepts is ZMHS-VAL-MAX-BUFLEN.
PAGE 67
SPI Programming Considerations for OSI/MHS Retrieving and Decoding Event Messages commands to be issued only by members of the super group or of the user group that owns the MHS manager. Section 5, Commands and Responses, identifies each OSI/MHS command as sensitive or nonsensitive. Retrieving and Decoding Event Messages The following is a summary of the steps your application must take to retrieve and act upon event messages: 1.
PAGE 68
SPI Programming Considerations for OSI/MHS Event-Management Considerations for OSI/MHS h. If you encounter the error-list token (ZSPI-TKN-ERRLIST), make another call to EMSGET or EMSGETTKN to retrieve the tokens inside the error list. i. Take action appropriate to the information in the event message. The EMS Manual provides information on how to retrieve tokens from an event message.
PAGE 69
SPI Programming Considerations for OSI/MHS Templates and Labels messages to select which event messages will be returned to your application. You can create filters that return only critical event messages, all messages associated with a particular device, all messages with a certain event number, and so forth. For examples of filters you could use to select event messages related to the OSI/MHS subsystem, refer to Appendix C, Examples.
PAGE 70
SPI Programming Considerations for OSI/MHS Naming Guidelines for Applications OSI/MHS Management Programming Manual—424824-001 3- 12
PAGE 71
4 Common Definitions This section lists the common definitions for the OSI/MHS subsystem: those used in several commands, responses, or event messages.
PAGE 72
SPI Standard Definitions Common Definitions Compaq provides each set of definitions in several programming languages, as described under Definition Files on page 3-1. Compaq also provides the Data Definition Language (DDL) source file from which the definitions (data declarations) in other languages are derived. Wherever it is necessary to show the type or structure represented by a symbolic name, this manual lists the DDL definition as it appears in the corresponding DDL definition file.
PAGE 73
SPI Standard Definitions Common Definitions Table 4-2. SPI Standard Definitions for Other Simple Tokens (page 2 of 2) Other Simple Tokens ZSPI-TKN-DATALIST ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-ENDLIST ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ZSPI-TKN-SERVER-BANNER Table 4-3.
PAGE 74
Extended SPI Definitions Common Definitions Table 4-5. SPI Standard Definitions for Value Names Value Names ZSPI-SSN-ZMHS ZSPI-VAL-FALSE ZSPI-VAL-TRUE ZSPI-TKN-SSID has the value ZMHS-VAL-SSID, which identifies the OSI/MHS subsystem. ZSPI-TKN-MANAGER specifies the OSI/MHS subsystem process to which a command is directed. SCP will forward the command to that process. This token is required in all OSI/MHS commands.
PAGE 75
Extended SPI Definitions Common Definitions Table 4-7. Extended SPI Definitions for Object Types Object Types ZCOM-OBJ-APPL ZCOM-OBJ-GROUP ZCOM-OBJ-CLASS ZCOM-OBJ-MON ZCOM-OBJ-CUG ZCOM-OBJ-MTA ZCOM-OBJ-CUGMEMBER ZCOM-OBJ-NULL ZCOM-OBJ-DLIST ZCOM-OBJ-PROCESS ZCOM-OBJ-DLISTMEMBER ZCOM-OBJ-ROUTE ZCOM-OBJ-ENTRY ZCOM-OBJ-SUBSYS ZCOM-OBJ-GATEWAY Table 4-8.
PAGE 76
Object Format Common Definitions single object; LISTOBJECTS accepts either a single object name or an object-name template (wildcard name) that specifies a set of objects. This token is required in all OSI/MHS commands except GETVERSION and LISTOBJECTS. Most OSI/MHS commands allow multiple occurrences of this token, so that a single command can operate on several objects. In responses, one ZCOM-TKN-OBJNAME token is returned for each object about which the command is to return information.
PAGE 77
Object Format Common Definitions proc is an alphanumeric string with a maximum length of four characters. It specifies the name of the MHS manager. applname is an alphanumeric string with a maximum length of 16 characters. It specifies the name of the APPL object. class is an alphanumeric string. It can be one of five values: GI, LO, MR, MS, or RS. You can use this qualifier when directing requests to the class as a whole and when constructing names to identify individual groups.
PAGE 78
Simple Tokens Common Definitions group is an alphanumeric string with a maximum length of 16 characters. The first character must be an alphabetic character. It is the name of a GROUP object within a class. mta is an alphanumeric string with a maximum length of 32 characters. It is the name of an MTA object. pname is an alphanumeric string with a maximum length of four characters. It specifies a valid process name route is an alphanumeric string with a maximum length of 16 characters.
PAGE 79
Summary States Common Definitions Summary States for APPL Objects The following states apply to MHS APPL processes. ZCOM-VAL-SUMSTATE-STARTED The process is running and will accept new requests for connections. ZCOM-VAL-SUMSTATE-STOPPED The process exists in the subsystem configuration but is not running. ZCOM-VAL-SUMSTATE-SUSP The process is running but will not accept new requests for connections. If the process is in the SUSP (suspended) state, it cannot communicate with other MHS processes.
PAGE 80
EMS Definitions Common Definitions Summary States for SUBSYS Objects The following states apply to the OSI/MHS subsystem process. ZCOM-VAL-SUMSTATE-STARTED The process is running and will accept new requests for connections. ZCOM-VAL-SUMSTATE-STOPPED The process exists in the subsystem configuration but is not running. ZCOM-VAL-SUMSTATE-STOPPING The process is in transition to the STOPPED state because a STOP command was issued for that process.
PAGE 81
Standard EMS Tokens Common Definitions ZEMS-TKN-CRTPID indicates the CRTPID of the process generating the event. ZEMS-TKN-EMPHASIS has the value ZSPI-VAL-TRUE if the event is considered critical, and ZSPI-VAL-FALSE otherwise. ZEMS-TKN-EVENTNUMBER assumes one of the following values: 1. ZCOM-EVT-SUMSTATE-CHANGE (when a change of state of an object occurs) 2. A ZCMK-defined event number 3.
PAGE 82
OSI/MHS Tokens Common Definitions ZMHS-EVT-INTL-WARN ZMHS-EVT-SQL-ERR ZMHS-EVT-INVALID-PASSWORD ZMHS-EVT-UNROUTE ZMHS-EVT-IO-ERR ZMHS-EVT-UNROUTE-RECIP ZEMS-TKN-GENTIME contains the time the event was generated. ZEMS-TKN-LOGTIME contains the time the event was logged. ZEMS-TKN-PIN contains the pin of the process generating the event ZEMS-TKN-SUBJECT-MARK indirectly indicates the subject token.
PAGE 83
OSI/MHS Tokens Common Definitions ZMHS-TKN-EVT-GEN (ZSPI-TYP-ENUM) identifies a process class or type and can have one of the following values: ZMHS-VAL-EVT-GEN- Value Meaning MGR 0 MHS manager process UA 1 UA process MS 2 MS process MTA 3 MTA process RTS 4 RTS process SC 5 SC process ROS 6 ROS process LO 7 LO process GIP 8 GIP process ZMHS-TKN-PDUID (ZSPI-TYP-INT4) identifies the PDU store identifier for messages involved in the event.
PAGE 84
OSI/MHS Tokens Common Definitions ZMHS-VAL-MS-DIAG- Value Meaning UA-UNAVAIL 3 Message arrived for a UA for which the association has been aborted. MS-FULL 4 The message store is full. DISCARD-DELIV 5 Message cannot be stored. BAD-CONT-TYPE 6 Bad content type detected in a message. BAD-PROT-ELEM 7 Message cannot be decoded. ZMHS-TKN-KERNEL (ZSPI-TYP-ENUM) identifies the OSI/MHS kernel in which an error occurred. This is an internal Compaq token.
PAGE 85
OSI/MHS Tokens Common Definitions ZMHS-TKN-GROUP-NAME (ZSPI-TYP-STRING) identifies the name of a group object in the OSI.MHS SUBSYS; maximum length is 42 bytes. ZMHS-TKN-UNRT-REASON (ZSPI-TYP-ENUM) identifies the reason a report could not be routed. The possible values are: ZMHS-VAL-UNRT- Value Meaning NOT-CONFIG 0 No route found. BAD-ROUTE 1 Routes found but could not be used. APPL-UNAVAL 2 Local APPL is not available. MAX-TIME 3 Maximum time allowed for report delivery has expired.
PAGE 86
OSI/MHS Tokens Common Definitions ZMHS-TKN-ACT-REQ (ZSPI-TYP-ENUM) contains a token indicating what type of action is required. The possible values are: ZMHS-VAL-ACT-REQ- Value BAD-OSI-CFG 1 CLR-OSI-CFG 2 BAD-OSI-RSC 1 OSI-RSC-AVL 2 ALT-COL-UNAVL 3 ALT-COL-AVL 4 The meaning attached to the values are described with the event in which this token appears. See Section 6, Event Messages. ZMHS-TKN-CPU (ZSPI-TYP-INT) indicates the CPU number in which the process was running.
PAGE 87
Standard Subsystem Programmatic Interface (SPI) Tokens Common Definitions ZMHS-TKN-LOOP-DETECTED (ZSPI-TYP-BOOLEAN) contains a token indicating whether crash-looping has been detected when an internal error event is generated. The possible values are: ZSPI-VAL- Value Meaning TRUE -1 Loop detected, PDU marked as inactive FALSE 0 Loop not detected ZMHS-TKN-CUG-VIOL-RSN (ZSPI-TYP-ENUM) contains a token indicating the reason for the CUG violation.
PAGE 88
Operating System Tokens Common Definitions ZSPI-TKN-PROC-ERR identifies the procedure in which the error occurred. ZSPI-TKN-RETCODE identifies the return code from a SPI command. Operating System Tokens The following is a description of the operating system defined tokens that might appear in OSI/MHS specific event messages. Refer to the individual event descriptions to determine if this token is considered required for the event.
PAGE 89
Accounting Tokens Common Definitions ZMHS-TKN-ASSOC-CHK-PNT-SZ (ZSPI-TYP-INT) shows the negotiated checkpoint size for RTS association.
PAGE 90
Accounting Tokens Common Definitions ZMHS-VAL-ASSOC-REJECT- Value Meaning PROTOCOL 7 Bad protocol RESTRICT 8 Remote association initiation not allowed NO-MORE 9 Cannot support any more associations ZMHS-TKN-ASSOC-RES (ZSPI-TYP-ENUM) specifies the association establishment result according to the following values: ZMHS-VAL-ASSOC- Value Meaning RES-ACCEPT 0 Association accepted RES-REJECT 1 Association rejected ZMHS-TKN-ASSOC-START-TIME (ZSPI-TYP-TIMESTAMP) indicates the time the asso
PAGE 91
Accounting Tokens Common Definitions ZMHS-TKN-DELIVER-RESULT (ZSPI-TYP-BOOLEAN) indicates the delivery or nondelivery of a message to the recipient according to the following values: ZMHS-VAL- Value Meaning TRUE -1 Message delivered FALSE 0 Message not delivered This token can be present only if ZMHS-TKN-MSG-TYPE has the value ZMHS-VAL-MSG-TYPE-REPORT.
PAGE 92
Accounting Tokens Common Definitions ZMHS-TKN-MID-ADMD (ZSPI-TYP-STRING) is the ADMD name component of the MHS-wide unique message identifier; maximum length is 16 bytes. ZMHS-TKN-MID-COUNTRY (ZSPI-TYP-STRING) is the country name component of the MHS-wide unique message identifier; maximum length is 3 bytes. ZMHS-TKN-MID-LOCALID (ZSPI-TYP-STRING) is the local identifier component of the MHS-wide unique message identifier; maximum length is 32 bytes.
PAGE 93
Accounting Tokens Common Definitions ZMHS-VAL-MS- Value Meaning OPER-LIST 6 List OPER-FETCH 7 Fetch OPER-SUMMARIZE 8 Summarize OPER-DELETE 9 Delete ZMHS-TKN-MS-OPER-ARG-PDUID (INT4) is the PDU ID of an MS Operation argument. This token may have a value of 0 if the MS Operation argument does not have a related PDU. ZMHS-TKN-MS-OPER-RESULT (ZSPI-TYP-ENUM) specifies the result of an MS operation.
PAGE 94
Accounting Tokens Common Definitions ZMHS-TKN-MSG-SIZE (ZSPI-TYP-INT2) is the total number of bytes in an UMPDU (user message protocol data unit), a probe or a report. For user messages (UMPDUs) and reports, it is the envelope plus the content; for probes, it is only the envelope. ZMHS-TKN-MSG-TYPE (ZSPI-TYP-ENUM) is the type of X.400 message.
PAGE 95
Accounting Tokens Common Definitions ZMHS-TKN-OR-DD-VALUE-1 ZMHS-TKN-OR-DD-VALUE-2 ZMHS-TKN-OR-DD-VALUE-3 ZMHS-TKN-OR-DD-VALUE-4 (ZSPI-TYP-STRING) (ZSPI-TYP-STRING) (ZSPI-TYP-STRING) (ZSPI-TYP-STRING) are the domain defined attribute values of the O/R name; maximum length 128 bytes. These tokens are optional—they are supplied if they are present in the X.400 O/R name. ZMHS-TKN-OR-NETWORK (ZSPI-TYP-STRING) is the network address (X.121 address) component of the O/R name; maximum length 15 bytes.
PAGE 96
Accounting Tokens Common Definitions ZMHS-TKN-OR-PRMD (ZSPI-TYP-STRING) is the PRMD name component of the O/R name; maximum length 16 bytes. This token is optional—it is supplied if it is present in the X.400 O/R name. ZMHS-TKN-OR-TERM-ID (ZSPI-TYP-STRING) is the terminal Id component of the O/R name; maximum length 24 bytes. This token is optional—it is supplied if it is present in the X.400 O/R name. ZMHS-TKN-OR-TERM-TYPE (ZSPI-TYP-ENUM) is the terminal type component of the O/R name.
PAGE 97
Accounting Tokens Common Definitions ZMHS-TKN-PER-RECIP-FLAG (ZSPI-TYP-INT) contains a set of per-recipient bit flags whose meaning is defined below: Bits Value Meaning 0 0 1 This MTA is not responsible for the message. This MTA is responsible for the message. 1 and 2 0,0 1,0 0,1 1,1 This combination should not occur. MTA report requested. MTA nondelivery report requested. Audited report requested. 3 and 4 0,0 1,0 0,1 1,1 No report. Report requested. Nondelivery report requested.
PAGE 98
Accounting Tokens Common Definitions ZMHS-TKN-REROUTE-ATTEMPT (ZSPI-TYP-BOOLEAN) indicates if this is a rerouting attempt. The possible values are: ZSPI-VAL- Value Meaning TRUE -1 Rerouting attempt FALSE 0 First routing attempt ZMHS-TKN-ROUTE-PRI (ZSPI-TYP-INT) shows the priority of a route selected during routing.
PAGE 99
Operating System Definitions Common Definitions ZMHS-TKN-TRANS-CLASS (ZSPI-TYP-ENUM) specifies the class of message transfer that has occurred. The possible values are: ZMHS-VAL-TRANS-CLASS- Value Meaning SUB-TO-REM 0 The UMPDU or probe was submitted by a local MTS user and transferred to a remote MTA. DELIVERED 1 The UMPDU or report was delivered to a local MTS user, or a probe reached its destination.
PAGE 100
ZCMK Definitions Common Definitions ZCMK Definitions The OSI/MHS subsystem is based on a common implementation of the SPI common extensions. This implementation uses definitions whose names begin with ZCMK. These definitions are provided in the ZSPIDEF.ZCMKDDL file and in corresponding files for other languages and are described in the SPI Common Extensions Manual. OSI Definitions Definitions whose names begin with ZOSI are OSI definitions.
PAGE 101
Fixed Structures Common Definitions Table 4-12.
PAGE 102
Predefined Token and Field Values Common Definitions Table 4-13.
PAGE 103
Predefined Token and Field Values Common Definitions Table 4-14.
PAGE 104
Other Tokens Common Definitions Table 4-14. OSI/MHS Predefined Values (page 3 of 3) ZMHS Values ZMHS-VAL-MS-DIAG-APPL-STOPPED ZMHS-VAL-VINTAGE-84 ZMHS-VAL-MS-DIAG-APPL-SUSPEND ZMHS-VAL-VINTAGE-88 ZMHS-VAL-MS-DIAG-BAD-CONT-TYPE Other Tokens Simple tokens that appear in OSI/MHS commands and responses are listed in Appendix B, Token Codes and Token Maps, and are described in Section 5, Commands and Responses.
PAGE 105
5 Commands and Responses This section describes the syntax and semantics for all commands and responses in the management programming interface to Open Systems Interconnection/Message Handling System (OSI/MHS). In this section, the names and structures of commands, object types, and all tokens and their values are represented in DDL (Data Definition Language). For a quick explanation of DDL, see the SPI Programming Manual.
PAGE 106
Commands by Object Type Commands and Responses Table 5-2.
PAGE 107
Commands by Object Type Commands and Responses Table 5-3.
PAGE 108
Commands by Object Type Commands and Responses Table 5-3.
PAGE 109
Sensitive and Nonsensitive Commands Commands and Responses Table 5-3.
PAGE 110
Command Descriptions Commands and Responses SUSPEND Places an object in the SUSPENDED state (ZCOM-VALSUMSTATE-SUSP). SWITCH Switches the primary and backup CPUs of a process. TRACE Starts or stops generating trace records for an object. Nonsensitive commands do not affect the operation or status of an object; therefore these commands can be issued by any user. The nonsensitive OSI/MHS commands and their functions are as follows: GETVERSION Returns an object’s software-release version information.
PAGE 111
Attributes, Defaults, and Null Values Commands and Responses Descriptions of simple tokens in this section do not identify their token numbers. However, the symbolic names of the token numbers can be derived from the token names by simply replacing -TKN- with -TNM-. For example, the token number of the ZSPI-TKN-MANAGER token is ZSPI-TNM-MANAGER. The syntax boxes do not include the SPI header tokens, which are always present in every command and response buffer.
PAGE 112
Commands and Responses Attributes, Defaults, and Null Values Null values are not explicitly described. You can place null values in the buffers by using the SPI routine SSNULL. You can check for the presence of a null value in a token by comparing the values in the token with values in a buffer that contains null values.
PAGE 113
ABORT APPL Commands and Responses ABORT APPL The ABORT APPL command terminates an APPL name. The STOPPED state disallows application logons with message store (MS) APPL names. Command ZCOM-CMD-ABORT Object Type ZCOM-OBJ-APPL Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE.
PAGE 114
Commands and Responses ABORT APPL ZCOM-TKN-SEL-SUMSTATE is described in the SPI Common Extensions Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE and ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual.
PAGE 115
ABORT CLASS Commands and Responses ABORT CLASS The ABORT CLASS command terminates a CLASS object type and leaves it in the STOPPED state. Command ZCOM-CMD-ABORT Object Type ZCOM-OBJ-CLASS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT ZCOM-TKN-SUB ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE-TYPE.
PAGE 116
Commands and Responses ABORT CLASS ZCOM-TKN-SUB ZCOM-TKN-SEL-SUMSTATE are described in the SPI Common Extensions Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual.
PAGE 117
ABORT GROUP Commands and Responses ABORT GROUP The ABORT GROUP command causes the MHS manager to call the STOP system procedure call for all processes in that group. Command ZCOM-CMD-ABORT Object Type ZCOM-OBJ-GROUP Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT ZCOM-TKN-SUB ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE.
PAGE 118
Commands and Responses ABORT GROUP ZCOM-TKN-SUB ZCOM-TKN-SEL-SUMSTATE are described in the SPI Common Extensions Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual.
PAGE 119
ABORT MON Commands and Responses ABORT MON The ABORT MON command stops the MHS manager. Command ZCOM-CMD-ABORT Object Type ZCOM-OBJ-MON Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE-TYPE. ZSPI-TYP-INT-PAIR. ZSPI-TYP-INT-PAIR.
PAGE 120
Commands and Responses ABORT MON Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual. ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual.
PAGE 121
ABORT SUBSYS Commands and Responses ABORT SUBSYS The ABORT SUBSYS command terminates the operation of MHS SUBSYS objects. This command acts the same as the STOP SUBSYS command. Command ZCOM-CMD-ABORT Object Type ZCOM-OBJ-SUBSYS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE.
PAGE 122
Commands and Responses ABORT SUBSYS Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual. ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual.
PAGE 123
ACTIVATE APPL Commands and Responses ACTIVATE APPL The ACTIVATE command activates a suspended APPL name. Command ZCOM-CMD-ACTIVATE Object Type ZCOM-OBJ-APPL Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE-TYPE. ZSPI-TYP-STRING. token-type token-type token-type token-type token-type ZSPI-TYP-LIST.
PAGE 124
Commands and Responses ACTIVATE APPL Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual. ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual.
PAGE 125
ADD APPL Commands and Responses ADD APPL The ADD APPL command adds a new user name and associated configuration information. APPL objects can be of two types, MS (user mailbox) and GW (Transfer gateways). ADD APPL attributes can be divided into the following categories: Category Description O/R name Identifies the O/R name used to route messages to this user. The name can be specific or generic. These attributes apply to both MS users and gateway users.
PAGE 126
Commands and Responses ADD APPL Tokens in Command Buffer ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32. ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZMHS-TKN-ACCESS-TYPE token-type ZSPI-TYP-ENUM. ZMHS-TKN-ACCESS-NAME token-type ZSPI-TYP-STRING. ZMHS-MAP-APPL-ORNAME def ZMHS-DDL-APPL-ORNAME. 02 ZISOCOUNTRY type ZMHS-DDL-ISO-COUNTRY-CODE. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(2). 02 ZADMD-NAME type ZMHS-DDL-ADMD. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(16). 02 ZPRMD-NAME type ZMHS-DDL-PRMD.
PAGE 127
Commands and Responses ADD APPL 02 ZSURNAME type ZMHS-DDL-SUR-NAME. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(40). 02 ZGIVENNAME type ZMHS-DDL-GIVEN-NAME. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(16). 02 ZINITIALS type ZMHS-DDL-INITIALS. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(5). 02 ZGENERATIONQUALIFIER type ZMHS-DDL-GEN-QUALIFIER. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(3). 02 ZDOMAINDEFINEDTYPE1 type ZMHS-DDL-DOM-DEF-TYPE. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(8).
PAGE 128
ADD APPL Commands and Responses 02 ZDEL-EIT-VOICE 02 ZDEL-CONTENT-TYPE-CHECK 02 ZDEL-UNIDENTIFIED 02 ZDEL-EXTERNAL 02 ZDEL-IPM84 02 ZDEL-IPM88 02 ZDEL-EDI 02 ZDEL-EIT-EDIFACT-ISO646 02 ZDEL-EIT-EDIFACT-T61 02 ZDEL-EIT-EDIFACT-OCTET 02 ZDEL-EIT-ANSIX12-ISO646 02 ZDEL-EIT-ANSIX12-T61 02 ZDEL-EIT-ANSIX12-OCTET 02 ZDEL-EIT-ANSIX12-EBCDIC 02 ZDEL-EIT-UNTID-ISO646 02 ZDEL-EIT-UNTID-T61 02 ZDEL-EIT-UNTID-OCTET 02 ZDEL-EIT-PRIVATE-OCTET 02 ZDEL-EIT-UNDEFINED-OCTET end.
PAGE 129
Commands and Responses ADD APPL 02 ZCOPY-RECIPS type ZMHS-DDL-FLAG. 02 ZEXPIRY-TIME type ZMHS-DDL-FLAG. 02 ZIMPORTANCE type ZMHS-DDL-FLAG. 02 ZOBSOLETED-IPMS type ZMHS-DDL-FLAG. 02 ZORIGINATOR type ZMHS-DDL-FLAG. 02 ZPRIMARY-RECIPS type ZMHS-DDL-FLAG. 02 ZRELATED-IPMS type ZMHS-DDL-FLAG. 02 ZREPLIED-TO-IPMS type ZMHS-DDL-FLAG. 02 ZREPLY-RECIPS type ZMHS-DDL-FLAG. 02 ZREPLY-TIME type ZMHS-DDL-FLAG. 02 ZSENSITIVITY type ZMHS-DDL-FLAG. 02 ZSUBJECT type ZMHS-DDL-FLAG. 02 ZCONTENT-ID type ZMHS-DDL-FLAG.
PAGE 130
ADD APPL Commands and Responses ZSPI-TKN-DATALIST ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST . . . ZSPI-TKN-ENDLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT token-type token-type token-type token-type token-type ZSPI-TYP-LIST. ZSPI-TYP-ENUM. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-LIST. token-type ZSPI-TYP-SSCTL. token-type ZSPI-TYP-SSCTL. token-type ZSPI-TYP-BYTESTRING.
PAGE 131
Commands and Responses ADD APPL ZLENGTH is the length. The value range is -1 through 2. The value -1 means unused. ZSTRING is the country name. ZADMD-NAME corresponds to the administrationDomainName O/R attribute. ZLENGTH is the length. The value range is -1 through 16 characters. The value -1 means unused. ZSTRING is a valid domain name. ZPRMD-NAME corresponds to the privateDomainName O/R attribute. ZLENGTH is the length. The value range is -1 through 16 characters. The value -1 means unused.
PAGE 132
Commands and Responses ADD APPL ZLENGTH is the length. The value range is -1 through 24 numeric characters. The value -1 means unused. ZSTRING is a valid terminal ID. This value is a numeric string. ZNUMERICUSERIDENTIFIER corresponds to the numeric user identifier O/R attribute. ZLENGTH is the length. The value range is -1 through 32 numeric characters. The value -1 means unused. ZSTRING is an empty string, a valid numeric user identifier, or a partially or fully wild-carded numeric user identifier.
PAGE 133
Commands and Responses ADD APPL ZLENGTH is the length. The value range is -1 through 64. The value -1 means unused. ZSTRING is a valid organization name. ZORGUNIT1...4 corresponds to the organizationalUnit O/R attribute. ZLENGTH is the length. The value range is -1 through 32. The value -1 means unused. ZSTRING is a valid organizational unit. ZSURNAME is the surname of the personal name set. ZLENGTH is the length. The value range is -1 through 40. The value -1 means unused. ZSTRING is the surname.
PAGE 134
Commands and Responses ADD APPL ZGENERATIONQUALIFIER corresponds to the generationQualifier O/R attribute. ZLENGTH is the length. The value range is -1 through 3. The value -1 means unused. ZSTRING is the generation qualifier. ZDOMAINDEFINEDTYPE1...4 corresponds to the attributeType of the domainDefinedAttributes O/R attribute. ZLENGTH is the length. The value range is 1 through 8. The value -1 means unused. ZSTRING is the attribute type. ZDOMAINDEFINEDVALUE1...
PAGE 135
ADD APPL Commands and Responses ZDEL-EIT-CHECK controls whether a mailbox user can receive encoded information types (EITs). ZMHS-VAL-FLAG-ON means that each EIT field will be checked for an ON or OFF value; the user can receive only those EITs that are set ON. ZMHS-VALFLAG-OFF means that the user can receive all types of encoded information; that is, no checks will take place.
PAGE 136
Commands and Responses ADD APPL ZDEL-EIT-TIF0 controls whether messages with TIF0/G4-CLASS-1 type encoded information can be delivered. If ZDEL-EIT-CHECK is OFF, this field is ignored. If ZDEL-EIT-CHECK is ON, this field may be null, ON or OFF. In either case, null defaults to OFF. ZDEL-EIT-TTX controls whether messages with teletext type encoded information can be delivered. If ZDEL-EIT-CHECK is OFF, this field is ignored. If ZDEL-EIT-CHECK is ON, this field may be null, ON or OFF.
PAGE 137
Commands and Responses ADD APPL ZDEL-CONTENT-TYPE-CHECK controls whether a mailbox user can receive various content types. ZMHS-VAL-FLAG-ON means that each content type field will be checked for an ON or OFF value; the user can receive only those content types that are set that are set ON. ZMHS-VAL-FLAG-OFF means that the user can receive all content types; that is, no checks will take place.
PAGE 138
Commands and Responses ADD APPL ZDEL-IPM88 controls whether messages with content type INTERPERSONALMESSAGING-1988 can be delivered. This corresponds to the built-in content type of 22 (ipm-88) and the external object ID content type (2,6,1,10,1), defined in X.420. If ZDEL-CONTENT-TYPE-CHECK is OFF, this field is ignored. If ZDEL-CONTENT-TYPE-CHECK is ON, this field may be null, ON or OFF. A value of null defaults to ON.
PAGE 139
Commands and Responses ADD APPL If ZDEL-EIT-CHECK is OFF, this field is ignored. If ZDEL-EIT-CHECK is ON, this field may be null, ON or OFF. In either case, null defaults to OFF. ZDEL-EDI-ANSIX12-T61 specifies that this APPL object can receive EDI messages with a primary body part that uses the ANSI X.12 standard and the T61 character set. The default value is OFF. If ZDEL-EIT-CHECK is OFF, this field is ignored. If ZDEL-EIT-CHECK is ON, this field may be null, ON or OFF.
PAGE 140
Commands and Responses ADD APPL If ZDEL-EIT-CHECK is OFF, this field is ignored. If ZDEL-EIT-CHECK is ON, this field may be null, ON or OFF. In either case, null defaults to OFF. ZDEL-EDI-PRIVATE-OCTET specifies that this APPL object can receive EDI messages with a primary body part that uses a privately defined octet string standard. The default value is OFF. If ZDEL-EIT-CHECK is OFF, this field is ignored. If ZDEL-EIT-CHECK is ON, this field may be null, ON or OFF. In either case, null defaults to OFF.
PAGE 141
Commands and Responses ADD APPL ZSUB-LOWEST-PRI is a message submission attribute that specifies the lowest priority at which this APPL object is allowed to submit messages. The range of values is 0 (lowest) through 2 (highest). The SPI-NULL value for this field is 255. ZSUB-MSG-ALLOWED is a message submission attribute that specifies whether this APPL object is allowed to submit messages.
PAGE 142
Commands and Responses ADD APPL ZCHILD-SEQ-NO is a message retrieval attribute that specifies whether this APPL object can use the childSequenceNumber X.400 attribute stored in the MS. In an ADD command, a null value indicates that this attribute is not used for this APPL. ZCONTENT-TYPE is a message retrieval attribute that specifies whether this APPL object can use the contentType X.400 attribute stored in the MS. In an ADD command, a null value indicates that this attribute is not used for this APPL.
PAGE 143
Commands and Responses ADD APPL ZSEQ-NO is a message retrieval attribute that specifies whether this APPL object can use the sequenceNumber X.400 attribute stored in the MS. In an ADD command, a null value indicates that this attribute is not used for this APPL. ZSUBJ-SUBMISSION-ID is a message retrieval attribute that specifies whether this APPL object can use the subjectSubmissionIdentifier X.400 attribute stored in the MS.
PAGE 144
Commands and Responses ADD APPL ZEXPIRY-TIME is a message retrieval attribute that specifies whether this APPL object can use the expiryTime X.400 attribute stored in the MS. In an ADD command, a null value indicates that this attribute is not used for this APPL. ZIMPORTANCE is a message retrieval attribute that specifies whether this APPL object can use the importance X.400 attribute stored in the MS. In an ADD command, a null value indicates that this attribute is not used for this APPL.
PAGE 145
Commands and Responses ADD APPL ZSENSITIVITY is a message retrieval attribute that specifies whether this APPL object can use the sensitivity X.400 attribute stored in the MS. In an ADD command, a null value indicates that this attribute is not used for this APPL. ZSUBJECT is a message retrieval attribute that specifies whether this APPL object can use the subject X.400 attribute stored in the MS. In an ADD command, a null value indicates that this attribute is not used for this APPL.
PAGE 146
Commands and Responses ADD APPL ZMSG-DEL-ID is a message retrieval attribute that specifies whether this APPL object can use the messageDeliverIdentifier X.400 attribute stored in the MS. In an ADD command, a null value indicates that this attribute is not used for this APPL. ZMHS-MAP-LOS-EXT-PARAMS is an extensible structured token that defines attributes that are configurable for an APPL object that accesses the system through the LO GROUP process. This token is required if ACCESS-TYPE is MS.
PAGE 147
Commands and Responses ADD APPL ZSSELECTOR is a structure that defines the SSEL part of the OSI address used by this group for receiving associations from adjacent MTAs. This structure identifies a session layer entity. If you specify the attribute name without any characters as the address or you do not specify this attribute name at all, this part of the address is unused. The SPI-NULL value for this structure is 255.
PAGE 148
Commands and Responses ADD APPL ZSTRING is the OSI address NSAP. This value must be a hexadecimal string of the length specified in ZSTRING. Note. If communication with the APPL object is over X.25 (1980), you must specify the ASCII equivalent of the DTE address for the APPL object in the ZNSAP attribute. For example, if the DTE address is 12345, you must specify 3132333435. ZMHS-MAP-APPL-DUPL-SUPRN is a structured token that defines the duplicate suppression attributes for an MS APPL.
PAGE 149
Commands and Responses ADD APPL ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual.
PAGE 150
Commands and Responses • • • ADD APPL You cannot specify both a wildcarded X121-ADDR and a wildcarded NUMERICUSER-IDENTIFIER address for the same APPL(i.e., only one or the other of the attributes can be wildcarded). The message retrieval attributes determine what criteria can be used to retrieve a message from a mailbox. Each message is retrievable only by those attributes that were set ON when the message was stored.
PAGE 151
Commands and Responses ADD CLASS ADD CLASS The ADD CLASS command configures information that is specific to a group class. Command ZCOM-CMD-ADD Object Type ZCOM-OBJ-CLASS Tokens in Command Buffer ZMHS-TKN-ROUTE-RETRY-CHECK token-type ZSPI-TYP-ENUM. ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32. ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZMHS-MAP-NO-OF-MAILBOXES def ZMHS-DDL-NO-OF-MAILBOXES. 02 ZNUMBER type ZSPI-DDL-INT2. end. ZMHS-MAP-MR-CLASS-PARAMS def ZMHS-DDL-MR-CLASS-PARAMS.
PAGE 152
ADD CLASS Commands and Responses 02 ZNONURGENT-ROUTE-RETRY-DELAY type ZSPI-DDL-INT2. 02 ZCUG-CHECK type ZSPI-DDL-ENUM. 02 ZREPORT-ROUTE-RETRY-TIME type ZSPI-DDL-INT2. 02 ZREPORT-ROUTE-RETRY-DELAY type ZSPI-DDL-INT2. 02 ZURGENT-ROUTE-RETRY-GROW type ZSPI-DDL-INT. 02 ZNORMAL-ROUTE-RETRY-GROW type ZSPI-DDL-INT. 02 ZNONURG-ROUTE-RETRY-GROW type ZSPI-DDL-INT. 02 ZREPORT-ROUTE-RETRY-GROW type ZSPI-DDL-INT. end. ZMHS-MAP-SC-TIMESTAMP def ZMHS-DDL-SC-TIMESTAMP. 02 ZSC-TIME-HOURS type ZSPI-DDL-INT.
PAGE 153
Commands and Responses ADD CLASS ZMHS-VAL-ROUTE-RETRY-CHK-LOCAL indicates that the arrival-time checks are based on the time of arrival in the local Tandem system. The default value for this token is MTS. ZSPI-TKN-MANAGER is the MHS manager name, that is, the process to which SCP is to send this command. This token is required and must occur only once. ZCOM-TKN-OBJNAME is the name of the CLASS object to be added. This token is required.
PAGE 154
Commands and Responses ADD CLASS ZCHKPNT-SIZE specifies the maximum amount of data in units of K octets that may be sent between two minor synchronization points by the RTS. This value is in the range 1 through 30. This attribute is used by OSI/MHS when negotiating the checkpoint size. ZWNDW-SIZE is the maximum number of outstanding minor synchronization points before data transfer is suspended by the RTS. The range of values is 1 through 100.
PAGE 155
Commands and Responses ADD CLASS association with the adjacent MTA. The MR group can initiate an association with an adjacent MTA before this time expires if the ZNORMAL-TIME threshold is reached for the adjacent MTA. This value is expressed in seconds and has a range of 1 through 36000. ZNONURGENT-COUNT specifies the maximum number of nonurgent messages that the MTA can have on its queue for a given destination before it attempts to establish an association with the adjacent MTA.
PAGE 156
Commands and Responses ADD CLASS ZASSOC-CLOSE-TIME is the time allowed for a primitive close request. The range of values is 1 through 36000 seconds. ZLINK-RETRY-TIME is the maximum amount of time for trying an adjacent MTA before trying another adjacent MTA. The range of values is 5 through 36000 seconds. ZLINK-RETRY-DELAY is the maximum amount of time to delay between attempts to use the links to a particular adjacent MTA. The range of values is 5 through 36000 seconds.
PAGE 157
Commands and Responses ADD CLASS is 0 through 36000 minutes. A value of 0 means that no route retry attempts are made. ZCUG-CHECK is the message retrieval attribute that indicates whether or not the CUG checking process is enabled for the MR GROUP process. The SPI-NULL value for this attribute is 255. The possible values are: ZMHS-VAL-CUG-CHK-NONE ZMHS-VAL-CUG-CHK-ALL In an ADD command, ZCUG-CHECK is optional; if not specified, it defaults to ZMHS-VAL-CUG-CHK-NONE.
PAGE 158
Commands and Responses ADD CLASS ZMHS-MAP-SC-TIMESTAMP is a structured token that specifies a specific local system time during which the store cleaner will run, and can be repeated up to 12 times. This token is optional. This token may not be specified if ZCS-TIME-INT contains a value other than null. The ZMHS-MAP-SC-TIMESTAMP definition, ZMHS-DDL-SC-TIMESTAMP, contains the following fields: ZSC-TIME-HOURS is the number of hours which the store cleaner will run. The range of values is 0 to 23.
PAGE 159
Commands and Responses ADD CLASS ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual.
PAGE 160
ADD CUG Commands and Responses ADD CUG The ADD CUG command adds a closed user group to the MHS configuration. Command ZCOM-CMD-ADD Object Type ZCOM-OBJ-CUG Tokens in Command Buffer ZSPI-TKN-MANAGER token-type ZCOM-TKN-OBJNAME token-type ZMHS-MAP-CUG-PARAMS def ZMHS-DDL-CUG-PARAMS. 02 ZMAX-MSG-SIZE type 02 ZLOWEST-PRI type 02 ZCONT-TYPE-CHECK type 02 ZNUMBER-OF-MEMBERS type end.
PAGE 161
ADD CUG Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST . . . ZSPI-TKN-ENDLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT token-type token-type token-type token-type token-type ZSPI-TYP-LIST. ZSPI-TYP-ENUM. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-LIST. token-type ZSPI-TYP-SSCTL. token-type ZSPI-TYP-SSCTL. token-type ZSPI-TYP-BYTESTRING.
PAGE 162
Commands and Responses ADD CUG performed. A value of ON indicates that checking is performed and only contents defined using the ZMHS-DDL-CONT-TYPE-1...20 tokens are valid. The SPI-NULL value for this field is 32. ZNUMBER-OF-MEMBERS is the number of CUGMEMBERS currently configured for this CUG. This field is not used for the ADD CUG and the ALTER CUG commands and should contain the NULL value (-1). The range of values for this field for the INFO command is 0 through 32767.
PAGE 163
Commands and Responses ADD CUG Operational Notes • • ADD CUG is a sensitive command. CUG objects can be added at any time to an operational OSI/MHS subsystem. However, CUG checking is done only when the MR CLASS attribute ZCUG-CHECK is set to ALL. See the description of the ZCUG-CHECK attribute in the ADD CLASS command for more information.
PAGE 164
ADD CUGMEMBER Commands and Responses ADD CUGMEMBER The ADD CUGMEMBER command adds a closed user group member to the MHS configuration. Command ZCOM-CMD-ADD Object Type ZCOM-OBJ-CUGMEMBER Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-CUGMEM-ORNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZMHS-DDL-ORNAME. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE-TYPE.
PAGE 165
Commands and Responses • • • • ADD CUGMEMBER A domain name (Country, ADMD, and, optionally, PRMD) A domain name plus an organization name A domain name plus an organization name plus one organization unit name A qualified mnemonic, numeric, or terminal O/R name as specified in the CCITT X.402 recommendations The O/R-name attributes specified for a CUGMEMBER object should conform to one of the attribute sets listed above.
PAGE 166
ADD DLIST Commands and Responses ADD DLIST The ADD DLIST command adds a local distribution list to the MHS configuration. Command ZCOM-CMD-ADD Object Type ZCOM-OBJ-DLIST Tokens in Command Buffer ZSPI-TKN-MANAGER token-type ZCOM-TKN-OBJNAME token-type ZMHS-MAP-DLIST-PARAMS def ZMHS-DDL-DLIST-PARAMS. 02 ZNOTIFY-POLICY type 02 ZNUMBER-OF-MEMBERS type end.
PAGE 167
Commands and Responses ADD DLIST ZMHS-MAP-DLIST-PARAMS is an extensible structured token that contains the distribution list parameters. The ZMHS-MAP-DLIST-PARAMS definition, ZMHS-DDL-DLIST-PARAMS, contains: ZNOTIFY-POLICY is the reporting policy of the distribution list. The SPI-NULL value for this field is 0.
PAGE 168
Commands and Responses ADD DLIST ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual.
PAGE 169
ADD DLISTMEMBER Commands and Responses ADD DLISTMEMBER The ADD DLISTMEMBER command adds a local distribution list member to the MHS configuration. Command ZCOM-CMD-ADD Object Type ZCOM-OBJ-DLISTMEMBER Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-DLMEM-ORNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZMHS-DDL-ORNAME. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE-TYPE.
PAGE 170
Commands and Responses ADD DLISTMEMBER identify a nested distribution list. There is no limit to the level to which distribution lists can be nested. For descriptions of these attributes, see the descriptions provided in the ADD APPL command for the ZMHS-DDL-APPL-ORNAME definition. ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual.
PAGE 171
ADD GATEWAY Commands and Responses ADD GATEWAY The ADD GATEWAY command adds a gateway to the MHS configuration. Command ZCOM-CMD-ADD Object Type ZCOM-OBJ-GATEWAY Tokens in Command Buffer ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32. ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZMHS-MAP-GATEWAY-PARAMS def ZMHS-DDL-GATEWAY-PARAMS. 02 ZVINTAGE type ZSPI-DDL-ENUM. 02 ZVALIDATION type ZMHS-DDL-FLAG. 02 ZPASSWORD type ZMHS-DDL-PI-PASSW. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(62).
PAGE 172
Commands and Responses ADD GATEWAY ZMHS-MAP-GATEWAY-PARAMS is an extensible structured token that contains parameters for a specified GATEWAY object. This token is required. The ZMHS-MAP-GATEWAY-PARAMS definition, ZMHS-DDL-GATEWAY-PARAMS, contains the following fields: ZVINTAGE indicates whether the GATEWAY object is a 1984 or 1988 implementation. Note that this attribute is meaningless if ZMHS-TKN-GW-TYPE is ZMHS-VAL-GW-P1-EXIT. The SPI-NULL value for this field is 0.
PAGE 173
Commands and Responses ADD GATEWAY If the ZGW-MAX-TIME-EXPIRED value is set to 0, then the attribute is turned off, and event 52 is not generated. Gateways that are migrated from D20, D21, or D22 have the ZGW-MAX-TIME-EXPIRED value set to 0. Note. After every twentieth message queued to the gateway input queue, the OSI/MHS MTA retrieves the time of enqueue for the first message on the queue.
PAGE 174
Commands and Responses ADD GATEWAY Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual. ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual.
PAGE 175
ADD GROUP Commands and Responses ADD GROUP The ADD GROUP command is used to configure a group of a specific class. Command ZCOM-CMD-ADD Object Type ZCOM-OBJ-GROUP Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-GROUP def ZMHS-DDL-GROUP. 02 ZPRIM-CPU 02 ZSEC-CPU 02 ZPRI 02 ZPDU-FNAME 02 ZPDU-LOG-FNAME 02 ZWORK-SVOL end. ZMHS-MAP-MS-PARAMS def ZMHS-DDL-MS-PARAMS.
PAGE 176
ADD GROUP Commands and Responses ZMHS-MAP-MR-PARAMS def ZMHS-DDL-MR-PARAMS. 02 ZMRP-PNAME 02 ZMRP-CPU 02 ZMRP-BACKUP 02 ZMRP-PRI 02 ZRTS-PNAME 02 ZRTS-CPU 02 ZRTS-BACKUP 02 ZRTS-PRI 02 ZSC-PNAME 02 ZSC-CPU 02 ZSC-BACKUP 02 ZSC-PRI 02 ZPSELECTOR PSELECTOR. 04 ZLENGTH 04 ZSTRING 02 ZSSELECTOR SSELECTOR. 04 ZLENGTH 04 ZSTRING 02 ZTSELECTOR TSELECTOR. 04 ZLENGTH 04 ZSTRING 02 ZNSAP 04 ZLENGTH 04 ZSTRING 02 ZTRANSMIT-MODE end. type type type type type type type type type type type type type ZSPI-DDL-CHAR8.
PAGE 177
ADD GROUP Commands and Responses ZMHS-MAP-RS-PARAMS def ZMHS-DDL-RS-PARAMS. 02 ZRS-PNAME 02 ZRS-CPU 02 ZRS-BACKUP 02 ZRS-PRI 02 ZPSELECTOR 04 ZLENGTH 04 ZSTRING 02 ZSSELECTOR 04 ZLENGTH 04 ZSTRING 02 ZTSELECTOR 04 ZLENGTH 04 ZSTRING 02 ZNSAP 04 ZLENGTH 04 ZSTRING end. ZMHS-MAP-LO-PARAMS def ZMHS-DDL-LO-PARAMS. 02 ZLO-PNAME 02 ZLO-CPU 02 ZLO-BACKUP 02 ZLO-PRI end. MHS-MAP-GI-PARAMS def ZMHS-DDL-GI-PARAMS. 02 ZGI-PNAME 02 ZGI-CPU 02 ZGI-BACKUP 02 ZGI-PRI end.
PAGE 178
Commands and Responses ADD GROUP Tokens in Command Buffer ZSPI-TKN-MANAGER is the MHS manager name, that is, the process to which SCP is to send this command. This token is required and must occur only once. ZCOM-TKN-OBJNAME is the name of the GROUP object to be added. This token is required. ZMHS-MAP-GROUP is an extensible structured token that contains attributes common to all groups. This token is required.
PAGE 179
Commands and Responses ADD GROUP ZWORK-SVOL is the volume and subvolume for the GROUP’s private data files. This subvolume must be on the same node as the MHS manager. The SPI-NULL value for this field is 0. ZMHS-MAP-MS-PARAMS is an extensible structured token that contains attributes specific to MS GROUP processes. This token is required. ZMHS-DDL-MS-PARAMS contains the following fields: ZMS-PNAME specifies the process name of the MS process within this group.
PAGE 180
Commands and Responses ADD GROUP ZMR-LIST is a structure that defines a list of MR groups to which this MS can submit messages. If ZMR-COUNT has a value of -1, this structure is blank-filled. If you specify an integer in the ZMR-COUNT attribute, then the number of times you specify a group name in the ZMR-GROUP-NAME attribute must equal the integer you specify for ZMR-COUNT. ZMR-GROUP-NAME is the group name for the MR. The SPI-NULL value for this field is 0.
PAGE 181
Commands and Responses ADD GROUP ZMRP-PRI is the priority at which the MRP process will run. The maximum value is the MHS manager priority minus 1. If the null value is detected, the default value for the group is used. The SPI-NULL value for this field is 255. ZRTS-PNAME specifies the process name of the RTS process within this group. This process must reside on the same node as the MHS manager. The SPI-NULL value for this field is 0. ZRTS-CPU is the CPU on which the RTS process will run.
PAGE 182
Commands and Responses ADD GROUP eight-CPU system). If the null value is detected, the default value for the group is used. The SPI-NULL value for this field is 255. ZSC-PRI is the priority at which the store cleaner process will run. The maximum value is the priority of the MHS manager minus 1. If the null value is detected, the default value for the group is used. The SPI-NULL value for this field is 255.
PAGE 183
Commands and Responses ADD GROUP address is unused. The SPI-NULL value for this structure is 255. ZTSELECTOR contains the following fields: ZLENGTH is the length of the string field in bytes. This value must be an even number in the range 0 through 64. ZSTRING is the OSI address TSEL. This value must be a hexadecimal string of the length specified in ZLENGTH.
PAGE 184
Commands and Responses ADD GROUP ZMHS-MAP-RS-PARAMS is an extensible structured token that contains attributes specific to RS GROUP process. This token is required. ZMHS-DDL-RS-PARAMS contains the following fields: ZRS-PNAME is the name of the RS process within this group. This process must reside on the same node as the MHS manager. The SPI-NULL value for this field is 0. ZRS-CPU is the CPU on which the RS process will run. No range checking is performed.
PAGE 185
Commands and Responses ADD GROUP ZSSELECTOR is a structure that defines the SSEL part of the OSI address used by this group for receiving associations from remote UAs. This structure identifies a session layer entity. If you specify the attribute name without any characters as the address or you do not specify this attribute name at all, this part of the address is unused. The SPI-NULL value for this structure is 255.
PAGE 186
Commands and Responses ADD GROUP ZMHS-MAP-LO-PARAMS is an extensible structured token that contains attributes specific to the LO GROUP process. This token is required. The ZMHS-MAP-LO-PARAMS definition, ZMHS-DDL-LO-PARAMS, contains the following fields: ZLO-PNAME is the name of the LO process within this group. This process must reside on the same node as the MHS manager. The SPI-NULL value for this field is 0. ZLO-CPU is the CPU on which the LO process will run. No range checking is performed.
PAGE 187
Commands and Responses ADD GROUP ZGI-BACKUP is the backup CPU that the GI process will use. No range checking is performed. However, this value should not exceed the number of CPUs on the target system minus one (for example, a value in the range 0 to 7 for an eight-CPU system). If the null value is detected, the default value for the group is used. The SPI-NULL value for this field is 255. ZGI-PRI is the priority at which the GI process will run.
PAGE 188
Commands and Responses ADD GROUP robust strategy of multiple groups). However, you cannot configure MR and RS groups with the same OSI address. • • • ADD GROUP can set process priorities. If at run time the priority of the MHS manager has changed so that it is unable to start the process at the requested priority, the MHS manager starts the process at a priority one less than its own. OSI/MHS GROUP processes do not run as process pairs. Each process runs in the designated primary CPU only.
PAGE 189
Commands and Responses ADD MTA ADD MTA The ADD MTA command adds an adjacent MTA to the MHS configuration. Command ZCOM-CMD-ADD Object Type ZCOM-OBJ-MTA Tokens in Command Buffer ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32. ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZMHS-MAP-MTA-ADD-PARAMS def ZMHS-DDL-MTA-ADD-PARAMS. 02 ZITS-MTA-NAME type ZMHS-DDL-MTA-NAME-AND-LEN. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(32). 02 ZISOCOUNTRY type ZMHS-DDL-ISO-COUNTRY-CODE. 04 ZLENGTH type ZSPI-DDL-INT.
PAGE 190
ADD MTA Commands and Responses ZMHS-MAP-MTA-PARAMS def ZMHS-DDL-MTA-PARAMS.
PAGE 191
ADD MTA Commands and Responses 02 ZLOCSSELECTOR2 04 ZLENGTH 04 ZSTRING 02 ZLOCTSELECTOR2 04 ZLENGTH 04 ZSTRING 02 ZLOCNSAP2 04 ZLENGTH 04 ZSTRING 02 ZREMPSELECTOR3 04 ZLENGTH 04 ZSTRING 02 ZREMSSELECTOR3 04 ZLENGTH 04 ZSTRING 02 ZREMTSELECTOR3 04 ZLENGTH 04 ZSTRING 02 ZREMNSAP3 04 ZLENGTH 04 ZSTRING 02 ZLOCPSELECTOR3 04 ZLENGTH 04 ZSTRING 02 ZLOCSSELECTOR3 04 ZLENGTH 04 ZSTRING 02 ZLOCTSELECTOR3 04 ZLENGTH 04 ZSTRING 02 ZLOCNSAP3 04 ZLENGTH 04 ZSTRING 02 ZREMPSELECTOR4 04 ZLENGTH 04 ZSTRING 02 ZREMSSELECT
PAGE 192
ADD MTA Commands and Responses 02 ZLOCTSELECTOR4 04 ZLENGTH 04 ZSTRING 02 ZLOCNSAP4 04 ZLENGTH 04 ZSTRING 02 ZREMPSELECTOR5 04 ZLENGTH 04 ZSTRING 02 ZREMSSELECTOR5 04 ZLENGTH 04 ZSTRING 02 ZREMTSELECTOR5 04 ZLENGTH 04 ZSTRING 02 ZREMNSAP5 04 ZLENGTH 04 ZSTRING 02 ZLOCPSELECTOR5 04 ZLENGTH 04 ZSTRING 02 ZLOCSSELECTOR5 04 ZLENGTH 04 ZSTRING 02 ZLOCTSELECTOR5 04 ZLENGTH 04 ZSTRING 02 ZLOCNSAP5 04 ZLENGTH 04 ZSTRING 02 ZREMPSELECTOR6 04 ZLENGTH 04 ZSTRING 02 ZREMSSELECTOR6 04 ZLENGTH 04 ZSTRING 02 ZREMTSELECT
PAGE 193
ADD MTA Commands and Responses 02 ZLOCNSAP6 04 ZLENGTH 04 ZSTRING 02 ZREMPSELECTOR7 04 ZLENGTH 04 ZSTRING 02 ZREMSSELECTOR7 04 ZLENGTH 04 ZSTRING 02 ZREMTSELECTOR7 04 ZLENGTH 04 ZSTRING 02 ZREMNSAP7 04 ZLENGTH 04 ZSTRING 02 ZLOCPSELECTOR7 04 ZLENGTH 04 ZSTRING 02 ZLOCSSELECTOR7 04 ZLENGTH 04 ZSTRING 02 ZLOCTSELECTOR7 04 ZLENGTH 04 ZSTRING 02 ZLOCNSAP7 04 ZLENGTH 04 ZSTRING 02 ZX121COUNTRY 04 ZLENGTH 04 ZSTRING 02 ZCOUNTRYNAME type ZMHS-DDL-EXT-NSAP. type ZSPI-DDL-INT. PIC X(40).
PAGE 194
ADD MTA Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST . . . ZSPI-TKN-ENDLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT token-type token-type token-type token-type token-type ZSPI-TYP-LIST. ZSPI-TYP-ENUM. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-LIST. token-type ZSPI-TYP-SSCTL. token-type ZSPI-TYP-SSCTL. token-type ZSPI-TYP-BYTESTRING.
PAGE 195
ADD MTA Commands and Responses ZSTRING is the country name. ZADMD corresponds to the administrationDomainName attribute of the adjacent MTA. ZADMD contains the following fields: ZLENGTH is the length of the administration domain name. The range of values is 1 through 16. ZSTRING is the administration domain name. ZPRMD corresponds to the privateDomainName attribute of the adjacent MTA. ZPRMD contains the following fields: ZLENGTH is the length of the private domain name.
PAGE 196
ADD MTA Commands and Responses ZOUR-LOGON is the password that the adjacent MTA expects in a bind request; that is, the password that our OSI/MHS subsystem must provide to access the adjacent MTA. If ZVALIDATION-REQUIRED is ZMHS-VAL-FLAG-ON, this field is required. The SPI-NULL value for this field is 0. ZOUR-LOGON contains the following fields: ZLENGTH is the length of the logon password. The range of values is 1 through 62 bytes, or -1 to indicate not used. ZSTRING is the logon password.
PAGE 197
ADD MTA Commands and Responses ZMAX-MSG-LEN is the maximum length of a message that can be received by the adjacent MTA. The range of values is 0 through the value of ZMHS-VAL-MAX-MSG-LEN. A value of 0 means that no length check is performed. ZLOCAL-INITIATE controls whether local initiation of associations is allowed; that is, whether our OSI/MHS subsystem can send a bind request to this adjacent MTA. The SPI-NULL value for this field is 32.
PAGE 198
Commands and Responses ADD MTA ZSTRING is the SSEL part of the address. This is a hexadecimal string of the length specified in ZLENGTH. ZREMTSELECTOR1...7 is the TSEL part of the MTA’s OSI address. This field identifies a transport layer entity. If you specify the attribute name without any characters in the address, this part of the address is unused. Each ZREMTSELECTOR token contains the following fields: ZLENGTH is the length of the address in bytes.
PAGE 199
Commands and Responses ADD MTA ZLENGTH is the length of the address in bytes. This value must be an even number in the range 0 through 32. ZSTRING is the PSEL part of the address. This value is a hexadecimal string of the length specified in ZLENGTH. ZLOCSSELECTOR1...7 is the SSEL part of the OSI address for OSI/MHS. This field identifies a session layer entity. If you specify the attribute name without any characters in the address, this part of the address is unused.
PAGE 200
Commands and Responses ADD MTA ZSTRING is the NSAP part of the address. This is a hexadecimal value of the length specified in ZLENGTH. ZX121COUNTRY is the country name of the adjacent MTA in X.121 form. This field is present for information purposes only. The SPI-NULL value for this field is 0. ZX121COUNTRY contains the following fields: ZLENGTH is the length of the country name. The value is in the range 1 through 3 numeric characters, or it is -1, indicating that country name is not specified.
PAGE 201
Commands and Responses ADD MTA ZITS-LOGON-RSP is the password expected from the adjacent MTA in a bind confirmation. This is the password an adjacent MTA must provide in response to our attempt to access it. If ZVALIDATION-REQUIRED is ZMHS-VAL-FLAG-ON, this field is required. A null password can be specified using the asterisk (*) character; in this case, any password received from the adjacent MTA is accepted as valid. The SPI-NULL value for this field is 0.
PAGE 202
Commands and Responses ADD MTA ZMSG-DOWNGRDE determines to which gateway a message intended for this MTA has to be rerouted if downgrading is required for the P22 content of the message. ZMSGDOWNGRDE contains the following fields: ZLENGTH is the length of the gateway name. The range of values is 1 through 32. ZSTRING is the gateway name. ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual.
PAGE 203
Commands and Responses ADD MTA ZITS-LOGON-RESP ZITS-LOGON ZOUR-LOGON-RESP ZMTA-PSWD-SVR of ADD SUBSYS command If ZPASSW-SERVER is ON, OSI/MHS uses the external password server specified in the ADD SUBSYS command; in this case, ZVALIDATION-REQUIRED must be OFF, and ZOUR-LOGON, ZITS-LOGON-RESP, ZITS-LOGON, and ZOURLOGON-RESP must not be specified. If ZVALIDATION-REQUIRED is ON, OSI/MHS uses the passwords supplied by the ZOUR-LOGON, ZITS-LOGON-RESP, ZITS-LOGON, and ZOUR-LOGONRESP.
PAGE 204
Commands and Responses 5 Commands and Responses 5 Commands and Responses ADD ROUTE The ADD ROUTE command adds a ROUTE for a given adjacent MTA.
PAGE 205
Commands and Responses ADD ROUTE Tokens in Command Buffer ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32. ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZMHS-MAP-ROUTE-SEL-PARAM def ZMHS-DDL-ROUTE-SEL-PARAM. 02 ZISOCOUNTRY type ZMHS-DDL-ISO-COUNTRYCODE. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(2). 02 ZADMD-NAME type ZMHS-DDL-ADMD. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(16). 02 ZPRMD-NAME type ZMHS-DDL-PRMD. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(16).
PAGE 206
Commands and Responses ADD ROUTE 02 ZORGUNIT4 type ZMHS-DDL-SINGLE-ORG-UNIT. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(32). 02 ZSURNAME type ZMHS-DDL-SUR-NAME. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(40). 02 ZGIVENNAME type ZMHS-DDL-GIVEN-NAME. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(16). 02 ZINITIALS type ZMHS-DDL-INITIALS. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(5). 02 ZGENERATIONQUALIFIER type ZMHS-DDL-GEN-QUALIFIER. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(3).
PAGE 207
ADD ROUTE Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST . . . ZSPI-TKN-ENDLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT token-type token-type token-type token-type token-type ZSPI-TYP-LIST. ZSPI-TYP-ENUM. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-LIST. token-type ZSPI-TYP-SSCTL. token-type ZSPI-TYP-SSCTL. token-type ZSPI-TYP-BYTESTRING.
PAGE 208
Commands and Responses ADD ROUTE ZLENGTH is the length of the administration domain name. The first character must be an alphabetic character. The value is in the range 1 through 16 alphanumeric characters, or it is -1, indicating that the domain name is not specified. ZSTRING is a valid administration domain name. Note. If the ADMD name is present (that is, not -1), then the ZISOCOUNTRY name also must be present; otherwise this route cannot be accessed.
PAGE 209
ADD ROUTE Commands and Responses ZSTRING is a valid terminal ID. The value is 1 through 24 alphanumeric characters. ZNUMERICUSERIDENTIFIER corresponds to the numeric user identifier and contains the following fields: ZLENGTH is the length of the numeric user identifier. The value is in the range 1 through 32, or it is -1, indicating that the identifier is not specified. ZSTRING is an empty string, a valid numeric user identifier, or a partially or fully wild-carded numeric user identifier.
PAGE 210
Commands and Responses ADD ROUTE ZSTRING is a valid organization name. ZORGUNIT1...4 corresponds to the organizationalUnit O/R attribute and contains: ZLENGTH is the length of the organizational unit in the range 1 through 32 alphanumeric characters, or it is -1, indicating that the unit is not specified. ZSTRING is a valid organizational unit.
PAGE 211
Commands and Responses ADD ROUTE ZSTRING is the initials. ZGENERATIONQUALIFIER corresponds to the generationQualifier of the personal name set and contains: ZLENGTH is the length of the generation qualifier. The value is in the range 1 through 3 alphanumeric characters, or it is -1, indicating that the qualifier is not specified. ZSTRING is the generation qualifier. ZDOMAINDEFINEDTYPE1...
PAGE 212
Commands and Responses ADD ROUTE ZROUTE-PRIORITY is the route priority in case multiple routes exist. The range of values is 1 through 99. The highest priority is 1. ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list.
PAGE 213
ADD SUBSYS Commands and Responses ADD SUBSYS The ADD SUBSYS command adds a SUBSYS object. It allows global data to be configured for all objects on a subsystem-wide basis. Command ZCOM-CMD-ADD Object Type ZCOM-OBJ-SUBSYS Tokens in Command Buffer ZSPI-TKN-MANAGER token-type ZCOM-TKN-OBJNAME token-type ZMHS-MAP-DB-FNAMES def ZMHS-DDL-DB-FNAMES. 02 ZROUTE type 02 ZUSER type 02 ZADJ-MTA type 02 ZDLIST type 02 ZDLMEM type 02 ZCUGSRCH type end. ZMHS-MAP-ACCOUNTING-PARAMS def ZMHS-DDL-ACCOUNTING-PARAMS.
PAGE 214
ADD SUBSYS Commands and Responses 02 ZDUPL-SUPRN type ZMHS-DDL-FLAG. 02 ZMS-SUMMARY type ZMHS-DDL-FLAG. 02 ZMS-OPERATION type ZMHS-DDL-FLAG. end. ZMHS-MAP-GLOBAL-ADD-PARAMS def ZMHS-DDL-GLOBAL-ADD-PARAMS. 02 ZISOCOUNTRY type ZMHS-DDL-ISO-COUNTRYCODE. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(2). 02 ZADMD type ZMHS-DDL-ADMD. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(16). 02 ZPRMD type ZMHS-DDL-PRMD. 04 ZLENGTH type ZSPI-DDL-INT. 04 ZSTRING PIC X(16). 02 ZMTA type ZMHS-DDL-MTA-NAME-ANDLEN.
PAGE 215
Commands and Responses ADD SUBSYS Tokens in Command Buffer ZSPI-TKN-MANAGER is the MHS manager name, that is, the process to which SCP is to send this command. This token is required and must occur only once. ZCOM-TKN-OBJNAME is the name of the SUBSYS object to be added. This token is required. ZMHS-MAP-DB-FNAMES is an extensible structured token that contains the database names for the subsystem. This token is required.
PAGE 216
Commands and Responses ADD SUBSYS defined by the CONFIG-DB-SVOL parameter (for example, $USER7.DJOSIMHS.ZD1XDB). ZMHS-MAP-ACCOUNTING-PARAMS is an extensible structured token that contains the accounting attributes for the specified SUBSYS object. This token is required. These attributes include the events that generate accounting records and the information to be included in the accounting records. The SPI-NULL value for each field within this token is 32.
PAGE 217
Commands and Responses ADD SUBSYS ZPROBE-DELIVER controls whether a delivered probe will generate accounting events. ZMHS-VAL-FLAG-ON means accounting events will be generated. ZPROBE-RELAY controls whether a relayed probe will generate accounting events. ZMHS-VALFLAG-ON means accounting events will be generated. ZREPORT-GEN controls whether a generated report will generate accounting events. ZMHS-VAL-FLAG-ON means accounting events will be generated.
PAGE 218
Commands and Responses ADD SUBSYS ZUNROUTE-RECIP-INFO controls whether an unrouteable message will generate recipient information events. ZMHS-VAL-FLAG-ON means recipient information events will be generated. ZDLIST-EXPANSION controls whether the expansion of distribution lists generates events. ZMHS-VAL-FLAG-ON means expansion of distribution lists is generated. The default is ZMHS-VAL-FLAG-OFF. ZRTS-ASSOC controls whether the RTS-level association accounting events are generated.
PAGE 219
Commands and Responses ADD SUBSYS ZMS-OPERATION controls whether the MS operation accounting events are generated. ZMHS-VAL-FLAG-ON means the MS operation accounting events are generated. The default is ZMHS-VAL-FLAG-OFF. ZMHS-MAP-GLOBAL-ADD-PARAMS is an extensible structured token that contains global information for the OSI/MHS subsystem. This token is required. These attributes cannot be changed using the ALTER SUBSYS command.
PAGE 220
Commands and Responses ADD SUBSYS ZMTA is a structure that contains the name of the local MTA and contains the following fields: ZLENGTH is the length of the ZSTRING field. The range of values is 1 through 32 characters. ZSTRING contains the name of the local MTA. To add a SUBSYS object without specifying the MTA name, define the MTA name with a minimum of one space character. ZMTA-DESIGNATOR is a structure that contains the local MTA designator.
PAGE 221
Commands and Responses ADD SUBSYS ZMHS-MAP-PROC-DATA is an extensible structured token that contains process information used by the entire OSI/MHS subsystem. This token is required. The ZMHS-MAP-PROC-DATA definition, ZMHS-DDL-PROC-DATA, contains the following fields: ZOSI-MGR identifies the OSI manager process that manages the local OSI end system. The OSI manager process must be on the same node as the MHS manager. The SPI-NULL value for this field is 0.
PAGE 222
ALTER APPL Commands and Responses ALTER APPL The ALTER APPL command changes the attributes of an APPL object. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-APPL Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-APPL-ORNAME ZMHS-MAP-APPL-DEL-PARAMS ZMHS-MAP-MS-APPL-PARAMS ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZMHS-DDL-APPL-ORNAME.
PAGE 223
ALTER CLASS Commands and Responses ALTER CLASS The ALTER CLASS command changes the configuration of an OSI/MHS class.
PAGE 224
Commands and Responses • • ALTER CLASS All tokens are optional for ALTER CLASS.
PAGE 225
ALTER CUG Commands and Responses ALTER CUG The ALTER CUG command alters a closed user group in the MHS configuration.
PAGE 226
Commands and Responses ALTER CUG Tokens in Command and Response Buffers For a description of the tokens in the command and response buffers, see the ADD CUG command. Operational Notes • • ALTER CUG is a sensitive command. All tokens for the ALTER CUG command are optional.
PAGE 227
ALTER CUGMEMBER Commands and Responses ALTER CUGMEMBER The ALTER CUGMEMBER command alters a closed user group member in the MHS configuration. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-CUGMEMBER Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-CUGMEM-ORNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZMHS-DDL-ORNAME. ZSPI-TYP-ALLOW-TYPE.
PAGE 228
ALTER DLIST Commands and Responses ALTER DLIST The ALTER DLIST command alters a local distribution list to the MHS configuration. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-DLIST Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-DLIST-PARAMS ZMHS-MAP-DLIST-ORNAME ZMHS-MAP-DLIST-OWNER-ORNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING.
PAGE 229
ALTER DLISTMEMBER Commands and Responses ALTER DLISTMEMBER The ALTER DLISTMEMBER command alters a distribution list member in the MHS configuration. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-DLISTMEMBER Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-DLMEM-ORNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZMHS-DDL-ORNAME. ZSPI-TYP-ALLOW-TYPE.
PAGE 230
ALTER GATEWAY Commands and Responses ALTER GATEWAY The ALTER GATEWAY command changes the configuration of an existing GATEWAY process. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-GATEWAY Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-GATEWAY-PARAMS PARAMS. ZMHS-MAP-GW-PNAME ZMHS-MAP-GW-AUX-PNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-STRING.
PAGE 231
ALTER GROUP Commands and Responses ALTER GROUP The ALTER GROUP command changes the attribute values associated with a group. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-GROUP Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-GROUP ZMHS-MAP-MS-PARAMS ZMHS-MAP-MR-PARAMS ZMHS-MAP-RS-PARAMS ZMHS-MAP-LO-PARAMS ZMHS-MAP-GI-PARAMS ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE.
PAGE 232
Commands and Responses • • • ALTER GROUP The MS bind password server for a GROUP object can be removed by specifying the ZMS-PSWD-SVR attribute without a process name. This has the effect of turning off the MS bind password server for the group. If you specify the attribute ZMR-COUNT for an MS group, all current MR groups specified for that object are overwritten by the groups specified in the command.
PAGE 233
ALTER MON Commands and Responses ALTER MON The ALTER MON command alters configuration data for the MON object. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-MON Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCMK-MAP-ALTER def ZCMK-DDL-ALTER. 02 ZBKUP-DEBUG 02 ZDEBUG-ON-ERR end. ZCMK-TKN-ALTER-BKUP-CPU ZCMK-TKN-EMS-XFNAME ZCMK-TKN-LOG-XFNAME ZCMK-TKN-MSG-XFNAME ZCMK-TKN-EMS-XFNAME1 ZCMK-TKN-EMS-XFNAME2 ZCMK-TKN-EMS-XFNAME3 ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE.
PAGE 234
ALTER MON Commands and Responses ZCOM-TKN-OBJNAME is the name of the MON object to be altered. This token is optional. ZCMK-MAP-ALTER is an extensible structured token that contains parameters that can be used to alter the way the MON object starts and terminates. This token is optional and should be used only under the direction of someone who understands the internal operation of the MON object.
PAGE 235
Commands and Responses ALTER MON ZCMK-TKN-EMS-XFNAME1 is the name of an alternate collector. This token is optional. It specifies the alternate collector for accounting. It can be altered only if the SUBSYS object is in the STOPPED state. The range of values is 0 through 256 bytes. A value of 0 means that no events are sent to the alternate collector. ZCMK-TKN-EMS-XFNAME2 This token is reserved for future use. ZCMK-TKN-EMS-XFNAME3 This token is reserved for future use.
PAGE 236
ALTER MTA Commands and Responses ALTER MTA The ALTER MTA command changes the configuration of an existing MTA. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-MTA Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-MTA-PARAMS ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZMHS-DDL-MTA-PARAMS. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE-TYPE. ZSPI-TYP-STRING.
PAGE 237
ALTER ROUTE Commands and Responses ALTER ROUTE The ALTER ROUTE command changes a ROUTE in the MHS configuration. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-ROUTE Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-ROUTE-SEL-PARAM PARAM. ZMHS-MAP-ROUTE-RSLT-PARAM PARAM. ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-STRING. token-type ZMHS-DDL-ROUTE-SELtoken-type ZMHS-DDL-ROUTE-RSLTtoken-type ZSPI-TYP-ALLOW-TYPE.
PAGE 238
ALTER SUBSYS Commands and Responses ALTER SUBSYS The ALTER SUBSYS command alters global configuration information for the MHS subsystem. Command ZCOM-CMD-ALTER Object Type ZCOM-OBJ-SUBSYS Tokens in Command Buffer ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32. ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZMHS-MAP-DB-FNAMES token-type ZMHS-DDL-DB-FNAMES. ZMHS-MAP-ACCOUNTING-PARAMS token-type ZMHS-DDL-ACCOUNTING-PARAMS. ZMHS-TKN-MSG-ST-CHG-PARAM token-type ZSPI-TYP-INT.
PAGE 239
Commands and Responses ALTER SUBSYS Note that reconfiguration of ZMS-SUMMARY and ZMS-OPERATION events can take effect only in P7 associations established following the change. Existing P7 associations are not affected. • The MS bind password server for a SUBSYS object can be removed by specifying the ZMTA-PSWD-SVR attribute without a process name. This has the effect of turning off the MS bind password server for the subsystem.
PAGE 240
DELETE APPL Commands and Responses DELETE APPL The DELETE APPL command removes an APPL object from the MHS database. Command ZCOM-CMD-DELETE Object Type ZCOM-OBJ-APPL Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-CMD-POWER token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-ENUM.
PAGE 241
Commands and Responses DELETE APPL Operational Notes • • • DELETE APPL is a sensitive command. In addition, it requires the process that executes it to be running either under the super ID or under the same group and user ID as the MHS manager. The APPL object must be in the STOPPED state before it can be deleted. A request to delete an application will be rejected if messages exist in the message store pertaining to this application, unless the MAX option is used.
PAGE 242
DELETE CLASS Commands and Responses DELETE CLASS The DELETE CLASS command removes classes from the database. Command ZCOM-CMD-DELETE Object Type ZCOM-OBJ-CLASS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-ENUM.
PAGE 243
DELETE CUG Commands and Responses DELETE CUG The DELETE CUG command deletes a closed user group from the MHS configuration.
PAGE 244
Commands and Responses DELETE CUG Tokens in Command and Response Buffers ZCOM-TKN-SUB is described in the SPI Common Extensions Manual. For a description of all the other tokens in the command and response buffers, see the ADD CUG command. Operational Notes • • DELETE CUG is a sensitive command. All CUGMEMBER objects associated with the CUG must be deleted before the CUG can be deleted. The command is rejected if any subordinate CUGMEMBER objects are configured.
PAGE 245
DELETE CUGMEMBER Commands and Responses DELETE CUGMEMBER The DELETE CUGMEMBER command deletes a closed user group member from the MHS configuration. Command ZCOM-CMD-DELETE Object Type ZCOM-OBJ-CUGMEMBER Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-CUGMEM-ORNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZMHS-DDL-ORNAME. ZSPI-TYP-ALLOW-TYPE.
PAGE 246
DELETE DLIST Commands and Responses DELETE DLIST The DELETE DLIST command deletes a local distribution list from the configuration. Command ZCOM-CMD-DELETE Object Type ZCOM-OBJ-DLIST Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-DLIST-PARAMS ZMHS-MAP-DLIST-ORNAME ZMHS-MAP-DLIST-OWNER-ORNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB token-type token-type token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING.
PAGE 247
DELETE DLISTMEMBER Commands and Responses DELETE DLISTMEMBER The DELETE DLISTMEMBER command deletes a distribution list member from the configuration. Command ZCOM-CMD-DELETE Object Type ZCOM-OBJ-DLISTMEMBER Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-DLMEM-ORNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZMHS-DDL-ORNAME. ZSPI-TYP-ALLOW-TYPE.
PAGE 248
DELETE GATEWAY Commands and Responses DELETE GATEWAY The DELETE GATEWAY command removes a GATEWAY from the MHS configuration. Command ZCOM-CMD-DELETE Object Type ZCOM-OBJ-GATEWAY Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 249
DELETE GROUP Commands and Responses DELETE GROUP The DELETE GROUP command removes groups from the MHS configuration. Command ZCOM-CMD-DELETE Object Type ZCOM-OBJ-GROUP Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-ENUM.
PAGE 250
Commands and Responses • • • DELETE GROUP When you delete a GROUP object, all processes within that group are deleted regardless of the SUB qualifier. To delete an MS GROUP object, you must delete all MS APPL objects associated with the MS group. To delete an MR GROUP object, it is advisable to drain all messages from the group before deleting the group. Refer to the description of the ZTRANSMIT-MODE attribute under “ADD GROUP Command” for information about draining these messages.
PAGE 251
DELETE MTA Commands and Responses DELETE MTA The DELETE MTA command removes MTAs from the MHS configuration. Command ZCOM-CMD-DELETE Object Type ZCOM-OBJ-MTA Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-ENUM.
PAGE 252
DELETE ROUTE Commands and Responses DELETE ROUTE The DELETE ROUTE command removes a ROUTE from the MHS configuration. Command ZCOM-CMD-DELETE Object Type ZCOM-OBJ-ROUTE Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 253
DELETE SUBSYS Commands and Responses DELETE SUBSYS The DELETE SUBSYS command removes the SUBSYS from the database. Command ZCOM-CMD-DELETE Object Type ZCOM-OBJ-SUBSYS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 254
GETVERSION MON Commands and Responses GETVERSION MON The GETVERSION MON command returns version information for the MHS manager, including the control-and inquiry-version level. Command ZCOM-CMD-GETVERSION Object Type ZCOM-OBJ-MON Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 255
Commands and Responses GETVERSION MON Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZSPI-TKN-SERVER-BANNER contains a copy of the detailed server banner of the subsystem.
PAGE 256
GETVERSION NULL Commands and Responses GETVERSION NULL The GETVERSION NULL command returns version information about the product. Command ZCOM-CMD-GETVERSION Object Type ZCOM-OBJ-NULL Tokens in Command Buffer ZSPI-TKN-MANAGER ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type ZSPI-TYP-FNAME32. token-type ZSPI-TYP-ALLOW-TYPE. token-type ZSPI-TYP-RESPONSEtoken-type ZSPI-TYP-STRING.
PAGE 257
Commands and Responses GETVERSION NULL Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZSPI-TKN-SERVER-BANNER is a copy of the detailed server banner of the subsystem.
PAGE 258
GETVERSION PROCESS Commands and Responses GETVERSION PROCESS The GETVERSION PROCESS command returns version information for the process. Command ZCOM-CMD-GETVERSION Object Type ZCOM-OBJ-PROCESS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 259
Commands and Responses GETVERSION PROCESS Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZSPI-TKN-SERVER-BANNER is a copy of the detailed server banner of the process. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual.
PAGE 260
INFO APPL Commands and Responses INFO APPL The INFO APPL command returns the attribute values of an APPL object. The response contains the configuration information established when the APPL object was added with an ADD command or was last modified with an ALTER command.
PAGE 261
Commands and Responses INFO APPL Tokens in Command and Response Buffers ZCOM-TKN-SEL-SUMSTATE is described in the SPI Common Extensions Manual. For a description of all the other tokens in the command and response buffers, see the ADD APPL command. Operational Notes • • • • • • INFO APPL is a nonsensitive command. The INFO APPL display indicates if the attributes ZX121ADDRESS or ZNUMERICUSERIDENTIFIER inside the ZMHS-DDL-APPL-ORNAME token are partially or fully wildcarded.
PAGE 262
INFO CLASS Commands and Responses INFO CLASS The INFO CLASS command returns the configuration of an MHS class. Command ZCOM-CMD-INFO Object Type ZCOM-OBJ-CLASS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-ENUM.
PAGE 263
Commands and Responses INFO CLASS For a description of all the other tokens in the command and response buffers, see the ADD CLASS command. Operational Notes • • INFO CLASS is a nonsensitive command. INFO CLASS does not support the optional command tokens ZCOM-TKN-INFO-DEFLT and ZCOM-TKN-ENQ.
PAGE 264
INFO CUG Commands and Responses INFO CUG The INFO CUG command returns the MHS configuration attribute for a closed user group. Command ZCOM-CMD-INFO Object Type ZCOM-OBJ-CUG Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-ENUM.
PAGE 265
INFO CUG Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME ZMHS-MAP-CUG-PARAMS PARAMS.
PAGE 266
INFO CUGMEMBER Commands and Responses INFO CUGMEMBER The INFO CUGMEMBER command returns the MHS configuration attribute for a closed user group member. Command ZCOM-CMD-INFO Object Type ZCOM-OBJ-CUGMEMBER Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 267
INFO DLIST Commands and Responses INFO DLIST The INFO DLIST command returns the configuration attribute for a distribution list. Command ZCOM-CMD-INFO Object Type ZCOM-OBJ-DLIST Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-ENUM.
PAGE 268
Commands and Responses INFO DLIST Operational Notes • • • INFO DLIST is a nonsensitive command. ZNUMBER-OF-MEMBERS is the number of distribution list members currently configured for the DLIST. This field is not used for the ADD DLIST and the ALTER DLIST commands and should contain the NULL value (-1). The range of values for this field for the INFO command is 0 through 32000. The SPI-NULL value for this field is 255.
PAGE 269
INFO DLISTMEMBER Commands and Responses INFO DLISTMEMBER The INFO DLISTMEMBER command returns the configuration attribute for a distribution list member. Command ZCOM-CMD-INFO Object Type ZCOM-OBJ-DLISTMEMBER Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 270
INFO GATEWAY Commands and Responses INFO GATEWAY The INFO GATEWAY command returns all configuration attributes for a gateway except the password. Command ZCOM-CMD-INFO Object Type ZCOM-OBJ-GATEWAY Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 271
INFO GROUP Commands and Responses INFO GROUP The INFO GROUP command always returns the current configuration of an MHS group. Command ZCOM-CMD-INFO Object Type ZCOM-OBJ-GROUP Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 272
Commands and Responses • • • • INFO GROUP The INFO GROUP command returns all subsystem configuration attributes that can be added. The field descriptions for INFO GROUP are the same as the corresponding field descriptions for ADD GROUP. INFO GROUP does not support the optional command tokens ZCOM-TKN-INFODEFLT and ZCOM-TKN-ENQ. MS INFO returns configuration information for the specified GROUP and also returns the ZMHS-MAP-GROUP token information, which is common to all groups.
PAGE 273
INFO MON Commands and Responses INFO MON The INFO MON command returns the configurable attribute values of the MHS manager. Command ZCOM-CMD-INFO Object Type ZCOM-OBJ-MON Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 274
Commands and Responses INFO MON Tokens in Command Buffer ZSPI-TKN-MANAGER is the MHS manager name, that is, the process to which SCP is to send this command. This token is required and must occur only once. ZCOM-TKN-OBJNAME is the name of the MON object to be altered. This token is optional. ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual.
PAGE 275
Commands and Responses INFO MON ZBUF-SWAPVOL is the name of the disk volume on which the data space (stack space) is swapped. ZDEBUG-ON-ERR is the current state of the DEBUGONERROR flag. ZMEM-SWAPVOL is the name of the disk volume on which general memory is swapped. ZCMK-TKN-LIB-FILE-MOD is the modification date of the user library bound with this code. This token is optional. ZCMK-TKN-LIB-XFNAME is the name of the user library bound with this code. This token is optional.
PAGE 276
Commands and Responses ZSPI-TKN-RETCODE, ZSPI-TKN-ERRLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual. Operational Notes • • INFO MON is a nonsensitive command. INFO MON does not support the optional command tokens ZCOM-TKN-INFO-DEFLT and ZCOM-TKN-ENQ.
PAGE 277
INFO MTA Commands and Responses INFO MTA The INFO MTA command returns all subsystem configuration attributes that can be added (except for passwords). Command ZCOM-CMD-INFO Object Type ZCOM-OBJ-MTA Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT ZCOM-TKN-SUB token-type token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE-TYPE. ZSPI-TYP-STRING.
PAGE 278
Commands and Responses INFO MTA Operational Notes • • • INFO MTA is a nonsensitive command. The INFO MTA command returns all subsystem configuration attributes that can be added (except for passwords). INFO MTA does not support the optional command tokens ZCOM-TKN-INFO-DEFLT and ZCOM-TKN-ENQ.
PAGE 279
INFO ROUTE Commands and Responses INFO ROUTE The INFO ROUTE command returns the configuration attributes for a route. Command ZCOM-CMD-INFO Object Type ZCOM-OBJ-ROUTE Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 280
Commands and Responses • • INFO ROUTE The INFO ROUTE command returns all subsystem configuration attributes that can be added. INFO ROUTE does not support the optional command tokens ZCOM-TKN-INFO-DEFLT and ZCOM-TKN-ENQ.
PAGE 281
INFO SUBSYS Commands and Responses INFO SUBSYS The INFO SUBSYS command returns the configuration of the SUBSYS object. Subsystem configuration attributes can be added using the ADD SUBSYS command and can be returned using the INFO SUBSYS command.
PAGE 282
Commands and Responses Operational Notes • • INFO SUBSYS is a nonsensitive command. INFO SUBSYS does not support the optional command tokens ZCOM-TKN-INFO-DEFLT and ZCOM-TKN-ENQ.
PAGE 283
LISTOBJECTS APPL Commands and Responses LISTOBJECTS APPL The LISTOBJECTS APPL returns a list of all APPL objects known to the MHS subsystem. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-APPL Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 284
LISTOBJECTS CLASS Commands and Responses LISTOBJECTS CLASS The LISTOBJECTS CLASS command returns a list of the CLASS objects known to the MHS subsystem. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-CLASS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE.
PAGE 285
LISTOBJECTS CUG Commands and Responses LISTOBJECTS CUG The LISTOBJECTS CUG command returns a list of the closed user group objects known to the OSI/MHS subsystem.
PAGE 286
Commands and Responses LISTOBJECTS CUG Tokens in Command and Response Buffers ZCOM-TKN-SUB is described in the SPI Common Extensions Manual. For a description of all the other tokens in the command and response buffers, see the ADD CUG command. Operational Notes • • LISTOBJECTS CUG is a nonsensitive command. If ZSPI-TKN-MAXRESP is greater than 0, one object name is included in each SPI data list.
PAGE 287
LISTOBJECTS CUGMEMBER Commands and Responses LISTOBJECTS CUGMEMBER The LISTOBJECTS CUGMEMBER command returns a list of the closed user group member objects known to the OSI/MHS subsystem. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-CUGMEMBER Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-CUGMEM-ORNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZMHS-DDL-ORNAME.
PAGE 288
LISTOBJECTS DLIST Commands and Responses LISTOBJECTS DLIST The LISTOBJECTS DLIST command returns a list of distribution list objects known to the OSI/MHS subsystem. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-DLIST Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-DLIST-PARAMS ZMHS-MAP-DLIST-ORNAME ZMHS-MAP-DLIST-OWNER-ORNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE.
PAGE 289
LISTOBJECTS DLISTMEMBER Commands and Responses LISTOBJECTS DLISTMEMBER The LISTOBJECTS DLISTMEMBER command returns a list of the distribution list member objects known to the OSI/MHS subsystem. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-DLISTMEMBER Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZMHS-MAP-DLMEM-ORNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING.
PAGE 290
LISTOBJECTS ENTRY Commands and Responses LISTOBJECTS ENTRY The LISTOBJECTS ENTRY command returns a list of the ENTRY objects known to the MHS subsystem. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-ENTRY Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 291
Commands and Responses LISTOBJECTS ENTRY Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual.
PAGE 292
LISTOBJECTS GATEWAY Commands and Responses LISTOBJECTS GATEWAY The LISTOBJECTS GATEWAY command returns a list of the GATEWAY objects known to the MHS subsystem. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-GATEWAY Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 293
LISTOBJECTS GROUP Commands and Responses LISTOBJECTS GROUP The LISTOBJECTS GROUP command returns a list of the GROUP objects known to the MHS subsystem. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-GROUP Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE.
PAGE 294
LISTOBJECTS MON Commands and Responses LISTOBJECTS MON The LISTOBJECTS MON command returns the object type and name of the MON object. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-MON Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 295
Commands and Responses LISTOBJECTS MON ZCOM-TKN-SEL-SUMSTATE is described in the SPI Common Extensions Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0, if ZSPITKN-MAXRESP is greater than 0, and if one object is included in each SPI data list.
PAGE 296
LISTOBJECTS MTA Commands and Responses LISTOBJECTS MTA The LISTOBJECTS MTA command returns a list of the MTA objects known to the MHS subsystem. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-MTA Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 297
LISTOBJECTS NULL Commands and Responses LISTOBJECTS NULL The LISTOBJECTS NULL command returns a list of all objects known to the MHS subsystem. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-NULL Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 298
LISTOBJECTS NULL Commands and Responses DLISTMEMBER DLISTMEMBER name ENTRY ENTRY name GATEWAY GATEWAY name GROUP MHS manager group name MON MHS manager process name MTA MTA name PROCESS PROCESS name ROUTE ROUTE name SUBSYS SUBSYSTEM name ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual.
PAGE 299
LISTOBJECTS PROCESS Commands and Responses LISTOBJECTS PROCESS The LISTOBJECTS PROCESS command returns a list of the PROCESS objects known to the MHS subsystem. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-PROCESS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE.
PAGE 300
Commands and Responses LISTOBJECTS PROCESS ZCOM-TKN-SEL-SUMSTATE is described in the SPI Common Extensions Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual.
PAGE 301
LISTOBJECTS ROUTE Commands and Responses 5 Commands and Responses 5 Commands and Responses LISTOBJECTS ROUTE The LISTOBJECTS ROUTE command returns a list of the ROUTE objects known to the MHS subsystem. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-ROUTE Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE.
PAGE 302
LISTOBJECTS SUBSYS Commands and Responses LISTOBJECTS SUBSYS The LISTOBJECTS SUBSYS command returns the object type and name of the SUBSYS object. Command ZCOM-CMD-LISTOBJECTS Object Type ZCOM-OBJ-SUBSYS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 303
LISTOPENS MON Commands and Responses LISTOPENS MON The LISTOPENS command returns the information about all processes that have opened the MON object. Command ZCOM-CMD-LISTOPENS Object Type ZCOM-OBJ-MON Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE-TYPE.
PAGE 304
Commands and Responses LISTOPENS MON Tokens in Command Buffer ZSPI-TKN-MANAGER is the MHS manager name, that is, the process to which SCP is to send this command. This token is required and must occur only once. ZCOM-TKN-OBJNAME is the name of the MON object whose opens are to be listed. This token is optional. ZSPI-TKN-ALLOW when set to a value of ZSPI-VAL-ALLOW-SEGMENTS, declares that the management application can accept a segmented response.
PAGE 305
Commands and Responses LISTOPENS MON ZBKUP-CPU is the backup CPU of the opener or -1 if the opener is not a NonStop process pair. ZBKUP-PIN is the backup PIN of the opener or 0 if the opener is not a NonStop process pair. ZBKUP-FNUM is the file number of the backup of the opener. ZBKUP-FNUM is 0 if the opener is not a NonStop process pair or the file does not exist on the backup CPU. ZPRIM-CPU is the CPU of the opener. ZPRIM-PIN is the PIN of the opener.
PAGE 306
RESETSTATS APPL Commands and Responses RESETSTATS APPL The RESETSTATS APPL command returns the statistical information associated with the specified MS APPL and then resets the counters. This command is not supported for GATEWAY APPL objects. Command ZCOM-CMD-RESETSTATS Object Type ZCOM-OBJ-APPL Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING.
PAGE 307
Commands and Responses RESETSTATS APPL Tokens in Response Buffer ZSPI-TKN-DATALIST token-type ZSPI-TYP-LIST. ZCOM-TKN-OBJTYPE token-type ZSPI-TYP-ENUM. ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZMHS-MAP-STATS-MS-APPL def ZMHS-DDL-STATS-MS-APPL.
PAGE 308
Commands and Responses RESETSTATS APPL Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual. ZMHS-MAP-STATS-MS-APPL is an extensible structured token that contains statistics counts for MS APPLs only.
PAGE 309
Commands and Responses RESETSTATS APPL ZSIZE-MSGS-STORED The size of messages in bytes stored in the MS APPL mailbox since the last reset. This includes the envelope and content size of main entries and returned content message types. The size of child messages is included in either the size of the delivered message or in the size of the returned content. ZDISK-SPACE-STORED The size of disk space in bytes used to store messages of all types for this MS APPL.
PAGE 310
Commands and Responses RESETSTATS APPL ZDISK-SPACE-DELETED The amount of disk space in bytes freed by deleting messages of all types for this MS APPL. It includes the space allocated to the PDU store, PDU logs and the various SQL tables that are used by the mailbox entries. This records the actual disk space that was used by entries deleted from the SQL tables and the PDUs deleted from the PDU store and log file.
PAGE 311
Commands and Responses RESETSTATS APPL ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual. Operational Notes • • RESETSTATS APPL is a sensitive command. RESETSTATS APPL does not support the optional command tokens ZCOM-TKN-INFO-DEFLT and ZCOM-TKN-ENQ.
PAGE 312
RESETSTATS MON Commands and Responses RESETSTATS MON The RESETSTATS MON command returns the statistical information associated with the MHS manager and then resets the counters. Command ZCOM-CMD-RESETSTATS Object Type ZCOM-OBJ-MON Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 313
RESETSTATS MON Commands and Responses Tokens in Response Buffer ZSPI-TKN-DATALIST token-type ZCOM-TKN-OBJTYPE token-type ZCOM-TKN-OBJNAME token-type ZCMK-MAP-STATS-MEM def ZCMK-DDL-STATS-MEM. 02 ZCONFIG type 02 ZCURR type 02 ZCURR-FRAG type 02 ZFAIL type 02 ZGROWTH-CNT type 02 ZGROWTH-TIME type 02 ZMAX type 02 ZRESET-TIME type 02 ZSAMPLE-TIME type end. ZCMK-MAP-STATS-BUF def ZCMK-DDL-STATS-BUF.
PAGE 314
Commands and Responses RESETSTATS MON Tokens in Command Buffer ZSPI-TKN-MANAGER is the MHS manager name, that is, the process to which SCP is to send this command. This token is required and must occur only once. ZCOM-TKN-OBJNAME is the name of the MON object for which the statistics counters are to be reset. This token is optional. ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual.
PAGE 315
Commands and Responses RESETSTATS MON ZFAIL is the amount of storage in the last request for memory that was rejected since process initialization, the last backup takeover, or the last RESETSTATS. ZGROWTH-CNT is the number of times the pool was enlarged because of storage pressure. The range of values is 0 through 65,535. ZGROWTH-TIME is the time that the pool last grew.
PAGE 316
Commands and Responses RESETSTATS MON ZFAIL is the amount of storage in the last request for memory that was rejected since process initialization, the last backup takeover, or the last RESETSTATS. ZGROWTH-CNT is the number of times the pool was enlarged because of storage pressure. The range of values is 0 through 65535. ZGROWTH-TIME is the time that the pool last grew.
PAGE 317
Commands and Responses RESETSTATS MON ZRESET-TIME is the latest time at which process initialization, backup takeover, or the RESETSTATS command occurred. ZSAMPLE-TIME is the time that the sample was taken; that is, when the response buffer was built. ZCMK-MAP-STATS-OPNR is an extensible structured token that contains information about the number of openers of the process.
PAGE 318
RESETSTATS PROCESS Commands and Responses RESETSTATS PROCESS The RESETSTATS PROCESS command returns the statistical information associated with the process and then resets the counters. It returns the different statistical counters maintained by each PROCESS type.
PAGE 319
RESETSTATS PROCESS Commands and Responses 02 ZCNT-UA-CANCEL 02 ZCNT-UA-DELETE end. ZMHS-MAP-STATS-MRP def ZMHS-DDL-STATS-MRP. 02 ZRESET-TIME 02 ZSAMPLE-TIME 02 ZCPU 02 ZCNT-INVAL-MSG 02 ZCNT-RX-UMPDU 02 ZCNT-TX-UMPDU 02 ZCNT-RX-PROBE 02 ZCNT-TX-PROBE 02 ZCNT-RX-REPORT 02 ZCNT-TX-REPORT 02 ZCNT-USR-SUBMIT 02 ZCNT-USR-PROBE 02 ZCNT-USR-DELIVER 02 ZCNT-USR-REPORT 02 ZCNT-USR-CANCEL end. ZMHS-MAP-STATS-RTS def ZMHS-DDL-STATS-RTS.
PAGE 320
Commands and Responses ZMHS-MAP-STATS-SC def ZMHS-DDL-STATS-SC. 02 ZRESET-TIME type 02 ZSAMPLE-TIME type 02 ZCPU type 02 ZTOTAL-PDUS-DELETED type 02 ZPDUS-DELETED-IN-SWEEP type 02 ZSIZE-OF-LAST-SWEEP type 02 ZLARGEST-SWEEP type 02 ZLENGTH-OF-LAST-SWEEP type 02 ZLONGEST-SWEEP type 02 ZNUMBER-OF-SWEEPS type end. ZMHS-MAP-STATS-RS def ZMHS-DDL-STATS-RS.
PAGE 321
Commands and Responses ZMHS-MAP-STATS-GI def ZMHS-DDL-STATS-GI.
PAGE 322
Commands and Responses RESETSTATS PROCESS Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual. ZMHS-MAP-STATS-MS is an extensible structured token that contains general statistics for the MS.
PAGE 323
Commands and Responses RESETSTATS PROCESS ZCNT-UA-PROBE is the number of probes submitted by UAs to the MS. ZCNT-UA-LIST is the number of list operations performed for UAs. ZCNT-UA-FETCH is the number of message fetch operations performed for UAs. ZCNT-UA-SUMMARY is the number of summarize operations performed for UAs. ZCNT-UA-CANCEL is the number of cancel deferred delivery operations performed for UAs. ZCNT-UA-DELETE is the number of delete operations performed for UAs.
PAGE 324
Commands and Responses RESETSTATS PROCESS ZCNT-TX-UMPDU is the number of user messages sent by the MRP to adjacent MTAs and GATEWAYs. ZCNT-RX-PROBE is the number of user probes received by the MRP from adjacent MTAs and GATEWAYs. ZCNT-TX-PROBE is the number of user probes sent to adjacent MTAs and GATEWAYs. ZCNT-RX-REPORT is the number of delivery reports received by the MRP from adjacent MTAs and GATEWAYs. ZCNT-TX-REPORT is the number of delivery reports sent to adjacent MTAs and GATEWAYs.
PAGE 325
Commands and Responses RESETSTATS PROCESS ZSAMPLE-TIME is the time that the sample was taken; that is, when the response buffer was built. ZCPU is the CPU in which the process is running, or -1 if it is not running. This information is supplied by the MHS manager. ZCNT-TX-MSG is the number of messages sent by the RTS. ZCNT-TX-BYTE is the number of message bytes sent by the RTS, in kilobytes. ZCNT-RX-MSG is the number of messages received by the RTS.
PAGE 326
Commands and Responses RESETSTATS PROCESS ZCNT-O-ASS-FAIL is the number of outgoing associations that have failed and could not be recovered. ZCNT-I-ASS-RECOV is the number of successful incoming association recoveries. ZCNT-O-ASS-RECOV is the number of successful outgoing association recoveries. ZCNT-I-TX-FAIL is the number of incoming message transfers that have failed. ZCNT-O-TX-FAIL is the number of outgoing message transfers that have failed.
PAGE 327
Commands and Responses RESETSTATS PROCESS ZRESET-TIME is the time the statistics were reset by the RESETSTATS or START command. ZSAMPLE-TIME is the time that the sample was taken; that is, when the response buffer was built. ZCPU is the CPU in which the process is running, or -1 if it is not running. ZTOTAL-PDUS-DELETED is the total number of PDUs deleted by the SC. ZPDUS-DELETED-IN-SWEEP is the number of PDUs deleted in the last sweep.
PAGE 328
Commands and Responses RESETSTATS PROCESS ZCPU is the CPU in which the process is running, or -1 if it is not running. This information is supplied by the MHS manager. ZCNT-TX-MSG is the number of APDUs sent by the RS. ZCNT-TX-BYTE is the number of message bytes sent by the RS, in kilobytes. ZCNT-RX-MSG is the number of APDUs received by the RS. ZCNT-RX-BYTE is the number of message bytes received by the RS, in kilobytes. ZCNT-I-ASS-OP is the number of incoming associations opened.
PAGE 329
Commands and Responses RESETSTATS PROCESS ZCPU is the CPU in which the process is running, or -1 if it is not running. This information is supplied by the MHS manager. ZCNT-TX-MSG is the number of messages sent by the RTS. ZCNT-TX-BYTE is the number of message bytes sent by the RTS, in kilobytes. ZCNT-RX-MSG is the number of messages received by the RTS. ZCNT-RX-BYTE is the number of message bytes received by the RTS, in kilobytes. ZCNT-I-ASS-OP is the number of incoming associations opened.
PAGE 330
Commands and Responses RESETSTATS PROCESS ZSESSIONS-OPENED is the number of sessions opened. ZSESSIONS-CLOSED is the number of sessions closed. ZOUTBOUND-USER-MSGS is the number of outbound P1 user MPDUs. ZINBOUND-USER-MSGS is the number of inbound P1 user MPDUs. ZOUTBOUND-PROBES is the number of outbound P1 probe MPDUs. ZINBOUND-PROBES is the number of inbound P1 probe MPDUs. ZOUTBOUND-REPORTS is the number of outbound P1 reports MPDUs. ZINBOUND-REPORTS is the number of inbound P1 reports MPDUs.
PAGE 331
Commands and Responses RESETSTATS PROCESS ZBAD-TRANSFER-OUT is the number of startTransferOut attempts that were not completed. ZMR-GROUP-SWITCHES is the number of forced MR group switches. ZBAD-RECEIVED-MSGS is the number of unknown messages on $RECEIVE. ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual. Operational Notes • • • RESETSTATS PROCESS is a sensitive command.
PAGE 332
START APPL Commands and Responses START APPL The START APPL command starts an APPL name that is in the STOPPED state or that has just been added using the ADD command. This makes the APPL configuration available for logons and for receiving and submitting messages. Command ZCOM-CMD-START Object Type ZCOM-OBJ-APPL Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32.
PAGE 333
Commands and Responses START APPL Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual. ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual.
PAGE 334
START CLASS Commands and Responses START CLASS The START CLASS command starts a CLASS. Command ZCOM-CMD-START Object Type ZCOM-OBJ-CLASS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-ENUM.
PAGE 335
Commands and Responses START CLASS Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual. ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual.
PAGE 336
START GROUP Commands and Responses START GROUP The START GROUP command starts a group that is in the STOPPED state. This entails running the processes within that group. Command ZCOM-CMD-START Object Type ZCOM-OBJ-GROUP Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 337
Commands and Responses START GROUP ZCOM-TKN-SUB is described in the SPI Common Extensions Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual.
PAGE 338
START SUBSYS Commands and Responses START SUBSYS The START SUBSYS command starts the SUBSYS object. This allows CLASS objects and GROUP objects to be started. Command ZCOM-CMD-START Object Type ZCOM-OBJ-SUBSYS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 339
Commands and Responses START SUBSYS Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual. ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual.
PAGE 340
STATISTICS APPL Commands and Responses STATISTICS APPL The STATISTICS APPL command returns the statistical information associated with an MS APPL only. It is not supported for a GATEWAY APPL. Command ZCOM-CMD-STATISTICS Object Type ZCOM-OBJ-APPL Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE.
PAGE 341
STATISTICS MON Commands and Responses STATISTICS MON The STATISTICS MON command returns the statistical information associated with the MHS manager. Command ZCOM-CMD-STATISTICS Object Type ZCOM-OBJ-MON Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 342
STATISTICS PROCESS Commands and Responses STATISTICS PROCESS The STATISTICS PROCESS command returns the statistical information associated with a process. The statistical information is derived from counters maintained by each PROCESS type.
PAGE 343
Commands and Responses STATISTICS PROCESS Tokens in Command and Response Buffers For a description of the tokens in the command and response buffers, see the RESETSTATS PROCESS command. Operational Notes • • STATISTICS PROCESS is a nonsensitive command. STATISTICS PROCESS does not support the optional command tokens ZCOM-TKN-INFO-DEFLT and ZCOM-TKN-ENQ.
PAGE 344
STATUS APPL Commands and Responses STATUS APPL The STATUS APPL command returns operational status of the application, including the logon state of the application. Command ZCOM-CMD-STATUS Object Type ZCOM-OBJ-APPL Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE.
PAGE 345
Commands and Responses STATUS APPL 02 ZAUTHORIZING-USERS type ZSPI-DDL-ENUM. 02 ZAUTO-FORWARD type ZSPI-DDL-ENUM. 02 ZBLIND-COPY-RECIPS type ZSPI-DDL-ENUM. 02 ZCOPY-RECIPS type ZSPI-DDL-ENUM. 02 ZEXPIRY-TIME type ZSPI-DDL-ENUM. 02 ZIMPORTANCE type ZSPI-DDL-ENUM. 02 ZOBSOLETED-IPMS type ZSPI-DDL-ENUM. 02 ZORIGINATOR type ZSPI-DDL-ENUM. 02 ZPRIMARY-RECIPS type ZSPI-DDL-ENUM. 02 ZRELATED-IPMS type ZSPI-DDL-ENUM. 02 ZREPLIED-TO-IPMS type ZSPI-DDL-ENUM. 02 ZREPLY-RECIPS type ZSPI-DDL-ENUM.
PAGE 346
STATUS APPL Commands and Responses ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual. ZCOM-TKN-SEL-SUMSTATE is described in the SPI Common Extensions Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0.
PAGE 347
STATUS APPL Commands and Responses ZMHS-DDL-STATUS-MS-APPL, contains the following fields. For all the fields in this token, the enumerated values are: ZMHS-VAL-ATTRIBUTE- Meaning NONE Attribute is in neither set LIST Attribute is in the LIST attribute default set FETCH Attribute is in the FETCH attribute default set BOTH Attribute is in both sets ZBODY is a message retrieval attribute that specifies whether this APPL object can use the body attribute of an X.400 message.
PAGE 348
Commands and Responses STATUS APPL ZMSG-DEL-ENVELOPE is a message retrieval attribute that specifies whether this APPL object can use the messageDeliveryEnvelope X.400 attribute stored in the MS. ZPARENT-SEQ-NO is a message retrieval attribute that specifies whether this APPL object can use the parentSequenceNumber X.400 attribute stored in the MS. ZRECIP-REP-DEL-FIELDS is a message retrieval attribute that specifies whether this APPL object can use the perRecipientReportDeliveryFields X.
PAGE 349
Commands and Responses STATUS APPL ZBLIND-COPY-RECIPS is a message retrieval attribute that specifies whether this APPL object can use the blindCopyRecipients X.400 attribute stored in the MS. ZCOPY-RECIPS is a message retrieval attribute that specifies whether this APPL object can use the copyRecipients X.400 attribute stored in the MS. ZEXPIRY-TIME is a message retrieval attribute that specifies whether this APPL object can use the expiryTime X.400 attribute stored in the MS.
PAGE 350
Commands and Responses STATUS APPL ZSENSITIVITY is a message retrieval attribute that specifies whether this APPL object can use the sensitivity X.400 attribute stored in the MS. ZSUBJECT is a message retrieval attribute that specifies whether this APPL object can use the subject X.400 attribute stored in the MS. ZCONTENT-ID is a message retrieval attribute that specifies whether this APPL object can use the contentIdentifier X.400 attribute stored in the MS.
PAGE 351
Commands and Responses STATUS APPL ZMHS-MAP-STATUS-APPL-MB definition, ZMHS-DDL-MS-APPL-MB, contains the following fields: znum-reps is the number of delivered reports currently in the MS APPL database. This count includes only the X400 main entries. It does not include any returned content messages that were returned with reports; these are counted under the field ZNUM-RET-CONT. znum-del-msgs is the number of delivered messages currently in the MS APPL database.
PAGE 352
Commands and Responses STATUS APPL znum-unread-ret-cont is the number of unread returned content messages currently in the MS APPL database. This count does not include the following: • • Unread delivered report messages in which these messages were returned. These are counted under the field ZNUM-UNREAD-REPS. Unread child messages of returned content messages. These are included under the field ZNUM-UNREAD-CHILDREN.
PAGE 353
Commands and Responses STATUS APPL Operational Notes • • • • STATUS APPL is a nonsensitive command. The initial logon state is LOGGED-OFF. The GW APPL is always in the LOGGED-OFF state. The status counts in ZMHS-DDL-APPL-MB are snapshots of the state of the mailbox; they do not include any messages that are received and deleted between counts.
PAGE 354
STATUS CLASS Commands and Responses STATUS CLASS The STATUS CLASS command returns the operational status of a CLASS, including the CLASS name and its summary state. Command ZCOM-CMD-STATUS Object Type ZCOM-OBJ-CLASS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE.
PAGE 355
Commands and Responses STATUS CLASS ZCOM-TKN-OBJNAME is the name of the CLASS object for which you want status information. This token is required. ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual. ZCOM-TKN-SUB ZCOM-TKN-SEL-SUMSTATE are described in the SPI Common Extensions Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list.
PAGE 356
Commands and Responses STATUS CLASS ZGROUP-RECOV-CNT is the number of groups that have failed and are currently being recovered by the MHS manager. ZGROUP-DEFINED-CNT is the number of groups that are defined for this class. ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual. Operational Note STATUS CLASS is a nonsensitive command.
PAGE 357
STATUS ENTRY Commands and Responses STATUS ENTRY The STATUS ENTRY command returns state information for the ENTRY command. Command ZCOM-CMD-STATUS Object Type ZCOM-OBJ-ENTRY Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 358
Commands and Responses STATUS ENTRY Tokens in Response Buffer ZSPI-TKN-DATALIST token-type ZSPI-TYP-LIST. ZSPI-TKN-RETCODE token-type ZSPI-TYP-ENUM. ZCOM-TKN-OBJTYPE token-type ZSPI-TYP-ENUM. ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING. ZCOM-TKN-OBJSTATE token-type ZSPI-TYP-ENUM. ZMHS-MAP-STATUS-COUNTS def ZMHS-DDL-STATUS-COUNTS. 02 ZITEM-COUNT-TOTAL type ZSPI-DDL-INT2. end. ZSPI-TKN-SEGLIST ZMHS-MAP-STATUS-ENTRY def ZMHS-DDL-STATUS-ENTRY. 02 ZPDUIDENTIFIER type ZSPI-DDL-INT4.
PAGE 359
Commands and Responses STATUS ENTRY ZCOM-TKN-OBJNAME is the name of the ENTRY object for which you want status information. This token is required. ZSPI-TKN-ALLOW when set to a value of ZSPI-VAL-ALLOW-SEGMENTS, declares that the management application can accept a segmented response. ZSPI-TKN-ALLOW-TYPE, ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual.
PAGE 360
Commands and Responses STATUS ENTRY ZNEXT-ACTION-TIME is the time when the item in the queue will next be acted upon. ZSTART-TIME is the time when the PDU started the retry sequence. For DEFERRED ENTRYs, this is the time the message was first submitted to the MTA. For LINKRETRY ENTRYs, this is the time of the initial failure to transmit the message.
PAGE 361
Commands and Responses STATUS ENTRY ZSTRING is a valid PRMD name. ZMPDUID-LOCALID is the local ID name component of the MPDU identifier. The SPI-NULL value for this token is 0. ZLENGTH is the length; maximum value is 32 characters. ZSTRING is a valid local ID. ZLAST-MTA-TRIED is the DSM object name of the last MTA where a transfer was attempted. ZGROUP-OBJ-NAME is the DSM object name of a group where the PDU store contains a message.
PAGE 362
Commands and Responses STATUS ENTRY ZITEM-COUNT-TOTAL item contains the number of items on the ENTRY queue when the first response buffer was returned. As subsequent response buffers are returned the number of items on the ENTRY queue may change and the total number of items eventually returned may not match ZITEM-COUNT-TOTAL. If segmentation is not allowed, a single response buffer containing a maximum of 30 ENTRY items is returned.
PAGE 363
STATUS GROUP Commands and Responses STATUS GROUP The STATUS GROUP command returns the operational status of a group, including the object name and summary state for all groups. Command ZCOM-CMD-STATUS Object Type ZCOM-OBJ-GROUP Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE.
PAGE 364
Commands and Responses STATUS GROUP ZCOM-TKN-SUB ZCOM-TKN-SEL-SUMSTATE are described in the SPI Common Extensions Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME ZCOM-TKN-OBJSTATE are described in the SPI Common Extensions Manual.
PAGE 365
STATUS MON Commands and Responses STATUS MON The STATUS MON command returns the operational status of the MHS manager. Command ZCOM-CMD-STATUS Object Type ZCOM-OBJ-MON Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-INT-PAIR.
PAGE 366
Commands and Responses STATUS MON ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE, ZSPI-TKN-COMMENT are described in the SPI Programming Manual. ZCOM-TKN-SEL-SUMSTATE is described in the SPI Common Extensions Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0.
PAGE 367
Commands and Responses STATUS MON ZMHS-MAP-TRACE-STATUS is the location where the current trace status information about this object is stored. This token is required. The ZMHS-MAP-TRACE-STATUS definition, ZMHS-DDL-TRACE-STATUS, contains the following fields: ZTRACE-STATUS specifies the current trace status. ZTRACE-OPTIONS is the 32-bit integer that corresponds to the trace number defined in the TRACE command section of this object description and when set will indicate the corresponding trace option.
PAGE 368
STATUS PROCESS Commands and Responses STATUS PROCESS The STATUS PROCESS command returns the operational status of the process. For the MS process, STATUS PROCESS returns state information and the number of mailboxes unused by an APPL object. For the MRP, STATUS PROCESS returns status information from the MRP. The structured tokens ZMHS-DDL-FU-QUEUE, ZMHS-DDL-MTA-QUEUE, and ZMHS-DDL-APPL-QUEUE can occur 0 or more times.
PAGE 369
STATUS PROCESS Commands and Responses For MS Processes: ZMHS-MAP-STATUS-MS def ZMHS-DDL-STATUS-MS. 02 ZCPU 02 ZSTART-TIME 02 ZFAIL-TIME 02 ZCNT-AVAIL-MBOXES 02 ZCNT-ACTIVE-UA end. ZMHS-MAP-TRACE-STATUS def ZMHS-DDL-TRACE-STATUS. 02 ZTRACE-STATUS 02 ZTRACE-OPTIONS 02 ZTRACE-FILE end. type type type type type ZSPI-DDL-INT. ZSPI-DDL-TIMESTAMP. ZSPI-DDL-TIMESTAMP. ZSPI-DDL-INT. ZSPI-DDL-INT2. type ZMHS-DDL-FLAG. type ZSPI-DDL-INT2. type ZMHS-DDL-EXCEED-FNAME.
PAGE 370
Commands and Responses STATUS PROCESS For MRP Processes: ZMHS-MAP-STATUS-MRP def ZMHS-DDL-STATUS-MRP. 02 ZCPU type ZSPI-DDL-INT. 02 ZSTART-TIME type ZSPI-DDL-TIMESTAMP. 02 ZFAIL-TIME type ZSPI-DDL-TIMESTAMP. 02 ZFU-COUNT-TOTAL type ZSPI-DDL-INT2. 02 ZMTA-COUNT-TOTAL type ZSPI-DDL-INT2. 02 ZAPPL-COUNT-TOTAL type ZSPI-DDL-INT2. end. ZMHS-MAP-TRACE-STATUS def ZMHS-DDL-TRACE-STATUS. 02 ZTRACE-STATUS type ZMHS-DDL-FLAG. 02 ZTRACE-OPTIONS type ZSPI-DDL-INT2. 02 ZTRACE-FILE type ZMHS-DDL-EXCEED-FNAME. end.
PAGE 371
STATUS PROCESS Commands and Responses For RTS Processes: ZMHS-MAP-STATUS-RTS def ZMHS-DDL-STATUS-RTS. 02 ZCPU 02 ZSTART-TIME 02 ZFAIL-TIME 02 ZCNT-I-ASS 02 ZCNT-O-ASS end. ZMHS-MAP-TRACE-STATUS def ZMHS-DDL-TRACE-STATUS. 02 ZTRACE-STATUS 02 ZTRACE-OPTIONS 02 ZTRACE-FILE end. ZMHS-MAP-ASSOC-INFO def ZMHS-DDL-ASSOC-INFO.
PAGE 372
STATUS PROCESS Commands and Responses For SC Processes: ZMHS-MAP-STATUS-SC def ZMHS-DDL-STATUS-SC. 02 ZCPU 02 ZSTART-TIME 02 ZFAIL-TIME 02 ZNEXT-SWEEP-TIME end. ZMHS-MAP-TRACE-STATUS def ZMHS-DDL-TRACE-STATUS. 02 ZTRACE-STATUS 02 ZTRACE-OPTIONS 02 ZTRACE-FILE end. type type type type ZSPI-DDL-INT. ZSPI-DDL-TIMESTAMP. ZSPI-DDL-TIMESTAMP. ZSPI-DDL-TIMESTAMP. type ZMHS-DDL-FLAG. type ZSPI-DDL-INT2. type ZMHS-DDL-EXCEED-FNAME. For RS Processes: ZMHS-MAP-STATUS-RS def ZMHS-DDL-STATUS-RS.
PAGE 373
STATUS PROCESS Commands and Responses For GI Processes: ZMHS-MAP-STATUS-GI def ZMHS-DDL-STATUS-GI. 02 ZCPU 02 ZSTART-TIME 02 ZFAIL-TIME 02 ZCNT-I-SESSION 02 ZMESSAGE-Q-LENGTH end. ZMHS-MAP-TRACE-STATUS def ZMHS-DDL-TRACE-STATUS. 02 ZTRACE-STATUS 02 ZTRACE-OPTIONS 02 ZTRACE-FILE end. type type type type type ZSPI-DDL-INT. ZSPI-DDL-TIMESTAMP. ZSPI-DDL-TIMESTAMP. ZSPI-DDL-INT2. ZSPI-DDL-INT2. type ZMHS-DDL-FLAG. type ZSPI-DDL-INT2. type ZMHS-DDL-EXCEED-FNAME. For All Processes: ZSPI-TKN-ERRLIST . . .
PAGE 374
Commands and Responses STATUS PROCESS Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZSPI-TKN-RETCODE is described in the SPI Programming Manual. ZCOM-TKN-OBJTYPE, ZCOM-TKN-OBJNAME, ZCOM-TKN-OBJSTATE are described in the SPI Common Extensions Manual.
PAGE 375
Commands and Responses STATUS PROCESS ZTRACE-STATUS is a flag that specifies the current trace status. The SPI-NULL value for this field is 32. ZTRACE-OPTIONS is the 32-bit integer that corresponds to the trace number defined in the TRACE command section of this object description and when set will indicate the corresponding trace option. If ZTRACE-STATUS has a value of ZMHS-VALFLAG-OFF, this field is null. ZTRACE-FILE is the file name of the trace output file.
PAGE 376
Commands and Responses STATUS PROCESS ZMHS-MAP-FU-QUEUE is an optional extensible structured token that contains status information for FU queues of the specified MRP PROCESS. This token may occur 0 (zero) or more times. This structure is repeated for each FU with more than 0 items in its queue. The ZMHS-MAP-FU-QUEUE definition, ZMHS-DDL-FU-QUEUE, contains the following fields: ZSPI-TKN-SEGLIST introduces a segmented list; ZSPI-TKN-ENDLIST ends the segmented list.
PAGE 377
Commands and Responses STATUS PROCESS ZAPPLNAME is the object identifier of the APPL object. ZCOUNT is the number of messages for the APPL object. ZMHS-MAP-STATUS-RTS is an extensible structured token that contains state information for the RTS process. This token is required if ZCOM-TKN-OBJNAME is an RTS process. The ZMHSMAP-STATUS-RTS definition, ZMHS-DDL-STATUS-RTS, contains the following fields: ZCPU is the CPU in which the process is running, or -1 if it is not running.
PAGE 378
Commands and Responses STATUS PROCESS ZREMTSELECTOR is a structure that defines the TSEL part of the OSI address used by this RTS for receiving associations from adjacent MTAs. This structure identifies a Transport Layer entity. ZREMTSELECTOR contains the following fields: ZLENGTH is the length of the string field. The range of values is 0 through 64 bytes. ZSTRING is the OSI address TSEL.
PAGE 379
Commands and Responses STATUS PROCESS ZDIRECTION is the direction of the association. This field can contain the following values: ZMHS-VAL-DIRECTION-OUT ZMHS-VAL-DIRECTION-IN ZSTATE is the state of the association. The possible values are the numbers following STA in Table A.2 of X.228. ZREMPSELECTOR is a structure that defines the PSEL part of the OSI address used by this RTS for receiving associations from adjacent MTAs. This structure identifies a Presentation Layer entity.
PAGE 380
Commands and Responses STATUS PROCESS ZLOCSSELECTOR is a structure that defines the SSEL part of the OSI address used by OSI/MHS. This structure identifies a Session Layer entity. ZLOCSSELECTOR contains: ZLENGTH is the length of the string field. The range of values is 0 through 32 bytes. ZSTRING is the OSI address SSEL. ZMHS-MAP-STATUS-SC is an extensible structured token that contains state information for the SC process. This token is required if ZCOM-TKN-OBJNAME is an SC process.
PAGE 381
Commands and Responses STATUS PROCESS ZCPU is the CPU in which the process is running, or -1 if it is not running. This information is supplied by the MHS manager. The SPI-NULL value for this field is 255. ZSTART-TIME is the time at which the process was last started. The value is supplied by the MHS manager. The SPI-NULL value for this field is 0. ZFAIL-TIME is the time at which the process last failed. The value is supplied by the MHS manager. The SPI-NULL value for this field is 0.
PAGE 382
Commands and Responses STATUS PROCESS ZMHS-MAP-TRACE-STATUS see previous description under the ZMHS-MAP-STATUS-MS structure. ZMHS-MAP-STATUS-GI is an extensible structured token that contains state information for the RS process. This token is required. The ZMHS-MAP-STATUS-GI definition, ZMHS-DDLSTATUS-GI, contains the following fields: ZCPU is the CPU in which the process is running, or -1 if it is not running. This information is supplied by the MHS manager. The SPI-NULL value for this field is 255.
PAGE 383
STATUS SUBSYS Commands and Responses STATUS SUBSYS The STATUS SUBSYS command returns the operational status of the subsystem. Command ZCOM-CMD-STATUS Object Type ZCOM-OBJ-SUBSYS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-INT-PAIR.
PAGE 384
Commands and Responses STATUS SUBSYS ZCOM-TKN-SEL-SUMSTATE is described in the SPI Common Extensions Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual.
PAGE 385
STOP APPL Commands and Responses STOP APPL The STOP APPL command stops an APPL name. Command ZCOM-CMD-STOP Object Type ZCOM-OBJ-APPL Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SEL-SUMSTATE ZCOM-TKN-CMD-POWER token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-INT-PAIR. token-type ZSPI-TYP-ENUM.
PAGE 386
Commands and Responses STOP APPL ZCOM-TKN-SEL-SUMSTATE is described in the SPI Common Extensions Manual. ZCOM-TKN-CMD-POWER is described in the SPI Common Extensions Manual. The possible values are: NORMAL Stop the application name only if the MS application name is not currently in use (logged on). This is the default value. FORCED Stop the application even if an MS application name is use (logged on).
PAGE 387
STOP CLASS Commands and Responses STOP CLASS The STOP CLASS command changes the summary state of a class to STOPPED. Command ZCOM-CMD-STOP Object Type ZCOM-OBJ-CLASS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SUB ZCOM-TKN-SEL-SUMSTATE ZCOM-TKN-CMD-POWER token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE.
PAGE 388
Commands and Responses STOP CLASS ZCOM-TKN-SUB ZCOM-TKN-SEL-SUMSTATE are described in the SPI Common Extensions Manual. ZCOM-TKN-CMD-POWER is described in the SPI Common Extensions Manual. The possible values are: FORCED Groups stop themselves after the processes within the group have safestored their message queues to disk. The current message is not completed until the process is restarted.
PAGE 389
STOP GROUP Commands and Responses STOP GROUP The STOP GROUP command is used to stop an MHS group. Command ZCOM-CMD-STOP Object Type ZCOM-OBJ-GROUP Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SEL-SUMSTATE ZCOM-TKN-CMD-POWER token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-INT-PAIR.
PAGE 390
Commands and Responses STOP GROUP ZCOM-TKN-SEL-SUMSTATE is described in the SPI Common Extensions Manual. ZCOM-TKN-CMD-POWER is described in the SPI Common Extensions Manual. The possible values are: FORCED Processes within the group stop after safestoring the process message queues to disk. The current message does not get completed until the process is restarted. For an MS group, FORCED causes the MS group to delete redundant PDUs from its PDU stores.
PAGE 391
STOP MON Commands and Responses STOP MON The STOP MON command stops the MHS manager. The STOP MON command has the same result as the ABORT MON command. Command ZCOM-CMD-STOP Object Type ZCOM-OBJ-MON Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 392
Commands and Responses STOP MON Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual. ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual.
PAGE 393
STOP SUBSYS Commands and Responses STOP SUBSYS The STOP SUBSYS command terminates the operation of MHS SUBSYS objects. This command has the same effect as the ABORT SUBSYS command. Command ZCOM-CMD-STOP Object Type ZCOM-OBJ-SUBSYS Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-SEL-SUMSTATE token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE.
PAGE 394
Commands and Responses STOP SUBSYS ZCOM-TKN-SEL-SUMSTATE is described in the SPI Common Extensions Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual.
PAGE 395
SUSPEND APPL Commands and Responses SUSPEND APPL The SUSPEND APPL command suspends an APPL name. Command ZCOM-CMD-SUSPEND Object Type ZCOM-OBJ-APPL Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT ZCOM-TKN-CMD-POWER token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-ENUM.
PAGE 396
Commands and Responses SUSPEND APPL NORMAL The application name is suspended only if the application name is not currently in use (logged on). This the default. FORCED The application is suspended whether or not an application name is in use (logged on). Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list.
PAGE 397
SWITCH MON Commands and Responses SWITCH MON The SWITCH MON command switches the primary and backup CPU of the MHS manager. Command ZCOM-CMD-SWITCH Object Type ZCOM-OBJ-MON Tokens in Command Buffer ZSPI-TKN-MANAGER ZCOM-TKN-OBJNAME ZCOM-TKN-SWITCH-CPU ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE TYPE. ZSPI-TKN-COMMENT token-type token-type token-type token-type token-type ZSPI-TYP-FNAME32. ZSPI-TYP-STRING. ZSPI-TYP-INT ZSPI-TYP-ALLOW-TYPE. ZSPI-TYP-RESPONSE- token-type ZSPI-TYP-STRING.
PAGE 398
Commands and Responses SWITCH MON ZSPI-TKN-ALLOW-TYPE ZSPI-TKN-RESPONSE-TYPE ZSPI-TKN-COMMENT are described in the SPI Programming Manual. Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual.
PAGE 399
TRACE MON Commands and Responses TRACE MON The TRACE MON command initiates, modifies, or stops tracing of the MHS manager. Command ZCOM-CMD-TRACE Object Type ZCOM-OBJ-MON Tokens in Command Buffer ZSPI-TKN-MANAGER token-type ZCOM-TKN-OBJNAME token-type ZCOM-MAP-TRACE-MODIF def ZCOM-DDL-TRACE-MODIF. 02 ZSTOP type 02 ZPRIM type 02 ZREC-SIZE type 02 ZCNT type 02 ZXDS-PAGES type 02 ZCOLL type 02 ZFNAME type end.
PAGE 400
TRACE MON Commands and Responses ZCOM-MAP-TRACE-MODIF is a standard data-communications extensible structured token described in the SPI Common Extensions Manual. This token must be present in the command, and duplicate occurrences are not allowed. ZCOM-TKN-TRACE-OPT is a standard data-communications token described in the SPI Common Extensions Manual. This token must be present in the command and can appear multiple times. ZCOM-TKN-TRACE-OPT selects the kinds of trace records to be generated.
PAGE 401
Commands and Responses TRACE MON Operational Notes • • • • TRACE MON is a sensitive command. The fields within ZCOM-TKN-TRACE-MODIF can be set up as required. The token must be present in the buffer or SCP will reject the command. Refer to the OSI/MHS SCF Reference Manual for more information about traced information. The ZCOM-TKN-TRACE-BKUP token is not supported.
PAGE 402
TRACE PROCESS Commands and Responses TRACE PROCESS The TRACE PROCESS command starts, stops, or modifies tracing for the process. Command ZCOM-CMD-TRACE Object Type ZCOM-OBJ-PROCESS Tokens in Command Buffer ZSPI-TKN-MANAGER token-type ZCOM-TKN-OBJNAME token-type ZCOM-MAP-TRACE-MODIF def ZCOM-DDL-TRACE-MODIF. 02 ZSTOP type 02 ZPRIM type 02 ZREC-SIZE type 02 ZCNT type 02 ZXDS-PAGES type 02 ZCOLL type 02 ZFNAME type end.
PAGE 403
TRACE PROCESS Commands and Responses ZCOM-MAP-TRACE-MODIF is a standard data-communications extensible structured token described in the SPI Common Extensions Manual. This token must be present in the command, and duplicate occurrences are not allowed. ZCOM-TKN-TRACE-OPT is a standard data-communications token described in the SPI Common Extensions Manual. This token must be present in the command can appear multiple times. ZCOM-TKN-TRACE-OPT selects the kinds of trace records to be generated.
PAGE 404
Commands and Responses TRACE PROCESS Tokens in Response Buffer ZSPI-TKN-DATALIST introduces a data list, as described in the SPI Programming Manual; the final ZSPI-TKN-ENDLIST ends the data list. These tokens enclose the other response tokens only if the value of the header token ZSPI-TKN-MAXRESP is not 0. ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJNAME are described in the SPI Common Extensions Manual. ZSPI-TKN-RETCODE ZSPI-TKN-ERRLIST ZSPI-TKN-ENDLIST ZSPI-TKN-CONTEXT are described in the SPI Programming Manual.
PAGE 405
6 Event Messages This section describes the contents and meaning of all event messages defined by OSI/MHS. OSI/MHS also generates event messages defined by ZCMK and ZCOM. For descriptions of ZCMK-defined and ZCOM-defined event messages, see the SPI Common Extensions Manual. Within the OSI/MHS subsystem, the MHS manager and TAPS processes generate event messages. All event messages generated by these processes contain the OSI/MHS subsystem ID, which is described under SPI Standard Definitions on page 4-2.
PAGE 406
Event Messages Table 6-1. OSI/MHS Event Messages (page 2 of 3) Symbolic Name (ZMHS-EVT-) Event Number Message Text ACCT-ROS-ASSOC-END 40 ROS Association End; Assoc. id(…); APPL #…; Reason: … ACCT-ROS-ASSOC-OP 38 ROS Association… ACCT-ROS-TRANSFER 39 ROS … APDU Transfer; Association id(…); APPL #… ACCT-RTS-ASSOC-END 37 RTS … Association End; Assoc. id (…) Reason … ACCT-RTS-ASSOC-OP 35 RTS … Association Accepted/Rejected… ACCT-RTS-TRANSFER 36 RTS … Message Transfer; Assoc.
PAGE 407
Tokens in All Event Messages Event Messages Table 6-1. OSI/MHS Event Messages (page 3 of 3) Symbolic Name (ZMHS-EVT-) Event Number Message Text INVALID-PASSWORD 19 Invalid password attempt from … IO-ERR 12 File system error … from procedure …, file … MR-GRP-CHANGE 49 Group … was using … MR groups; now using … MR groups or Group … has had MR groups dynamically reallocated.
PAGE 408
Event-Message Descriptions Event Messages Table 6-2.
PAGE 409
Event Messages Event-Message Descriptions The ZEMS-TKN-SUBJECT-MARK token always immediately precedes the subject token of an event message. For more information on the subject token, refer to the EMS Manual. The notation used for simple tokens is a shorthand version of the essential information given in the DDL TOKEN-CODE statement. The syntax box also contains the text version of the event message, as provided by the EMSTEXT procedure and displayed on the operator console.
PAGE 410
1: ZMHS-EVT-INTL-ERR Event Messages 1: ZMHS-EVT-INTL-ERR The OSI/MHS subsystem detected an unrecoverable internal error. The affected OSI/MHS process terminates abnormally. This is a critical event.
PAGE 411
1: ZMHS-EVT-INTL-ERR Event Messages For more information about the GPI refer to the OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide or OSI/MHS Gateway Programmatic Interface (GPI) Reference Manual. ZMHS-TKN-LINE is the line number in the OSI/MHS software on which the error occurred. ZMHS-TKN-UNIQUE-ID identifies the error within a module in OSI/MHS. ZMHS-TKN-ORIG-PDUID is the PDU ID of a PDU received by OSI/MHS from an external source.
PAGE 412
1: ZMHS-EVT-INTL-ERR Event Messages Considerations Any OSI/MHS process can generate this event message. This event message is reported to the primary collector. If there is a trap in the process, this event will not be sent; instead a text message is written to the output file of the MHS manager.
PAGE 413
2: ZMHS-EVT-INTL-WARN Event Messages 2: ZMHS-EVT-INTL-WARN The OSI/MHS subsystem detected an internal warning. The affected OSI/MHS process continues to run. For the GIP values check each error code for information about the state of the process. This is not a critical event.
PAGE 414
2: ZMHS-EVT-INTL-WARN Event Messages ZMHS-TKN-UNIQUE-ID identifies the error within a module in OSI/MHS. ZMHS-TKN-SUBCODE is the error subcode. It is an optional token. Up to four subcodes can be specified and displayed. The additional subcodes appear in positions <8>, <9>, and <10>. ZMHS-TKN-XFNAME is an optional token representing the name of a file involved in the error. The maximum length is 256 bytes.
PAGE 415
2: ZMHS-EVT-INTL-WARN Event Messages Table 6-3. GPI Errors Assigned by GIP (page 1 of 3) ZGPI-VAL- Value Meaning BUFFER-INIT-ERROR 7100 The GIP cannot initialize its memory-bufferhandling system. Two error subcodes are returned. The GIP terminates abnormally. MHSMGR-INIT-ERROR 7101 The GIP cannot initialize its interprocess communication (IPC) interface with the MHS manager. Four error subcodes are returned. The GIP terminates abnormally.
PAGE 416
2: ZMHS-EVT-INTL-WARN Event Messages Table 6-3. GPI Errors Assigned by GIP (page 2 of 3) ZGPI-VAL- Value Meaning TRYING-NEW-CONNECT 7111 The GIP must switch to another MRP group because the current attempt to connect to an MRP group has failed. No error subcodes are returned. The GIP continues processing. TRYING-NEW-MRP-SEND 7112 The GIP must switch to another MRP group because the current attempt to send a communication to an MRP group has failed. No error subcodes are returned.
PAGE 417
2: ZMHS-EVT-INTL-WARN Event Messages Table 6-3. GPI Errors Assigned by GIP (page 3 of 3) ZGPI-VAL- Value Meaning UNKNOWN-PDU 7121 The PDU identifier is null, or the PDU cannot be found in the PDU store. This event is generated during GPI_MT_START_TRANSFER_IN_. The PDU is archived and the PDUID is reported in the event. No error subcodes are returned. The GIP continues processing. INVALID-GW-PDU 7122 The PDU is known, but it has not been delivered to a gateway.
PAGE 418
3: ZMHS-EVT-PROC-START-FAIL Event Messages 3: ZMHS-EVT-PROC-START-FAIL MHS was unable to start a process in either the process’s primary or backup CPU, and the attempt to start the process has been abandoned. This is a critical event. Additional Unconditional Tokens ZSPI-TKN-ERRLIST ZGRD-TKN-OBJECTFILE ZSPI-TKN-ERROR.Z-ERROR ZSPI-TKN-ERROR.Z-SSID ZCMK-TKN-PROC-ORD ZSPI-TKN-ENDLIST ZMHS-TKN-GROUP-NAME ZMHS-TKN-CPU ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT token-type ZSPI-TYP-LIST.
PAGE 419
3: ZMHS-EVT-PROC-START-FAIL Event Messages If a call to the PROCESS_CREATE_ procedure fails, bits 0 through 7 contain the primary error code and bits 8 through 15 contain the secondary error code. These codes are described in the Guardian Procedure Calls Reference Manual. Note that these codes describe the second attempt to start the process, that is, the attempt to start the process in its configured backup CPU.
PAGE 420
4: ZMHS-EVT-UNROUTE Event Messages 4: ZMHS-EVT-UNROUTE The OSI/MHS MTA is unable to transfer a message to an adjacent MTA, local user, or gateway. This is not a critical event.
PAGE 421
4: ZMHS-EVT-UNROUTE Event Messages Conditional Tokens ZMHS-TKN-MID-PRMD token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-COUNTRY token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-ADMD token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-LOCALID token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-PRMD token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-COUNTRY <3> token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-ADMD <4> token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-NETWORK token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-TERM-ID token-type ZSPI-TYP-STRING.
PAGE 422
4: ZMHS-EVT-UNROUTE Event Messages Event-Message Text PDU ID <1> unroutable for reason <2> Recipient: c=<3> /a=<4> /p=<5> /o=<6> /pn=<7>.<8> Token Descriptions ZMHS-TKN-PDUID is the PDU store identifier for the message involved in this event. ZMHS-TKN-MSG-TYPE is the type of X.400 message.
PAGE 423
4: ZMHS-EVT-UNROUTE Event Messages ZMHS-TKN-MID-COUNTRY is the country name component of an MTS-wide unique message identifier; maximum length is 3 bytes. ZMHS-TKN-MID-ADMD is the ADMD name component of an MTS-wide unique message identifier; maximum length is 16 bytes. ZMHS-TKN-MID-LOCALID is the local identifier component of an MTS-wide unique message identifier; maximum length is 32 bytes.
PAGE 424
4: ZMHS-EVT-UNROUTE Event Messages ZMHS-TKN-SUB-MID-COUNTRY is the country name component of an MTS-wide unique message identifier of the subject reported in a report MPDU. The maximum length is 3 bytes. ZMHS-TKN-SUB-MID-ADMD is the ADMD name component of an MTS-wide unique message identifier of the subject reported in a report MPDU. The maximum length is 16 bytes.
PAGE 425
4: ZMHS-EVT-UNROUTE Event Messages ZMHS-TKN-OR-NUM-UID is the numeric user ID component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 32 bytes. ZMHS-TKN-OR-COMMON-NAME is the common name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes. ZMHS-TKN-OR-TERM-TYPE is the terminal type component of an O/R name.
PAGE 426
4: ZMHS-EVT-UNROUTE Event Messages ZMHS-TKN-OR-DD-TYPE-1...4 is the domain-defined attribute type component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 8 bytes. ZMHS-TKN-OR-DD-VALUE-1...4 is the domain-defined attribute value component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 128 bytes.
PAGE 427
4: ZMHS-EVT-UNROUTE Event Messages ZMHS-TKN-OR-TLTX-DD-TYPE-1...4 is the teletex domain-defined attribute type component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 8 bytes. ZMHS-TKN-PRIORITY is the priority of a user message. This token is optional and can only be present if ZMHS-TKN-MSG-TYPE has the value ZMHS-VAL-MSG-TYPE-UMPDU.
PAGE 428
4: ZMHS-EVT-UNROUTE Event Messages If necessary, add or alter routes to allow transfer of subsequent messages and responses. Considerations This event message is reported to the primary collector. A report is considered to be unrouteable to an adjacent MTA only after all routes and links have been retried. The tokens ZMHS-TKN-SUB-MID-xxx are the message identifiers of the original message or probe to which the report refers.
PAGE 429
5: ZMHS-EVT-UNROUTE-RECIP Event Messages 5: ZMHS-EVT-UNROUTE-RECIP This event provides recipient information for MHS MTA unrouteable messages. A sequence of these events is generated for each ZMHS-EVT-UNROUTE event. A single ZMHS-EVT-UNROUTE-RECIP event is generated for each recipient associated with an unrouteable message transfer. This is not a critical event.
PAGE 430
5: ZMHS-EVT-UNROUTE-RECIP Event Messages Conditional Tokens ZMHS-TKN-MID-PRMD token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-COUNTRY token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-ADMD token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-LOCALID token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-PRMD token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-COUNTRY <2> token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-ADMD <3> token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-NETWORK token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-TERM-ID token-type ZSPI-TYP-STRING.
PAGE 431
5: ZMHS-EVT-UNROUTE-RECIP Event Messages ZMHS-TKN-OR-TLTX-DD-TYPE-4 ZMHS-TKN-OR-TLTX-DD-VALUE-1 ZMHS-TKN-OR-TLTX-DD-VALUE-2 ZMHS-TKN-OR-TLTX-DD-VALUE-3 ZMHS-TKN-OR-TLTX-DD-VALUE-4 ZMHS-TKN-PER-RECIP-FLAG ZMHS-TKN-EXPLICIT-CONV ZMHS-TKN-DELIVER-RESULT ZMHS-TKN-NON-DELIV-REASON ZMHS-TKN-NON-DELIV-DIAG ZMHS-TKN-END-FLAG token-type ZSPI-TYP-BYTESTRING. token-type ZSPI-TYP-BYTESTRING. token-type ZSPI-TYP-BYTESTRING. token-type ZSPI-TYP-BYTESTRING. token-type ZSPI-TYP-BYTESTRING. token-type ZSPI-TYP-INT.
PAGE 432
5: ZMHS-EVT-UNROUTE-RECIP Event Messages ZMHS-VAL-TRANS-CLASS- Value Meaning RELAYED 2 The UMPDU, probe, or report originating from a remote MTA was relayed to another remote MTA. GENERATED 3 The report was generated by a local MTA and transferred to a remote MTA. UNROUTE 4 The UMPDU, probe, or report cannot be routed. ZMHS-TKN-RECIP-INDEX is a sequence number supplied in each recipient-information EMS buffer in a sequence. The buffers are numbered sequentially starting with 1.
PAGE 433
5: ZMHS-EVT-UNROUTE-RECIP Event Messages ZMHS-TKN-SUB-MID-ADMD is the ADMD name component of an MTS-wide unique message identifier of the subject reported in a report MPDU. The maximum length is 16 bytes. ZMHS-TKN-SUB-MID-LOCALID is the local identifier component of an MTS-wide unique message identifier of the subject reported in a report MPDU. The maximum length is 32 bytes.
PAGE 434
5: ZMHS-EVT-UNROUTE-RECIP Event Messages ZMHS-TKN-OR-COMMON-NAME is the common name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes. ZMHS-TKN-OR-TERM-TYPE is the terminal type component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name.
PAGE 435
5: ZMHS-EVT-UNROUTE-RECIP Event Messages ZMHS-TKN-OR-DD-VALUE-1...4 is the domain-defined attribute value component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 128 bytes. ZMHS-TKN-OR-TLTX-ORGANIZ is the teletex organization name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes.
PAGE 436
5: ZMHS-EVT-UNROUTE-RECIP Event Messages ZMHS-TKN-PER-RECIP-FLAG contains a set of per-recipient bit flags whose meaning is defined below: Bits Value Meaning 0 0 1 This MTA is not responsible for the message. This MTA is responsible for the message. 1 and 2 0,0 1,0 0,1 1,1 This combination should not occur. MTA report requested. MTA nondelivery report requested. Audited report requested. 3 and 4 0,0 1,0 0,1 1,1 No report. Report requested. Nondelivery report requested.
PAGE 437
5: ZMHS-EVT-UNROUTE-RECIP Event Messages ZMHS-TKN-END-FLAG is the final EMS buffer in a sequence of buffers relating to a single accounting or unrouteable message event. This token always has the value ZSPI-VAL-TRUE, indicating the final buffer in the sequence. This token is only present in the last of the events associated with a particular ZMHS-EVT-ACCT-MSG event. Cause. OSI/MHS could not determine how to route a message to a particular recipient.
PAGE 438
6: ZMHS-EVT-BAD-PROT-ELEM Event Messages 6: ZMHS-EVT-BAD-PROT-ELEM The OSI/MHS subsystem detected a bad protocol element in a PDU ID. This is not a critical event. Additional Unconditional Tokens ZMHS-TKN-PDUID ZMHS-TKN-KIND ZMHS-TKN-INVPDU-REASON ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type token-type <2> token-type token-type token-type ZSPI-TYP-INT4. ZSPI-TYP-INT. ZSPI-TYP-ENUM. ZSPI-TYP-BOOLEAN. ZSPI-TYP-BOOLEAN.
PAGE 439
6: ZMHS-EVT-BAD-PROT-ELEM Event Messages error can be caused by corrupted data in the PDU store or by receipt of an invalid byte stream. Recovery. Check and correct the message. Considerations The decoding procedures used can generate this event message. This event message is reported to the primary collector.
PAGE 440
7: ZMHS-EVT-ACCT-MSG Event Messages 7: ZMHS-EVT-ACCT-MSG This event contains OSI/MHS message transfer accounting information. This is not a critical event. Additional Unconditional Tokens ZMHS-TKN-MSG-TYPE ZMHS-TKN-TRANS-CLASS ZMHS-TKN-MSG-SIZE ZMHS-TKN-MID-COUNTRY ZMHS-TKN-MID-ADMD ZMHS-TKN-MID-LOCALID ZMHS-TKN-NUM-RECIPIENTS ZMHS-TKN-PDUID ZMHS-TKN-ORIG-PDUID ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-ENUM. <2> token-type ZSPI-TYP-ENUM. <3> token-type ZSPI-TYP-INT2.
PAGE 441
7: ZMHS-EVT-ACCT-MSG Event Messages Conditional Tokens ZMHS-TKN-MID-PRMD token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-COUNTRY token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-ADMD token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-PRMD token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-LOCALID token-type ZSPI-TYP-STRING. ZMHS-TKN-MSG-CONTENT-SZ token-type ZSPI-TYP-INT2. ZMHS-TKN-OR-COUNTRY <5> token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-ADMD <6> token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-NETWORK token-type ZSPI-TYP-STRING.
PAGE 442
7: ZMHS-EVT-ACCT-MSG Event Messages ZMHS-TKN-OR-TLTX-DD-VALUE-3 ZMHS-TKN-OR-TLTX-DD-VALUE-4 ZMHS-TKN-PRIORITY ZMHS-TKN-PER-MSG-FLAGS ZMHS-TKN-END-FLAG token-type token-type token-type token-type token-type ZSPI-TYP-BYTESTRING. ZSPI-TYP-BYTESTRING. ZSPI-TYP-INT. ZSPI-TYP-INT. ZSPI-TYP-BOOLEAN. Event-Message Text For Messages: Message <2>; Msg Orig.: c=<5> /a=<6> /p=<7> /o=<8> /pn=<9>.<10>/, Size: <3> MPDUid: <4> For Probes: Probe <2>; Probe Orig.: c=<5> /a=<6> /p=<7> /o=<8> /pn=<9>.
PAGE 443
7: ZMHS-EVT-ACCT-MSG Event Messages ZMHS-VAL-TRANS-CLASS- Value Meaning GENERATED 3 The report was generated by a local MTA and transferred to a remote MTA. UNROUTE 4 The UMPDU, probe, or report cannot be routed. DL EXPANSION 5 The UMPDU was submitted as a result of a Distribution List Expansion. ZMHS-TKN-MSG-SIZE is the total number of bytes in an UMPDU, probe, or report (that is, envelope and content for an UMPDU or a report, and envelope only for a probe).
PAGE 444
7: ZMHS-EVT-ACCT-MSG Event Messages ZMHS-TKN-MID-PRMD is the PRMD name component of an MTS-wide unique message identifier; maximum length is 16 bytes. ZMHS-TKN-SUB-MID-COUNTRY is the country name component of an MTS-wide unique message identifier of the subject reported in a report MPDU. The maximum length is 3 bytes. ZMHS-TKN-SUB-MID-ADMD is the ADMD name component of an MTS-wide unique message identifier of the subject reported in a report MPDU. The maximum length is 16 bytes.
PAGE 445
7: ZMHS-EVT-ACCT-MSG Event Messages ZMHS-TKN-OR-ORGANIZ is the organization name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes. ZMHS-TKN-OR-NUM-UID is the numeric user ID component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 32 bytes. ZMHS-TKN-OR-COMMON-NAME is the common name component of an O/R name.
PAGE 446
7: ZMHS-EVT-ACCT-MSG Event Messages ZMHS-TKN-OR-ORG-UNIT-1...4 is the organizational unit name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 32 bytes. ZMHS-TKN-OR-DD-TYPE-1...4 is the domain-defined attribute type component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 8 bytes. ZMHS-TKN-OR-DD-VALUE-1...
PAGE 447
7: ZMHS-EVT-ACCT-MSG Event Messages ZMHS-TKN-OR-TLTX-ORG-UNIT-1...4 is the teletex organizational unit name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 32 bytes. ZMHS-TKN-OR-TLTX-DD-TYPE-1...4 is the teletex domain-defined attribute type component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 8 bytes.
PAGE 448
7: ZMHS-EVT-ACCT-MSG Event Messages Considerations OSI/MHS MRP processes can generate this event message. This event message is reported to the alternate collector. The tokens ZMHS-TKN-SUB-MID-xxx are only present in report MPDUs and give the message identifier of the original message or probe to which the report refers. In case of a user message (UMPDU) or probe, the ZMHS-TKN-OR-xxx tokens in this event specify the O/R name of the originator of the UMPDU or probe.
PAGE 449
8: ZMHS-EVT-ACCT-RECIP-INFO Event Messages 8: ZMHS-EVT-ACCT-RECIP-INFO This event contains MHS message transfer recipient information. A sequence of these events is generated for each preceding ZMHS-EVT-ACCT-MSG event. A single ZMHS-EVT-ACCT-RECIP-INFO event is generated for each recipient associated with the message transfer. This is not a critical event.
PAGE 450
8: ZMHS-EVT-ACCT-RECIP-INFO Event Messages Conditional Tokens ZMHS-TKN-MID-PRMD token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-COUNTRY token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-ADMD token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-PRMD token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-LOCALID <4> token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-COUNTRY token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-ADMD token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-NETWORK token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-TERM-ID token-type ZSPI-TYP-STRING.
PAGE 451
8: ZMHS-EVT-ACCT-RECIP-INFO Event Messages ZMHS-TKN-OR-TLTX-DD-TYPE-3 ZMHS-TKN-OR-TLTX-DD-TYPE-4 ZMHS-TKN-OR-TLTX-DD-VALUE-1 ZMHS-TKN-OR-TLTX-DD-VALUE-2 ZMHS-TKN-OR-TLTX-DD-VALUE-3 ZMHS-TKN-OR-TLTX-DD-VALUE-4 ZMHS-TKN-PER-RECIP-FLAG ZMHS-TKN-EXPLICIT-CONV ZMHS-TKN-DELIVER-RESULT ZMHS-TKN-NON-DELIV-REASON <5> ZMHS-TKN-NON-DELIV-DIAG <6> ZMHS-TKN-END-FLAG token-type token-type token-type token-type token-type token-type token-type token-type token-type token-type token-type token-type ZSPI-TYP-BYTESTRING.
PAGE 452
8: ZMHS-EVT-ACCT-RECIP-INFO Event Messages ZMHS-TKN-TRANS-CLASS is the class of message transfer that has occurred. The possible values are: ZMHS-VAL-TRANS-CLASS- Value Meaning SUB-TO-REM 0 The UMPDU or probe was submitted by a local MTS user and transferred to a remote MTA. DELIVERED 1 The UMPDU or report was delivered to a local MTS user, or a probe reached its destination (the local MTA). The UMPDU or report may have originated from a remote or a local MTS user.
PAGE 453
8: ZMHS-EVT-ACCT-RECIP-INFO Event Messages ZEMS-TKN-CONSOLE-PRINT has the value ZSPI-VAL-FALSE. ZMHS-TKN-MID-PRMD is the PRMD name component of an MTS-wide unique message identifier. The maximum length is 16 bytes. ZMHS-TKN-SUB-MID-COUNTRY is the country name component of an MTS-wide unique message identifier of the subject reported in a report MPDU. The maximum length is 3 bytes.
PAGE 454
8: ZMHS-EVT-ACCT-RECIP-INFO Event Messages ZMHS-TKN-OR-ORGANIZ is the organization name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes. ZMHS-TKN-OR-NUM-UID is the numeric user ID component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 32 bytes. ZMHS-TKN-OR-COMMON-NAME is the common name component of an O/R name.
PAGE 455
8: ZMHS-EVT-ACCT-RECIP-INFO Event Messages ZMHS-TKN-OR-ORG-UNIT-1...4 is the organizational unit name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 32 bytes. ZMHS-TKN-OR-DD-TYPE-1...4 is the domain-defined attribute type component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 8 bytes. ZMHS-TKN-OR-DD-VALUE-1...
PAGE 456
8: ZMHS-EVT-ACCT-RECIP-INFO Event Messages ZMHS-TKN-OR-TLTX-ORG-UNIT-1...4 is the teletex organizational unit name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 32 bytes. ZMHS-TKN-OR-TLTX-DD-TYPE-1...4 is the teletex domain-defined attribute type component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 8 bytes.
PAGE 457
8: ZMHS-EVT-ACCT-RECIP-INFO Event Messages ZMHS-TKN-NON-DELIV-REASON is only present for nondelivery reports. This token can have the values specified for NonDeliveryReasonCode in the X.411 standard. These values are also listed in Appendix D, Reason and Diagnostic Codes. ZMHS-TKN-NON-DELIV-DIAG is only present for nondelivery reports. This token can have the values specified for NonDeliveryDiagnosticCode in the X.411 standard. These values are also listed in Appendix D, Reason and Diagnostic Codes.
PAGE 458
9: ZMHS-EVT-ACCT-REG Event Messages 9: ZMHS-EVT-ACCT-REG This MHS accounting registration record indicates attempts to add or alter MTAs or APPLs using control and inquiry configuration requests. This is not a critical event. Additional Unconditional Tokens ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZCMK-TKN-CMD-CODE ZSPI-TKN-RETCODE ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> <2> <3> <4> token-type token-type token-type token-type token-type token-type ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TYP-LIST.
PAGE 459
9: ZMHS-EVT-ACCT-REG Event Messages Considerations The MHS manager can generate this event message. This event message is reported to the alternate collector. ZSPI-TKN-RETCODE is included so that both successful and unsuccessful attempts to add, alter, or delete APPL, CUG, CUGMEMBER, DLIST, DLISTMEMBER, and MTA objects are recorded.
PAGE 460
10: ZMHS-EVT-ACCT-STORE Event Messages 10: ZMHS-EVT-ACCT-STORE This event contains accounting information about message store (MS) storage and deletion. This is not a critical event.
PAGE 461
10: ZMHS-EVT-ACCT-STORE Event Messages Conditional Tokens ZMHS-TKN-MID-PRMD token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-COUNTRY token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-ADMD token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-PRMD token-type ZSPI-TYP-STRING. ZMHS-TKN-SUB-MID-LOCALID token-type ZSPI-TYP-STRING. ZMHS-TKN-MSG-CONTENT-SZ token-type ZSPI-TYP-INT2. ZMHS-TKN-OR-COUNTRY <4> token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-ADMD <5> token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-NETWORK token-type ZSPI-TYP-STRING.
PAGE 462
10: ZMHS-EVT-ACCT-STORE Event Messages Event-Message Text For Messages: <1> Message; MS User: c=<4> /a=<5> /p=<6> /o=<7> /pn=<8>.<9>/, Size: <2> MPDUid: <3> For Reports: <1> Report; MS User: c=<4> /a=<5> /p=<6> /o=<7> /pn=<8>.<9>/ Token Descriptions ZMHS-TKN-STORE-ACTION specifies whether the message is stored in or deleted from the MS store. This token can have the following values: ZMHS-VAL-STORE-ACTION- Value Meaning STORE 0 Message is stored in the MS store.
PAGE 463
10: ZMHS-EVT-ACCT-STORE Event Messages ZMHS-TKN-PDUID is the PDU store identifier for the message involved in this event. ZMHS-TKN-MSG-SEQ-NUMBER identifies the sequence number of messages that are stored or deleted. ZEMS-TKN-EMPHASIS has the value ZSPI-VAL-FALSE, indicating that this is not a critical event. ZEMS-TKN-CONSOLE-PRINT has the value ZSPI-VAL-FALSE. ZMHS-TKN-MID-PRMD is the PRMD name component of an MTS-wide unique message identifier. The maximum length is 16 bytes.
PAGE 464
10: ZMHS-EVT-ACCT-STORE Event Messages ZMHS-TKN-OR-ADMD is the ADMD name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes. ZMHS-TKN-OR-NETWORK is the network address or X.121 address name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 15 bytes. ZMHS-TKN-OR-TERM-ID is the terminal ID component of an O/R name.
PAGE 465
10: ZMHS-EVT-ACCT-STORE Event Messages ZMHS-TKN-OR-PNAME-SUR is the personal surname component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 40 bytes. ZMHS-TKN-OR-PNAME-GIVEN is the personal name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes. ZMHS-TKN-OR-PNAME-INIT is the personal initials component of an O/R name.
PAGE 466
10: ZMHS-EVT-ACCT-STORE Event Messages ZMHS-TKN-OR-TLTX-PNAME-SUR is the teletex personal surname component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 40 bytes. ZMHS-TKN-OR-TLTX-PNAME-GIVEN is the teletex personal given-name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes.
PAGE 467
11: ZMHS-EVT-ACCT-DEFER Event Messages 6 Event Messages 6 Event Messages 11: ZMHS-EVT-ACCT-DEFER This event contains deferred delivery accounting information. This is not a critical event.
PAGE 468
11: ZMHS-EVT-ACCT-DEFER Event Messages Conditional Tokens ZMHS-TKN-MID-PRMD ZMHS-TKN-OR-COUNTRY <4> ZMHS-TKN-OR-ADMD <5> ZMHS-TKN-OR-NETWORK ZMHS-TKN-OR-TERM-ID ZMHS-TKN-OR-PRMD <6> ZMHS-TKN-OR-ORGANIZ <7> ZMHS-TKN-OR-NUM-UID ZMHS-TKN-OR-COMMON-NAME ZMHS-TKN-OR-TERM-TYPE ZMHS-TKN-OR-PNAME-SUR <8> ZMHS-TKN-OR-PNAME-GIVEN <9> ZMHS-TKN-OR-PNAME-INIT ZMHS-TKN-OR-PNAME-GENQ ZMHS-TKN-OR-ORG-UNIT-1 ZMHS-TKN-OR-ORG-UNIT-2 ZMHS-TKN-OR-ORG-UNIT-3 ZMHS-TKN-OR-ORG-UNIT-4 ZMHS-TKN-OR-DD-TYPE-1 ZMHS-TKN-OR-DD-TYPE-2 ZM
PAGE 469
11: ZMHS-EVT-ACCT-DEFER Event Messages Token Descriptions ZMHS-TKN-DEFER-ACTION is the deferral action taken on the message. The possible values are: ZMHS-VAL-DEFER- Value Meaning ACTION-DEFER 0 Message is stored for deferred delivery. ACTION-CANCEL 1 Message is canceled while waiting for deferred delivery. ZMHS-TKN-DEFER-TIME specifies time in seconds.
PAGE 470
11: ZMHS-EVT-ACCT-DEFER Event Messages ZEMS-TKN-CONSOLE-PRINT has the value ZSPI-VAL-FALSE. ZMHS-TKN-MID-PRMD is the PRMD name component of an MTS-wide unique message identifier; maximum length is 16 bytes. ZMHS-TKN-OR-COUNTRY is the country name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 3 bytes. ZMHS-TKN-OR-ADMD is the ADMD name component of an O/R name.
PAGE 471
11: ZMHS-EVT-ACCT-DEFER Event Messages ZMHS-TKN-OR-TERM-TYPE is the terminal type component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The possible values are: ZMHS-VAL- Value Meaning TERMINAL-TX 1 Telex TERMINAL-TTX 2 Teletex TERMINAL-G3 3 G3-facsimile TERMINAL-G4 4 G4-facsimile TERMINAL-IA5 5 IA5-terminal TERMINAL-VTX 6 Videotex ZMHS-TKN-OR-PNAME-SUR is the personal surname component of an O/R name.
PAGE 472
11: ZMHS-EVT-ACCT-DEFER Event Messages ZMHS-TKN-OR-TLTX-ORGANIZ is the teletex organization name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes. ZMHS-TKN-OR-TLTX-COMMON-NAME is the teletex common name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes.
PAGE 473
11: ZMHS-EVT-ACCT-DEFER Event Messages Considerations OSI/MHS MRP processes can generate this event message. This event message is reported to the alternate collector. The ZMHS-TKN-OR-xxx tokens in this event specify the O/R name of the originator of the UMPDU that is being stored in the MTA deferral queue.
PAGE 474
12: ZMHS-EVT-IO-ERR Event Messages 12: ZMHS-EVT-IO-ERR The OSI/MHS subsystem returned a file system error from a file I/O operation. This is not a critical event. Additional Unconditional Tokens ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR.Z-ERROR ZSPI-TKN-ERROR.Z-SSID ZFIL-TKN-FILE-NAME ZSPI-TKN-PROC-ERR ZSPI-TKN-ENDLIST ZMHS-TKN-XFNAME ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT token-type <1> token-type token-type token-type <2> token-type token-type <3> token-type token-type token-type ZSPI-TYP-LIST.
PAGE 475
13: ZMHS-EVT-BAD-OPNR Event Messages 13: ZMHS-EVT-BAD-OPNR An attempt to open this subsystem was rejected. This is not a critical event. Additional Unconditional Tokens ZMHS-TKN-XPNAME ZMHS-TKN-XFNAME ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-STRING. <2> token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-BOOLEAN. token-type ZSPI-TYP-BOOLEAN.
PAGE 476
14: ZMHS-EVT-SPI-BAD-OCCURS Event Messages 14: ZMHS-EVT-SPI-BAD-OCCURS An SPI message was received with a byte count that cannot occur in a well-formed request message. This is not a critical event. Additional Unconditional Tokens ZMHS-TKN-XPNAME ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-BOOLEAN. token-type ZSPI-TYP-BOOLEAN.
PAGE 477
15: ZMHS-EVT-SPI-SHORT Event Messages 15: ZMHS-EVT-SPI-SHORT A received control and inquiry message was too short. This is not a critical event. Additional Unconditional Tokens ZMHS-TKN-XPNAME ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-BOOLEAN. token-type ZSPI-TYP-BOOLEAN. Event-Message Text SPI request from <1> bad: Message short Token Descriptions ZMHS-TKN-XPNAME is the name of the process involved in the event; maximum length is 128 bytes.
PAGE 478
16: ZMHS-EVT-SPI-SSCALL Event Messages 16: ZMHS-EVT-SPI-SSCALL The process sensed an error in a control and inquiry request buffer. This is not a critical event. Additional Unconditional Tokens ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR.Z-ERROR ZSPI-TKN-ERROR.Z-SSID ZSPI-TKN-PROC-ERR ZSPI-TKN-ENDLIST ZMHS-TKN-XPNAME ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT token-type <1> token-type token-type <2> token-type token-type <3> token-type token-type token-type ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-ERROR.
PAGE 479
16: ZMHS-EVT-SPI-SSCALL Event Messages If your local operating procedures require contacting the Compaq NonStop Support Center (TNSC), supply your system number and the numbers and versions of all related products as well. Considerations Any OSI/MHS process except the MHS manager can generate this event message. Usually, the message is caused by an error from a non-OSI/MHS process. It can also be caused by an OSI/MHS process in the event of an internal error.
PAGE 480
17: ZMHS-EVT-GROUP-TOO-MANY-FAILS Event Messages 17: ZMHS-EVT-GROUP-TOO-MANY-FAILS This event occurs when the MHS manager unsuccessfully attempts to restart a failed group. This is a critical event. Additional Unconditional Tokens ZMHS-TKN-GROUP-NAME ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-BOOLEAN. token-type ZSPI-TYP-BOOLEAN.
PAGE 481
18: ZMHS-EVT-PROC-FAIL Event Messages 18: ZMHS-EVT-PROC-FAIL An MHS process other than the MHS manager failed. This is not a critical event. Additional Unconditional Tokens ZMHS-TKN-XPNAME ZMHS-TKN-GROUP-NAME ZMHS-TKN-FAIL-REASON ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-STRING. <2> token-type ZSPI-TYP-STRING. <3> token-type ZSPI-TYP-ENUM. token-type ZSPI-TYP-BOOLEAN. token-type ZSPI-TYP-BOOLEAN.
PAGE 482
19: ZMHS-EVT-INVALID-PASSWORD Event Messages 19: ZMHS-EVT-INVALID-PASSWORD An invalid password was received in a bind attempt from an OSI/MHS MTA or APPL object. This is not a critical event. Additional Unconditional Tokens ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-STRING. <2> token-type ZSPI-TYP-ENUM. token-type ZSPI-TYP-BOOLEAN. token-type ZSPI-TYP-BOOLEAN.
PAGE 483
20: ZMHS-EVT-MS-DIAGNOSTIC Event Messages 20: ZMHS-EVT-MS-DIAGNOSTIC The MS could not process the message specified by the ZMHS-TKN-MS-DIAG token. This is not a critical event. Additional Unconditional Tokens ZMHS-TKN-PDUID ZMHS-TKN-MS-DIAG ZCOM-TKN-OBJNAME ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-INT4. <2> token-type ZSPI-TYP-ENUM. <3> token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-BOOLEAN. token-type ZSPI-TYP-BOOLEAN.
PAGE 484
20: ZMHS-EVT-MS-DIAGNOSTIC Event Messages ZEMS-TKN-CONSOLE-PRINT has the value ZSPI-VAL-TRUE. Cause. The diagnostic reason indicates the cause of this event. The cause of each event is explained in the preceding descriptions of the error-code tokens. Recovery. Inspect the X.400 message. If the MS is full, then the message store SQL table size should be extended. Otherwise, make corrections depending on the reason displayed. Considerations OSI/MHS MS GROUP processes can generate this event message.
PAGE 485
21: ZMHS-EVT-NO-MEM Event Messages 21: ZMHS-EVT-NO-MEM An unsuccessful attempt was made to allocate memory within a process. This is a critical event. Additional Unconditional Tokens ZMHS-TKN-XFNAME ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-BOOLEAN. token-type ZSPI-TYP-BOOLEAN. Event-Message Text Insufficient memory space from swap file <1> Token Descriptions ZMHS-TKN-XFNAME is the name of the file involved in the error; maximum length is 256 bytes.
PAGE 486
22: ZMHS-EVT-BAD-OSI-CONFIG Event Messages 22: ZMHS-EVT-BAD-OSI-CONFIG A problem exists with the configuration of OSI/MHS and the OSI services. This is not a critical event.
PAGE 487
22: ZMHS-EVT-BAD-OSI-CONFIG Event Messages Event-Message Text OSI configuration problem with device <4> on call <3> returned with <1>, <2> Local: NSAP=<5> TSEL=<6> SSEL=<7> PSEL=<8> Remote: NSAP=<9> TSEL=<10> SSEL=<11> PSEL=<12> The first detected error was with device <13> returned with <14>, <15> or OSI configuration problem with device <4> over Local: NSAP=<5> TSEL=<6> SSEL=<7> PSEL=<8> Remote: NSAP=<9> TSEL=<10> SSEL=<11> PSEL=<12> Token Descriptions ZMHS-TKN-ACT-REQ is the type of action required.
PAGE 488
22: ZMHS-EVT-BAD-OSI-CONFIG Event Messages ZMHS-TKN-API-SUBCODE is the OSI/AS application programmatic interface error subcode.
PAGE 489
22: ZMHS-EVT-BAD-OSI-CONFIG Event Messages ZMHS-TKN-REM-OSI-DATA has the value ZSPI-VAL-TRUE if the remote OSI address tokens are present, ZSPI-VAL-FALSE if the remote OSI address is not present. ZMHS-TKN-LOC-NSAP is the local OSI NSAP; maximum length is 40 characters. ZMHS-TKN-LOC-TSEL is the local OSI TSEL; maximum length is 64 characters. ZMHS-TKN-LOC-SSEL is the local OSI SSEL; maximum length is 32 characters. ZMHS-TKN-LOC-PSEL is the local OSI PSEL; maximum length is 32 characters.
PAGE 490
22: ZMHS-EVT-BAD-OSI-CONFIG Event Messages ZMHS-TKN-FIRST-SUBCODE further describes ZMHS-TKN-FIRST-ERROR. It is only present if the token ZMHS-TKN-ERROR-DATA has the value ZSPI-VAL-TRUE. Cause. The first form of this message indicates a problem in the interaction between the OSI/MHS and the OSI/AS. A configuration problem has blocked the OSI/MHS from using the specified device. The OSI/MHS might continue to attempt to use the device until the configuration is corrected.
PAGE 491
23: ZMHS-EVT-BAD-OSI-RESOURCE Event Messages 23: ZMHS-EVT-BAD-OSI-RESOURCE A problem exists with the way OSI/MHS uses of the resources of the OSI services. This is not a critical event.
PAGE 492
23: ZMHS-EVT-BAD-OSI-RESOURCE Event Messages Event-Message Text OSI resource problem with device <4> on call <3> returned with <1>, <2> Local: NSAP=<5> TSEL=<6> SSEL=<7> PSEL=<8> Remote: NSAP=<9> TSEL=<10> SSEL=<11> PSEL=<12> The first detected error was with device <13> returned with <14>, <15> File system error <16> on the <17> connection.
PAGE 493
23: ZMHS-EVT-BAD-OSI-RESOURCE Event Messages ZMHS-TKN-API-CALL is the OSI/AS procedure call used; maximum length is 24 bytes. ZMHS-TKN-API-FILENAME is the name of the OSI/AS TAPS device used. It has the same format as ZAPS-DDL-FILENAME. ZEMS-TKN-ACTION-NEEDED is set to TRUE except when retries are done on the local OSI address for the process. In this case the token is set to TRUE when the condition starts and set to FALSE when the condition ends.
PAGE 494
23: ZMHS-EVT-BAD-OSI-RESOURCE Event Messages ZMHS-TKN-REM-TSEL is the remote OSI TSEL; maximum length is 64 characters. ZMHS-TKN-REM-SSEL is the remote OSI SSEL; maximum length is 32 characters. ZMHS-TKN-REM-PSEL is the remote OSI PSEL; maximum length is 32 characters. ZMHS-TKN-ERROR-DATA has the value ZSPI-VAL-TRUE if the first error information is present, ZSPI-VALFALSE if the first error info is not present.
PAGE 495
23: ZMHS-EVT-BAD-OSI-RESOURCE Event Messages ZMHS-TKN-X25-DATA has the value ZSPI-VAL-TRUE if the X25 error information is present, ZSPI-VALFALSE if the X25 error information is not present. It is only true if the lower comm level is provided by X25AM. ZMHS-TKN-X25-DISC-REASON1 ... 4 are only present if ZMHS-TKN-X25-DATA has a value of ZSPI-VAL-TRUE. They are the reasons for the circuit disconnection as returned by APS_STATUS in the structure ZAPS-DDL-LL-BUFFER.
PAGE 496
24: ZMHS-EVT-FTL-OSI-CONFIG Event Messages 24: ZMHS-EVT-FTL-OSI-CONFIG A problem exists with the configuration of OSI/MHS and the OSI services at start up of an OSI/MHS GROUP. This is a critical event.
PAGE 497
24: ZMHS-EVT-FTL-OSI-CONFIG Event Messages ZMHS-TKN-API-SUBCODE is the OSI/AS application programmatic interface error subcode. ZMHS-TKN-API-CALL is the OSI/AS procedure call used; maximum length is 24 bytes. ZMHS-TKN-API-FILENAME is the name of the OSI/AS TAPS device used. It has the same format as ZAPS-DDL-FILENAME. ZEMS-TKN-EMPHASIS has the value ZSPI-VAL-TRUE, indicating that this is a critical event. ZEMS-TKN-CONSOLE-PRINT has the value ZSPI-VAL-TRUE.
PAGE 498
24: ZMHS-EVT-FTL-OSI-CONFIG Event Messages ZMHS-TKN-REM-SSEL is the remote OSI SSEL; maximum length is 32 characters. ZMHS-TKN-REM-PSEL is the remote OSI PSEL; maximum length is 32 characters. ZMHS-TKN-ERROR-DATA has the value ZSPI-VAL-TRUE if the first error information is present, ZSPI-VALFALSE if the first error info is not present. ZMHS-TKN-FIRST-DEVICE is the fully qualified device name on which the first error in the current error situation occurred.
PAGE 499
24: ZMHS-EVT-FTL-OSI-CONFIG Event Messages Considerations OSI/MHS RTS or ROS processes can issue this event message. This event message is reported to the primary collector.
PAGE 500
25: ZMHS-EVT-FTL-OSI-RESOURCE Event Messages 25: ZMHS-EVT-FTL-OSI-RESOURCE A problem exists with the way OSI/MHS uses the resources of the OSI services at start up of an OSI/MHS GROUP. This is a critical event.
PAGE 501
25: ZMHS-EVT-FTL-OSI-RESOURCE Event Messages Event-Message Text FATAL OSI resource problem with device <4> on call <3> returned with <1>, <2> Local: NSAP=<5> TSEL=<6> SSEL=<7> PSEL=<8> Remote: NSAP=<9> TSEL=<10> SSEL=<11> PSEL=<12> The first detected error was with device <13> returned with <14>, <15> File system error <16> on the <17> connection. X25 Disc Reason =<18>, <19>, <20>, <21> Clear cause =<22> diagnostic code =<23>.
PAGE 502
25: ZMHS-EVT-FTL-OSI-RESOURCE Event Messages ZMHS-TKN-REM-OSI-DATA has the value ZSPI-VAL-TRUE if the remote OSI address tokens are present, ZSPI-VAL-FALSE if the remote OSI address is not present. ZMHS-TKN-LOC-NSAP is the local OSI NSAP; maximum length is 40 characters. ZMHS-TKN-LOC-TSEL is the local OSI TSEL; maximum length is 64 characters. ZMHS-TKN-LOC-SSEL is the local OSI SSEL; maximum length is 32 characters. ZMHS-TKN-LOC-PSEL is the local OSI PSEL; maximum length is 32 characters.
PAGE 503
25: ZMHS-EVT-FTL-OSI-RESOURCE Event Messages ZMHS-TKN-FIRST-SUBCODE further describes ZMHS-TKN-FIRST-ERROR. It is only present if the token ZMHS-TKN-ERROR-DATA has the value ZSPI-VAL-TRUE. ZMHS-TKN-DEVICE-DATA has the value ZSPI-VAL-TRUE if the device information is present, ZSPI-VALFALSE if the device info is not present. ZMHS-TKN-FSYS-ERROR is only present if the token ZMHS-TKN-DEVICE-DATA has a value of ZSPI-VALTRUE.
PAGE 504
25: ZMHS-EVT-FTL-OSI-RESOURCE Event Messages Considerations OSI/MHS RTS or ROS processes can generate this event message. This event message is reported to the primary collector.
PAGE 505
26: ZMHS-EVT-BAD-MSG Event Messages 26: ZMHS-EVT-BAD-MSG An unexpected message was received by an OSI/MHS process. This is not a critical event. Additional Unconditional Tokens ZMHS-TKN-XPNAME ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-BOOLEAN. token-type ZSPI-TYP-BOOLEAN. Event-Message Text Unexpected message from <1> Token Descriptions ZMHS-TKN-XPNAME is the name of the process involved in the event; maximum length is 128 bytes.
PAGE 506
27: ZMHS-EVT-SQL-ERR Event Messages 27: ZMHS-EVT-SQL-ERR An unexpected error was returned from an operation on the process’s SQL database. The affected OSI/MHS process terminates abnormally. This is a critical event. Additional Unconditional Tokens ZMHS-TKN-SQL-ERROR ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-INT. token-type ZSPI-TYP-BOOLEAN. token-type ZSPI-TYP-BOOLEAN.
PAGE 507
28: ZMHS-EVT-BAD-ALT-COLL Event Messages 28: ZMHS-EVT-BAD-ALT-COLL The alternate collector was unavailable to receive accounting events. This is not a critical event. Additional Unconditional Tokens ZMHS-TKN-ACT-REQ ZMHS-TKN-XPNAME ZEMS-TKN-ACTION-NEEDED ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT token-type <1> token-type token-type token-type token-type ZSPI-TYP-ENUM. ZSPI-TYP-STRING. ZSPI-TYP-BOOLEAN. ZSPI-TYP-BOOLEAN. ZSPI-TYP-BOOLEAN. Event-Message Text Alternate collector <1> unavailable.
PAGE 508
28: ZMHS-EVT-BAD-ALT-COLL Event Messages Recovery. Ensure that the alternate collector is running. Considerations Any OSI/MHS process can generate this event message. This event message is reported to the primary collector.
PAGE 509
29: ZMHS-EVT-FTL-IO-ERR Event Messages 29: ZMHS-EVT-FTL-IO-ERR A file system error code was returned from an I/O operation on the specified file. The affected OSI/MHS process terminates abnormally. This is a critical event. Additional Unconditional Tokens ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR.Z-ERROR ZSPI-TKN-ERROR.
PAGE 510
30: ZMHS-EVT-CUG-VIOL Event Messages 30: ZMHS-EVT-CUG-VIOL This event is generated when the OSI/MHS MTA detects a closed user group (CUG) violation. A violation can happens under the following circumstances: • • • No CUG object exists. The originator is not in any CUG object. A CUG object exists but the restrictions defined for the CUG object exclude the current message or probe.
PAGE 511
30: ZMHS-EVT-CUG-VIOL Event Messages Conditional Tokens ZMHS-TKN-MID-PRMD ZMHS-TKN-OR-COUNTRY ZMHS-TKN-OR-ADMD ZMHS-TKN-OR-NETWORK ZMHS-TKN-OR-TERM-ID ZMHS-TKN-OR-PRMD ZMHS-TKN-OR-ORGANIZ ZMHS-TKN-OR-NUM-UID ZMHS-TKN-OR-COMMON-NAME ZMHS-TKN-OR-TERM-TYPE ZMHS-TKN-OR-PNAME-SUR ZMHS-TKN-OR-PNAME-GIVEN ZMHS-TKN-OR-PNAME-INIT ZMHS-TKN-OR-PNAME-GENQ ZMHS-TKN-OR-ORG-UNIT-1 ZMHS-TKN-OR-ORG-UNIT-2 ZMHS-TKN-OR-ORG-UNIT-3 ZMHS-TKN-OR-ORG-UNIT-4 ZMHS-TKN-OR-DD-TYPE-1 ZMHS-TKN-OR-DD-TYPE-2 ZMHS-TKN-OR-DD-TYPE-3 ZMHS-T
PAGE 512
30: ZMHS-EVT-CUG-VIOL Event Messages Token Descriptions ZMHS-TKN-MSG-TYPE is the type of X.400 message. The possible values are: ZMHS-VAL-MSG- Value Meaning TYPE-UMPDU 0 User message (UMPDU) TYPE-PROBE 1 Probe TYPE-REPORT 2 Delivery/nondelivery report ZMHS-TKN-MSG-SIZE is the total number of bytes in an UMPDU, probe, or report (that is, envelope and content for an UMPDU or a report, and envelope only for a probe).
PAGE 513
30: ZMHS-EVT-CUG-VIOL Event Messages ZMHS-TKN-CUG-VIOL-RSN A token indicating the reason for the CUG violation: ZMHS-VAL-CUG-VIOL-RSN- Value Meaning ORIG 0 Originator not in any CUG RESTRICT 1 Failed CUG restrictions for all CUGs containing originator RECIPS 2 Recipient(s) have no CUG in common with originator ZMHS-TKN-NUM-RECIPIENTS is the number of recipients in a message or probe, or the number of proposed recipients in a report.
PAGE 514
30: ZMHS-EVT-CUG-VIOL Event Messages ZMHS-TKN-OR-PRMD is the PRMD name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes. ZMHS-TKN-OR-ORGANIZ is the organization name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes. ZMHS-TKN-OR-NUM-UID is the numeric user ID component of an O/R name.
PAGE 515
30: ZMHS-EVT-CUG-VIOL Event Messages ZMHS-TKN-OR-PNAME-GENQ is the personal generation qualifier component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 3 bytes. ZMHS-TKN-OR-ORG-UNIT-1...4 is the organizational unit name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 32 bytes. ZMHS-TKN-OR-DD-TYPE-1...
PAGE 516
30: ZMHS-EVT-CUG-VIOL Event Messages ZMHS-TKN-OR-TLTX PNAME-GENQ is the teletex personal generation qualifier component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 3 bytes. ZMHS-TKN-OR-TLTX-ORG-UNIT-1...4 is the teletex organizational unit name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 32 bytes. ZMHS-TKN-OR-TLTX-DD-TYPE-1...
PAGE 517
30: ZMHS-EVT-CUG-VIOL Event Messages Cause. The OSI/MHS message transfer agent (MTA) detects a closed user group (CUG) violation. A violation can be any of the following: • • • No CUG object exists. The originator is not in any CUG object. A CUG object exists but the restrictions defined for the CUG object exclude the current message or probe. OSI/MHS generates a nondelivery report for the invalid recipients. Recovery. If necessary, add or alter the CUG and CUGMEMBER objects.
PAGE 518
31: ZMHS-EVT-CUG-VIOL-RECIP Event Messages 31: ZMHS-EVT-CUG-VIOL-RECIP This event is for recipients of a message or probe when closed user group (CUG) checking is enabled for the OSI/MHS subsystem and a CUG violation is detected. A single ZMHS-EVT-CUG-VIOL-RECIP event is generated for each invalid recipient detected during CUG checking. This is not a critical event.
PAGE 519
31: ZMHS-EVT-CUG-VIOL-RECIP Event Messages ZMHS-TKN-OR-TLTX-PNAME-GIVEN ZMHS-TKN-OR-TLTX-PNAME-INIT ZMHS-TKN-OR-TLTX-PNAME-GENQ ZMHS-TKN-OR-TLTX-ORG-UNIT-1 ZMHS-TKN-OR-TLTX-ORG-UNIT-2 ZMHS-TKN-OR-TLTX-ORG-UNIT-3 ZMHS-TKN-OR-TLTX-ORG-UNIT-4 ZMHS-TKN-OR-TLTX-DD-TYPE-1 ZMHS-TKN-OR-TLTX-DD-TYPE-2 ZMHS-TKN-OR-TLTX-DD-TYPE-3 ZMHS-TKN-OR-TLTX-DD-TYPE-4 ZMHS-TKN-OR-TLTX-DD-VALUE-1 ZMHS-TKN-OR-TLTX-DD-VALUE-2 ZMHS-TKN-OR-TLTX-DD-VALUE-3 ZMHS-TKN-OR-TLTX-DD-VALUE-4 ZMHS-TKN-OR-TLTX-ORGANIZ ZMHS-TKN-OR-TLTX-COMMON-N
PAGE 520
31: ZMHS-EVT-CUG-VIOL-RECIP Event Messages ZMHS-TKN-RECIP-INDEX is a sequence number supplied in each recipient-information EMS buffer in a sequence. The buffers are numbered sequentially starting with 1. ZMHS-TKN-MID-COUNTRY is the country name component of an MTS-wide unique message identifier; maximum length is 3 bytes. ZMHS-TKN-MID-ADMD is the ADMD name component of an MTS-wide unique message identifier; maximum length is 16 bytes.
PAGE 521
31: ZMHS-EVT-CUG-VIOL-RECIP Event Messages ZMHS-TKN-OR-TERM-ID is the terminal ID component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 24 bytes. ZMHS-TKN-OR-PRMD is the PRMD name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes. ZMHS-TKN-OR-ORGANIZ is the organization name component of an O/R name.
PAGE 522
31: ZMHS-EVT-CUG-VIOL-RECIP Event Messages ZMHS-TKN-OR-PNAME-INIT is the personal initials component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 5 bytes. ZMHS-TKN-OR-PNAME-GENQ is the personal generation qualifier component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 3 bytes. ZMHS-TKN-OR-ORG-UNIT-1...
PAGE 523
31: ZMHS-EVT-CUG-VIOL-RECIP Event Messages ZMHS-TKN-OR-TLTX PNAME-INIT is the teletex personal initials component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 5 bytes. ZMHS-TKN-OR-TLTX PNAME-GENQ is the teletex personal generation qualifier component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 3 bytes. ZMHS-TKN-OR-TLTX-ORG-UNIT-1...
PAGE 524
31: ZMHS-EVT-CUG-VIOL-RECIP Event Messages ZMHS-VAL-MSG-TYPE-UMPDU or ZMHS-VAL-MSG-TYPE-PROBE. The possible values are: ZMHS-VAL-EC- Value Meaning IA5-TTX 0 IA5 text to Teletex. TTX-TX 1 Teletex to telex. ZMHS-TKN-END-FLAG is the final EMS buffer in a sequence of buffers relating to a single accounting or unrouteable message event. This token always has the value ZSPI-VAL-TRUE, indicating the final buffer in the sequence.
PAGE 525
32: ZMHS-EVT-NO-MTA-PW-SVR Event Messages 32: ZMHS-EVT-NO-MTA-PW-SVR The MTA bind password server was configured for an adjacent MTA and an attempt is made to establish an association with the adjacent MTA, but no MTA bind password server was configured. This is not a critical event. Additional Unconditional Tokens ZCOM-TKN-OBJNAME ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-BOOLEAN. token-type ZSPI-TYP-BOOLEAN.
PAGE 526
33: ZMHS-EVT-MTA-PW-SVR-ERR Event Messages 33: ZMHS-EVT-MTA-PW-SVR-ERR An error is returned by the MTA bind password server in response to a password request from an MRP process. This is not a critical event. Additional Unconditional Tokens ZCOM-TKN-OBJNAME ZMHS-TKN-PASSW-TYPE ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-STRING. <2> token-type ZSPI-TYP-ENUM token-type ZSPI-TYP-BOOLEAN. token-type ZSPI-TYP-BOOLEAN.
PAGE 527
33: ZMHS-EVT-MTA-PW-SVR-ERR Event Messages Considerations OSI/MHS MRP processes can generate this event message. This event message is reported to the alternate collector.
PAGE 528
34: ZMHS-EVT-DUPL-MPDU Event Messages 34: ZMHS-EVT-DUPL-MPDU This indicates that a duplicate message or report MPDU is discarded by the MS. This is not a critical event. Additional Unconditional Tokens ZMHS-TKN-MSG-TYPE ZMHS-TKN-MSG-SIZE ZMHS-TKN-MID-COUNTRY ZMHS-TKN-MID-ADMD ZMHS-TKN-MID-LOCALID ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-ENUM. <2> token-type ZSPI-TYP-INT2. token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-STRING. token-type ZSPI-TYP-STRING.
PAGE 529
34: ZMHS-EVT-DUPL-MPDU Event Messages Conditional Tokens ZMHS-TKN-MID-PRMD ZMHS-TKN-OR-COUNTRY ZMHS-TKN-OR-ADMD ZMHS-TKN-OR-NETWORK ZMHS-TKN-OR-TERM-ID ZMHS-TKN-OR-PRMD ZMHS-TKN-OR-ORGANIZ ZMHS-TKN-OR-NUM-UID ZMHS-TKN-OR-COMMON-NAME ZMHS-TKN-OR-TERM-TYPE ZMHS-TKN-OR-PNAME-SUR ZMHS-TKN-OR-PNAME-GIVEN ZMHS-TKN-OR-PNAME-INIT ZMHS-TKN-OR-PNAME-GENQ ZMHS-TKN-OR-ORG-UNIT-1 ZMHS-TKN-OR-ORG-UNIT-2 ZMHS-TKN-OR-ORG-UNIT-3 ZMHS-TKN-OR-ORG-UNIT-4 ZMHS-TKN-OR-DD-TYPE-1 ZMHS-TKN-OR-DD-TYPE-2 ZMHS-TKN-OR-DD-TYPE-3 ZMHS-
PAGE 530
34: ZMHS-EVT-DUPL-MPDU Event Messages Token Descriptions ZMHS-TKN-MSG-TYPE is the type of X.400 message. The possible values are: ZMHS-VAL-MSG- Value Meaning TYPE-UMPDU 0 User message (UMPDU) TYPE-PROBE 1 Probe TYPE-REPORT 2 Delivery/nondelivery report ZMHS-TKN-MSG-SIZE is the total number of bytes in an UMPDU, probe, or report (that is, envelope and content for an UMPDU or a report, and envelope only for a probe).
PAGE 531
34: ZMHS-EVT-DUPL-MPDU Event Messages ZMHS-TKN-OR-ADMD is the ADMD name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes. ZMHS-TKN-OR-NETWORK is the network address or X.121 address name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 15 bytes. ZMHS-TKN-OR-TERM-ID is the terminal ID component of an O/R name.
PAGE 532
34: ZMHS-EVT-DUPL-MPDU Event Messages ZMHS-TKN-OR-PNAME-SUR is the personal surname component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 40 bytes. ZMHS-TKN-OR-PNAME-GIVEN is the personal name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes. ZMHS-TKN-OR-PNAME-INIT is the personal initials component of an O/R name.
PAGE 533
34: ZMHS-EVT-DUPL-MPDU Event Messages ZMHS-TKN-OR-TLTX-PNAME-SUR is the teletex personal surname component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 40 bytes. ZMHS-TKN-OR-TLTX-PNAME-GIVEN is the teletex personal given-name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes.
PAGE 534
35: ZMHS-EVT-ACCT-RTS-ASSOC-OP Event Messages 6 Event Messages 6 Event Messages 35: ZMHS-EVT-ACCT-RTS-ASSOC-OP This indicates a successful or unsuccessful RTS association establishment. This is not a critical event.
PAGE 535
35: ZMHS-EVT-ACCT-RTS-ASSOC-OP Event Messages Token Descriptions ZMHS-TKN-REM-NSAP is the remote OSI NSAP address; maximum length is 40 characters. ZMHS-TKN-REM-TSEL is the remote OSI TSEL; maximum length is 64 characters. ZMHS-TKN-REM-SSEL is the remote OSI SSEL; maximum length is 32 characters. ZMHS-TKN-REM-PSEL is the remote OSI PSEL; maximum length is 32 characters. ZMHS-TKN-LOC-NSAP is the local OSI NSAP; maximum length is 40 characters.
PAGE 536
35: ZMHS-EVT-ACCT-RTS-ASSOC-OP Event Messages ZMHS-TKN-ASSOC-RES is the establishment of the association. This token is only present if the token ZMHS-TKN-ASSOC-RES has a value of ZMHS-TKN-VAL-ASSOC-ACCEPT. The possible values are: ZMHS-VAL-ASSOC- Value Meaning RES-ACCEPT 0 Association accepted RES-REJECT 1 Association rejected ZMHS-TKN-ASSOC-REJECT-RSN specifies the reason for failure to open association.
PAGE 537
35: ZMHS-EVT-ACCT-RTS-ASSOC-OP Event Messages ZMHS-TKN-ASSOC-WINDOW-SZ is the negotiated window size for an RTS association. This token is only present if the token ZMHS-TKN-ASSOC-RES has a value of ZMHS-TKN-VAL-ASSOCACCEPT. ZMHS-TKN-ASSOC-CHK-PNT-SZ is the negotiated checkpoint size for an RTS association. Cause. This accounting message indicates a successful or unsuccessful association establishment with an adjacent message transfer agent (MTA).
PAGE 538
36: ZMHS-EVT-ACCT-RTS-TRANSFER Event Messages 36: ZMHS-EVT-ACCT-RTS-TRANSFER This indicates the successful transfer of an APDU by the RTS that was sent to, or received from, an adjacent MTA. This is not a critical event.
PAGE 539
36: ZMHS-EVT-ACCT-RTS-TRANSFER Event Messages ZMHS-TKN-LOC-SSEL is the local OSI SSEL; maximum length is 32 characters. ZMHS-TKN-LOC-PSEL is the local OSI PSEL; maximum length is 32 characters. ZMHS-TKN-ASSOC-DIR is the direction of the association. The possible values are: ZMHS-VAL-ASSOC-DIR-IN Incoming associations ZMHS-VAL-ASSOC-DIR-OUT Outgoing associations ZMHS-TKN-ASSOC-ID is the local association identifier. The MHS process allocates an association ID for each association it handles.
PAGE 540
37: ZMHS-EVT-ACCT-RTS-ASSOC-END Event Messages 37: ZMHS-EVT-ACCT-RTS-ASSOC-END This accounting event indicates whether the termination of the RTS association occurred normally. This is not a critical event.
PAGE 541
37: ZMHS-EVT-ACCT-RTS-ASSOC-END Event Messages ZMHS-TKN-LOC-SSEL is the local OSI SSEL; maximum length is 32 characters. ZMHS-TKN-LOC-PSEL is the local OSI PSEL; maximum length is 32 characters. ZMHS-TKN-ASSOC-DIR is the direction of the association. The possible values are: ZMHS-VAL-ASSOC- Value Meaning DIR-IN 0 Incoming associations DIR-OUT 1 Outgoing associations ZMHS-TKN-ASSOC-ID is the local association identifier.
PAGE 542
38: ZMHS-EVT-ACCT-ROS-ASSOC-OP Event Messages 38: ZMHS-EVT-ACCT-ROS-ASSOC-OP This accounting message indicates a successful or unsuccessful RS association establishment. This is not a critical event.
PAGE 543
38: ZMHS-EVT-ACCT-ROS-ASSOC-OP Event Messages Conditional Tokens ZMHS-TKN-OR-COUNTRY ZMHS-TKN-OR-ADMD ZMHS-TKN-OR-NETWORK ZMHS-TKN-OR-TERM-ID ZMHS-TKN-OR-PRMD ZMHS-TKN-OR-ORGANIZ ZMHS-TKN-OR-NUM-UID ZMHS-TKN-OR-COMMON-NAME ZMHS-TKN-OR-TERM-TYPE ZMHS-TKN-OR-PNAME-SUR ZMHS-TKN-OR-PNAME-GIVEN ZMHS-TKN-OR-PNAME-INIT ZMHS-TKN-OR-PNAME-GENQ ZMHS-TKN-OR-ORG-UNIT-1 ZMHS-TKN-OR-ORG-UNIT-2 ZMHS-TKN-OR-ORG-UNIT-3 ZMHS-TKN-OR-ORG-UNIT-4 ZMHS-TKN-OR-DD-TYPE-1 ZMHS-TKN-OR-DD-TYPE-2 ZMHS-TKN-OR-DD-TYPE-3 ZMHS-TKN-OR-DD-
PAGE 544
38: ZMHS-EVT-ACCT-ROS-ASSOC-OP Event Messages Token Descriptions ZMHS-TKN-REM-NSAP is the remote OSI NSAP; maximum length is 40 characters. ZMHS-TKN-REM-TSEL is the remote OSI TSEL; maximum length is 64 characters. ZMHS-TKN-REM-SSEL is the remote OSI SSEL; maximum length is 32 characters. ZMHS-TKN-REM-PSEL is the remote OSI PSEL; maximum length is 32 characters. ZCOM-TKN-OBJNAME is the name of the APPL object referred to in the event.
PAGE 545
38: ZMHS-EVT-ACCT-ROS-ASSOC-OP Event Messages association ends, the ID can be reused. The association IDs are unique to all concurrent associations within a single process. ZEMS-TKN-EMPHASIS has the value ZSPI-VAL-FALSE, indicating that this is not a critical event. ZEMS-TKN-CONSOLE-PRINT has the value ZSPI-VAL-FALSE. ZMHS-TKN-OR-COUNTRY is the country name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 3 bytes.
PAGE 546
38: ZMHS-EVT-ACCT-ROS-ASSOC-OP Event Messages ZMHS-TKN-OR-TERM-TYPE is the terminal type component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The possible values are: ZMHS-VAL- Value Meaning TERMINAL-TX 1 Telex TERMINAL-TTX 2 Teletex TERMINAL-G3 3 G3-facsimile TERMINAL-G4 4 G4-facsimile TERMINAL-IA5 5 IA5-terminal TERMINAL-VTX 6 Videotex ZMHS-TKN-OR-PNAME-SUR is the personal surname component of an O/R name.
PAGE 547
38: ZMHS-EVT-ACCT-ROS-ASSOC-OP Event Messages ZMHS-TKN-OR-TLTX-ORGANIZ is the teletex organization name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes. ZMHS-TKN-OR-TLTX-COMMON-NAME is the teletex common name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes.
PAGE 548
38: ZMHS-EVT-ACCT-ROS-ASSOC-OP Event Messages • • Run a trace on the RS process. For more information on how to run a trace, refer to the OSI/MHS SCF Reference Manual. Check the configuration for OSI/MHS. Considerations OSI/MHS ROS processes can generate this event message. This event message is reported to the alternate collector. The ZMHS-TKN-OR-xxx tokens indicate the O/R name of the remote UA.
PAGE 549
39: ZMHS-EVT-ACCT-ROS-TRANSFER Event Messages 39: ZMHS-EVT-ACCT-ROS-TRANSFER An accounting event that indicates the transfer of an APDU by the RS that was sent to, or received from, a remote UA. This is not a critical event.
PAGE 550
39: ZMHS-EVT-ACCT-ROS-TRANSFER Event Messages Conditional Tokens ZMHS-TKN-OR-COUNTRY ZMHS-TKN-OR-ADMD ZMHS-TKN-OR-NETWORK ZMHS-TKN-OR-TERM-ID ZMHS-TKN-OR-PRMD ZMHS-TKN-OR-ORGANIZ ZMHS-TKN-OR-NUM-UID ZMHS-TKN-OR-COMMON-NAME ZMHS-TKN-OR-TERM-TYPE ZMHS-TKN-OR-PNAME-SUR ZMHS-TKN-OR-PNAME-GIVEN ZMHS-TKN-OR-PNAME-INIT ZMHS-TKN-OR-PNAME-GENQ ZMHS-TKN-OR-ORG-UNIT-1 ZMHS-TKN-OR-ORG-UNIT-2 ZMHS-TKN-OR-ORG-UNIT-3 ZMHS-TKN-OR-ORG-UNIT-4 ZMHS-TKN-OR-DD-TYPE-1 ZMHS-TKN-OR-DD-TYPE-2 ZMHS-TKN-OR-DD-TYPE-3 ZMHS-TKN-OR-DD-
PAGE 551
39: ZMHS-EVT-ACCT-ROS-TRANSFER Event Messages Token Descriptions ZMHS-TKN-REM-NSAP is the remote OSI NSAP; maximum length is 40 characters. ZMHS-TKN-REM-TSEL is the remote OSI TSEL; maximum length is 64 characters. ZMHS-TKN-REM-SSEL is the remote OSI SSEL; maximum length is 32 characters. ZMHS-TKN-REM-PSEL is the remote OSI PSEL; maximum length is 32 characters. ZMHS-TKN-LOC-NSAP is the local OSI NSAP; maximum length is 40 characters.
PAGE 552
39: ZMHS-EVT-ACCT-ROS-TRANSFER Event Messages ZMHS-TKN-MSG-SIZE is the total number of bytes in an UMPDU, probe, or report (that is, envelope and content for an UMPDU or a report, and envelope only for a probe). ZEMS-TKN-EMPHASIS has the value ZSPI-VAL-FALSE, indicating that this is not a critical event. ZEMS-TKN-CONSOLE-PRINT has the value ZSPI-VAL-FALSE. ZMHS-TKN-OR-COUNTRY is the country name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name.
PAGE 553
39: ZMHS-EVT-ACCT-ROS-TRANSFER Event Messages ZMHS-TKN-OR-TERM-TYPE is the terminal type component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The possible values are: ZMHS-VAL- Value Meaning TERMINAL-TX 1 Telex TERMINAL-TTX 2 Teletex TERMINAL-G3 3 G3-facsimile TERMINAL-G4 4 G4-facsimile TERMINAL-IA5 5 IA5-terminal TERMINAL-VTX 6 Videotex ZMHS-TKN-OR-PNAME-SUR is the personal surname component of an O/R name.
PAGE 554
39: ZMHS-EVT-ACCT-ROS-TRANSFER Event Messages ZMHS-TKN-OR-TLTX-ORGANIZ is the teletex organization name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes. ZMHS-TKN-OR-TLTX-COMMON-NAME is the teletex common name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes.
PAGE 555
Event Messages 39: ZMHS-EVT-ACCT-ROS-TRANSFER The token ZMHS-TKN-PDUID may have a value of 0 for RS transfers that do not have a related PDUID. It is not possible to determine if the outgoing RS APDUs have been successfully received by the remote user. For messages submitted by the MS, the attributes of the object specified in ZCOMTKN-OBJNAME match the attributes of the O/R name of the message originator.
PAGE 556
40: ZMHS-EVT-ACCT-ROS-ASSOC-END Event Messages 40: ZMHS-EVT-ACCT-ROS-ASSOC-END This accounting event indicates whether the termination of the RS association occurred normally. This is not a critical event.
PAGE 557
40: ZMHS-EVT-ACCT-ROS-ASSOC-END Event Messages Conditional Tokens ZMHS-TKN-OR-COUNTRY ZMHS-TKN-OR-ADMD ZMHS-TKN-OR-NETWORK ZMHS-TKN-OR-TERM-ID ZMHS-TKN-OR-PRMD ZMHS-TKN-OR-ORGANIZ ZMHS-TKN-OR-NUM-UID ZMHS-TKN-OR-COMMON-NAME ZMHS-TKN-OR-TERM-TYPE ZMHS-TKN-OR-PNAME-SUR ZMHS-TKN-OR-PNAME-GIVEN ZMHS-TKN-OR-PNAME-INIT ZMHS-TKN-OR-PNAME-GENQ ZMHS-TKN-OR-ORG-UNIT-1 ZMHS-TKN-OR-ORG-UNIT-2 ZMHS-TKN-OR-ORG-UNIT-3 ZMHS-TKN-OR-ORG-UNIT-4 ZMHS-TKN-OR-DD-TYPE-1 ZMHS-TKN-OR-DD-TYPE-2 ZMHS-TKN-OR-DD-TYPE-3 ZMHS-TKN-OR-DD
PAGE 558
40: ZMHS-EVT-ACCT-ROS-ASSOC-END Event Messages Token Descriptions ZMHS-TKN-REM-NSAP is the remote OSI NSAP; maximum length is 40 characters. ZMHS-TKN-REM-TSEL is the remote OSI TSEL; maximum length is 64 characters. ZMHS-TKN-REM-SSEL is the remote OSI SSEL; maximum length is 32 characters. ZMHS-TKN-REM-PSEL is the remote OSI PSEL; maximum length is 32 characters. ZMHS-TKN-LOC-NSAP is the local OSI NSAP; maximum length is 40 characters.
PAGE 559
40: ZMHS-EVT-ACCT-ROS-ASSOC-END Event Messages ZEMS-TKN-EMPHASIS has the value ZSPI-VAL-FALSE, indicating that this is not a critical event. ZEMS-TKN-CONSOLE-PRINT has the value ZSPI-VAL-FALSE. ZMHS-TKN-OR-COUNTRY is the country name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 3 bytes. ZMHS-TKN-OR-ADMD is the ADMD name component of an O/R name. It is an optional token that is supplied if it is present in the X.
PAGE 560
40: ZMHS-EVT-ACCT-ROS-ASSOC-END Event Messages ZMHS-TKN-OR-TERM-TYPE is the terminal type component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The possible values are: ZMHS-VAL- Value Meaning TERMINAL-TX 1 Telex TERMINAL-TTX 2 Teletex TERMINAL-G3 3 G3-facsimile TERMINAL-G4 4 G4-facsimile TERMINAL-IA5 5 IA5-terminal TERMINAL-VTX 6 Videotex ZMHS-TKN-OR-PNAME-SUR is the personal surname component of an O/R name.
PAGE 561
40: ZMHS-EVT-ACCT-ROS-ASSOC-END Event Messages ZMHS-TKN-OR-TLTX-ORGANIZ is the teletex organization name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes. ZMHS-TKN-OR-TLTX-COMMON-NAME is the teletex common name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes.
PAGE 562
Event Messages 40: ZMHS-EVT-ACCT-ROS-ASSOC-END For messages submitted by the MS, the attributes of the object specified in ZCOMTKN-OBJNAME match the attributes of the O/R name of the message originator. For messages delivered to the MS, the attributes of the object specified in ZCOM-TKNOBJNAME match the attributes of the O/R name of the message recipient.
PAGE 563
41: ZMHS-EVT-ACCT-LOS-ASSOC-OP Event Messages 41: ZMHS-EVT-ACCT-LOS-ASSOC-OP This indicates a successful or unsuccessful LO association establishment. This is not a critical event. Additional Unconditional Tokens ZCOM-TKN-OBJNAME ZMHS-TKN-ASSOC-RES ZMHS-TKN-ASSOC-ID ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-STRING. <2> token-type ZSPI-TYP-ENUM. <3> token-type ZSPI-TYP-INT2. token-type ZSPI-TYP-BOOLEAN. token-type ZSPI-TYP-BOOLEAN.
PAGE 564
41: ZMHS-EVT-ACCT-LOS-ASSOC-OP Event Messages Conditional Tokens ZMHS-TKN-OR-COUNTRY ZMHS-TKN-OR-ADMD ZMHS-TKN-OR-NETWORK ZMHS-TKN-OR-TERM-ID ZMHS-TKN-OR-PRMD ZMHS-TKN-OR-ORGANIZ ZMHS-TKN-OR-NUM-UID ZMHS-TKN-OR-COMMON-NAME ZMHS-TKN-OR-TERM-TYPE ZMHS-TKN-OR-PNAME-SUR ZMHS-TKN-OR-PNAME-GIVEN ZMHS-TKN-OR-PNAME-INIT ZMHS-TKN-OR-PNAME-GENQ ZMHS-TKN-OR-ORG-UNIT-1 ZMHS-TKN-OR-ORG-UNIT-2 ZMHS-TKN-OR-ORG-UNIT-3 ZMHS-TKN-OR-ORG-UNIT-4 ZMHS-TKN-OR-DD-TYPE-1 ZMHS-TKN-OR-DD-TYPE-2 ZMHS-TKN-OR-DD-TYPE-3 ZMHS-TKN-OR-DD-
PAGE 565
41: ZMHS-EVT-ACCT-LOS-ASSOC-OP Event Messages Token Descriptions ZCOM-TKN-OBJNAME is the name of the APPL object referred to in the event. This token is present only if the token ZMHS-TKN-ASSOC-RES has a value of ZMHS-VAL-ASSOC-RESACCEPT. ZMHS-TKN-ASSOC-RES is the establishment of the association. The possible values are: ZMHS-VAL-ASSOC- Value Meaning RES-ACCEPT 0 Association accepted RES-REJECT 1 Association rejected ZMHS-TKN-ASSOC-ID is the local association identifier.
PAGE 566
41: ZMHS-EVT-ACCT-LOS-ASSOC-OP Event Messages ZMHS-TKN-OR-PRMD is the PRMD name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes. ZMHS-TKN-OR-ORGANIZ is the organization name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes. ZMHS-TKN-OR-NUM-UID is the numeric user ID component of an O/R name.
PAGE 567
41: ZMHS-EVT-ACCT-LOS-ASSOC-OP Event Messages ZMHS-TKN-OR-PNAME-GENQ is the personal generation qualifier component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 3 bytes. ZMHS-TKN-OR-ORG-UNIT-1...4 is the organizational unit name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 32 bytes. ZMHS-TKN-OR-DD-TYPE-1...
PAGE 568
41: ZMHS-EVT-ACCT-LOS-ASSOC-OP Event Messages ZMHS-TKN-OR-TLTX PNAME-GENQ is the teletex personal generation qualifier component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 3 bytes. ZMHS-TKN-OR-TLTX-ORG-UNIT-1...4 is the teletex organizational unit name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 32 bytes. ZMHS-TKN-OR-TLTX-DD-TYPE-1...
PAGE 569
42: ZMHS-EVT-ACCT-LOS-TRANSFER Event Messages 42: ZMHS-EVT-ACCT-LOS-TRANSFER This is an accounting event that indicates the transfer of an APDU by the LO that was sent to, or received from, a remote UA. This is not a critical event. Additional Unconditional Tokens ZCOM-TKN-OBJNAME ZMHS-TKN-ASSOC-ID ZMHS-TKN-TRANS-DIRECTION ZMHS-TKN-PDUID ZMHS-TKN-MSG-SIZE ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-STRING. <2> token-type ZSPI-TYP-INT2. token-type ZSPI-TYP-ENUM.
PAGE 570
42: ZMHS-EVT-ACCT-LOS-TRANSFER Event Messages Conditional Tokens ZMHS-TKN-OR-COUNTRY ZMHS-TKN-OR-ADMD ZMHS-TKN-OR-NETWORK ZMHS-TKN-OR-TERM-ID ZMHS-TKN-OR-PRMD ZMHS-TKN-OR-ORGANIZ ZMHS-TKN-OR-NUM-UID ZMHS-TKN-OR-COMMON-NAME ZMHS-TKN-OR-TERM-TYPE ZMHS-TKN-OR-PNAME-SUR ZMHS-TKN-OR-PNAME-GIVEN ZMHS-TKN-OR-PNAME-INIT ZMHS-TKN-OR-PNAME-GENQ ZMHS-TKN-OR-ORG-UNIT-1 ZMHS-TKN-OR-ORG-UNIT-2 ZMHS-TKN-OR-ORG-UNIT-3 ZMHS-TKN-OR-ORG-UNIT-4 ZMHS-TKN-OR-DD-TYPE-1 ZMHS-TKN-OR-DD-TYPE-2 ZMHS-TKN-OR-DD-TYPE-3 ZMHS-TKN-OR-DD-
PAGE 571
42: ZMHS-EVT-ACCT-LOS-TRANSFER Event Messages Token Descriptions ZCOM-TKN-OBJNAME is the name of the APPL object referred to in the event. ZMHS-TKN-ASSOC-ID is the local association identifier. The individual MHS process allocates an association identifier, starting at 0 for each association it handles. When an association ends, the ID can be reused. The association IDs are unique to all concurrent associations within a single process. ZMHS-TKN-TRANS-DIRECTION is the direction of the APDU transfer.
PAGE 572
42: ZMHS-EVT-ACCT-LOS-TRANSFER Event Messages ZMHS-TKN-OR-NETWORK is the network address or X.121 address name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 15 bytes. ZMHS-TKN-OR-TERM-ID is the terminal ID component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 24 bytes. ZMHS-TKN-OR-PRMD is the PRMD name component of an O/R name.
PAGE 573
42: ZMHS-EVT-ACCT-LOS-TRANSFER Event Messages ZMHS-TKN-OR-PNAME-GIVEN is the personal name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes. ZMHS-TKN-OR-PNAME-INIT is the personal initials component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 5 bytes. ZMHS-TKN-OR-PNAME-GENQ is the personal generation qualifier component of an O/R name.
PAGE 574
42: ZMHS-EVT-ACCT-LOS-TRANSFER Event Messages ZMHS-TKN-OR-TLTX-PNAME-GIVEN is the teletex personal given-name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes. ZMHS-TKN-OR-TLTX PNAME-INIT is the teletex personal initials component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 5 bytes.
PAGE 575
43: ZMHS-EVT-ACCT-LOS-ASSOC-END Event Messages 43: ZMHS-EVT-ACCT-LOS-ASSOC-END This accounting event indicates whether the termination of the LO association occurred normally. This is not a critical event. Additional Unconditional Tokens ZCOM-TKN-OBJNAME ZMHS-TKN-ASSOC-ID ZMHS-TKN-ASSOC-RES ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT <1> token-type ZSPI-TYP-STRING. <2> token-type ZSPI-TYP-INT2. <3> token-type ZSPI-TYP-ENUM. token-type ZSPI-TYP-BOOLEAN. token-type ZSPI-TYP-BOOLEAN.
PAGE 576
43: ZMHS-EVT-ACCT-LOS-ASSOC-END Event Messages Conditional Tokens ZMHS-TKN-OR-COUNTRY ZMHS-TKN-OR-ADMD ZMHS-TKN-OR-NETWORK ZMHS-TKN-OR-TERM-ID ZMHS-TKN-OR-PRMD ZMHS-TKN-OR-ORGANIZ ZMHS-TKN-OR-NUM-UID ZMHS-TKN-OR-COMMON-NAME ZMHS-TKN-OR-TERM-TYPE ZMHS-TKN-OR-PNAME-SUR ZMHS-TKN-OR-PNAME-GIVEN ZMHS-TKN-OR-PNAME-INIT ZMHS-TKN-OR-PNAME-GENQ ZMHS-TKN-OR-ORG-UNIT-1 ZMHS-TKN-OR-ORG-UNIT-2 ZMHS-TKN-OR-ORG-UNIT-3 ZMHS-TKN-OR-ORG-UNIT-4 ZMHS-TKN-OR-DD-TYPE-1 ZMHS-TKN-OR-DD-TYPE-2 ZMHS-TKN-OR-DD-TYPE-3 ZMHS-TKN-OR-DD
PAGE 577
43: ZMHS-EVT-ACCT-LOS-ASSOC-END Event Messages Token Descriptions ZCOM-TKN-OBJNAME is the name of the APPL object referred to in the event. ZMHS-TKN-ASSOC-ID is the local association identifier. The individual MHS process allocates an association identifier, starting at 0 for each association it handles. When an association ends, the ID can be reused. The association IDs are unique to all concurrent associations within a single process. ZMHS-TKN-ASSOC-RES is the establishment of the association.
PAGE 578
43: ZMHS-EVT-ACCT-LOS-ASSOC-END Event Messages ZMHS-TKN-OR-PRMD is the PRMD name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes. ZMHS-TKN-OR-ORGANIZ is the organization name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes. ZMHS-TKN-OR-NUM-UID is the numeric user ID component of an O/R name.
PAGE 579
43: ZMHS-EVT-ACCT-LOS-ASSOC-END Event Messages ZMHS-TKN-OR-PNAME-GENQ is the personal generation qualifier component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 3 bytes. ZMHS-TKN-OR-ORG-UNIT-1...4 is the organizational unit name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 32 bytes. ZMHS-TKN-OR-DD-TYPE-1...
PAGE 580
43: ZMHS-EVT-ACCT-LOS-ASSOC-END Event Messages ZMHS-TKN-OR-TLTX PNAME-GENQ is the teletex personal generation qualifier component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 3 bytes. ZMHS-TKN-OR-TLTX-ORG-UNIT-1...4 is the teletex organizational unit name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 32 bytes. ZMHS-TKN-OR-TLTX-DD-TYPE-1...
PAGE 581
44: ZMHS-EVT-ACCT-MRP-ROUTE Event Messages 44: ZMHS-EVT-ACCT-MRP-ROUTE This is a sequence of OSI/MHS routing information events that is generated when an MPDU is routed by the OSI/MHS subsystem. A separate event is generated for each recipient. This is not a critical event.
PAGE 582
44: ZMHS-EVT-ACCT-MRP-ROUTE Event Messages Conditional Tokens ZMHS-TKN-MID-PRMD ZMHS-TKN-OR-COUNTRY ZMHS-TKN-OR-ADMD ZMHS-TKN-OR-NETWORK ZMHS-TKN-OR-TERM-ID ZMHS-TKN-OR-PRMD ZMHS-TKN-OR-ORGANIZ ZMHS-TKN-OR-NUM-UID ZMHS-TKN-OR-COMMON-NAME ZMHS-TKN-OR-TERM-TYPE ZMHS-TKN-OR-PNAME-SUR ZMHS-TKN-OR-PNAME-GIVEN ZMHS-TKN-OR-PNAME-INIT ZMHS-TKN-OR-PNAME-GENQ ZMHS-TKN-OR-ORG-UNIT-1 ZMHS-TKN-OR-ORG-UNIT-2 ZMHS-TKN-OR-ORG-UNIT-3 ZMHS-TKN-OR-ORG-UNIT-4 ZMHS-TKN-OR-DD-TYPE-1 ZMHS-TKN-OR-DD-TYPE-2 ZMHS-TKN-OR-DD-TYPE-3
PAGE 583
44: ZMHS-EVT-ACCT-MRP-ROUTE Event Messages Event-Message Text for APDUs routed to DLIST objects: Routing <1> To: #<4> (DLIST); Recip. <3> MPDUid: <2> Event-Message Text for APDUs routed to ROUTE objects: Routing <1> To: #<4> (ROUTE) Recip. <3> MPDUid: <2> Event-Message Text for other APDUs, which must be unrouteable Routing <1> To: #NULL (UNROUTABLE) Recip. <3> MPDUid: <2> Token Descriptions ZMHS-TKN-MSG-TYPE is the type of X.400 message.
PAGE 584
44: ZMHS-EVT-ACCT-MRP-ROUTE Event Messages ZCOM-TKN-OBJNAME is the name of the object referred to in the event. This token specifies the name of the DSM object to which the recipient is routed. This can either be a ROUTE object, an APPL object, or a DLIST. The type of object is indicated by the token ZCOM-TKN-OBJTYPE. ZMHS-TKN-ROUTING-FSM-TRACE is the list of routed FSM states that are used during an invocation of the routing algorithm for a single recipient.
PAGE 585
44: ZMHS-EVT-ACCT-MRP-ROUTE Event Messages ZMHS-TKN-OR-NETWORK is the network address or X.121 address name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 15 bytes. ZMHS-TKN-OR-TERM-ID is the terminal ID component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 24 bytes. ZMHS-TKN-OR-PRMD is the PRMD name component of an O/R name.
PAGE 586
44: ZMHS-EVT-ACCT-MRP-ROUTE Event Messages ZMHS-TKN-OR-PNAME-GIVEN is the personal name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes. ZMHS-TKN-OR-PNAME-INIT is the personal initials component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 5 bytes. ZMHS-TKN-OR-PNAME-GENQ is the personal generation qualifier component of an O/R name.
PAGE 587
44: ZMHS-EVT-ACCT-MRP-ROUTE Event Messages ZMHS-TKN-OR-TLTX-PNAME-GIVEN is the teletex personal given-name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes. ZMHS-TKN-OR-TLTX PNAME-INIT is the teletex personal initials component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 5 bytes.
PAGE 588
44: ZMHS-EVT-ACCT-MRP-ROUTE Event Messages Considerations OSI/MHS MRP processes can generate this event message. This event message is reported to the alternate collector. In the case of the message text, “For other APDUs, which must be unrouteable:”, ZCOM-TKN-OBJTYPE has a value of ZCOM-OBJ-NULL, and ZCOM-TKNOBJNAME has a value of ZCOM-OBJ-UNROUTABLE, as indicated in the message.
PAGE 589
45: ZMHS-EVT-ACCT-DUPL-SUPRN Event Messages 45: ZMHS-EVT-ACCT-DUPL-SUPRN This accounting event indicates that a duplicate message or report MPDU was discarded by the MS. This is not a critical event. Additional Unconditional Tokens ZMHS-TKN-MSG-TYPE ZMHS-TKN-MSG-SIZE ZMHS-TKN-MID-COUNTRY ZMHS-TKN-MID-ADMD ZMHS-TKN-MID-LOCALID ZEMS-TKN-EMPHASIS ZEMS-TKN-CONSOLE-PRINT token-type <1> token-type token-type token-type <2> token-type token-type token-type ZSPI-TYP-ENUM. ZSPI-TYP-INT2. ZSPI-TYP-STRING.
PAGE 590
45: ZMHS-EVT-ACCT-DUPL-SUPRN Event Messages Conditional Tokens ZMHS-TKN-MID-PRMD token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-COUNTRY <3> token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-ADMD <4> token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-NETWORK token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-TERM-ID token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-PRMD <5> token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-ORGANIZ <6> token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-NUM-UID token-type ZSPI-TYP-STRING. ZMHS-TKN-OR-COMMON-NAME token-type ZSPI-TYP-STRING.
PAGE 591
45: ZMHS-EVT-ACCT-DUPL-SUPRN Event Messages Event-Message Text for Reports: Discard Report; MS User: c=<3> /a=<4> /p=<5> /o=<6> /pn=<7>.<8>, Token Descriptions ZMHS-TKN-MSG-TYPE is the type of X.400 message.
PAGE 592
45: ZMHS-EVT-ACCT-DUPL-SUPRN Event Messages ZMHS-TKN-OR-COUNTRY is the country name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 3 bytes. ZMHS-TKN-OR-ADMD is the ADMD name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes. ZMHS-TKN-OR-NETWORK is the network address or X.121 address name component of an O/R name.
PAGE 593
45: ZMHS-EVT-ACCT-DUPL-SUPRN Event Messages ZMHS-VAL- Value Meaning TERMINAL-G4 4 G4-facsimile TERMINAL-IA5 5 IA5-terminal TERMINAL-VTX 6 Videotex ZMHS-TKN-OR-PNAME-SUR is the personal surname component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 40 bytes. ZMHS-TKN-OR-PNAME-GIVEN is the personal name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name.
PAGE 594
45: ZMHS-EVT-ACCT-DUPL-SUPRN Event Messages ZMHS-TKN-OR-TLTX-PNAME-SUR is the teletex personal surname component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 40 bytes. ZMHS-TKN-OR-TLTX-PNAME-GIVEN is the teletex personal given-name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 16 bytes.
PAGE 595
46: ZMHS-EVT-ACCT-MS-SUMMARY Event Messages 46: ZMHS-EVT-ACCT-MS-SUMMARY This accounting message counts the operations performed by the MS user since the start of the association or previous ZMHS-EVT-ACCT-MS-SUMM event. This is not a critical event. Additional Unconditional Tokens ZCOM-TKN-OBJNAME ZMHS-TKN-ASSOC-START-TIME TIMESTAMP.
PAGE 596
46: ZMHS-EVT-ACCT-MS-SUMMARY Event Messages Conditional Tokens ZMHS-TKN-ASSOC-END-TIME TIMESTAMP.
PAGE 597
46: ZMHS-EVT-ACCT-MS-SUMMARY Event Messages Token Descriptions ZCOM-TKN-OBJNAME is the name of the APPL object referred to in the event. ZMHS-TKN-ASSOC-START-TIME is the time the association started. ZMHS-TKN-MS-LIST-COUNT is the number of LIST operations performed by the MS APPL object. ZMHS-TKN-MS-SUMM-COUNT is the number of SUMMARIZE operations performed by the MS APPL object. ZMHS-TKN-MS-FETCH-COUNT is the number of FETCH operations performed by the MS APPL object.
PAGE 598
46: ZMHS-EVT-ACCT-MS-SUMMARY Event Messages ZMHS-TKN-ASSOC-END-TIME is the time the association ended. This token is present only in the last event for the association; it is absent in the events generated periodically during the life-time of the association. ZMHS-TKN-OR-COUNTRY is the country name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 3 bytes. ZMHS-TKN-OR-ADMD is the ADMD name component of an O/R name.
PAGE 599
46: ZMHS-EVT-ACCT-MS-SUMMARY Event Messages ZMHS-TKN-OR-TERM-TYPE is the terminal type component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The possible values are: ZMHS-VAL- Value Meaning TERMINAL-TX 1 Telex TERMINAL-TTX 2 Teletex TERMINAL-G3 3 G3-facsimile TERMINAL-G4 4 G4-facsimile TERMINAL-IA5 5 IA5-terminal TERMINAL-VTX 6 Videotex ZMHS-TKN-OR-PNAME-SUR is the personal surname component of an O/R name.
PAGE 600
46: ZMHS-EVT-ACCT-MS-SUMMARY Event Messages ZMHS-TKN-OR-TLTX-ORGANIZ is the teletex organization name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes. ZMHS-TKN-OR-TLTX-COMMON-NAME is the teletex common name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes.
PAGE 601
Event Messages 46: ZMHS-EVT-ACCT-MS-SUMMARY The ZMHS-TKN-MS-xxx-COUNT tokens are counters for both successful and unsuccessful operations. For messages submitted by the MS, the attributes of the object specified in ZCOMTKN-OBJNAME match the attributes of the O/R name of the message originator. For messages delivered to the MS, the attributes of the object specified in ZCOM-TKNOBJNAME match the attributes of the O/R name of the message recipient.
PAGE 602
47: ZMHS-EVT-ACCT-MS-OPERATION Event Messages 47: ZMHS-EVT-ACCT-MS-OPERATION This accounting event indicates that a particular MS operation was performed. This is not a critical event.
PAGE 603
47: ZMHS-EVT-ACCT-MS-OPERATION Event Messages Conditional Tokens ZCOM-TKN-OBJNAME ZMHS-TKN-OR-COUNTRY ZMHS-TKN-OR-ADMD ZMHS-TKN-OR-NETWORK ZMHS-TKN-OR-TERM-ID ZMHS-TKN-OR-PRMD ZMHS-TKN-OR-ORGANIZ ZMHS-TKN-OR-NUM-UID ZMHS-TKN-OR-COMMON-NAME ZMHS-TKN-OR-TERM-TYPE ZMHS-TKN-OR-PNAME-SUR ZMHS-TKN-OR-PNAME-GIVEN ZMHS-TKN-OR-PNAME-INIT ZMHS-TKN-OR-PNAME-GENQ ZMHS-TKN-OR-ORG-UNIT-1 ZMHS-TKN-OR-ORG-UNIT-2 ZMHS-TKN-OR-ORG-UNIT-3 ZMHS-TKN-OR-ORG-UNIT-4 ZMHS-TKN-OR-DD-TYPE-1 ZMHS-TKN-OR-DD-TYPE-2 ZMHS-TKN-OR-DD-TYPE-
PAGE 604
47: ZMHS-EVT-ACCT-MS-OPERATION Event Messages Token Descriptions ZCOM-TKN-MS-OBJNAME is the name of the APPL object referred to in the event. ZMHS-TKN-MS-OPER is the type of MS operation.
PAGE 605
47: ZMHS-EVT-ACCT-MS-OPERATION Event Messages ZEMS-TKN-CONSOLE-PRINT has the value ZSPI-VAL-FALSE. ZCOM-TKN-OBJNAME is the name of the APPL object referred to in the event. ZMHS-TKN-OR-COUNTRY is the country name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 3 bytes. ZMHS-TKN-OR-ADMD is the ADMD name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name.
PAGE 606
47: ZMHS-EVT-ACCT-MS-OPERATION Event Messages ZMHS-TKN-OR-TERM-TYPE is the terminal type component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The possible values are: ZMHS-VAL- Value Meaning TERMINAL-TX 1 Telex TERMINAL-TTX 2 Teletex TERMINAL-G3 3 G3-facsimile TERMINAL-G4 4 G4-facsimile TERMINAL-IA5 5 IA5-terminal TERMINAL-VTX 6 Videotex ZMHS-TKN-OR-PNAME-SUR is the personal surname component of an O/R name.
PAGE 607
47: ZMHS-EVT-ACCT-MS-OPERATION Event Messages ZMHS-TKN-OR-TLTX-ORGANIZ is the teletex organization name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes. ZMHS-TKN-OR-TLTX-COMMON-NAME is the teletex common name component of an O/R name. It is an optional token that is supplied if it is present in the X.400 O/R name. The maximum length is 64 bytes.
PAGE 608
Event Messages 47: ZMHS-EVT-ACCT-MS-OPERATION The APPL object name (ZCOM-TKN-OBJNAME) is not present if a bind fails as a result of an unknown O/R name (that is, if the token ZMHS-TKN-MS-OPER has a value of ZMHS-VAL-MS-OPER-BIND and the token ZMHS-TKN-MS-OPER-RESULT has a value of ZMHS-VAL-MS-OPER-RESULT-ERR). Generation of the event may not mean that the P7 user has successfully received the operation result, or error, because of the problems inherent in the P7 protocol when RTSE is not used.
PAGE 609
48: ZMHS-EVT-CROSS-THRESHOLD Event Messages 48: ZMHS-EVT-CROSS-THRESHOLD This event indicates that subsystem utilization of a specific resource has crossed a defined threshold value. Additional Unconditional Tokens ZMHS-TKN-EVT-GEN ZMHS-TKN-GROUP-NAME ZMHS-TKN-RES-USAGE ZMHS-TKN-RES-CONDITION ZMHS-TKN-RES-THRESHOLD ZMHS-TKN-RES-SUBSYS ZMHS-TKN-RES-ID <1> <2> <3> <4> <5> token-type token-type token-type token-type token-type token-type token-type ZSPI-TYP-ERROR. ZSPI-TYP-ERROR. ZSPI-TYP-INT.
PAGE 610
48: ZMHS-EVT-CROSS-THRESHOLD Event Messages ZMHS-TKN-RES-ID identifies the specific resource whose threshold has been exceeded. Possible values and corresponding message text are: 0 “NULL pool” 1 “DPDU pool” 2 “EPDU pool” 3 “APPLIC pool” 4 “QUEUE pool” 5 “ILAYER pool” 6 “TIMER pool” 7 “CONTROL pool” Cause. The defined utilization threshold for the specified resource was crossed.
PAGE 611
49: ZMHS-EVT-MR-GRP-CHANGE Event Messages 49: ZMHS-EVT-MR-GRP-CHANGE This event indicates one of two conditions. Either condition may appear during database conversion to a D22 system. • • A change in the number of MR groups allocated to an MS group for message submission has been detected. The MR groups used by an MS group for message submission had to be dynamically reallocated.
PAGE 612
50: ZMHS-EVT-ACCT-MSG-ST-CHG Event Messages 50: ZMHS-EVT-ACCT-MSG-ST-CHG This event indicates that a message in the message store has changed from one state to another.
PAGE 613
50: ZMHS-EVT-ACCT-MSG-ST-CHG Event Messages ZMHS-TKN-MSG-TYPE is the type of X.400 message. The possible values are: ZMHS-VAL-MSG-TYPE- Value Meaning UMPDU 0 User message (UMPDU) PROBE 1 Probe REGISTER 2 Delivery/nondelivery report ZMHS-TKN-PDUID is the PDU store identifier for the message involved in this event. ZMHS-TKN-MID-COUNTRY is the country name component of an MTS-wide unique message identifier. ZMHS-TKN-MID-ADMD is the ADMD name component of an MTS-wide unique message identifier.
PAGE 614
50: ZMHS-EVT-ACCT-MSG-ST-CHG Event Messages ZEMS-TKN-CONSOLE-PRINT has the value ZSPI-VAL-FALSE. ZMHS-TKN-MID-PRMD is the PRMD name component of an MTS-wide unique message identifier. Cause. This accounting message is generated when a message in a message store (mailbox) changes state, as follows: • • • From NEW to LISTED From NEW to PROCESSED From LISTED to PROCESSED Recovery. None necessary; this message is for information only. Considerations OSI/MHS MS processes can generate this event message.
PAGE 615
52: ZMHS-EVT-GW-MAX-TIME-EXPIRED Event Messages 52: ZMHS-EVT-GW-MAX-TIME-EXPIRED This event indicates that the time configured for the gateway attribute GW-MAX-TIMEEXPIRED has past since a message was delivered to the gateway input queue. Additional Unconditional Tokens ZMHS-TKN-GATEWAY-OBJECT-NAME <4> token-type ZSPI-TYP-STRING. ZEMS-TKN-EMPHASIS token-type ZSPI-TYP-BOOLEAN. ZEMS-TKN-CONSOLE-PRINT token-type ZSPI-TYP-BOOLEAN.
PAGE 616
Event Messages 52: ZMHS-EVT-GW-MAX-TIME-EXPIRED OSI/MHS Management Programming Manual—424824-001 6 -212
PAGE 617
7 Password Server Interfaces OSI/MHS supports two password server programmatic interfaces: one at the MTA bind authentication boundary and another at the MS bind authentication boundary. The MTA bind password server interface allows generation and validation of authentication parameters used during MTA association establishment. The MS bind password server interface controls and validates the passwords used when a user represented by an MS APPL object binds to the MS.
PAGE 618
Command and Response Definitions Password Server Interfaces Figure 7-1. MTA Password Server Programmatic Interface OSI/MHS Subsystem MHS Manager Password Server MHS Database MRP Password Database SPI Requests and Responses Association Establishment X.400 MTA CDT 111.CDD The MRP sends an SPI-formatted request to the password server process. The password server process then performs the specified request (to validate or generate parameters) and sends an SPI-formatted reply to the MRP.
PAGE 619
Password Server Interfaces Command and Response Tokens All requests contain the following tokens: ZMHS-MAP-PASSW-COMMAND ZMHS-MAP-LOCAL-MTA-NAME ZMHS-MAP-REMOTE-MTA-NAME Command and Response Tokens The definitions of SPI commands and responses for the MTA password server interface are as follows. Tokens in Command Buffer ZMHS-MAP-PASSW-SERVICE def ZMHS-DDL-PASSW-SERVICE. 02 ZVALUE token-type ZSPI-TYP-INT. end. ZMHS-MAP-PASSW-COMMAND def ZMHS-DDL-PASSW-COMMAND. 02 ZVALUE token-type ZSPI-TYP-INT. end.
PAGE 620
Command and Response Tokens Password Server Interfaces ZMHS-MAP-PASSW def ZMHS-DDL-PASSW. 02 ZLENGTH 02 ZSTRING end. token-type ZSPI-TYP-INT. PIC X(62). Tokens in Response Buffer ZMHS-MAP-PASSW-STATUS def ZMHS-DDL-PASSW-STATUS. 02 ZVALUE token-type ZSPI-TYP-INT. end. ZMHS-MAP-PASSW def ZMHS-DDL-PASSW. 02 ZLENGTH 02 ZSTRING end. token-type ZSPI-TYP-INT. PIC X(62) Tokens in Command Buffer ZMHS-MAP-PASSW-SERVICE identifies the type of password service being requested.
PAGE 621
Command and Response Tokens Password Server Interfaces Table 7-1. Values for ZMHS-MAP-PASSW-COMMAND for MTA If ZMHS-MAP-PASSWCOMMAND contains the value ZMHS-VALPASSW-MTA-… Then this is a request to... And... REQUEST Use the password in a BIND request No additional tokens are present in the request. The reply contains the tokens ZMHS-MAP-PASSWSTATUS and, optionally, ZMHSMAP-PASSW (if the password generation is successful).
PAGE 622
Password Server Interfaces Command and Response Tokens ZMTANAME defines the name of the adjacent MTA. ZISOCOUNTRY defines the name of the country for the adjacent MTA. ZADMD defines the name of the ADMD for the adjacent MTA. ZPRMD defines the name of the PRMD for the adjacent MTA. ZMHS-MAP-PASSW defines a password. This token is optional. It contains a password received from a remote MTA to be validated. In requests, this token is only present if ZMHS-MAPPASSW-COMMAND.
PAGE 623
Password Server Interfaces Error Handling ZMHS-MAP-PASSW defines a password. This token is optional. It contains a password supplied by the password server to be sent to a remote MTA. In responses, this token is only present if ZMHS-MAP-PASSW-COMMAND.ZVALUE is ZMHS-VAL-PASSW-MTAREQUEST or ZMHS-VAL-PASSW-MTA-RESPONSE. The ZMHS-MAPPASSW- tokens consists of the following: ZLENGTH defines the length of the password. ZSTRING defines the password itself.
PAGE 624
MS Password Server Programmatic Interface Password Server Interfaces Table 7-2. MRP Error-Handling Actions If the MRP fails to communicate with the password server or receives an error response when issuing a ZMHS-VAL-PASSW- Then... REQUEST command No attempt is made to establish an outgoing association to this adjacent MTA. MTA-INDICATION command The incoming association is rejected with the error authentication failure.
PAGE 625
MS Process Requests to the MS Password Server Password Server Interfaces Figure 7-2. MIS Password Server Programmatic Interface SCP OSI/MHS Subsystem ADD/ALTER/DELETE APPL MHS Manager MHS Database MRP MS SPI Messages Password Server Password Database SPI Messages MS Bind Register-MS Remote UA CDT 112.
PAGE 626
Password Server Interfaces Password Server Process Failures As with the MS process, the MHS manager performs a WRITEREADX to send an SPI-formatted request to the password server process, and receives back an SPI-formatted reply. However, this is implemented as a true nowaited interface whereby the MHS manager can perform other processing and service requests made on it before the password server replies. The MHS manager does impose a timeout on requests to the password server.
PAGE 627
Command and Response Tokens Password Server Interfaces ZMHS-MAP-PASSW-COMMAND def ZMHS-DDL-PASSW-COMMAND. 02 ZVALUE token-type ZSPI-TYP-INT. end. ZMHS-MAP-APPL-NAME def ZMHS-DDL-APPL-NAME. 02 ZNAME end. ZMHS-MAP-PASSW def ZMHS-DDL-PASSW. 04 ZLENGTH 04 ZSTRING end. PIC X(16) token-type ZSPI-TYP-INT. PIC X(62). ZMHS-MAP-APPL-ORNAME def ZMHS-DDL-APPL-ORNAME. end. ZMHS-MAP-UA-OSI-ADDRESS def ZMHS-DDL-UA-OSI-ADDRESS.
PAGE 628
Password Server Interfaces Command and Response Tokens Tokens in Command Buffer ZMHS-MAP-PASSW-SERVICE identifies the type of password service being requested. ZMHS-DDL-PASSWSERVICE contains the following field: ZVALUE defines the type of password service being requested, and can be set to either ZMHS-VAL-MTA-BIND-AUTHEN or ZMHS-VAL-MS-BIND-AUTHEN. This token is required, and for MS bind authentication always has the value ZMHS-VAL-MS-BIND-AUTHEN. ZMHS-MAP-PASSW-COMMAND defines the type of request.
PAGE 629
Command and Response Tokens Password Server Interfaces Table 7-4. ZVALUE Descriptions (page 1 of 2) If the ZMHS-MAPPASSW-COMMAND token contains the value ZMHS-VALPASSW-MS- Then this is a result from... And... ADD An ADD MS APPL operation The ZMHS-MAP-APPL-ORNAME token is required and contains the O/R name of the APPL object. The ZMHS-MAP-UA-OSI-ADDRESS token is optional and contains the calling OSI address used by a UA accessing the APPL’s mailbox.
PAGE 630
Command and Response Tokens Password Server Interfaces Table 7-4. ZVALUE Descriptions (page 2 of 2) If the ZMHS-MAPPASSW-COMMAND token contains the value ZMHS-VALPASSW-MS- Then this is a result from... And... DELETE A DELETE MS APPL operation The ZMHS-MAP-APPL-ORNAME token is required and contains the O/R name of the APPL object. BIND An MS bind operation The ZMHS-MAP-UA-OSI-ADDRESS token is optional and contains the OSI address of UAs attempting the bind operation over the OSI services.
PAGE 631
Command and Response Tokens Password Server Interfaces Table 7-5.
PAGE 632
Password Server Interfaces Command and Response Tokens ZLENGTH is the length of the string field. The range of values is 0 through 32 bytes. ZSTRING is the OSI address SSEL. ZTSELECTOR specifies the TSEL part of the UA’s calling OSI address. This structure identifies a Transport Layer entity. ZTSELECTOR contains the following fields: ZLENGTH is the length of the string field. The range of values is 0 through 64 bytes. ZSTRING is the OSI address TSEL.
PAGE 633
Password Server Interfaces Command and Response Tokens Tokens in Response Buffer ZMHS-PASSW-STATUS defines whether the operation was successful. This token is required. ZVALUE defines the status. Possible values are: ZMHS-VAL-PASSW-OK ZMHS-VAL-PASSW-ERROR Programming Considerations For security purposes, the password server process should check each requester process. This is done by checking the name of the requester process and its owner.
PAGE 634
Error Handling Password Server Interfaces In the event of a process failure, retry the command to make sure the request succeeded. In the case of an MS register command, retry with the old password and then with the new password. Note that within the tokens of the MS password server interface, those data fields that are shorter than the maximum length may not have valid data in the unused portion of the field. Use the associated length field to determine how much of the field contains valid data.
PAGE 635
Master Password Server Password Server Interfaces Table 7-7. OSI/MHS Event Messages, MS Password Server Interface— Register-MS Event Number Symbolic Name (ZMHS-EVT-) 12 IO-ERR If the MS process cannot communicate with the password server process, then this event is generated, specifying the name of the password server process, and the association is aborted.
PAGE 636
Password Server Interfaces • MPS Concepts and Components It authorizes Bind requests from remote and local P7 user agents configured on an OSI/MHS subsystem. It also authorizes Register-MS requests that would change a user’s password. The MPS uses the MS bind password server interface to communicate with the OSI/MHS subsystem. This interface allows Message Store processes to go through the MPS to authorize Bind and Register-MS requests from remote and local P7 User Agents.
PAGE 637
MPS Concepts and Components Password Server Interfaces Figure 7-3. Master Password Server—Basic Configuration OSI/MHS Subsystem Pathmon MHSMGR Audit Trail MS 1 APPL Authorization Database MPS MS Bind Password Server Interface MS 2 . . . Configuration Database MS n CDT 113.
PAGE 638
Password Server Interfaces MPS Concepts and Components Validation of SPI Requests The MPS process receives Bind and Register requests from the MS process, and ALTER, ADD, and DELETE requests from the MHSMGR process, in the form of SPI messages.
PAGE 639
Password Server Interfaces MPS Concepts and Components ELSE ** normal APPL bind request ** IF (password supplied matches APPL password) THEN IF ( ("Check OSI addresses" flag is TRUE) AND (Bind is over the remote P7 interface) IF (OSI address supplied is OK) THEN reply to MS with OK status ELSE reply to MS with ERROR status ENDIF ELSE reply to MS with OK status ENDIF ELSE IF (password matches master password) THEN reply to MS with OK status ELSE ** not APPL OR master password ** reply to MS with ERROR stat
PAGE 640
Password Server Interfaces MPS Concepts and Components The audit-trail file can be a disk file, a terminal, or a spooler location. If it is a disk file, it is an Enscribe entry-sequenced file with a record size of 250 bytes. When auditing is enabled, the audit-trail file is created and shared by all active MPS processes that support the same master user (except that if the audit-trail file is a spooler location, each MPS process opens a separate spooler location).
PAGE 641
Password Server Interfaces MPS Concepts and Components Table 7-9. Contents of Audit Trail File Field Description RequestorProcName A character string containing the process name of the requestor in the form “\node.$proc”. This field is a fixed length of 15 characters (blank padded). Password A character string containing the unencrypted password of the APPL. This field is a variable length between 3 and 64 characters.
PAGE 642
Password Server Interfaces • • • • • • MPS Concepts and Components The encryption method Whether to log requests in an audit trail The name of the audit-trail file Whether to log bind requests (or only other types of requests) Whether to write passwords to the audit-trail file Master user information: • • • • • • • The master user APPL name The master user APPL OSI address The encryption method for the master password The master password (encrypted) The master user O/R name Whether the master user may
PAGE 643
Password Server Interfaces MPS Concepts and Components The authorization database is an audited, Enscribe key-sequenced file containing several records with information about users of the message stores supported by the MPS process. Each record contains the following information: • • • • • The APPL name The APPL OSI address The encryption method The encrypted password The APPL O/R name The authorization database is created by the MPS installation procedure.
PAGE 644
Password Server Interfaces • • • • Alternative MPS Configurations Creation of a database file Inconsistency in configuration information Errors in opening or writing to database files Fatal errors requiring termination of a server A complete list of MPS errors and informational messages appears under the heading MPS Error and Informational Messages on page 7-45.
PAGE 645
Password Server Interfaces Alternative MPS Configurations An MPS process can have a maximum of 16 openers at a time, including all MS processes and the MHSMGR. No process can have multiple concurrent opens of an MPS process. Load Sharing Configuration In Figure 7-4, two MPS processes share the load of authorization of APPL Bind and Register-MS operations (and ADD, ALTER and DELETE APPL requests) for all the MS groups.
PAGE 646
Password Server Interfaces Alternative MPS Configurations Figure 7-4. Master Password Server—Load Sharing Configuration OSI/MHS Subsystem MHSMGR Audit Trail 1 MS 1 APPL Authorization Database 1 MPS 1 MS Bind Configuration Database Pathmon MS 2 Password Server Interfaces MS 3 Audit Trail 2 MPS 2 MS 4 . . . APPL Authorization Database 2 MPS n . . . MS n CDT 114.
PAGE 647
Password Server Interfaces Alternative MPS Configurations Figure 7-5. Master Password Server—Multiple Master User Configuration OSI/MHS Subsystem Audit Trail 1 MHSMGR APPL Authorization Database 1 MS 1 MPS 1 Configuration Database 1 MS Bind Pathmon MS 2 Password Server Interfaces MS 3 Audit Trail 2 MPS 2 MS 4 APPL Authorization Database 2 . . . MPS n . . . MS n Configuration Database 2 CDT 115.CDD Figure 7-6 shows a variation of the multiple master user configuration shown in Figure 7-5.
PAGE 648
Password Server Interfaces Alternative MPS Configurations Figure 7-6. A Second Variation of the Multiple Master User Configuration Audit Trail 1 OSI/MHS Subsystem Pathmon APPL Authorization Database 1 Configuration Database 1 MHSMGR MPS 1 MS 1 Audit Trail 2 MS 2 APPL Authorization Database 2 MPS 2 Password Server Interfaces Configuration Database 2 Audit Trail 3 MS Bind MS 3 . . . MPS 3 MS n APPL Authorization Database 3 Configuration Database 3 . . . MPS n CDT 116.
PAGE 649
Password Server Interfaces Using the Master Password Server Using the Master Password Server You will need to perform the following tasks to use the MPS: • • • • • • • Plan the MPS configuration Create the authorization database Define the MPS process or processes Add APPLs to the MPS authorization database from: • • An OSI/MHS subsystem already configured with APPLs or An OSI/MHS subsystem not yet configured with APPLs Run and monitor the MPS Make changes to an established MPS configuration Deconfig
PAGE 650
Password Server Interfaces Using the Master Password Server Figure 7-7. Installation and Configuration Tasks Define the MPS configuration Create the APPL authorization database Define the MPS server(s) YES APPLs configured on subystem ? NO Add APPLs to the MPS from a non-configured subystem Add APPLs to the MPS from a configured subystem Run and monitor the MPS Make changes to an established MPS configuration Deconfigure the MPS CDT 017.
PAGE 651
Password Server Interfaces • • What will you name the authorization databases (one per server process), and where will they reside? How many master users will you define? (You need exactly one configuration database for each master user, regardless of the number of MPS processes.
PAGE 652
Password Server Interfaces Using the Master Password Server MPS Operational Parameters Whether you use PATHCOM or a TACL command interpreter, you specify values of the following MPS startup parameters: MPS-AUTH-DB is a valid filename specifying the (local) file name of the authorization database. This parameter is required. (When you run an MPS process in RECONFIGURE mode, as explained later in this list, this parameter is required even though it is not used.
PAGE 653
Password Server Interfaces Using the Master Password Server If a normal-mode server is the first MPS process to run, it creates and loads the configuration database. This is the usual mode in which an MPS process runs. ISOLATE In this mode, the MPS process services requests from the MHSMGR and the MS.
PAGE 654
Password Server Interfaces Using the Master Password Server authorization database and the mode—the MPS process writes a warning message to its output file and continues to use the old parameters. MPS-MASTER-APPL specifies the SCF APPL name of the master user. This parameter is optional. If the configuration database already exists (because another MPS process created it), the new MPS process supports the master user defined in the database.
PAGE 655
Password Server Interfaces Using the Master Password Server MPS-AUDIT-FILE specifies the (local) file name of the audit-trail file to be created by the MPS process. This parameter is required if MPS-AUDIT PARAM is ON and is ignored if the MPS-AUDIT is OFF. This parameter is optional. If the configuration database already exists (because another MPS process created it), the new MPS process uses the value defined in the database unless it is in RECONFIGURE or ISOLATE mode.
PAGE 656
Password Server Interfaces Using the Master Password Server This parameter is optional. If the configuration database already exists (because another MPS process created it), the new MPS process uses the value defined in the database unless it is in RECONFIGURE or ISOLATE mode. If you specify a different value for a process in NORMAL or POPULATE mode, the MPS writes a warning message to the output file and ignores the new parameter. MPS-CHECK-OSI has a value of ON or OFF, and a default value of OFF.
PAGE 657
Password Server Interfaces Using the Master Password Server 4. Determine the OSI address (if any) and the current password of each of the APPLs. SCF does not report the current password; obtain it from the user if possible. 5. Create an SCF command file containing an ALTER APPL command for each of the APPLs. Be sure to specify a password and, if it exists, the OSI address for each APPL.
PAGE 658
Password Server Interfaces Using the Master Password Server if a Register-MS request changes a user’s password, the MPS process updates the password for the corresponding APPL in its authorization database. Follow these steps to add new APPLs: 1. Run the MHSMGR process if it is not already running. 2. Use the SCF ADD or ALTER GROUP command to specify an MPS process name for each MS group to be supported by the MPS. Use the SCF attribute MS-BINDPW-SVR to specify the MPS process name. 3.
PAGE 659
Password Server Interfaces • Using the Master Password Server When you stop an MPS process, Bind, Register-MS, ADD, ALTER, and DELETE operations on the affected APPLs are unavailable until the MPS process is restarted or the MS is redefined so as not to use the MPS.
PAGE 660
Password Server Interfaces • • • Sizing and Performance Information Run a new MPS process in RECONFIGURE mode, specifying new values for the startup parameters. The MPS process in RECONFIGURE mode updates the configuration and then stops. All MPS processes using that configuration database are notified of the update and begin to operate with the new parameters. Run an MPS process in ISOLATE mode, specifying new values for the startup parameters.
PAGE 661
Password Server Interfaces MPS Error and Informational Messages The algorithm used by the MPS to search the Authorization information is described in the header file for the authorization module. (See MPS Source and Configuration Files on page 7-65.) Another factor that influences performance is the audit -trail option. It is most efficient to disable that option during normal operations.
PAGE 662
Password Server Interfaces MPS Error and Informational Messages Recovery. Use TMFCOM to examine the status of TMF on your system and correct the problem. *** ERROR *** CONTROL 27 failed with error Cause. This message reports an I/O problem with the configuration database. The I/O function and the file-system error number are reported in the message. Effect. In general, this error reports an unrecoverable situation, and the MPS will ABEND. Recovery.
PAGE 663
Password Server Interfaces *** ERROR MPS Error and Informational Messages *** ENDTRANSACTION failed with error Cause. This message refers to a problem using the TMF facilities. Effect. Generally, the MPS will attempt to continue processing under these conditions, but any requests from OSI/MHS will be rejected. Recovery. Use TMFCOM to examine the status of TMF on your system and correct the problem. *** ERROR *** Failed to process update to MPS-CONF-DB Cause.
PAGE 664
Password Server Interfaces MPS Error and Informational Messages Effect. The MPS process ABENDs. Recovery. Correct the version incompatibility, either by using a different version of the MPS or by recreating the configuration database. *** ERROR *** Invalid PARAM Cause. This message reports a problem with a configuration parameter value specified on startup of the MPS. Effect. It is a fatal error and causes the MPS to ABEND. Recovery.
PAGE 665
Password Server Interfaces *** ERROR MPS Error and Informational Messages *** Mandatory PARAM MPS-AUTH-DB not specified Cause. This message reports a problem with a configuration parameter value specified on startup of the MPS. Effect. It is a fatal error and causes the MPS to ABEND. Recovery. Correct the configuration parameter value that is in error and restart or reconfigure the MPS. *** ERROR *** Mandatory PARAM MPS-CONF-DB not specified Cause.
PAGE 666
Password Server Interfaces *** ERROR MPS Error and Informational Messages *** Open of $RECEIVE failed with error Cause. This message reports a process or device-related I/O problem. Effect. It is fatal and causes the MPS to ABEND. Recovery. This message should never occur in normal operation. Contact your Compaq representative with information about your configuration and the circumstances of the error. *** ERROR *** Open of MPS-AUDIT-FILE failed with error Cause.
PAGE 667
Password Server Interfaces ** ERROR MPS Error and Informational Messages *** Open of MPS-CONF-DB for nowaited I/O failed with error Cause. This message reports an I/O problem with the configuration database. The I/O function, the file name, and the file-system error number are reported in the message. Effect. In general, this error reports an unrecoverable situation, and the MPS will ABEND. Recovery. Look up the error number in the Guardian Procedure Errors and Messages Manual.
PAGE 668
Password Server Interfaces *** ERROR MPS Error and Informational Messages *** READUPDATE failed with error Cause. This message reports a process or device-related I/O problem. Effect. It is fatal and causes the MPS to ABEND. Recovery. This message should never occur in normal operation. If you are using the MPS unmodified (as delivered from Compaq), contact your Compaq representative with information about your configuration and the circumstances of the error.
PAGE 669
Password Server Interfaces MPS Error and Informational Messages Effect. In general, this error reports an unrecoverable situation, and the MPS will ABEND. Recovery. Look up the error number in the Guardian Procedure Errors and Messages Manual. Correct the reported problem with the file, and restart the MPS. *** ERROR *** Write to MPS-CONF-DB failed with error Cause. This message reports an I/O problem with the configuration database.
PAGE 670
Password Server Interfaces *** info MPS Error and Informational Messages *** Initialisation complete - ready to service requests Cause. This message reports that the MPS has completed its initialization and is ready to service requests from OSI/MHS. Effect. The MPS process is in operation. Recovery. You can now start APPLs and inform users that they can begin to use their message stores. *** info *** MPS-ALLOW-BINDS altered from to Cause.
PAGE 671
Password Server Interfaces MPS Error and Informational Messages Recovery. No action is required, other than to verify that the configuration change is expected and correct. *** info *** MPS-AUDIT-BINDS altered from to Cause. This message reports that the specified configuration parameter has been changed for the MPS reporting the message, as well as for the other MPS processes that share the configuration database, unless this is an isolate-mode server.
PAGE 672
Password Server Interfaces MPS Error and Informational Messages share the configuration database, unless this is an isolate-mode server. The old value and the new value are both reported in the message. Effect. The new value determines whether or not the MPS will verify OSI addresses. Recovery. No action is required, other than to verify that the configuration change is expected and correct. *** info *** MPS-ENCRYPT-METHOD altered from to Cause.
PAGE 673
Password Server Interfaces MPS Error and Informational Messages Effect. The MPS attempts to continue, unless this warning occurs in connection with other errors that cause it to ABEND. A database inconsistency might exist in this case. Recovery. Review the file-system error number, and attempt to determine the reason for failure. Verify the correct installation and operation of TMF on your NonStop system. *** warning *** APPL has already been added to database Cause.
PAGE 674
Password Server Interfaces MPS Error and Informational Messages *** warning *** Attempt to OPEN MPS twice was rejected Cause. A process attempted to open the MPS more than once. Effect. The MPS rejects the open attempt but continues to accept requests normally through all its other opens. Recovery. Attempt to locate the source of the invalid request and remove it. If necessary, change the code of the MPS to report the process ID of the process that is the source of the messages.
PAGE 675
Password Server Interfaces MPS Error and Informational Messages about the type of operation being requested. If you have modified the MPS program, study it for errors in processing SPI messages. *** warning *** Couldn't initialise reply buffer Cause. This message reports a possible error in the MPS code. It is unlikely to occur if you use the MPS without modification. Effect. The MPS process rejects the request and attempts to continue operation. Recovery.
PAGE 676
Password Server Interfaces MPS Error and Informational Messages Effect. The new MPS process uses the parameters already in the database and ignores the new ones specified. Recovery. No action is required. To avoid this warning in the future, reread the description of the startup parameters in this manual and modify your TACL or PATHCOM script. *** warning *** Invalid PASSW-COMMAND token value in SPI request buffer Cause.
PAGE 677
Password Server Interfaces MPS Error and Informational Messages *** warning *** Mandatory PARAM MPS-AUDIT-FILE not specified *** warning *** Altered PARAM MPS-AUDIT ON to OFF Cause. These two messages are written together when an MPS is asked to start auditing but no audit file has been specified yet. Effect. The second message indicates that auditing has been automatically disabled. Recovery. Attempt to enable auditing again, specifying the MPS-AUDIT and the MPS-AUDIT-FILE params.
PAGE 678
Password Server Interfaces MPS Error and Informational Messages Effect. The MPS does not update the master user information and continues operation without a master user. Recovery. Stop the MPS concerned and all the APPLs that are served by that MPS. Use the SCF INFO APPL command to verify the configuration of the APPL(s) in OSI/MHS. If the configuration is incorrect, correct it using SCF.
PAGE 679
Password Server Interfaces MPS Error and Informational Messages *** warning *** READ of MPS-AUTH-DB failed with error Cause. This message reports a problem with I/O to an authorization database. The message includes the name of the I/O operation, the name of the authorization database, and the file-system error number. Effect. The MPS attempts to continue operation, unless this warning occurs in connection with errors that cause it to ABEND. Recovery.
PAGE 680
Password Server Interfaces MPS Error and Informational Messages Recovery. Attempt to locate the source of the security threat and remove it. If necessary, change the code of the MPS to report the process ID of the process that is the source of the messages. *** warning *** SPI message from requestor that has not opened MPS Cause. This message reports a possible security threat against the OSI/MHS subsystem served by the MPS, specifically a message received from an unauthorized process. Effect.
PAGE 681
Password Server Interfaces MPS Source and Configuration Files Effect. The MPS attempts to continue operation, unless this warning occurs in connection with an error that causes it to ABEND. Recovery. Examine the file system error number and attempt to resolve the problem. Refer to the Guardian Procedure Errors and Messages Manual for information about file-system errors. MPS Source and Configuration Files Table 7-10 lists the name and purpose of each MPS file on the OSI/MHS product subvolume.
PAGE 682
Password Server Interfaces MPS Source and Configuration Files Table 7-10.
PAGE 683
A Errors and Error Lists This appendix lists the error numbers defined by the OSI/MHS subsystem (values whose symbolic names begin with ZMHS-ERR-) and describes the error list associated with each number. These error numbers appear in response messages as values of the token ZSPI-TKN-RETCODE and also in the Z-ERROR field of ZSPI-TKN-ERROR in the error list. All errors described in this appendix represent error conditions rather than warning conditions.
PAGE 684
Errors and Error Lists ZCOM Errors Returned by OSI/MHS Table A-1.
PAGE 685
Errors and Error Lists Notation Used appear in the box. These two tokens serve the same function in all error lists, so they are not described here. For more information about these tokens, refer to the SPI Programming Manual. In this appendix, tokens and their values are represented in Data Definition Language (DDL). For a quick explanation of DDL, refer to the appendix “Overview of DDL for SPI” in the SPI Programming Manual.
PAGE 686
Errors and Error Lists 1: ZMHS-ERR-NETWORK 1: ZMHS-ERR-NETWORK The attempted command cannot be implemented because of the current state of the network. 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.
PAGE 687
Errors and Error Lists 2: ZMHS-ERR-APPL-MSG 2: ZMHS-ERR-APPL-MSG An MS APPL has messages in the message database and cannot be deleted. 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.
PAGE 688
Errors and Error Lists 3: ZMHS-ERR-APPL-LOG 3: ZMHS-ERR-APPL-LOG The APPL is currently logged on and cannot be stopped or suspended. 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.
PAGE 689
Errors and Error Lists 4: ZMHS-ERR-PDU-FILE 4: ZMHS-ERR-PDU-FILE An attempt was made to add a group with a PDU file name or PDU log file name that is being used by another group. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZMHS-TKN-XFNAME 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-STRING. ZSPI-TYP-SSCTL.
PAGE 690
Errors and Error Lists 5: ZMHS-ERR-PROC-NAME 5: ZMHS-ERR-PROC-NAME An attempt was made to add a group with a process name that is not unique in the subsystem. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZMHS-TKN-XFNAME 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-STRING. ZSPI-TYP-SSCTL.
PAGE 691
Errors and Error Lists 6: ZMHS-ERR-APPL-USE 6: ZMHS-ERR-APPL-USE The object specified in a delete command is being used for message submission and delivery by APPL objects. 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.
PAGE 692
Errors and Error Lists 7: ZMHS-ERR-NO-PARENT-OBJ 7: ZMHS-ERR-NO-PARENT-OBJ An attempt was made to add a child object before the parent object was added. 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.
PAGE 693
Errors and Error Lists 8: ZMHS-ERR-CHILD-OBJ-EXISTS 8: ZMHS-ERR-CHILD-OBJ-EXISTS An attempt was made to delete an object for which children exist. For a SUBSYS, a child is a CLASS, APPL, or MTA object. For a CLASS, a child is a GROUP object. For an MTA, a child is a ROUTE object. 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.
PAGE 694
Errors and Error Lists 9: ZMHS-ERR-INV-FIELDS 9: ZMHS-ERR-INV-FIELDS A cross check of fields in a token failed. Although the values of the individual fields are valid, the combination of these fields within a structure is invalid. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZCOM-TKN-PARAM-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.
PAGE 695
Errors and Error Lists 10: ZMHS-ERR-DUP-OSI-ADDR 10: ZMHS-ERR-DUP-OSI-ADDR A duplicate OSI address has been specified. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZMHS-TKN-OSI-ADDR 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-DDL-EXTERNAL-ADDR. ZSPI-TYP-SSCTL. ZSPI-TKN-ERROR is the standard SPI error token, as described in the SPI Programming Manual.
PAGE 696
Errors and Error Lists 11: ZMHS-ERR-INV-NODE 11: ZMHS-ERR-INV-NODE A field in a token contains an invalid node. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZCOM-TKN-PARAM-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. ZSPI-TKN-ERROR is the standard SPI error token, as described in the SPI Programming Manual.
PAGE 697
Errors and Error Lists 12: ZMHS-ERR-DUP-OR-NAME 12: ZMHS-ERR-DUP-OR-NAME An APPL object has been added with an O/R name that is not unique. 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.
PAGE 698
Errors and Error Lists 13: ZMHS-ERR-INV-ACCESS-NAME 13: ZMHS-ERR-INV-ACCESS-NAME An APPL object has been added with an invalid ACCESS-NAME. 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.
PAGE 699
Errors and Error Lists 14: ZMHS-ERR-INVAL-OR-NAME 14: ZMHS-ERR-INVAL-OR-NAME A DLIST or DLISTMEMBER object was added or altered without a valid name. 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.
PAGE 700
Errors and Error Lists 15: ZMHS-ERR-INV-APPL-ADDR 15: ZMHS-ERR-INV-APPL-ADDR An APPL OSI address was not configured for the MS GROUP process. 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.
PAGE 701
Errors and Error Lists 16: ZMHS-ERR-MS-PW-SVR-ERR 16: ZMHS-ERR-MS-PW-SVR-ERR An error was received from the MS bind password server when an MS APPL process was being added, altered, or deleted. 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.
PAGE 702
Errors and Error Lists 17: ZMHS-ERR-INVALID-PRI 17: ZMHS-ERR-INVALID-PRI An invalid priority was specified when adding or altering a GROUP process. 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.
PAGE 703
Errors and Error Lists 18: ZMHS-ERR-ALTER-GW-APPL 18: ZMHS-ERR-ALTER-GW-APPL An MS APPL attribute was specified when altering a GW APPL attribute. 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.
PAGE 704
Errors and Error Lists 19: ZMHS-ERR-DUPL-GW-PNAME 19: ZMHS-ERR-DUPL-GW-PNAME An attempt was made to add or alter a GATEWAY object with a duplicate GW-PNAME or GW-AUX-PNAME attribute. 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.
PAGE 705
Errors and Error Lists 20: ZMHS-ERR-DUPL-P1-EXIT-GW 20: ZMHS-ERR-DUPL-P1-EXIT-GW An attempt was made to add more than one P1-EXIT gateway. 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.
PAGE 706
Errors and Error Lists 21: ZMHS-ERR-NON-UNIQUE-CPU 21: ZMHS-ERR-NON-UNIQUE-CPU A group, or any process configured for the group, was configured with duplicate primary and backup CPU numbers. 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.
PAGE 707
Errors and Error Lists 22: ZMHS-ERR-INV-RTVL-ATTR 22: ZMHS-ERR-INV-RTVL-ATTR An attempt was made to alter an APPL object list-and-fetch message retrieval attribute when the SET-RTVL-DEFAULTS attribute was set to OFF. 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.
PAGE 708
Errors and Error Lists 23: ZMHS-ERR-BAD-GROUP-SUMSTATE 23: ZMHS-ERR-BAD-GROUP-SUMSTATE An attempt was made to trace a process when the GROUP object to which it belongs was in an invalid state. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZCOM-TKN-OBJSTATE 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-ENUM. ZSPI-TYP-SSCTL.
PAGE 709
Errors and Error Lists 24: ZMHS-ERR-NON-UNIQUE-OR-NAME 24: ZMHS-ERR-NON-UNIQUE-OR-NAME An O/R name resulted in a non-unique routing database key. 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.
PAGE 710
Errors and Error Lists 25: ZMHS-ERR-GROUP-USE 25: ZMHS-ERR-GROUP-USE An MR group was specified in a delete command, but there are MS groups that use that MR group for message submission. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ENDLIST token-type token-type token-type token-type ZSPI-TYP-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TKN-ERROR is the standard SPI error token, as described in the SPI Programming Manual.
PAGE 711
Errors and Error Lists 26: ZMHS-ERR-TOO-MANY-PARTIALS 26: ZMHS-ERR-TOO-MANY-PARTIALS Both the X121-ADDR attribute and the NUMERIC-USER-IDENTIFIER attribute have been wild-carded. You can wild-card only one of these two attributes in a given object. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ENDLIST token-type token-type token-type token-type ZSPI-TYPE-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENUM.
PAGE 712
Errors and Error Lists 27: ZMHS-ERR-INV-PART-OR-ADDR-ATTR 27: ZMHS-ERR-INV-PART-OR-ADDR-ATTR An invalid partially or fully wild-carded O/R address has been entered. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ENDLIST token-type token-type token-type token-type ZSPI-TYPE-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TKN-ERROR is the standard SPI error token, as described in the SPI Programming Manual.
PAGE 713
Errors and Error Lists 28: ZMHS-ERR-TOO-MANY-PART-ADDRS 28: ZMHS-ERR-TOO-MANY-PART-ADDRS The subsystem limit of 200 partially or fully wild-carded O/R attributes has been exceeded. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ENDLIST token-type token-type token-type token-type ZSPI-TYPE-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TKN-ERROR is the standard SPI error token, as described in the SPI Programming Manual.
PAGE 714
Errors and Error Lists 29: ZMHS-ERR-NO-MR-GRPS 29: ZMHS-ERR-NO-MR-GRPS The MS group specified in a start command has no MR groups configured for message submission. ZSPI-TKN-ERRLIST ZSPI-TKN-ERROR ZCOM-TKN-OBJNAME ZCOM-TKN-OBJTYPE ZSPI-TKN-ENDLIST token-type token-type token-type token-type ZSPI-TYPE-LIST. ZSPI-TYP-ERROR. ZSPI-TYP-STRING. ZSPI-TYP-ENUM. ZSPI-TKN-ERROR is the standard SPI error token, as described in the SPI Programming Manual.
PAGE 715
B Token Codes and Token Maps This appendix contains all the token codes and token maps specific to the OSI/MHS subsystem. Table of Token Codes Table B-1 summarizes all token codes specific to the OSI/MHS subsystem (that is, all token codes whose names begin with ZMHS-TKN-). For each token code, the Table B-1 gives the corresponding token type.
PAGE 716
Token Codes and Token Maps Table of Token Codes Table B-1.
PAGE 717
Token Codes and Token Maps Table of Token Codes Table B-1.
PAGE 718
Token Codes and Token Maps Table of Token Codes Table B-1.
PAGE 719
Token Codes and Token Maps Table of Token Maps Table B-1.
PAGE 720
Token Codes and Token Maps Table of Token Maps Table B-2. OSI/MHS Token Maps and DDL Definitions (page 2 of 2) Token Map DDL Definition ZMHS-MAP-MS-APPL-PARAMS ZMHS-DDL-MS-APPL-PARAMS ZMHS-MAP-MS-PARAMS ZMHS-DDL-MS-PARAMS ZMHS-MAP-MTA-ADD-PARAMS ZMHS-DDL-MTA-ADD-PARAMS ZMHS-MAP-MTA-PARAMS ZMHS-DDL-MTA-PARAMS.
PAGE 721
C Examples This appendix contains the following examples: • SPI example in TAL and TACL shows how to: • • • • • • • • • • Build SPI command buffer Initialize and set the command buffer Issue a command and check the reply Close the MHS manager Exit Command file to load all definitions and compile the files EMS filter EMS template example that shows how to: • • • • • Create the dictionary Create the EMS template source Compile the EMS template source Create the EMS template file Start the EMS printi
PAGE 722
Examples SPI Example in TACL ?TACL MACRO == ***************************************************************************** == == TACL macro to issue ADD MTA == == The command executed (in SCF structure): == ADD MTA $MHS1.
PAGE 723
Examples SPI Example in TACL #SET spi_buflen 3900 == == ROUTINE initialize == == Initialize the SPI request for ADD MTA == [#DEF initialize ROUTINE |BODY| == ADD MTA command #SET err [#SSINIT add_mta_req [MHS^val^SSID] zcom^cmd^ADD /OBJECT zcom^obj^mta/ ] [#IF err |THEN| spi_error [err] from #SSINIT in ADD MTA] #SET err [#SSPUTV add_mta_req zspi^tkn^MANAGER mhs_mgr_name] [#IF err |THEN| spi_error [err] from #SSPUT zcom^tkn^MANAGER in ADD MTA] #set mta_objname MTAX #set mta_objname_len 4 #SET err [#SSPUT a
PAGE 724
Examples SPI Example in TACL zmhs^val^boolean^true #set mta_params:zpassw^server:zflag zmhs^val^boolean^false #set mta_params:zabs^syntax^id 0 #set #set #set #set #set mta_params:zrempselector1:zlength 0 mta_params:zremsselector1:zlength 0 mta_params:zremtselector1:zlength 0 mta_params:zremnsap1:zlength 2 mta_params:zremnsap1:zstring 52 #set #set #set #set #set mta_params:zlocpselector1:zlength 0 mta_params:zlocsselector1:zlength 0 mta_params:zloctselector1:zlength 0 mta_params:zlocnsap1:zlength 2 mta_
PAGE 725
Examples SPI Example in TACL #set mta_params:zlocsselector7:zlength 0 #set mta_params:zloctselector7:zlength 0 #set mta_params:zlocnsap7:zlength 0 #set mta_params:zx121country:zlength 3 #set mta_params:zx121country:zstring 310 #set mta_params:zcountryname:zlength 21 #set mta_params:zcountryname:zstring UNITEDSTATESOFAMERICA #SET err [#SSPUTV add_mta_req Zmhs^map^mta^params mta_params] [#IF err |THEN| spi_error [err] from #SSPUTV mta_params in ADD MTA] ] == Error handling [#DEF io_error ROUTINE #PUSH err
PAGE 726
Examples SPI Example in TACL #SET err [#REQUESTER /WAIT spi_buflen / == OPEN scp.#ZSPI READ [scp_name].#ZSPI io_err reply request] [#IF err |THEN| spi_error [err] opening [scp_name].#ZSPI] #SETV subsys_status "INDETERMINATE" ] == == ROUTINE close_scp == == Close the SCP process == [#DEF close_scp ROUTINE |BODY| #SET err [#REQUESTER CLOSE request] [#IF e rr |THEN| spi_error [err] closing [scp_name].
PAGE 727
Examples SPI Example in TAL open_scp add_MTA close_scp #UNFRAME SPI Example in TAL The source code for this example is provided in the file EXSPIT1 on the OSI/MHS installation subvolume. --------------------------------------------------------------- File. EXSPIT1 --- This program communicates with an OSI/MHS subsystem -- through SCP, sending the following commands to the OSI/MHS -- manager process. --- * ADD MTA $MHS1.
PAGE 728
Examples SPI Example in TAL ? LIST -OSI/MHS subsystem-specific TAL definitions ? NOLIST, SOURCE zMHSTAL ? LIST ? PAGE "Global variables " --- Compaq data communications variables ---- Declare a variable to hold the subsystem ID of the OSI/MHS -- subsystem, initializing it with the proper values. -INT .MHS^Val^SSID[0:5] := [ zSpi^Val^Tandem, zSpi^SSN^zMHS, zMHS^Val^Version ]; ----- Define the structure for the profile information and the token map for the structure. STRUCT INT STRUCT INT .
PAGE 729
Examples SPI Example in TAL END; S^Ptr[5] ':=' ")" -> @S^Ptr; CALL Write ( Term^Fn, Term^Buf, @S^Ptr '-' @S^Term^Buf )#; LITERAL MAX^MGR^INPUT^LEN = 10; -- Maximum length of input MHS -- Manager name in bytes --- MHS Manager name -INT .Mgr^Tkn^Name[0:15] := ["\ "]; -12345678901234567890123456789012 -- Word offset of MHS Manager name in Mgr^Tkn^Name LITERAL MGR^TKN^NAME^OFFSET = 4; --------------INT INT INT ---INT INT INT SPI communication variables Define two buffers for the SPI messages.
PAGE 730
Examples SPI Example in TAL ? NOLIST, SOURCE $SYSTEM.SYSTEM.EXTDECS0( SSGet, ? SSGetTkn, ? SSInit, ? SSMove, ? SSMoveTkn, ? SSNull, ? SSPut, ? SSPutTkn ) ? LIST ? PAGE "Process Startup Sequence" --------------------------------------------------------------- STARTUP. --GLOBALS. None -INPUT. None -OUTPUT. None --- Purpose. Perform the standard process startup sequence.
PAGE 731
Examples SPI Example in TAL CALL FileInfo( Rcv^Num, Open^Error ); Write^Term^With^Num ( "Cannot open $RECEIVE", Open^Error ); CALL Abend; END; CALL Read( Rcv^Num, Startup^Msg, $LEN( Startup^Msg ), Count^Read ); IF <> THEN BEGIN CALL FileInfo( Rcv^Num, Open^Error ); Write^Term^With^Num ( "Cannot read $RECEIVE", Open^Error ); CALL Abend; END; CALL Close( Rcv^Num ); END; -- PROC Startup ? PAGE "Open SCP process" --------------------------------------------------------------- Open^SCP - Open the SCP $ZNET p
PAGE 732
Examples SPI Example in TAL ------------------------------------------------------------PROC Init^Cmd^Buffer ( Cmd, ObjType ); INT INT Cmd; ObjType; BEGIN INT MaxResp; SSErr := SSInit ( Spi^Buffer, zMHS^Val^BufLen, MHS^Val^SSID, zSpi^Val^CmdHdr, Cmd, ObjType ); IF (SSErr <> zSpi^Err^OK) THEN BEGIN Write^Term^With^Num ( "SSInit failed", SSErr ); CALL Abend; END; --- Set the zSpi^Tkn^MaxResp token value to -1 to indicate that -- we want as many response records per SPI response as will -- fit in the bu
PAGE 733
Examples SPI Example in TAL Init^Buffer SSErr := zSpi^Val^Initial^Buffer; := SSPutTkn ( Spi^Buffer, zSpi^Tkn^Initial^Position, Init^Buffer ); IF (SSErr <> zSpi^Err^OK) THEN BEGIN Write^Term^With^Num ( "SSPutTkn failed", SSErr ); CALL Abend; END; END; -- PROC Reset^SpiBuf ? PAGE "Send command to OSI/MHS Subsystem" -------------------------------------------------------------- SEND^SPICMD - Send command to OSI/MHS through SCP. --GLOBALS. SCP^fn . File number for SCP process -Spi^Buffer .
PAGE 734
Examples SPI Example in TAL -GLOBALS. Term^Fn . File number of home terminal -Term^Buf . Buffer used for terminal I/O -S^Term^Buf -S^Ptr . Temporary string pointer -Mgr^Tkn^Name . Set to the MHS Manager name -input from the terminal -INPUT. None -OUTPUT. None -------------------------------------------------------------PROC Get^MHSMGR^Name; BEGIN INT INT INT STRING Got^It := zSpi^Val^False; Count^Read; Character^Count; .
PAGE 735
Examples SPI Example in TAL Character^Count BYTES; Got^It := zSpi^Val^True; END; END; END; END; -- while -- PROC Get^MHSMGR^Name ? PAGE "GetResponse^Loop" --------------------------------------------------------------- GetResponse^Loop - Get responses from OSI/MHS iteratively -by sending the command with the context token, until -there is no context token in the response buffer. --GLOBALS. Spi^Buffer . SPI buffer containing the -command to be sent -Spi^Buffer^Copy .
PAGE 736
Examples SPI Example in TAL CALL Reset^SpiBuf; -- Count number of response records in the reply. Token^Id := zSpi^Tkn^DataList; SSErr := SSGetTkn( Spi^Buffer, zSpi^Tkn^Count, Token^Id, 1, DataList^Count ); IF (SSErr <> zSpi^Err^OK) THEN BEGIN Write^Term^With^Num ( "SSGetTkn failed", SSErr ); CALL Abend; END; FOR DataList^Index := 1 TO DataList^Count DO BEGIN -- Open the first response list.
PAGE 737
Examples SPI Example in TAL Objectnm7 [1], Objectnm7 [0] ); zCom^Obj^APPL -> CALL Write( Term^Fn, Objectnm8 [1], Objectnm8 [0] ); zCom^Obj^GATEWAY -> CALL Write( Term^Fn, Objectnm9 [1], Objectnm9 [0] ); zCom^Obj^DLIST -> CALL Write( Term^Fn, Objectnm10 [1], Objectnm10 [0] ); zCom^Obj^DLISTMEMBER -> CALL Write( Term^Fn, Objectnm11 [1], Objectnm11 [0] ); zCom^Obj^CUG -> CALL Write( Term^Fn, Objectnm12 [1], Objectnm12 [0] ); zCom^Obj^CUGMEMBER -> CALL Write( Term^Fn, Objectnm13 [1], Objectnm13 [0] ); zCom^Ob
PAGE 738
Examples SPI Example in TAL END; Objname[0] ); -- for Objname^Index -- Get return token. SSErr := SSGetTkn( Spi^Buffer, zSpi^Tkn^RetCode, RetCode ); IF (SSErr <> zSpi^Err^OK) THEN BEGIN Write^Term^With^Num ( "SSGetTkn failed", SSErr ); CALL Abend; END; -- Get end-list token to close response record.
PAGE 739
Examples SPI Example in TAL -Mgr^Tkn^Name . Contains the MHS Manager -name on entry; used to -construct SPI command -MTA^Add^Params^Map . Token map for ADD MTA -parameters -MTA^Params^Map . Token map for MTA operation -parameters -RetCode . Set to the retcode value in -the SPI response -INPUT. None -OUTPUT. None -------------------------------------------------------------INT PROC Add^MTA; BEGIN INT INT STRING DataList^Index; .ObjName [0:132]; .
PAGE 740
Examples SPI Example in TAL -- Set the ISO country name MTA^Add^Params.zisocountry.zlength MTA^Add^Params.zisocountry.zstring := 2; ':=' "US"; -- Set the ADMD MTA^Add^Params.zadmd.zlength MTA^Add^Params.zadmd.zstring := 8; ':=' "MTA2ADMD"; -- Set the PRMD MTA^Add^Params.zprmd.zlength MTA^Add^Params.zprmd.zstring := 8; ':=' "MTA2PRMD"; --- Initialize the MTA PARAMS structure to null values.
PAGE 741
Examples SPI Example in TAL MTA^Params.zlocpselector2.zlength MTA^Params.zlocsselector2.zlength MTA^Params.zloctselector2.zlength MTA^Params.zlocnsap2.zlength := := := := 0; 0; 0; 0; MTA^Params.zrempselector3.zlength MTA^Params.zremsselector3.zlength MTA^Params.zremtselector3.zlength MTA^Params.zremnsap3.zlength MTA^Params.zlocpselector3.zlength MTA^Params.zlocsselector3.zlength MTA^Params.zloctselector3.zlength MTA^Params.zlocnsap3.zlength := := := := := := := := 0; 0; 0; 0; 0; 0; 0; 0; MTA^Params.
PAGE 742
Examples SPI Example in TAL SSErr := SSPut( Spi^Buffer, MTA^Params^Map, MTA^Params ); IF (SSErr <> zSpi^Err^OK) THEN BEGIN Write^Term^With^Num ( "SSPut failed", SSErr ); CALL Abend; END; CALL Send^SpiCmd; CALL Reset^SpiBuf; -- Open the response data list. -DataList^Index := 1; SSErr := SSGetTkn( Spi^Buffer, zSpi^Tkn^DataList, DataList^Index ); IF (SSErr <> zSpi^Err^OK) THEN BEGIN -- An error occurred opening the response.
PAGE 743
Examples SPI Example in TAL zCom^Err^Secur^Viol -> Write^Term ( "Security violation ADDing MTA" ); zCom^Err^FS^Err -> Write^Term ( "ZCom file system error ADDing MTA" ); zCom^Err^Obj^Alrdy^Def -> Write^Term ( "ZCom object already defined ADDing MTA" ); OTHERWISE -> Write^Term^With^Num ( "SPI retrieval error ADDing MTA", RetCode ); END; -- case -- if SSErr <> zSpi^Err^OK END; RETURN (RetCode); END; -- Add^MTA; ? PAGE "ListObjects Null " --------------------------------------------------------------- LI
PAGE 744
Examples SPI Example in TAL ? PAGE "zMHS Example" --------------------------------------------------------------- Main - main program -Open terminal file -Process startup sequence -Open $ZNET process -Get user input of the MHS manager name -ADD MTA #MTAX, ... object with valid attributes .. -LISTOBJECTS NULL -Close all the opened files -------------------------------------------------------------PROC zMHS^Example MAIN; BEGIN -- Get terminal name and open terminal.
PAGE 745
Examples Load and Compile Definitions Load and Compile Definitions This command file loads all definitions and compiles the files. #push dummy #load/keep 1,loaded #load/keep 1,loaded #load/keep 1,loaded #load/keep 1,loaded #load/keep 1,loaded #load/keep 1,loaded #load/keep 1,loaded #load/keep 1,loaded #pop dummy dummy/ dummy/ dummy/ dummy/ dummy/ dummy/ dummy/ dummy/ $system.zspidef.zspitacl $system.zspidef.zcomtacl $system.zspidef.zemstacl $system.zspidef.zositacl $system.zspidef.zos4tacl $system.
PAGE 746
Examples 1. Create Dictionary 3. Compile EMS template source 4. Create EMS template file 5. Start EMS printing distributor These steps produce a single EMS template containing all OSI/MHS events, customized accounting event templates, and any other subsystem template required. 1. Create Dictionary The following example shows how to create a dictionary that contains all OSI/MHS definitions and all common definitions used by OSI/MHS.
PAGE 747
Examples 2. Create EMS Template Source 9: zmhs-tkn-or-pname-given 10: zmhs-tkn-mid-localid MSG: zmhs-tkn-deliver-result, zspi-val-true "successful" MSG: zmhs-tkn-deliver-result, zspi-val-false "failed" MSG: zems-tkn-eventnumber, 8 "[8] <14> recipient <1>" "<*IF 3>, delivery <4><*ENDIF>" "<*IF 5>, Reason <6> diag <7><*ENDIF>" ": /c=<8>/a=<9>/p=<10>/o=<11>/pn=<2>.
PAGE 748
Examples 3. Compile the EMS Template Source 3. Compile the EMS Template Source You compile the EMS template source using the template compiler, TEMPL, as follows: templ/in xtmpl/otmpl This command creates an EMS object template file. The compiled file is input to the next step. 4. Create EMS Template File You can create a complete EMS template file that includes all templates of any subsystem you want to display, using an event distributor.
PAGE 749
Examples Password Server Example The following example shows the EMS event log. The date and time have been removed from the display. \COMM2.$M11 \COMM2.$M11 \COMM2.$M11 \COMM2.$M11 \COMM2.$M11 \COMM2.$M11 \COMM2.$M11 \COMM2.$M11 \COMM2.$M11 \COMM2.$I11 TANDEM.MHS.C30 000007 [7] Message submitted, Len=1662, Originator: /c=US/a=TELENET/p=DEVICEIND/o=SALES/pn=JAMES.John/, MPDUid: SALES M0000000674581753004 TANDEM.MHS.
PAGE 750
Examples Prerequisites Prerequisites This example requires a password database which consists of the following two SQL tables: MTPWTABL contains MTA password information. The information contained in this table must be entered by some other application or by hand, and includes the following: local MTA and domain names remote MTA and domain names local passwords remote passwords MSPWTABL contains MS password information.
PAGE 751
Examples • Example in C Extracts local and remote MTA names, and optional passwords, from the password database (MTPWTABL SQL table), and processes SPI requests as follows: • • • • Requests: Extracts the password and sends it in the response. Indications/Confirms: Validates the information and sends a reply. Responses: Supplies the response password. Writes an error message, if necessary, to a standard output file.
PAGE 752
Examples * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ Example in C It illustrates the use of the MTA password server interface and the MS password server interface to maintain and authenticate passwords. This example mainly illustrates the tasks involved in decoding the SPI formatted requests, in validating the requests and in formatting the SPI responses. It does not include any additional recommended features, for example, validating the security of processes that open this process.
PAGE 753
Examples Example in C /* constant SSID buffer zmhs_val_ssid_def ZMHS_VAL_SSID; */ /* Host variables for accessing SQL tables MSPWTABL and MTPWTABL int sqlcode; exec sql begin declare section; */ exec sql invoke =mspwtabl as mspwtabl_row_def; exec sql invoke =mtpwtabl as mtpwtabl_row_def; struct mspwtabl_row_def mspwtabl_row; struct mtpwtabl_row_def mtpwtabl_row; exec sql end declare section; /***************************************************************************/ /* FUNCTION PROTOTYPES */ /******
PAGE 754
Examples Example in C if (rcv_bytes_read < 0) { printf ("Error on $RECEIVE : %d\n", errno); exit (EXIT_FAILURE); } /* if (rcv_status) */ else /* no read error */ { if (!valid_spi_request (rcv_buf)) { send_password_response (PASSW_ERROR_RSP, NULL); } else { process_spi_request (rcv_buf); } } /* no read error */ } /* while (1) */ } /* end main */ /***************************************************************************/ /* Function: valid_spi_request */ /* Usage : if (!valid_spi_request) */ /* Parameters
PAGE 755
Examples Example in C (char *)&tkn_ssid_buf); } if (!spi_status && strcmp ((char *)&tkn_ssid_buf.u_z_filler.z_owner, ZSPI_VAL_TANDEM) == 0 && tkn_ssid_buf.z_number == ZSPI_SSN_ZMHS && tkn_ssid_buf.
PAGE 756
Examples Example in C { switch (passw_command.zvalue) { case ZMHS_VAL_PASSW_MS_ADD : process_ms_add_appl (req_buf); break; case ZMHS_VAL_PASSW_MS_ALTER : process_ms_alter_appl (req_buf); break; case ZMHS_VAL_PASSW_MS_DELETE : process_ms_delete_appl (req_buf); break; case ZMHS_VAL_PASSW_MS_BIND : process_ms_bind_appl (req_buf); break; case ZMHS_VAL_PASSW_MS_REGISTER : process_ms_register_appl (req_buf); break; default : printf ("Invalid value in ZMHS_MAP_PASSW_COMMAND %d\n", passw_command.
PAGE 757
Examples Example in C error = SSGET (req_buf_s, (short *)&zmhs_map_local_mta_name, (char *)&local_mta_name); if (error) { printf ("SSGET procedure error - %d\n", error); send_password_response (PASSW_ERROR_RSP, NULL); return; } error = SSGET (req_buf_s, (short *)&zmhs_map_remote_mta_name, (char *)&remote_mta_name); if (error) { printf ("SSGET procedure error - %d\n", error); send_password_response (PASSW_ERROR_RSP, NULL); return; } if (passw_command == ZMHS_VAL_PASSW_MTA_INDICATION || passw_command == ZMH
PAGE 758
Examples } Example in C /* end process_mta_request */ /***************************************************************************/ /* Function: process_ms_add_appl */ /* Usage : process_ms_add_appl (req_buf) */ /* Parameters: req_buf INPUT */ /*-------------------------------------------------------------------------*/ /* Process the ADD APPL request from the MHSMGR. Extract the attributes */ /* from the request, and call add_mspwtabl_row to add the row in MSPWTABL.
PAGE 759
Examples Example in C ua_osi_address.zpselector.zlength ua_osi_address.zsselector.zlength ua_osi_address.ztselector.zlength ua_osi_address.znsap.
PAGE 760
Examples Example in C { printf ("SSGET procedure error - %d\n", error); send_password_response (PASSW_ERROR_RSP, NULL); return; } error = SSGET (req_buf_s, (short *)&zmhs_map_passw, (char *)&passw); if (error == TKN_NOT_PRESENT_ERROR) { error = 0; passw.
PAGE 761
Examples Example in C if (!error) { send_password_response (PASSW_OK_RSP, NULL); return; } else { send_password_response (PASSW_ERROR_RSP, NULL); return; } } /* end process_ms_alter_appl */ /***************************************************************************/ /* Function: process_ms_delete_appl */ /* Usage : process_ms_delete_appl (req_buf) */ /* Parameters: req_buf INPUT */ /*-------------------------------------------------------------------------*/ /* Process the DELETE APPL request from the
PAGE 762
Examples Example in C } else { send_password_response (PASSW_ERROR_RSP, NULL); return; } } /* end process_ms_delete_appl */ /***************************************************************************/ /* Function: process_ms_bind_appl */ /* Usage : process_ms_bind_appl (req_buf) */ /* Parameters: req_buf INPUT */ /*-------------------------------------------------------------------------*/ /* Process the MS-Bind request from the MS process.
PAGE 763
Examples Example in C } if (error) { printf ("SSGET procedure error - %d\n", error); send_password_response (PASSW_ERROR_RSP, NULL); return; } error = validate_bind_password (&appl_name, &passw, &ua_osi_address, &passw_ok); if (error) { printf ("SQL Error accessing MSPWTABL row - %d\n", error); } if (!error && passw_ok) { send_password_response (PASSW_OK_RSP, NULL); return; } else { send_password_response (PASSW_ERROR_RSP, NULL); return; } } /* end process_ms_bind_appl */ /******************************
PAGE 764
Examples Example in C (short *)&zmhs_map_passw, (char *)&passw); if (error) { printf ("SSGET procedure error - %d\n", error); send_password_response (PASSW_ERROR_RSP, NULL); return; } error = SSGET (req_buf_s, (short *)&zmhs_map_old_passw, (char *)&old_passw); if (error) { printf ("SSGET procedure error - %d\n", error); send_password_response (PASSW_ERROR_RSP, NULL); return; } if (!error) { error = alter_mspwtabl_row_passw (&appl_name, &passw, &old_passw, &passw_updated); if (error) { printf ("SQL Error u
PAGE 765
Examples Example in C /* Any SQL error (other than row not found) is returned as the error code. */ /***************************************************************************/ int validate_mta_request (int passw_command, zmhs_ddl_local_mta_name_def *local_mta_name, zmhs_ddl_remote_mta_name_def *remote_mta_name, zmhs_ddl_passw_def *req_passw_in, zmhs_ddl_passw_def *rsp_passw_out, bool *req_valid) { int sql_error; zmhs_ddl_passw_def req_password; sql_error = 0; *req_valid = FALSE; memset (mtpwtabl_row.
PAGE 766
Examples Example in C * row into the response password. */ switch (passw_command) { case ZMHS_VAL_PASSW_MTA_REQUEST : rsp_passw_out->zlength = sizeof (rsp_passw_out->zstring); memcpy (rsp_passw_out->zstring, mtpwtabl_row.our_password, rsp_passw_out->zlength); break; case ZMHS_VAL_PASSW_MTA_INDICATION : *req_valid = STRNEQUAL (mtpwtabl_row.their_password, req_password.
PAGE 767
Examples Example in C memset (&old_password, BLANKS, sizeof (zmhs_ddl_old_passw_def)); memcpy (new_password.zstring, new_passw_in->zstring, new_passw_in>zlength); memcpy (old_password.zstring, old_passw_in->zstring, old_passw_in>zlength); exec sql begin work; /* obtain the old value for the password */ exec sql select password into :mspwtabl_row.password from =mspwtabl where (appl_name = :mspwtabl_row.
PAGE 768
Examples Example in C /* corresponding to the APPL name. If the password and the OSI addresses */ /* match, set passw_valid to TRUE, else set passw_valid to FALSE. */ /* Any SQL error causes passw_valid to be set to FALSE, and the SQL error */ /* code (except row not found) to be returned. */ /* If the OSI address is not present, set the zlength fields in */ /* ua_osi_address to -1.
PAGE 769
Examples Example in C *passw_valid = (*passw_valid && STRNEQUAL (mspwtabl_row.password, password.zstring) && STRNEQUAL (mspwtabl_row.pselector, osi_address.zpselector.zstring) && STRNEQUAL (mspwtabl_row.sselector, osi_address.zsselector.zstring) && STRNEQUAL (mspwtabl_row.tselector, osi_address.ztselector.zstring) && STRNEQUAL (mspwtabl_row.nsap, osi_address.znsap.
PAGE 770
Examples Example in C if (appl_orname->zcommonname.zlength > 0) memcpy (mspwtabl_row.common_name, appl_orname->zcommonname.zstring, appl_orname->zcommonname.zlength); mspwtabl_row.terminal_type = appl_orname->zterminaltype; if (appl_orname->zorgname.zlength > 0) memcpy (mspwtabl_row.org_name, appl_orname->zorgname.zstring, appl_orname->zorgname.zlength); if (appl_orname->zorgunit1.zlength > 0) memcpy (mspwtabl_row.org_unit_1, appl_orname->zorgunit1.zstring, appl_orname->zorgunit1.
PAGE 771
Examples Example in C if (ua_osi_address->zpselector.zlength > 0) memcpy (mspwtabl_row.pselector, ua_osi_address->zpselector.zstring, ua_osi_address->zpselector.zlength); if (ua_osi_address->zsselector.zlength > 0) memcpy (mspwtabl_row.sselector, ua_osi_address->zsselector.zstring, ua_osi_address->zsselector.zlength); if (ua_osi_address->ztselector.zlength > 0) memcpy (mspwtabl_row.tselector, ua_osi_address->ztselector.zstring, ua_osi_address->ztselector.zlength); if (ua_osi_address->znsap.
PAGE 772
Examples Example in C return (sql_error); } /* end add_mspwtabl_row */ /***************************************************************************/ /* Function: alter_mspwtabl_row */ /* Usage : error = alter_mspwtabl_row (appl_name, */ /* passw_in, */ /* appl_orname, */ /* ua_osi_address) */ /* Parameters: appl_name INPUT */ /* passw_in INPUT */ /* appl_orname INPUT */ /* ua_osi_address INPUT */ /*-------------------------------------------------------------------------*/ /* Alter a MSPWTABL row in res
PAGE 773
Examples Example in C } if (appl_orname->zadmd_name.zlength > 0) { memcpy (mspwtabl_row.admd, appl_orname->zadmd_name.zstring, appl_orname->zadmd_name.zlength); } if (appl_orname->zprmd_name.zlength > 0) { memcpy (mspwtabl_row.prmd, appl_orname->zprmd_name.zstring, appl_orname->zprmd_name.zlength); } if (appl_orname->zx121address.zlength > 0) { memcpy (mspwtabl_row.x121_address, appl_orname->zx121address.zstring, appl_orname->zx121address.zlength); } if (appl_orname->zterminalid.
PAGE 774
Examples Example in C if if if if if if if if if if { memcpy (mspwtabl_row.given_name, appl_orname->zgivenname.zstring, appl_orname->zgivenname.zlength); } (appl_orname->zinitials.zlength > 0) { memcpy (mspwtabl_row.initials, appl_orname->zinitials.zstring, appl_orname->zinitials.zlength); } (appl_orname->zgenerationqualifier.zlength > 0) { memcpy (mspwtabl_row.gen_qualifier, appl_orname->zgenerationqualifier.zstring, appl_orname->zgenerationqualifier.
PAGE 775
Examples Example in C memset (mspwtabl_row.pselector, BLANKS, sizeof (mspwtabl_row.pselector)); memcpy (mspwtabl_row.pselector, ua_osi_address->zpselector.zstring, ua_osi_address->zpselector.zlength); } if (ua_osi_address->zsselector.zlength >= 0) { memset (mspwtabl_row.sselector, BLANKS, sizeof (mspwtabl_row.sselector)); memcpy (mspwtabl_row.sselector, ua_osi_address->zsselector.zstring, ua_osi_address->zsselector.zlength); } if (ua_osi_address->ztselector.zlength >= 0) { memset (mspwtabl_row.
PAGE 776
Examples Example in C where (appl_name = :mspwtabl_row.
PAGE 777
Examples Example in C { int error; char rsp_buf [ZMHS_VAL_BUFLEN]; short *rsp_buf_s = (short *)&rsp_buf; int rsp_bytes; zmhs_ddl_passw_status_def passw_status; /* initialize the response buffer error = SSINIT (rsp_buf_s, ZMHS_VAL_BUFLEN, (short *)&ZMHS_VAL_SSID, ZSPI_VAL_CMDHDR, PASSW_CMD); if (error) { printf ("SSINIT procedure error - %d\n", error); exit (EXIT_FAILURE); } */ error = SSNULL ((short *)&zmhs_map_passw_status, (char *)&passw_status); if (error) { printf ("SSNULL procedure error - %d\n", e
PAGE 778
Examples Password Server Database /* Function: open_receive */ /* Usage : rcv_file = open_receive (rcv_depth) */ /* Parameters: rcv_depth INPUT */ /*-------------------------------------------------------------------------*/ /* Open $RECEIVE with a constant RCV_DEPTH. Return the file descriptor */ /* for $RECEIVE. If there is an error, write the error message and abend.
PAGE 779
Examples #SET pws_vol #SET outfile Password Server Database [libvol].t5qpws [pws_vol].sql1o INLPREFIX + sink [#purge [outfile]] SQLCI /INLINE, OUT [outfile], STATUS proc_status, name/ + catalog [sql_catalog]; + purge ! [sql_catalog].* no listall; + drop catalog [sql_catalog]; + create catalog [sql_catalog]; + create table [sql_catalog].
PAGE 780
Examples Password Server Database INLPREFIX + #SET outfile [pws_vol].pwtablc SQLCI /INLINE, OUT $NULL, STATUS proc_status, name/ + invoke [sql_catalog].mspwtabl format c to [outfile] (mspwtabl) clear; + invoke [sql_catalog].
PAGE 781
D Reason and Diagnostic Codes This appendix contains the reason codes and diagnostic codes specified in the CCITT X.411 recommendations. Reason Codes Following are the values for NONDELIVERYREASONCODE as specified in the CCITT X.411 recommendations: (0) Transfer-failure indicates that, while the MTS was attempting to deliver or probe delivery of the subject-message, some communication failure prevented it from doing so.
PAGE 782
Reason and Diagnostic Codes Diagnostic Codes Diagnostic Codes Following are the values for NONDELIVERYDIAGNOSTICCODE as specified in the CCITT X.411 recommendations: (0) Unrecognised-OR-name indicates that the recipient-name argument of the subject does not contain an O/R-name recognized by the MTS. (1) Ambiguous-OR-name indicates that the recipient-name argument of the subject identifies more than one potential recipient (that is, is ambiguous).
PAGE 783
Reason and Diagnostic Codes (10) Diagnostic Codes Implicit-conversion-not-subscribed indicates that a conversion required for the subject-message to be delivered has not been subscribed to by the recipient. (11) Invalid-arguments indicates that one or more arguments in the subject was detected as being invalid. (12) Content-syntax-error indicates that a syntax error was detected in the content of the subject-message (not applicable to subject-probes).
PAGE 784
Reason and Diagnostic Codes (21) Diagnostic Codes Page-split indicates that a conversion required for the subject-message to be delivered would have resulted in loss of information because an original page would be split. (22) Pictorial-symbol-loss indicates that a conversion required for the subject-message to be delivered would have resulted in loss of information because of a loss of one or more pictorial symbols.
PAGE 785
Reason and Diagnostic Codes (31) Diagnostic Codes Physical-rendition-attributes-not-supported indicates that the PDAU does not support the physical-rendition-attributes requested. (32) Undeliverable-mail-physical-delivery-address-incorrect indicates that the subject-message was undeliverable because the specified recipient postal-O/R-address was incorrect.
PAGE 786
Reason and Diagnostic Codes (41) Diagnostic Codes Undeliverable-mail-recipient-changed-address-temporarily indicates that the subject-message was undeliverable because the recipient specified in the recipient postal-O/R-address has changed address temporarily (on travel) and forwarding was not applicable.
PAGE 787
Glossary The following glossary defines terms used in this manual and in other Compaq OSI/MHS manuals. Both industry-standard terms and Compaq terms are included. This list covers Compaq OSI/MHS as a whole; therefore, not all terms given here are used in this particular manual. abstract syntax. A representation of the way in which components of information are to be specified in a communication.
PAGE 788
Glossary archive queue archive queue. A queue to which you can move an object from the input queue during a finish-transfer-in operation requested of the GPI. Typically, undecodable communications are placed on the archive queue for future examination using diagnostic procedures. See also communication. ASE (application service element).
PAGE 789
Glossary attribute value attribute value. The data for specific instance of an attribute. For example, “US” is a possible value of an MH-T-COUNTRY-NAME attribute. BER (Basic Encoding Rules). The standard for an associated transfer syntax (CCITT Recommendation X.209). These rules were defined to provide a transfer syntax for use by ASN.1 compilers. bind. The act of establishing a connection.
PAGE 790
Glossary command/response interface An SPI message, containing a command, sent from an application program to a subsystem. See also response message or event message. command/response interface. In DSM, a management interface that performs operations on subsystem-defined objects. common definition. In DSM programmatic interfaces, a definition (data declaration) used in several commands, responses, or event messages in an SPI interface to a subsystem. common name. In X.
PAGE 791
Glossary context token context token. In DSM programmatic interfaces, a token in an SPI response message that indicates (by its presence or absence) whether or not the response is continued in the following message. control and inquiry. In DSM, those operations that affect or request information about the state or configuration of an object. See also event management. core services.
PAGE 792
Glossary definition definition. A declaration provided by Compaq for use in applications that use a specific procedural interface, such as the APS or SPI procedures. Definitions are commonly provided in definition files. definition files. A set of files containing declarations for use in applications that use a specific procedural interface.
PAGE 793
Glossary element element. See string element. element of service. In OSI, a feature or function defined as part of a service. empty response record. In DSM programmatic interfaces, a response record containing only a return token with a value that means “no more response records.” EMS (Event Management Service). A part of DSM used to provide event collection, event logging, and event distribution facilities.
PAGE 794
Glossary event information about the error. A response record must contain a return token and can also contain error lists to explain the error further. event. In DSM, a significant change in some condition in the system or network. Events can be operational errors, notifications of limits exceeded, requests for action needed, and so on. event log. A file or set of files maintained by EMS to store event messages generated by subsystems. event management.
PAGE 795
Glossary external tracing external tracing. The recording of actions taken by a management domain with respect to a message, probe, or report. See also internal tracing. extensible structured token. In DSM programmatic interfaces, a token consisting of a token code and a value that is an extensible structure. Extensible structures can be extended by adding new fields at the end.
PAGE 796
Glossary GPI (Gateway Programmatic Interface) GPI (Gateway Programmatic Interface). A service that provides X.400 access to proprietary messaging systems through Compaq OSI/MHS. GPI library. The GPI procedural interface. GPI service. The combined function of the GPI library and the GIP. group. A collection of one or more processes and databases that provide a defined set of services. GROUP object.
PAGE 797
Glossary installation procedure installation procedure. The OSI/MHS procedure that creates a default edit file and prompts you to modify that file to fit your configuration requirements. installation subvolume. See ISV. interactive command. In DSM, a command given by a human operator rather than by a program. See also programmatic command. interface. In general, a set of rules by which a person, a program, or a device interacts with a hardware or software product.
PAGE 798
Glossary layer layer. A grouping of related functions in the OSI Reference Model. See Application Layer, Data Link Layer, Network Layer, Physical Layer, Presentation Layer, Session Layer, or Transport Layer. link. A physical and logical path between two adjacent computers or other devices. In OSI/MHS, a pair of OSI addresses that are configured for each MTA. A pair of OSI addresses is a set of local and remote address definitions in the MTA object representing an adjacent MTA. link retry.
PAGE 799
Glossary mailbox count mailbox count. A “snapshot” of the recent activity in your mailbox: number of messages read, number of messages deleted, and so on. mailbox statistics. A historical report of the activity in your mailbox, starting with the previous RESET and continuing until the next RESET. management application. In DSM, an application process that opens a management or subsystem process to control a subsystem.
PAGE 800
Glossary MIB (management information base) MIB (management information base). A database used by the OSI manager to store and retrieve configuration information and information about applications. mnemonic O/R address. An O/R address that identifies a user by terms that are easily remembered. See also numeric O/R address. MON object. An object type, used in OSI/MHS management interfaces, that enables you to address commands to the MHS manager. The MON object name identifies the MHS manager.
PAGE 801
Glossary MTA object MTA object. An object type, used in OSI/MHS management interfaces, that defines adjacent MTAs and their attributes to the OSI/MHS subsystem. MTA process. See MRP. MTS (message transfer system). The part of a message handling system that contains the MTAs and that permits communication between user agents. MTS identifier. A unique identifier that distinguishes a communication from all other communications ever conveyed by the MTS within the MHS. multithreaded process.
PAGE 802
Glossary nonsensitive command nonsensitive command. A DSM command that can be issued by any user or program having access to the target subsystem—that is, a command on which the subsystem imposes no further security restrictions. For Compaq data communications subsystems, the nonsensitive commands are usually information commands (commands that cannot change the state or configuration of objects). See also sensitive command. NonStop Kernel.
PAGE 803
Glossary object management In the GPI, a unique identifier of a particular object generated by the GPI service when the client program creates a new object, copies an object, or reserves an object. The client program passes the object identifier to any GPI procedure operating on the object. A GPI object identifier is not related to an ASN.1 object identifier. object management. A means to operate on messages and their elements as objects. object-name template.
PAGE 804
Glossary OSI/MHS database The Compaq implementation of an X.400 message handling system for Compaq NonStop systems. OSI/MHS database. The database that consists of the registration database and OSI/MHS configuration database. OSI/MHS ISV. The installation subvolume for the OSI/MHS release. The Install process creates this subvolume as ZOSIMHS. OSI/MHS subsystem.
PAGE 805
Glossary P2 message P2 message. An X.400 message that consists of a heading followed by a series of data blocks, called body parts. The heading contains the message originator, recipients, and other service information. Each body part can contain a different form of data, and messages can be nested within body parts. P3 protocol. The X.400 message submission and delivery protocol, which defines a standard for the submission and delivery of messages and the interaction of UAs and MTAs. P7 protocol. The X.
PAGE 806
Glossary port address interface that applications can use by making file-system procedure calls. The PAM subsystem implements, for LANs, the services of the Data Link Layer and layers below. PAM replaces the Tandem LAN Access Method (TLAM) for G06 and later releases. port address. For X25AM lines, the logical port number used to specify the address of the connection to the X.25 network. For TLAM lines, the address used by TLAM to specify the address of the connection to a LAN controller.
PAGE 807
Glossary programmatic command programmatic command. In DSM, a command issued by a program rather than by a human operator. See also interactive command. programmatic interface. A mechanism by which a program can interact with other software. programmed operator. In DSM, a management application that performs functions that might otherwise be performed by a human operator. protocol.
PAGE 808
Glossary remote MTA remote MTA. An adjacent or nonadjacent MTA. Any MTA other than your local OSI/MHS subsystem. Remote Operations Service. See ROSE. remote system. In Compaq terms, any system within an Expand network that is not the local system. remote user agent. See RUA. report. A notification generated by the OSI/MHS subsystem that tells the user whether the message has been sent. request primitive. In OSI, a primitive issued when a service user wants the service to do some work.
PAGE 809
Glossary ROSE (remote operations service element) ROSE (remote operations service element). An Application Layer service definition and protocol supporting interactive applications, implemented by the RS process in OSI/MHS. Examples of ROSE PDUs are: ROIV-APDU Invoke application protocol data unit RORJ-PDU Reject application protocol data unit ROER-APDU Error application protocol data unit RORS-APDU Response application protocol data unit route. A path through an X.
PAGE 810
Glossary RTS (reliable transfer service) process RTS (reliable transfer service) process. A process in the MR group that implements the RTSE protocol and accesses the PDU store to read and write messages. RUA (remote user agent). A user agent that submits and retrieves messages through a message store and resides on a system or device other than the system that provides the message store. See also LUA. SAP (service access point).
PAGE 811
Glossary service service. A set of primitives (operations) that an OSI layer provides to the layer above it. The service defines what operations the layer can perform on behalf of its users, but not how these operations are implemented. A service relates to an interface between two layers, with the lower layer being the service provider and the upper layer being the service user. See also protocol. The GPI and P7 API are examples of services available to applications.
PAGE 812
Glossary softdoc softdoc. A text file in EDIT-file (code 101) format that is part of a software product version or an interim product modification (IPM) in the same subvolume. A softdoc provides information about new product features and sometimes contains information not included in product manuals. SPI (Subsystem Programmatic Interface).
PAGE 813
Glossary string segment string segment. A portion of a string value consisting of zero or more contiguous octets of its representation. subject. In event management, a device, process, or other named entity about which a given event message has information. subnetwork. In general, a network that participates in a larger network, possibly through the use of gateways or bridges. In OSI, one or more intermediate systems that provide relaying and through which end systems may establish network connections.
PAGE 814
Glossary symbolic name names of which appear on the last part of the packing list. The SUT contains the DSVs for OSI/MHS and other products. symbolic name. In DSM programmatic interfaces, a name used in programs to refer to commonly used values, token codes, token maps, extensible structures, and other related variables for use in management programs. syntax. See attribute syntax. SYSGEN.
PAGE 815
Glossary token code the SSGET procedure. A token has two parts: an identifying code, or token code, and a token value. In command and response messages, a token normally represents a parameter to a command, an item of information in a response, or control information for the subsystem. In event messages, a token normally represents an item of information about an event or about the event message itself. See also header token. token code.
PAGE 816
Glossary TSAP (transport service access point) TSAP (transport service access point). A logical location between the Transport and Session Layers, through which transport services are made available to local users, and through which session services are made available to remote systems. TSEL (transport selector). An address between the Transport and Session Layers, through which connections are established and maintained.
PAGE 817
Glossary working subvolume characters can appear: ? for a single character and * for zero, one, or more consecutive characters. In O/R name attributes, a single asterisk in place of the attribute indicates “not used.” In the X121-ADDR and NUMERIC-USER-ID attributes of the ADD APPL, ALTER APPL, ADD ROUTE, and ALTER ROUTE commands, a single asterisk (*) can substitute for the trailing characters of the attribute value, and the double asterisk (**) can substitute for the entire value.
PAGE 818
Glossary $RECEIVE OSI/MHS Management Programming Manual—424824-001 Glossary-32
PAGE 819
Index A Abbreviations Abbreviations-1 ABORT APPL command 5-9/5-10 operational note 5-10 tokens in command buffer 5-9 tokens in response buffer 5-10 ABORT CLASS command 5-11/5-12 operational notes 5-12 tokens in command buffer 5-11 tokens in response buffer 5-12 ABORT GROUP command 5-13/5-14 operational notes 5-14 tokens in command buffer 5-13 tokens in response buffer 5-14 ABORT MON command 5-15/5-16 operational notes 5-16 tokens in command buffer 5-15 tokens in response buffer 5-16 ABORT SUBSYS command 5-1
PAGE 820
Index A ADD DLISTMEMBER command 5-65/5-66 invalid O/R name (error 14) A-17 operational notes 5-66 tokens in command buffer 5-65 tokens in response buffer 5-66 ADD GATEWAY command 5-67/5-70 duplicate P1-EXIT (error 20) A-23 duplicate PNAME (error 19) A-22 operational notes 5-70 tokens in command buffer 5-67 tokens in response buffer 5-70 ADD GROUP command 5-71/5-84 duplicate CPU (error 21) A-24 invalid priority (error 17) A-20 no parent object (error 7) A-10 operational notes 5-83 OSI address already exist
PAGE 821
Index A ALTER APPL command (continued) tokens in response buffer 5-119 ALTER CLASS command 5-120/5-121 operational notes 5-120 tokens in command buffer 5-120 tokens in response buffer 5-120 ALTER CUG command 5-122/5-123 operational notes 5-123 tokens in command buffer 5-123 tokens in response buffer 5-123 ALTER CUGMEMBER command 5-124 operational notes 5-124 tokens in command buffer 5-124 tokens in response buffer 5-124 ALTER DLIST command 5-125 invalid O/R name (error 14) A-17 operational notes 5-125 syn
PAGE 822
Index B APPL objects (continued) ADD 5-21 ALTER 5-119 DELETE 5-137/5-138 INFO 5-157/5-158 LISTOBJECTS 5-180 START 5-230/5-231 STATUS 5-242/5-251 STOP 5-283/5-284 SUSPEND 5-293/5-294 description 1-11 errors ACCESS-NAME name invalid (error 13) A-16 cannot alter GW attribute (error 18) A-21 cannot be deleted (error 2) A-5 cannot be stopped (error 3) A-6 invalid O/R name (error 14) A-17 MS password server error (error 16) A-19 no parent object (error 7) A-10 O/R name already exists (error 12) A-15 name format
PAGE 823
Index C Beginning See ACTIVATE command, START command BEGINTRANSACTION failed… (MPS error) 7-45 bilaterallyDefinedBodyParts attribute, X.400 See ZBIL-DEF-BODY-PART field Bind request validation by MPS 7-22/7-23 Bind requests permitting in MPS 7-38 blindCopyRecipients attribute, X.400 See ZBLIND-COPY-RECIPS field Body attribute, X.
PAGE 824
Index C Compiling password server example C-30 Conditional tokens in events 6-4 Configuration and control components 1-7 Configuration database, MPS 7-25/7-26 Configuration problem (event 22) 6-84/6-88 Configuration problem, fatal (event 24) 6-94/6-97 Configuration, MPS modifying 7-42/7-44 modifying dynamically 7-37 Consumer distributor 1-10 Content attribute, X.
PAGE 825
Index D CUGMEMBER objects commands for ADD 5-60/5-61 ALTER 5-124 DELETE 5-142 INFO 5-163 LISTOBJECTS 5-184 description 1-12 name format 4-6/4-8 relationship to other objects 1-15 summary state 4-10 cugmember variable 4-7 D Data declaration files 3-1 Data Definition Language (DDL) See ZMHS-DDL- definitions Data encryption, MPS 7-27, 7-39 Data lists 3-5 Data packet size See ZCHKPNT-SIZE field Data packets to be sent See ZSAFE-STORE-WNDW field Data transfer See ZMAX-MSG-XFER-TIME field, ZWNDW-SIZE field Dat
PAGE 826
Index D DELETE GATEWAY command 5-145 object in use (error 6) A-9 syntax and notes 5-145 tokens in command buffer 5-145 tokens in response buffer 5-145 DELETE GROUP command 5-146/5-147 object in use (error 6) A-9 operational notes 5-146 syntax and notes 5-146/5-147 tokens in command buffer 5-146 tokens in response buffer 5-146 DELETE MTA command 5-148 child object exists (error 8) A-11 operational notes 5-148 syntax and notes 5-148 tokens in command buffer 5-148 tokens in response buffer 5-148 DELETE ROUTE
PAGE 827
Index E Domain names See ZADMD-NAME field, ZPRMDNAME field DSM (Distributed Systems Management) commands 1-16, 1-17/1-21 event and accounting messages 1-21 management functions 1-16/1-17 object hierarchy 1-15/1-16 object types 1-10/1-15 overview 1-1/1-4 Duplicate message… (event 34) 6-126/6-131 Duplicate O/R name (error 24) A-27 Duplicate suppression See ZDUPL-SUPRN field, ZDUPLSUPRN-WINDOW field E EMS (Event Management Service) compiling templates C-28 customizing templates C-25/C-29 definition of 1-3 d
PAGE 828
Index F Establishing See ACTIVATE command, START command Event log 1-9 Event messages See Messages, event, EMS (Event Management Service), ZMHS-EVTevents Event-management interface 1-8/1-10 expiryTime attribute, X.
PAGE 829
Index H GETVERSION MON command (continued) tokens in response buffer 5-152 GETVERSION NULL command 5-153/5-154 operational note 5-154 tokens in command buffer 5-153 tokens in response buffer 5-154 GETVERSION PROCESS command 5-155/5-156 operational note 5-156 tokens in command buffer 5-155 tokens in response buffer 5-156 GI fields See ZGI-BACKUP field, ZGI-CPU field, ZGI-PNAME field, ZGI-PRI field GIP (gateway interface) process 1-4 Given names See ZGIVENNAME field GPI (gateway programmatic interface) 1-5
PAGE 830
Index I I IA5 text messages See ZDEL-EIT-IA5TEXT field Illegal attempt to alter PARAM… (MPS warning) 7-59 importance attribute, X.
PAGE 831
Index K Interfaces (continued) MS password server 7-8/7-19 MS password server interface 1-22 MTA password server 7-1/7-8 MTA password server interface 1-22 programmatic (DSM) 1-3 Internal error… (event 1) 6-6/6-8 Invalid ACCESS-NAME (error 13) A-16 Invalid field combination (error 9) A-12 Invalid node name (error 11) A-14 Invalid PARAM… (MPS error) 7-48 Invalid password attempt… (event 19) 6-80 Invalid PASSW-COMMAND token… (MPS warning) 7-60 Invalid priority (error 17) A-20 Invalid state for trace (error
PAGE 832
Index M LISTOBJECTS MON command 5-191/5-192 operational notes 5-192 tokens in command buffer 5-191 tokens in response buffer 5-192 LISTOBJECTS MTA command 5-193 operational notes 5-193 tokens in command buffer 5-193 tokens in response buffer 5-193 LISTOBJECTS NULL command 5-194/5-195 operational notes 5-195 tokens in command buffer 5-194 tokens in response buffer 5-195 LISTOBJECTS null command example in TAL C-23 LISTOBJECTS PROCESS command 5-196/5-197 operational notes 5-197 tokens in command buffer 5-19
PAGE 833
Index M Management programming (continued) overview 1-1/1-4 password server interfaces 1-22 processes, types of 1-4/1-10 programming elements 3-3/3-5 receiving responses 3-7/3-8 security 3-8 segmented responses 2-2 subsystem architecture 1-6 templates and labels 3-11 using SCP 2-1/2-2 Zxxx naming convention 3-11 Mandatory PARAM MPS-AUDIT-FILE… (MPS warning) 7-61 Mandatory PARAM…not specified (MPS error) 7-48/7-49 Master password server See MPS (master password server) Master user access to mailboxes 7-21
PAGE 834
Index M Messages, event (continued) common tokens, table of 6-3/6-4 description of interface 1-2 error lists in 6-5 management considerations 3-10/3-11 notation used to describe 6-5 numbers for 3-5 overview 1-21 relationship to console messages 6-5 retrieving and decoding 3-9/3-10 running a consumer distributor 2-3 See also ZMHS-EVT- events templates 3-11 tokens in 6-4 Messages, nonurgent See ZNONURGENT-COUNT field, ZNONURGENT-ROUTE-RETRYDELAY field, ZNONURGENTROUTE-RETRY-TIME field, ZNONURGE 1-1 Messages
PAGE 835
Index M MPS (master password server) alternative configurations load sharing 7-28/7-29 multiple master users 7-30 concepts and components audit-trail file 7-23/7-25 authorization database 7-26/7-27 basic configuration 7-20/7-21 configuration database 7-25/7-26 data encryption methods 7-27 MPS process 7-21 MS bind password server interface 7-28 output file 7-27 using PATHCOM or TACL 7-28 validating SPI requests 7-22/7-23 error messages 7-45/7-53 informational messages 7-53/7-56 installation file 7-35 maste
PAGE 836
Index M MPS-MASTER-APPL altered… (MPS info message) 7-56 MR group still in use (error 25) A-28 MR groups dynamically reallocated 6-210, 6-214 MRP fields See ZMRP-BACKUP field, ZMRP-CPU field, ZMRP-PNAME field, ZMRP-PRI field MRP (message relay process) 1-4, 7-1/7-8 MS access-type attributes 5-44 MS bind request, validation by MPS 7-22/7-23 MS cannot process PDU… (event 20) 6-81 MS group has no MR groups configured (error 29) A-32 MS groups reassigned to new MR groups 6-210, 6-214 MS operation performed… (
PAGE 837
Index N MTA password server interface (continued) example in C data declarations C-32/C-33 function prototypes C-33/C-34 open $RECEIVE, send reply C-58 overview of tasks C-30 prerequisites C-29/C-30 process MTA request C-36/C-38 process SPI request C-35/C-36 program description C-31/C-32 send response C-56/C-57 validate MTA bind request C-45/C-46 validate SPI request C-34/C-35 example macro for SQL files C-58/C-60 programming considerations 7-7 purpose 7-1 MTA password server not configured (event 32) 6-1
PAGE 838
Index O Objects (continued) object-name token 3-4 object-type token 3-4 overview of types 1-11/1-15 See also individual object types symbolic names for 3-4 symbolic names, table of 5-3/5-4 types and names 4-5 types, table of 4-5 obsoletedIpms attribute, X.
PAGE 839
Index P P P1-EXIT GATEWAY object 1-13 PARAM messages 2-3 parentSequenceNumber attribute, X.
PAGE 840
Index R Pool allocation See ZCMK-MAP- structure identifiers, STATS-MEM POPULATE, MPS MODE value 7-37 POSITION to end of…failed… (MPS error) 7-51 Predefined tokens, OSI/MHS 4-32/4-34 Predefined values common SPI extensions 4-4 operating system 4-29 SPI 4-3 primaryRecipient attribute, X.
PAGE 841
Index R READ of MPS-AUTH-DB failed… (MPS warning) 7-63 READ of…failed… (MPS error) 7-51 READUPDATE failed… (MPS error) 7-52 READUPDATE of MPS-AUTH-DB failed… (MPS warning) 7-63 READUPDATE on $RECEIVE… (MPS error) 7-52 Reason codes D-1 RECEIVE not open (MPS error) 7-45 Received SPI request from… (MPS warning) 7-63 RECONFIGURE, MPS MODE value 7-37 Register bind request, validation by MPS 7-22/7-23 Register requests, permitting in MPS 7-38 Registration event… (event 9) 6-54/6-55 relatedIpms attribute, X.
PAGE 842
Index S ROUTE objects (continued) LISTOBJECTS 5-199 description 1-15 LISTOBJECTS command 5-199 name format 4-6/4-8 no parent object (error 7) A-10 relationship to other objects 1-15 summary state 4-10 route variable 4-8 ROUTEDB trace keyword 5-298 Routing to… (event 44) 6-180/6-187 RS fields See ZRS-BACKUP field, ZRS-CPU field, ZRS-PNAME field, ZRS-PRI field RS (remote operations service) process 1-4 RTS fields See ZRTS-BACKUP field, ZRTS-CPU field, ZRTS-PNAME field, ZRTS-PRI field RTS (reliable transfer
PAGE 843
Index S SPI (Subsystem Programmatic Interface) (continued) error handling 3-8 event and accounting messages 1-21 event management 3-10/3-11 events, retrieving 3-9/3-10 example program in TACL error handling C-5 initialize parameters C-3/C-5 main routine C-6 using SCP C-5/C-6 variable definitions C-2/C-3 example program in TAL add MTA C-18/C-23 error handling C-22 get response C-15/C-18 globals, literals, and defines C-7/C-10 initialize parameters C-19/C-21 main program C-24 send command C-13/C-15 startup
PAGE 844
Index S Starting process error (event 3) 6-14/6-15 STARTING summary state 4-9 STATISTICS MON command 5-239 operational notes 5-239 tokens in command buffer 5-239 tokens in response buffer 5-239 STATISTICS PROCESS command 5-240/5-241 operational notes 5-241 tokens in command buffer 5-241 tokens in response buffer 5-241 STATUS APPL command 5-242/5-251 operational notes 5-251 tokens in command buffer 5-243 tokens in response buffer 5-244/5-250 STATUS CLASS command 5-252/5-254 operational note 5-254 tokens in
PAGE 845
Index T SUBSYS objects child object exists (error 8) A-11 commands for ABORT 5-17/5-18 ADD 5-110/5-118 ALTER 5-135 DELETE 5-150 INFO 5-178/5-179 LISTOBJECTS 5-200 START 5-236/5-237 STATUS 5-281/5-282 STOP 5-291 description 1-15 name format 4-6/4-8 relationship to other objects 1-15 summary states 4-10 subsys variable 4-8 Subsystem Control Facility See SCF (Subsystem Control Facility) Subsystem Control Point See SCP (Subsystem Control Point) Subsystem Programmatic Interface See SPI (Subsystem Programmatic
PAGE 846
Index U TIF0/G4-CLASS-1 messages See ZDEL-EIT-TIF0 field TIF1/MIXED-MODE messages See ZDEL-EIT-TIF1 field timestamp field, MPS audit trail 7-24 TMF (Transaction Monitoring Facility), use by MPS 7-26, 7-27 Tokens codes and types, table of B-1/B-5 command/response header tokens, table of 5-7 common SPI definitions, table of 4-2/4-4 definition 3-1 event header and data-portion, table of 6-3/6-4 event, types of 6-4 extensible structured, initializing caution 3-6 maps, table of B-5 response-type 3-8 Tokens, ex
PAGE 847
Index V V Validation by MPS 7-22/7-23 Value names defined by common SPI extensions 4-5 defined by SPI 4-4 Version levels See GETVERSION command Video text messages See ZDEL-EIT-VIDEOTEXT field ViewPoint utility 1-3 Voice messages See ZDEL-EIT-VOICE field W Warning handling 3-8 Warning… (event 2) 6-9/6-10 Wild-card notation 3-5 Write of MPS-AUTH-DB failed… (MPS warning) 7-64 Write to MPS-CONF-DB failed… (MPS error) 7-53 WRITEUPDATE of MPS-AUTH-DB failed… (MPS warning) 7-64 X X121-ADDR and NUMERIC-USERIDE
PAGE 848
Index Z ZCMK-DDL- definitions (continued) STATS-MEM 5-211 STATS-OPNR 5-211 STATS-RECV 5-211 ZCMK-MAP- structure identifiers ALTER description 5-131 syntax 5-130 INFO description 5-171/5-172 syntax 5-170 LISTOP description 5-202 syntax 5-201 STATS-BUF description 5-213/5-214 syntax 5-211, 5-239 STATS-MEM description 5-212/5-213 syntax 5-211, 5-239 STATS-OPNR description 5-215 syntax 5-211, 5-239 STATS-RECV description 5-214/5-215 syntax 5-211, 5-239 ZCMK-TKN- tokens ALTER-BKUP-CPU description 5-131 CMD-COD
PAGE 849
Index Z ZCNT-O-ASS-RJ field 5-223 ZCNT-O-TX-FAIL field 5-224 ZCNT-PROTOCOL-ERR field 5-224 ZCNT-P-ABORT field 5-224 ZCNT-P-EXCEPT field 5-224 ZCNT-RECOV-TO field 5-224 ZCNT-RX-BYTE field 5-223/5-227 ZCNT-RX-MSG field 5-223/5-227 ZCNT-RX-PROBE field 5-222 ZCNT-RX-REPORT field 5-222 ZCNT-RX-UMPDU field 5-221 ZCNT-TRANS-TO field 5-224 ZCNT-TX-BYTE field 5-223/5-227 ZCNT-TX-MSG field 5-223/5-227 ZCNT-TX-PROBE field 5-222 ZCNT-TX-REPORT field 5-222 ZCNT-TX-UMPDU field 5-222 ZCNT-UA-CANCEL field 5-221 ZCNT-UA-D
PAGE 850
Index Z ZCOM-TKN- tokens (continued) INFO GROUP command 5-169 INFO MON command 5-173 INFO MTA command 5-175 INFO ROUTE command 5-177 INFO SUBSYS command 5-179 RESETSTATS MON command 5-215 RESETSTATS PROCESS command 5-229 STATISTICS MON command 5-239 STATISTICS PROCESS command 5-241 OBJNAME 5-9, 5-10 definition in errors A-4 description in commands 4-5 description in events 6-54 OBJSTATE 5-282 OBJTYPE 4-6, 5-10, 6-54, 6-80, 6-182, A-4 PARAM-ERR A-12, A-14 SEL-SUMSTATE 5-10 SUB 3-7, 5-12 SWITCH-CPU 5-295 ta
PAGE 851
Index Z ZDEL-MAX-CONT-LEN field 5-30 ZDEL-MSG-ALLOWED field 5-37 ZDEL-PRIVATE-OCTET field 5-31, 5-36 ZDEL-REPORT-ALLOWED field 5-37 ZDEL-UNDEFINED-OCTET field 5-31, 5-36 ZDEL-UNIDENTIFIED field 5-33 ZDEL-UNTID-ISO646 field 5-31, 5-35 ZDEL-UNTID-OCTET field 5-31, 5-35 ZDEL-UNTID-T61 field 5-31, 5-35 ZDIALOG-MODE field 5-92 example in TACL C-3 example in TAL C-20 ZDIRECTION field 5-277 ZDLIST field 5-112 ZDLIST-EXPANSION field 5-115 ZDLMEM field 5-112 ZDOMAINDEFINEDTYPE1-4 fields 5-30, 5-108 ZDOMAINDEFINEDV
PAGE 852
Index Z ZGPI-VAL- descriptions (continued) USESEGMENT-FAILURE (7000) 6-6 VAL-NOT-INIT (7116) 6-12 ZGRD-TKN- tokens general description 4-29 OBJECTFILE 4-18 ZGROUP-DEFINED-CNT field 5-254 ZGROUP-OBJ-NAME field 5-259 ZGROUP-RECOV-CNT field 5-254 ZGROUP-STARTED-CNT field 5-253 ZGROUP-STARTING-CNT field 5-253 ZGROUP-STOPPED-CNT field 5-253 ZGROUP-STOPPING-CNT field 5-253 ZGROWTH-CNT field 5-213, 5-214 ZGROWTH-TIME field 5-213, 5-214 ZGW-MAX-TIME-EXPIRED field 5-68 ZHEADING field 5-37, 5-245 ZIDQCOUNT field 5-
PAGE 853
Index Z ZMAX-MSG-LEN field 5-93 example in TACL C-3 example in TAL C-20 ZMAX-MSG-SIZE field 5-57 ZMAX-MSG-XFER-TIME field 5-51 ZMAX-OT-DATA-SIZE field 5-228 ZMAX-OT-ENTRIES field 5-228 ZMDQCOUNT field 5-274 ZMEM-SWAPVOL field 5-172 ZMESSAGE-Q-LENGTH field 5-280 ZMHS-DDL- definitions ACCOUNTING-PARAMS 5-110 APPL-DEL-PARAMS 5-23 APPL-DUPL-SUPRN 5-25 APPL-NAME 7-11 APPL-ORNAME 5-22, 7-11 APPL-OSI-ADDR 5-25 APPL-QUEUE 5-268 ASSOC-INFO 5-269 CUG-PARAMS 5-56 DB-FNAMES 5-110 DLIST-PARAMS 5-62 extensible structur
PAGE 854
Index Z ZMHS-DDL- definitions (continued) UA-OSI-ADDRESS 7-11 ZMHS-ERR- errors ALTER-GW-APPL (error 18) A-21 APPL-LOG (error 3) A-6 APPL-MSG (error 2) A-5 APPL-USE (error 6) A-9 BAD-GROUP-SUMSTATE (error 23) A-26 CHILD-OBJ-EXISTS (error 8) A-11 DUPL-GW-PNAME (error 19) A-22 DUPL-P1-EXIT-GW (error 20) A-23 DUP-OR-NAME (error 12) A-15 DUP-OSI-ADDR (error 10) A-13 GROUP-USE (error 25) A-28 INVALID-PRI (error 17) A-20 INVAL-OR-NAME (error 14) A-17 INV-ACCESS-NAME (error 13) A-16 INV-APPL-ADDR (error 15) A-18
PAGE 855
Index Z ZMHS-EVT- events (continued) INVALID-PASSWORD (event 19) 7-8, 7-18, 7-19 IO-ERR 6-72 IO-ERR (event 12) 7-8, 7-18, 7-19 MR-GRP-CHANGE 6-210 MS-DIAGNOSTIC 6-81 MTA-PW-SVR-ERR 6-124/6-125 MTA-PW-SVR-ERR (event 33) 7-8 NO-MEM 6-83 NO-MTA-PW-SVR 6-123 NO-MTA-PW-SVR (event 32) 7-8 PROC-FAIL 6-79 PROC-START-FAIL 6-14/6-15 See also EMS (Event Management Service) SPI-BAD-OCCURS 6-74 SPI-SHORT 6-75 SPI-SSCALL 6-76/6-77 SQL-ERR 6-104 UNROUTE 6-16/6-24 UNROUTE-RECIP 6-25/6-33 ZMHS-EVT-ACCT-xxx event tokens 4-
PAGE 856
Index Z ZMHS-MAP- structure identifiers (continued) DLMEM-ORNAME syntax 5-65, 5-126, 5-144, 5-166, 5-186 FU-QUEUE description 5-274 syntax 5-268 GATEWAY-PARAMS description 5-68 syntax 5-67, 5-127, 5-167 GI-CLASS-PARAMS description 5-54 syntax 5-48, 5-120, 5-159 GI-PARAMS description 5-82/5-83 syntax 5-73, 5-128, 5-168 GLOBAL-ADD-PARAMS description 5-116/5-117 syntax 5-111, 5-135, 5-178 GROUP description 5-74/5-75 syntax 5-71, 5-128, 5-168 GW-AUX-PNAME syntax 5-67, 5-127, 5-167 GW-PNAME syntax 5-67, 5-127,
PAGE 857
Index Z ZMHS-MAP- structure identifiers (continued) syntax 7-11 PASSW description 7-6, 7-7, 7-14 syntax 7-4 PASSW-COMMAND description 7-4 syntax 7-3 PASSW-SERVICE description 7-4, 7-12 syntax 7-3 PASSW-STATUS description 7-6 syntax 7-4 PROC-DATA description 5-118 syntax 5-111, 5-135, 5-178 REMOTE-MTA-NAME description 7-5/7-6 ROUTE-RSLT-PARAM description 5-108 syntax 5-103, 5-134, 5-176 ROUTE-SEL-PARAM description 5-104/5-108 syntax 5-102, 5-134, 5-176 RS-CLASS-PARAMS description 5-54 syntax 5-48, 5-120, 5
PAGE 858
Index Z ZMHS-MAP- structure identifiers (continued) syntax 5-270 STATUS-MRP description 5-273 syntax 5-268 STATUS-MS description 5-272 syntax 5-267 STATUS-MS-APPL description 5-244 syntax 5-242 STATUS-RS description 5-278, 5-278/5-279 syntax 5-270 STATUS-RTS description 5-275 syntax 5-269 STATUS-SC description 5-278 syntax 5-270 table of B-5 TRACE-STATUS description 5-265, 5-272/5-273, 5-275, 5-278, 5-279, 5-280 syntax 5-263, 5-267, 5-268, 5-269, 5-270, 5-271 UA-OSI-ADDRESS description 7-15/7-16 syntax 7-
PAGE 859
Index Z ZMHS-TKN- tokens (continued) KERNEL 4-14, 6-6, 6-9 KIND 4-13, 6-34 LINE 4-14, 6-7, 6-9 LOC-NSAP 6-91, 6-95, 6-100, 6-134 LOC-OSI-DATA 6-91, 6-95, 6-99 LOC-PSEL 6-91, 6-95, 6-100, 6-134 LOC-SSEL 6-91, 6-95, 6-100, 6-134 LOC-TSEL 6-91, 6-95, 6-100, 6-134 LOC-xxx 4-21 LOOP-DETECTED 6-7 MID-ADMD 4-22, 6-19, 6-212 MID-COUNTRY 4-22, 6-19, 6-212 MID-LOCALID 4-22, 6-19, 6-212 MID-PRMD 4-22, 6-19, 6-213 MODULE 4-14, 6-6, 6-9 MSG-CONTENT-SZ 4-23, 6-40, 6-59, 6-67 MSG-SEQ-NUMBER 4-23, 6-59, 6-212 MSG-SIZE 4-
PAGE 860
Index Z ZMHS-TKN- tokens (continued) REM-PSEL 4-27, 6-92, 6-96, 6-100, 6-134 REM-SSEL 4-27, 6-92, 6-96, 6-100, 6-134 REM-TSEL 4-27, 6-92, 6-95, 6-100, 6-134 REROUTE-ATTEMPT 4-28, 6-183 RES-CONDITION 6-208 RES-ID 6-209 RES-SUBSYS 6-208 RES-THRESHOLD 6-208 RES-USAGE 6-208 ROUTE-PRI 4-28, 6-185 ROUTING-FSM-TRACE 4-28, 6-183 R-TERM-ID 6-49 SQL-ERROR 4-16, 6-104 STORE-ACTION 4-28, 6-58 SUBCODE 4-14, 6-10 SUBSYS 4-14, 6-6, 6-9 SUB-MID-ADMD 4-28, 6-20 SUB-MID-COUNTRY 4-28, 6-20 SUB-MID-LOCALID 4-28, 6-20 SUB-MID
PAGE 861
Index Z ZMHS-VAL- descriptions (continued) PASSW-MTA-xxx 7-4 PASSW-xxx 7-6, 7-7 PASSW-xxx (0-1) 6-124 PRIORITY-xxx 5-258 PRI-xxx (0-2) 6-23, 6-43, 6-114 PRI-xxx (0-4) 4-27 STORE-xxx (0-1) 6-58 table of 4-32/4-34 TERMINAL-xxx 5-28 TERMINAL-xxx (1-6) 4-26, 6-21 TM-xxx 5-79 TRANS-CLASS-xxx (0-4) 6-18 TRANS-CLASS-xxx (0-5) 4-29 TRANS-DIRECTION-xxx (0-1) 4-29, 6-138 UNRT-xxx (0-6) 6-19 UNRT-xxx (0-8) 4-15 VINTAGE-xx 5-68 ZMHS-VAL- tokens NEW-MSG-STATE 6-212 ZMPDUID-ADMD field 5-258 ZMPDUID-COUNTRY field 5-258
PAGE 862
Index Z ZNUMERICUSERIDENTIFIER field 5-28, 5-106 ZNUM-ASSOCS field 5-54 ZNUM-RTE-ATTEMPTS field 5-259 ZNUM-SESSIONS field 5-54 ZOBSOLETED-IPMS field 5-40, 5-247 ZOPEN-RETRY-THRESHOLDTIME field 5-51 ZORGNAME field 5-28, 5-106 ZORGUNIT1-4 fields 5-29, 5-107 ZORIGINATOR field 5-40, 5-247 ZORIGINATOR-NAME field 5-41, 5-248 ZOSI-MGR field 5-118 ZOSI-xxx definitions 4-30 ZOUR-LOGON field 5-92 example in TACL C-3 example in TAL C-20 ZOUR-LOGON-RSP field 5-96 example in TACL C-3 example in TAL C-20 ZOUTBOUND-PROB
PAGE 863
Index Z ZREPLIED-TO-IPMS field 5-40 ZREPLY-RECIPS field 5-40, 5-247 ZREPLY-TIME field 5-40, 5-247 ZREPORT-DELIVER field 5-114 ZREPORT-GEN field 5-114 ZREPORT-RELAY field 5-114 ZREPORT-ROUTE-RETRY-DELAY field 5-53 ZREPORT-ROUTE-RETRY-GROW field 5-53 ZREPORT-ROUTE-RETRY-TIME field 5-53 ZREP-DEL-ENVELOPE field 5-38, 5-246 ZRESET-TIME field 5-213, 5-214, 5-215, 5-220, 5-221, 5-222, 5-225, 5-226, 5-227 ZROUTE field 5-112 ZROUTE-PRIORITY field 5-109 ZRS-BACKUP field 5-80 ZRS-CPU field 5-80 ZRS-PNAME field 5-80
PAGE 864
Index Special Characters ZSUBJ-SUBMISSION-ID field 5-39, 5-246 ZSUBMIT-RECIP-INFO field 5-114 ZSUB-LOWEST-PRE field 5-37 ZSUB-LOWEST-PRI field 5-37 ZSUB-MAX-CONT-LEN field 5-36 ZSUB-MSG-ALLOWED field 5-37 ZSUB-PROBE-ALLOWED field 5-37 ZSUB-REL-TRANSFER field 5-42 ZSURNAME field 5-29, 5-107 ZTERMINALID field 5-27, 5-105 ZTERMINALTYPE field 5-28, 5-106 ZTHIS-IPM field 5-39, 5-246 ZTHIS-RECIP-NAME field 5-41 ZTOTAL-PDUS-DELETED field 5-225 ZTRACE-FILE field 5-265 ZTRACE-OPTIONS field 5-265 ZTRACE-STATUS fiel