OSI /MHS SCF Reference Manual

Transcription

1 OSI /MHS SCF Reference Manual Abstract This manual describes how to use the Subsystem Control Facility (SCF) interactive interface to configure and control a Compaq Open System Interconnection/Message Handling System (OSI/MHS) subsystem. This manual also describes how to use the PTrace program to display trace files. This manual is intended for operators, network managers, and application programmers. 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 December 1999

2 Document History Part Number Product Version Published OSI/MHS C32 March OSI/MHS D20 September OSI/MHS D21 May OSI/MHS D22 June OSI/MHS D41 February OSI/MHS D42 December 1999 Ordering Information For manual ordering information: domestic U.S. customers, call ; international customers, contact your local sales representative. Document Disclaimer Information contained in a manual is subject to change without notice. Please check with your authorized representative to make sure you have the most recent information. Export Statement Export of the information contained in this manual may require authorization from the U.S. Department of Commerce. Examples Examples and sample programs are for illustration only and may not be suited for your particular purpose. The inclusion of examples and sample programs in the documentation does not warrant, guarantee, or make any representations regarding the use or the results of the use of any examples or sample programs in any documentation. You should verify the applicability of any example or sample program before placing the software into productive use. U.S. Government Customers FOR U.S. GOVERNMENT CUSTOMERS REGARDING THIS DOCUMENTATION AND THE ASSOCIATED SOFTWARE: These notices shall be marked on any reproduction of this data, in whole or in part. NOTICE: Notwithstanding any other lease or license that may pertain to, or accompany the delivery of, this computer software, the rights of the Government regarding its use, reproduction and disclosure are as set forth in Section of the FARS Computer Software Restricted Rights clause. RESTRICTED RIGHTS NOTICE: Use, duplication, or disclosure by the Government is subject to the restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS RESTRICTED RIGHTS LEGEND: Use, duplication or disclosure by the Government is subject to restrictions as set forth in paragraph (b)(3)(b) of the rights in Technical Data and Computer Software clause in DAR (a). This computer software is submitted with restricted rights. Use, duplication or disclosure is subject to the restrictions as set forth in NASA FAR SUP (April 1985) Commercial Computer Software Restricted Rights (April 1985). If the contract contains the Clause at Rights in Data General then the Alternate III clause applies. U.S. Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract. Unpublished All rights reserved under the Copyright Laws of the United States.

3 OSI /MHS SCF Reference Manual Glossary Index Figures Tables What s New in This Manual ix Manual Information ix New and Changed Information About This Manual xi Who Should Read This Manual? What s in This Manual? xi Related Manuals xii Your Comments Invited xvi Notation Conventions xvi Abbreviations xx 1. Introduction Object Specification 1-2 OSI/MHS Object Hierarchy 1-4 APPL Object 1-5 CLASS Object 1-5 CUG Object 1-6 CUGMEMBER Object 1-6 DLIST Object 1-6 DLISTMEMBER Object 1-6 ENTRY Object 1-6 GATEWAY Object 1-7 GROUP Object 1-7 MON Object 1-7 MTA Object 1-8 PROCESS Object 1-8 ROUTE Object 1-8 ix xi Compaq Computer Corporation i

4 Contents 1. Introduction (continued) 1. Introduction (continued) SUBSYS Object 1-8 null Object 1-9 Wild-Card and Special Characters 1-9 Wild-Card Notation in Object Names 1-9 Wild-Card Notation in O/R Names 1-10 Wild-Card Notation in ROUTE and APPL X.121 Addresses and Numeric User Identifiers 1-11 CONFIRM Option 1-13 Error Messages 1-14 Subsystem Identifier 1-14 Common Versus Subsystem-Specific Errors 1-14 Summary States Supported by OSI/MHS OSI/MHS SCF Commands OSI/MHS Commands 2-3 Sensitive and Nonsensitive Commands 2-3 Syntax Variables in OSI/MHS Commands 2-3 ABORT Command 2-6 ACTIVATE Command 2-8 ADD APPL Command 2-9 ADD CLASS Command 2-28 ADD CUG Command 2-37 ADD CUGMEMBER Command 2-39 ADD DLIST Command 2-43 ADD DLISTMEMBER Command 2-49 ADD GATEWAY Command 2-53 ADD GROUP Command 2-56 ADD MTA Command 2-67 ADD ROUTE Command 2-75 ADD SUBSYS Command 2-79 ALTER APPL Command 2-85 ALTER CLASS Command 2-87 ALTER CUG Command 2-89 ii

5 Contents 2. OSI/MHS SCF Commands (continued) 2. OSI/MHS SCF Commands (continued) ALTER CUGMEMBER Command 2-90 ALTER DLIST Command 2-91 ALTER DLISTMEMBER Command 2-92 ALTER GATEWAY Command 2-93 ALTER GROUP Command 2-94 ALTER MON Command 2-95 ALTER MTA Command 2-97 ALTER ROUTE Command 2-98 ALTER SUBSYS Command 2-99 DELETE Command INFO Command INFO Command Displays LISTOPENS Command LISTOPENS MON Display NAMES Command NAMES Command Displays PRIMARY Command START Command STATS Command STATS Command Displays STATUS Command STATUS Command Displays STOP APPL Command STOP CLASS Command STOP GROUP Command STOP MON Command STOP SUBSYS Command SUSPEND APPL Command TRACE MON Command TRACE PROCESS Command VERSION Command VERSION Command Displays iii

