HP TR3271 Manual del propietario

Networking and Data Communications Library

Tandem Computers Incorporated

TR3271

Management

Programming

Manual

Abstract This manual describes the control-and-inquiry interface and the event messages available to an

application program controlling or monitoring the TR3271 subsystem. This manual is for programmers.

Part Number 14948

Document History Edition Part Number Product Version Operating System Version Date

First Edition 14948 TR3271 C20 GUARDIAN 90C20 March 1989

New editions incorporate any updates issued since the previous edition.

translation to another language, without the prior written consent of Tandem Computers Incorporated.



1989 Tandem Computers Incorporated.

CONTENTS

PREFACE ..................................................... vii

NOTATION CONVENTIONS ......................................... ix

SECTION 1. INTRODUCTION .................................... 1-1

Brief Overview of TR3271 .................................. 1-1

Objects Controlled by the Subsystem ....................... 1-1

Required Management Functions ............................. 1-2

Relationship With Other Subsystems ........................ 1-4

Subsystem Architecture .................................... 1-5

SECTION 2. MANAGEMENT PROGRAMMING FOR TR3271 ............... 2-1

How a Management Application Fits Into the Architecture ... 2-2

Commands .................................................. 2-4

Event Messages ........................................... 2-10

Communicating With the TR3271 Subsystem .................. 2-11

SECTION 3. ELEMENTS OF SPI MESSAGES FOR THE SUBSYSTEM ...... 3-1

Definition Files .......................................... 3-2

Naming Rules and Guidelines for Applications .............. 3-4

Common Syntax Elements for the Subsystems ................. 3-4

Command Numbers ......................................... 3-4

Object Types ............................................ 3-5

Object Names ............................................ 3-6

Event Numbers ........................................... 3-7

Subjects of Event Messages .............................. 3-7

Tokens .................................................. 3-8

Constructs Involving Multiple Tokens ................... 3-11

Components of a Command, Response and Event ............ 3-11

SECTION 4. SPI PROGRAMMING CONSIDERATIONS FOR TR3271 ....... 4-1

Building the Command Buffer ............................... 4-1

Discontinuing a Command in Progress ....................... 4-2

Receiving and Decoding the Response Buffer ................ 4-3

Error Handling ............................................ 4-4

Security .................................................. 4-4

Command Protocol .......................................... 4-5

iii

CONTENTS

SECTION 5. COMMON DEFINITIONS .............................. 5-1

SPI Standard Definitions .................................. 5-1

EMS Standard Definitions .................................. 5-9

Data-Communications Standard Definitions ................. 5-11

Common Definitions for the TR3271 Subsystem .............. 5-17

TR3271 Buffer Declarations ............................. 5-17

TR3271 Predefined Token and Field Values ............... 5-18

TR3271 Simple Tokens ................................... 5-18

TR3271 Extensible Structured Tokens .................... 5-19

TR3271 Tokens in Error Lists ........................... 5-19

TR3271 Tokens in Event Messages ........................ 5-20

SECTION 6. COMMANDS AND RESPONSES .......................... 6-1

Commands by Object Type ................................... 6-4

Sensitive and Nonsensitive Commands ....................... 6-6

Command Descriptions ...................................... 6-6

ABORT Command ........................................... 6-8

ADD Command ............................................ 6-13

ALTER Command .......................................... 6-20

CONNECT Command ........................................ 6-31

DELETE Command ......................................... 6-36

DISCONNECT Command ..................................... 6-41

GETVERSION Command ..................................... 6-46

INFO Command ........................................... 6-50

LISTOBJECTS Command .................................... 6-63

LOAD Command ........................................... 6-68

RESET Command .......................................... 6-72

RESETSTATS Command ..................................... 6-76

START Command .......................................... 6-84

STATISTICS Command ..................................... 6-89

STATUS Command ......................................... 6-97

STOP Command .......................................... 6-108

SWITCH Command ........................................ 6-114

TRACE Command ......................................... 6-119

SECTION 7. TR3271 EVENT MANAGEMENT ......................... 7-1

Subsystem Processes That Report Events .................... 7-1

Critical Events ........................................... 7-3

Event-Management Programming .............................. 7-3

Event-Message Descriptions ................................ 7-4

3: ZTR3-EVT-IOBUS-ERR ................................... 7-6

4: ZTR3-EVT-CIU-ERR .................................... 7-10

6: ZTR3-EVT-OBJ-STARTED ................................ 7-15

7: ZTR3-EVT-OBJ-STOPPED ................................ 7-18

67: ZTR3-EVT-SUBDEV-ERR ................................ 7-21

74: ZTR3-EVT-INTL-ERR .................................. 7-24

90: ZTR3-EVT-PROC-ABEND ................................ 7-27

106: ZTR3-EVT-INSUFF-BUF ............................... 7-31

112: ZTR3-EVT-DISCARD-ERR .............................. 7-34

141: ZTR3-EVT-CLIP-DWLOAD .............................. 7-37

147: ZTR3-EVT-CSS-PROBE-ERR ............................ 7-40

