HP NonStop Pathway/iTS Owner's manual

NonStop Pathway/iTS
Management
Programming Manual
Abstract
This manual describes the Subsystem Programmatic Interface (SPI) interface to
Pathway/iTS product; it is intended for programmers writing applications that manage
Pathway/iTS. It describes the SPI commands and messages for Pathway/iTS
objects—those related to terminal control processes (TCPs), terminals, and intelligent
devices.
Product Version
Pathway/iTS 1.0
Supported Release Version Updates (RVUs)
This publication supports D42.00 and all subsequent D4x.00 releases, G02.00 and all
subsequent G-series RVUs, and H06.03 and all subsequent H-series RVUs until
otherwise indicated by its replacement publications.
Part Number Published
426749-002 February 2006

Document History
Part Number Product Version Published
120042 Pathway/TS D42 August 1996
426749-001 Pathway/iTS 1.0 October 2000
426749-002 Pathway/iTS 1.0 February 2006

Hewlett-Packard Company—426749-002
i
NonStop Pathway/iTS
Management Programming
Manual
Index Examples Figures Tables
What’s New in This Manual ix
Manual Information ix
New and Changed Information ix
About This Manual xi
Who Should Read This Manual xi
Related Documentation xii
Notation Conventions xiii
1. Introduction
Which Sections Do You Need? 1-1
Architecture and Components 1-2
Distributed Systems Management 1-4
Management Interfaces 1-5
PATHCOM Interface 1-6
SPI Interface 1-6
2. Pathway/iTS Management Programming
Comparison of PATHCOM and SPI Commands 2-1
Pathway Management Programming Interface 2-4
Control and Inquiry 2-5
Sending Commands and Receiving Replies 2-5
3. SPI Programming Considerations
Definition Files 3-1
Naming Conventions 3-2
Contents 3-2
Location 3-3
Which Files Do You Need? 3-3
Message Elements for the Pathway Subsystem 3-4
Commands 3-4
Object Types 3-6
Object Names 3-8

Contents
NonStop Pathway/iTS Management Programming Manual—426749-002
ii
3. SPI Programming Considerations (continued)
3. SPI Programming Considerations (continued)
Object-Selector Tokens 3-8
Event Numbers 3-9
Other Tokens 3-9
Extensible Structured Tokens 3-10
Types for Fields in Structured Tokens 3-17
Data Lists and Error Lists 3-18
Building and Sending a Command Message 3-19
Summary of Steps 3-19
Considerations for SSINIT 3-20
Considerations for SSPUT 3-21
Considerations for SSNULL and Extensible Structured Tokens 3-21
Specifying Continuation 3-21
Required Object States for Continuation 3-23
Continuation Example 3-24
32-Byte File Names 3-25
Resetting Values in Fields 3-26
Receiving and Decoding Response Messages 3-27
Summary of Steps 3-27
Considerations 3-27
Event and Error Handling 3-28
Event Message Subject Tokens 3-28
Event-Specific Tokens 3-29
Error Messages 3-29
Message Numbers 3-30
Security 3-31
Naming Guidelines for Applications 3-31
Programming Considerations for Specific Object Types 3-32
TCP Objects 3-32
TERM Objects 3-33
PROG Objects 3-33
Tell Messages 3-33
Writing C Programs 3-34
Command Presentation 3-35
Unlisted Tokens 3-36
Required Tokens and Fields 3-36

Contents
NonStop Pathway/iTS Management Programming Manual—426749-002
iii
4. SPI and EMS Standard Definitions
4. SPI and EMS Standard Definitions
SPI Standard Definitions 4-1
EMS Standard Definitions 4-1
5. ZPWY-DDL- Definitions
Pathway Subsystem Definitions 5-1
Buffer Declarations 5-3
Object Names 5-3
Token Codes for Object Names 5-4
ZPWY-DDL-PROGNAME 5-4
ZPWY-DDL-PROGTERMNAME 5-4
ZPWY-DDL-SCOBOL-PUNAME 5-5
ZPWY-DDL-SCTCPNAME 5-5
ZPWY-DDL-SCTERMNAME 5-5
ZPWY-DDL-TCPLINKNAME 5-6
ZPWY-DDL-TCPNAME 5-6
ZPWY-DDL-TCPSCNAME 5-6
ZPWY-DDL-TCPTERMNAME 5-7
ZPWY-DDL-TELLNAME 5-7
ZPWY-DDL-TERMNAME 5-7
ZPWY-DDL-UNKNOWNNAME 5-8
Private Token and Field Types 5-8
ZPWY-DDL-AUTO-RESTART 5-8
ZPWY-DDL-CHAR15 5-8
ZPWY-DDL-CHAR30 5-9
ZPWY-DDL-CHAR132 5-9
ZPWY-DDL-CPU 5-9
ZPWY-DDL-DUMP-INFO 5-9
ZPWY-DDL-ERRINFO2 5-11
ZPWY-DDL-ERROR-INFO 5-12
ZPWY-DDL-FILLER 5-12
ZPWY-DDL-INSPECT-INFO 5-12
ZPWY-DDL-IO-PROTOCOL 5-13
ZPWY-DDL-OBJECT-NAME 5-13
ZPWY-DDL-ON-OFF 5-14
ZPWY-DDL-ON-OFF-CURRENT 5-14
ZPWY-DDL-OWNER-ID 5-14
ZPWY-DDL-PRINTER-INFO 5-15
ZPWY-DDL-TERM-TYPE 5-16