6 Contents 3. Formatting Trace Files With PTrace 3. Formatting Trace Files With PTrace Running PTrace 3-1 Starting a Noninteractive Session 3-1 Starting an Interactive Session 3-2 PTrace Commands 3-3 SELECT Command 3-3 DESELECT Command 3-6 LABEL Command 3-6 Getting Help 3-7 Device Types and Subtypes 3-7 Trace Record Formats 3-8 MON Trace Records 3-8 PROCESS Trace Records 3-12 GIP Trace Records 3-23 A. OSI/MHS SCF Command Syntax Summary ABORT APPL Command A-1 ABORT CLASS Command A-1 ABORT GROUP Command A-1 ABORT MON Command A-1 ABORT SUBSYS Command A-1 ACTIVATE APPL Command A-1 ADD APPL Command A-2 ADD CLASS Command A-6 ADD CUG Command A-7 ADD CUGMEMBER Command A-8 ADD DLIST Command A-9 ADD DLISTMEMBER Command A-10 ADD GATEWAY Command A-11 ADD GROUP Command A-12 ADD MTA Command A-14 ADD ROUTE Command A-16 ADD SUBSYS Command A-17 ALTER APPL Command A-19 iv

7 Contents A. OSI/MHS SCF Command Syntax Summary (continued) A. OSI/MHS SCF Command Syntax Summary (continued) ALTER CLASS Command A-22 ALTER CUG Command A-23 ALTER CUGMEMBER Command A-24 ALTER DLIST Command A-25 ALTER DLISTMEMBER Command A-26 ALTER GATEWAY Command A-27 ALTER GROUP Command A-28 ALTER MON Command A-29 ALTER MTA Command A-30 ALTER ROUTE Command A-32 ALTER SUBSYS Command A-33 DELETE APPL Command A-34 DELETE CLASS Command A-34 DELETE CUG Command A-34 DELETE CUGMEMBER Command A-34 DELETE DLIST Command A-34 DELETE DLISTMEMBER Command A-34 DELETE GATEWAY Command A-34 DELETE GROUP Command A-35 DELETE MTA Command A-35 DELETE ROUTE Command A-35 DELETE SUBSYS Command A-35 INFO APPL Command A-35 INFO CLASS Command A-35 INFO CUG Command A-36 INFO CUGMEMBER Command A-36 INFO DLIST Command A-36 INFO DLISTMEMBER Command A-36 INFO GATEWAY Command A-36 INFO GROUP Command A-36 INFO MON Command A-37 INFO MTA Command A-37 v

8 Contents A. OSI/MHS SCF Command Syntax Summary (continued) A. OSI/MHS SCF Command Syntax Summary (continued) INFO ROUTE Command A-37 INFO SUBSYS Command A-37 LISTOPENS MON Command A-37 NAMES APPL Command A-37 NAMES CLASS Command A-37 NAMES CUG Command A-38 NAMES CUGMEMBER Command A-38 NAMES DLIST Command A-38 NAMES DLISTMEMBER Command A-38 NAMES ENTRY Command A-38 NAMES GATEWAY Command A-38 NAMES GROUP Command A-38 NAMES MON Command A-39 NAMES MTA Command A-39 NAMES PROCESS Command A-39 NAMES ROUTE Command A-39 NAMES SUBSYS Command A-39 NAMES null Command A-39 PRIMARY MON Command A-39 START APPL Command A-40 START CLASS Command A-40 START GROUP Command A-40 START SUBSYS Command A-40 STATS APPL Command A-40 STATS MON Command A-40 STATS PROCESS Command A-40 STATUS APPL Command A-41 STATUS CLASS Command A-41 STATUS ENTRY Command A-41 STATUS GROUP Command A-41 STATUS MON Command A-41 STATUS PROCESS Command A-41 vi

9 Contents A. OSI/MHS SCF Command Syntax Summary (continued) A. OSI/MHS SCF Command Syntax Summary (continued) STATUS SUBSYS Command A-42 STOP APPL Command A-42 STOP CLASS Command A-42 STOP GROUP Command A-42 STOP MON Command A-42 STOP SUBSYS Command A-42 SUSPEND APPL Command A-43 TRACE MON Command A-43 TRACE PROCESS Command A-44 VERSION PROCESS Command A-44 VERSION null PROCESS A-44 B. OSI/MHS SCF Error Messages Glossary Index Figures Tables Figure i. OSI/MHS Manual Set xiii Figure ii. Related Manuals xv Figure 1-1. Inquiry, Configuration, and Control Components 1-1 Figure 1-2. OSI/MHS Subsystem Object Hierarchy 1-5 Table 1-1. OSI/MHS Object Types and Name Formats 1-2 Table 1-2. Examples of Successful and Unsuccessful Routing Based on Partial Wild-Carding 1-12 Table 1-3. OSI/MHS Summary States 1-16 Table 2-1. Commands by Object Type (page 1 of 2) 2-1 Table 3-1. PTrace SELECT Command Number and Keyword Descriptions (page 1 of 2) 3-4 vii

10 Contents viii