157: ZTR3-EVT-CSS-FRAME-ERR ............................ 7-44

CONTENTS

158: ZTR3-EVT-CSS-UNEXP-BRKPT .......................... 7-48

160: ZTR3-EVT-CSS-LIU-CONFIG-ERR ....................... 7-51

164: ZTR3-EVT-CSS-LINE-ERR ............................. 7-54

165: ZTR3-EVT-CSS-SUBDEV-ERR ........................... 7-58

-1: ZCOM-EVT-CPU-SWITCH ................................ 7-62

-2: ZCOM-EVT-PATH-SWITCH ............................... 7-65

-3: ZCOM-EVT-SUMSTATE-CHG .............................. 7-69

Examples of Filters ...................................... 7-72

Example 1 .............................................. 7-72

Example 2 .............................................. 7-73

APPENDIX A. ERROR NUMBERS AND ERROR LISTS .................. A-1

Notation Used ............................................. A-1

2: ZTR3-ERR-CLIP-PROB ................................. A-3

3: ZTR3-ERR-TARGET-OBJ-NOT-FOUND ...................... A-4

4: ZTR3-ERR-ATTR-CONFL-SU ............................. A-5

5: ZTR3-ERR-NOT-PTP-SU ................................ A-7

6: ZTR3-ERR-ALRDY-USING-ADDR .......................... A-8

7: ZTR3-ERR-NO-OBJ-IN-SEL-STATE ....................... A-9

8: ZTR3-ERR-OPENED-SU-EXIST .......................... A-10

10: ZTR3-ERR-TARGET-OBJNAME-INV ....................... A-11

11: ZTR3-ERR-NO-OWNER ................................. A-12

12: ZTR3-ERR-CONN-EXIST ............................... A-13

13: ZTR3-ERR-SU-OPENED ................................ A-14

APPENDIX B. TR3271 SUBSYSTEM DDL ........................... B-1

CONTENTS

FIGURES

1-1. TR3271 Subsystem Architecture ......................... 1-6

2-1. How an Application Fits Into the Architecture ......... 2-3

TABLES

2-1. TR3271 Programmatic Commands .......................... 2-4

2-2. SCF Commands and Programmatic Commands ................ 2-6

2-3. CMI Commands and Programmatic Commands ................ 2-8

4-1. Command Protocol Summary State Changes ................ 4-5

5-1. SPI Standard Definitions .............................. 5-2

5-2. EMS Standard Definitions .............................. 5-9

5-3. Data-Communications Standard Definitions ............. 5-12

6-1. Commands and Their Symbolic Names ..................... 6-2

7-1. TR3271 Event Messages ................................. 7-2

PREFACE

In the Tandem environment, TR3271 provides application programs

with the ability to communicate with IBM hosts and IBM

3270-family devices. This manual provides subsystem-specific

information for application programmers using the management-

programming interfaces to manage the TR3271 subsystem. The

management-programming interfaces are based on the Subsystem

Programmatic Interface (SPI). This manual describes the control-

and-inquiry interface and the Event Management Service (EMS)

interface available to an application program for subsystem-

management purposes.

This manual is intended for application programmers in one of the

following categories:

•TAL, COBOL85, and C programmers who are writing management

applications that communicate with the TR3271 subsystem.

•TACL users who are writing macros and routines to perform

management functions on the TR3271 subsystem.

This manual serves as a reference manual for the development of

management applications. The seven sections and two appendixes

of this manual contain information as follows:

•Section 1 introduces the TR3271 subsystem and the objects

it controls. It also describes the required management

functions, the relationship of the subsystem to other

subsystems, and the architecture of the TR3271 subsystem.

•Section 2 describes management programming. This section

describes the purpose of management programming and how

applications fit into the Distributed Systems Management

(DSM) architecture. It also contains tables of TR3271

programmatic commands and a comparison of programmatic and

operator commands.

•Section 3 describes the elements of SPI messages.

vii

PREFACE

•Section 4 describes SPI programming considerations for the

subsystem. This description includes information about build-

ing the command buffer, canceling commands, receiving and

decoding response buffers, error handling, version

compatibility, and security.

•Section 5 summarizes standard SPI definitions, EMS

definitions, and data-communications definitions used by the

subsystem in multiple commands, responses, or event messages.

These definitions include token codes, token maps, token

types, token values, field types, and field values.

•Section 6 describes all available commands and associated

responses when communicating with the TR3271 subsystem.

•Section 7 describes event management for applications communi-

cating with the TR3271 subsystem. This section contains

information on how to obtain event messages reported by the

subsystem, a description of each event message that can be

issued by the subsystems, and examples of filters that could

be used by an application.

•Appendix A describes the error numbers and error lists that

can be issued by the TR3271 subsystem.

•Appendix B is a listing of the TR3271 subsystem's DDL.

To use this manual, you should be familiar with Tandem system

architecture, have a reading knowledge of DDL, and have a working

knowledge of TR3271 and the language in which you are working:

TAL, COBOL85, TACL, and C. In addition, you should be familiar

with distributed systems management. Therefore, before using

this manual, you must be familiar with the material covered in