Contents
NonStop Pathway/iTS Management Programming Manual—426749-002
iv
5. ZPWY-DDL- Definitions (continued)
5. ZPWY-DDL- Definitions (continued)
ZPWY-DDL-TERMTYPE-INFO 5-17
ZPWY-DDL-TMF-RESTARTS 5-20
ZPWY-DDL-YES-NO 5-20
ZPWY-DDL-0-2045 5-20
ZPWY-DDL-0-2250 5-20
ZPWY-DDL-0-4095 5-21
ZPWY-DDL-1-199 5-21
ZPWY-DDL-1-255 5-21
Predefined Token and Field Values 5-21
Private Field Types for Predefined Values 5-22
ZPWY-DDL-CHARSET-VALUE 5-22
ZPWY-DDL-FRZSTATETERM-VALUE 5-23
ZPWY-DDL-NONSTOP-VALUE 5-23
ZPWY-DDL-OBJSTATE-VALUE 5-23
ZPWY-DDL-POP-VALUE 5-23
ZPWY-DDL-SECURITY-VALUE 5-24
ZPWY-DDL-TCPQUALSTATE-VALUE 5-24
ZPWY-DDL-TERMPEND-VALUE 5-24
ZPWY-DDL-TERMWAIT-VALUE 5-25
ZPWY-DDL-TRMQUALSTATE-VALUE 5-25
Simple Tokens 5-25
6. ZPWY-MAP- Definitions
Extensible Structured Tokens 6-1
ZPWY-MAP-DEF-PATHWAY 6-3
ZPWY-MAP-DEF-PROG 6-6
ZPWY-MAP-DEF-PROGTERM 6-8
ZPWY-MAP-DEF-TCP 6-13
ZPWY-MAP-DEF-TELL 6-25
ZPWY-MAP-DEF-TERM 6-26
ZPWY-MAP-PAR-CONTROL-TCP 6-33
ZPWY-MAP-PAR-INFO 6-35
ZPWY-MAP-PAR-INSPECT-TERM 6-36
ZPWY-MAP-PAR-START-PROG 6-37
ZPWY-MAP-PAR-START-TERM 6-38
ZPWY-MAP-PAR-STATS-SCTCP 6-38
ZPWY-MAP-PAR-STATS-TCP 6-40
ZPWY-MAP-PAR-STATS-TCPSC 6-40

Contents
NonStop Pathway/iTS Management Programming Manual—426749-002
v
6. ZPWY-MAP- Definitions (continued)
6. ZPWY-MAP- Definitions (continued)
ZPWY-MAP-PAR-STATS-TCPTERM 6-41
ZPWY-MAP-PAR-STATS-TERM 6-41
ZPWY-MAP-PAR-SUSPEND-TERM 6-42
ZPWY-MAP-PAR-TELL-TERM 6-42
ZPWY-MAP-QUAL-TCP 6-43
ZPWY-MAP-QUAL-TERM 6-44
ZPWY-MAP-SEL-PROG 6-44
ZPWY-MAP-SEL-PROGTERM 6-45
ZPWY-MAP-SEL-SCTCP 6-45
ZPWY-MAP-SEL-SCTERM 6-45
ZPWY-MAP-SEL-TCP 6-46
ZPWY-MAP-SEL-TCPLINK 6-46
ZPWY-MAP-SEL-TCPSC 6-46
ZPWY-MAP-SEL-TCPTERM 6-47
ZPWY-MAP-SEL-TELL 6-47
ZPWY-MAP-SEL-TERM 6-47
ZPWY-MAP-STARTPROG 6-48
ZPWY-MAP-STATS-SC 6-49
ZPWY-MAP-STATS-TCP1 6-50
ZPWY-MAP-STATS-TCP2 6-53
ZPWY-MAP-STATS-TERM1 6-60
ZPWY-MAP-STATS-TERM2 6-62
ZPWY-MAP-STATUS-TCP 6-70
ZPWY-MAP-STATUS-TCPLINK 6-72
ZPWY-MAP-STATUS-TERMDETAIL 6-73
ZPWY-MAP-STATUS-TERMFREEZE 6-79
ZPWY-MAP-TELLNUM 6-79
7. Terminal Control Process (TCP) Commands
ADD TCP 7-2
ALTER TCP 7-4
CONTROL TCP 7-6
DELETE TCP 7-8
GETVERSION TCP 7-9
INFO TCP 7-11
REFRESHCODE TCP 7-13
START TCP 7-15
STATS SCTCP 7-17