11 What s New in This Manual Manual Information SCF Reference Manual for Tandem OSI/MHS Abstract This manual describes how to use the Subsystem Control Facility (SCF) interactive interface to configure and control a Compaq Open System Interconnection/Message Handling System (OSI/MHS) subsystem. This manual also describes how to use the PTrace program to display trace files. This manual is intended for operators, network managers, and application programmers. 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 December 1999 Document History Part Number Product Version Published OSI/MHS C32 March OSI/MHS D20 September OSI/MHS D21 May OSI/MHS D22 June OSI/MHS D41 February OSI/MHS D42 December 1999 New and Changed Information This manual was previously published by Compaq under the title SCF Reference Manual for Tandem OSI/MHS. This manual has been updated to support the D42 OSI/MHS product and G-series system software. A description of the attribute DOWNGRDE-GW has been added to the ADD MTA command and the INFO MTA display. ix

12 What s New in This Manual New and Changed Information x

13 About This Manual This manual describes how to use the Subsystem Control Facility (SCF) interactive interface to configure and control a Compaq Open Systems Interconnection/Message Handling System (OSI/MHS) data communications subsystem. It also describes how to use the PTrace program to display trace files. For information about the programmatic interface to the Compaq OSI/MHS subsystem, see the OSI/MHS Management Programming Manual. For information about how to install, configure, manage, and maintain the Compaq OSI/MHS subsystem, see the OSI/MHS Configuration and Management Manual. SCF allows you to configure and examine the status of the Compaq OSI/MHS subsystem. SCF is similar in use and function to CMI, which is described in the Communications Management Interface (CMI) Operator's Guide. CMI is used to configure and control the subsystems described in the CMI manual; SCF is used to configure and control Compaq OSI/MHS and other Compaq data communications subsystems. The Subsystem Control Point (SCP) is the interface between SCF and the data communications subsystems. SCP is an intermediate, transparent management process that receives and distributes messages for data communications subsystems. It is described in detail in the SPI Common Extensions Manual. Who Should Read This Manual? This manual is written for those who want to configure and control the Compaq OSI/MHS subsystem interactively. To use this manual effectively, all readers should be familiar with the following: The International Telegraph and Telephone Consultative Committee (CCITT) X.400 specifications for message handling systems The CCITT X.200 specifications for the OSI Reference Model The Event Management Service (EMS) within DSM Basic operating system architecture What s in This Manual? This manual contains three sections, two appendixes, a glossary, and an index: Section 1, Introduction, describes how you use SCF commands to control, configure, and inquire about the Compaq OSI/MHS subsystem. It describes the object types and summary states that Compaq OSI/MHS supports, and it presents the object specification for each object. It also describes the other OSI/MHS manuals. Section 2, OSI/MHS SCF Commands, describes the SCF commands that the OSI/MHS subsystem supports. The command descriptions include the syntax, attributes, considerations, and examples for each command. xi

14 About This Manual Related Manuals Section 3, Formatting Trace Files With PTrace, describes the subsystem-specific details for formatting and displaying OSI/MHS trace files using the PTrace program. Appendix A, OSI/MHS SCF Command Syntax Summary, lists the commands alphabetically and displays their syntax. Appendix B, OSI/MHS SCF Error Messages, lists and describes each OSI/MHS subsystem-specific error message. The descriptions include the probable cause of the error and the recommended action for recovery from the error. Related Manuals This manual is only one in a set of OSI/MHS manuals. The list below describes each of the other manuals as shown in Figure i. Message Handling Systems Orientation Guide describes common tasks involved in building message handling systems with Compaq products. It also helps you to find related information in other Compaq manuals and educational offerings. 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. OSI/MHS P7 Application Programmatic Interface (P7 API) Manual contains programming and reference information for C programmers who use the P7 API procedures. OSI/MHS Configuration and Management Manual describes how to install, configure, manage, and maintain the OSI/MHS subsystem and its interfaces to DSM and OSI/AS (Application Services). It provides planning information in addition to several configuration examples. OSI/MHS Administrative Utility (AU) Manual describes how to install, configure, and use the AU, a Compaq utility that allows users to obtain information about messages, reports, or probes (communications sent by an originator to the message transfer system (MTS) to test delivery of a message or report) in the form of Protocol Data Units (Plus). Operator Messages Manual describes system messages and provides an explanation of the cause, a discussion of the effect on the system, and suggestions for corrective action. xii

15 About This Manual Related Manuals OSI/MHS Management Programming Manual, describes the Subsystem Programmatic Interface (SPI) and Event Management Service (EMS) used by management applications to manage OSI/MHS. This manual also describes the master password server process provided by OSI/MHS and the password server programmatic interfaces used by password server applications. It serves as both a reference manual and a programmer s guide for the development of network-management applications. For general information about SPI, see the SPI Programming Manual. Figure i. OSI/MHS Manual Set Concepts OSI/MHS Orientation Guide OSI/MHS GPI Programming Guide OSI/MHS GPI Reference Manual OSI/MHS P7 API Manual Programming Management Methods and Tools OSI/MHS Configuration and Management Manual OSI/MHS Administrative Utility (AU) Manual Management Reference for Operators Operator Messages Manual OSI/MHS SCF Reference Manual Reference for Automating Management OSI/MHS Management Programming Manual CDT 999.CDD xiii