the following Tandem manuals:

•

Data Definition Language (DDL) Reference Manual

•

Device-Specific Access Methods--AM3270/TR3271

•

Introduction to Distributed Systems Management

•

Distributed Systems Management (DSM) Programming Manual

•

Communications Management Programming Manual

•

Event Management System (EMS) Manual

viii

NOTATION CONVENTIONS

The following list summarizes the conventions used in this

manual, including the boxed descriptions of programmatic

commands, event messages, and error lists in this manual.

Notation Meaning

UPPERCASE Uppercase letters represent names from the

LETTERS definition files, SCF commands, or CMI commands;

enter these names exactly as shown.

lowercase Lowercase letters represent words that are part of

letters the notation.

Ellipsis An ellipsis immediately following a pair of brackets

... or braces indicates that you can repeat the enclosed

syntax items any number of times.

The following notation appears to the right of the description

of a token or field within a command, response, or event-message

box.

Command Message

!{} You must specify this token or field.

!... You can repeat this token or field.

name

Specify or omit this token or field depending on the

token, field, or value identified by

name

. See the text

for the exact nature of the dependency.

} You must choose only one of the set of tokens or

fields that are indicated by !{

}, where

is the same

uppercase letter of the alphabet; for example, !{A}.

] You can choose zero or one of the set of tokens or

fields that are indicated by ![

], where

is the same

uppercase letter of the alphabet; for example, ![A].

}... You must choose at least one--and you can choose more

than one--of the set of tokens or fields indicated by

}..., where

is the same uppercase letter of the

alphabet; for example, !{A}... .

]... You can choose zero or one or more of the set of tokens

or fields indicated by ![

]..., where

is the same

uppercase letter of the alphabet; for example, ![A]... .

NOTATION CONVENTIONS

Response Message

!{} This token or field is always present.

!... This token or field can occur multiple times.

name

The presence or absence of this token or field depends

on the token, field, or value identified by

name

. See

the text for the exact nature of the dependency.

Event Message

!... This token or field can occur multiple times.

name

The presence or absence of this token or field depends

on the token, field, or value identified by

name

. See

the text for the exact nature of the dependency.

Tabla de contenidos

Otros manuales de Software de HP

HP D7171A - NetServer - LPr Manual de usuario

HP BL680c - ProLiant - G5 Manual de usuario

HP StorageWorks 2/32 - SAN Switch Manual de instrucciones

HP NAS 1200s Manual de instrucciones

HP HP-UX 11i v3 Manual de servicio

HP Brocade 8/24c Manual de instrucciones

HP StorageWorks MSA 2/8 - SAN Switch Manual de usuario

HP T5145 - Thin Client - Tower Manual de usuario

HP BB118BV - StorageWorks Data Protector Express... Manual de uso y cuidado

HP AK373A - StorageWorks All-in-One Storage System 1200r 5.4TB SAS Model NAS... Cómo utilizar

HP StorageWorks SSL1016 Instrucciones de uso

HP 1032 Manual de usuario

HP Rp7410 - Server - 0 MB RAM Manual de servicio

HP D6030A - NetServer - E50 Manual de usuario

HP ACC2 Aurora Manual de usuario

HP NonStop Pathway/iTS Manual del propietario

HP AB300 - Server Console Solution Manual de usuario

HP BladeSystem Dual NC370i - Multifunction Network... Manual de instrucciones

HP Xw4300 - Workstation - 2 GB RAM Guía de referencia rápida

HP StorageWorks MSA 2/8 - SAN Switch Manual de usuario

HP B6191-90015a Manual de usuario

HP KAYAK XM600 Manual de instrucciones

HP 418800-B21 - StorageWorks Modular Smart Array 70 Storage... Manual de usuario

HP C7791C - DesignJet 130 Color Inkjet Printer Guía de configuración

Manuales populares de Software de otras marcas

COMPRO

COMPRO COMPROFM Manual de usuario

Muratec

Muratec OFFICEBRIDGE ONLINE Manual de usuario

Oracle

Oracle Contact Center Anywhere 8.1 Manual de usuario

Adobe

Adobe 65007312 - Photoshop Lightroom Manual

Avaya

Avaya NULL One-X for RIM Blackberry Manual de usuario

PS Audio

PS Audio PowerPlay Manual del propietario

Brady

Brady LOCKOUT PRO 3.0 Manual de servicio

Avaya

Avaya Interaction Center Manual de usuario

Texas Instruments

Texas Instruments TI-83 Plus Silver Edition Manual

Novell

Novell GROUPWISE 8 - INTERNET AGENT Manual de usuario

Oracle

Oracle Application 9i Manual de usuario

Acer

Acer RDM Manual de usuario

Canon

Canon Vixia HF21 Manual de usuario

Canon

Canon ZR950 Manual de usuario

Samsung

Samsung Auto Backup Manual de usuario

Polycom

Polycom Vortex EF2201 Instrucciones de instalación y funcionamiento

Brocade Communications Systems

Brocade Communications Systems Brocade 8/12c Manual de usuario

Novell

Novell SP2 - S Manual de instrucciones