Contents
NonStop Pathway/iTS Management Programming Manual—426749-002
vi
7. Terminal Control Process (TCP)
Commands (continued)
7. Terminal Control Process (TCP) Commands (continued)
STATS TCP 7-19
STATS TCPSC 7-21
STATUS TCP 7-23
STATUS TCPLINK 7-25
STOP TCP 7-27
SWITCH TCP 7-29
8. TERM Commands
ABORT TCPTERM 8-2
ABORT TERM 8-3
ADD TERM 8-4
ALTER TERM 8-6
DELETE TCPTERM 8-8
DELETE TERM 8-9
FREEZESTATUS SCTERM 8-10
INFO TCPTERM 8-12
INFO TERM 8-14
INSPECT TERM 8-16
RESUME TCPTERM 8-17
RESUME TERM 8-19
START TCPTERM 8-21
START TERM 8-23
STATS TCPTERM 8-25
STATS TERM 8-27
STATUS TCPTERM 8-29
STATUS TERM 8-31
STOP TCPTERM 8-33
STOP TERM 8-35
SUSPEND TCPTERM 8-37
SUSPEND TERM 8-39
9. PROG Commands
ADD PROG 9-1
ADD PROGTERM 9-4
ALTER PROG 9-6
ALTER PROGTERM 9-8
DELETE PROG 9-10
DELETE PROGTERM 9-11

Contents
NonStop Pathway/iTS Management Programming Manual—426749-002
vii
9. PROG Commands (continued)
9. PROG Commands (continued)
INFO PROG 9-13
INFO PROGTERM 9-15
START PROG 9-17
10. Tell Message Commands
ADD TELL 10-1
DELETE TELL 10-3
INFO TELL 10-4
START TELL 10-5
TELL TERM 10-6
TELL TCPTERM 10-7
11. TCP Event Messages
Message Numbers 11-1
Event-Message Format 11-1
Unlisted Tokens 11-2
Listed Tokens 11-2
Subject Tokens 11-2
Event-Message Text 11-3
Additional Information for Terminal Errors 11-3
Simple Tokens 11-3
Error Recovery 11-4
Event-Message Range 3000 Through 3999 11-4
12. TCP Error Messages
Message Numbers 12-1
Error Presentation 12-1
Errors in STATUS TCP and STATUS TERM Command Responses 12-2
Errors in Error Lists 12-2
Object Types in Error Lists 12-2
Additional Information for Terminal Errors 12-3
Error Recovery 12-3
Error-Message Range 3000 Through 3999 12-3
13. Management Programming Examples
Configuring Pathway/iTS 13-1
Obtaining PROG Information 13-15

Contents
NonStop Pathway/iTS Management Programming Manual—426749-002
viii
14. Error Handling Example Program
14. Error Handling Example Program
Index
Examples
Example 3-1. Format for 32-Byte File Names 3-25
Example 13-1. Pathway/iTS Configuration Program 13-2
Example 13-2. Obtaining PROG Information 13-15
Example 14-1. Handling Errors 14-2
Figures
Figure 1-1. A NonStop TS/MP Application With Pathway/iTS 1-3
Figure 1-2. Pathway/iTS and DSM 1-5
Figure 1-3. Pathway/iTS Management Interfaces 1-6
Figure 1-4. Management Programming Environment 1-7
Figure 2-1. Sending Commands and Receiving Responses 2-6
Tables
Table 1-1. Configuration and Manual Correspondences 1-1
Table 2-1. PATHCOM and SPI Commands for Pathway/iTS 2-2
Table 3-1. Pathway/iTS Programmatic Commands 3-4
Table 3-2. TS/MP Commands Affecting Pathway/iTS Objects 3-6
Table 3-3. Pathway/iTS Object Types 3-6
Table 3-4. Commands and Objects 3-8
Table 3-5. Required Object States for Continuation 3-23
Table 3-6. Reset Constants 3-26
Table 3-7. Event Message Subject Tokens 3-28
Table 3-8. Event-Specific Pathway EMS Tokens 3-29
Table 3-9. Restricted Commands and Objects for Pathway/iTS 3-31
Table 4-1. EMS Standard Definitions for Header Tokens 4-1
Table 4-2. EMS Standard Definition for Data-Portion Tokens 4-1
Table 5-1. Pathway Buffer Declarations 5-1
Table 5-2. Pathway/iTS Object Names 5-1
Table 5-3. Pathway/iTS Private Token and Field Types 5-2
Table 5-4. Pathway Predefined Token and Field Values 5-2
Table 5-5. Pathway/iTS Field Types for Predefined Values 5-2
Table 6-1. Categories of Extensible Structured Tokens 6-1
Table 6-2. Pathway/iTS Extensible Structured Tokens 6-2