16 About This Manual Related Manuals Figure ii shows how this manual is related to other Compaq manuals. The following is a description of the purpose and content of each manual in Figure ii. For background information on the Compaq environment, you may want to read the following manuals: Introduction to Compaq Networking and Data Communications. This manual provides an overview of aspects of networking and data communications specific to Compaq systems. Introduction to Distributed Systems Management (DSM). This manual introduces the products and components called collectively Distributed Systems Management. It also discusses subsystem enhancements to support DSM. Subsystem Control Facility (SCF) Reference Manual. This manual describes the operation of SCF and tells system and network managers, operators, and programmers how to use it to configure, control, and inquire about supported data communications subsystems. For information specific to OSI/MHS, you may want to read the following manual: OSI/MHS Configuration and Management Manual. This manual describes how to plan, install, configure, manage, and maintain a Compaq OSI/MHS subsystem. For information on event and problem management, you may want to read the following manuals: PTrace Reference Manual. This manual tells system and network managers how to display trace files created by the SCF TRACE command. EMS Manual. This manual tells system and network managers how to write eventmessage filters to select event messages of particular interest, and how to distribute event messages to various destinations. Operator Messages Manual. This manual describes system messages and provides an explanation of the cause, a discussion of the effect on the system, and suggestions for corrective action. ViewPoint Manual. This manual describes ViewPoint, a multifunction operations console application that allows the management of a network of systems. For information on underlying OSI subsystems, you may want to read the following manuals: OSI/AS Configuration and Management Manual. This manual provides taskoriented information necessary for the installation and management of Compaq OSI/AS services. SCF Reference Manual for OSI/AS. This manual describes how to use SCF commands to install, control, and inquire about the Compaq OSI/AS subsystem. SCF Reference Manual for OSI/TS. This manual describes how to use SCF commands to install, control, and inquire about the Compaq OSI/TS subsystem. SCF Reference Manual for TLAM. This manual describes how to use SCF commands to install, control, and inquire about the Compaq TLAM subsystem. xiv

17 About This Manual Related Manuals SCF Reference Manual for X25AM. This manual describes how to use SCF commands to install, control, and inquire about the Compaq X25AM subsystem. Figure ii. Related Manuals Introduction to Networking and Data Comm. Introduction to Distributed Systems Management (DSM) Subsystem Control Facility (SCF) Reference Manual Operator Messages Manual PTrace Reference Manual EMS Manual For information on the Compaq environment For information on event and problem management OSI/MHS SCF Reference Manual For information on OSI/MHS For information on underlying OSI subsystems OSI/MHS Configuration and Management Manual OSI/AS Configuration and Management Manual SCF Ref. Manuals for OSI/AS, OSI/TS, TLAM, X25AM ViewPoint Manual CDT 002.CDD xv

18 About This Manual Your Comments Invited 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 Compaq CD Read disc. You can either FAX or mail the card to us. The FAX number and mailing address are provided on the card. Also provided on the Reader Comment Card is an Internet mail address. When you send an Internet mail message to us, we immediately acknowledge receipt of your message. A detailed response to your message is sent as soon as possible. Be sure to include your name, company name, address, and phone number in your message. If your comments are specific to a particular manual, also include the part number and title of the manual. Many of the improvements you see in Compaq manuals are a result of suggestions from our customers. Please take this opportunity to help us improve future manuals. Notation Conventions General Syntax Notation The following list summarizes the notation conventions for syntax presentation in this manual. UPPERCASE LETTERS. Uppercase letters indicate keywords and reserved words; enter these items exactly as shown. Items not enclosed in brackets are required. For example: MAXATTACH lowercase italic letters. Lowercase italic letters indicate variable items that you supply. Items not enclosed in brackets are required. For example: file-name [ ] Brackets. Brackets enclose optional syntax items. For example: TERM [\system-name.]$terminal-name INT[ERRUPTS] A group of items enclosed in brackets is a list from which you can choose one item or none. The items in the list may be arranged either vertically, with aligned brackets on each side of the list, or horizontally, enclosed in a pair of brackets and separated by vertical lines. For example: LIGHTS [ ON ] [ OFF ] [ SMOOTH [ num ] ] K [ X D ] address-1 xvi

19 About This Manual General Syntax Notation { } 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. For example: LISTOPENS PROCESS { $appl-mgr-name } { $process-name } ALLOWSU { ON OFF } Vertical Line. A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces. For example: INSPECT { OFF ON SAVEABEND } Ellipsis. An ellipsis immediately following a pair of brackets or braces indicates that you can repeat the enclosed sequence of syntax items any number of times. For example: M address-1 [, new-value ]... [ - ] { }... An ellipsis immediately following a single syntax item indicates that you can repeat that syntax item any number of times. For example: "s-char..." Punctuation. Parentheses, commas, semicolons, and other symbols not previously described must be entered as shown. For example: error := NEXTFILENAME ( file-name ) ; LISTOPENS SU $process-name.#su-name Quotation marks around a symbol such as a bracket or brace indicate the symbol is a required character that you must enter as shown. For example: "[" repetition-constant-list "]" Item Spacing. Spaces shown between items are required unless one of the items is a punctuation symbol such as a parenthesis or a comma. For example: CALL STEPMOM ( process-id ) ; If there is no space between two items, spaces are not permitted. In the following example, there are no spaces permitted between the period and any other items: $process-name.#su-name 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 ]... xvii

20 About This Manual Notation for Messages!i and!o. In procedure calls, the!i notation follows an input parameter (one that passes data to the called procedure); the!o notation follows an output parameter (one that returns data to the calling program). For example: CALL CHECKRESIZESEGMENT ( segment-id!i, error ) ;!o!i,o. In procedure calls, the!i,o notation follows an input/output parameter (one that both passes data to the called procedure and returns data to the calling program). For example: error := COMPRESSEDIT ( filenum ) ;!i,o!i:i. In procedure calls, the!i:i notation follows an input string parameter that has a corresponding parameter specifying the length of the string in bytes. For example: error := FILENAME_COMPARE_ ( filename1:length!i:i, filename2:length ) ;!i:i!o:i. In procedure calls, the!o:i notation follows an output buffer parameter that has a corresponding input parameter specifying the maximum length of the output buffer in bytes. For example: error := FILE_GETINFO_ ( filenum!i, [ filename:maxlen ] ) ;!o:i Notation for Messages The following list summarizes the notation conventions for the presentation of displayed messages in this manual. Nonitalic text. Nonitalic letters, numbers, and punctuation indicate text that is displayed or returned exactly as shown. For example: Backup Up. 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. The items in the list might be arranged either vertically, with aligned brackets on each side of the list, or horizontally, enclosed in a pair of brackets and separated by vertical lines. For example: LDEV ldev [ CU %ccu CU %... ] UP [ (cpu,chan,%ctlr,%unit) ] xviii

21 About This Manual Notation for Management Programming Interfaces { } Braces. A group of items enclosed in braces is a list of all possible items that can be displayed, of which one is actually displayed. The items in the list might be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines. For example: LBU { X Y } POWER FAIL process-name State changed from old-objstate to objstate { Operator Request. } { Unknown. } Vertical Line. A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces. For example: Transfer status: { OK Failed } % Percent Sign. A percent sign precedes a number that is not in decimal notation. The %þnotation precedes an octal number. The %Bþnotation precedes a binary number. The %Hþnotation precedes a hexadecimal number. For example: % P=%p-register E=%e-register Notation for Management Programming Interfaces UPPERCASE LETTERS. Uppercase letters indicate names from definition files; enter these names exactly as shown. For example: ZCOM-TKN-SUBJ-SERV lowercase letters. Words in lowercase letters are words that are part of the notation, including Data Definition Language (DDL) keywords. For example: token-type!r.!o. The!r notation following a token or field name indicates that the token or field is required. For example: ZCOM-TKN-OBJNAME token-type ZSPI-TYP-STRING.!r The!o notation following a token or field name indicates that the token or field is optional. For example: ZSPI-TKN-MANAGER token-type ZSPI-TYP-FNAME32.!o xix

22 About This Manual Abbreviations Abbreviations The following list defines abbreviations used in this manual and in other Compaq OSI/MHS manuals. Both industry-standard terms and Compaq terms are included; Compaq terms are marked as such. 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. EDI messaging system EDIN. EDI notification EDI-MS. EDI message store EDI-UA. EDI user agent EIT. Encoded information type G3. Group 3 (facsimile) G4. Group 4 (facsimile) GIP. Gateway Interface Process (Compaq term) GPI. Gateway Programmatic Interface (Compaq term) IA5. International Alphabet No. 5 xx

23 About This Manual Abbreviations IDU. Internal data unit 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. Object management O/R. Originator/recipient OSI. Open Systems Interconnection OSI/MHS. Open Systems Interconnection/Message Handling System (Compaq term) P1. Protocol 1 (message-transfer protocol) P2. Protocol 2 (interpersonal-messaging protocol) P3. Protocol 3 (message-submission-and-delivery protocol) PDAU. Physical delivery access unit xxi

24 About This Manual Abbreviations PDU. Protocol data unit 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.400 Application Program Interface Association xxii

25 1 Introduction The Compaq Open Systems Interconnection/Message Handling System (OSI/MHS) is a 1988 implementation of the X.400 Message Handling System (MHS) model. Compaq OSI/MHS allows you to build a large-scale X.400 messaging network on Compaq computers. The OSI/MHS subsystem runs on any Compaq NonStop computer that uses the NonStop operating system. OSI/MHS can interoperate with Compaq systems and other X.400 systems. This manual describes the subsystem-specific details for using the Subsystem Control Facility (SCF) to configure, control, and inquire about the Compaq OSI/MHS subsystem. SCF can be used as an interface to the OSI/MHS subsystem. The OSI/MHS subsystem is fully compatible with the conventions defined by SCF. The Subsystem Control Point (SCP) is the interface between SCF and the OSI/MHS subsystem. SCP is an intermediate management process that receives and distributes messages for data communications subsystems. It is described in detail in the SPI Common Extensions Manual and the Subsystem Control Facility (SCF) Reference Manual. Figure 1-1 shows the inquiry, configuration, and control components pertinent to OSI/MHS within the SCF environment. Figure 1-1. Inquiry, Configuration, and Control Components Configuration and Control Components OSI/MHS Subsystem Management Applications SCP MHS Manager Config. Databases SCF LO MS User MR GI RS CDT 003.CDD 1-1

26 Introduction Object Specification Object Specification Object types and object names make up the object specification. The object types that OSI/MHS supports are listed in Table 1-1, along with the object name format for each type. The syntax of the name format is described in detail below the table, followed by a definition of each object. Table 1-1. OSI/MHS Object Types and Name Formats Object Type APPL CLASS CUG CUGMEMBER DLIST DLISTMEMBER ENTRY GATEWAY GROUP MON MTA PROCESS ROUTE SUBSYS null psystem proc is a valid node name. It is the name of the node in which the MHS manager resides. is an alphanumeric string with a maximum length of four characters. It specifies the name of the MHS manager. applname Name Format [\psystem.]$proc.#applname [\psystem.]$proc.#class [\psystem.]$proc.#cug [\psystem.]$proc.#cug.cugmember [\psystem.]$proc.#dlist [\psystem.]$proc.#dlist.dlistmember [\psystem.]$proc.#entry [\psystem.]$proc.#gateway [\psystem.]$proc.#class.[\gsystem.]group [\psystem.]$proc [\psystem.]$proc.#mta [\psystem.]$proc.#[\gsystem.]pname [\psystem.]$proc.#mta.route [\psystem.]$proc.#subsys [\psystem.]$proc is an alphanumeric string with a maximum length of 16 characters. It specifies the name of the APPL object. 1-2

27 Introduction Object Specification class cug is an alphanumeric string. It can be one of the following 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. is an alphanumeric string with a maximum length of 32 characters. It specifies the name of an individual closed user group (CUG). cugmember dlist is an alphanumeric string with a maximum length of 32 characters. It specifies the name of a member of a closed user group (CUG). is an alphanumeric string with a maximum length of 32 characters. It specifies the name of an individual distribution list. dlistmember entry is an alphanumeric string with a maximum length of 32 characters. It specifies the name of a member of a distribution list. is an alphanumeric string having one of three values: LINKRETRY, ROUTERETRY, or DEFERRED. It specifies the type of OSI/MHS message queue inquiry. gateway is an alphanumeric string with a maximum length of 32 characters. It is the name of the GATEWAY object. gsystem group mta is a valid node name. It is the name of the node in which the group resides. This node must be the same as the node for psystem. The MHS manager and all of its processes must be on a single node. 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. is an alphanumeric string with a maximum length of 32 characters. It is the name of an MTA object. 1-3

28 Introduction OSI/MHS Object Hierarchy pname route is an alphanumeric string with a maximum length of four characters. It specifies a valid process name is an alphanumeric string with a maximum length of 16 characters. It is used to define the location of routing information in the OSI/MHS routing database. subsys is an alphanumeric string with a maximum length of four characters, the first of which must be an alphabetic character. It specifies the name of the subsystem. OSI/MHS Object Hierarchy Figure 1-2 shows the hierarchical order of the object types that OSI/MHS supports. To an MHS manager process, the SUBSYS object type (which corresponds to the entire OSI/MHS subsystem) is at the highest point of the hierarchy. (The null object type is not an actual object type, but is used in commands that allow you to obtain information about all of the object types in a subsystem.) Subordinate to the SUBSYS object type are the CLASS, GATEWAY, APPL, DLIST, CUG, MTA, and ENTRY object types. The MON (MHS manager) object type has no subordinate object types and is separate from the hierarchy structure of the other object types. Subordinate to the CLASS object type is the GROUP object type. Subordinate to the GROUP object type is the PROCESS object type. The PROCESS object type has no subordinate object types. The GATEWAY object type has no subordinate object types. The APPL object type has no subordinate object types. Subordinate to the DLIST object type is the DLISTMEMBER object type. The DLISTMEMBER object type has no subordinate object types. Subordinate to the CUG object type is the CUGMEMBER object type. The CUGMEMBER object type has no subordinate object types. Subordinate to the MTA object type is the ROUTE object type. The ROUTE object type has no subordinate object types. The ENTRY object type has no subordinate object types. 1-4

29 Introduction APPL Object Figure 1-2. OSI/MHS Subsystem Object Hierarchy SUBSYS MON CLASS GATEWAY APPL DLIST CUG MTA ENTRY GROUP DLISTMEMBER CUGMEMBER ROUTE PROCESS CDT 004.CDD APPL Object The APPL object type defines an application to the OSI/MHS subsystem. The APPL object is used to configure the routing database and the OSI/MHS user database. Each APPL object in the database identifies either an application that can log on to OSI/MHS or a person on whose behalf an application can log on to OSI/MHS. You can specify one of two kinds of APPL objects. The one you specify depends on how the application accesses the OSI/MHS subsystem. The two types of APPL objects are: MS, whereby the user accesses the subsystem through an MS (message store) group. You can configure up to 1000 APPL objects per MS group. GW, whereby the user accesses the subsystem through a Transfer X400 or GPI gateway. The APPL object name is associated with a group that is used for servicing the messages submitted by the APPL object. APPL object names are unique user identifiers. An example of an APPL object name is: $ZMHS.#APPL1 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. The OSI/MHS subsystem recognizes five CLASS object names: #GI, which refers to the gateway interface CLASS object #LO, which refers to the local operations CLASS object #MR, which refers to the message relay CLASS object 1-5

30 Introduction CUG Object #MS, which refers to the message store CLASS object #RS, which refers to the remote operations service CLASS object Examples of CLASS object names are: $ZMHS.#GI $ZMHS.#LO $ZMHS.#MR $ZMHS.#MS $ZMHS.#RS CUG Object The CUG object type defines a closed user group within the OSI/MHS subsystem. CUGMEMBER Object The CUGMEMBER object type identifies an individual member of a closed user group. DLIST Object The DLIST object type defines a local distribution list within the OSI/MHS subsystem. DLISTMEMBER Object The DLISTMEMBER object type identifies an individual member of a local distribution list. 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. #LINKRETRY describes the messages that are being delayed for LINK-RETRY- DELAY as part of the message retry scheme. #ROUTERETRY describes the messages that are being delayed for time ROUTE- RETRY-DELAY as part of the message retry scheme. #DEFERRED describes the messages that MS APPL objects have requested to be deferred before transmission. Examples of ENTRY object names include: $ZMHS.#LINKRETRY $ZMHS.#ROUTERETRY $ZMHS.#DEFERRED 1-6

31 Introduction GATEWAY Object GATEWAY Object The GATEWAY object type allows you to define, control, and inquire about gateways attached to the OSI/MHS subsystem. You can configure up to 16 gateways per OSI/MHS subsystem. An example of a GATEWAY object name is: $ZMHS.#TG GROUP Object The GROUP object type identifies a group of related processes. It is used to configure, stop, and start related processes. If you issue the START command to a group, all processes in that group are started. Similarly, if you issue the STOP command to a group, all processes in that group are stopped. The GROUP object is in the GI class, the LO class, the MR class, the MS class, or the RS class. If the GROUP object is in the MR class, each group controls and configures three PROCESS objects: The store cleaner (SC) process The reliable transfer service (RTS) process The message relay process (MRP) If the GROUP object is in the MS class, the group controls and configures only the MS process. If the GROUP object is in the RS class, the group controls and configures only the RS process. 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.\HOE.GRP1 MON Object The MON object type enables you to address commands to the MHS manager. The MON object name must identify the manager process. An example of a MON object name is: $ZMHS 1-7

32 Introduction MTA Object MTA Object The MTA object type defines adjacent MTAs and their attributes to the OSI/MHS subsystem. This object is used to control and inquire about adjacent MTAs. Routes are defined for remote X.400 users or sets of remote X.400 users using these MTA objects. You can configure up to 800 adjacent MTA objects. Examples of MTA object names include: $ZMHS.#NEWYORK $ZMHS.#TOKYO $ZMHS.#HK PROCESS Object The PROCESS object type defines a process to the OSI/MHS subsystem. This object is used to trace and monitor OSI/MHS processes. You can direct requests to a specific process, to groups of processes, to classes of processes, or to all OSI/MHS processes. If the PROCESS object name is a network name, the system name is the name assigned to the group in which the process resides. Examples of PROCESS object names include: $ZMHS.#MS3 $ZMHS.#\HOE.MR3 ROUTE Object The ROUTE object type defines 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 the OSI/MHS subsystem as a whole. You use the SUBSYS object to configure general aspects of the subsystem and to inquire about the subsystem as a whole. You can stop and start the SUBSYS object to reconfigure the subsystem. However, commands addressed to the SUBSYS object do not support the SUB modifier. For information about the SUB modifier, see the Subsystem Control Facility (SCF) Reference Manual. An example of a SUBSYS object name is: $ZMHS.#SUBSYSA 1-8

33 Introduction null Object null Object A null object type is used as the object type in commands that do not require you to specify a particular object type. The null object type is not an actual object type: null is a term used to represent the absence of an object type in the command. If an SCF command supports the null object type, you can issue it without specifying an object type. The null object type has no hierarchical relationship to any of the other object types that OSI/MHS supports. For Compaq OSI/MHS, the NAMES and VERSION commands support the null object type. The NAMES null command refers to a collection of object types; for the VERSION null command, the object type is irrelevant. The object name for the null object type must identify the MHS manager, $ZMHS. Examples of null object names include: VERSION $ZMHS NAMES $ZMHS Wild-Card and Special Characters SCF allows the use of wild-cards and special characters when issuing commands. You can use wild-cards in the following ways: In object names, to allow wild-card matching of zero or more characters. In O/R name attributes within ADD and ALTER commands, to indicate not used. In the X121-ADDR and NUMERIC-USER-IDENTIFIER O/R name attributes of the ADD APPL, ALTER APPL, ADD ROUTE, and ALTER ROUTE commands, to allow messages to be routed to partially wild-carded or fully wild-carded addresses. Note. The asterisk (*) is used in all three kinds of wild-carding, but the notation and the results differ for each situation. Be sure you are using wild-carding correctly for the task you want to accomplish. Wild-Card Notation in Object Names You can use wild-card characters in object-name specifications to match zero or more characters. Two wild-card characters are valid: 1. An asterisk (*) can substitute for zero or more characters. For example, you can use it to find all objects whose names begin or end with a certain sequence of characters, regardless of the number of characters following or preceding the sequence you specify. 2. A question mark (?) can substitute for exactly one character. You can use it to find all objects in which the names are the same length but which differ by one character in the same position. 1-9

34 Introduction Wild-Card Notation in O/R Names Here are some examples of how you might use wild-card characters: NAMES GROUP $ZMHS.* NAMES GROUP $ZMHS.#MS.* NAMES GROUP $ZMHS.*.\ZOMM.* NAMES PROCESS $ZMHS.#ZAC? These considerations apply when using wild-card characters in object names: You cannot use wild-card characters in the process name of the MHS manager process. SCF needs the process name to route the command properly. For example, NAMES PROCESS $* You cannot use wild-card characters in certain commands. For example, the command ADD GROUP $ZMHS.* is not valid because the ADD GROUP command requires that you provide a specific name for the group. Take care when you use the? wild-card character with object names that include optional node names (specifically, PROCESS and GROUP objects). OSI/MHS always matches these object names as if they included the node name (whether you specify it or not). For example, if there is a group named MRGRP1 on node \ABC and you use an object specification of?rgrp1 (allowing the node name to default), OSI/MHS will return an error indicating that the object was not found because \ABC.M does not match a single character. However, an object specification of *RGRP1 (where the * allows for multiple preceding characters) will find the group. Wild-Card Notation in O/R Names lists the names of all groups. You can use wild-cards to substitute for O/R attribute name values in ADD and ALTER commands. In the ADD command, you can use an asterisk to indicate O/R name elements that are not specified. An unspecified element matches any value. For example, this APPL accepts any legal SUR-NAME value. ADD APPL $ZMHS.#GWAPPL1, ACCESS-TYPE GW & ACCESS-NAME GW1, & DOM-TYPE-1 ABC1, DOM-VALUE-1 PPICKLY, & ISO-COUNTRY-NAME US, ADMD BELL, & SUR-NAME * & lists the names of all groups in the MS class. lists the names of all groups on the node \ZOMM. lists all four-character processes starting with ZAC. is an invalid use of the * wild-card character. 1-10

35 Introduction Wild-Card Notation in ROUTE and APPL X.121 Addresses and Numeric User Identifiers In the ALTER command, you can use an asterisk to remove a previously specified name element. This example changes the SUR-NAME attribute so that the APPL accepts any legal value: ALTER APPL $ZMHS.#GWAPPL1, ACCESS-TYPE GW & ACCESS-NAME GW1, & DOM-TYPE-1 ABC1, DOM-VALUE-1 PPICKLY, & ISO-COUNTRY-NAME US, ADMD BELL, & SUR-NAME * & If an asterisk is used for a name element, subordinate name elements must be unspecified or must also have an asterisk as a value. The example shown below is invalid; because ORG-NAME contains an asterisk, the ORG-UNIT name should either be omitted or should have an asterisk: ADD DLISTMEMBER $ZMHS.#USERS.USER 1, & ISO-COUNTRY-NAME US, & ADMD ATT, & PRMD Compaq, & ORG-NAME * & ORG-UNIT-1 COMMUNICATIONS You cannot use an asterisk to represent a part of a name element. The SUR-NAME attribute in this example is not valid: ADD APPL $ZMHS.#GWAPPL1, ACCESS-TYPE GW & ACCESS-NAME GW1, & DOM-TYPE-1 ABC1, DOM-VALUE-1 PPICKLY, & ISO-COUNTRY-NAME US, ADMD BELL, & SUR-NAME DAV* & Note. The first three rules above apply to all O/R name attributes. The fourth rule applies to all O/R name attributes except the X121-ADDR and NUMERIC-USER-IDENTIFIER attributes of the ROUTE and APPL objects. See the following subsection for a description of wild-carding with these elements. Wild-Card Notation in ROUTE and APPL X.121 Addresses and Numeric User Identifiers For the ADD APPL, ALTER APPL, ADD ROUTE, or ALTER ROUTE commands, you can use the asterisk to represent some or all of an X.121 address or numeric user identifier. This feature lets you route messages based on partial matching of an X.121 or numeric user identifier field. OSI/MHS supports both partial wild-carding and full wild-carding. Each is described below. Partial Wild-Carding Partial wild-carding in this context means substituting the asterisk wild-card character for one or more characters at the end of a string. For example, you can represent an X.121 address for an APPL object as: X121-ADDR 493* 1-11

36 Introduction Wild-Card Notation in ROUTE and APPL X.121 Addresses and Numeric User Identifiers This address matches all X121-ADDR attributes that begin with 493. Similarly, this address matches all NUMERIC-USER-IDENTIFIER attributes that begin with 7752: NUMERIC-USER-IDENTIFIER 7752* Note. The X121-ADDR string is 1 to 15 numeric characters long; the NUMERIC-USER- IDENTIFIER string is 1 to 32 numeric characters long. The following are not valid partially wild-carded name elements, because the asterisk is not at the end of the string: NUMERIC-USER-IDENTIFIER 4*93 X121-ADDR *493 Here is a description of how OSI/MHS routes an incoming message to a partially wildcarded address. Assume that the local subsystem includes a ROUTE object whose NUMERIC-USER-IDENTIFIER O/R attribute is partially wildcarded. If there is a numeric user identifier element within the message s recipient O/R name, and if the numeric user identifier in the message's recipient O/R name matches the first part of a partially specified numeric user identifier in the ROUTE object, and if the message s recipient O/R name meets the routing criteria defined for that ROUTE, and if there are no ROUTEs, APPLs or DLISTs that contain a precise match for the routing criteria, then the message can be routed to the partially specified ROUTE. Table 1-2 contains examples of successful and unsuccessful routing: Table 1-2. Examples of Successful and Unsuccessful Routing Based on Partial Wild-Carding ROUTE1 O/R Attribute Incoming Message O/R Attribute Routable to ROUTE1? NUMERIC-USER-IDENTIFIER 347* NUMERIC-USER-IDENTIFIER Yes (assuming that other O/R attributes match) NUMERIC-USER-IDENTIFIER 347* NUMERIC-USER-IDENTIFIER No NUMERIC-USER-IDENTIFIER 347* X121-ADDR No Full Wildcarding OSI/MHS also supports full wild-carding of X.121 addresses and numeric user identifier names. Full wild-carding allows an X.121 address to match any valid incoming X.121 address, or any numeric user identifier to match any valid incoming user identifier. 1-12