Networking and Data Communications Library
EXPAND
Management
Programming
Manual
™
Abstract
Part Number
This manual is for programmers. It describes the management-programming interfaces to the EXPAND
subsystem and how to use them.
11169
Tandem Computers Incorporated
Document History
Edition
Part Number
Product Version
Operating System Version Date
First Edition
Second Edition
84109
11169
EXPAND C00
EXPAND C10
GUARDIAN 90 C00
GUARDIAN 90 C10
November 1987
May 1988
New editions incorporate any updates issued since the previous edition.
Copyright
All rights reserved. No part of this document may be reproduced in any form, including photocopying or
translation to another language, without the prior written consent of Tandem Computers Incorporated.
Copyright  1988 Tandem Computers Incorporated.
CONTENTS
PREFACE ...................................................... ix
NOTATION CONVENTIONS ......................................... xi
SECTION 1. INTRODUCTION ....................................
Objects Controlled by the EXPAND Subsystem ................
Required Management Functions .............................
Relationship with Other Subsystems ........................
Architecture of the EXPAND Subsystem ......................
1-1
1-1
1-2
1-2
1-3
SECTION 2. MANAGEMENT PROGRAMMING FOR THE EXPAND SUBSYSTEM . 2-1
How Applications Fit Into the Architecture ................ 2-2
Commands an Application Can Issue ......................... 2-3
Event Messages ........................................... 2-12
Prerequisite Manuals ..................................... 2-13
SECTION 3. COMMUNICATING WITH THE EXPAND MANAGER PROCESS ...
Communicating Through SCP .................................
Creating the EXPAND Manager Process .......................
Using a RUN Command .....................................
Using a NEWPROCESS Call .................................
3-1
3-1
3-2
3-3
3-4
SECTION 4. ELEMENTS OF SPI MESSAGES FOR THE EXPAND SUBSYSTEM
Definition Files ..........................................
Naming Rules and Guidelines for Applications ..............
Common Syntax Elements for the EXPAND Subsystem ...........
Command Numbers .........................................
Object Types ............................................
Object Names ............................................
Event Numbers ...........................................
Subjects of Event Messages ..............................
Other Tokens ............................................
Constructs Involving Multiple Tokens ....................
Components of a Command .................................
Components of a Response ................................
Components of an Event Message ..........................
4-1
4-2
4-3
4-3
4-3
4-4
4-4
4-5
4-5
4-5
4-7
4-7
4-8
4-8
v
CONTENTS
SECTION 5.
SPI PROGRAMMING CONSIDERATIONS FOR THE EXPAND
SUBSYSTEM .......................................
Building the Command Buffer ...............................
Discontinuing a Command in Progress .......................
Receiving and Decoding the Response Buffer ................
Error Handling ............................................
Security ..................................................
5-1
5-1
5-2
5-3
5-4
5-4
SECTION 6. COMMON DEFINITIONS .............................. 6-1
SPI Standard Definitions .................................. 6-1
EMS Standard Definitions .................................. 6-4
Data-Communications Standard Definitions .................. 6-5
Common Definitions for the EXPAND Subsystem ............... 6-8
Buffer Declarations ..................................... 6-9
Private Token and Field Types .......................... 6-10
Predefined Token and Field Values ...................... 6-10
Simple Tokens .......................................... 6-11
Extensible Structured Tokens ........................... 6-12
Tokens in Error Lists .................................. 6-24
Tokens in Event Messages ............................... 6-25
SECTION 7. COMMANDS AND RESPONSES .......................... 7-1
Commands by Object Type ................................... 7-3
Sensitive and Nonsensitive Commands ....................... 7-4
Command Descriptions ...................................... 7-5
ABORT Command ........................................... 7-7
ALTER LINE Command ..................................... 7-11
ALTER PATH Command ..................................... 7-20
ALTER PROCESS Command .................................. 7-25
GETVERSION Command (EXPAND Manager Process) ............ 7-29
GETVERSION Command (Lines and Paths) ................... 7-32
INFO LINE Command ...................................... 7-35
INFO PATH Command ...................................... 7-45
INFO PROCESS Command ................................... 7-50
LOAD Command ........................................... 7-58
PROBE Command .......................................... 7-61
RESET Command .......................................... 7-65
RESETSTATS LINE Command ................................ 7-68
RESETSTATS PATH Command ................................ 7-74
START Command .......................................... 7-79
STATISTICS LINE Command ................................ 7-83
STATISTICS PATH Command ................................ 7-89
STATISTICS PROCESS Command ............................. 7-94
STATUS LINE Command .................................... 7-99
STATUS PATH Command ................................... 7-104
STOP Command .......................................... 7-108
SWITCH Command ........................................ 7-112
TRACE Command (EXPAND Manager Process) ................ 7-116
TRACE Command (NCP Process, Lines, and Paths) ......... 7-121
Examples of Commands and Responses ...................... 7-125
vi
CONTENTS
SECTION 8. EVENT MANAGEMENT ................................ 8-1
Subsystem Processes That Report Events .................... 8-1
Critical Events ........................................... 8-3
Event-Management Programming .............................. 8-4
Event-Message Descriptions ................................ 8-4
3: ZEXP-EVT-IO-BUS-ERR .................................. 8-7
4: ZEXP-EVT-DEV-ERR .................................... 8-10
6: ZEXP-EVT-DEV-UP ..................................... 8-17
7: ZEXP-EVT-DEV-DOWN ................................... 8-20
33: ZEXP-EVT-NET-LINE-QUAL ............................. 8-23
43: ZEXP-EVT-NET-DISCONN ............................... 8-26
44: ZEXP-EVT-NET-LINE-READY ............................ 8-29
45: ZEXP-EVT-NET-LINE-NOT-READY ........................ 8-32
46: ZEXP-EVT-NET-CONN .................................. 8-35
47: ZEXP-EVT-NET-TIMEOUT ............................... 8-38
48: ZEXP-EVT-NET-CPU-STATUS ............................ 8-41
49: ZEXP-EVT-NET-NO-RSP ................................ 8-44
90: ZEXP-EVT-NET-BAD-SYSGEN ............................ 8-47
91: ZEXP-EVT-NET-RUN-TIME-ERR .......................... 8-52
117: ZEXP-EVT-NET-REQ-ABORT ............................ 8-55
141: ZEXP-EVT-CLIP-DWLOADED ............................ 8-58
146: ZEXP-EVT-CSS-UNIT-ERROR ........................... 8-61
147: ZEXP-EVT-CSS-STATUS-PROBE-ERR ..................... 8-66
152: ZEXP-EVT-CSS-CLB-CMD-REJ .......................... 8-70
156: ZEXP-EVT-CSS-NO-RSP ............................... 8-73
157: ZEXP-EVT-CSS-FRAME-ERR ............................ 8-77
158: ZEXP-EVT-CSS-UNEXP-BRKPT .......................... 8-81
160: ZEXP-EVT-CSS-LIU-CONFIG-ERR ....................... 8-84
164: ZEXP-EVT-CSS-LINE-ERR ............................. 8-87
Examples of Filters ...................................... 8-90
Example 1 .............................................. 8-90
Example 2 .............................................. 8-91
Example of Event-Message Retrieval ....................... 8-92
Modifications to Example in EMS Manual ................. 8-93
Filter Source File ..................................... 8-95
Additional TAL Source Modules .......................... 8-95
APPENDIX A. ERROR NUMBERS AND ERROR LISTS .................. A-1
Notation Used ............................................. A-1
Error-List Descriptions ................................... A-2
1: ZEXP-ERR-TOO-MANY-OBJNAMES ........................... A-3
2: ZEXP-ERR-NEG-LH-RSP .................................. A-5
3: ZEXP-ERR-EMPT-RSP .................................... A-7
4: ZEXP-ERR-TKN-CONFL ................................... A-8
5: ZEXP-ERR-OBJ-TYPE-NAME-MISMATC ...................... A-10
6: ZEXP-ERR-TRACE-NOT-STARTED .......................... A-12
9: ZEXP-ERR-NEG-NCP-RSP ................................ A-13
10: ZEXP-ERR-BAD-NETTRACE-RCVD ......................... A-15
11: ZEXP-ERR-INV-VALUE ................................. A-17
APPENDIX B.
TOKEN CODES AND TOKEN MAPS ..................... B-1
vii
CONTENTS
APPENDIX C.
LINE ATTRIBUTES BY LINE-HANDLER TYPE ........... C-1
INDEX ................................................... Index-1
FIGURES
1-1.
2-1.
Architecture of the EXPAND Subsystem .................. 1-3
How an Application Uses the Management-Programming
Interfaces ............................................ 2-3
TABLES
2-1.
2-2.
2-3.
2-4.
2-5.
2-6.
6-1.
6-2.
6-3.
7-1.
8-1.
8-2.
B-1.
B-2.
C-1.
viii
EXPAND Programmatic Commands .......................... 2-4
SCF Commands and Programmatic Commands ................ 2-6
CMI Commands and Programmatic Commands ................ 2-8
NETMON Commands and Programmatic Commands ............ 2-10
CUP Commands and Programmatic Commands ............... 2-11
PUP Commands and Programmatic Commands ............... 2-12
SPI Standard Definitions Used by the EXPAND Subsystem . 6-2
EMS Standard Definitions Used by the EXPAND Subsystem . 6-5
Data-Communications Standard Definitions Used by the
EXPAND Subsystem ...................................... 6-6
Commands and Their Symbolic Names ..................... 7-2
EXPAND Line-Handler Process Event Messages ............ 8-2
EXPAND Network Control Process Event Messages ......... 8-3
EXPAND Token Codes .................................... B-2
EXPAND Token Maps ..................................... B-4
Line Attributes by Line-Handler Type .................. C-2
PREFACE
This manual is for you if you are an experienced application
programmer in one of the following categories:
•
TAL programmers, and COBOL85 programmers using ENTER TAL, who
are writing applications that control or monitor the EXPAND
subsystem.
•
TACL users who are writing macros or routines that control or
monitor the EXPAND subsystem.
This manual provides subsystem-specific programming information
about the management-programming interface provided by Tandem for
managing the EXPAND subsystem. This interface is based on the
Subsystem Programmatic Interface (SPI) and the Event Management
Service (EMS). (The latter facility was formerly called the
Event Management System.)
This manual serves as both a reference manual and a programmer's
guide for the development of management applications that use the
EXPAND subsystem.
This manual includes the following information:
•
Descriptions of the definitions provided by the EXPAND subsystem for use in the management-programming interface.
•
Detailed descriptions of all programmatic commands that can
be sent to the EXPAND subsystem and their corresponding
responses.
•
Detailed descriptions of all event messages that the EXPAND
subsystem can generate.
•
Detailed descriptions of all error lists that can be returned
by the EXPAND subsystem.
ix
PREFACE
•
An example in TAL that illustrates giving commands and
retrieving responses.
•
Several example event-message filters for use with the EXPAND
subsystem, and an example in TAL that illustrates retrieving
an EXPAND event message and taking appropriate corrective
action.
This manual assumes that you are familiar with Tandem system
architecture, have a reading knowledge of DDL, and have a working
knowledge of both the EXPAND subsystem and the languages in
which you are programming: TAL, COBOL85, or TACL. Before using
this manual, therefore, you should be familiar with the material
covered in the following Tandem manuals:
•
Introduction to Tandem Computer Systems
•
Data Definition Language (DDL) Reference Manual (only a
reading familiarity with DDL is required)
•
EXPAND Reference Manual
•
The manuals describing the programming languages being used
In addition, this manual assumes that you are familiar with
system and network management. Before using this manual, you
should be familiar with the material covered in the following
manuals, which contain general information about system and
network management, SPI, EMS, and the management of datacommunications subsystems such as the EXPAND subsystem.
•
Introduction to Distributed Systems Management (DSM)
•
Distributed Systems Management (DSM) Programming Manual
•
Event Management Service (EMS) Manual (formerly called the
Event Management System (EMS) Manual)
•
Communications Management Programming Manual
This manual refers frequently to the latter three manuals for
further information.
x
NOTATION CONVENTIONS
The following list summarizes the conventions for syntax notation
in this manual.
Notation
Meaning
UPPERCASE
LETTERS
Uppercase letters represent keywords and reserved
words; enter these items exactly as shown.
italics
Lowercase italic letters represent variable items
that you supply.
Brackets []
Brackets enclose optional syntax items. A group
of vertically aligned items enclosed in brackets
represents a list of selections from which you can
choose one or none.
Spaces
If a space separates two items, that space is
required. If one of the items is a punctuation
symbol, such as a parenthesis or a comma, spaces are
optional.
Punctuation
Parentheses, commas, semicolons, and other symbols
not described above must be entered precisely as
shown. Quotation marks around any symbol indicate
that it is not a syntax descriptor but a required
character, and you must enter it as shown.
The following list summarizes the conventions used in the boxed
descriptions of programmatic commands, event messages, and error
lists in this manual.
Notation
Meaning
UPPERCASE
LETTERS
Uppercase letters represent names from the
definition files; enter these names exactly as
shown.
lowercase
letters
Lowercase letters represent words that are
part of the notation, including DDL keywords.
!r
This symbol, placed to the right of a token or field
name, indicates that the token or field is required.
!o
This symbol, placed to the right of a token or field
name, indicates that the token or field is optional.
xi
SECTION 1
INTRODUCTION
The EXPAND network-operating software is a communications subsystem that links together as many as 255 geographically distributed
Tandem NonStop computer systems to create a network having the
same reliability, capacity to preserve database integrity, and
potential for modular expansion as a single system.
OBJECTS CONTROLLED BY THE EXPAND SUBSYSTEM
An EXPAND network consists of two or more Tandem NonStop systems
connected by data-communications paths. Each system in a network
is called a node. A process called the Network Control Process
(NCP) runs in each node of a network. Each node might also
contain a process called the EXPAND manager process. (The
architecture of the EXPAND subsystem is described in more detail
later in this section.)
An EXPAND path is a logical connection between two nodes in a
network. For each path between adjacent nodes in a network,
there is an EXPAND line-handler process that controls the path.
An EXPAND path between adjacent nodes can consist of several
lines. An EXPAND line is a communication link such as a fullduplex telephone line, an X.25 virtual circuit, a fiber-optic
cable, or a satellite link.
The EXPAND subsystem controls EXPAND paths and lines. Target
objects for some commands can also be parts of the EXPAND
subsystem itself: line-handler processes, the EXPAND manager
process, and the NCP.
1-1
INTRODUCTION
Required Management Functions
REQUIRED MANAGEMENT FUNCTIONS
To manage the objects that make up the EXPAND subsystem, you must
be provided with the capability to do the following:
•
Define certain characteristics, or attributes, of lines,
paths, and processes.
•
Find out the current values of the attributes of lines, paths,
and processes.
•
Obtain information about the current paths from other systems
to a selected system.
•
Determine the current states of lines and paths.
•
Initiate the operation of lines and paths.
•
Terminate the operation of lines and paths.
•
Change the system resources used by processes.
•
Obtain information about the product names and release versions of various components of the subsystem.
•
Obtain statistics about the execution history of lines and
paths, the communication between two systems, or the network
traffic passing through a given system.
•
Reinitialize the counters used to save statistics for lines
and paths.
•
Trace the actions of various components of the subsystem.
RELATIONSHIP WITH OTHER SUBSYSTEMS
EXPAND line handlers can communicate over X.25 virtual circuits,
and EXPAND lines can coincide with Fiber Optic Extension (FOX)
links, so an EXPAND network can be affected by the actions
of the X25AM subsystem and the FOX subsystem. The management
programming interfaces to these subsystems are described in
the X25AM Management Programming Manual and the FOX Management
Programming Manual, respectively.
1-2
INTRODUCTION
Architecture of the EXPAND Subsystem
ARCHITECTURE OF THE EXPAND SUBSYSTEM
The EXPAND subsystem consists of the EXPAND manager process,
the Network Control Process (NCP), the Network Utility Process
($ZNUP), and one or more line-handler processes. ($ZNUP performs
some statistics collection functions that were formerly performed
by the NCP.) Figure 1-1 illustrates the architecture of the
EXPAND subsystem and the various interfaces to the subsystem.
Interactive
Interfaces
Programmatic
Interfaces
SCF
SCP
EXPAND Subsystem
EXPAND
Manager
Process
$ZNUP
CMI
Line-Handler
Process
CUP
PUP
NETMON
NCP
SCP
S7012-001
Figure 1-1.
Architecture of the EXPAND Subsystem
1-3
INTRODUCTION
Architecture of the EXPAND Subsystem
You can communicate with the EXPAND subsystem through both
interactive and programmatic interfaces. The interactive interfaces to the EXPAND subsystem are the following:
•
The Subsystem Control Facility (SCF), which you can use to
configure, control, and collect information from the EXPAND
subsystem. SCF communicates with the EXPAND manager process
through the Subsystem Control Point (SCP), a programmatic
command interface that is described below. The EXPAND
manager process, in turn, communicates with the line-handler
processes.
SCF commands are similar to those of CMI, described in the
following paragraph; but SCF includes some functions that are
not available through CMI or the other interactive interfaces
described below.
•
The Communications Management Interface (CMI), which you can
use to configure, control, and collect information from the
EXPAND subsystem. CMI communicates with the NCP, $ZNUP, and
the line-handler processes.
•
The Network Monitor (NETMON) utility program, which allows you
to obtain information about the current state of the network.
NETMON communicates only with the NCP and $ZNUP.
•
The Communications Utility Program (CUP), which allows you to
obtain statistics and status information about EXPAND lines
and paths; alter the attributes of lines, paths, and linehandler processes; and stop lines and paths. CUP communicates
with the NCP, $ZNUP, and the line-handler processes.
•
The Peripheral Utility Program (PUP), which allows you to
bring line-handler processes up or down, switch the NCP
or line-handler processes between processors, and list the
attribute values of devices on the network. PUP communicates
with the NCP and the line-handler processes.
The programmatic interfaces available to the EXPAND subsystem are
the following:
•
The control-and-inquiry interface, which allows an application
to configure, control, and collect information from the EXPAND
subsystem by sending requests to and receiving responses from
the subsystem. Requests are sent to the EXPAND manager
process through the Subsystem Control Point (SCP), and the
EXPAND manager process forwards the requests to the linehandler processes.
•
The Event Management Service (EMS), which allows an application to obtain notification of events reported by the NCP and
the line-handler processes.
1-4
INTRODUCTION
Architecture of the EXPAND Subsystem
Applications other than management applications use EXPAND for
access to remote files, devices, and applications. They do so by
referring to network file names and process names and by calling
GUARDIAN 90 file-system procedures. For more information, refer
to the EXPAND Reference Manual, the GUARDIAN Operating System
Programmer’s Guide, and the System Procedure Calls Reference
Manual.
1-5
SECTION 2
MANAGEMENT PROGRAMMING FOR THE EXPAND SUBSYSTEM
As seen in the previous section, there are several different
interfaces, both interactive and programmatic, to the EXPAND
subsystem. In some situations, the programmatic interfaces would
be preferred over the interactive interfaces for the following
reasons:
•
It is efficient to transfer as many routine network-management
tasks as possible to programs running on the computer network
itself, freeing operators and other network-management personnel to do the work that requires judgment and creativity.
•
Information obtained through the programmatic interfaces can
be used directly by an application to control its actions,
produce reports, and so forth.
An application that uses the control-and-inquiry and eventmanagement interfaces can perform tasks that once required
the use of two or three interactive interfaces, and such an
application can also communicate with multiple subsystems. In
addition, the capability to write your own applications allows
you to tailor them to the needs and configuration of your
network.
You could, for example, write an application that uses the
control-and-inquiry interface to check the number of errors
occurring on all the EXPAND lines in the network and stop
lines that have too many errors. An application could monitor
the events occurring in the EXPAND subsystem and react to the
notification that a line is going down by starting another line
to handle the traffic.
Your applications can communicate with other subsystems as well
as with the EXPAND subsystem. For example, you could write an
application that uses the EXPAND subsystem to bring up an EXPAND
line to a remote system and then uses the PATHWAY subsystem to
2-1
MANAGEMENT PROGRAMMING FOR THE EXPAND SUBSYSTEM
restart terminals on that remote system. As another example,
if your EXPAND network contains an X.25 virtual circuit, you
could write an application that monitors the events reported by
the X25AM subsystem as well as those reported by the EXPAND
subsystem. This application could also send requests to both the
X25AM subsystem and the EXPAND subsystem to manage the network.
HOW APPLICATIONS FIT INTO THE ARCHITECTURE
An application uses the control-and-inquiry interface to the
EXPAND subsystem by sending requests (commands) to and receiving
responses from SCP. SCP passes some commands to the Network
Control Process (NCP), some to the Network Utility Process
($ZNUP), and some to the line handlers; these processes, in turn,
perform the specified actions. An application uses the Event
Management Service (EMS) to retrieve event messages generated
by the EXPAND subsystem by sending commands to and receiving
responses from an EMS distributor process.
Figure 2-1 illustrates how an application fits into the architecture of the EXPAND subsystem.
2-2
MANAGEMENT PROGRAMMING FOR THE EXPAND SUBSYSTEM
How Applications Fit Into the Architecture
Responses
Control-andInquiry
Interface
EXPAND
Manager
Process
SCP
Commands
Management
Application
Line-Handler
Process
$ZNUP
EMS
Filter
EventManagement
Interface
NCP
Event
Messages
EMS
Consumer
Distributor
EMS
Collector
($0)
Event
Messages
Event
Messages
Event
Messages
Other
Subsystems
Event
Log
S7012-002
Figure 2-1.
How an Application Uses the Management-Programming
Interfaces
COMMANDS AN APPLICATION CAN ISSUE
Table 2-1 lists and briefly describes the commands that a
management application can send to the EXPAND subsystem. These
commands are described in detail in Section 7, "Commands and
Responses."
2-3
MANAGEMENT PROGRAMMING FOR THE EXPAND SUBSYSTEM
Commands an Application Can Issue
Table 2-1.
EXPAND Programmatic Commands
Terminates the operation of lines or paths
immediately.
ALTER
Changes the values of attributes of lines,
paths, or line-handler processes.
GETVERSION
Returns the server version of the EXPAND
manager process.
INFO
Returns the current values of the attributes of
lines, paths, or line-handler processes, or
returns network map and/or path map information about one system as seen from another
specified system.
LOAD
Causes the Communications Line Interface
Processor (CLIP) to be downloaded.
PROBE
Returns information about the current paths
from other systems to a selected system.
RESET
Causes the CLIP to be placed in the boot state.
RESETSTATS
Returns statistical information about lines or
paths and then clears the statistics counters.
START
Initiates the operation of lines or paths.
STATISTICS
Returns statistical information about lines,
paths, communication between systems, or
network traffic through a given system.
STATUS
Returns information about the current state of
lines or paths.
STOP
Terminates the operation of lines or paths if
they have no connections to other systems.
SWITCH
Switches line-handler processes between
processors or Communications Interface Unit
(CIU) paths.
TRACE
Initiates, modifies, or terminates trace mode
on lines, paths, the EXPAND manager process,
or the NCP.
2-4
ABORT
MANAGEMENT PROGRAMMING FOR THE EXPAND SUBSYSTEM
Commands an Application Can Issue
Tables 2-2, 2-3, 2-4, 2-5, and 2-6 show the correspondence
between the interactive commands you use to control and inquire
about the EXPAND subsystem and the corresponding programmatic
commands you send to the EXPAND subsystem. Each table lists
the programmatic commands corresponding to the commands (those
applicable to EXPAND) in one particular interactive interface:
Table 2-2 for the Subsystem Control Facility (SCF), Table 2-3
for the Communications Management Interface (CMI), Table 2-4 for
NETMON, Table 2-5 for CUP, and Table 2-6 for PUP.
To make the contrast between the two kinds of commands clear, the
tables give the programmatic command and object names in the full
form you must use in programs. Later in this manual, in text and
in the headings for the command descriptions, the commands and
object types appear in a shortened form (without the ZCOM-CMDand ZCOM-OBJ- prefixes).
Note that in some cases, the correspondence between interactive
and programmatic commands is not exactly one-to-one. When
commands listed in the tables do not correspond exactly, the
programmatic interface usually provides more functionality than
the interactive interface.
2-5
MANAGEMENT PROGRAMMING FOR THE EXPAND SUBSYSTEM
Commands an Application Can Issue
Table 2-2.
SCF Commands and Programmatic Commands (Page 1 of 2)
SCF COMMAND
AND OBJECT TYPE
PROGRAMMATIC COMMAND
AND OBJECT TYPE
ZCOM-CMD-ABORT
ZCOM-OBJ-LINE
ABORT PATH
ZCOM-CMD-ABORT
ZCOM-OBJ-PATH
ALTER LINE
ZCOM-CMD-ALTER
ZCOM-OBJ-LINE
ALTER PATH
ZCOM-CMD-ALTER
ZCOM-OBJ-PATH
ALTER PROCESS
ZCOM-CMD-ALTER
ZCOM-OBJ-PROCESS
BOOT LINE
ZCOM-CMD-RESET
ZCOM-OBJ-LINE
INFO LINE
ZCOM-CMD-INFO
ZCOM-OBJ-LINE
INFO PATH
ZCOM-CMD-INFO
ZCOM-OBJ-PATH
INFO PROCESS
ZCOM-CMD-INFO
ZCOM-OBJ-PROCESS
LOAD LINE
ZCOM-CMD-LOAD
ZCOM-OBJ-LINE
PRIMARY PROCESS
ZCOM-CMD-SWITCH
(with ZCOM-TKNSWITCH-CPU)
ZCOM-OBJ-PROCESS
None
ZCOM-CMD-PROBE
ZCOM-OBJ-PROCESS
START LINE
ZCOM-CMD-START
ZCOM-OBJ-LINE
START PATH
ZCOM-CMD-START
ZCOM-OBJ-PATH
2-6
ABORT LINE
MANAGEMENT PROGRAMMING FOR THE EXPAND SUBSYSTEM
Commands an Application Can Issue
Table 2-2.
SCF Commands and Programmatic Commands (Page 2 of 2)
SCF COMMAND
AND OBJECT TYPE
PROGRAMMATIC COMMAND
AND OBJECT TYPE
STATS LINE
ZCOM-CMD-STATISTICS
ZCOM-OBJ-LINE
STATS PATH
ZCOM-CMD-STATISTICS
ZCOM-OBJ-PATH
None
ZCOM-CMD-STATISTICS
ZCOM-OBJ-PROCESS
STATS LINE,
RESET
ZCOM-CMD-RESETSTATS
ZCOM-OBJ-LINE
STATS PATH,
RESET
ZCOM-CMD-RESETSTATS
ZCOM-OBJ-PATH
STATUS LINE
ZCOM-CMD-STATUS
ZCOM-OBJ-LINE
STATUS PATH
ZCOM-CMD-STATUS
ZCOM-OBJ-PATH
STOP LINE
ZCOM-CMD-STOP
ZCOM-OBJ-LINE
STOP PATH
ZCOM-CMD-STOP
ZCOM-OBJ-PATH
SWITCH PROCESS
ZCOM-CMD-SWITCH
(with ZCOM-TKNSWITCH-PATH)
ZCOM-OBJ-PROCESS
TRACE LINE
ZCOM-CMD-TRACE
ZCOM-OBJ-PROCESS
TRACE PATH
ZCOM-CMD-TRACE
ZCOM-OBJ-PROCESS
VERSION $ZEXP
ZCOM-CMD-GETVERSION
ZCOM-OBJ-NULL
VERSION PROCESS
$lhname
ZCOM-CMD-GETVERSION
ZCOM-OBJ-PROCESS
2-7
MANAGEMENT PROGRAMMING FOR THE EXPAND SUBSYSTEM
Commands an Application Can Issue
Table 2-3.
CMI Commands and Programmatic Commands (Page 1 of 2)
CMI COMMAND
AND OBJECT TYPE
PROGRAMMATIC COMMAND
AND OBJECT TYPE
ZCOM-CMD-ABORT
ZCOM-OBJ-LINE
ABORT PATH
ZCOM-CMD-ABORT
ZCOM-OBJ-PATH
ALTER LINE
ZCOM-CMD-ALTER
ZCOM-OBJ-LINE
ALTER PATH
ZCOM-CMD-ALTER
ZCOM-OBJ-PATH
ALTER PROCESS
ZCOM-CMD-ALTER
ZCOM-CMD-SWITCH
ZCOM-OBJ-PROCESS
CONTROL LINE,
LOAD
ZCOM-CMD-LOAD
ZCOM-OBJ-LINE
CONTROL LINE,
RESET
ZCOM-CMD-RESET
ZCOM-OBJ-LINE
None
ZCOM-CMD-GETVERSION
ZCOM-OBJ-NULL
None
ZCOM-CMD-GETVERSION
ZCOM-OBJ-PROCESS
INFO LINE
ZCOM-CMD-INFO
ZCOM-OBJ-LINE
INFO PATH
ZCOM-CMD-INFO
ZCOM-OBJ-PATH
None
ZCOM-CMD-INFO
ZCOM-OBJ-PROCESS
None
ZCOM-CMD-PROBE
ZCOM-OBJ-PROCESS
START LINE
ZCOM-CMD-START
ZCOM-OBJ-LINE
START PATH
ZCOM-CMD-START
ZCOM-OBJ-PATH
2-8
ABORT LINE
MANAGEMENT PROGRAMMING FOR THE EXPAND SUBSYSTEM
Commands an Application Can Issue
Table 2-3.
CMI Commands and Programmatic Commands (Page 2 of 2)
CMI COMMAND
AND OBJECT TYPE
PROGRAMMATIC COMMAND
AND OBJECT TYPE
STATUS LINE
ZCOM-CMD-STATUS
ZCOM-OBJ-LINE
STATUS PATH
ZCOM-CMD-STATUS
ZCOM-OBJ-PATH
STATUS PROCESS
None
None
STATUS LINE,
DETAIL
ZCOM-CMD-STATISTICS
ZCOM-OBJ-LINE
STATUS PATH,
DETAIL
ZCOM-CMD-STATISTICS
ZCOM-OBJ-PATH
STATUS PROCESS,
DETAIL
None
None
None
ZCOM-CMD-STATISTICS
ZCOM-OBJ-PROCESS
STATUS LINE,
RESET
ZCOM-CMD-RESETSTATS
ZCOM-OBJ-LINE
STATUS PATH,
RESET
ZCOM-CMD-RESETSTATS
ZCOM-OBJ-PATH
STATUS PROCESS,
RESET
None
None
STOP LINE
ZCOM-CMD-STOP
ZCOM-OBJ-LINE
STOP PATH
ZCOM-CMD-STOP
ZCOM-OBJ-PATH
TRACE LINE
ZCOM-CMD-TRACE
ZCOM-OBJ-PROCESS
TRACE PATH
ZCOM-CMD-TRACE
ZCOM-OBJ-PROCESS
2-9
MANAGEMENT PROGRAMMING FOR THE EXPAND SUBSYSTEM
Commands an Application Can Issue
Table 2-4.
NETMON Commands and Programmatic Commands
NETMON COMMAND
PROGRAMMATIC COMMAND
AND OBJECT TYPE
ADD systems;
DISPLAY
ZCOM-CMD-STATISTICS
(ZEXP-TKN-STATSNCP-OPT = ZEXP-VALPKTS-STATS)
ZCOM-OBJ-PROCESS
BACKUPCPU
None
None
CPUS
None
None
MAPS
ZCOM-CMD-INFO
(ZEXP-TKN-INFO-NCPOPT = ZEXP-VAL-NCPMAPS)
ZCOM-OBJ-PROCESS
PATHS
ZCOM-CMD-INFO
(ZEXP-TKN-INFO-NCPOPT = ZEXP-VAL-NCPPATHS)
ZCOM-OBJ-PROCESS
PROBE
ZCOM-CMD-PROBE
ZCOM-OBJ-PROCESS
STATS
ZCOM-CMD-STATISTICS
(ZEXP-TKN-STATSNCP-OPT = ZEXP-VALSYS-STATS)
ZCOM-OBJ-PROCESS
2-10
MANAGEMENT PROGRAMMING FOR THE EXPAND SUBSYSTEM
Commands an Application Can Issue
Table 2-5.
CUP Commands and Programmatic Commands
CUP COMMAND
AND OBJECT TYPE
PROGRAMMATIC COMMAND
AND OBJECT TYPE
ALTER LINE
ZCOM-CMD-ALTER
ZCOM-OBJ-LINE
DUMP
None
None
SHOW*
ZCOM-CMD-INFO
ZCOM-CMD-INFO
ZCOM-CMD-VERSION
ZCOM-OBJ-LINE
ZCOM-OBJ-PATH
ZCOM-OBJ-PROCESS
STATS LINE
ZCOM-CMD-STATISTICS
ZCOM-OBJ-LINE
STATS LINE,
RESET
ZCOM-CMD-RESETSTATS
ZCOM-OBJ-LINE
TRACE
None**
None**
*To obtain all the information returned by CUP SHOW, three
programmatic commands are required. However, the programmatic commands return much more information than CUP SHOW
returns.
**Trace files produced by CUP TRACE for EXPAND lines are
incompatible with trace files produced by the programmatic
interface command ZCOM-CMD-TRACE.
2-11
MANAGEMENT PROGRAMMING FOR THE EXPAND SUBSYSTEM
Commands an Application Can Issue
Table 2-6.
PUP COMMAND
PUP Commands and Programmatic Commands
PROGRAMMATIC COMMAND
AND OBJECT TYPE
DOWN
ZCOM-CMD-STOP
ZCOM-OBJ-LINE
LISTDEV
ZCOM-CMD-INFO
ZCOM-OBJ-LINE
PRIMARY
ZCOM-CMD-SWITCH
(with ZCOM-TKNSWITCH-CPU)
ZCOM-OBJ-PROCESS
UP
ZCOM-CMD-START
ZCOM-OBJ-LINE
EVENT MESSAGES
In addition to sending commands and receiving responses, a
management application can obtain notification of events that
occur in the EXPAND subsystem. This notification is in the form
of event messages that are issued by the EXPAND subsystem. An
event message describes an event such as a hardware or software
error or the completion of an operation. Your application could
monitor these event messages to handle unexpected situations
or to keep track of the current status of the system and the
network.
The event messages that can be issued by the EXPAND subsystem are
described in Section 8, "Event Management."
2-12
MANAGEMENT PROGRAMMING FOR THE EXPAND SUBSYSTEM
Prerequisite Manuals
PREREQUISITE MANUALS
This manual provides subsystem-specific information about using
the programmatic control-and-inquiry interface to communicate
with the EXPAND subsystem and about the event messages generated
by the EXPAND subsystem. To use the material in this manual, you
must be familiar with the information provided in the following
manuals:
•
The Distributed Systems Management (DSM) Programming Manual,
which contains general information about using SPI messages to
communicate with subsystems.
•
The Event Management Service (EMS) Manual, which contains
information about obtaining event messages, defining filters,
and so on.
•
The Communications Management Programming Manual, which contains information about using SPI messages to communicate with
data-communications subsystems such as the EXPAND subsystem.
2-13
SECTION 3
COMMUNICATING WITH THE EXPAND MANAGER PROCESS
This section describes how a management application sends commands to and receives responses from the EXPAND subsystem.
Obtaining event messages from the EXPAND subsystem is described
in Section 8, "Event Management."
COMMUNICATING THROUGH SCP
To manage the EXPAND subsystem, an application communicates
with the EXPAND manager process. However, to communicate with
this process, an application opens and sends requests to a
process called the Subsystem Control Point (SCP). Communication
between an application and SCP is described in the Communications
Management Programming Manual, and it consists of the following
steps:
1.
The application opens the SCP process.
2.
The application sends an SPI-formatted request (an EXPAND
command) to SCP. A token in the command tells SCP that the
request is for the EXPAND subsystem.
3.
SCP checks whether or not the EXPAND manager process is open.
If it is not, SCP opens it.
4.
SCP checks whether or not the versions of the EXPAND manager
process and the application are compatible, and it performs
security validation on the request.
5.
If all is well, SCP forwards the request to the EXPAND
manager process.
3-1
COMMUNICATING WITH THE EXPAND MANAGER PROCESS
Communicating Through SCP
6.
If the request is directed to the EXPAND manager process
itself, that process responds to the request. If the request
is directed to the NCP or to $ZNUP, the EXPAND manager
process forwards it to that process, which in turn sends its
response back to the EXPAND manager process. Likewise, if
the request is directed to a line-handler process, the EXPAND
manager process forwards it to the line-handler process and
the line-handler process returns its response to the EXPAND
manager process.
7.
The EXPAND manager process then returns the response to SCP,
and SCP returns it to the application.
8.
Before terminating, the application closes the SCP process.
Usually the EXPAND manager process remains in the open state
after being opened by SCP. It will be closed if any file-system
error occurs or at the expiration of any timeout value.
CREATING THE EXPAND MANAGER PROCESS
The EXPAND manager process can be created either by a RUN command
from a command interpreter such as TACL or by a NEWPROCESS
system procedure call. After the EXPAND manager process has
been created, SPI-formatted requests can be sent to the EXPAND
subsystem through SCP.
It is recommended that the EXPAND manager process be created as
a NonStop process pair. Note that this process is a privileged
process.
3-2
COMMUNICATING WITH THE EXPAND MANAGER PROCESS
Using a RUN Command
Using a RUN Command
The syntax of the command-interpreter RUN command used to create
the EXPAND manager process is as follows.
RUN object-file / run-option-list / [ backup-cpu-number ]
object-file
is the name of the object file for the EXPAND manager
process. The name of this file is $SYSTEM.SYSnn.OZEXP,
where $SYSTEM.SYSnn is the currently used system subvolume and nn is a two-digit octal integer that identifies
that subvolume.
run-option-list
is a list of one or more GUARDIAN 90
separated by commas, as described in
Operating System Utilities Reference
options that are significant for the
process are the following:
run options
the GUARDIAN 90
Manual. The run
EXPAND manager
CPU cpu-number
designates the processor number of the processor
where the EXPAND manager process is to run. cpunumber is an integer in the range 0 through 15. If
this option is omitted, the process runs in the same
processor as the initiating command interpreter.
NAME $process-name
designates the symbolic name to be assigned to the
EXPAND manager process, such as "$ZEXP". This option
is required.
>
3-3
COMMUNICATING WITH THE EXPAND MANAGER PROCESS
Using a RUN Command
NOWAIT
means that the initiating command interpreter does
not wait while the EXPAND manager process runs but
returns a command input prompt after sending the
startup message to the process. If this option is
omitted, the command interpreter pauses while the
process runs.
PRI priority
is the execution priority of the EXPAND manager
process. priority is an integer in the range 1
through 199. If this option is omitted, the priority
assigned is 1 less than that of the initiating
command interpreter.
The only run option that is required to appear is
"NAME $process-name".
backup-cpu-number
indicates that the EXPAND manager process is to run
as a NonStop process pair and designates the processor
number of the backup processor. backup-cpu-number is an
integer in the range 0 through 15. This parameter is
optional.
Using a NEWPROCESS Call
An application process that satisfies the existing security
requirements can create the EXPAND manager process by using a
NEWPROCESS system procedure call. For information about the
syntax of a NEWPROCESS call, refer to the System Procedure Calls
Reference Manual. For information on the security requirements,
refer to the Security Administration Guide.
3-4
SECTION 4
ELEMENTS OF SPI MESSAGES FOR THE EXPAND SUBSYSTEM
The Subsystem Programmatic Interface (SPI) is used for building
commands to, decoding responses from, and obtaining event messages issued by the EXPAND subsystem. The procedures used
by an application to perform these tasks are described in the
Distributed Systems Management (DSM) Programming Manual. Using
SPI messages to communicate with the EXPAND subsystem through SCP
is described in the Communications Management Programming Manual.
The commands, responses, and event messages that are sent to
and received from the EXPAND subsystem are made up of special
codes called tokens. Each token contains a particular piece
of information, such as the command number of a command or one
element of an event message. Tokens can be single values or
structures consisting of several values, and some tokens, called
header tokens, are present in every command, response, or event
message.
This manual does not attempt to give a complete explanation
of tokens; it provides subsystem-specific information about the
tokens used to communicate with the EXPAND subsystem. General
information about tokens can be found in the Distributed Systems
Management (DSM) Programming Manual, and information about tokens
that is common to all data-communications subsystems can be found
in the Communications Management Programming Manual.
This manual uses DDL to describe all tokens. For a quick
explanation of DDL as it applies to SPI, refer to the appendix
"Overview of DDL for SPI" in the Distributed Systems Management
(DSM) Programming Manual.
4-1
ELEMENTS OF SPI MESSAGES FOR THE EXPAND SUBSYSTEM
Definition Files
DEFINITION FILES
Every token or other type of definition needed by an application
that uses SPI is defined in definition files provided by Tandem.
Each source of definitions, such as a subsystem or an operatingsystem component, has associated with it a set of four definition
files: one in TAL; one in COBOL85; one in TACL; and one in DDL,
from which the other three definition files are derived.
To be able to use the definitions from a particular source, an
application copies in or loads the definition file associated
with that source that is in the appropriate programming language.
The definitions in a COBOL85 definition file are grouped into
sections to enable COBOL85 programmers to declare multiple copies
of structures in the definition file. TAL programmers should
always source in the entire definition file, and TACL always
loads the entire definition file. For further information on
how definition files are accessed by an application, refer to the
Distributed Systems Management (DSM) Programming Manual.
An application that communicates with the EXPAND subsystem needs
the following definition files in the appropriate programming
language:
1.
The SPI definition file.
2.
The EMS definition file (needed only if the application
retrieves event messages or controls EMS).
3.
The data-communications definition file.
4.
The EXPAND definition file.
If the application also communicates with other subsystems, the
definition files for those other subsystems must also be used.
For example, an EXPAND application written in COBOL85 that
retrieves event messages would need the following definition
files:
ZSPIDEF.ZSPICOB
ZSPIDEF.ZEMSCOB
ZSPIDEF.ZCOMCOB
ZSPIDEF.ZEXPCOB
SPI definitions
EMS definitions
Data-communications definitions
EXPAND definitions
These files are located on the disk volume chosen by your site.
The default disk volume used by the INSTALL program is $SYSTEM.
For further information about the SPI definitions, EMS
definitions, and data-communications definitions, refer to the
Distributed Systems Management (DSM) Programming Manual, the
Event Management Service (EMS) Manual, and the Communications
4-2
ELEMENTS OF SPI MESSAGES FOR THE EXPAND SUBSYSTEM
Naming Rules and Guidelines for Applications
Management Programming Manual, respectively.
tions are described in this manual.
The EXPAND defini-
NAMING RULES AND GUIDELINES FOR APPLICATIONS
By convention, Tandem uses names beginning with the letter Z for
all definitions and all component fields of structures in its
definition files. To avoid present and future conflicts with
names defined by Tandem, it is best not to begin any of your own
names (names you define in your applications) with uppercase or
lowercase Z.
COMMON SYNTAX ELEMENTS FOR THE EXPAND SUBSYSTEM
The rest of this section contains subsystem-specific information
about elements of commands, responses, and event messages. For
more complete information about these elements, refer to the
Communications Management Programming Manual.
Command Numbers
In the EXPAND subsystem, command numbers are represented by
symbolic names of the form ZCOM-CMD-name, where name identifies
the command.
The EXPAND subsystem supports the following commands:
ABORT
ALTER
GETVERSION
INFO
LOAD
PROBE
RESET
RESETSTATS
START
STATISTICS
STATUS
STOP
SWITCH
TRACE
These commands are described in Section 7, "Commands and
Responses."
4-3
ELEMENTS OF SPI MESSAGES FOR THE EXPAND SUBSYSTEM
Object Types
Object Types
In addition to the object-type header token found in all commands
and responses, some EXPAND response records contain an objecttype token that describes the object the response record relates
to. In the EXPAND subsystem, object types are represented by
symbolic names of the form ZCOM-OBJ-name, where name identifies
the object type. The EXPAND subsystem supports the following
object types:
LINE
NULL
PATH
PROCESS
The kinds of objects the EXPAND subsystem manages are described
in Section 1, "Introduction." The object types supported
by the EXPAND subsystem are described in Section 6, "Common
Definitions."
The GETVERSION command does not require an object type.
Object Names
Most EXPAND commands and responses contain object-name tokens
that, when combined with the object-type information, designate
which objects are to be or were affected by the command.
In the management-programming interface to the EXPAND subsystem,
an object name consists of a dollar sign ($) followed by from one
to seven alphanumeric characters; the first character is always a
letter. An example of a valid object name is "$LN01".
Most EXPAND commands accept up to 30 object names. Object-name
templates and the subordinate names option are not supported.
In responses to EXPAND commands that operate on objects, a
response record always contains response information for the
operation of the command on a single object.
4-4
ELEMENTS OF SPI MESSAGES FOR THE EXPAND SUBSYSTEM
Event Numbers
Event Numbers
Event numbers for event messages issued by the EXPAND subsystem
are represented by symbolic names of the form ZEXP-EVT-name,
where name identifies the event. EXPAND event numbers and their
associated event messages are described in Section 8, "Event
Management."
Subjects of Event Messages
In EXPAND event messages, there are two possible forms for the
subject token (the token that immediately follows the subjectmark token), depending on whether the subject is a logical device
or a system.
When the subject of an event is a logical device, the subject
token is a device-name token that contains an 8-byte GUARDIAN
internal-format device name.
When the subject of an event is a system, the subject token
is a system-name token that contains the name of the system as
a string of eight ASCII characters. In this case, the event
message also contains a system-number token that gives the system
number of the system as a 16-bit signed integer.
Other Tokens
In addition to the tokens already described, the EXPAND subsystem
uses other tokens as command parameters, results in responses,
and elements of event messages and error lists.
Simple Tokens
Simple tokens--tokens whose values are single fields or fixed
structures--are identified by token codes. The token codes for
the simple tokens used by the EXPAND subsystem are represented
by symbolic names of the form subsys-TKN-name, where subsys
is a four-character subsystem abbreviation and name identifies
the token code. For example, the token code ZEXP-TKN-SYSNAME
identifies a simple token that contains the name of a system.
4-5
ELEMENTS OF SPI MESSAGES FOR THE EXPAND SUBSYSTEM
Other Tokens
A table of all the token codes defined by the EXPAND subsystem
(token codes with names of the form ZEXP-TKN-name) can be found
in Appendix B.
Token Types
The token types used by the EXPAND subsystem are represented
by symbolic names of the form subsys-TYP-name, where subsys
is a four-character subsystem abbreviation and name identifies
the token type. For example, the token type ZSPI-TYP-CHAR8
represents a string of eight ASCII characters. The EXPAND
subsystem does not define any private token types; that is, no
token types have names of the form ZEXP-TYP-name.
Throughout this manual, when a simple token is described, its
token type is given.
Predefined Value Names
The predefined values used by the EXPAND subsystem are represented by symbolic names of the form subsys-VAL-name, where
subsys is a four-character subsystem abbreviation and name
identifies the predefined value. For example, the predefined
value ZEXP-VAL-RS232 represents the RS-232 hardware interface.
Extensible Structured Tokens
Extensible structured tokens--tokens whose values are extensible
structures--are identified by token maps. The token maps for
the extensible structured tokens used by the EXPAND subsystem
are represented by symbolic names of the form subsys-MAP-name,
where subsys is a four-character subsystem abbreviation and name
identifies the token map. For example, the token map ZEXPMAP-STATS-PATH identifies an extensible structured token that
contains all the statistical information for one path.
All EXPAND commands can contain extensible structured tokens.
The responses to the following EXPAND commands can also contain
extensible structured tokens:
INFO
PROBE
RESETSTATS
4-6
STATISTICS
STATUS
ELEMENTS OF SPI MESSAGES FOR THE EXPAND SUBSYSTEM
Other Tokens
Extensible structured tokens do not appear in any event message
or error list issued by the EXPAND subsystem.
Throughout this manual, when an extensible structured token is
described, its DDL definition, including the definitions and
types of all fields, is also given.
The predefined field values used by the EXPAND subsystem are
represented by symbolic names of the form subsys-VAL-name,
where subsys is a four-character subsystem abbreviation and name
identifies the predefined value.
A table of all the token maps defined by the EXPAND subsystem
(token maps with names of the form ZEXP-MAP-name) can be found in
Appendix B.
Field Types
All the field types used by the EXPAND subsystem are SPI standard
field types, so they are represented by symbolic names of the
form ZSPI-DDL-name, where name identifies the field type. For
example, the field type ZSPI-DDL-BOOLEAN represents the Boolean
data type.
Throughout this manual, when a field is described, its field type
is given.
Constructs Involving Multiple Tokens
The EXPAND subsystem supports data lists and error lists as
described in the Distributed Systems Management (DSM) Programming
Manual.
Components of a Command
This topic is discussed in the Communications Management
Programming Manual.
Each EXPAND command and the tokens it contains are described in
this manual in Section 7, "Commands and Responses."
Considerations for building EXPAND command buffers are described
in this manual in Section 5, "SPI Programming Considerations for
the EXPAND Subsystem."
4-7
ELEMENTS OF SPI MESSAGES FOR THE EXPAND SUBSYSTEM
Components of a Response
Components of a Response
This topic is discussed in the Communications Management
Programming Manual.
Each EXPAND response and the tokens it contains are described in
this manual in Section 7, "Commands and Responses."
Considerations for retrieving and decoding EXPAND response
buffers are described in this manual in Section 5, "SPI
Programming Considerations for the EXPAND Subsystem."
Components of an Event Message
This topic is discussed in the Event Management Service (EMS)
Manual.
Each EXPAND event message and the tokens it contains, and
considerations for retrieving and decoding EXPAND event messages,
are described in this manual in Section 8, "Event Management."
4-8
SECTION 5
SPI PROGRAMMING CONSIDERATIONS FOR THE EXPAND SUBSYSTEM
The Communications Management Programming Manual discusses general programming considerations for writing applications that
use the Subsystem Programmatic Interface (SPI) to communicate
with data-communications subsystems like the EXPAND subsystem.
This section discusses SPI programming considerations that are
specific to the EXPAND subsystem.
BUILDING THE COMMAND BUFFER
The following programming considerations apply when an application builds the command buffer for an EXPAND command.
The recommended buffer length in bytes for an EXPAND command is a
predefined value with the symbolic name ZEXP-VAL-BUFLEN.
The EXPAND subsystem does not support multiple commands in a
single request message. However, most of the EXPAND commands
accept up to 30 object names in one command, so one command can
affect up to 30 objects. All the objects named in one command
must be of the same object type.
The EXPAND subsystem does not support continuation of a command
across multiple messages, but it does support the special case
of receiving multiple reply messages using the context token, as
described in the Distributed Systems Management (DSM) Programming
Manual.
The command buffers for all EXPAND commands can contain extensible structured tokens. An extensible structured token that is
to appear in a command should always be initialized by the SPI
procedure SSNULL to ensure that every field of the token is
initialized to its null value. This action is important because
5-1
SPI PROGRAMMING CONSIDERATIONS FOR THE EXPAND SUBSYSTEM
Building the Command Buffer
an operation will be performed if a field contains a value other
than its null value. For example, in the ALTER LINE command,
if a field of the extensible structured token that describes the
line attributes contains a value other than its null value, that
value is assigned to the attribute corresponding to that field.
Using SSNULL is important even when every field of an extensible
structured token will have a value assigned to it, so that the
application will continue to work if it is compiled with new
definition files that add new fields to the token.
The only tokens that can appear more than once in an EXPAND
command are ZSPI-TKN-COMMENT, ZCOM-TKN-OBJNAME, and ZCOM-TKNTRACE-OPT. ZSPI-TKN-COMMENT is the comment token, described
in the Distributed Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is the object-name token, described in Section
6, "Common Definitions." ZCOM-TKN-TRACE-OPT is a token used in
the TRACE command, and it is described in Section 7, "Commands
and Responses."
If any of the other tokens in a command appear more than once, an
error is given either by the EXPAND subsystem or by SCP.
DISCONTINUING A COMMAND IN PROGRESS
General programming considerations for discontinuing a command
in progress are discussed in the Communications Management
Programming Manual.
The EXPAND subsystem does support the use of the token ZSPITKN-ALLOW-TYPE, which allows an application to specify, in a
command operating on multiple objects, whether or not the EXPAND
subsystem should continue immediately to the next object if it
failed on the previous one. If no value is specified for this
token, the EXPAND subsystem continues to the next object only if
no errors or warnings occurred on the previous one.
When the EXPAND subsystem discontinues a command because of an
error or warning, it immediately sends a reply message to the
application. The reply message contains a context token. The
application can choose to resend the command, causing the EXPAND
subsystem to proceed to the next object, or to abandon the
command.
5-2
SPI PROGRAMMING CONSIDERATIONS FOR THE EXPAND SUBSYSTEM
Receiving and Decoding the Response Buffer
RECEIVING AND DECODING THE RESPONSE BUFFER
The following programming considerations apply when an application receives and decodes the response buffer for an EXPAND
response.
In responses to EXPAND commands that operate on objects, a
response record always contains response information for the
operation of the command on a single object.
The EXPAND subsystem supports multiple response records in a
single reply message. The number of response records returned in
one reply message is controlled by the value of the header token
ZSPI-TKN-MAXRESP in the command.
If multiple response records are to be returned in one reply
message (or if the command is PROBE or is INFO with ZEXP-TKNINFO-NCP-OPT specified), the recommended buffer size in bytes for
the response is a predefined value with the symbolic name ZEXPVAL-MAXBUFLEN. If a single response record is to be returned in
each reply message (for commands other than PROBE and INFO with
ZEXP-TKN-INFO-NCP-OPT), the recommended buffer size in bytes for
the response is the predefined value ZEXP-VAL-BUFLEN.
The EXPAND subsystem does support multiple response records over
multiple messages (continuation) by returning a context token
when a response is continued.
The EXPAND subsystem also supports the use of the token ZSPITKN-RESPONSE-TYPE, which allows an application to specify, in a
command operating on multiple objects, which kinds of response
records should be returned--one for every object, or only those
for objects on which errors or warnings occurred. If no value is
specified for this token, the EXPAND subsystem returns a response
record for every object.
Note that for commands such as the INFO command whose purpose
is to return information, using ZSPI-TKN-RESPONSE-TYPE to request
the return of only those response records for objects on which
errors or warnings occurred can result in no information being
returned.
The responses to the INFO, PROBE, RESETSTATS, STATISTICS, and
STATUS commands each contain an extensible structured token that
returns the requested information.
5-3
SPI PROGRAMMING CONSIDERATIONS FOR THE EXPAND SUBSYSTEM
Error Handling
ERROR HANDLING
General programming considerations for handling errors that occur
when using the management-programming interfaces are discussed in
the Communications Management Programming Manual.
In the programmatic control-and-inquiry interface to the EXPAND
subsystem, there are two values for the return token that
indicate that the response record does not contain an error
list. One is the value ZSPI-ERR-OK, which means that no error
or warning occurred. The other is an error number defined
by the EXPAND subsystem that signifies the "empty" response
record. This value, ZEXP-ERR-EMPT-RSP, is returned, for example,
when an application requests through ZSPI-TKN-RESPONSE-TYPE that
only response records for objects on which errors or warnings
occurred be returned, and the command finishes processing without
encountering any errors or warnings.
The EXPAND subsystem does not pass through errors from other
subsystems or interfaces.
Error-handling considerations for specific commands are described
in Section 7, "Commands and Responses." The error numbers
returned by the EXPAND subsystem are described in Appendix A.
SECURITY
Security for the EXPAND subsystem is handled by SCP, as described
in the Communications Management Programming Manual.
Some of the EXPAND commands are sensitive commands, meaning that
they can be issued only by certain users (for EXPAND, members of
the SUPER group and members of the same group as the owner of the
EXPAND manager process). When an application that is not allowed
to issue sensitive commands attempts to issue one, SCP returns
an error. For more information on sensitive commands, refer to
Section 7, "Commands and Responses."
5-4
SECTION 6
COMMON DEFINITIONS
The management-programming interfaces to the EXPAND subsystem
make use of definitions from four different sources: the SPI
standard definitions, the EMS standard definitions, the datacommunications standard definitions, and the EXPAND definitions.
This section discusses the definitions from these four sources
that can be used in a management application to communicate with
the EXPAND subsystem.
The information in this section is general information that
applies to all uses of the definitions in the interface to
the EXPAND subsystem. Information about a definition that
is specific to a particular command, response, event message,
or error list is given in the description for that command,
response, event message, or error list.
All definitions in this section are represented in DDL.
Structures, both fixed and extensible, are defined by using DDL
DEF statements. For a quick explanation of DDL as it applies
to SPI, refer to the appendix "Overview of DDL for SPI" in the
Distributed Systems Management (DSM) Programming Manual.
SPI STANDARD DEFINITIONS
Definitions whose names begin with ZSPI- are Subsystem
Programmatic Interface (SPI) standard definitions.
Table 6-1 lists SPI standard definitions that are used in
the management-programming interfaces to the EXPAND subsystem.
These definitions consist of simple tokens that are used in
EXPAND commands, responses, event messages, and error lists;
header tokens and other special tokens that are available to
6-1
COMMON DEFINITIONS
SPI Standard Definitions
all applications using SPI; token and field values; and fixed
structures and token types used in other definitions.
This table does not list SPI error numbers or definitions that
are used only in error lists associated with those error numbers,
nor does it list all the SPI token values that can be used in an
application. For information about these definitions, refer to
the Distributed Systems Management (DSM) Programming Manual.
Table 6-1.
SPI Standard Definitions Used by the EXPAND Subsystem
(Page 1 of 2)
Header Tokens
Other Simple Tokens
ZSPI-TKN-CHECKSUM
ZSPI-TKN-COMMAND
ZSPI-TKN-HDRTYPE
ZSPI-TKN-LASTERR
ZSPI-TKN-LASTERRCODE
ZSPI-TKN-LASTPOSITION
ZSPI-TKN-MAX-FIELD-VERSION
ZSPI-TKN-MAXRESP
ZSPI-TKN-OBJECT-TYPE
ZSPI-TKN-POSITION
ZSPI-TKN-SERVER-VERSION
ZSPI-TKN-SSID
ZSPI-TKN-USEDLEN
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
ZSPI-TKN-CONTEXT
ZSPI-TKN-DATALIST
ZSPI-TKN-ENDLIST
ZSPI-TKN-ERRLIST
ZSPI-TKN-ERROR
ZSPI-TKN-MANAGER
ZSPI-TKN-PARM-ERR
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-SERVER-BANNER
Value Names
Special Tokens
ZSPI-TKN-ADDR
ZSPI-TKN-CLEARERR
ZSPI-TKN-COUNT
ZSPI-TKN-DATA-FLUSH
ZSPI-TKN-DEFAULT-SSID
ZSPI-TKN-DELETE
ZSPI-TKN-INITIAL-POSITION
ZSPI-TKN-LEN
ZSPI-TKN-NEXTCODE
ZSPI-TKN-NEXTTOKEN
ZSPI-TKN-OFFSET
ZSPI-TKN-RESET-BUFFER
6-2
ZSPI-SSN-ZEXP
ZSPI-VAL-FALSE
ZSPI-VAL-TANDEM
ZSPI-VAL-TRUE
COMMON DEFINITIONS
SPI Standard Definitions
Table 6-1.
SPI Standard Definitions Used by the EXPAND Subsystem
(Page 2 of 2)
Token Types
Fixed Structures
ZSPI-TYP-BOOLEAN
ZSPI-TYP-BYTE-PAIR
ZSPI-TYP-BYTESTRING
ZSPI-TYP-CHAR8
ZSPI-TYP-CHAR50
ZSPI-TYP-CRTPID
ZSPI-TYP-ENUM
ZSPI-TYP-ERROR
ZSPI-TYP-FNAME32
ZSPI-TYP-INT
ZSPI-TYP-LIST
ZSPI-TYP-MARK
ZSPI-TYP-PARM-ERR
ZSPI-TYP-SSCTL
ZSPI-TYP-SSID
ZSPI-TYP-STRING
ZSPI-TYP-TIMESTAMP
ZSPI-TYP-UINT
ZSPI-DDL-BOOLEAN
ZSPI-DDL-BYTE
ZSPI-DDL-CHAR8
ZSPI-DDL-CRTPID
ZSPI-DDL-DEVICE
ZSPI-DDL-DISCNAME
ZSPI-DDL-ENUM
ZSPI-DDL-FNAME
ZSPI-DDL-FNAME32
ZSPI-DDL-INT
ZSPI-DDL-INT-PAIR
ZSPI-DDL-INT2
ZSPI-DDL-TIMESTAMP
ZSPI-DDL-UINT
All SPI standard definitions are fully described in the
Distributed Systems Management (DSM) Programming Manual.
Information about these definitions that is specific to the
EXPAND subsystem is given below.
ZSPI-SSN-ZEXP is the subsystem number assigned to the EXPAND
subsystem.
ZSPI-TKN-COMMAND contains the command number of an EXPAND command. These command numbers and their associated commands are
described in Section 7, "Commands and Responses."
ZSPI-TKN-ERROR is the error token. For descriptions of all
EXPAND error numbers and their associated error lists, refer to
Appendix A.
ZSPI-TKN-MANAGER contains the file name of the EXPAND manager
process.
ZSPI-TKN-OBJECT-TYPE contains the object-type number of an EXPAND
object. These object-type numbers are described under "DataCommunications Standard Definitions," later in this section.
6-3
COMMON DEFINITIONS
SPI Standard Definitions
ZSPI-TKN-RETCODE is the return token, which contains one of
the EXPAND or common data-communications error numbers. For
descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A. For descriptions of all
common data-communications error numbers and their associated
error lists, refer to the Communications Management Programming
Manual.
ZSPI-TKN-SERVER-VERSION contains the server version of the EXPAND
manager process.
ZSPI-TKN-SSID contains ZEXP-VAL-SSID, the subsystem ID of the
EXPAND subsystem. ZEXP-VAL-SSID has the following structure
definition:
def ZEXP-VAL-SSID tacl ssid.
02 Z-FILLER
type character 8
value is ZSPI-VAL-TANDEM.
02 Z-OWNER
redefines Z-FILLER
type ZSPI-DDL-CHAR8.
02 Z-NUMBER
type ZSPI-DDL-INT
value is ZSPI-SSN-ZEXP.
02 Z-VERSION
type ZSPI-DDL-UINT
value is ZEXP-VAL-VERSION.
end.
EMS STANDARD DEFINITIONS
Definitions whose names begin with ZEMS- are Event Management
Service (EMS) standard definitions.
Table 6-2 lists EMS standard definitions that are used in
the management-programming interfaces to the EXPAND subsystem.
These definitions consist of simple tokens that are used in
EXPAND event messages; header tokens that are available to
all applications using EMS; and token types used in other
definitions.
This table does not list EMS error numbers or definitions that
are used only in error lists associated with those error numbers.
For information about these definitions, refer to the Event
Management Service (EMS) Manual.
6-4
COMMON DEFINITIONS
EMS Standard Definitions
Table 6-2.
EMS Standard Definitions Used by the EXPAND Subsystem
Header Tokens
Other Simple Tokens
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-EMPHASIS
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEMS-TKN-CU
ZEMS-TKN-LDEV
ZEMS-TKN-LDEVNAME
ZEMS-TKN-OPMSG
ZEMS-TKN-SUBJECT-MARK
Token Types
ZEMS-TYP-OPMSG
All EMS standard definitions are fully described in the Event
Management Service (EMS) Manual. Information about these definitions that is specific to the EXPAND subsystem is given below.
ZEMS-TKN-CONSOLE-PRINT always contains the value ZSPI-VAL-TRUE,
indicating that all EXPAND event messages are displayed on the
operator console controlled by the compatibility distributor
($Z0).
ZEMS-TKN-EVENTNUMBER contains the event number of an EXPAND event
message. These event numbers and their associated event messages
are described in Section 8, "Event Management."
ZEMS-TKN-LDEVNAME contains the device name of the logical device
that is the subject of the event message.
DATA-COMMUNICATIONS STANDARD DEFINITIONS
Definitions whose names begin with ZCOM- are data-communications
standard definitions.
Table 6-3 lists data-communications standard definitions that
are used in the management-programming interfaces to the EXPAND
subsystem. These definitions consist of simple tokens and
extensible structured tokens that are used in EXPAND commands,
responses, and error lists; command numbers; object types; token
and field values; and fixed structures used in other definitions.
6-5
COMMON DEFINITIONS
Data-Communications Standard Definitions
This table does not list data-communications error numbers or
definitions that are used only in error lists associated with
those error numbers. For information about these definitions,
refer to the Communications Management Programming Manual.
Table 6-3.
Data-Communications Standard Definitions Used by the
EXPAND Subsystem
Simple Tokens
Command Numbers
ZCOM-TKN-CMD-TIMEOUT
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZCOM-TKN-SWITCH-CPU
ZCOM-TKN-SWITCH-PATH
ZCOM-TKN-TRACE-OPT
ZCOM-CMD-ABORT
ZCOM-CMD-ALTER
ZCOM-CMD-GETVERSION
ZCOM-CMD-INFO
ZCOM-CMD-LOAD
ZCOM-CMD-PROBE
ZCOM-CMD-RESET
ZCOM-CMD-RESETSTATS
ZCOM-CMD-START
ZCOM-CMD-STATISTICS
ZCOM-CMD-STATUS
ZCOM-CMD-STOP
ZCOM-CMD-SWITCH
ZCOM-CMD-TRACE
Extensible
Structured Tokens
ZCOM-MAP-REQID
ZCOM-MAP-TRACE-MODIF
Fixed Structures
ZCOM-DDL-REQID
ZCOM-DDL-TRACE-MODIF
Object Types
Value Names
ZCOM-OBJ-LINE
ZCOM-OBJ-NULL
ZCOM-OBJ-PATH
ZCOM-OBJ-PROCESS
ZCOM-VAL-PATH-A
ZCOM-VAL-PATH-B
ZCOM-VAL-SUMSTATE-STARTED
ZCOM-VAL-SUMSTATE-STOPPED
All data-communications standard definitions are fully described
in the Communications Management Programming Manual. Information
about these definitions that is specific to the EXPAND subsystem
is given below.
The command numbers and their associated commands are described
in Section 7, "Commands and Responses."
ZCOM-MAP-TRACE-MODIF indicates whether and how tracing is to be
initiated, modified, or terminated by the TRACE command.
6-6
COMMON DEFINITIONS
Data-Communications Standard Definitions
ZCOM-OBJ-LINE is an EXPAND line. In the EXPAND subsystem, a line
is the smallest entity that carries units of data between two
neighboring nodes. A line can be, for instance, a copper wire,
a fiber-optic cable, or a satellite link. Since a path between
neighboring nodes can consist of one or more lines, lines are
subordinate to paths in the hierarchy of objects.
ZCOM-OBJ-NULL refers to the EXPAND manager process. For EXPAND,
this object type can be used only with the GETVERSION command.
ZCOM-OBJ-PATH is an EXPAND path. In the EXPAND subsystem, a path
is a logical connection between any two nodes in the network.
A path between neighboring nodes consists of one or more lines;
commands that operate on a path change or report information
common to all lines in the path. A call to ABORT, START, or STOP
a path always aborts, starts, or stops all lines associated with
that path. Commands operate only on paths between neighboring
nodes.
ZCOM-OBJ-PROCESS is the EXPAND manager process, the NCP process
($NCP), or an EXPAND line-handler process running on a Tandem
NonStop system.
ZCOM-TKN-OBJNAME contains the name of an EXPAND object.
The object name of a LINE object or a PATH object is the name
of a specific line or path, respectively, configured on a single
system. These names are assigned at system-generation time, and
they are unique within a system.
The object name of the NULL object is the name of the EXPAND
manager process.
If a PROCESS object is the EXPAND manager process or the NCP
process ($NCP), its object name is the name of the process. If a
PROCESS object is a line-handler process, its object name is the
object name of a line or path controlled by the process.
Most EXPAND programmatic commands accept up to 30 object names.
ZCOM-TKN-OBJTYPE is included in each response record returned by
the EXPAND subsystem to identify the object type of the object
described in that response record. For the EXPAND subsystem, the
value of this token always matches the value of ZSPI-TKN-OBJECTTYPE.
ZCOM-TKN-SWITCH-CPU indicates that the SWITCH command is to
switch processes between processors. For more information, refer
to the SWITCH command in Section 7, "Commands and Responses."
6-7
COMMON DEFINITIONS
Data-Communications Standard Definitions
ZCOM-TKN-SWITCH-PATH indicates that the SWITCH command is to
switch processes between Communications Interface Unit (CIU)
paths. It has one of the following values:
ZCOM-VAL-PATH-A
The processes are to be switched to path A.
ZCOM-VAL-PATH-B
The processes are to be switched to path B.
For more information, refer to the SWITCH command in Section 7.
ZCOM-TKN-TRACE-OPT indicates what items are to be traced by the
TRACE command. For information on the possible values of this
token, refer to the TRACE command in Section 7.
ZCOM-VAL-PATH-A identifies Communications Interface Unit (CIU)
path A. It is a value of the tokens ZCOM-TKN-SWITCH-PATH and
ZEXP-TKN-CIU-PATH. For more information, see the SWITCH command
in Section 7 and the subsection "Tokens in Event Messages" later
in this section.
ZCOM-VAL-PATH-B identifies Communications Interface Unit (CIU)
path B. It is a value of the tokens ZCOM-TKN-SWITCH-PATH and
ZEXP-TKN-CIU-PATH. For more information, see the SWITCH command
in Section 7 and the subsection "Tokens in Event Messages" later
in this section.
ZCOM-VAL-SUMSTATE-STARTED is a value of the field
extensible structured tokens ZEXP-MAP-STATUS-LINE
STATUS-PATH. It indicates that an EXPAND line or
STARTED summary state. For more information, see
and STATUS PATH commands in Section 7.
ZSTATE of the
and ZEXP-MAPpath is in the
the STATUS LINE
ZCOM-VAL-SUMSTATE-STOPPED is a value of the field
extensible structured tokens ZEXP-MAP-STATUS-LINE
STATUS-PATH. It indicates that an EXPAND line or
STOPPED summary state. For more information, see
and STATUS PATH commands in Section 7.
ZSTATE of the
and ZEXP-MAPpath is in the
the STATUS LINE
COMMON DEFINITIONS FOR THE EXPAND SUBSYSTEM
Definitions whose names begin with ZEXP- are EXPAND definitions.
Those EXPAND definitions that appear in several commands,
responses, or event messages are described in this section. This
section also describes those EXPAND definitions that are not
described elsewhere in the manual, such as the EXPAND subsystem
version number. Definitions are listed in alphabetical order
within each category.
6-8
COMMON DEFINITIONS
Common Definitions for the EXPAND Subsystem
Information about EXPAND definitions that is specific to particular commands, responses, or event messages is discussed in
Section 7, "Commands and Responses," and in Section 8, "Event
Management."
Buffer Declarations
The EXPAND subsystem provides the following buffer declarations
for message buffers that can be used with the SPI procedures.
All applications should use one of these declarations for a
buffer of the recommended size.
ZEXP-DDL-MSG-BUFFER is a message buffer whose size is that
recommended for command messages and for responses in which
each reply message contains a single response record, with the
exception of the PROBE command and the INFO command with ZEXPTKN-INFO-NCP-OPT specified.
def ZEXP-DDL-MSG-BUFFER.
02 Z-MSGCODE
type ZSPI-DDL-INT.
02 Z-BUFLEN
type ZSPI-DDL-UINT.
02 Z-OCCURS
type ZSPI-DDL-UINT.
02 Z-FILLER
type ZSPI-DDL-BYTE
occurs 0 to ZEXP-VAL-BUFLEN times
depending on Z-OCCURS.
end.
ZEXP-DDL-MSG-BUFFER-MAXLEN is a message buffer whose size is
that recommended for responses in which each reply message
contains multiple response records, and also for responses to the
PROBE command and to the INFO command with ZEXP-TKN-INFO-NCP-OPT
specified.
def ZEXP-DDL-MSG-BUFFER-MAXLEN.
02 Z-MSGCODE
type ZSPI-DDL-INT.
02 Z-BUFLEN
type ZSPI-DDL-UINT.
02 Z-OCCURS
type ZSPI-DDL-UINT.
02 Z-FILLER
type ZSPI-DDL-BYTE
occurs 0 to ZEXP-VAL-MAXBUFLEN times
depending on Z-OCCURS.
end.
6-9
COMMON DEFINITIONS
Private Token and Field Types
Private Token and Field Types
The EXPAND subsystem does not define any token or field types.
Predefined Token and Field Values
The EXPAND subsystem defines the following token and field values
for use in more than one command, event message, or error list.
ZEXP-VAL-ASCII represents the ASCII character set. It can occur
as a value of the field ZCHARSET of the extensible structured
tokens ZEXP-MAP-ALTER-LINE, ZEXP-MAP-INFO-LINE-HDLC, and ZEXPMAP-INFO-LINE-CSM. For more information, see the ALTER LINE and
INFO LINE commands in Section 7, "Commands and Responses."
ZEXP-VAL-BUFLEN is the recommended buffer size in bytes for
command messages sent to the EXPAND subsystem and for responses
in which each reply message contains a single response record,
with the exception of the PROBE command and the INFO command with
ZEXP-TKN-INFO-NCP-OPT specified.
ZEXP-VAL-EBCDIC represents the EBCDIC character set. It can
occur as a value of the field ZCHARSET of the extensible
structured tokens ZEXP-MAP-ALTER-LINE, ZEXP-MAP-INFO-LINE-HDLC,
and ZEXP-MAP-INFO-LINE-CSM. For more information, see the ALTER
LINE and INFO LINE commands in Section 7.
ZEXP-VAL-MAX-NUM-OF-PATHS is the maximum number of paths (63)
connecting any one system to its neighboring systems in an EXPAND
network.
ZEXP-VAL-MAX-SYS-NUMBER is the maximum allowable system number
(255) in an EXPAND network.
ZEXP-VAL-MAX-SYSTEMS is the maximum number of systems (255) in an
EXPAND network.
ZEXP-VAL-MAXBUFLEN is the maximum buffer size in bytes for
command messages sent to the EXPAND subsystem. This is the
recommended buffer size for responses in which each reply message
contains multiple response records, and also for the PROBE
command and for the INFO command with ZEXP-TKN-INFO-NCP-OPT
specified.
ZEXP-VAL-MIN-SYS-NUMBER is the minimum allowable system number
(0) in an EXPAND network.
ZEXP-VAL-RS232 represents the RS-232 hardware interface. It
can occur as a value of the field ZINTERF of the extensible
6-10
COMMON DEFINITIONS
Predefined Token and Field Values
structured tokens ZEXP-MAP-ALTER-LINE, ZEXP-MAP-INFO-LINE-HDLC,
and ZEXP-MAP-INFO-LINE-CSM. For more information, see the ALTER
LINE and INFO LINE commands in Section 7.
ZEXP-VAL-RS422 represents the RS-422 hardware interface. It
can occur as a value of the field ZINTERF of the extensible
structured tokens ZEXP-MAP-ALTER-LINE, ZEXP-MAP-INFO-LINE-HDLC,
and ZEXP-MAP-INFO-LINE-CSM. For more information, see the ALTER
LINE and INFO LINE commands in Section 7.
ZEXP-VAL-SSID is the subsystem ID for the EXPAND subsystem. Its
structure definition is given earlier in this section, under "SPI
Standard Definitions."
For more information about ZEXP-VAL-SSID, refer to the discussion
of the subsystem ID in the Distributed Systems Management (DSM)
Programming Manual.
ZEXP-VAL-VERSION is the version number of this version of the
EXPAND subsystem. This value is a 16-bit unsigned integer; the
left byte contains the letter part of the version as an ASCII
uppercase alphabetic character, and the right byte contains the
numeric part of the version as an unsigned integer value.
Simple Tokens
The following simple tokens are used in several commands.
ZEXP-TKN-CALLED-SYS is the system number (as identified to
SYSGEN) of the destination system in commands that provide
information about connections between systems. Its token type
is ZSPI-TYP-INT. For more information, see the INFO PROCESS,
PROBE, and STATISTICS PROCESS commands in Section 7, "Commands
and Responses."
ZEXP-TKN-SEL-SYS is the system number (as identified to SYSGEN)
of the source (selected) system in commands that provide information about connections between systems. Its token type is ZSPITYP-INT. For more information, see the INFO PROCESS, PROBE, and
STATISTICS PROCESS commands in Section 7.
The following simple tokens appear in error lists returned by the
EXPAND subsystem. These tokens and all the EXPAND error lists
are described in Appendix A.
ZEXP-TKN-LH-ERR-NUM contains a file-system error number returned
by a line-handler process.
ZEXP-TKN-NCP-ERR-NUM contains a file-system error number returned
by the NCP.
6-11
COMMON DEFINITIONS
Simple Tokens
The following simple tokens appear in several EXPAND event
messages. They are described later in this section under "Tokens
in Event Messages."
ZEXP-TKN-CIU-PATH indicates the CIU path.
ZEXP-TKN-SYS-MSG-MODE indicates what software component the event
message relates to.
ZEXP-TKN-SYSNAME contains a system name.
ZEXP-TKN-SYSNUM contains a system number.
Extensible Structured Tokens
The following extensible structured tokens appear in multiple
EXPAND responses.
ZEXP-MAP-STATS-LINE-CSM is an extensible structured token that
contains the current statistical information for a line handler
configured as HDLC Normal for 6100 Communications Subsystem
(CSS). It has the token number ZEXP-TNM-STATS-LINE-CSM and the
DDL definition ZEXP-DDL-STATS-LINE-CSM. This token is returned
in the responses to the RESETSTATS LINE and STATISTICS LINE
commands, which are described in Section 7, "Commands and
Responses."
def ZEXP-DDL-STATS-LINE-CSM.
02 ZLAST-RESETSTATS-TMSTP
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
ZSTATS-CURR-TMSTP
ZI-FRAMES-SENT
ZI-FRAMES-RECV
ZS-FRAMES-SENT
ZS-FRAMES-RECV
ZU-FRAMES-SENT
ZU-FRAMES-RECV
ZBCC-ERRS
ZALLOC-ERRS
ZQUAL-ERRS
ZFRAMES-TOTAL
ZFRAMES-ERR
ZL2-I-FRAMES-SENT
ZL2-I-FRAMES-SENT-P
ZL2-I-FRAMES-RECV
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
>
6-12
COMMON DEFINITIONS
Extensible Structured Tokens
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
end.
ZL2-I-FRAMES-RECV-P
ZL2-RR-FRAMES-SENT
ZL2-RNR-FRAMES-SENT
ZL2-REJ-FRAMES-SENT
ZL2-RR-FRAMES-RECV
ZL2-RNR-FRAMES-RECV
ZL2-REJ-FRAMES-RECV
ZL2-SABM-FRAMES-SENT
ZL2-SABM-FRAMES-RECV
ZL2-DISC-FRAMES-SENT
ZL2-DISC-FRAMES-RECV
ZL2-CMDR-FRAMES-SENT
ZL2-CMDR-FRAMES-RECV
ZL2-UA-FRAMES-SENT
ZL2-UA-FRAMES-RECV
ZL2-DM-FRAMES-SENT
ZL2-DM-FRAMES-RECV
ZL2-RECV-OVERRUN
ZL2-MODEM-ERRS
ZL2-SREJ-FRAMES-SENT
ZL2-SREJ-FRAMES-RECV
ZL2-FCS-ERRS
ZL2-TIMEOUT
ZL2-ADDR-ERRS
ZL2-LEN-ERRS
ZL2-RECV-ABORTED
ZL2-RECV-BUFF
ZL2-STATE-CTS
ZL2-STATE-DCD
ZL2-STATE-DSR
ZLINE-PPID
ZLINE-BPID
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-BYTE.
ZSPI-DDL-BYTE.
ZSPI-DDL-BYTE.
ZSPI-DDL-INT-PAIR.
ZSPI-DDL-INT-PAIR.
ZLAST-RESETSTATS-TMSTP contains the time that the statistics
counters were last restored to their initial values.
ZSTATS-CURR-TMSTP contains the time that the statistics counters
were read.
The following fields of ZEXP-MAP-STATS-LINE-CSM (fields
ZI-FRAMES-SENT through ZU-FRAMES-RECV) contain counts of the
numbers of level-2 frames sent and received.
ZI-FRAMES-SENT contains the total number of I-frames sent.
ZI-FRAMES-RECV contains the total number of I-frames received.
6-13
COMMON DEFINITIONS
Extensible Structured Tokens
ZS-FRAMES-SENT contains the total number of S-frames sent.
ZS-FRAMES-RECV contains the total number of S-frames received.
ZU-FRAMES-SENT contains the total number of U-frames sent.
ZU-FRAMES-RECV contains the total number of U-frames received.
The following fields of ZEXP-MAP-STATS-LINE-CSM (fields ZBCC-ERRS
through ZFRAMES-ERR) relate to the numbers of errors in received
frames. These error counts apply only to the link between the
I/O process and the CLIP (that is, to the CIU-to-LIU Bus, or
CLB).
ZBCC-ERRS contains the total number of BCC/VRC errors and FCS
errors detected in driver frames received by a bit-synchronous or
byte-synchronous controller.
ZALLOC-ERRS contains the total number of buffer-allocation
failures.
ZQUAL-ERRS contains the total number of line-quality errors.
ZFRAMES-TOTAL contains the total number of frames handled.
ZFRAMES-ERR contains the total number of received frames that had
errors. The count of error frames is incremented each time one
or more of the following errors occurs while receiving a frame:
•
A BCC/VRC error or an FCS error on a frame received by a bitsynchronous or byte-synchronous controller
•
An overrun error due to unavailability of resources
•
A one-byte frame (for LAPX protocol only)
The count is also incremented each time a level-2 timeout occurs
while level 2 is waiting for an acknowledgment of an information
frame.
The following fields of ZEXP-MAP-STATS-LINE-CSM (fields ZL2-IFRAMES-SENT through ZL2-SREJ-FRAMES-RECV) contain a more detailed
breakdown of the numbers of level-2 frames sent and received.
ZL2-I-FRAMES-SENT contains the total number of I-frames without
the poll bit set that have been sent.
ZL2-I-FRAMES-SENT-P contains the total number of I-frames with
the poll bit set that have been sent.
6-14
COMMON DEFINITIONS
Extensible Structured Tokens
ZL2-I-FRAMES-RECV contains the total number of I-frames without
the poll bit set that have been received.
ZL2-I-FRAMES-RECV-P contains the total number of I-frames with
the poll bit set that have been received.
ZL2-RR-FRAMES-SENT contains the total number of RR frames sent.
ZL2-RNR-FRAMES-SENT contains the total number of RNR frames sent.
ZL2-REJ-FRAMES-SENT contains the total number of REJ frames sent.
ZL2-RR-FRAMES-RECV contains the total number of RR frames
received.
ZL2-RNR-FRAMES-RECV contains the total number of RNR frames
received.
ZL2-REJ-FRAMES-RECV contains the total number of REJ frames
received.
ZL2-SABM-FRAMES-SENT contains the total number of SABM frames
sent.
ZL2-SABM-FRAMES-RECV contains the total number of SABM frames
received.
ZL2-DISC-FRAMES-SENT contains the total number of DISC frames
sent.
ZL2-DISC-FRAMES-RECV contains the total number of DISC frames
received.
ZL2-CMDR-FRAMES-SENT contains the total number of CMDR frames
sent.
ZL2-CMDR-FRAMES-RECV contains the total number of CMDR frames
received.
ZL2-UA-FRAMES-SENT contains the total number of UA frames sent.
ZL2-UA-FRAMES-RECV contains the total number of UA frames
received.
ZL2-DM-FRAMES-SENT contains the total number of DM frames sent.
ZL2-DM-FRAMES-RECV contains the total number of DM frames
received.
ZL2-RECV-OVERRUN contains the total number of frames received
that were longer than the maximum frame size specified.
ZL2-MODEM-ERRS contains the total number of modem errors.
6-15
COMMON DEFINITIONS
Extensible Structured Tokens
ZL2-SREJ-FRAMES-SENT contains the total number of SREJ frames
sent.
ZL2-SREJ-FRAMES-RECV contains the total number of SREJ frames
received.
The following fields of ZEXP-MAP-STATS-LINE-CSM (fields ZL2-FCSERRS through ZL2-STATE-DSR) contain counts of errors on frames
received from the modem that are reported by the HDLC protocol
running in the CLIP.
ZL2-FCS-ERRS contains the total number of FCS errors detected in
driver frames received.
ZL2-TIMEOUT contains the total number of T1 timeouts.
ZL2-ADDR-ERRS contains the total number of address-field errors.
ZL2-LEN-ERRS contains the total number of frame-length errors.
ZL2-RECV-ABORTED contains the total number of receive aborts.
ZL2-RECV-BUFF contains the total number of receive buffers.
ZL2-STATE-CTS contains the state of the CTS signal.
ZL2-STATE-DCD contains the state of the DCD signal.
ZL2-STATE-DSR contains the state of the DSR signal.
The following fields of ZEXP-MAP-STATS-LINE-CSM identify the
primary and backup line-handler processes associated with the
given line.
ZLINE-PPID is the process ID of the primary line-handler process
associated with the line.
ZLINE-BPID is the process ID of the backup line-handler process
associated with the line.
ZEXP-MAP-STATS-LINE-NCSM is an extensible structured token that
contains the current statistical information for a line handler
configured as anything other than HDLC Normal for 6100 CSS.
It has the token number ZEXP-TNM-STATS-LINE-NCSM and the DDL
definition ZEXP-DDL-STATS-LINE-NCSM. This token is returned
in the responses to the RESETSTATS LINE and STATISTICS LINE
commands, which are described in Section 7, "Commands and
Responses."
6-16
COMMON DEFINITIONS
Extensible Structured Tokens
def ZEXP-DDL-STATS-LINE-NCSM.
02 ZLAST-RESETSTATS-TMSTP
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
end.
ZSTATS-CURR-TMSTP
ZI-FRAMES-SENT
ZI-FRAMES-RECV
ZS-FRAMES-SENT
ZS-FRAMES-RECV
ZU-FRAMES-SENT
ZU-FRAMES-RECV
ZBCC-ERRS
ZALLOC-ERRS
ZQUAL-ERRS
ZFRAMES-TOTAL
ZFRAMES-ERR
ZL2-I-FRAMES-SENT
ZL2-I-FRAMES-SENT-P
ZL2-I-FRAMES-RECV
ZL2-I-FRAMES-RECV-P
ZL2-RR-FRAMES-SENT
ZL2-RNR-FRAMES-SENT
ZL2-REJ-FRAMES-SENT
ZL2-RR-FRAMES-RECV
ZL2-RNR-FRAMES-RECV
ZL2-REJ-FRAMES-RECV
ZL2-SABM-FRAMES-SENT
ZL2-SABM-FRAMES-RECV
ZL2-DISC-FRAMES-SENT
ZL2-DISC-FRAMES-RECV
ZL2-CMDR-FRAMES-SENT
ZL2-CMDR-FRAMES-RECV
ZL2-UA-FRAMES-SENT
ZL2-UA-FRAMES-RECV
ZL2-DM-FRAMES-SENT
ZL2-DM-FRAMES-RECV
ZL2-RECV-OVERRUN
ZL2-MODEM-ERRS
ZL2-SREJ-FRAMES-SENT
ZL2-SREJ-FRAMES-RECV
ZLINE-PPID
ZLINE-BPID
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT-PAIR.
ZSPI-DDL-INT-PAIR.
ZLAST-RESETSTATS-TMSTP contains the time that the statistics
counters were last restored to their initial values.
ZSTATS-CURR-TMSTP contains the time that the statistics counters
were read.
6-17
COMMON DEFINITIONS
Extensible Structured Tokens
The following fields of ZEXP-MAP-STATS-LINE-NCSM (fields
ZI-FRAMES-SENT through ZU-FRAMES-RECV) contain counts of the
numbers of level-2 frames sent and received.
ZI-FRAMES-SENT contains the total number of I-frames sent.
ZI-FRAMES-RECV contains the total number of I-frames received.
ZS-FRAMES-SENT contains the total number of S-frames sent.
ZS-FRAMES-RECV contains the total number of S-frames received.
ZU-FRAMES-SENT contains the total number of U-frames sent.
ZU-FRAMES-RECV contains the total number of U-frames received.
The following fields of ZEXP-MAP-STATS-LINE-NCSM (fields ZBCCERRS through ZFRAMES-ERR) relate to the numbers of errors in
frames received from the modem.
ZBCC-ERRS contains the total number of BCC/VRC errors and FCS
errors detected in driver frames received by a bit-synchronous or
byte-synchronous controller.
ZALLOC-ERRS contains the total number of buffer-allocation
failures.
ZQUAL-ERRS contains the total number of line-quality errors.
ZFRAMES-TOTAL contains the total number of frames handled.
ZFRAMES-ERR contains the total number of received frames that had
errors. The count of error frames is incremented each time one
or more of the following errors occurs while receiving a frame:
•
A BCC/VRC error or an FCS error on a frame received by a bitsynchronous or byte-synchronous controller
•
An overrun error due to unavailability of resources
•
A one-byte frame (for LAPX protocol only)
The count is also incremented each time a level-2 timeout occurs
while level 2 is waiting for an acknowledgment of an information
frame.
6-18
COMMON DEFINITIONS
Extensible Structured Tokens
The following fields of ZEXP-MAP-STATS-LINE-NCSM (fields ZL2-IFRAMES-SENT through ZL2-SREJ-FRAMES-RECV) contain a more detailed
breakdown of the numbers of level-2 frames sent and received.
ZL2-I-FRAMES-SENT contains the total number of I-frames without
the poll bit set that have been sent.
ZL2-I-FRAMES-SENT-P contains the total number of I-frames with
the poll bit set that have been sent.
ZL2-I-FRAMES-RECV contains the total number of I-frames without
the poll bit set that have been received.
ZL2-I-FRAMES-RECV-P contains the total number of I-frames with
the poll bit set that have been received.
ZL2-RR-FRAMES-SENT contains the total number of RR frames sent.
ZL2-RNR-FRAMES-SENT contains the total number of RNR frames sent.
ZL2-REJ-FRAMES-SENT contains the total number of REJ frames sent.
ZL2-RR-FRAMES-RECV contains the total number of RR frames
received.
ZL2-RNR-FRAMES-RECV contains the total number of RNR frames
received.
ZL2-REJ-FRAMES-RECV contains the total number of REJ frames
received.
ZL2-SABM-FRAMES-SENT contains the total number of SABM frames
sent.
ZL2-SABM-FRAMES-RECV contains the total number of SABM frames
received.
ZL2-DISC-FRAMES-SENT contains the total number of DISC frames
sent.
ZL2-DISC-FRAMES-RECV contains the total number of DISC frames
received.
ZL2-CMDR-FRAMES-SENT contains the total number of CMDR frames
sent.
ZL2-CMDR-FRAMES-RECV contains the total number of CMDR frames
received.
ZL2-UA-FRAMES-SENT contains the total number of UA frames sent.
ZL2-UA-FRAMES-RECV contains the total number of UA frames
received.
6-19
COMMON DEFINITIONS
Extensible Structured Tokens
ZL2-DM-FRAMES-SENT contains the total number of DM frames sent.
ZL2-DM-FRAMES-RECV contains the total number of DM frames
received.
ZL2-RECV-OVERRUN contains the total number of frames received
that were longer than the maximum frame size specified.
ZL2-MODEM-ERRS contains the total number of modem errors.
ZL2-SREJ-FRAMES-SENT contains the total number of SREJ frames
sent.
ZL2-SREJ-FRAMES-RECV contains the total number of SREJ frames
received.
The following fields of ZEXP-MAP-STATS-LINE-NCSM identify the
primary and backup line-handler processes associated with the
given line.
ZLINE-PPID is the process ID of the primary line-handler process
associated with the line.
ZLINE-BPID is the process ID of the backup line-handler process
associated with the line.
ZEXP-MAP-STATS-PATH is an extensible structured token that contains the current statistical information for an EXPAND path. It
has the token number ZEXP-TNM-STATS-PATH and the DDL definition
ZEXP-DDL-STATS-PATH. This token is returned in the responses
to the RESETSTATS PATH and STATISTICS PATH commands, which are
described in Section 7, "Commands and Responses."
def ZEXP-DDL-STATS-PATH.
02 ZLAST-RESETSTATS-TMSTP
02
02
02
02
02
02
02
02
02
02
ZSTATS-CURR-TMSTP
ZL4-PKTS-SENT
ZL4-PKTS-RECV
ZL4-FWD-SENT
ZL4-FWD-RECV
ZL4-LINK-REQ-SENT
ZL4-LINK-REQ-RECV
ZL4-REQ-SENT-CONN
ZL4-REQ-SENT-TRACE
ZL4-REQ-SENT-NCP
type
type
type
type
type
type
type
type
type
type
type
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
>
6-20
COMMON DEFINITIONS
Extensible Structured Tokens
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
02
end.
ZL4-REQ-SENT-LRQ
type
ZL4-REQ-SENT-LCMP
type
ZL4-REQ-SENT-CANCEL
type
ZL4-REQ-SENT-ACK
type
ZL4-REQ-SENT-NAK
type
ZL4-REQ-SENT-ENQ
type
ZL4-REQ-RECV-CONN
type
ZL4-REQ-RECV-TRACE
type
ZL4-REQ-RECV-NCP
type
ZL4-REQ-RECV-LRQ
type
ZL4-REQ-RECV-LCMP
type
ZL4-REQ-RECV-CANCEL
type
ZL4-REQ-RECV-ACK
type
ZL4-REQ-RECV-NAK
type
ZL4-REQ-RECV-ENQ
type
ZLOC-POOL-CURR-USED
type
ZLOC-POOL-MAX-USED
type
ZFRAMES-LE-64
type
ZFRAMES-LE-128
type
ZFRAMES-LE-256
type
ZFRAMES-LE-512
type
ZFRAMES-LE-1024
type
ZFRAMES-LE-2048
type
ZFRAMES-LE-4096
type
ZFRAMES-GT-4096
type
ZOUT-OF-SEQ-POOL-CURR-USED
type
ZOUT-OF-SEQ-POOL-MAX-USED
type
ZMAX-POOL-USED
type
ZOUT-OF-SEQ-TIMEOUT
type
ZPATH-CHANGES-SENT
type
ZPATH-CHANGES-RECV
type
ZLOC-POOL-PAGES
type
ZLOC-POOL-FAILS
type
ZKNOWN-SYS
type
ZPATH-PPID
type
ZPATH-BPID
type
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT-PAIR.
ZSPI-DDL-INT-PAIR.
ZLAST-RESETSTATS-TMSTP contains the time that the statistics
counters were last restored to their initial values.
ZSTATS-CURR-TMSTP contains the time that the statistics counters
were read.
6-21
COMMON DEFINITIONS
Extensible Structured Tokens
The following fields of ZEXP-MAP-STATS-PATH (fields ZL4-PKTSSENT through ZL4-REQ-RECV-ENQ) contain information about level-4
processing, which is related to the sending and receiving of
requests and responses.
ZL4-PKTS-SENT contains the total number of packets sent on this
path.
ZL4-PKTS-RECV contains the total number of packets received on
this path.
ZL4-FWD-SENT contains the total number of forwarded packets that
were received at this node on other paths and sent on this path.
ZL4-FWD-RECV contains the total number of forwarded packets that
were received at this node on this path and sent on other paths.
ZL4-LINK-REQ-SENT contains the total number of link requests sent
from this node on this path.
ZL4-LINK-REQ-RECV contains the total number of link requests
received at this node on this path.
ZL4-REQ-SENT-CONN contains the total number of connect requests
sent.
ZL4-REQ-SENT-TRACE contains the total number of trace requests
sent.
ZL4-REQ-SENT-NCP contains the total number of NCP messages sent.
ZL4-REQ-SENT-LRQ contains the total number of LRQ requests sent.
ZL4-REQ-SENT-LCMP contains the total number of LCMP requests
sent.
ZL4-REQ-SENT-CANCEL contains the total number of cancel requests
sent.
ZL4-REQ-SENT-ACK contains the total number of ACKs sent.
ZL4-REQ-SENT-NAK contains the total number of NAKs sent.
ZL4-REQ-SENT-ENQ contains the total number of enquiry requests
sent.
ZL4-REQ-RECV-CONN contains the total number of connect requests
received.
ZL4-REQ-RECV-TRACE contains the total number of trace requests
received.
6-22
COMMON DEFINITIONS
Extensible Structured Tokens
ZL4-REQ-RECV-NCP contains the total number of NCP messages
received.
ZL4-REQ-RECV-LRQ contains the total number of LRQ requests
received.
ZL4-REQ-RECV-LCMP contains the total number of LCMP requests
received.
ZL4-REQ-RECV-CANCEL contains the total number of cancel requests
received.
ZL4-REQ-RECV-ACK contains the total number of ACKs received.
ZL4-REQ-RECV-NAK contains the total number of NAKs received.
ZL4-REQ-RECV-ENQ contains the total number of enquiry requests
received.
The following fields of ZEXP-MAP-STATS-PATH (fields ZLOC-POOLCURR-USED through ZKNOWN-SYS) contain information about the
network in general.
ZLOC-POOL-CURR-USED contains the number of kilobytes of local
pool currently being used.
ZLOC-POOL-MAX-USED contains the maximum number of kilobytes of
local pool that have been used.
ZFRAMES-LE-64 contains the number of messages sent and received
by this node over this path whose size is less than or equal to
64 bytes.
ZFRAMES-LE-128 contains the number of messages sent and received
by this node over this path whose size is less than or equal to
128 bytes.
ZFRAMES-LE-256 contains the number of messages sent and received
by this node over this path whose size is less than or equal to
256 bytes.
ZFRAMES-LE-512 contains the number of messages sent and received
by this node over this path whose size is less than or equal to
512 bytes.
ZFRAMES-LE-1024 contains the number of messages sent and received
by this node over this path whose size is less than or equal to
1024 bytes.
ZFRAMES-LE-2048 contains the number of messages sent and received
by this node over this path whose size is less than or equal to
2048 bytes.
6-23
COMMON DEFINITIONS
Extensible Structured Tokens
ZFRAMES-LE-4096 contains the number of messages sent and received
by this node over this path whose size is less than or equal to
4096 bytes.
ZFRAMES-GT-4096 contains the number of messages sent and received
by this node over this path whose size is greater than 4096
bytes.
ZOUT-OF-SEQ-POOL-CURR-USED contains the number of words of outof-sequence buffer pool currently being used.
ZOUT-OF-SEQ-POOL-MAX-USED contains the maximum number of words of
out-of-sequence buffer pool that have been used.
ZMAX-POOL-USED contains the maximum number of kilobytes of buffer
pool that have been used.
ZOUT-OF-SEQ-TIMEOUT contains the total number of out-of-sequence
timeouts.
ZPATH-CHANGES-SENT contains the total number of path-change
messages sent.
ZPATH-CHANGES-RECV contains the total number of path-change
messages received.
ZLOC-POOL-PAGES contains the number of pages in the local pool.
ZLOC-POOL-FAILS contains the number of local-pool allocation
failures.
ZKNOWN-SYS contains the number of known systems.
The following fields of ZEXP-MAP-STATS-PATH identify the primary
and backup line-handler processes associated with the given path.
ZPATH-PPID is the process ID of the primary line-handler process
associated with the path.
ZPATH-BPID is the process ID of the backup line-handler process
associated with the path.
Tokens in Error Lists
The following tokens appear in error lists returned by the EXPAND
subsystem. These tokens and all the EXPAND error lists are
described in Appendix A.
6-24
COMMON DEFINITIONS
Tokens in Error Lists
ZEXP-TKN-LH-ERR-NUM contains a file-system error number returned
by a line-handler process.
ZEXP-TKN-NCP-ERR-NUM contains a file-system error number returned
by the NCP.
Tokens in Event Messages
The following tokens appear in several event messages issued by
the EXPAND subsystem. The EXPAND event messages are described in
Section 8, "Event Management."
ZEXP-TKN-CIU-PATH is a token that indicates the CIU path. It has
the token number ZEXP-TNM-CIU-PATH and the token type ZSPI-TYPENUM. This token is an unconditional token, and it can have the
following values:
ZCOM-VAL-PATH-A
The CIU path is path A.
ZCOM-VAL-PATH-B
The CIU path is path B.
ZEXP-TKN-SYS-MSG-MODE is a token that indicates what software
component the event message relates to. It has the token number
ZEXP-TNM-SYS-MSG-MODE and the token type ZSPI-TYP-INT. This
token is an unconditional token, and it can have the following
values:
0
The event message is related to the GUARDIAN 90 operating
system.
1
The event message is related to the EXPAND subsystem.
2
The event message is related to X25AM.
3
The event message is related to device access.
ZEXP-TKN-SYSNAME is a token that contains the system name of the
system that is the subject of the event message. It has the
token number ZEXP-TNM-SYSNAME and the token type ZSPI-TYP-CHAR8.
This token is an unconditional token.
ZEXP-TKN-SYSNUM is a token that contains the system number of
the system that is the subject of the event message. It has
the token number ZEXP-TNM-SYSNUM and the token type ZSPI-TYP-INT.
This token is an unconditional token.
6-25
SECTION 7
COMMANDS AND RESPONSES
This section describes the syntax and semantics for all commands
and responses in the programmatic control-and-inquiry interface
to the EXPAND subsystem.
These commands allow an application to do the following:
•
Change the attributes of EXPAND objects
•
Start and stop the operation of EXPAND objects
•
Obtain attribute values
•
Obtain statistical and status information
•
Trace the operation of EXPAND objects
In this section, command numbers, object types, and all tokens
and their values are represented in DDL. For a quick explanation
of DDL as it applies to SPI, refer to the appendix "Overview
of DDL for SPI" in the Distributed Systems Management (DSM)
Programming Manual.
Table 7-1 lists all the commands that are available in the
programmatic control-and-inquiry interface to the EXPAND subsystem and gives their symbolic names.
7-1
COMMANDS AND RESPONSES
Table 7-1.
Commands and Their Symbolic Names (Page 1 of 2)
SYMBOLIC NAME OF
COMMAND AND OBJECT
COMMAND
ABORT LINE
ZCOM-CMD-ABORT
PATH
ZCOM-OBJ-LINE
ZCOM-OBJ-PATH
ALTER LINE
ZCOM-CMD-ALTER
ZCOM-OBJ-LINE
PATH
ZCOM-OBJ-PATH
PROCESS
ZCOM-OBJ-PROCESS
GETVERSION
ZCOM-CMD-GETVERSION
ZCOM-OBJ-PROCESS
ZCOM-OBJ-NULL
INFO LINE
ZCOM-CMD-INFO
ZCOM-OBJ-LINE
PATH
ZCOM-OBJ-PATH
PROCESS
ZCOM-OBJ-PROCESS
LOAD
ZCOM-CMD-LOAD
ZCOM-OBJ-LINE
PROBE
ZCOM-CMD-PROBE
ZCOM-OBJ-PROCESS
RESET
ZCOM-CMD-RESET
ZCOM-OBJ-LINE
RESETSTATS LINE
ZCOM-CMD-RESETSTATS
ZCOM-OBJ-LINE
PATH
START LINE
PATH
7-2
ZCOM-OBJ-PATH
ZCOM-CMD-START
ZCOM-OBJ-LINE
ZCOM-OBJ-PATH
COMMANDS AND RESPONSES
Table 7-1.
Commands and Their Symbolic Names (Page 2 of 2)
SYMBOLIC NAME OF
COMMAND AND OBJECT
COMMAND
STATISTICS LINE
ZCOM-CMD-STATISTICS
ZCOM-OBJ-LINE
PATH
ZCOM-OBJ-PATH
PROCESS
ZCOM-OBJ-PROCESS
STATUS LINE
ZCOM-CMD-STATUS
PATH
ZCOM-OBJ-LINE
ZCOM-OBJ-PATH
STOP LINE
ZCOM-CMD-STOP
ZCOM-OBJ-LINE
PATH
ZCOM-OBJ-PATH
SWITCH
ZCOM-CMD-SWITCH
ZCOM-OBJ-PROCESS
TRACE
ZCOM-CMD-TRACE
ZCOM-OBJ-PROCESS
COMMANDS BY OBJECT TYPE
The following EXPAND commands accept the LINE object type:
ABORT
ALTER
INFO
LOAD
RESET
RESETSTATS
START
STATISTICS
STATUS
STOP
The following commands accept the NULL object type:
GETVERSION
7-3
COMMANDS AND RESPONSES
Commands by Object Type
The following commands accept the PATH object type:
ABORT
ALTER
INFO
RESETSTATS
START
STATISTICS
STATUS
STOP
The following commands accept the PROCESS object type:
ALTER
GETVERSION
INFO
PROBE
STATISTICS
SWITCH
TRACE
SENSITIVE AND NONSENSITIVE COMMANDS
Commands are divided into two groups based on whether or not a
user must have proper security to be able to use the command.
These two groups are called sensitive commands and nonsensitive
commands.
Sensitive commands can change the summary state of an object.
The only users allowed to issue a sensitive command are the
members of the SUPER group and the members of the same group as
the owner of the EXPAND manager process.
The following EXPAND commands are sensitive commands:
ABORT
ALTER
LOAD
RESET
RESETSTATS
START
STOP
SWITCH
TRACE
Nonsensitive commands do not change the summary state of an
object, and these commands can be issued by any user.
The following EXPAND commands are nonsensitive commands:
GETVERSION
INFO
PROBE
STATISTICS
STATUS
7-4
COMMANDS AND RESPONSES
Command Descriptions
COMMAND DESCRIPTIONS
On the following pages, each EXPAND command and its response
is described in detail. The command descriptions appear in
alphabetical order.
Within each command description, there is a box that contains the
symbolic name of the command number, the symbolic names of all
object types accepted by the command, a list of tokens that can
be present in the command buffer, and a list of tokens that can
be present in the response buffer.
The order in which tokens are presented in the command and
response parts of the syntax box is arbitrary, except that ZSPITKN-ENDLIST occurs after its corresponding ZSPI-TKN-DATALIST or
ZSPI-TKN-ERRLIST. The syntax box shows the pairs ZSPI-TKNDATALIST ... ZSPI-TKN-ENDLIST and ZSPI-TKN-ERRLIST ... ZSPITKN-ENDLIST together to show that they are pairs. In the actual
buffer, both sets of pairs enclose additional tokens.
In the actual buffer, the token ZSPI-TKN-DATALIST, if present,
always appears at the beginning of each response record, and
the token ZSPI-TKN-ENDLIST always appears at the end of each
response record. The other tokens listed in the response part
of the syntax box, except for the context token ZSPI-TKN-CONTEXT,
are the tokens that can be contained in a response record.
Similarly, in the buffer, each ZSPI-TKN-ERRLIST ... ZSPI-TKNENDLIST pair encloses a set of tokens; this set of tokens depends
not on the command but on the value of ZSPI-TKN-RETCODE, and are
given in Appendix A.
For more information on the structure of responses, and for
information on the context token, refer to the Distributed
Systems Management (DSM) Programming Manual.
The notation used in the box for simple tokens is a shorthand
version of the essential information given in the DDL TOKEN-CODE
statement. Extensible structured tokens are defined by using DDL
DEF statements.
For each token in the command buffer, and for each field of
an extensible structured token in the command buffer, the box
contains an indication of whether or not the token or field must
be present in the command. For a token, the notation "!r" means
that the token must be present (is required) in the command, and
the notation "!o" means that the token may or may not be present
(is optional) in the command. For a field of an extensible
structured token, the notation "!r" means that the field must
have a value other than its null value, and the notation "!o"
means that the field may or may not have a value other than its
null value.
7-5
COMMANDS AND RESPONSES
Command Descriptions
Data lists and error lists are indicated in the box by following
each of the tokens ZSPI-TKN-DATALIST and ZSPI-TKN-ERRLIST,
respectively, by an ellipsis (...) and the token ZSPI-TKNENDLIST. The token ZSPI-TKN-ENDLIST is indented to show that
it is present only if the list token is present. For more
information on data lists and error lists, refer to the
Distributed Systems Management (DSM) Programming Manual.
Following the box, the tokens in the command buffer and the
tokens in the response buffer are described in the same order as
they appeared in the box.
The command descriptions refer to some concepts common to several
Tandem data-communications subsystems--for instance, summary
states. For more information about these concepts, refer to
the Communications Management Programming Manual. For background
information on the EXPAND subsystem, refer to the EXPAND
Reference Manual. For more information about setting the
configuration attributes listed in the descriptions of the ALTER
and INFO commands, refer to the System Generation Manual.
7-6
COMMANDS AND RESPONSES
ABORT Command
ABORT Command
The ABORT command terminates the operation of one or more lines
or paths as quickly as possible--only enough processing is done
to ensure the integrity of the subsystem.
Command
ZCOM-CMD-ABORT
Object Type
ZCOM-OBJ-LINE
or
ZCOM-OBJ-PATH
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
token-type ZSPI-TYP-LIST.
token-type
token-type
token-type
token-type
ZSPI-TYP-SSCTL.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
>
7-7
COMMANDS AND RESPONSES
ABORT Command
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line or path to be terminated. This token must be present
in the command, and from 1 through 30 line or path names are
allowed. ZCOM-TKN-OBJNAME is described in Section 6, "Common
Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line or path that was terminated by the command. This
token is present in every response record. ZCOM-TKN-OBJNAME is
described in Section 6, "Common Definitions."
7-8
COMMANDS AND RESPONSES
ABORT Command
ZCOM-TKN-OBJTYPE is an object-type token that indicates the type
of the object named in ZCOM-TKN-OBJNAME. This token can have the
following values:
ZCOM-OBJ-LINE
The object is a line.
ZCOM-OBJ-PATH
The object is a path.
ZCOM-TKN-OBJTYPE is present in every response record, and it is
described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the ABORT command are the following:
-16
(ZCOM-ERR-OBJ-ALRDY-IN-SUMSTATE):
in the desired summary state.
The object is already
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
2
(ZEXP-ERR-NEG-LH-RSP):
a negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The EXPAND line handler returned
The empty response record is being
For command-specific information about these error numbers,
see "Error-Handling Notes" below. For descriptions of all
EXPAND error numbers and their associated error lists, refer to
Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
ABORT is a sensitive command.
•
If the object type for the ABORT command is ZCOM-OBJ-LINE,
execution of this command terminates activity on the specified
7-9
COMMANDS AND RESPONSES
ABORT Command
line or lines. If the object type is ZCOM-OBJ-PATH, execution
of this command terminates activity on all lines associated
with the specified path or paths.
•
The lines or paths are placed in the STOPPED summary state,
and the CLIP remains loaded.
•
All activities being performed by the lines or paths are
halted, and files and listings can be left in an inconsistent
or incomplete state.
•
The STOP command can be used to terminate lines and paths if
they have no connections to other systems.
Error-Handling Notes
•
If an attempt is made to abort a line or path that is already
in the STOPPED summary state, the error identified by the
error number ZCOM-ERR-OBJ-ALRDY-IN-SUMSTATE is returned.
7-10
COMMANDS AND RESPONSES
ALTER LINE Command
ALTER LINE Command
The ALTER LINE command changes the values of the attributes of
one or more lines.
Command
ZCOM-CMD-ALTER
Object Type
ZCOM-OBJ-LINE
Tokens in Command Buffer
ZSPI-TKN-MANAGER
token-type ZSPI-TYP-FNAME32.
!r
ZEXP-MAP-ALTER-LINE
!r
def ZEXP-DDL-ALTER-LINE.
02 ZADDR
type ZSPI-DDL-INT-PAIR.
02 ZASSOC-DEV
type ZSPI-DDL-DEVICE.
02 ZASSOC-SUBDEV
type ZSPI-DDL-DEVICE.
02 ZAUTOLOAD
type ZSPI-DDL-BOOLEAN.
02 ZCHARSET
type ZSPI-DDL-ENUM.
02 ZDELAY
type ZSPI-DDL-TIMESTAMP.
02 ZDSR-TIMEOUT
type ZSPI-DDL-TIMESTAMP.
02 ZIDLE-TIMEOUT
type ZSPI-DDL-TIMESTAMP.
02 ZINTERF
type ZSPI-DDL-ENUM.
02 ZMAX-RECONNS
type ZSPI-DDL-INT
spi-null 255.
02 ZPROG
type ZSPI-DDL-FNAME.
02 ZREAD-BUFFS
type ZSPI-DDL-INT.
02 ZRETRIES
type ZSPI-DDL-INT.
02 ZRETRY-PROBE
type ZSPI-DDL-INT.
02 ZRECV-WINDOW
type ZSPI-DDL-INT.
02 ZSPEED
type ZSPI-DDL-INT2.
02 ZSYNCS
type ZSPI-DDL-INT.
02 ZTEST-INTVL
type ZSPI-DDL-TIMESTAMP.
02 ZTHRES
type ZSPI-DDL-INT.
02 ZTIMEOUT
type ZSPI-DDL-TIMESTAMP.
02 ZTIMER-BIND
type ZSPI-DDL-TIMESTAMP.
02 ZTIMER-INACTV
type ZSPI-DDL-TIMESTAMP.
02 ZTIMER-PROBE
type ZSPI-DDL-TIMESTAMP.
02 ZTIMER-RECONN
type ZSPI-DDL-TIMESTAMP.
!o
!o
!o
!o
!o
!o
!o
!o
!o
!o
!o
!o
!o
!o
!o
!o
!o
!o
!o
!o
!o
!o
!o
!o
>
7-11
COMMANDS AND RESPONSES
ALTER LINE Command
02
02
end.
ZXMIT-WINDOW
ZWINDOW
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
type ZSPI-DDL-INT.
type ZSPI-DDL-INT.
!o
!o
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
token-type ZSPI-TYP-LIST.
token-type
token-type
token-type
token-type
token-type
ZSPI-TYP-SSCTL.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZEXP-MAP-ALTER-LINE is an extensible structured token that describes which attributes are to have their values changed and
what the new values for these attributes are. It has the token
7-12
COMMANDS AND RESPONSES
ALTER LINE Command
number ZEXP-TNM-ALTER-LINE and the DDL definition ZEXP-DDL-ALTERLINE. This token must be present in the command, and duplicate
occurrences are not allowed.
The attribute changes described by ZEXP-MAP-ALTER-LINE apply to
all the lines whose names appear in the command.
There is a field in ZEXP-MAP-ALTER-LINE for each line attribute
that can be altered by the ALTER LINE command. If a field
of this token is assigned a value other than its null value,
the ALTER LINE command assigns that value to the attribute
corresponding to that field. If no value is assigned to a field,
the corresponding attribute is not altered.
ZEXP-MAP-ALTER-LINE contains the following fields:
ZADDR contains a pair of integers that specify the level-2
primary and secondary addresses. The default value for the
primary address is the MYSYSTEM value, and for the secondary
address, it is the NEXTSYS value. The two integers of
ZADDR correspond to the SYSGEN modifiers L2PRIMARYADDR and
L2SECONDARYADDR. ZADDR is valid only for line handlers that
are configured as HDLC Extended for bit- and byte-synchronous
transmission.
ZASSOC-DEV specifies the logical device name of the NAM
process. This field corresponds to the SYSGEN modifier
ASSOCIATEDEV. ZASSOC-DEV is valid only for NAM line handlers.
ZASSOC-SUBDEV specifies the logical subdevice name of the NAM
logical device. The default value for this name is all
blanks. This field corresponds to the SYSGEN modifier NAME.
ZASSOC-SUBDEV is valid only for NAM line handlers.
ZAUTOLOAD specifies whether or not automatic downloading of
the CLIP program is to be enabled. If automatic downloading
is enabled, the CLIP will be downloaded whenever the associated line is brought up again after being down. This field
can have the following values:
ZSPI-VAL-TRUE
Enable automatic downloading of the CLIP.
ZSPI-VAL-FALSE
Disable automatic downloading of the CLIP.
Automatic downloading is enabled by default. ZAUTOLOAD
corresponds to the SYSGEN modifiers AUTOLOAD and NOAUTOLOAD.
This field is valid only for line handlers that are configured
as HDLC Normal for 6100 CSS.
7-13
COMMANDS AND RESPONSES
ALTER LINE Command
ZCHARSET specifies the character set for the line.
can have the following values:
This field
ZEXP-VAL-ASCII
The character set for the line is ASCII.
ZEXP-VAL-EBCDIC
The character set for the line is EBCDIC.
The character set is ASCII by default. This field corresponds
to the SYSGEN modifiers ASCII and EBCDIC. ZCHARSET is valid
for all line handlers except NAM line handlers.
ZDELAY specifies the amount of time in microseconds between
transmissions. The value must be in the range 0 through
327,670,000, and the default value is 100,000. This field
has no corresponding SYSGEN modifier, and it is valid only for
line handlers that are configured as HDLC Normal for 6100 CSS.
ZDSR-TIMEOUT specifies the amount of time in microseconds that
the CLIP is to wait for the Data Set Ready (DSR) signal from
the modem before it informs the Communications Access Process
(CAP) of no detection. This value must be in the range
0 through 327,670,000, and the default value is 20,000,000.
This field corresponds to the SYSGEN modifier DSRTIMER. ZDSRTIMEOUT is valid only for line handlers that are configured as
HDLC Normal for 6100 CSS.
ZIDLE-TIMEOUT specifies the amount of time in microseconds for
the level-2 Receive Ready (RR) timer to wait before timing
out. This value must be in the range 0 through 327,670,000,
and the default value is 10,000,000. This field corresponds
to the SYSGEN modifier L2IDLETIMEOUT. ZIDLE-TIMEOUT is valid
for all line handlers except NAM line handlers.
ZINTERF specifies the hardware interface.
the following values:
This field can have
ZEXP-VAL-RS232
The hardware interface is RS-232.
ZEXP-VAL-RS422
The hardware interface is RS-422.
The hardware interface is RS-232 by default. This field
corresponds to the SYSGEN modifiers RS232 and RS422. This
field is valid for all line handlers except NAM line handlers,
except that it does not apply to lines attached to a
multifunction controller.
ZMAX-RECONNS specifies the maximum number of times a network
connection is attempted. This value must be in the range 0
through 32767, where the value 0 indicates no maximum. The
default value is 0. This field corresponds to the SYSGEN
modifier MAXRECONNECTS. ZMAX-RECONNS is valid only for NAM
line handlers.
7-14
COMMANDS AND RESPONSES
ALTER LINE Command
ZPROG specifies the file name of the CLIP program to be
downloaded. The default name is $SYSTEM.CSSnn.C9311P00. This
field corresponds to the SYSGEN modifier PROGRAM. ZPROG is
valid only for line handlers that are configured as HDLC
Normal for 6100 CSS.
ZREAD-BUFFS specifies the number of read buffers to allocate.
This value must be in the range 1 through 7, except for
satellite-efficient lines, where the range is from 1 to 63.
The default value is 4 for line handlers that are configured
as HDLC Normal for either bit- and byte-synchronous transmission or 6100 CSS. This field corresponds to the SYSGEN
modifier READBUFFERS. ZREAD-BUFFS is valid for all line
handlers except NAM line handlers.
ZRETRIES specifies the number of level-2 retries to attempt
before reporting a failure. This value must be in the range
1 through 32767, and the default value is 10. This field
corresponds to the SYSGEN modifier L2RETRIES. ZRETRIES is
valid for all line handlers except NAM line handlers.
ZRETRY-PROBE specifies the number of times the line handler
will retry its probe of the NAM before it considers the
network to be unavailable. This value must be in the range
1 through 32767. The default value is 10 for NETCLUSTER
(FOX) lines and 20 for NETNAM (X.25) lines. A value of 1
indicates no retries (one attempt). This field corresponds
to the SYSGEN modifier RETRYPROBE. ZRETRY-PROBE is valid only
for NAM line handlers.
ZRECV-WINDOW specifies the number of packets the NAM process
can send to the EXPAND line handler before the line handler
must send a reply. This value must be in the range 2 through
7. The default value is 7 for NETCLUSTER (FOX) lines and 2
for NETNAM (X.25) lines. This field corresponds to the SYSGEN
modifier RXWINDOW. ZRECV-WINDOW is valid only for NAM line
handlers.
ZSPEED specifies the baud rate of the line handler. This
value must be in the range 1200 through 224000. This field
corresponds to the SYSGEN modifier LINESPEED. ZSPEED is valid
for all types of line handlers.
ZSYNCS specifies the number of leading sync characters transmitted before each frame. This value must be in the range
1 through 15, and the default value is 3. This field
corresponds to the SYSGEN modifier SYNCS. ZSYNCS is valid for
all line handlers except NAM line handlers.
ZTEST-INTVL specifies the amount of time in microseconds
between CLIP status probes. This value must be in the range
0 through 327,670,000, and the default value is 10,000,000.
A value of zero indicates no status probe. This field
7-15
COMMANDS AND RESPONSES
ALTER LINE Command
corresponds to the SYSGEN modifier CLBSTATUSPROBETIME. ZTESTINTVL is valid only for line handlers that are configured as
HDLC Normal for 6100 CSS.
ZTHRES specifies the number of frames that must be sent
and received before line quality is checked. This value
must be in the range 100 through 16384, and the default
value is 500. This field corresponds to the SYSGEN modifier
LINEQUALITYTHRESHOLD. ZTHRES is valid only for line handlers
that are configured as HDLC Normal for 6100 CSS or the
multifunction controller.
ZTIMEOUT specifies the amount of time in microseconds that
the level-2 T1 timer will run before timing out. This value
must be in the range 0 through 327,670,000. The default
value is 2,000,000 for line handlers that are configured
as HDLC Extended for bit-synchronous and byte-synchronous
transmission, 0 for NETNAM line handlers, and 1,000,000 for
other types of line handlers. This field corresponds to the
SYSGEN modifier L2TIMEOUT. ZTIMEOUT is valid for all types of
line handlers.
ZTIMER-BIND specifies the amount of time in microseconds that
the line handler will wait for successful completion of the
bind to the NET subdevice. The default value is 60,000,000
for NETCLUSTER (FOX) lines and 30,000,000 for NETNAM (X.25)
lines. A value of 0 indicates an indefinite interval. This
field corresponds to the SYSGEN modifier TIMERBIND. ZTIMERBIND is valid only for NAM line handlers.
ZTIMER-INACTV specifies the amount of time in microseconds the
line handler will remain inactive before it requests that the
network service provided by the NAM be disconnected. This
value must be in the range 0 through 32,767,000,000. The
default value is 0 for NETCLUSTER (FOX) lines and 900,000,000
for NETNAM (X.25) lines. A value of 0 indicates an indefinite
interval. This field corresponds to the SYSGEN modifier
TIMERINACTIVITY. ZTIMER-INACTV is valid only for NAM line
handlers.
ZTIMER-PROBE specifies the amount of time in microseconds
for the line handler to obtain the status of the NAM. The
default value is 30,000,000 for NETCLUSTER (FOX) lines and
300,000,000 for NETNAM (X.25) lines. A value of 0 indicates
an indefinite interval. This field corresponds to the SYSGEN
modifier TIMERPROBE. ZTIMER-PROBE is valid only for NAM line
handlers.
ZTIMER-RECONN specifies the amount of time in microseconds for
the line handler to wait to successfully initiate a network
connection. The default value is 60,000,000 for NETCLUSTER
(FOX) lines and 30,000,000 for NETNAM (X.25) lines. A value
of 0 indicates an indefinite interval. This field corresponds
7-16
COMMANDS AND RESPONSES
ALTER LINE Command
to the SYSGEN modifier TIMERRECONNECT.
only for NAM line handlers.
ZTIMER-RECONN is valid
ZXMIT-WINDOW specifies the number of EXPAND packets the line
handler can send to the NAM before it receives a reply.
This value must be in the range 2 through 7. The default
value is 7 for NETCLUSTER (FOX) lines and 2 for NETNAM
(X.25) lines. This field corresponds to the SYSGEN modifier
TXWINDOW. ZXMIT-WINDOW is valid only for NAM line handlers.
ZWINDOW specifies the number of EXPAND packets the line
handler can send before it receives a reply. This value
must be in the range 2 through 7, except for satelliteefficient lines, where the range is 1 through 63. The
default value is 2. This field has no corresponding SYSGEN
modifier. ZWINDOW is valid for all line handlers except NAM
line handlers.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line whose attributes are to be altered. This token must
be present in the command, and from 1 through 30 line names are
allowed. ZCOM-TKN-OBJNAME is described in Section 6, "Common
Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line whose attributes were altered by the command. This
token is present in every response record. ZCOM-TKN-OBJNAME is
described in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-LINE. This token is present in every response record,
and it is described in Section 6, "Common Definitions."
7-17
COMMANDS AND RESPONSES
ALTER LINE Command
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the ALTER LINE command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
The empty response record is being
4
(ZEXP-ERR-TKN-CONFL):
command.
A token conflict occurred in the
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The EXPAND line handler returned a
For command-specific information about these error numbers,
see "Error-Handling Notes" below. For descriptions of all
EXPAND error numbers and their associated error lists, refer to
Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
ALTER LINE is a sensitive command.
•
The line must be in the STOPPED summary state.
•
To obtain the current values of the attributes of a line, use
the INFO LINE command.
•
Not all line attributes are valid for all types of lines.
Refer to Appendix C for a table that lists the applicable line
attributes for the different types of line handlers. If an
attempt is made to alter an attribute that is not valid for
the line, the error identified by the error number ZEXP-ERRNEG-LH-RSP results.
•
No summary-state transition is associated with this command.
7-18
COMMANDS AND RESPONSES
ALTER LINE Command
Error-Handling Notes
•
The error number ZEXP-ERR-NEG-LH-RSP can signify either of the
following two errors:
-- An attempt was made to alter an attribute that is not valid
for the line. Refer to Appendix C for a table that lists
the applicable line attributes for the different types of
line handlers.
-- The line was not in the STOPPED summary state when the
ALTER LINE command was issued.
•
The error identified by the error number ZEXP-ERR-TKN-CONFL
signifies that the extensible structured token ZEXP-MAP-ALTERPATH or ZEXP-MAP-ALTER-PROC was present in the ALTER LINE
command.
7-19
COMMANDS AND RESPONSES
ALTER PATH Command
ALTER PATH Command
The ALTER PATH command changes the values of the attributes of
one or more paths.
Command
ZCOM-CMD-ALTER
Object Type
ZCOM-OBJ-PATH
Tokens in Command Buffer
ZSPI-TKN-MANAGER
token-type ZSPI-TYP-FNAME32.
!r
ZEXP-MAP-ALTER-PATH
!r
def ZEXP-DDL-ALTER-PATH.
02 ZCMPRSS
type ZSPI-DDL-BOOLEAN.
02 ZNEXT-SYS
type ZSPI-DDL-INT
spi-null 255.
02 ZOUT-OF-SEQ-SPACE
type ZSPI-DDL-INT.
02 ZOUT-OF-SEQ-TIMEOUT
type ZSPI-DDL-TIMESTAMP.
02 ZRETRIES
type ZSPI-DDL-INT.
02 ZTIMEOUT
type ZSPI-DDL-TIMESTAMP.
end.
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
!o
!o
!o
!o
!o
!o
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
>
7-20
COMMANDS AND RESPONSES
ALTER PATH Command
ZSPI-TKN-COMMENT
token-type ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
token-type ZSPI-TYP-LIST.
token-type
token-type
token-type
token-type
token-type
ZSPI-TYP-SSCTL.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZEXP-MAP-ALTER-PATH is an extensible structured token that describes which attributes are to have their values changed and
what the new values for the attributes are. It has the token
number ZEXP-TNM-ALTER-PATH and the DDL definition ZEXP-DDL-ALTERPATH. This token must be present in the command, and duplicate
occurrences are not allowed.
The attribute changes described by ZEXP-MAP-ALTER-PATH apply to
all the paths whose names appear in the command.
There is a field in ZEXP-MAP-ALTER-PATH for each path attribute
that can be altered by the ALTER PATH command. If a field
of this token is assigned a value other than its null value,
the ALTER PATH command assigns that value to the attribute
corresponding to that field. If no value is assigned to a field,
the corresponding attribute is not altered.
7-21
COMMANDS AND RESPONSES
ALTER PATH Command
ZEXP-MAP-ALTER-PATH contains the following fields:
ZCMPRSS specifies whether or not compression of outgoing
messages is to be enabled. ZCMPRSS can have the following
values:
ZSPI-VAL-TRUE
Enable compression of outgoing messages.
ZSPI-VAL-FALSE
Disable compression of outgoing messages.
Compression of outgoing messages is enabled by default.
This field corresponds to the SYSGEN modifiers COMPRESS and
NOCOMPRESS.
ZNEXT-SYS specifies the network identification (system number)
of the neighbor system on this path. The default value of
this identification is 255. This field corresponds to the
SYSGEN modifier NEXTSYS.
ZOUT-OF-SEQ-SPACE specifies the maximum number of words of
local pool space that can be used for the out-of-sequence
buffer. The default value is 3072. This field corresponds to
the SYSGEN modifier MAXOOSBUF.
ZOUT-OF-SEQ-TIMEOUT specifies the amount of time in microseconds that the out-of-sequence timer will run before timing
out. This value must be in the range 0 through 327,670,000,
and the default value is 3,000,000. This field corresponds to
the SYSGEN modifier OOSTIMEOUT.
ZRETRIES specifies the number of level-4 retries to attempt
before a failure is reported. This value must be in the
range 1 through 32767, and the default value is 3. This field
corresponds to the SYSGEN modifier L4RETRIES.
ZTIMEOUT specifies the amount of time in microseconds for the
level-4 timer to run before timing out. This value must be
in the range 0 through 327,670,000, and the default value is
20,000,000. This field corresponds to the SYSGEN modifier
L4TIMEOUT.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a path whose attributes are to be altered. This token must
be present in the command, and from 1 through 30 object names
are allowed. ZCOM-TKN-OBJNAME is described in Section 6, "Common
Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
7-22
COMMANDS AND RESPONSES
ALTER PATH Command
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a path whose attributes were altered by the command. This
token is present in every response record. ZCOM-TKN-OBJNAME is
described in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-PATH. This token is present in every response record,
and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the ALTER PATH command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
The empty response record is being
4
(ZEXP-ERR-TKN-CONFL):
command.
A token conflict occurred in the
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The EXPAND line handler returned a
For command-specific information about these error numbers,
see "Error-Handling Notes" below. For descriptions of all
EXPAND error numbers and their associated error lists, refer to
Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
7-23
COMMANDS AND RESPONSES
ALTER PATH Command
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
ALTER PATH is a sensitive command.
•
The path must be in the STOPPED summary state.
•
To obtain the current values of the attributes of a path, use
the INFO PATH command.
•
No summary-state transition is associated with this command.
Error-Handling Notes
•
The error identified by the error number ZEXP-ERR-NEG-LH-RSP
can signify that the path was not in the STOPPED summary state
when the ALTER PATH command was issued.
•
The error identified by the error number ZEXP-ERR-TKN-CONFL
signifies that the extensible structured token ZEXP-MAP-ALTERLINE or ZEXP-MAP-ALTER-PROC was present in the ALTER PATH
command.
7-24
COMMANDS AND RESPONSES
ALTER PROCESS Command
ALTER PROCESS Command
The ALTER PROCESS command changes the values of the attributes of
one or more EXPAND line-handler processes.
Command
ZCOM-CMD-ALTER
Object Type
ZCOM-OBJ-PROCESS
Tokens in Command Buffer
ZSPI-TKN-MANAGER
token-type ZSPI-TYP-FNAME32.
!r
ZEXP-MAP-ALTER-PROC
!r
def ZEXP-DDL-ALTER-PROC.
02 ZDEBUG
type ZSPI-DDL-BOOLEAN.
end.
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
!o
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
>
7-25
COMMANDS AND RESPONSES
ALTER PROCESS Command
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
token-type
token-type
token-type
token-type
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZEXP-MAP-ALTER-PROC is an extensible structured token that describes which attributes are to have their values changed and
what the new values for the attributes are. It has the token
number ZEXP-TNM-ALTER-PROC and the DDL definition ZEXP-DDL-ALTERPROC. This token must be present in the command, and duplicate
occurrences are not allowed.
The attribute changes described by ZEXP-MAP-ALTER-PROC apply to
all the processes whose names appear in the command.
There is a field in ZEXP-MAP-ALTER-PROC for each line-handler
process attribute that can be altered by the ALTER PROCESS
command. If a field of this token is assigned a value other
than its null value, the ALTER PROCESS command assigns that value
to the attribute corresponding to that field. If no value is
assigned to a field, the corresponding attribute is not altered.
ZEXP-MAP-ALTER-PROC contains the following field:
ZDEBUG specifies whether or not the CLIP DEBUG interface is to
be enabled. ZDEBUG can have the following values:
ZSPI-VAL-TRUE
Enable the CLIP DEBUG interface.
ZSPI-VAL-FALSE
Disable the CLIP DEBUG interface.
This field has no corresponding SYSGEN modifier.
ZCOM-TKN-OBJNAME is an object-name token that contains the object
name of a line-handler process whose attributes are to be
7-26
COMMANDS AND RESPONSES
ALTER PROCESS Command
altered. This token must be present in the command, and from
1 through 30 object names are allowed. ZCOM-TKN-OBJNAME is
described in Section 6, "Common Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZCOM-TKN-OBJNAME is an object-name token that contains the object
name of a line-handler process whose attributes were altered by
the command. This token is present in every response record.
ZCOM-TKN-OBJNAME is described in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-PROCESS. This token is present in every response
record, and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the ALTER PROCESS command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
The empty response record is being
4
(ZEXP-ERR-TKN-CONFL):
command.
A token conflict occurred in the
The EXPAND line handler returned a
7-27
COMMANDS AND RESPONSES
ALTER PROCESS Command
For command-specific information about these error numbers,
see "Error-Handling Notes" below. For descriptions of all
EXPAND error numbers and their associated error lists, refer to
Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
ALTER PROCESS is a sensitive command.
•
To obtain the current values of the attributes of a linehandler process, use the INFO PROCESS command.
•
No summary-state transition is associated with this command.
Error-Handling Notes
•
The error identified by the error number ZEXP-ERR-TKN-CONFL
signifies that the extensible structured token ZEXP-MAP-ALTERLINE or ZEXP-MAP-ALTER-PATH was present in the ALTER PROCESS
command.
7-28
COMMANDS AND RESPONSES
GETVERSION Command (EXPAND Manager Process)
GETVERSION Command (EXPAND Manager Process)
This version of the GETVERSION command returns the server version
and server-banner string of the EXPAND manager process.
Command
ZCOM-CMD-GETVERSION
Object Type
None
or
ZCOM-OBJ-NULL
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!o
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-SERVER-BANNER
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
token-type ZSPI-TYP-LIST.
token-type
token-type
token-type
token-type
ZSPI-TYP-SSCTL.
ZSPI-TYP-CHAR50.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
>
7-29
COMMANDS AND RESPONSES
GETVERSION Command (EXPAND Manager Process)
ZSPI-TKN-CONTEXT
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token as described in Section
6, "Common Definitions." This token is not required to be
present in the command, and if it is present, it is ignored.
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-SERVER-BANNER is a standard SPI server-banner token, as
described in the Distributed Systems Management (DSM) Programming
Manual. It contains the server-banner string for the EXPAND
manager process. This token is present in every response record
that does not contain an error list.
7-30
COMMANDS AND RESPONSES
GETVERSION Command (EXPAND Manager Process)
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
this version of the GETVERSION command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
More than 30 object names
The EXPAND line handler returned a
The empty response record is being
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
All users can issue the GETVERSION command.
•
The server version of the EXPAND manager process is returned
in the header token ZSPI-TKN-SERVER-VERSION.
•
No summary-state transition is associated with this command.
7-31
COMMANDS AND RESPONSES
GETVERSION Command (Lines and Paths)
GETVERSION Command (Lines and Paths)
This version of the GETVERSION command returns the server version
of the EXPAND manager process and the server-banner string of one
or more lines or paths.
Command
ZCOM-CMD-GETVERSION
Object Type
ZCOM-OBJ-PROCESS
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-SERVER-BANNER
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
7-32
token-type ZSPI-TYP-LIST.
token-type
token-type
token-type
token-type
ZSPI-TYP-SSCTL.
ZSPI-TYP-CHAR50.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
COMMANDS AND RESPONSES
GETVERSION Command (Lines and Paths)
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line or path whose server-banner string is to be returned.
This token must be present in the command, and from 1 through
30 object names are allowed. ZCOM-TKN-OBJNAME is described in
Section 6, "Common Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-SERVER-BANNER is a standard SPI server-banner token, as
described in the Distributed Systems Management (DSM) Programming
Manual. It contains the server-banner string for a line or path
whose name appeared in the command. This token is present in
every response record that does not contain an error list.
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
this version of the GETVERSION command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
More than 30 object names
The EXPAND line handler returned a
7-33
COMMANDS AND RESPONSES
GETVERSION Command (Lines and Paths)
3
(ZEXP-ERR-EMPT-RSP):
returned.
The empty response record is being
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
All users can issue the GETVERSION command.
•
The server version of the EXPAND manager process is returned
in the header token ZSPI-TKN-SERVER-VERSION.
•
Using the token ZSPI-TKN-RESPONSE-TYPE in the command to
request the return of only those response records for lines
and paths on which errors or warnings occurred can result in
no information being returned.
•
No summary-state transition is associated with this command.
7-34
COMMANDS AND RESPONSES
INFO LINE Command
INFO LINE Command
The INFO LINE command returns the current values of the attributes of one or more lines.
Command
ZCOM-CMD-INFO
Object Type
ZCOM-OBJ-LINE
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
ZEXP-MAP-INFO-LINE-HDLC
def ZEXP-DDL-INFO-LINE-HDLC.
02 ZADDR
type ZSPI-DDL-INT-PAIR.
02 ZCHARSET
type ZSPI-DDL-ENUM.
02 ZDELAY
type ZSPI-DDL-INT2.
>
7-35
COMMANDS AND RESPONSES
INFO LINE Command
02
02
02
02
02
02
02
02
02
02
02
end.
ZFRAME-SIZE
ZIDLE-TIMEOUT
ZINTERF
ZREAD-BUFFS
ZRETRIES
ZSPEED
ZSYNCS
ZTHRES
ZTIMEOUT
ZWINDOW
ZTYPE
type
type
type
type
type
type
type
type
type
type
type
ZSPI-DDL-INT.
ZSPI-DDL-INT2.
ZSPI-DDL-ENUM.
ZSPI-DDL-INT.
ZSPI-DDL-INT.
ZSPI-DDL-INT2.
ZSPI-DDL-INT.
ZSPI-DDL-INT.
ZSPI-DDL-INT2.
ZSPI-DDL-INT.
ZSPI-DDL-INT-PAIR.
def ZEXP-DDL-INFO-LINE-CSM.
02 ZADDR
type
02 ZAUTOLOAD
type
02 ZCHARSET
type
02 ZDELAY
type
02 ZDSR-TIMEOUT
type
02 ZFRAME-SIZE
type
02 ZIDLE-TIMEOUT
type
02 ZINTERF
type
02 ZPROG
type
02 ZPROTOID
type
02 ZREAD-BUFFS
type
02 ZRETRIES
type
02 ZSPEED
type
02 ZSYNCS
type
02 ZTEST-INTVL
type
02 ZTHRES
type
02 ZTIMEOUT
type
02 ZWINDOW
type
02 ZTYPE
type
end.
ZSPI-DDL-INT-PAIR.
ZSPI-DDL-BOOLEAN.
ZSPI-DDL-ENUM.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT.
ZSPI-DDL-INT2.
ZSPI-DDL-ENUM.
ZSPI-DDL-DISCNAME.
ZSPI-DDL-INT.
ZSPI-DDL-INT.
ZSPI-DDL-INT.
ZSPI-DDL-INT2.
ZSPI-DDL-INT.
ZSPI-DDL-INT2.
ZSPI-DDL-INT.
ZSPI-DDL-INT2.
ZSPI-DDL-INT.
ZSPI-DDL-INT-PAIR.
ZEXP-MAP-INFO-LINE-CSM
ZEXP-MAP-INFO-LINE-NAM
def ZEXP-DDL-INFO-LINE-NAM.
02 ZASSOC-DEV
type
02 ZASSOC-SUBDEV
type
02 ZDELAY
type
02 ZFRAME-SIZE
type
02 ZMAX-RECONNS
type
02 ZRETRY-PROBE
type
02 ZRECV-WINDOW
type
02 ZSPEED
type
ZSPI-DDL-DEVICE.
ZSPI-DDL-DEVICE.
ZSPI-DDL-INT2.
ZSPI-DDL-INT.
ZSPI-DDL-INT.
ZSPI-DDL-INT.
ZSPI-DDL-INT.
ZSPI-DDL-INT2.
>
7-36
COMMANDS AND RESPONSES
INFO LINE Command
02
02
02
02
02
02
02
end.
ZTIMEOUT
ZTIMER-BIND
ZTIMER-INACTV
ZTIMER-PROBE
ZTIMER-RECONN
ZXMIT-WINDOW
ZTYPE
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
type
type
type
type
type
type
type
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT.
ZSPI-DDL-INT-PAIR.
token-type
token-type
token-type
token-type
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line whose attribute values are to be returned. This token
must be present in the command, and from 1 through 30 object
names are allowed. ZCOM-TKN-OBJNAME is described in Section 6,
"Common Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
7-37
COMMANDS AND RESPONSES
INFO LINE Command
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZEXP-MAP-INFO-LINE-HDLC, ZEXP-MAP-INFO-LINE-CSM, and ZEXP-MAPINFO-LINE-NAM are all extensible structured tokens that contain
the current values of the attributes of a line. Only one of
these tokens is present in each response record.
ZEXP-MAP-INFO-LINE-HDLC is returned when the line handler is
configured as HDLC (Normal or Extended) for bit- and bytesynchronous transmission. It has the token number ZEXP-TNM-INFOLINE-HDLC and the DDL definition ZEXP-DDL-INFO-LINE-HDLC. This
token contains the following fields:
ZADDR is a pair of integers containing the level-2 primary and
secondary addresses. The two integers of ZADDR correspond to
the SYSGEN modifiers L2PRIMARYADDR and L2SECONDARYADDR.
ZCHARSET contains a value indicating the character set for the
line. This field can have the following values:
ZEXP-VAL-ASCII
The character set for the line is ASCII.
ZEXP-VAL-EBCDIC
The character set for the line is EBCDIC.
This field corresponds to the SYSGEN modifiers ASCII and
EBCDIC.
ZDELAY contains the amount of time in microseconds between
transmissions. This field has no corresponding SYSGEN
modifier.
ZFRAME-SIZE contains the frame size in words.
corresponds to the SYSGEN modifier FRAMESIZE.
This field
ZIDLE-TIMEOUT contains the amount of time in microseconds
that the level-2 Receive Ready (RR) timer will wait before
timing out. This field corresponds to the SYSGEN modifier
L2IDLETIMEOUT.
ZINTERF contains a value that indicates the hardware interface. This field can have the following values:
7-38
ZEXP-VAL-RS232
The hardware interface is RS-232.
ZEXP-VAL-RS422
The hardware interface is RS-422.
COMMANDS AND RESPONSES
INFO LINE Command
This field corresponds to the SYSGEN modifiers RS232 and
RS422. It does not apply to lines attached to a multifunction
controller.
ZREAD-BUFFS contains the number of read buffers allocated.
This field corresponds to the SYSGEN modifier READBUFFERS.
ZRETRIES contains the number of level-2 retries that are
attempted before a failure is reported. This field corresponds to the SYSGEN modifier L2RETRIES.
ZSPEED contains the baud rate of the line handler.
corresponds to the SYSGEN modifier LINESPEED.
This field
ZSYNCS contains the number of leading sync characters transmitted before each frame. This field corresponds to the
SYSGEN modifier SYNCS.
ZTHRES contains the number of frames that must be sent
and received before line quality is checked. This field
corresponds to the SYSGEN modifier LINEQUALITYTHRESHOLD.
ZTIMEOUT contains the amount of time in microseconds that the
level-2 T1 timer will run before timing out. This field
corresponds to the SYSGEN modifier L2TIMEOUT.
ZWINDOW contains the number of EXPAND packets the line handler
can send before it receives a reply. This field has no
corresponding SYSGEN modifier.
ZTYPE is a pair of integers containing the device type and
subtype of the line. The two integers of ZTYPE correspond to
the SYSGEN modifiers TYPE and SUBTYPE.
ZEXP-MAP-INFO-LINE-CSM is returned when the line handler is
configured as HDLC Normal for 6100 CSS. It has the token number
ZEXP-TNM-INFO-LINE-CSM and the DDL definition ZEXP-DDL-INFO-LINECSM. This token contains the following fields:
ZADDR is a pair of integers containing the level-2 primary and
secondary addresses. The two integers of ZADDR correspond to
the SYSGEN modifiers L2PRIMARYADDR and L2SECONDARYADDR.
ZAUTOLOAD indicates whether or not automatic downloading of
the CLIP program is enabled. If automatic downloading is
enabled, the CLIP will be downloaded whenever the associated
line is brought up again after being down. This field
contains one of the following values:
ZSPI-VAL-TRUE
Automatic downloading of the CLIP is
enabled.
7-39
COMMANDS AND RESPONSES
INFO LINE Command
ZSPI-VAL-FALSE
Automatic downloading of the CLIP is
disabled.
This field corresponds to the SYSGEN modifiers AUTOLOAD and
NOAUTOLOAD.
ZCHARSET contains a value indicating the character set for the
line. This field can have the following values:
ZEXP-VAL-ASCII
The character set for the line is ASCII.
ZEXP-VAL-EBCDIC
The character set for the line is EBCDIC.
This field corresponds to the SYSGEN modifiers ASCII and
EBCDIC.
ZDELAY contains the amount of time in microseconds between
transmissions. This field has no corresponding SYSGEN
modifier.
ZDSR-TIMEOUT contains the amount of time in microseconds that
the CLIP will wait for the Data Set Ready (DSR) signal from
the modem before it informs the Communications Access Process
(CAP) of no detection. This field corresponds to the SYSGEN
modifier DSRTIMER.
ZFRAME-SIZE contains the frame size in words.
corresponds to the SYSGEN modifier FRAMESIZE.
This field
ZIDLE-TIMEOUT contains the amount of time in microseconds
that the level-2 Receive Ready (RR) timer will wait before
timing out. This field corresponds to the SYSGEN modifier
L2IDLETIMEOUT.
ZINTERF contains a value that indicates the hardware interface. This field can have the following values:
ZEXP-VAL-RS232
The hardware interface is RS-232.
ZEXP-VAL-RS422
The hardware interface is RS-422.
This field corresponds to the SYSGEN modifiers RS232 and
RS422.
ZPROG contains the file name of the CLIP program to be
downloaded. This field corresponds to the SYSGEN modifier
PROGRAM.
ZPROTOID contains the CLIP protocol identification.
field has no corresponding SYSGEN modifier.
This
ZREAD-BUFFS contains the number of read buffers allocated.
This field corresponds to the SYSGEN modifier READBUFFERS.
7-40
COMMANDS AND RESPONSES
INFO LINE Command
ZRETRIES contains the number of level-2 retries that are
attempted before a failure is reported. This field corresponds to the SYSGEN modifier L2RETRIES.
ZSPEED contains the baud rate of the line handler.
corresponds to the SYSGEN modifier LINESPEED.
This field
ZSYNCS contains the number of leading sync characters transmitted before each frame. This field corresponds to the
SYSGEN modifier SYNCS.
ZTEST-INTVL contains the amount of time in microseconds
between CLIP status probes. This field corresponds to the
SYSGEN modifier CLBSTATUSPROBETIME.
ZTHRES contains the number of frames that must be sent
and received before line quality is checked. This field
corresponds to the SYSGEN modifier LINEQUALITYTHRESHOLD.
ZTIMEOUT contains the amount of time in microseconds that the
level-2 T1 timer will run before timing out. This field
corresponds to the SYSGEN modifier L2TIMEOUT.
ZWINDOW contains the number of EXPAND packets the line handler
can send before it receives a reply. This field has no
corresponding SYSGEN modifier.
ZTYPE is a pair of integers containing the device type and
subtype of the line. The two integers of ZTYPE correspond to
the SYSGEN modifiers TYPE and SUBTYPE.
ZEXP-MAP-INFO-LINE-NAM is returned when the line handler is
configured as NAM. It has the token number ZEXP-TNM-INFO-LINENAM and the DDL definition ZEXP-DDL-INFO-LINE-NAM. This token
contains the following fields:
ZASSOC-DEV contains the logical device name of the NAM
process. This field corresponds to the SYSGEN modifier
ASSOCIATEDEV.
ZASSOC-SUBDEV contains the logical subdevice name of the NAM
logical device. This field corresponds to the SYSGEN modifier
NAME.
ZDELAY contains the amount of time in microseconds between
transmissions. This field has no corresponding SYSGEN
modifier.
ZFRAME-SIZE contains the frame size in words.
corresponds to the SYSGEN modifier FRAMESIZE.
This field
7-41
COMMANDS AND RESPONSES
INFO LINE Command
ZMAX-RECONNS contains the maximum number of times a network
connection is attempted. This field corresponds to the SYSGEN
modifier MAXRECONNECTS.
ZRETRY-PROBE contains the number of times the line handler
will retry its probe of the NAM before it considers the
network to be unavailable. This field corresponds to the
SYSGEN modifier RETRYPROBE.
ZRECV-WINDOW contains the number of packets the NAM process
can send to the EXPAND line handler before the line handler
must send a reply. This field corresponds to the SYSGEN
modifier RXWINDOW.
ZSPEED contains the baud rate of the line handler.
corresponds to the SYSGEN modifier LINESPEED.
This field
ZTIMEOUT contains the amount of time in microseconds that the
level-2 T1 timer will run before timing out. This field
corresponds to the SYSGEN modifier L2TIMEOUT.
ZTIMER-BIND contains the amount of time in microseconds that
the line handler will wait for successful completion of the
bind to the NET subdevice. This field corresponds to the
SYSGEN modifier TIMERBIND.
ZTIMER-INACTV contains the amount of time in microseconds the
line handler will remain inactive before it requests that the
network service provided by the NAM be disconnected. This
field corresponds to the SYSGEN modifier TIMERINACTIVITY.
ZTIMER-PROBE contains the amount of time in microseconds for
the line handler to obtain the status of the NAM. This field
corresponds to the SYSGEN modifier TIMERPROBE.
ZTIMER-RECONN contains the amount of time in microseconds the
line handler will wait to successfully initiate a network
connection. This field corresponds to the SYSGEN modifier
TIMERRECONNECT.
ZXMIT-WINDOW contains the number of EXPAND packets the line
handler can send to the NAM before it receives a reply. This
field corresponds to the SYSGEN modifier TXWINDOW.
ZTYPE is a pair of integers containing the device type and
subtype of the line. The two integers of ZTYPE correspond to
the SYSGEN modifiers TYPE and SUBTYPE.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of the line whose attribute values are returned in this response
record. This token is present in every response record. ZCOMTKN-OBJNAME is described in Section 6, "Common Definitions."
7-42
COMMANDS AND RESPONSES
INFO LINE Command
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-LINE. This token is present in every response record,
and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the INFO LINE command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The EXPAND line handler returned a
The empty response record is being
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
All users can issue the INFO LINE command.
•
To change the values of the attributes of a line, use the
ALTER LINE command.
•
To obtain information about the current state of a line, use
the STATUS LINE command.
•
To obtain statistical information about a line, use the
STATISTICS LINE command or the RESETSTATS LINE command.
7-43
COMMANDS AND RESPONSES
INFO LINE Command
•
Using the token ZSPI-TKN-RESPONSE-TYPE in the command to
request the return of only those response records for lines on
which errors or warnings occurred can result in no information
being returned.
•
No summary-state transition is associated with this command.
7-44
COMMANDS AND RESPONSES
INFO PATH Command
INFO PATH Command
The INFO PATH command returns the current values of the attributes of one or more paths.
Command
ZCOM-CMD-INFO
Object Type
ZCOM-OBJ-PATH
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
ZEXP-MAP-INFO-PATH
def ZEXP-DDL-INFO-PATH.
02 ZCMPRSS
type ZSPI-DDL-BOOLEAN.
02 ZNEXT-SYS
type ZSPI-DDL-INT.
>
7-45
COMMANDS AND RESPONSES
INFO PATH Command
02
02
02
02
02
02
end.
ZOUT-OF-SEQ-SPACE
type
ZOUT-OF-SEQ-TIMEOUT
type
ZRETRIES
type
ZTIME-FACT
type
ZTIMEOUT
type
ZTYPE
type
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
ZSPI-DDL-INT.
ZSPI-DDL-INT2.
ZSPI-DDL-INT.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT-PAIR.
token-type
token-type
token-type
token-type
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a path whose attribute values are to be returned. This token
must be present in the command, and from 1 through 30 object
names are allowed. ZCOM-TKN-OBJNAME is described in Section 6,
"Common Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
7-46
COMMANDS AND RESPONSES
INFO PATH Command
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZEXP-MAP-INFO-PATH is an extensible structured token that contains the current values of the attributes of the path. It has
the token number ZEXP-TNM-INFO-PATH and the DDL definition ZEXPDDL-INFO-PATH. This token is present in every response record.
ZEXP-MAP-INFO-PATH contains the following fields:
ZCMPRSS indicates whether or not compression of outgoing
messages is enabled. ZCMPRSS can have one of the following
values:
ZSPI-VAL-TRUE
Compression of outgoing messages is
enabled.
ZSPI-VAL-FALSE
Compression of outgoing messages is
disabled.
This field corresponds to the SYSGEN modifiers COMPRESS and
NOCOMPRESS.
ZNEXT-SYS contains the network identification (system number)
of the neighbor system on this path. This field corresponds
to the SYSGEN modifier NEXTSYS.
ZOUT-OF-SEQ-SPACE contains the maximum number of words of
local pool space that can be used for the out-of-sequence
buffer. This field corresponds to the SYSGEN modifier
MAXOOSBUF.
ZOUT-OF-SEQ-TIMEOUT contains the amount of time in microseconds that the out-of-sequence timer will run before timing
out. This field corresponds to the SYSGEN modifier
OOSTIMEOUT.
ZRETRIES contains the number of level-4 retries that will
be attempted before a failure is reported. This field
corresponds to the SYSGEN modifier L4RETRIES.
ZTIME-FACT contains the current routing time factor for the
path. This field has no corresponding SYSGEN modifier.
ZTIMEOUT contains the amount of time in microseconds that
the level-4 timer will run before timing out. This field
corresponds to the SYSGEN modifier L4TIMEOUT.
7-47
COMMANDS AND RESPONSES
INFO PATH Command
ZTYPE is a pair of integers containing the device type and
subtype of the path. The two integers of ZTYPE correspond to
the SYSGEN modifiers TYPE and SUBTYPE.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of the path whose attribute values are returned in this response
record. This token is present in every response record. ZCOMTKN-OBJNAME is described in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-PATH. This token is present in every response record,
and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the INFO PATH command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The EXPAND line handler returned a
The empty response record is being
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
All users can issue the INFO PATH command.
•
To change the values of the attributes of a path, use the
ALTER PATH command.
•
To obtain information about the current state of a path, use
the STATUS PATH command.
7-48
COMMANDS AND RESPONSES
INFO PATH Command
•
To obtain statistical information about a path, use the
STATISTICS PATH command or the RESETSTATS PATH command.
•
Using the token ZSPI-TKN-RESPONSE-TYPE in the command to
request the return of only those response records for paths on
which errors or warnings occurred can result in no information
being returned.
•
No summary-state transition is associated with this command.
7-49
COMMANDS AND RESPONSES
INFO PROCESS Command
INFO PROCESS Command
The INFO PROCESS command performs one of two functions:
•
It provides network map and/or path map information about a
specified system (the selected system) as seen from another
system (the called system).
•
It returns the current values of the attributes of one or more
EXPAND line-handler processes.
Command
ZCOM-CMD-INFO
Object Type
ZCOM-OBJ-PROCESS
Tokens in Command Buffer
ZSPI-TKN-MANAGER
token-type ZSPI-TYP-FNAME32.
!r
ZEXP-TKN-INFO-NCP-OPT
ZEXP-TKN-CALLED-SYS
ZEXP-TKN-SEL-SYS
token-type ZSPI-TYP-ENUM.
token-type ZSPI-TYP-INT.
token-type ZSPI-TYP-INT.
!o
!o
!o
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
>
7-50
COMMANDS AND RESPONSES
INFO PROCESS Command
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
ZEXP-MAP-INFO-NCP-NETMAP
def ZEXP-DDL-INFO-NCP-NETMAP.
02 ZCALLED-SYS
type ZSPI-DDL-INT.
02 ZSEL-SYS
type ZSPI-DDL-INT.
02 ZNUM-OF-PATH
type ZSPI-DDL-INT.
02 ZNSCB-TOSVERSION type ZSPI-DDL-INT.
02 ZCONN-PATH
type ZSPI-DDL-INT.
02 ZCONN-STATE
type ZSPI-DDL-ENUM.
02 ZSYS-DIST-ENT
occurs 40 times.
03 ZPATH-NUM
type ZSPI-DDL-INT.
03 ZHOP-COUNT
type ZSPI-DDL-INT.
03 ZTRAVEL-TIME
type ZSPI-DDL-INT2.
end.
ZEXP-MAP-INFO-NCP-PATHMAP
def ZEXP-DDL-INFO-NCP-PATHMAP.
02 ZCALLED-SYS
type ZSPI-DDL-INT.
02 ZNUM-OF-PATH
type ZSPI-DDL-INT.
02 ZPATH-ENT
occurs 40 times.
03 ZPATH-NUM
type ZSPI-DDL-INT.
03 ZNOPASS-THRU
type ZSPI-DDL-BOOLEAN.
03 ZNEIGHBOR-NUM
type ZSPI-DDL-INT.
03 ZPATH-LDEV
type ZSPI-DDL-INT.
03 ZTIME-FACTOR
type ZSPI-DDL-INT.
03 ZPATH-CPU-PIN
type ZSPI-DDL-UINT.
03 ZNUM-OF-LINES
type ZSPI-DDL-INT.
03 ZLINE-STATUS
occurs 8 times.
04 ZLINE-LDEV
type ZSPI-DDL-INT.
04 ZSTATUS
type ZSPI-DDL-ENUM.
04 ZDOWN-CAUSE
type ZSPI-DDL-INT.
end.
ZEXP-MAP-INFO-PROC
def ZEXP-DDL-INFO-PROC.
02 ZDEBUG
type ZSPI-DDL-BOOLEAN.
02 ZTYPE
type ZSPI-DDL-INT-PAIR.
end.
>
7-51
COMMANDS AND RESPONSES
INFO PROCESS Command
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
token-type
token-type
token-type
token-type
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZEXP-TKN-INFO-NCP-OPT, if present, specifies that the command is
to return network map and/or path map information. If this
token is not present, the command is to return the current values
of the attributes of one or more EXPAND line-handler processes.
This token has the token number ZEXP-TNM-INFO-NCP-OPT and the
token type ZSPI-TYP-ENUM. Duplicate occurrences of this token
are not allowed.
ZEXP-TKN-INFO-NCP-OPT can have the following values:
ZEXP-VAL-NCP-MAPS
Return both network map and path map
information.
ZEXP-VAL-NCP-PATHS
Return path map information only.
ZEXP-TKN-CALLED-SYS is the system number of the called system.
It has the token number ZEXP-TNM-CALLED-SYS and the token type
ZSPI-TYP-INT. If ZEXP-TKN-INFO-NCP-OPT is present, this token
must also be present; if ZEXP-TKN-INFO-NCP-OPT is not present,
this token is meaningless and must not be present. Duplicate
occurrences are not allowed.
ZEXP-TKN-SEL-SYS is the system number of the selected system.
It has the token number ZEXP-TNM-SEL-SYS and the token type
ZSPI-TYP-INT. If ZEXP-TKN-INFO-NCP-OPT is present and its value
is ZEXP-VAL-NCP-MAPS, this token must also be present. If
ZEXP-TKN-INFO-NCP-OPT is present and its value is ZEXP-VAL-NCPPATHS, or if ZEXP-TKN-INFO-NCP-OPT is not present, this token is
7-52
COMMANDS AND RESPONSES
INFO PROCESS Command
meaningless and must not be present.
not allowed.
Duplicate occurrences are
ZCOM-TKN-OBJNAME is an object-name token. If ZEXP-TKN-INFO-NCPOPT is present, this token must contain the process name "$NCP".
If ZEXP-TKN-INFO-NCP-OPT is not present, this token contains the
object name of a line-handler process whose attribute values are
to be returned. This token must be present in the command; if
ZEXP-TKN-INFO-NCP-OPT is not present, from 1 through 30 object
names are allowed. ZCOM-TKN-OBJNAME is described in Section 6,
"Common Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZEXP-MAP-INFO-NCP-NETMAP is an extensible structured token that
contains network map information about the selected system as
seen from the called system. It has the token number ZEXP-TNMINFO-NCP-NETMAP and the DDL definition ZEXP-DDL-INFO-NCP-NETMAP.
This token is present if and only if ZEXP-TKN-INFO-NCP-OPT was
present in the command and had a value of ZEXP-VAL-NCP-MAPS.
ZEXP-MAP-INFO-NCP-NETMAP contains the following fields:
ZCALLED-SYS is the system number of the called system.
ZSEL-SYS is the system number of the selected system.
ZNUM-OF-PATH is the number of communication paths radiating
from the called system.
ZNSCB-TOSVERSION is the version number of the GUARDIAN or
GUARDIAN 90 operating system running in the called system.
7-53
COMMANDS AND RESPONSES
INFO PROCESS Command
ZCONN-PATH is the path number of the path through which the
called system and the selected system are currently connected
or are connecting, depending on the value of ZCONN-STATE.
A value of 0 means that there is no path between the two
systems.
ZCONN-STATE is the connection state of the path identified in
ZCONN-PATH. This field can have the following values:
ZEXP-VAL-PATH-CONNECTED
The path is in the connected
state.
ZEXP-VAL-PATH-CONNECTING
The path is in the connecting
state.
ZEXP-VAL-PATH-DISCONNECTED
The path is in the disconnected
state.
ZSYS-DIST-ENT (system distance entry) is a structure that
contains information about the distance from the called system
to the selected system over a particular path. This structure
is repeated 40 times. ZSYS-DIST-ENT consists of the following
fields:
ZPATH-NUM is the number identifying a particular path
between the called system and the selected system. Path
numbering starts with 1.
ZHOP-COUNT is the number of node-to-node paths traveled to
reach the selected system over this path.
ZTRAVEL-TIME is the time factor for this path, as determined by the formula in the EXPAND Reference Manual.
Smaller numbers represent faster lines.
ZEXP-MAP-INFO-NCP-PATHMAP is an extensible structured token that
contains path map information about the paths to the called
system. It has the token number ZEXP-TNM-INFO-NCP-PATHMAP and
the DDL definition ZEXP-DDL-INFO-NCP-PATHMAP. This token is
present if and only if ZEXP-TKN-INFO-NCP-OPT was present in the
command (regardless of its value).
ZEXP-MAP-INFO-NCP-PATHMAP contains the following fields:
ZCALLED-SYS is the system number of the called system.
ZNUM-OF-PATH is the number of communication paths radiating
from the called system.
7-54
COMMANDS AND RESPONSES
INFO PROCESS Command
ZPATH-ENT (path entry) is a structure that contains information describing a particular path to the called system. This
structure is repeated 40 times. It contains the following
fields:
ZPATH-NUM is the path number of this path.
ZNOPASS-THRU is reserved for Tandem use only.
ZNEIGHBOR-NUM is the system number of the system immediately adjacent to the called system over this path.
ZPATH-LDEV is the logical device (LDEV) number of this
path.
ZTIME-FACTOR is the time factor of this path, which depends
on the number of lines per path and the configured line
speeds. (For more information about the time factor, refer
to the EXPAND Reference Manual.)
ZPATH-CPU-PIN is the CPU number (in bits 0 through 7)
and PIN number (in bits 8 through 15) of the line-handler
process that manages this path.
ZNUM-OF-LINES is the number of lines that make up this
path.
ZLINE-STATUS is a structure that describes a line in this
path. Since an EXPAND network allows a maximum of eight
lines in a path, this structure is repeated eight times.
ZLINE-STATUS consists of the following fields:
ZLINE-LDEV is the logical device (LDEV) number of this
line. A value of zero means that this is an empty entry
(there are no more lines).
ZSTATUS is the status of this line.
the following values:
This field can have
ZEXP-VAL-READY
The line is ready.
ZEXP-VAL-NOT-READY
The line is not ready.
ZDOWN-CAUSE provides additional information about this
line if it is not ready. If the line is ready, the
value of this field is zero. If the line is not ready,
the value is a file-system error number indicating why
the line is not ready.
7-55
COMMANDS AND RESPONSES
INFO PROCESS Command
ZEXP-MAP-INFO-PROC is an extensible structured token that contains the current values of the attributes of the line-handler
process. It has the token number ZEXP-TNM-INFO-PROC and the DDL
definition ZEXP-DDL-INFO-PROC. This token is present if and only
if ZEXP-TKN-INFO-NCP-OPT was not present in the command.
ZEXP-MAP-INFO-PROC contains the following fields:
ZDEBUG indicates whether or not the CLIP DEBUG interface is
enabled. This field can have the following values:
ZSPI-VAL-TRUE
The CLIP DEBUG interface is enabled.
ZSPI-VAL-FALSE
The CLIP DEBUG interface is disabled.
This field has no corresponding SYSGEN modifier.
ZTYPE is a pair of integers containing the device type and
subtype of the line-handler process. The two integers of
ZTYPE correspond to the SYSGEN modifiers TYPE and SUBTYPE.
ZCOM-TKN-OBJNAME is an object-name token. If ZEXP-TKN-INFONCP-OPT was present in the command, this token contains the
process name "$NCP". If ZEXP-TKN-INFO-NCP-OPT was not present,
this token contains the name of the line-handler process whose
attribute values are returned in this response record. This
token is present in every response record. ZCOM-TKN-OBJNAME is
described in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-PROCESS. This token is present in every response
record, and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the INFO PROCESS command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
9
(ZEXP-ERR-NEG-NCP-RSP):
response.
More than 30 object names
The EXPAND line handler returned a
The empty response record is being
The NCP returned a negative
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
7-56
COMMANDS AND RESPONSES
INFO PROCESS Command
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
All users can issue the INFO PROCESS command.
•
To change the values of the attributes of a line-handler
process, use the ALTER PROCESS command.
•
Using the token ZSPI-TKN-RESPONSE-TYPE in the command to
request the return of only those response records for linehandler processes on which errors or warnings occurred can
result in no information being returned.
•
If the called system is directly connected to more than 40
neighboring systems, only the network map and/or path map
information for the first 40 neighboring systems will be
reported.
•
No summary-state transition is associated with this command.
7-57
COMMANDS AND RESPONSES
LOAD Command
LOAD Command
The LOAD command causes downloading of the CLIP associated with
an EXPAND line.
Command
ZCOM-CMD-LOAD
Object Type
ZCOM-OBJ-LINE
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
7-58
token-type ZSPI-TYP-LIST.
token-type
token-type
token-type
token-type
token-type
ZSPI-TYP-SSCTL.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
COMMANDS AND RESPONSES
LOAD Command
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line to be loaded. This token must be present in the
command, and from 1 through 30 object names are allowed. ZCOMTKN-OBJNAME is described in Section 6, "Common Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line that was loaded by the command. This token is
present in every response record. ZCOM-TKN-OBJNAME is described
in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-LINE. This token is present in every response record,
and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the LOAD command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
7-59
COMMANDS AND RESPONSES
LOAD Command
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
The EXPAND line handler returned a
3
(ZEXP-ERR-EMPT-RSP):
returned.
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The empty response record is being
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
LOAD is a sensitive command.
•
The specified lines must be in the STOPPED summary state when
the LOAD command is issued.
•
A RESET command should be issued before the LOAD command is
issued.
•
The CLIP that is downloaded is not started.
command to start the CLIP.
•
No summary-state transition is associated with this command.
7-60
Use a START
COMMANDS AND RESPONSES
PROBE Command
PROBE Command
The PROBE command returns information about the current paths
from other systems to a selected system.
Command
ZCOM-CMD-PROBE
Object Type
ZCOM-OBJ-PROCESS
Tokens in Command Buffer
ZSPI-TKN-MANAGER
token-type ZSPI-TYP-FNAME32.
!r
ZEXP-TKN-CALLED-SYS
ZEXP-TKN-SEL-SYS
token-type ZSPI-TYP-INT.
token-type ZSPI-TYP-INT.
!r
!r
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
>
7-61
COMMANDS AND RESPONSES
PROBE Command
ZEXP-MAP-PROBE-NCP
def ZEXP-DDL-PROBE-NCP.
02 ZTRIP-TIME
type ZSPI-DDL-INT2.
02 ZNUM-OF-SYS
type ZSPI-DDL-INT.
02 ZSYS-LIST
type ZSPI-DDL-INT occurs
ZEXP-VAL-MAX-SYSTEMS
times.
02 ZCALLED-SYS
type ZSPI-DDL-INT.
02 ZSEL-SYS
type ZSPI-DDL-INT.
end.
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
token-type
token-type
token-type
token-type
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZEXP-TKN-CALLED-SYS is the system number of the system from which
the probe is to be made. It has the token number ZEXP-TNMCALLED-SYS and the token type ZSPI-TYP-INT. This token must be
present in the command. Duplicate occurrences are not allowed.
ZEXP-TKN-SEL-SYS is the system number of the system to which the
probe is to be made. It has the token number ZEXP-TNM-SEL-SYS
and the token type ZSPI-TYP-INT. This token must be present in
the command. Duplicate occurrences are not allowed.
ZCOM-TKN-OBJNAME is an object-name token. This token must
contain the process name "$NCP", and it must be present in the
command. ZCOM-TKN-OBJNAME is described in Section 6, "Common
Definitions."
7-62
COMMANDS AND RESPONSES
PROBE Command
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZEXP-MAP-PROBE-NCP is an extensible structured token that contains information about the current paths from the called system
to the selected system. It has the token number ZEXP-TNM-PROBENCP and the DDL definition ZEXP-DDL-PROBE-NCP. This token is
always present in the response.
ZEXP-MAP-PROBE-NCP contains the following fields:
ZTRIP-TIME is the round-trip time for the probe in hundredths
of a second, including any retransmissions. Since packets may
be retransmitted one or more times during the probe, results
may vary considerably. An unusually large ZTRIP-TIME value
may indicate a problem with the line.
ZNUM-OF-SYS is the number of systems traversed from the
selected system to the called system, not including the
selected system or the called system.
ZSYS-LIST is the system number of one of the systems through
which the probe was made. This field is repeated ZEXP-VALMAX-SYSTEMS (255) times, resulting in an array. The systems
are listed in the order in which they are traversed, starting
with the system adjacent to the selected system and ending
with the system adjacent to the called system. Note that only
the first ZNUM-OF-SYS entries are meaningful.
ZCALLED-SYS is the system number of the called system (ZEXPTKN-CALLED-SYS in the command).
ZSEL-SYS is the system number of the selected system (ZEXPTKN-SEL-SYS in the command).
7-63
COMMANDS AND RESPONSES
PROBE Command
ZCOM-TKN-OBJNAME is an object-name token that contains the
process name "$NCP". This token is always present in the
response. ZCOM-TKN-OBJNAME is described in Section 6, "Common
Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-PROCESS. This token is always present in the response,
and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the PROBE command are the following:
9
10
(ZEXP-ERR-NEG-NCP-RSP):
response.
The NCP returned a negative
(ZEXP-ERR-BAD-NETTRACE-RCVD):
network trace.
The NCP returned a bad
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
All users can issue the PROBE command.
•
No summary-state transition is associated with this command.
7-64
COMMANDS AND RESPONSES
RESET Command
RESET Command
The RESET command causes the CLIP associated with an EXPAND line
to be placed in the boot state for downloading.
Command
ZCOM-CMD-RESET
Object Type
ZCOM-OBJ-LINE
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
token-type ZSPI-TYP-LIST.
token-type
token-type
token-type
token-type
token-type
ZSPI-TYP-SSCTL.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
7-65
COMMANDS AND RESPONSES
RESET Command
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line to be reset. This token must be present in the
command, and from 1 through 30 object names are allowed. ZCOMTKN-OBJNAME is described in Section 6, "Common Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line that was reset by the command. This token is present
in every response record. ZCOM-TKN-OBJNAME is described in
Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-LINE. This token is present in every response record,
and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the RESET command are the following:
1
7-66
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
COMMANDS AND RESPONSES
RESET Command
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
The EXPAND line handler returned a
3
(ZEXP-ERR-EMPT-RSP):
returned.
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The empty response record is being
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
RESET is a sensitive command.
•
The specified lines must be in the STOPPED summary state when
the RESET command is issued.
•
No summary-state transition is associated with this command.
7-67
COMMANDS AND RESPONSES
RESETSTATS LINE Command
RESETSTATS LINE Command
The RESETSTATS LINE command returns statistical information about
the execution history of one or more lines--dynamic information
such as request counts, numbers of errors, and so forth--and then
restores the statistics counters to their initial values.
Command
ZCOM-CMD-RESETSTATS
Object Type
ZCOM-OBJ-LINE
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
>
7-68
COMMANDS AND RESPONSES
RESETSTATS LINE Command
ZEXP-MAP-STATS-LINE-CSM
def ZEXP-DDL-STATS-LINE-CSM.
02 ZSTATS-CURR-TMSTP
02 ZLAST-RESETSTATS-TMSTP
02 ZI-FRAMES-SENT
02 ZI-FRAMES-RECV
02 ZS-FRAMES-SENT
02 ZS-FRAMES-RECV
02 ZU-FRAMES-SENT
02 ZU-FRAMES-RECV
02 ZBCC-ERRS
02 ZALLOC-ERRS
02 ZQUAL-ERRS
02 ZFRAMES-TOTAL
02 ZFRAMES-ERR
02 ZL2-I-FRAMES-SENT
02 ZL2-I-FRAMES-SENT-P
02 ZL2-I-FRAMES-RECV
02 ZL2-I-FRAMES-RECV-P
02 ZL2-RR-FRAMES-SENT
02 ZL2-RNR-FRAMES-SENT
02 ZL2-REJ-FRAMES-SENT
02 ZL2-RR-FRAMES-RECV
02 ZL2-RNR-FRAMES-RECV
02 ZL2-REJ-FRAMES-RECV
02 ZL2-SABM-FRAMES-SENT
02 ZL2-SABM-FRAMES-RECV
02 ZL2-DISC-FRAMES-SENT
02 ZL2-DISC-FRAMES-RECV
02 ZL2-CMDR-FRAMES-SENT
02 ZL2-CMDR-FRAMES-RECV
02 ZL2-UA-FRAMES-SENT
02 ZL2-UA-FRAMES-RECV
02 ZL2-DM-FRAMES-SENT
02 ZL2-DM-FRAMES-RECV
02 ZL2-RECV-OVERRUN
02 ZL2-MODEM-ERRS
02 ZL2-SREJ-FRAMES-SENT
02 ZL2-SREJ-FRAMES-RECV
02 ZL2-FCS-ERRS
02 ZL2-TIMEOUT
02 ZL2-ADDR-ERRS
02 ZL2-LEN-ERRS
02 ZL2-RECV-ABORTED
02 ZL2-RECV-BUFF
02 ZL2-STATE-CTS
02 ZL2-STATE-DCD
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-BYTE.
ZSPI-DDL-BYTE.
>
7-69
COMMANDS AND RESPONSES
RESETSTATS LINE Command
02
02
02
end.
ZL2-STATE-DSR
ZLINE-PPID
ZLINE-BPID
type ZSPI-DDL-BYTE.
type ZSPI-DDL-INT-PAIR.
type ZSPI-DDL-INT-PAIR.
ZEXP-MAP-STATS-LINE-NCSM
def ZEXP-DDL-STATS-LINE-NCSM.
02 ZSTATS-CURR-TMSTP
type
02 ZLAST-RESETSTATS-TMSTP type
02 ZI-FRAMES-SENT
type
02 ZI-FRAMES-RECV
type
02 ZS-FRAMES-SENT
type
02 ZS-FRAMES-RECV
type
02 ZU-FRAMES-SENT
type
02 ZU-FRAMES-RECV
type
02 ZBCC-ERRS
type
02 ZALLOC-ERRS
type
02 ZQUAL-ERRS
type
02 ZFRAMES-TOTAL
type
02 ZFRAMES-ERR
type
02 ZL2-I-FRAMES-SENT
type
02 ZL2-I-FRAMES-SENT-P
type
02 ZL2-I-FRAMES-RECV
type
02 ZL2-I-FRAMES-RECV-P
type
02 ZL2-RR-FRAMES-SENT
type
02 ZL2-RNR-FRAMES-SENT
type
02 ZL2-REJ-FRAMES-SENT
type
02 ZL2-RR-FRAMES-RECV
type
02 ZL2-RNR-FRAMES-RECV
type
02 ZL2-REJ-FRAMES-RECV
type
02 ZL2-SABM-FRAMES-SENT
type
02 ZL2-SABM-FRAMES-RECV
type
02 ZL2-DISC-FRAMES-SENT
type
02 ZL2-DISC-FRAMES-RECV
type
02 ZL2-CMDR-FRAMES-SENT
type
02 ZL2-CMDR-FRAMES-RECV
type
02 ZL2-UA-FRAMES-SENT
type
02 ZL2-UA-FRAMES-RECV
type
02 ZL2-DM-FRAMES-SENT
type
02 ZL2-DM-FRAMES-RECV
type
02 ZL2-RECV-OVERRUN
type
02 ZL2-MODEM-ERRS
type
02 ZL2-SREJ-FRAMES-SENT
type
02 ZL2-SREJ-FRAMES-RECV
type
02 ZLINE-PPID
type
02 ZLINE-BPID
type
end.
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT-PAIR.
ZSPI-DDL-INT-PAIR.
>
7-70
COMMANDS AND RESPONSES
RESETSTATS LINE Command
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
token-type
token-type
token-type
token-type
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line whose statistics are to be returned and whose
statistics counters are to be reinitialized. This token must
be present in the command, and from 1 through 30 object names
are allowed. ZCOM-TKN-OBJNAME is described in Section 6, "Common
Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
7-71
COMMANDS AND RESPONSES
RESETSTATS LINE Command
ZEXP-MAP-STATS-LINE-CSM and ZEXP-MAP-STATS-LINE-NCSM are extensible structured tokens that contain the statistical information
for a line. Only one of these tokens is present in each response
record. ZEXP-MAP-STATS-LINE-CSM is present when the line handler
is configured as HDLC Normal for 6100 CSS; otherwise, ZEXP-MAPSTATS-LINE-NCSM is present. These tokens are fully described in
Section 6, "Common Definitions."
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of the line whose statistics are returned in this response record
and whose statistics counters were reinitialized. This token is
present in every response record. ZCOM-TKN-OBJNAME is described
in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-LINE. This token is present in every response record,
and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the RESETSTATS LINE command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The EXPAND line handler returned a
The empty response record is being
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
7-72
COMMANDS AND RESPONSES
RESETSTATS LINE Command
Operational Notes
•
RESETSTATS LINE is a sensitive command.
•
The statistical information returned by the RESETSTATS LINE
command for FOX (NETCLUSTER) and X.25 (NETNAM) lines is always
all zeros, because the EXPAND subsystem does not control
level-2 operations on such lines.
•
The RESETSTATS LINE command updates the reset-timestamp counters when it clears the statistics counters.
•
To obtain statistical information about a line without clearing the statistics counters, use the STATISTICS LINE command.
•
To obtain information about the current state of a line, use
the STATUS LINE command.
•
To obtain the values of the attributes of a line, use the INFO
LINE command.
•
Using the token ZSPI-TKN-RESPONSE-TYPE in the command to
request the return of only those response records for lines on
which errors or warnings occurred can result in no information
being returned.
•
No summary-state transition is associated with this command.
7-73
COMMANDS AND RESPONSES
RESETSTATS PATH Command
RESETSTATS PATH Command
The RESETSTATS PATH command returns statistical information about
the execution history of one or more paths--dynamic information
such as request counts, numbers of errors, and so forth--and then
restores the statistics counters to their initial values.
Command
ZCOM-CMD-RESETSTATS
Object Type
ZCOM-OBJ-PATH
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
>
7-74
COMMANDS AND RESPONSES
RESETSTATS PATH Command
ZEXP-MAP-STATS-PATH
def ZEXP-DDL-STATS-PATH.
02 ZSTATS-CURR-TMSTP
type
02 ZLAST-RESETSTATS-TMSTP type
02 ZL4-PKTS-SENT
type
02 ZL4-PKTS-RECV
type
02 ZL4-FWD-SENT
type
02 ZL4-FWD-RECV
type
02 ZL4-LINK-REQ-SENT
type
02 ZL4-LINK-REQ-RECV
type
02 ZL4-REQ-SENT-CONN
type
02 ZL4-REQ-SENT-TRACE
type
02 ZL4-REQ-SENT-NCP
type
02 ZL4-REQ-SENT-LRQ
type
02 ZL4-REQ-SENT-LCMP
type
02 ZL4-REQ-SENT-CANCEL
type
02 ZL4-REQ-SENT-ACK
type
02 ZL4-REQ-SENT-NAK
type
02 ZL4-REQ-SENT-ENQ
type
02 ZL4-REQ-RECV-CONN
type
02 ZL4-REQ-RECV-TRACE
type
02 ZL4-REQ-RECV-NCP
type
02 ZL4-REQ-RECV-LRQ
type
02 ZL4-REQ-RECV-LCMP
type
02 ZL4-REQ-RECV-CANCEL
type
02 ZL4-REQ-RECV-ACK
type
02 ZL4-REQ-RECV-NAK
type
02 ZL4-REQ-RECV-ENQ
type
02 ZLOC-POOL-CURR-USED
type
02 ZLOC-POOL-MAX-USED
type
02 ZFRAMES-LE-64
type
02 ZFRAMES-LE-128
type
02 ZFRAMES-LE-256
type
02 ZFRAMES-LE-512
type
02 ZFRAMES-LE-1024
type
02 ZFRAMES-LE-2048
type
02 ZFRAMES-LE-4096
type
02 ZFRAMES-GT-4096
type
02 ZOUT-OF-SEQ-POOL-CURR-USED
type
02 ZOUT-OF-SEQ-POOL-MAX-USED
type
02 ZMAX-POOL-USED
type
02 ZOUT-OF-SEQ-TIMEOUT
type
02 ZPATH-CHANGES-SENT
type
02 ZPATH-CHANGES-RECV
type
02 ZLOC-POOL-PAGES
type
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
>
7-75
COMMANDS AND RESPONSES
RESETSTATS PATH Command
02
02
02
02
end.
ZLOC-POOL-FAILS
ZKNOWN-SYS
ZPATH-PPID
ZPATH-BPID
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
type
type
type
type
token-type
token-type
token-type
token-type
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT-PAIR.
ZSPI-DDL-INT-PAIR.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a path whose statistics are to be returned and whose
statistics counters are to be reinitialized. This token must
be present in the command, and from 1 through 30 object names
are allowed. ZCOM-TKN-OBJNAME is described in Section 6, "Common
Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
7-76
COMMANDS AND RESPONSES
RESETSTATS PATH Command
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZEXP-MAP-STATS-PATH is an extensible structured token that contains the statistical information for the path. This token is
present in every response record, and it is fully described in
Section 6, "Common Definitions."
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of the path whose statistics are returned in this response record
and whose statistics counters were reinitialized. This token is
present in every response record. ZCOM-TKN-OBJNAME is described
in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-PATH. This token is present in every response record,
and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the RESETSTATS PATH command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The EXPAND line handler returned a
The empty response record is being
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
7-77
COMMANDS AND RESPONSES
RESETSTATS PATH Command
Operational Notes
•
RESETSTATS PATH is a sensitive command.
•
The RESETSTATS PATH command updates the reset-timestamp counters when it clears the statistics counters.
•
To obtain statistical information about a path without clearing the statistics counters, use the STATISTICS PATH command.
•
To obtain information about the current state of a path, use
the STATUS PATH command.
•
To obtain the values of the attributes of a path, use the INFO
PATH command.
•
Using the token ZSPI-TKN-RESPONSE-TYPE in the command to
request the return of only those response records for paths on
which errors or warnings occurred can result in no information
being returned.
•
No summary-state transition is associated with this command.
7-78
COMMANDS AND RESPONSES
START Command
START Command
The START command initiates the operation of one or more lines or
paths.
Command
ZCOM-CMD-START
Object Type
ZCOM-OBJ-LINE
or
ZCOM-OBJ-PATH
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
token-type ZSPI-TYP-LIST.
token-type
token-type
token-type
token-type
ZSPI-TYP-SSCTL.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
>
7-79
COMMANDS AND RESPONSES
START Command
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line or path to be started. This token must be present
in the command, and from 1 through 30 object names are allowed.
ZCOM-TKN-OBJNAME is described in Section 6, "Common Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line or path that was started by the command. This token is
present in every response record. ZCOM-TKN-OBJNAME is described
in Section 6, "Common Definitions."
7-80
COMMANDS AND RESPONSES
START Command
ZCOM-TKN-OBJTYPE is an object-type token that indicates the type
of the object named in ZCOM-TKN-OBJNAME. This token can have the
following values:
ZCOM-OBJ-LINE
The object is a line.
ZCOM-OBJ-PATH
The object is a path.
ZCOM-TKN-OBJTYPE is present in every response record, and it is
described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the START command are the following:
-16
(ZCOM-ERR-OBJ-ALRDY-IN-SUMSTATE):
in the desired summary state.
The object is already
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
2
(ZEXP-ERR-NEG-LH-RSP):
a negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The EXPAND line handler returned
The empty response record is being
For command-specific information about these error numbers,
see "Error-Handling Notes" below. For descriptions of all
EXPAND error numbers and their associated error lists, refer to
Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
START is a sensitive command.
•
If the object type in the START command is ZCOM-OBJ-LINE, the
specified line or lines are started. If the object type is
7-81
COMMANDS AND RESPONSES
START Command
ZCOM-OBJ-PATH, all lines associated with the specified path or
paths are started.
•
Successful completion of the START command leaves the lines or
paths in the STARTED summary state. Unsuccessful completion
of the START command leaves the lines or paths in the STOPPED
summary state.
•
If the CLIP is in the boot state, a download of the CLIP
software is performed.
Error-Handling Notes
•
If an attempt is made to start a line or path that is already
in the STARTED summary state, the error identified by the
error number ZCOM-ERR-OBJ-ALRDY-IN-SUMSTATE is returned.
7-82
COMMANDS AND RESPONSES
STATISTICS LINE Command
STATISTICS LINE Command
The STATISTICS LINE command returns statistical information about
the execution history of one or more lines--dynamic information
such as request counts, numbers of errors, and so forth.
Command
ZCOM-CMD-STATISTICS
Object Type
ZCOM-OBJ-LINE
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
>
7-83
COMMANDS AND RESPONSES
STATISTICS LINE Command
ZEXP-MAP-STATS-LINE-CSM
def ZEXP-DDL-STATS-LINE-CSM.
02 ZSTATS-CURR-TMSTP
02 ZLAST-RESETSTATS-TMSTP
02 ZI-FRAMES-SENT
02 ZI-FRAMES-RECV
02 ZS-FRAMES-SENT
02 ZS-FRAMES-RECV
02 ZU-FRAMES-SENT
02 ZU-FRAMES-RECV
02 ZBCC-ERRS
02 ZALLOC-ERRS
02 ZQUAL-ERRS
02 ZFRAMES-TOTAL
02 ZFRAMES-ERR
02 ZL2-I-FRAMES-SENT
02 ZL2-I-FRAMES-SENT-P
02 ZL2-I-FRAMES-RECV
02 ZL2-I-FRAMES-RECV-P
02 ZL2-RR-FRAMES-SENT
02 ZL2-RNR-FRAMES-SENT
02 ZL2-REJ-FRAMES-SENT
02 ZL2-RR-FRAMES-RECV
02 ZL2-RNR-FRAMES-RECV
02 ZL2-REJ-FRAMES-RECV
02 ZL2-SABM-FRAMES-SENT
02 ZL2-SABM-FRAMES-RECV
02 ZL2-DISC-FRAMES-SENT
02 ZL2-DISC-FRAMES-RECV
02 ZL2-CMDR-FRAMES-SENT
02 ZL2-CMDR-FRAMES-RECV
02 ZL2-UA-FRAMES-SENT
02 ZL2-UA-FRAMES-RECV
02 ZL2-DM-FRAMES-SENT
02 ZL2-DM-FRAMES-RECV
02 ZL2-RECV-OVERRUN
02 ZL2-MODEM-ERRS
02 ZL2-SREJ-FRAMES-SENT
02 ZL2-SREJ-FRAMES-RECV
02 ZL2-FCS-ERRS
02 ZL2-TIMEOUT
02 ZL2-ADDR-ERRS
02 ZL2-LEN-ERRS
02 ZL2-RECV-ABORTED
02 ZL2-RECV-BUFF
02 ZL2-STATE-CTS
02 ZL2-STATE-DCD
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
type
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-BYTE.
ZSPI-DDL-BYTE.
>
7-84
COMMANDS AND RESPONSES
STATISTICS LINE Command
02
02
02
end.
ZL2-STATE-DSR
ZLINE-PPID
ZLINE-BPID
type ZSPI-DDL-BYTE.
type ZSPI-DDL-INT-PAIR.
type ZSPI-DDL-INT-PAIR.
ZEXP-MAP-STATS-LINE-NCSM
def ZEXP-DDL-STATS-LINE-NCSM.
02 ZSTATS-CURR-TMSTP
type
02 ZLAST-RESETSTATS-TMSTP type
02 ZI-FRAMES-SENT
type
02 ZI-FRAMES-RECV
type
02 ZS-FRAMES-SENT
type
02 ZS-FRAMES-RECV
type
02 ZU-FRAMES-SENT
type
02 ZU-FRAMES-RECV
type
02 ZBCC-ERRS
type
02 ZALLOC-ERRS
type
02 ZQUAL-ERRS
type
02 ZFRAMES-TOTAL
type
02 ZFRAMES-ERR
type
02 ZL2-I-FRAMES-SENT
type
02 ZL2-I-FRAMES-SENT-P
type
02 ZL2-I-FRAMES-RECV
type
02 ZL2-I-FRAMES-RECV-P
type
02 ZL2-RR-FRAMES-SENT
type
02 ZL2-RNR-FRAMES-SENT
type
02 ZL2-REJ-FRAMES-SENT
type
02 ZL2-RR-FRAMES-RECV
type
02 ZL2-RNR-FRAMES-RECV
type
02 ZL2-REJ-FRAMES-RECV
type
02 ZL2-SABM-FRAMES-SENT
type
02 ZL2-SABM-FRAMES-RECV
type
02 ZL2-DISC-FRAMES-SENT
type
02 ZL2-DISC-FRAMES-RECV
type
02 ZL2-CMDR-FRAMES-SENT
type
02 ZL2-CMDR-FRAMES-RECV
type
02 ZL2-UA-FRAMES-SENT
type
02 ZL2-UA-FRAMES-RECV
type
02 ZL2-DM-FRAMES-SENT
type
02 ZL2-DM-FRAMES-RECV
type
02 ZL2-RECV-OVERRUN
type
02 ZL2-MODEM-ERRS
type
02 ZL2-SREJ-FRAMES-SENT
type
02 ZL2-SREJ-FRAMES-RECV
type
02 ZLINE-PPID
type
02 ZLINE-BPID
type
end.
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT-PAIR.
ZSPI-DDL-INT-PAIR.
>
7-85
COMMANDS AND RESPONSES
STATISTICS LINE Command
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
token-type
token-type
token-type
token-type
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line whose statistics are to be returned. This token must
be present in the command, and from 1 through 30 object names
are allowed. ZCOM-TKN-OBJNAME is described in Section 6, "Common
Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZEXP-MAP-STATS-LINE-CSM and ZEXP-MAP-STATS-LINE-NCSM are both
extensible structured tokens that contain the statistical information for a line. Only one of these tokens is present in each
7-86
COMMANDS AND RESPONSES
STATISTICS LINE Command
response record. ZEXP-MAP-STATS-LINE-CSM is present if the line
handler is configured as HDLC Normal for 6100 CSS; otherwise,
ZEXP-MAP-STATS-LINE-NCSM is present. These tokens are fully
described in Section 6, "Common Definitions."
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of the line whose statistics are returned in this response
record. This token is present in every response record. ZCOMTKN-OBJNAME is described in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-LINE. This token is present in every response record,
and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the STATISTICS LINE command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The EXPAND line handler returned a
The empty response record is being
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
All users can issue the STATISTICS LINE command.
•
The statistical information returned by the STATISTICS LINE
command for FOX (NETCLUSTER) and X.25 (NETNAM) lines is always
all zeros, because the EXPAND subsystem does not control
level-2 operations on such lines.
7-87
COMMANDS AND RESPONSES
STATISTICS LINE Command
•
To obtain statistical information about a line and then
restore the statistics counters to their initial values, use
the RESETSTATS LINE command.
•
To obtain information about the current state of a line, use
the STATUS LINE command.
•
To obtain the values of the attributes of a line, use the INFO
LINE command.
•
Using the token ZSPI-TKN-RESPONSE-TYPE in the command to
request the return of only those response records for lines on
which errors or warnings occurred can result in no information
being returned.
•
No summary-state transition is associated with this command.
7-88
COMMANDS AND RESPONSES
STATISTICS PATH Command
STATISTICS PATH Command
The STATISTICS PATH command returns statistical information about
the execution history of one or more paths--dynamic information
such as request counts, numbers of errors, and so forth.
Command
ZCOM-CMD-STATISTICS
Object Type
ZCOM-OBJ-PATH
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
>
7-89
COMMANDS AND RESPONSES
STATISTICS PATH Command
ZEXP-MAP-STATS-PATH
def ZEXP-DDL-STATS-PATH.
02 ZSTATS-CURR-TMSTP
type
02 ZLAST-RESETSTATS-TMSTP type
02 ZL4-PKTS-SENT
type
02 ZL4-PKTS-RECV
type
02 ZL4-FWD-SENT
type
02 ZL4-FWD-RECV
type
02 ZL4-LINK-REQ-SENT
type
02 ZL4-LINK-REQ-RECV
type
02 ZL4-REQ-SENT-CONN
type
02 ZL4-REQ-SENT-TRACE
type
02 ZL4-REQ-SENT-NCP
type
02 ZL4-REQ-SENT-LRQ
type
02 ZL4-REQ-SENT-LCMP
type
02 ZL4-REQ-SENT-CANCEL
type
02 ZL4-REQ-SENT-ACK
type
02 ZL4-REQ-SENT-NAK
type
02 ZL4-REQ-SENT-ENQ
type
02 ZL4-REQ-RECV-CONN
type
02 ZL4-REQ-RECV-TRACE
type
02 ZL4-REQ-RECV-NCP
type
02 ZL4-REQ-RECV-LRQ
type
02 ZL4-REQ-RECV-LCMP
type
02 ZL4-REQ-RECV-CANCEL
type
02 ZL4-REQ-RECV-ACK
type
02 ZL4-REQ-RECV-NAK
type
02 ZL4-REQ-RECV-ENQ
type
02 ZLOC-POOL-CURR-USED
type
02 ZLOC-POOL-MAX-USED
type
02 ZFRAMES-LE-64
type
02 ZFRAMES-LE-128
type
02 ZFRAMES-LE-256
type
02 ZFRAMES-LE-512
type
02 ZFRAMES-LE-1024
type
02 ZFRAMES-LE-2048
type
02 ZFRAMES-LE-4096
type
02 ZFRAMES-GT-4096
type
02 ZOUT-OF-SEQ-POOL-CURR-USED
type
02 ZOUT-OF-SEQ-POOL-MAX-USED
type
02 ZMAX-POOL-USED
type
02 ZOUT-OF-SEQ-TIMEOUT
type
02 ZPATH-CHANGES-SENT
type
02 ZPATH-CHANGES-RECV
type
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-TIMESTAMP.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
>
7-90
COMMANDS AND RESPONSES
STATISTICS PATH Command
02
02
02
02
02
end.
ZLOC-POOL-PAGES
ZLOC-POOL-FAILS
ZKNOWN-SYS
ZPATH-PPID
ZPATH-BPID
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
type
type
type
type
type
token-type
token-type
token-type
token-type
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT-PAIR.
ZSPI-DDL-INT-PAIR.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a path whose statistics are to be returned. This token must
be present in the command, and from 1 through 30 object names
are allowed. ZCOM-TKN-OBJNAME is described in Section 6, "Common
Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
7-91
COMMANDS AND RESPONSES
STATISTICS PATH Command
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZEXP-MAP-STATS-PATH is an extensible structured token that contains the statistical information for the path. This token is
present in every response record, and it is fully described in
Section 6, "Common Definitions."
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of the path whose statistics are returned in this response
record. This token is present in every response record. ZCOMTKN-OBJNAME is described in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-PATH. This token is present in every response record,
and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the STATISTICS PATH command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The EXPAND line handler returned a
The empty response record is being
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
7-92
COMMANDS AND RESPONSES
STATISTICS PATH Command
Operational Notes
•
All users can issue the STATISTICS PATH command.
•
To obtain statistical information about a path and then
restore the statistics counters to their initial values, use
the RESETSTATS PATH command.
•
To obtain information about the current state of a path, use
the STATUS PATH command.
•
To obtain the values of the attributes of a path, use the INFO
PATH command.
•
Using the token ZSPI-TKN-RESPONSE-TYPE in the command to
request the return of only those response records for paths on
which errors or warnings occurred can result in no information
being returned.
•
No summary-state transition is associated with this command.
7-93
COMMANDS AND RESPONSES
STATISTICS PROCESS Command
STATISTICS PROCESS Command
The STATISTICS PROCESS command returns statistical information
from the Network Utility Program, $ZNUP (this information was
formerly collected by the NCP), concerning one of the following:
•
The communication between two specified systems
•
Network traffic passing through a specified system
Command
ZCOM-CMD-STATISTICS
Object Type
ZCOM-OBJ-PROCESS
Tokens in Command Buffer
ZSPI-TKN-MANAGER
token-type ZSPI-TYP-FNAME32.
!r
ZEXP-TKN-STATS-NCP-OPT
ZEXP-TKN-CALLED-SYS
ZEXP-TKN-SEL-SYS
token-type ZSPI-TYP-ENUM.
token-type ZSPI-TYP-INT.
token-type ZSPI-TYP-INT.
!r
!r
!o
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
>
7-94
COMMANDS AND RESPONSES
STATISTICS PROCESS Command
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
ZEXP-MAP-SYS-STATS-NCP
def ZEXP-DDL-SYS-STATS-NCP.
02 ZLINK-SENT
type
02 ZLINK-RECV
type
02 ZPKTS-SENT
type
02 ZPKTS-RECV
type
02 ZCALLED-SYS
type
02 ZSEL-SYS
type
end.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT2.
ZSPI-DDL-INT.
ZSPI-DDL-INT.
ZEXP-MAP-PKTS-STATS-NCP
def ZEXP-DDL-PKTS-STATS-NCP.
02 ZPKTS-SENT
type ZSPI-DDL-INT2.
02 ZPKTS-RECV
type ZSPI-DDL-INT2.
02 ZFWD-PKTS-SENT
type ZSPI-DDL-INT2.
02 ZFWD-PKTS-RECV
type ZSPI-DDL-INT2.
02 ZCALLED-SYS
type ZSPI-DDL-INT.
end.
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
token-type
token-type
token-type
token-type
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
7-95
COMMANDS AND RESPONSES
STATISTICS PROCESS Command
ZEXP-TKN-STATS-NCP-OPT, if present, specifies whether the command
is to return statistics about the communication between two
specified systems or statistics about network traffic passing
through a specified system. It has the token number ZEXP-TNMSTATS-NCP-OPT and the token type ZSPI-TYP-ENUM. This token must
be present in the command, and duplicate occurrences are not
allowed.
ZEXP-TKN-STATS-NCP-OPT can have the following values:
ZEXP-VAL-SYS-STATS
Return statistics about the communication
between two specified systems.
ZEXP-VAL-PKTS-STATS
Return statistics about network traffic
passing through a specified system.
ZEXP-TKN-CALLED-SYS is the system number of the called system.
It has the token number ZEXP-TNM-CALLED-SYS and the token type
ZSPI-TYP-INT. This token must be present in the command, and
duplicate occurrences are not allowed.
ZEXP-TKN-SEL-SYS is the system number of the selected system. It
has the token number ZEXP-TNM-SEL-SYS and the token type ZSPITYP-INT. This token must be present in the command if and only
if the value of ZEXP-TKN-STATS-NCP-OPT is ZEXP-VAL-SYS-STATS.
Duplicate occurrences are not allowed.
ZCOM-TKN-OBJNAME is an object-name token. This token must
contain the process name "$NCP", and it must be present in the
command. ZCOM-TKN-OBJNAME is described in Section 6, "Common
Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
7-96
COMMANDS AND RESPONSES
STATISTICS PROCESS Command
ZEXP-MAP-SYS-STATS-NCP is an extensible structured token that
contains statistics information about the communication between
the called system and the selected system. It has the token
number ZEXP-TNM-SYS-STATS-NCP and the DDL definition ZEXP-DDLSYS-STATS-NCP. This token is present if and only if ZEXP-TKNSTATS-NCP-OPT was present in the command and had a value of ZEXPVAL-SYS-STATS.
ZEXP-MAP-SYS-STATS-NCP contains the following fields:
ZLINK-SENT is the total number of link requests issued by the
called system to the selected system.
ZLINK-RECV is the total number of link requests received by
the called system from the selected system.
ZPKTS-SENT is the total number of packets sent from the called
system to the selected system.
ZPKTS-RECV is the total number of packets received by the
called system from the selected system.
ZCALLED-SYS is the system number of the called system (ZEXPTKN-CALLED-SYS in the command).
ZSEL-SYS is the system number of the selected system (ZEXPTKN-SEL-SYS in the command).
ZEXP-MAP-PKTS-STATS-NCP is an extensible structured token that
contains statistics information about network traffic passing
through the called system. It has the token number ZEXP-TNMPKTS-STATS-NCP and the DDL definition ZEXP-DDL-PKTS-STATS-NCP.
This token is present if and only if ZEXP-TKN-STATS-NCP-OPT was
present in the command and had a value of ZEXP-VAL-PKTS-STATS.
ZEXP-MAP-PKTS-STATS-NCP contains the following fields:
ZPKTS-SENT is the total number of packets sent by the called
system.
ZPKTS-RECV is the total number of packets received by the
called system.
ZFWD-PKTS-SENT is the total number of forward packets sent by
the called system.
ZFWD-PKTS-RECV is the total number of forward packets received
by the called system.
ZCALLED-SYS is the system number of the called system (ZEXPTKN-CALLED-SYS in the command).
7-97
COMMANDS AND RESPONSES
STATISTICS PROCESS Command
ZCOM-TKN-OBJNAME is an object-name token that contains the
process name "$NCP". This token is always present in the
response. ZCOM-TKN-OBJNAME is described in Section 6, "Common
Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-PROCESS. This token is always present in the response,
and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the STATISTICS PROCESS command are the following:
9
(ZEXP-ERR-NEG-NCP-RSP):
response.
The NCP returned a negative
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
All users can issue the STATISTICS PROCESS command.
•
This command does not return a timestamp indicating the
time when the statistics counters were last reset. This
information for each individual line is available from the
RESETSTATS LINE command, in the ZLAST-RESETSTATS-TMSTP field
of ZEXP-MAP-STATS-LINE-CSM and ZEXP-MAP-STATS-LINE-NCSM.
•
No summary-state transition is associated with this command.
7-98
COMMANDS AND RESPONSES
STATUS LINE Command
STATUS LINE Command
The STATUS LINE command returns information about the current
state of one or more lines--information such as the summary state
of the line, the CLIP path being used, and so forth.
Command
ZCOM-CMD-STATUS
Object Type
ZCOM-OBJ-LINE
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
ZEXP-MAP-STATUS-LINE
def ZEXP-DDL-STATUS-LINE.
02 ZSTATE
type ZSPI-DDL-ENUM.
02 ZLAST-ERR
type ZSPI-DDL-INT.
>
7-99
COMMANDS AND RESPONSES
STATUS LINE Command
02
02
02
02
02
02
02
end.
ZPATH
type
ZPRIM-SUBCHNL-ADDR
type
ZBKUP-SUBCHNL-ADDR
type
ZCSM-LDEV
type
ZPATH-LDEV
type
ZLINE-PPID
type
ZLINE-BPID
type
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
ZSPI-DDL-INT.
ZSPI-DDL-INT.
ZSPI-DDL-INT.
ZSPI-DDL-INT.
ZSPI-DDL-INT.
ZSPI-DDL-INT-PAIR.
ZSPI-DDL-INT-PAIR.
token-type
token-type
token-type
token-type
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line whose status is to be returned. This token must be
present in the command, and from 1 through 30 object names are
allowed. ZCOM-TKN-OBJNAME is described in Section 6, "Common
Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
7-100
COMMANDS AND RESPONSES
STATUS LINE Command
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZEXP-MAP-STATUS-LINE is an extensible structured token that
describes the current state of the line. It has the token number
ZEXP-TNM-STATUS-LINE and the DDL definition ZEXP-DDL-STATUS-LINE.
This token is present in every response record.
ZEXP-MAP-STATUS-LINE contains the following fields:
ZSTATE contains a value indicating the current summary state
of the line. This field can have the following values:
ZCOM-VAL-SUMSTATE-STARTED
The line is in the STARTED summary state.
ZCOM-VAL-SUMSTATE-STOPPED
The line is in the STOPPED summary state.
ZLAST-ERR contains the value 0 (zero).
ZPATH contains a value indicating which CIU path is being used
by this line. This field can have the following values:
0
Neither path A nor path B is being used.
1
Path A is being used.
2
Path B is being used.
3
Both path A and path B are being used.
ZPRIM-SUBCHNL-ADDR contains the primary subchannel address.
ZBKUP-SUBCHNL-ADDR contains the backup subchannel address.
ZCSM-LDEV contains the LDEV of the CSM.
ZPATH-LDEV contains the LDEV of the path.
ZLINE-PPID is the process ID of the primary line-handler
process associated with the line.
ZLINE-BPID is the process ID of the backup line-handler
process associated with the line.
7-101
COMMANDS AND RESPONSES
STATUS LINE Command
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of the line whose status is returned in this response record.
This token is present in every response record. ZCOM-TKN-OBJNAME
is described in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-LINE. This token is present in every response record,
and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the STATUS LINE command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The EXPAND line handler returned a
The empty response record is being
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
All users can issue the STATUS LINE command.
•
To obtain statistical information about a line, use the
STATISTICS LINE command or the RESETSTATS LINE command.
•
To obtain the values of the attributes of a line, use the INFO
LINE command.
7-102
COMMANDS AND RESPONSES
STATUS LINE Command
•
Using the token ZSPI-TKN-RESPONSE-TYPE in the command to
request the return of only those response records for lines on
which errors or warnings occurred can result in no information
being returned.
•
No summary-state transition is associated with this command.
7-103
COMMANDS AND RESPONSES
STATUS PATH Command
STATUS PATH Command
The STATUS PATH command returns information about the current
state of one or more paths--information such as the summary state
of the path, the number of lines in the path, and so forth.
Command
ZCOM-CMD-STATUS
Object Type
ZCOM-OBJ-PATH
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
ZEXP-MAP-STATUS-PATH
def ZEXP-DDL-STATUS-PATH.
02 ZSTATE
type ZSPI-DDL-ENUM.
02 ZLAST-ERR
type ZSPI-DDL-INT.
>
7-104
COMMANDS AND RESPONSES
STATUS PATH Command
02
02
02
02
02
end.
ZCLIP
ZTOTAL-LINES
ZLDEV
ZPATH-PPID
ZPATH-BPID
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
type ZSPI-DDL-BOOLEAN.
type ZSPI-DDL-INT.
type ZSPI-DDL-INT
occurs 8 times.
type ZSPI-DDL-INT-PAIR.
type ZSPI-DDL-INT-PAIR.
token-type
token-type
token-type
token-type
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a path whose status is to be returned. This token must be
present in the command, and from 1 through 30 object names are
allowed. ZCOM-TKN-OBJNAME is described in Section 6, "Common
Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
7-105
COMMANDS AND RESPONSES
STATUS PATH Command
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZEXP-MAP-STATUS-PATH is an extensible structured token that
describes the current state of the path. It has the token number
ZEXP-TNM-STATUS-PATH and the DDL definition ZEXP-DDL-STATUS-PATH.
This token is present in every response record.
ZEXP-MAP-STATUS-PATH contains the following fields:
ZSTATE contains a value indicating the current summary state
of the path. This field can have the following values:
ZCOM-VAL-SUMSTATE-STARTED
The path is in the STARTED summary state.
ZCOM-VAL-SUMSTATE-STOPPED
The path is in the STOPPED summary state.
ZLAST-ERR contains the value 0 (zero).
ZCLIP indicates whether or not the CLIP is loaded.
can have the following values:
ZSPI-VAL-TRUE
The CLIP is loaded.
ZSPI-VAL-FALSE
The CLIP is not loaded.
This field
ZTOTAL-LINES contains the total number of lines associated
with the path.
ZLDEV is an array of eight integers. Each integer is the LDEV
for a line in the path. ZLDEV[0] is the LDEV for line #1,
ZLDEV[1] is the LDEV for line #2, and so forth.
ZPATH-PPID is the process ID of the primary line-handler
process associated with the path.
ZPATH-BPID is the process ID of the backup line-handler
process associated with the path.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of the path whose status is returned in this response record.
This token is present in every response record. ZCOM-TKN-OBJNAME
is described in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-PATH. This token is present in every response record,
and it is described in Section 6, "Common Definitions."
7-106
COMMANDS AND RESPONSES
STATUS PATH Command
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the STATUS PATH command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
2
(ZEXP-ERR-NEG-LH-RSP):
negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The EXPAND line handler returned a
The empty response record is being
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
All users can issue the STATUS PATH command.
•
To obtain statistical information about a path, use the
STATISTICS PATH command or the RESETSTATS PATH command.
•
To obtain the values of the attributes of a path, use the INFO
PATH command.
•
Using the token ZSPI-TKN-RESPONSE-TYPE in the command to
request the return of only those response records for paths on
which errors or warnings occurred can result in no information
being returned.
•
No summary-state transition is associated with this command.
7-107
COMMANDS AND RESPONSES
STOP Command
STOP Command
The STOP command terminates the operation of one or more lines or
paths if they have no connections to other systems.
Command
ZCOM-CMD-STOP
Object Type
ZCOM-OBJ-LINE
or
ZCOM-OBJ-PATH
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
token-type ZSPI-TYP-LIST.
token-type
token-type
token-type
token-type
ZSPI-TYP-SSCTL.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
>
7-108
COMMANDS AND RESPONSES
STOP Command
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line or path to be terminated. This token must be present
in the command, and from 1 through 30 object names are allowed.
ZCOM-TKN-OBJNAME is described in Section 6, "Common Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of a line or path that was terminated by the command. This
token is present in every response record. ZCOM-TKN-OBJNAME is
described in Section 6, "Common Definitions."
7-109
COMMANDS AND RESPONSES
STOP Command
ZCOM-TKN-OBJTYPE is an object-type token that indicates the type
of the object named in ZCOM-TKN-OBJNAME. This token can have the
following values:
ZCOM-OBJ-LINE
The object is a line.
ZCOM-OBJ-PATH
The object is a path.
ZCOM-TKN-OBJTYPE is present in every response record, and it is
described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the STOP command are the following:
-16
(ZCOM-ERR-OBJ-ALRDY-IN-SUMSTATE):
in the desired summary state.
The object is already
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
2
(ZEXP-ERR-NEG-LH-RSP):
a negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The EXPAND line handler returned
The empty response record is being
For command-specific information about these error numbers,
see "Error-Handling Notes" below. For descriptions of all
EXPAND error numbers and their associated error lists, refer to
Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
STOP is a sensitive command.
•
If the object type in the STOP command is ZCOM-OBJ-LINE, the
specified line or lines are stopped. If the object type is
7-110
COMMANDS AND RESPONSES
STOP Command
ZCOM-OBJ-PATH, all lines associated with the specified path or
paths are stopped.
•
The lines or paths are left in the STOPPED summary state.
•
The only lines affected by the execution of this command are
those for which the level-2 state is not READY.
•
To terminate lines or paths immediately, without waiting for
processing to complete and regardless of whether or not there
are connections to other systems, use the ABORT command.
Error-Handling Notes
•
If an attempt is made to stop a line or path that is already
in the STOPPED summary state, the error identified by the
error number ZCOM-ERR-OBJ-ALRDY-IN-SUMSTATE is returned.
7-111
COMMANDS AND RESPONSES
SWITCH Command
SWITCH Command
The SWITCH command switches one or more line-handler processes
either between two processors or between two Communications
Interface Unit (CIU) paths.
Command
ZCOM-CMD-SWITCH
Object Type
ZCOM-OBJ-PROCESS
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-SWITCH-CPU
ZCOM-TKN-SWITCH-PATH
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-INT.
!(see text)
token-type ZSPI-TYP-ENUM.
!(see text)
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-STRING.
token-type ZSPI-TYP-ENUM.
>
7-112
COMMANDS AND RESPONSES
SWITCH Command
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
token-type ZSPI-TYP-ENUM.
token-type ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-SWITCH-CPU and ZCOM-TKN-SWITCH-PATH are standard datacommunications tokens that describe what the processes are to
be switched to. One token or the other, but not both, must
be present in the command, and duplicate occurrences are not
allowed.
If
to
an
be
ZCOM-TKN-SWITCH-CPU is present, the line-handler processes are
be switched between processors, and the value of this token is
integer indicating the primary processor the processes are to
switched to. This value must be in the range 0 through 15.
If ZCOM-TKN-SWITCH-PATH is present, the line-handler processes
are to be switched between CIU paths, and the value of this token
indicates the path the processes are to be switched to. ZCOMTKN-SWITCH-PATH can have the following values:
ZCOM-VAL-PATH-A
The processes are to be switched to path A.
ZCOM-VAL-PATH-B
The processes are to be switched to path B.
ZCOM-TKN-OBJNAME is an object-name token that contains the object
name of a line-handler process to be switched. This token must
be present in the command, and from 1 through 30 object names
are allowed. ZCOM-TKN-OBJNAME is described in Section 6, "Common
Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
7-113
COMMANDS AND RESPONSES
SWITCH Command
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZCOM-TKN-OBJNAME is an object-name token that contains the object
name of a line-handler process that was switched by the command.
This token is present in every response record. ZCOM-TKN-OBJNAME
is described in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-PROCESS. This token is present in every response
record, and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
the SWITCH command are the following:
-16
(ZCOM-ERR-OBJ-ALRDY-IN-SUMSTATE):
in the desired summary state.
The object is already
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
2
(ZEXP-ERR-NEG-LH-RSP):
a negative response.
3
(ZEXP-ERR-EMPT-RSP):
returned.
The empty response record is being
4
(ZEXP-ERR-TKN-CONFL):
command.
A token conflict occurred in the
The EXPAND line handler returned
For command-specific information about these error numbers,
see "Error-Handling Notes" below. For descriptions of all
EXPAND error numbers and their associated error lists, refer to
Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
7-114
COMMANDS AND RESPONSES
SWITCH Command
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
SWITCH is a sensitive command.
•
To determine which processor is currently being used by a
process, use the PUP command LISTDEV.
•
To determine which CIU path is currently being used by a
process, use the STATUS LINE command.
•
No summary-state transition is associated with this command.
Error-Handling Notes
•
The error identified by the error number ZCOM-ERR-OBJ-ALRDYIN-SUMSTATE signifies that the command specified a switch
in processors, and the processor that is to become the new
primary processor is already the primary processor.
•
The error identified by the error number ZEXP-ERR-TKN-CONFL
signifies that both ZCOM-TKN-SWITCH-CPU and ZCOM-TKN-SWITCHPATH were present in the command.
7-115
COMMANDS AND RESPONSES
TRACE Command (EXPAND Manager Process)
TRACE Command (EXPAND Manager Process)
This form of the TRACE command initiates, modifies, or terminates
trace mode on the EXPAND manager process.
When trace mode is started on an object, trace data, as specified
in the TRACE command, is collected in a special trace file.
This data can later be formatted and displayed using the PTRACE
program, as described in the PTRACE Reference Manual.
This form of the TRACE command (a trace of the EXPAND manager
process) is processed by the EXPAND manager process itself and
not by SCP. The EXPAND manager process uses the GDS tracing
facilities, which are described in the General Device Support
(GDS) Programming Manual.
Command
ZCOM-CMD-TRACE
Object Type
ZCOM-OBJ-PROCESS
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
!r
!r
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
!r
ZSPI-DDL-BOOLEAN.
ZSPI-DDL-BOOLEAN.
ZSPI-DDL-INT.
ZSPI-DDL-INT2.
ZSPI-DDL-INT.
!r
!r
!r
!r
!r
>
7-116
COMMANDS AND RESPONSES
TRACE Command (EXPAND Manager Process)
02
02
end.
ZCOLL
ZFNAME
ZCOM-TKN-TRACE-OPT
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
type ZSPI-DDL-BOOLEAN.
type ZSPI-DDL-FNAME32.
token-type
token-type
token-type
token-type
token-type
token-type
!r
!r
ZSPI-TYP-ENUM.
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
token-type ZSPI-TYP-LIST.
token-type
token-type
token-type
token-type
token-type
ZSPI-TYP-SSCTL.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of the EXPAND manager process, such as "$ZEXP". This token must
be present in the command, and duplicate occurrences are not
allowed. ZCOM-TKN-OBJNAME is described in Section 6, "Common
Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
7-117
COMMANDS AND RESPONSES
TRACE Command (EXPAND Manager Process)
ZCOM-MAP-TRACE-MODIF is a standard data-communications extensible
structured token described in the Communications Management
Programming 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 Communications Management Programming Manual.
This token must be present in the command. The possible values
for ZCOM-TKN-TRACE-OPT are the following:
-1
0
1
2
.
.
.
31
Mask
Mask
Mask
Mask
.
.
.
Mask
bits 0 through 31 are all set on.
bit 0 is set on.
bit 1 is set on.
bit 2 is set on.
bit 31 is set on.
The mask bits have the following meanings for this form of the
TRACE command:
Mask
Bits
----0
1
2
3
4
5
6
7
8
9
10
11
16
17
18
Trace Record
Meaning
Type (in octal)
--------------------------------External request
0-3
External data
10-13
Internal request
20-23
Internal data
30-33
Internal dispatches
40-42
Control blocks
50-57
Pool space
60-63
External control
70-71
Internal control
100
Task control
110-114
NonStop control
120-125
Error control
130-132
Subsystem Programmatic
Interface (SPI) request
200-201
Subsystem Programmatic
Interface (SPI) data
210-211
SGtask internal
220-221
Duplicate occurrences of ZCOM-TKN-TRACE-OPT are allowed, so that
more than one option can be selected.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
7-118
COMMANDS AND RESPONSES
TRACE Command (EXPAND Manager Process)
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of the EXPAND manager process. This token is always present
in the response. ZCOM-TKN-OBJNAME is described in Section 6,
"Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-PROCESS. This token is always present in the response,
and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
this form of the TRACE command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
3
(ZEXP-ERR-EMPT-RSP):
returned.
6
(ZEXP-ERR-TRACE-NOT-STARTED):
processing of this command.
More than 30 object names
The empty response record is being
An error occurred during
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
7-119
COMMANDS AND RESPONSES
TRACE Command (EXPAND Manager Process)
Operational Notes
•
TRACE is a sensitive command.
•
Only one object can be traced at a time; therefore, you cannot
use this command while a trace of the NCP process, a line, or
a path is in progress.
•
No summary-state transition is associated with this command.
7-120
COMMANDS AND RESPONSES
TRACE Command (NCP Process, Lines, and Paths)
TRACE Command (NCP Process, Lines, and Paths)
This form of the TRACE command initiates, modifies, or terminates
trace mode on the NCP process, a line, or a path.
When trace mode is started on an object, trace data, as specified
in the TRACE command, is collected in a special trace file.
This data can later be formatted and displayed using the PTRACE
program, as described in the PTRACE Reference Manual, or by using
SCF in PTRACE mode.
This form of the TRACE command is not passed to the EXPAND
manager process. Instead, it is processed by the tracing
facility provided by SCP. For more information about this
tracing facility, refer to the Communications Management
Programming Manual.
Command
ZCOM-CMD-TRACE
Object Type
ZCOM-OBJ-PROCESS
Tokens in Command Buffer
ZSPI-TKN-MANAGER
ZCOM-TKN-OBJNAME
ZCOM-TKN-CMD-TIMEOUT
token-type ZSPI-TYP-FNAME32.
!r
token-type ZSPI-TYP-STRING.
!r
token-type ZSPI-TYP-TIMESTAMP. !o
ZCOM-MAP-REQID
def ZCOM-DDL-REQID.
02 ZCRTPID
02 ZPAID
end.
!o
type ZSPI-DDL-CRTPID.
type ZSPI-DDL-INT.
!r
!r
ZCOM-MAP-TRACE-MODIF
def ZCOM-DDL-TRACE-MODIF.
02 ZSTOP
type
02 ZPRIM
type
02 ZREC-SIZE
type
02 ZCNT
type
!r
ZSPI-DDL-BOOLEAN.
ZSPI-DDL-BOOLEAN.
ZSPI-DDL-INT.
ZSPI-DDL-INT2.
!r
!r
!r
!r
>
7-121
COMMANDS AND RESPONSES
TRACE Command (NCP Process, Lines, and Paths)
02
02
02
end.
ZXDS-PAGES
ZCOLL
ZFNAME
ZCOM-TKN-TRACE-OPT
ZSPI-TKN-MAXRESP
ZSPI-TKN-CONTEXT
ZSPI-TKN-RESPONSE-TYPE
ZSPI-TKN-ALLOW-TYPE
ZSPI-TKN-COMMENT
type ZSPI-DDL-INT.
type ZSPI-DDL-BOOLEAN.
type ZSPI-DDL-FNAME32.
token-type
token-type
token-type
token-type
token-type
token-type
!r
!r
!r
ZSPI-TYP-ENUM.
!r
ZSPI-TYP-INT.
!o
ZSPI-TYP-BYTESTRING.!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-ENUM.
!o
ZSPI-TYP-STRING.
!o
Tokens in Response Buffer
ZSPI-TKN-DATALIST
...
ZSPI-TKN-ENDLIST
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-RETCODE
ZSPI-TKN-ERRLIST
...
ZSPI-TKN-ENDLIST
ZSPI-TKN-CONTEXT
token-type ZSPI-TYP-LIST.
token-type
token-type
token-type
token-type
token-type
ZSPI-TYP-SSCTL.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-ENUM.
ZSPI-TYP-LIST.
token-type ZSPI-TYP-SSCTL.
token-type ZSPI-TYP-BYTESTRING.
Tokens in Command Buffer
ZSPI-TKN-MANAGER is a standard SPI manager token that contains
the file name of the EXPAND manager process. This token
must be present in the command, and duplicate occurrences are
not allowed. ZSPI-TKN-MANAGER is described in the Distributed
Systems Management (DSM) Programming Manual.
ZCOM-TKN-OBJNAME is an object-name token that contains either
"$NCP", for the NCP, or the name of a line or path to be affected
by the command. This token must be present in the command,
and duplicate occurrences are not allowed. ZCOM-TKN-OBJNAME is
described in Section 6, "Common Definitions."
ZCOM-TKN-CMD-TIMEOUT and ZCOM-MAP-REQID are standard datacommunications tokens that are described in the Communications
Management Programming Manual. Duplicate occurrences of these
tokens are not allowed.
7-122
COMMANDS AND RESPONSES
TRACE Command (NCP Process, Lines, and Paths)
ZCOM-MAP-TRACE-MODIF is a standard data-communications extensible
structured token described in the Communications Management
Programming 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 Communications Management Programming Manual.
This token must be present in the command. The possible values
for ZCOM-TKN-TRACE-OPT are the following:
-1
0
1
2
.
.
.
31
Mask
Mask
Mask
Mask
bits 0 through 31 are all set on.
bit 0 is set on.
bit 1 is set on.
bit 2 is set on.
.
.
.
Mask bit 31 is set on.
The mask bits have the following meanings for this form of the
TRACE command:
Mask
Bits
----0
0
0
0
0
2
3
4
4
4
10
11
15,16
15,17
15,21
Meaning
-----------------------------Level-0 events:
Frames out, nonextended*
Frames in, nonextended*
Frames out, extended*
Frames in, extended*
Level-2 events
Level-3 events
Level-4 events
Line handler to NCP messages
System abort messages
CLB inbound frames**
CLB outbound frames**
CLIP inbound frames**
CLIP outbound frames**
CLIP level-2 events**
Trace
Record Type
----------0
1
7
8
2
3
4
5
6
248
249
255
255
255
* applies only to lines and paths that are not on 6100 CSS.
** applies only to 6100 CSS lines and paths.
Duplicate occurrences of ZCOM-TKN-TRACE-OPT are allowed, so that
more than one option can be selected.
(ZSPI-TKN-) MAXRESP, CONTEXT, RESPONSE-TYPE, ALLOW-TYPE, and
COMMENT are standard SPI tokens described in the Distributed
Systems Management (DSM) Programming Manual. With the exception
of ZSPI-TKN-COMMENT, duplicate occurrences of these tokens are
not allowed.
7-123
COMMANDS AND RESPONSES
TRACE Command (NCP Process, Lines, and Paths)
Tokens in Response Buffer
ZSPI-TKN-DATALIST is a standard SPI data list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of the NCP ("$NCP") or of a line or path that was affected by the
command. This token is always present in the response. ZCOMTKN-OBJNAME is described in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is an object-type token that contains the value
ZCOM-OBJ-PROCESS. This token is always present in the response,
and it is described in Section 6, "Common Definitions."
ZSPI-TKN-RETCODE is the standard SPI return token described in
the Distributed Systems Management (DSM) Programming Manual.
Some values of RETCODE that are likely to occur in response to
this form of the TRACE command are the following:
1
(ZEXP-ERR-TOO-MANY-OBJNAMES):
were in the command.
More than 30 object names
3
(ZEXP-ERR-EMPT-RSP):
returned.
5
(ZEXP-ERR-OBJ-TYPE-NAME-MISMATC): A conflict exists between the object type and an object name.
The empty response record is being
For descriptions of all EXPAND error numbers and their associated
error lists, refer to Appendix A.
ZSPI-TKN-ERRLIST is a standard SPI error list, as described in
the Distributed Systems Management (DSM) Programming Manual. The
list ends with the token ZSPI-TKN-ENDLIST.
ZSPI-TKN-CONTEXT is the standard SPI context token described in
the Distributed Systems Management (DSM) Programming Manual.
Operational Notes
•
TRACE is a sensitive command.
•
Only one object can be traced at a time; therefore, you cannot
use this command while another TRACE command is in progress.
•
No summary-state transition is associated with this command.
7-124
COMMANDS AND RESPONSES
Examples of Commands and Responses
EXAMPLES OF COMMANDS AND RESPONSES
The following example program, written in TAL, illustrates the
basic tasks that must be performed in an application that sends
commands to and retrieves responses from the EXPAND subsystem.
These basic steps are the following:
•
Opening SCP
•
Building the command buffer
•
Sending the command
•
Retrieving the response
•
Closing SCP
!
!
!
!
***************************************************************
*
Sample program to demonstrate giving commands and
*
*
receiving responses.
*
***************************************************************
?symbols, inspect
?nocode, nomap, nolmap
! The SPI standard definitions
?nolist, source $system.zspidef.zspital
?list
! The data-communications standard definitions
?nolist, source $system.zspidef.zcomtal
?list
! The EXPAND subsystem standard definitions
?nolist,source $system.zspidef.zexptal
?list
! Global declarations
INT scp^file^num,
! scp file number
.tkn^value[0:(zexp^val^buflen/2)-1], ! a token value
address[0:1],
! line address
char^set,
! character set of line
frame^size,
! frame size of line
syncs;
! syncs value of line
INT(32) line^speed;
! line speed of line
STRUCT .exp^buf(zexp^ddl^msg^buffer^maxlen^def),
! request/reply buffer
.zexp^val^ssid(zexp^val^ssid^def); ! subsystem ID
7-125
COMMANDS AND RESPONSES
Examples of Commands and Responses
! External declarations for GUARDIAN procedures
?nolist, source $system.system.extdecs(OPEN, CLOSE, WRITEREAD,
?
DEBUG, FILEINFO, INITIALIZER);
?list
! External declarations for SPI procedures
?nolist, source $system.system.extdecs0(SSGET, SSGETTKN, SSINIT,
?
SSMOVE, SSMOVETKN, SSNULL, SSPUT, SSPUTTKN)
?list
! ***************************************************************
! *
open^scp
*
! ***************************************************************
INT PROC open^scp;
BEGIN
! This procedure opens the SCP process, which is named $ZNET,
! and checks for open errors
INT scp^name[0:11] := ["$ZNET
#ZSPI
", 4 * [" "]],
flags := 0,
error := 0;
CALL OPEN(scp^name, scp^file^num, flags);
IF < THEN
BEGIN
! There was an open error
CALL FILEINFO(scp^file^num, error);
CALL DEBUG;
END;
! get error number
RETURN error;
END; ! of open^scp
! ***************************************************************
! *
handle^spi^error
*
! ***************************************************************
PROC handle^spi^error(error^number);
INT error^number;
! value returned by SPI procedure
BEGIN
! Handle errors in calls on SPI procedures
END; ! of handle^spi^error
7-126
COMMANDS AND RESPONSES
Examples of Commands and Responses
! ***************************************************************
! *
call^scp
*
! ***************************************************************
INT PROC call^scp;
BEGIN
! This procedure sends a command to SCP and retrieves the
! response. The value returned by call^scp is the value of
! the return token in the response.
INT error,
! error code for WRITEREAD error
spi^err,
! returned by call to SPI procedure
return^token,
! value of return token
init^buffer,
write^count,
read^count,
count^read;
spi^err := SSGETTKN(exp^buf, zspi^tkn^usedlen, write^count);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
read^count := zexp^val^maxbuflen;
CALL WRITEREAD(scp^file^num, exp^buf, write^count, read^count,
count^read);
IF <> THEN
BEGIN
! an error occurred during WRITEREAD
CALL FILEINFO(scp^file^num, error); ! get error code
CALL DEBUG;
END;
! reset buffer length, initial position and last error
init^buffer := zexp^val^maxbuflen;
spi^err := SSPUTTKN(exp^buf, zspi^tkn^reset^buffer,
init^buffer);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
! get the value of the return token
spi^err := SSGETTKN(exp^buf, zspi^tkn^retcode, return^token);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
RETURN return^token;
END; ! of call^scp
7-127
COMMANDS AND RESPONSES
Examples of Commands and Responses
! ***************************************************************
! *
build^cmd
*
! ***************************************************************
PROC build^cmd(cmd, obj^type);
INT cmd,
! command number
obj^type;
! object type
BEGIN
INT spi^err,
! returned by call on SPI procedure
zexp^manager[0:15] :=
! name of EXPAND manager
! process
["\MYSYS $ZEXP
"];
spi^err := SSINIT(exp^buf,zexp^val^buflen,zexp^val^ssid,
zspi^val^cmdhdr,cmd,obj^type,0);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
! put the manager token in the buffer
spi^err := SSPUTTKN(exp^buf, zspi^tkn^manager, zexp^manager);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
END; ! of build^cmd
! ***************************************************************
! *
probe^ncp
*
! ***************************************************************
PROC probe^ncp(called^sys,sel^sys);
INT called^sys,
sel^sys;
BEGIN
INT spi^err,
! returned by call to SPI procedure
return^token,
! value of return token
.i^ncp^name[0:11];
! NCP name for object-name token
STRING .s^ncp^name := @i^ncp^name '<<' 1; !string NCP name
INT .zexp^map^probe^ncp^resp[0:zexp^map^probe^ncp^wln-1] :=
zexp^map^probe^ncp;
INT .probe^ncp^value(zexp^ddl^probe^ncp^def);
! Initialize the command buffer
CALL build^cmd(zcom^cmd^probe, zcom^obj^process);
! Put the object-name token ("$NCP") in the buffer
i^ncp^name[0] := 4;
! length of string
s^ncp^name[2] ':=' ["$NCP"];
! value of string
spi^err := SSPUTTKN(exp^buf, zcom^tkn^objname, s^ncp^name);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
7-128
COMMANDS AND RESPONSES
Examples of Commands and Responses
! Put the called-system token in the buffer
spi^err := SSPUTTKN(exp^buf, zexp^tkn^called^sys, called^sys);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
! Put the selected-system token in the buffer
spi^err := SSPUTTKN(exp^buf, zexp^tkn^sel^sys, sel^sys);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
return^token := call^scp;
IF return^token <> zcom^err^ok THEN ! an error occurred
BEGIN
! Handle the possible errors for the PROBE PROCESS ($NCP)
! command
RETURN;
END;
! Get the value of the PROBE extensible structured token
spi^err := SSGET(exp^buf,zexp^map^probe^ncp^resp,
tkn^value, 1);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
! Make the information accessible
@probe^ncp^value := @tkn^value;
END; ! of probe^ncp
! ***************************************************************
! *
info^ncp
*
! ***************************************************************
PROC info^ncp(called^sys,sel^sys);
INT called^sys,
sel^sys;
BEGIN
INT
spi^err,
! returned by call on SPI procedure
return^token,
! value of return token
ncp^maps^val,
! value for the NCP option token
.i^ncp^name[0:11];
! NCP name for object-name token
STRING .s^ncp^name := @i^ncp^name '<<' 1; !string NCP name
INT .zexp^map^info^ncp^netmap^rsp
[0:zexp^map^info^ncp^netmap^wln-1] :=
zexp^map^info^ncp^netmap;
INT .info^ncp^netmap^value(zexp^ddl^info^ncp^netmap^def);
INT .zexp^map^info^ncp^pathmap^rsp
[0:zexp^map^info^ncp^pathmap^wln-1] :=
zexp^map^info^ncp^pathmap;
INT .info^ncp^pathmap^value(zexp^ddl^info^ncp^pathmap^def);
7-129
COMMANDS AND RESPONSES
Examples of Commands and Responses
! Initialize the command buffer
CALL build^cmd(zcom^cmd^info, zcom^obj^process);
! Put the object-name token ("$NCP") in the buffer
i^ncp^name[0] := 4;
! lenght of the string
s^ncp^name[2] ':=' ["$NCP"];
! value of the string
spi^err := SSPUTTKN(exp^buf, zcom^tkn^objname, i^ncp^name);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
! Put the NCP option token in the buffer;
! select both network map and path map information
ncp^maps^val := zexp^val^ncp^maps;
spi^err := SSPUTTKN(exp^buf, zexp^tkn^info^ncp^opt,
ncp^maps^val);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
! Put the called-system token in the buffer
spi^err := SSPUTTKN(exp^buf, zexp^tkn^called^sys, called^sys);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
! Put the selected-system token in the buffer
spi^err := SSPUTTKN(exp^buf, zexp^tkn^sel^sys, sel^sys);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
return^token := call^scp;
IF return^token <> zcom^err^ok THEN ! an error occurred
BEGIN
! Handle the possible errors for the INFO PROCESS ($NCP)
! command
RETURN;
END;
! Get the value of the NETMAP extensible structured token
spi^err := SSGET(exp^buf,zexp^map^info^ncp^netmap^rsp,
tkn^value, 1);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
! Make the information accessible
@info^ncp^netmap^value := @tkn^value;
! Get the value of the PATHMAP extensible structured token
spi^err := SSGET(exp^buf,zexp^map^info^ncp^pathmap^rsp,
tkn^value, 1);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
7-130
COMMANDS AND RESPONSES
Examples of Commands and Responses
! Make the information accessible
@info^ncp^pathmap^value := @tkn^value;
END; !of info^ncp
! ***************************************************************
! *
start^line
*
! ***************************************************************
PROC start^line(obj^name);
INT .obj^name;
! object name of line to be started
BEGIN
INT spi^err,
! returned by call on SPI procedure
return^token;
! value of return token
! Initialize the command buffer
CALL build^cmd(zcom^cmd^start, zcom^obj^line);
! Put the object-name token in the buffer
spi^err := SSPUTTKN(exp^buf, zcom^tkn^objname, obj^name);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
return^token := call^scp;
IF return^token <> zcom^err^ok THEN ! an error occurred
! Handle the possible errors for the START LINE command
END; ! of start^line
! ***************************************************************
! *
abort^line
*
! ***************************************************************
PROC abort^line(obj^name);
INT .obj^name;
! The object name of the line to be stopped
BEGIN
INT spi^err,
! returned by call on SPI procedure
return^token;
! the value of the return token
! Initialize the command buffer
CALL build^cmd(zcom^cmd^abort, zcom^obj^line);
! Put the object-name token in the buffer
spi^err := SSPUTTKN(exp^buf, zcom^tkn^objname, obj^name);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
return^token := call^scp;
IF return^token <> zcom^err^ok THEN ! an error occurred
! Handle the possible errors for the STOP LINE command
END; ! of abort^line
7-131
COMMANDS AND RESPONSES
Examples of Commands and Responses
! ***************************************************************
! *
alter^line
*
! ***************************************************************
PROC alter^line(obj^name);
INT .obj^name;
! object name of line whose
! attributes are to be altered
BEGIN
INT spi^err,
! returned by call on SPI procedure
return^token;
! value of return token
INT .zexp^map^alter^line^req[0:zexp^map^alter^line^wln-1]
:= zexp^map^alter^line;
INT .alter^line^value(zexp^ddl^alter^line^def);
! Initialize the command buffer
CALL build^cmd(zcom^cmd^alter, zcom^obj^line);
! Put the object-name token in the buffer
spi^err := SSPUTTKN(exp^buf, zcom^tkn^objname, obj^name);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
@alter^line^value := @tkn^value;
! Initialize the fields of the extensible structured token
! ZEXP^MAP^ALTER^LINE to null values
spi^err := SSNULL(zexp^map^alter^line^req, alter^line^value);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
! Modify the fields that correspond to the attributes
! to be altered
alter^line^value.zretries := 6;
alter^line^value.zsyncs := 4;
! Put the token in the command buffer
spi^err := SSPUT(exp^buf, zexp^map^alter^line^req,
alter^line^value);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
return^token := call^scp;
IF return^token <> zcom^err^ok THEN ! an error occurred
! Handle the possible errors for the ALTER LINE command
END; ! of alter^line
7-132
COMMANDS AND RESPONSES
Examples of Commands and Responses
! ***************************************************************
! *
info^line^hdlc
*
! ***************************************************************
PROC info^line^hdlc(obj^name);
INT .obj^name;
! object name of line whose
! attribute values are to be returned
BEGIN
INT spi^err,
! returned by call on SPI procedure
return^token;
! value of return token
INT .zexp^map^info^line^hdlc^resp
[0:zexp^map^info^line^hdlc^wln-1] :=
zexp^map^info^line^hdlc;
INT .info^line^hdlc^value(zexp^ddl^info^line^hdlc^def);
! Initialize the command buffer
CALL build^cmd(zcom^cmd^info, zcom^obj^line);
! Put the object-name token in the buffer
spi^err := SSPUTTKN(exp^buf, zcom^tkn^objname, obj^name);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
return^token := call^scp;
IF return^token <> zcom^err^ok THEN ! an error occurred
BEGIN
! Handle the possible errors for the INFO LINE
! command and exit this procedure
RETURN;
END;
! get the value of the extensible structured token
! zexp^map^info^line^hdlc
spi^err := SSGET(exp^buf, zexp^map^info^line^hdlc^resp,
tkn^value, 1);
IF spi^err THEN
CALL handle^spi^error(spi^err);
! error on the call
! save some of the information
@info^line^hdlc^value := @tkn^value;
address[0] := info^line^hdlc^value.zaddr.z^int[0];
address[1] := info^line^hdlc^value.zaddr.z^int[1];
char^set := info^line^hdlc^value.zcharset;
frame^size := info^line^hdlc^value.zframe^size;
syncs := info^line^hdlc^value.zsyncs;
line^speed := info^line^hdlc^value.zspeed;
END; ! of info^line^hdlc
7-133
COMMANDS AND RESPONSES
Examples of Commands and Responses
! ***************************************************************
! *
main program
*
! ***************************************************************
PROC m MAIN;
BEGIN
INT error,
called^sys,
sel^sys,
obj^name[0:8];
!
!
!
!
error upon opening SCP
sys # of called sys for net cmds
sys # of selected sys for net cmds
object name of line for line cmds
! Set up the EXPAND subsystem ID
zexp^val^ssid ':=' [zspi^val^tandem,
zspi^ssn^zexp,
zexp^val^version];
! Dispose of the startup message
CALL INITIALIZER;
! Open SCP
error := open^scp;
IF error THEN CALL DEBUG;
! Set up values for called system and selected system
! for network information commands
called^sys := 3;
sel^sys := 6;
! Set up object name to contain name of line to be
! affected by line commands
obj^name[0] := 8;
obj^name[1] ':=' ["$LHEXP "];
! Issue commands
CALL probe^ncp(called^sys,sel^sys);
CALL info^ncp(called^sys,sel^sys);
CALL info^line^hdlc(obj^name);
CALL abort^line(obj^name);
CALL alter^line(obj^name);
CALL start^line(obj^name);
CALL info^line^hdlc(obj^name);
! Close SCP
CALL CLOSE(scp^file^num);
END; ! of main program
7-134
SECTION 8
EVENT MANAGEMENT
The EXPAND subsystem provides information about events that it
detects by issuing event messages. A management application
can obtain these event messages by opening an Event Management
Service (EMS) distributor process and requesting the messages.
The application can also specify that a filter be applied to
select certain event messages. This section describes the event
messages that the EXPAND subsystem can issue and the specific
programming considerations for dealing with EXPAND event messages
in an application. For general information on how an application
obtains event messages from a subsystem, refer to the Event
Management Service (EMS) Manual.
In this section, event-message tokens and their values are
represented in DDL. For a quick explanation of DDL as it applies
to SPI, refer to the appendix "Overview of DDL for SPI" in the
Distributed Systems Management (DSM) Programming Manual.
SUBSYSTEM PROCESSES THAT REPORT EVENTS
Event messages issued by the EXPAND subsystem are generated by
the line-handler processes and by the Network Control Process
(NCP).
All event messages issued by the EXPAND subsystem contain the
EXPAND subsystem ID, which is described in Section 6, "Common
Definitions." For more information about subsystem IDs, refer to
the Distributed Systems Management (DSM) Programming Manual.
8-1
EVENT MANAGEMENT
Subsystem Processes That Report Events
Table 8-1 lists the event messages that the line-handler processes can issue, and Table 8-2 lists the event messages that the
NCP can issue.
Table 8-1.
EVENT
NUMBER
8-2
EXPAND Line-Handler Process Event Messages
SYMBOLIC
NAME
(ZEXP-EVT-)
DESCRIPTION
3
IO-BUS-ERR
I/O-bus error
4
DEV-ERR
Device error
6
DEV-UP
Line brought up
7
DEV-DOWN
Line brought down
141
CLIP-DWLOADED
CLIP downloaded
146
CSS-UNIT-ERROR
CLIP or CIU download
error
147
CSS-STATUS-PROBE-ERR
CLIP status probe error
152
CSS-CLB-CMD-REJ
BOB and host not
synchronized
156
CSS-NO-RSP
CLIP not responding
157
CSS-FRAME-ERR
Frame error
158
CSS-UNEXP-BRKPT
Unexpected breakpoint
160
CSS-LIU-CONFIG-ERR
Line configuration error
164
CSS-LINE-ERR
Invalid functionmodifier
EVENT MANAGEMENT
Subsystem Processes That Report Events
Table 8-2.
EXPAND Network Control Process Event Messages
EVENT
NUMBER
SYMBOLIC
NAME
(ZEXP-EVT-)
DESCRIPTION
33
NET-LINE-QUAL
Line quality change
43
NET-DISCONN
Network connection lost
44
NET-LINE-READY
Line ready
45
NET-LINE-NOT-READY
Line not ready
46
NET-CONN
Network connection made
47
NET-TIMEOUT
Timeout occurred
48
NET-CPU-STATUS
Processor status change
49
NET-NO-RSP
System not responding
90
NET-BAD-SYSGEN
SYSGEN parameter error
91
NET-RUN-TIME-ERR
Run-time error
NET-REQ-ABORT
Network traffic aborted
117
CRITICAL EVENTS
Events reported by the EXPAND subsystem are divided into two
classes: critical events and noncritical events. Critical
events are those for which the consequences could be serious,
such as the loss of a device or the occurrence of certain errors.
Noncritical events are often expected events, such as a line
becoming ready.
To determine whether or not an event message reports a critical
event, examine the value of the event-message token ZEMS-TKNEMPHASIS. If the value is ZSPI-VAL-TRUE, the event message
reports a critical event. If the value is ZSPI-VAL-FALSE, the
event is not critical.
8-3
EVENT MANAGEMENT
Event-Management Programming
EVENT-MANAGEMENT PROGRAMMING
The buffer size for an EXPAND event message is 128 words.
EXPAND event messages are made up of individual tokens, each
containing one piece of information about the event. There
are no extensible structured tokens or lists in EXPAND event
messages.
All EXPAND event messages are reported to EMS and none are
reported to the Tandem Maintenance and Diagnostic System (TMDS).
All messages are also displayed on the operator console controlled by the compatibility distributor ($Z0).
The EXPAND subsystem does not report any events as action events
(events that require operator intervention).
EMS provides you with the capability to create programs called
filters, which allow applications to select particular event
messages from among all the event messages that have been issued.
Filters select event messages to be returned to an application by
examining the values of tokens in the event message.
For example, to select only event messages issued by the EXPAND
subsystem, a filter would examine the token that contains the
subsystem ID of the issuing subsystem and pass through only those
messages containing the EXPAND subsystem ID.
Any of the tokens in an event message can be used for selecting
the event messages to be returned to an application. You can
create filters that return only critical event messages, all
event messages associated with a particular device, all event
messages with a certain event number, and so forth.
For more information about filters, refer to the Event Management
Service (EMS) Manual.
EVENT-MESSAGE DESCRIPTIONS
On the following pages, each event message that can be issued by
the EXPAND subsystem is described in detail. The descriptions
are given in ascending order by event number; that is, in
ascending order by the ZEXP-EVT- values.
8-4
EVENT MANAGEMENT
Event-Message Descriptions
Within each event-message description, there is a box that lists
all the tokens that can appear in the event message. Header
tokens are listed here, because an application can filter event
messages on header tokens as well as on other tokens. These
tokens are divided into four categories:
1.
Unconditional tokens (tokens that are always present in the
event message).
2.
Conditional tokens (tokens that might be present in the event
message).
3.
Volatile tokens (those that are subject to change from
release to release).
4.
Tandem internal tokens (those intended for Tandem use only).
If none of the tokens in an event message fall into a particular
category, that category does not appear in the box.
The order in which tokens are presented in the token sections
of the syntax box is arbitrary, except that the token ZEMS-TKNSUBJECT-MARK always immediately precedes the subject token of an
event message. For more information on the subject token, refer
to the Event Management Service (EMS) Manual.
The box also contains a portion of the text version of the event
message. The text version of an event message is available
through the EMSTEXT procedure, and it contains a standard header
that includes the date, time, system name, and other information.
(For further information on the standard header, refer to the
Event Management Service (EMS) Manual.) The text shown in the
box follows this standard header.
When you use the EMSTEXT procedure to get the text version of an
event message, you request either the display-format version or
the console-compatible-format version, as described in the Event
Management Service (EMS) Manual. In the case of EXPAND event
messages, there is no difference between the two versions (except
possibly the standard header), and the two versions are also
identical to the corresponding console message.
The notation used in the box for simple tokens is a shorthand
version of the essential information given in the DDL TOKEN-CODE
statement.
Following the box, the event-message tokens are described in the
same order in which they appeared in the box. However, because
Tandem internal tokens are intended for Tandem use only, they are
not described.
8-5
EVENT MANAGEMENT
Event-Message Descriptions
The descriptions in this section of the simple tokens defined by
the EXPAND subsystem (that is, the simple tokens whose symbolic
names begin with ZEXP-TKN-) do not identify the token numbers of
the tokens. However, the symbolic names of the token numbers can
be derived from the token names by replacing -TKN- with -TNM-.
For example, the token number of the token ZEXP-TKN-LINE-QUAL is
ZEXP-TNM-LINE-QUAL.
8-6
EVENT MANAGEMENT
3: ZEXP-EVT-IO-BUS-ERR
3:
ZEXP-EVT-IO-BUS-ERR
An I/O-bus error occurred, and an I/O path switch took place.
This event is a critical event, and the event message is reported
to the EMS collector, $0.
This event message is equivalent to console message 03.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEMS-TKN-LDEVNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
ZEXP-TKN-IO-BUS-ERR
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev [ %ccu ] I/O BUS ERROR #nnn
(BELL)
Console-Compatible Format:
LDEV ldev [ %ccu ] I/O BUS ERROR #nnn
(BELL)
8-7
EVENT MANAGEMENT
3: ZEXP-EVT-IO-BUS-ERR
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
IO-BUS-ERR (3).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line on which
the error occurred.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating
that this event is a critical event. This token is described in
the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
ZEMS-TKN-LDEV is a standard EMS token described in the Event
Management Service (EMS) Manual. It corresponds to the value
ldev in the text message.
ZEXP-TKN-IO-BUS-ERR gives the file-system error number for the
I/O bus error. For information on the particular file-system
error that occurred, refer to the System Procedure Errors and
Messages Manual. This token corresponds to the value nnn in the
text message.
Event-Message Text
In the text message, ldev corresponds to the value of ZEMS-TKNLDEV and nnn corresponds to the value of ZEXP-TKN-IO-BUS-ERR.
The value ccu does not correspond to the value of a token in the
event message.
8-8
EVENT MANAGEMENT
3: ZEXP-EVT-IO-BUS-ERR
Probable Cause
An I/O-bus error occurred during a data transfer with the
indicated device on a channel controlled by the sender CPU, and
an I/O path switch took place. The system retries the operation,
then retries the other path. If the file-system error number in
the token ZEXP-TKN-IO-BUS-ERR is in the range 210 through 229,
the operation might have been switched to the other CPU.
This event can be caused by a controller generating a continuous
I/O power-on interrupt. In this case, the application that is
trying to communicate with the device receives an error code
(usually #231, I/O power on) in response to its I/O request.
A TMDS event is generated.
Recommended Action
Appropriate recovery depends on the file-system error that
occurred. For information on file-system errors and how to
recover from them, refer to the System Procedure Errors and
Messages Manual.
8-9
EVENT MANAGEMENT
4: ZEXP-EVT-DEV-ERR
4:
ZEXP-EVT-DEV-ERR
An error occurred on the indicated line, and the I/O retry did
not succeed. This event is a critical event, and the event
message is reported to the EMS collector, $0.
This event message is equivalent to console message 04.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEMS-TKN-LDEVNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-DEV-STATUS
ZEXP-TKN-DEV-STATUS-MASK
token-type
token-type
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-INT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev [ CU %ccu ] ERROR %dev-status
%param1 %param2 %param3 (BELL)
Console-Compatible Format:
LDEV ldev [ CU %ccu ] ERROR %dev-status
%param1 %param2 %param3 (BELL)
8-10
EVENT MANAGEMENT
4: ZEXP-EVT-DEV-ERR
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
DEV-ERR (4).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line on which
the error occurred.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating
that this event is a critical event. This token is described in
the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
(ZEMS-TKN-) LDEV and CU are standard EMS tokens described in the
Event Management Service (EMS) Manual. These tokens correspond
to the values ldev and ccu, respectively, in the text message.
ZEXP-TKN-DEV-STATUS contains device status information. For
data-communications lines, this information is the status word
returned by the controller, in the format described below.
For the byte-synchronous controller, the bits of the status word
that are equal to 1 can be interpreted as follows:
Bit
----.0
.1
.2
.3
.4
Meaning (Write Unit)
-------------------Power on
Channel underrun
Channel abort
Channel parity error
Auto poll termination
.5
Data set ready termination
.6
Modem loss
Meaning (Read Unit)
------------------Power on
Device overrun
Channel abort
Unused
Block-check character
error
Vertical redundancy
check error
Modem loss
8-11
EVENT MANAGEMENT
4: ZEXP-EVT-DEV-ERR
If a modem loss was detected or, for a read unit, if a vertical
redundancy check error was reported, bits 7 through 15 of the
status word have the following meanings:
Bit
----.7
.8
.9
.10
.11
.12
.13
.14
.15
Meaning (Write Unit)
-------------------Byte count termination
Data set ready
Modem loss sensed
Data carrier detected
Clear to send
Data set ready interrupt
Control carrier enable
Request to send
Data terminal ready
Meaning (Read Unit)
------------------Byte count termination
Data set ready
Modem loss sensed
Data carrier detected
Clear to send
Data set ready interrupt
Control carrier enable
Request to send
Data terminal ready
If no modem loss was detected or, for a read unit, no vertical
redundancy check error was reported, bits 7 through 15 of the
status word have the following meanings:
Bit
----.7
.8
.9
.10
.11
.12
.13
.14
.15
Meaning (Write Unit)
-------------------Byte count termination
Meaning (Read Unit)
------------------Byte count termination
ETB/ETX sensed
SOH/STX sensed
State count
State count
For the bit-synchronous controller, the bits of the status word
that are equal to 1 can be interpreted as follows:
Bit
----.0
.1
.2
.3
.4
.5
.6
.7
8-12
Meaning (Write Unit)
-------------------Power on
Channel underrun
Channel abort
Channel parity error
Modem loss
0
Transmit underrun
No encryption
Meaning (Read Unit)
------------------0
Channel underrun
Channel abort
0
Modem loss
Read byte overrun
Receiver overrun
No encryption
EVENT MANAGEMENT
4: ZEXP-EVT-DEV-ERR
Bit
----.0
.1
.2
.3
.4
.5
.6
.7
Meaning (Autopoll)
-----------------0
Channel underrun
Channel abort
Channel parity error
Modem loss
Autopoll terminated
Transmit underrun
0
Meaning (Modem Control)
----------------------0
0
0
0
0
0
Data set ready interrupt
0
If a modem loss was detected, bits 8 through 15 of the status
word indicate modem status as follows:
Bit
----.8
.9
.10
.11
.12
.13
.14
.15
Meaning
------Data set ready (inverted)
Carrier detect (inverted)
Clear to send (inverted)
Transmit overrun
RS-422
Maintenance mode
Request to send
Data terminal ready
If no modem loss was detected, bits 8 through 15 of the status
word have the following meanings:
Bit
----.8
.9
.10
.11
.12
.13
Meaning (Write Unit)
--------------------
Ending state count
.14
.15
Bit
----.8
Meaning (Autopoll)
-----------------0
.9
0
.10
.11
.12
.13
.14
.15
0
0
0
0
End of poll list
End of poll
Meaning (Read Unit)
------------------Receiver error
Assembled bit count,
bit 0 (ABC.0)
ABC.1
ABC.2
Receiver overrun error
Abort/Go-Ahead character
detected
Receiver end-of-message
0
Meaning (Modem Control)
----------------------Data set ready
(inverted)
Carrier detect
(inverted)
Clear to send (inverted)
Transmit overrun
RS-422
Maintenance mode
Request to send
Data terminal ready
8-13
EVENT MANAGEMENT
4: ZEXP-EVT-DEV-ERR
For the multifunction controller, the status word can be interpreted as two bytes whose values identify the cause of the
controller interrupt, as follows:
Bits 0-7
-------0
Bits 8-15
--------0
1
3
4
5
6
7
8
9
10
2
All values
Error in data transfer to or from
Tandem system
Transfer aborted by channel
Data buffer DMA error
Peripheral port chip (PPC)
error
Read parity error
T-bus sequence error
Port transfer error
Data overrun
Data underrun
Controller ownership error
Port number of owning port
3
Controller in dead state (has
not received RESETUNIT EIO from
Tandem system)
4
Invalid EIO instruction sent to
controller
Value of EIO control field
All values
5
Hard (unrecoverable) error
(this code should never appear
in this event message)
6
Change in interface to modem-value in bits 8-15 is sum of
the values representing all of
the following conditions that
apply:
Data terminal ready
Request to send
Clear to send
Carrier detect
Data set ready
1
2
4
8
16
8-14
Meaning
------No error
7
Controller error statistics are
being sent to I/O process
(this code should never appear
in this event message)
8
Incoming frame too large
EVENT MANAGEMENT
4: ZEXP-EVT-DEV-ERR
Bits 0-7
-------9
Bits 8-15
--------1
2
10
Meaning
------No controller internal buffer
available
No buffer for port task (to
transmit data to, or receive
data from, Tandem system)
No buffer for driver task (to
receive data from line)
Tandem system attempted another
write to controller before the
first write was completed
ZEXP-TKN-DEV-STATUS corresponds to the value dev-status in the
text message.
ZEXP-TKN-DEV-STATUS-MASK is a mask that designates which bits
of ZEXP-TKN-DEV-STATUS are allowed to be equal to 1. For the
multifunction controller, this token is meaningless and should be
ignored. This token corresponds to the value param1 in the text
message.
Event-Message Text
The following correspondences exist between values in the text
message and tokens in the event message.
Value
-----------ldev
ccu
dev-status
param1
Token
-----------------------ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-DEV-STATUS
ZEXP-TKN-DEV-STATUS-MASK
The values param2 and param3 in the text message are not
meaningful for this event, and thus there are no tokens in the
event message that correspond to these values.
8-15
EVENT MANAGEMENT
4: ZEXP-EVT-DEV-ERR
Probable Cause
An error occurred on the indicated line, and the I/O retry did
not succeed. The tokens ZEXP-TKN-DEV-STATUS and ZEXP-TKN-DEVSTATUS-MASK supply information about the error. If the error
involves a controller ownership switch, the line handler retries
for up to three ownership switches; if the error persists, it
brings down the line. For any other error (for instance, a modem
error), the line handler waits for the error to clear, and then
retries.
Recommended Action
If the information in ZEXP-TKN-DEV-STATUS and ZEXP-TKN-DEVSTATUS-MASK indicates a problem with Tandem hardware, contact
your Tandem representative.
8-16
EVENT MANAGEMENT
6: ZEXP-EVT-DEV-UP
6:
ZEXP-EVT-DEV-UP
The indicated line has been brought up. This event is not a
critical event, and the event message is reported to the EMS
collector, $0.
This event message is equivalent to console message 06.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEMS-TKN-LDEVNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev [ CU %ccu ] UP
Console-Compatible Format:
LDEV ldev [ CU %ccu ] UP
8-17
EVENT MANAGEMENT
6: ZEXP-EVT-DEV-UP
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
DEV-UP (6).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line that was
brought up.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-FALSE, indicating
that this event is not a critical event. This token is described
in the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
ZEMS-TKN-LDEV is a standard EMS token described in the Event
Management Service (EMS) Manual. It corresponds to the value
ldev in the text message.
Event-Message Text
In the text message, ldev corresponds to the value of ZEMS-TKNLDEV. The value ccu does not correspond to the value of a token
in the event message.
Probable Cause
The operator has successfully returned the indicated line to the
system. The line is now up.
8-18
EVENT MANAGEMENT
6: ZEXP-EVT-DEV-UP
Recommended Action
This event message is an informative message only; no corrective
action is necessary.
8-19
EVENT MANAGEMENT
7: ZEXP-EVT-DEV-DOWN
7:
ZEXP-EVT-DEV-DOWN
The indicated line has been brought down. This event is a
critical event, and the event message is reported to the EMS
collector, $0.
This event message is equivalent to console message 07.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEMS-TKN-LDEVNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev [ %ccu ] DOWN
(BELL)
Console-Compatible Format:
LDEV ldev [ %ccu ] DOWN
8-20
(BELL)
EVENT MANAGEMENT
7: ZEXP-EVT-DEV-DOWN
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
DEV-DOWN (7).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line that was
brought down.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating
that this event is a critical event. This token is described in
the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
ZEMS-TKN-LDEV is a standard EMS token described in the Event
Management Service (EMS) Manual. It corresponds to the value
ldev in the text message.
Event-Message Text
In the text message, ldev corresponds to the value of ZEMS-TKNLDEV. The value ccu does not correspond to the value of a token
in the event message.
8-21
EVENT MANAGEMENT
7: ZEXP-EVT-DEV-DOWN
Probable Cause
This error probably occurred for one of the following reasons:
•
An operator removed the indicated line from the system.
•
The line handler brought the line down because more than three
ownership switches occurred.
•
The line handler brought the line down because a run-time
error occurred. In this case, this event message is preceded
by event message 91, ZEXP-EVT-NET-RUN-TIME-ERR.
•
The EXPAND subsystem encountered a SYSGEN error, causing the
line handler to stop and the line to go down. In this case,
this event message is preceded by event message 90, ZEXP-EVTNET-BAD-SYSGEN.
Recommended Action
If an operator command did not cause this event, perform the
recommended actions for any related event messages 90 and 91 that
precede this event message. If the problem persists, contact
your Tandem representative.
8-22
EVENT MANAGEMENT
33: ZEXP-EVT-NET-LINE-QUAL
33:
ZEXP-EVT-NET-LINE-QUAL
A change in line quality has occurred on the indicated line.
This event is not a critical event, and the event message is
reported to the EMS collector, $0.
This event message is equivalent to console message 33.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEMS-TKN-LDEVNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
ZEXP-TKN-LINE-QUAL
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev NET: LINE QUALITY
nnn
Console-Compatible Format:
LDEV ldev NET: LINE QUALITY
nnn
8-23
EVENT MANAGEMENT
33: ZEXP-EVT-NET-LINE-QUAL
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
NET-LINE-QUAL (33).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line on which
the line quality change occurred.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-FALSE, indicating
that this event is not a critical event. This token is described
in the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
ZEMS-TKN-LDEV is a standard EMS token described in the Event
Management Service (EMS) Manual. It corresponds to the value
ldev in the text message.
ZEXP-TKN-LINE-QUAL is the percentage of frames that were received
without error. The value of this token ranges from 100 (all
frames received without error) to 0. A value less than 95
indicates many retransmissions of frames are occurring on the
line, causing throughput to decrease. This token corresponds to
the value nnn in the text message.
Event-Message Text
In the text message, ldev corresponds to the value of ZEMS-TKNLDEV and nnn corresponds to the value of ZEXP-TKN-LINE-QUAL.
8-24
EVENT MANAGEMENT
33: ZEXP-EVT-NET-LINE-QUAL
Probable Cause
The Network Control Process (NCP) reported a change in the line
quality of the indicated line. This report is made whenever a
change greater than or equal to 5% occurs. After this event
message is issued, the system continues processing.
Recommended Action
If this event occurs repeatedly, or if the value in ZEXP-TKNLINE-QUAL is less than 95, examine the transmission quality of
your communications lines and use whatever corrective measures
are appropriate for those lines.
8-25
EVENT MANAGEMENT
43: ZEXP-EVT-NET-DISCONN
43:
ZEXP-EVT-NET-DISCONN
The connection to the indicated system has been lost. This event
is a critical event, and the event message is reported to the EMS
collector, $0.
This event message is equivalent to console message 43.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEXP-TKN-SYSNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
ZEXP-TKN-SYSNUM
ZEXP-TKN-DISCONN-CAUSE
token-type
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-CHAR8.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-INT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev NET:
(xxx) (BELL)
CONNECTION LOST TO SYS nnn
Console-Compatible Format:
LDEV ldev NET:
(xxx) (BELL)
8-26
CONNECTION LOST TO SYS nnn
EVENT MANAGEMENT
43: ZEXP-EVT-NET-DISCONN
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
NET-DISCONN (43).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEXP-TKN-SYSNAME.
ZEXP-TKN-SYSNAME is the system name of the system that is the
subject of this event message.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating
that this event is a critical event. This token is described in
the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
ZEMS-TKN-LDEV is the logical device number of the path the two
systems were connected over. This token corresponds to the value
ldev in the text message, and it is fully described in the Event
Management Service (EMS) Manual.
ZEXP-TKN-SYSNUM is the system number of the system that is the
subject of this event message. This token corresponds to the
value nnn in the text message.
ZEXP-TKN-DISCONN-CAUSE indicates the cause of the disconnection.
This token can have the following values:
1
The NCP determined that all paths to the indicated system
are unavailable.
4
The line handler reported an end-to-end protocol error.
999
The line handler reported a recovery from a soft failure,
possibly related to path timing.
This token corresponds to the value xxx in the text message.
8-27
EVENT MANAGEMENT
43: ZEXP-EVT-NET-DISCONN
Event-Message Text
The following correspondences exist between values in the text
message and tokens in the event message.
Value
-----ldev
nnn
xxx
Token
---------------------ZEMS-TKN-LDEV
ZEXP-TKN-SYSNUM
ZEXP-TKN-DISCONN-CAUSE
Probable Cause
The connection to the indicated system has been lost due to
the cause given by the token ZEXP-TKN-DISCONN-CAUSE. The NCP
attempts to reestablish the connection over the same path; if
this attempt fails, the line handler seeks an alternate path.
Recommended Action
This event message is an informative message only; no corrective
action is necessary unless other related event messages
appear--for instance, ZEXP-EVT-NET-LINE-NOT-READY (45) messages
for that line. In that case, follow the corrective action for
the related event messages.
8-28
EVENT MANAGEMENT
44: ZEXP-EVT-NET-LINE-READY
44:
ZEXP-EVT-NET-LINE-READY
The indicated line is now ready to accept network requests. This
event is not a critical event, and the event message is reported
to the EMS collector, $0.
This event message is equivalent to console message 44.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEMS-TKN-LDEVNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev NET: LINE READY
Console-Compatible Format:
LDEV ldev NET: LINE READY
8-29
EVENT MANAGEMENT
44: ZEXP-EVT-NET-LINE-READY
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
NET-LINE-READY (44).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line that is
now ready.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-FALSE, indicating
that this event is not a critical event. This token is described
in the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
ZEMS-TKN-LDEV is a standard EMS token described in the Event
Management Service (EMS) Manual. It corresponds to the value
ldev in the text message.
Event-Message Text
In the text message, ldev corresponds to the value of ZEMS-TKNLDEV.
Probable Cause
The indicated line has become ready to accept network requests
following the successful establishment of a line handler-to-line
handler connection to a remote system.
8-30
EVENT MANAGEMENT
44: ZEXP-EVT-NET-LINE-READY
For a direct-connect line handler, this event occurs after both
line handlers (local and remote) have exchanged reset sequences.
For the X.25 interface, this event occurs when the line handler
is informed that a virtual circuit has been established, or when
the line handler learns of the virtual circuit by querying the
X.25 access process.
Recommended Action
This event message is an informative message only; no corrective
action is necessary.
8-31
EVENT MANAGEMENT
45: ZEXP-EVT-NET-LINE-NOT-READY
45:
ZEXP-EVT-NET-LINE-NOT-READY
The indicated line has become not ready. This event is a
critical event, and the event message is reported to the EMS
collector, $0.
This event message is equivalent to console message 45.
Unconditional Tokens
ZSPI-TKN-SSID
token-type
ZEMS-TKN-EVENTNUMBER
token-type
ZEMS-TKN-SUBJECT-MARK
token-type
ZEMS-TKN-LDEVNAME
token-type
ZEMS-TKN-EMPHASIS
token-type
ZEMS-TKN-CONSOLE-PRINT
token-type
ZEMS-TKN-CPU
token-type
ZEMS-TKN-CRTPID
token-type
ZEMS-TKN-GENTIME
token-type
ZEMS-TKN-LOGTIME
token-type
ZEMS-TKN-PIN
token-type
ZEMS-TKN-SYSTEM
token-type
ZEMS-TKN-USERID
token-type
ZEXP-TKN-SYS-MSG-MODE
token-type
ZEMS-TKN-LDEV
token-type
ZEXP-TKN-LINE-NOT-READY-ERR
token-type
ZSPI-TYP-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev NET: LINE NOT READY, ERROR #nnn (BELL)
Console-Compatible Format:
LDEV ldev NET: LINE NOT READY, ERROR #nnn (BELL)
8-32
EVENT MANAGEMENT
45: ZEXP-EVT-NET-LINE-NOT-READY
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
NET-LINE-NOT-READY (45).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line that has
become not ready.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating
that this event is a critical event. This token is described in
the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
ZEMS-TKN-LDEV is a standard EMS token described in the Event
Management Service (EMS) Manual. It corresponds to the value
ldev in the text message.
ZEXP-TKN-LINE-NOT-READY-ERR gives the file-system error number
of the error that caused the line to become not ready. For
information on the particular file-system error that occurred,
refer to the System Procedure Errors and Messages Manual. This
token corresponds to the value nnn in the text message.
Event-Message Text
In the text message, ldev corresponds to the value of ZEMS-TKNLDEV and nnn corresponds to the value of ZEXP-TKN-LINE-NOT-READYERR.
8-33
EVENT MANAGEMENT
45: ZEXP-EVT-NET-LINE-NOT-READY
Probable Cause
The operator brought the indicated line down, or an error
occurred that brought it down. The specific cause of the event
is given by the token ZEXP-TKN-LINE-NOT-READY-ERR.
The line handler is not ready to accept further network requests,
and the NCP must find an alternate communication path.
Recommended Action
Appropriate recovery depends on the file-system error that
occurred and on the line type. For instance, for an error
140 (modem error) on a direct-connect bit-synchronous or bytesynchronous line, you should check the modem, the cables, and
the SYSGEN configuration. For an error 218 (interrupt timeout)
on such a line, check the modem, the cables, and the clock on
the modem. For most errors on a NETNAM line, check the SYSGEN
configuration.
For more information on file-system errors and how to recover
from them, refer to the System Procedure Errors and Messages
Manual.
8-34
EVENT MANAGEMENT
46: ZEXP-EVT-NET-CONN
46:
ZEXP-EVT-NET-CONN
A connection has been made with the NCP on the indicated remote
system. This event is not a critical event, and the event
message is reported to the EMS collector, $0.
This event message is equivalent to console message 46.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEXP-TKN-SYSNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
ZEXP-TKN-SYSNUM
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-CHAR8.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev NET:
CONNECTED TO SYS nnn
Console-Compatible Format:
LDEV ldev NET:
CONNECTED TO SYS nnn
8-35
EVENT MANAGEMENT
46: ZEXP-EVT-NET-CONN
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
NET-CONN (46).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEXP-TKN-SYSNAME.
ZEXP-TKN-SYSNAME is the system name of the system that is the
subject of this event message.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-FALSE, indicating
that this event is not a critical event. This token is described
in the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
ZEMS-TKN-LDEV is the logical device number of the path the two
systems are connected over. This token corresponds to the value
ldev in the text message, and it is fully described in the Event
Management Service (EMS) Manual.
ZEXP-TKN-SYSNUM is the system number of the system that is the
subject of this event message. This token corresponds to the
value nnn in the text message.
Event-Message Text
In the text message, ldev corresponds to the value of ZEMS-TKNLDEV and nnn corresponds to the value of ZEXP-TKN-SYSNUM.
8-36
EVENT MANAGEMENT
46: ZEXP-EVT-NET-CONN
Probable Cause
A successful connect exchange occurred with the NCP at the
indicated remote system. After this event message is issued, the
system continues processing.
Recommended Action
This event message is an informative message only; no corrective
action is necessary.
8-37
EVENT MANAGEMENT
47: ZEXP-EVT-NET-TIMEOUT
47:
ZEXP-EVT-NET-TIMEOUT
A line handler did not receive an end-to-end acknowledgment from
the indicated system within the configured L4TIMEOUT time. This
event is a critical event, and the event message is reported to
the EMS collector, $0.
This event message is equivalent to console message 47.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEXP-TKN-SYSNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
ZEXP-TKN-SYSNUM
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-CHAR8.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev NET: LVL 4 TIMEOUT RETRIES EXCEEDED
TO SYS nnn (BELL)
Console-Compatible Format:
LDEV ldev NET: LVL 4 TIMEOUT RETRIES EXCEEDED
TO SYS nnn (BELL)
8-38
EVENT MANAGEMENT
47: ZEXP-EVT-NET-TIMEOUT
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
NET-TIMEOUT (47).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEXP-TKN-SYSNAME.
ZEXP-TKN-SYSNAME is the system name of the system that is the
subject of this event message.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating
that this event is a critical event. This token is described in
the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
ZEMS-TKN-LDEV is the logical device number of the path over which
the two systems were connected. This token corresponds to the
value ldev in the text message, and it is fully described in the
Event Management Service (EMS) Manual.
ZEXP-TKN-SYSNUM is the system number of the system that is the
subject of this event message. This token corresponds to the
value nnn in the text message.
Event-Message Text
In the text message, ldev corresponds to the value of ZEMS-TKNLDEV and nnn corresponds to the value of ZEXP-TKN-SYSNUM.
8-39
EVENT MANAGEMENT
47: ZEXP-EVT-NET-TIMEOUT
Probable Cause
A line handler did not receive an end-to-end acknowledgment from
the indicated system within the configured L4TIMEOUT time. The
line handler sent a request for the acknowledgment and again did
not receive it within the configured L4TIMEOUT time. The line
handler retried the request the number of times given by the
configured L4RETRIES value before this event message was issued.
The connection to the indicated system is lost. The NCP attempts
to reestablish the connection first over the same line and then
over another line, if one is available.
Recommended Action
Appropriate recovery actions depend on the cause of the failure
to acknowledge. For instance, if congestion in the network
is indicated, check the configuration to ensure that each line
handler has sufficient pool space. Check the statistics for
pool space usage in intermediate systems along the path, and
increase the configured pool space if necessary. Check for other
sources of congestion (such as high-speed incoming lines and lowspeed outgoing lines at a node), and reconfigure lines as needed.
Check LCB usage on intermediate systems, and increase the number
of LCBs or processors as needed. Ensure that configured L4
timeout values are large enough, and change them if necessary.
8-40
EVENT MANAGEMENT
48: ZEXP-EVT-NET-CPU-STATUS
48:
ZEXP-EVT-NET-CPU-STATUS
A change in processor status has occurred at the indicated
system. This event is a critical event, and the event message is
reported to the EMS collector, $0.
This event message is equivalent to console message 48.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEXP-TKN-SYSNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEXP-TKN-SYSNUM
ZEXP-TKN-CPU-STATUS
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-CHAR8.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-INT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
NET: SYS nnn CPU STATUS pppppppppppppppp
(BELL)
Console-Compatible Format:
NET: SYS nnn CPU STATUS pppppppppppppppp
(BELL)
8-41
EVENT MANAGEMENT
48: ZEXP-EVT-NET-CPU-STATUS
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
NET-CPU-STATUS (48).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEXP-TKN-SYSNAME.
ZEXP-TKN-SYSNAME is the system name of the system that is the
subject of this event message.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating
that this event is a critical event. This token is described in
the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
ZEXP-TKN-SYSNUM is the system number of the system that is the
subject of this event message. This token corresponds to the
value nnn in the text message.
ZEXP-TKN-CPU-STATUS is a bit mask that gives the UP-DOWN status
of the individual processors of the indicated system. Bit 0
(the leftmost bit) indicates the status of processor 0, bit 1
indicates the status of processor 1, and so forth. For each
bit, a value of 1 indicates that the corresponding processor
is up, and a value of 0 indicates that the processor is down.
This token corresponds to the value pppppppppppppppp in the text
message.
Event-Message Text
In the text message, nnn corresponds to the value of ZEXP-TKNSYSNUM and pppppppppppppppp corresponds to the value of ZEXP-TKNCPU-STATUS.
8-42
EVENT MANAGEMENT
48: ZEXP-EVT-NET-CPU-STATUS
Probable Cause
A change in processor status has occurred at the indicated
system. This event is reported only by an NCP with Network
Monitor Center status. After this event message is issued, the
system continues processing.
Recommended Action
This event message is an informative message only; no corrective
action is necessary. This information can be useful to an
application communicating with a remote application on the system
where the CPU status change took place.
8-43
EVENT MANAGEMENT
49: ZEXP-EVT-NET-NO-RSP
49:
ZEXP-EVT-NET-NO-RSP
The NCP has not received a status message from the NCP at
the indicated system for three time periods. This event is a
critical event, and the event message is reported to the EMS
collector, $0.
This event message is equivalent to console message 49.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEXP-TKN-SYSNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
ZEXP-TKN-SYSNUM
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-CHAR8.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev NET: SYS nnn NOT RESPONDING
(BELL)
Console-Compatible Format:
LDEV ldev NET: SYS nnn NOT RESPONDING
8-44
(BELL)
EVENT MANAGEMENT
49: ZEXP-EVT-NET-NO-RSP
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
NET-NO-RSP (49).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEXP-TKN-SYSNAME.
ZEXP-TKN-SYSNAME is the system name of the system that is the
subject of this event message.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating
that this event is a critical event. This token is described in
the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
ZEMS-TKN-LDEV is the logical device number of the path the two
systems were connected over. This token corresponds to the value
ldev in the text message, and it is fully described in the Event
Management Service (EMS) Manual.
ZEXP-TKN-SYSNUM is the system number of the system that is the
subject of this event message. This token corresponds to the
value nnn in the text message.
Event-Message Text
In the text message, ldev corresponds to the value of ZEMS-TKNLDEV and nnn corresponds to the value of ZEXP-TKN-SYSNUM.
8-45
EVENT MANAGEMENT
49: ZEXP-EVT-NET-NO-RSP
Probable Cause
The NCP has not received a status message from the NCP at
the indicated system for a specified time period. The NCP
automatically seeks an alternate path. After this event message
is issued, the system continues processing.
Recommended Action
This event message is an informative message only; no corrective
action is necessary unless other related event messages
appear--for instance, ZEXP-EVT-NET-LINE-NOT-READY (45) messages
for that line. In that case, follow the corrective action for
the related event messages.
8-46
EVENT MANAGEMENT
90: ZEXP-EVT-NET-BAD-SYSGEN
90:
ZEXP-EVT-NET-BAD-SYSGEN
The EXPAND subsystem detected a missing, incorrect, or inconsistent SYSGEN parameter. This event is a critical event, and the
event message is reported to the EMS collector, $0.
This event message is equivalent to console message 90.
Unconditional Tokens
ZSPI-TKN-SSID
token-type
ZEMS-TKN-EVENTNUMBER
token-type
ZEMS-TKN-SUBJECT-MARK
token-type
ZEMS-TKN-LDEVNAME
token-type
ZEMS-TKN-EMPHASIS
token-type
ZEMS-TKN-CONSOLE-PRINT
token-type
ZEMS-TKN-CPU
token-type
ZEMS-TKN-CRTPID
token-type
ZEMS-TKN-GENTIME
token-type
ZEMS-TKN-LOGTIME
token-type
ZEMS-TKN-PIN
token-type
ZEMS-TKN-SYSTEM
token-type
ZEMS-TKN-USERID
token-type
ZEXP-TKN-SYS-MSG-MODE
token-type
ZEMS-TKN-LDEV
token-type
ZEXP-TKN-BAD-SYSGEN-CAUSE
token-type
ZSPI-TYP-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
I/O PROCESS ABEND, CODE:
nnnnn
Console-Compatible Format:
I/O PROCESS ABEND, CODE:
nnnnn
8-47
EVENT MANAGEMENT
90: ZEXP-EVT-NET-BAD-SYSGEN
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
NET-BAD-SYSGEN (90).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line or path
whose SYSGEN configuration caused the problem.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating
that this event is a critical event. This token is described in
the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
ZEMS-TKN-LDEV is a standard EMS token described in the Event
Management Service (EMS) Manual.
ZEXP-TKN-BAD-SYSGEN-CAUSE indicates the SYSGEN problem that was
detected. This token can have the following values:
1
A single-line line handler (subtype 0 or 5) was
generated on the same path as another line, probably
with a MULTI parameter.
2
More than eight logical devices for lines were specified for a logical path.
3
An invalid subtype was specified for a line.
4
Lines on CSS6100-type controllers and lines on
6200-type controllers were mixed on the same path.
5
The NEXTSYS modifier was missing or invalid (possibly
greater than or equal to the MAXIMUM_SYSTEMS
parameter). This error can occur when the MULTI
8-48
EVENT MANAGEMENT
90: ZEXP-EVT-NET-BAD-SYSGEN
parameter is omitted from a line that is meant to be
part of a logical path.
6
A logical path had no physical lines. This error can
occur when the MULTI parameter is omitted from all the
lines that were meant to be part of the logical path,
or when the MULTI parameter refers to another LINE
logical device.
7
All the lines of a multiline path were not of the same
form; that is, all the lines in a path were not from
one of the following categories:
Direct (macros NETDIRECT, PATHNETDIRECT)
Satellite (macro NETSATELLITE)
8
All the lines of a multiline path were not on the same
CSS6100 Communications Interface Unit (CIU) or the same
CSS6105 controller.
9
The computed line-buffer size was greater than 64K
words, or, for FOX and X.25 lines, the size was too
large to fit in the LOCALPOOL.
10
The given line-buffer size was too small and there was
not enough space for any read buffers.
11-14
Space was not allocated for a control block from POOL
in the USER DATA segment.
15-16
POOL was not defined in the USER DATA segment.
17-19
I/O segment space was not allocated, used, or locked.
20-24
POOL was not defined in an extended data segment.
25-26
A list of subchannel addresses is invalid.
99
The CPU is not licensed for the EXPAND subsystem.
ZEXP-TKN-BAD-SYSGEN-CAUSE corresponds to the value nnnnn in the
text message.
Event-Message Text
In the text message, nnnnn corresponds to the value of ZEXP-TKNBAD-SYSGEN-CAUSE.
8-49
EVENT MANAGEMENT
90: ZEXP-EVT-NET-BAD-SYSGEN
Probable Cause
The EXPAND subsystem detected a missing, incorrect, or inconsistent SYSGEN parameter, as described by the value of the token
ZEXP-TKN-BAD-SYSGEN-CAUSE. If the error pertains to the configuration of a line handler, the line handler stops and cannot be
used. Otherwise, the indicated line or path cannot be used.
Recommended Action
Specific recovery information for some of the possible values
of ZEXP-TKN-BAD-SYSGEN-CAUSE is given below. Most cases call
for correcting the missing, incorrect, or inconsistent parameter
associated with the indicated line or path in the SYSGEN
configuration file. If you change the configuration file, you
must then run INSTALL again.
1
Remove the MULTI parameter or change the subtype to 2
or 6.
2
Specify eight or fewer lines for the indicated path.
3
Change the line subtype to 0, 1, 2, 3, 5, or 6.
4
Check the MULTI parameters and the device subtypes for
the lines. Correct any instance where 6100 CSS lines
and lines other than 6100 CSS are mixed on the same
path.
5
For single-line devices (subtypes 0 and 5), supply the
NEXTSYS parameter to the line by using SCF, CMI, or
CUP. Then bring up the line using SCF, CMI, or PUP.
You do not have to run INSTALL again; however, you
should correct the SYSGEN configuration file before the
next time you run INSTALL.
6
Correct the configuration file by including the MULTI
parameter for all lines that are meant to be part of
the logical path.
7
Make sure that FOX and X.25 lines are not combined in a
multiline path.
8
If the 6100 CSS lines have two CIUs, make sure that
all the lines use the same CIU as the primary CIU.
Otherwise, make sure that the lines use the same
CSS6105 controller.
8-50
EVENT MANAGEMENT
90: ZEXP-EVT-NET-BAD-SYSGEN
9
The frame size must be the same for all line handlers
in the network. Reduce the L2WINDOW size, the number
of READBUFFERS, and/or the FRAMESIZE. Change the
FRAMESIZE for all line handlers simultaneously.
10
Increase the LINEBUFFERSIZE, decrease the L2WINDOW
size, or specify the number of READBUFFERS.
11-14
If the processor does not have sufficient physical
memory for the line handler to run, contact your Tandem
representative.
15-16
If the processor does not have sufficient physical
memory for the line handler to run, contact your Tandem
representative.
17-19
Reduce the amount of I/O space consumed by the EXPAND
line handlers by doing one or more of the following:
set the TXCOPY option on any line handler; reduce
the window size and the number of receive buffers;
and/or reduce the FRAMESIZE (the latter must be done
simultaneously for all line handlers on all nodes in
the network).
20-24
If the processor does not have sufficient physical
memory for the line handler to run, contact your Tandem
representative.
25-26
Check and correct the unit addresses supplied to SYSGEN
and COUP.
99
Contact your Tandem representative.
8-51
EVENT MANAGEMENT
91: ZEXP-EVT-NET-RUN-TIME-ERR
91:
ZEXP-EVT-NET-RUN-TIME-ERR
An EXPAND line handler or the NCP detected an internally
inconsistent condition. This event is a critical event, and the
event message is reported to the EMS collector, $0.
This event message is equivalent to console message 91.
Unconditional Tokens
ZSPI-TKN-SSID
token-type
ZEMS-TKN-EVENTNUMBER
token-type
ZEMS-TKN-SUBJECT-MARK
token-type
ZEMS-TKN-LDEVNAME
token-type
ZEMS-TKN-EMPHASIS
token-type
ZEMS-TKN-CONSOLE-PRINT
token-type
ZEMS-TKN-CPU
token-type
ZEMS-TKN-CRTPID
token-type
ZEMS-TKN-GENTIME
token-type
ZEMS-TKN-LOGTIME
token-type
ZEMS-TKN-PIN
token-type
ZEMS-TKN-SYSTEM
token-type
ZEMS-TKN-USERID
token-type
ZEXP-TKN-SYS-MSG-MODE
token-type
ZEMS-TKN-LDEV
token-type
ZEXP-TKN-RUN-TIME-ERR-CAUSE
token-type
ZSPI-TYP-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
EXPAND RUNTIME ERROR, CAUSE nn
Console-Compatible Format:
EXPAND RUNTIME ERROR, CAUSE nn
8-52
EVENT MANAGEMENT
91: ZEXP-EVT-NET-RUN-TIME-ERR
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
NET-RUN-TIME-ERR (91).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line or path
over which the problem occurred.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating
that this event is a critical event. This token is described in
the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
ZEMS-TKN-LDEV is a standard EMS token described in the Event
Management Service (EMS) Manual.
ZEXP-TKN-RUN-TIME-ERR-CAUSE indicates the internally inconsistent
condition that was detected. This token can have the following
values:
0 through 4
IOABORT was called from level 2 with a parameter
whose value is the same as the value of this
token. These values of ZEXP-TKN-RUN-TIME-ERRCAUSE occur only if level-2 tracing was enabled
for the line.
5
Line handler CPU ownership is unstable; the line
will go down by itself.
6 and 8
The line handler received a packet to forward
from another line handler, and this packet was
invalid because it was too small or too large.
The invalid packet is discarded.
8-53
EVENT MANAGEMENT
91: ZEXP-EVT-NET-RUN-TIME-ERR
7
Line handler level 3 received a packet from level
2, and this packet was invalid because it was too
small. The invalid packet is discarded.
10
The line handler was unable to BIND to (OPEN) the
associated IPB monitor process or the X25AM line
handler, or it was unable to successfully send a
request to its associated process. The line will
go down by itself.
ZEXP-TKN-RUN-TIME-ERR-CAUSE corresponds to the value nn in the
text message.
Event-Message Text
In the text message, nn corresponds to the value of ZEXP-TKN-RUNTIME-ERR-CAUSE.
Probable Cause
A line handler or the NCP detected an internally inconsistent
condition, which is described by the token ZEXP-TKN-RUN-TIME-ERRCAUSE. After this event message is issued, the NCP continues
processing.
Recommended Action
If ZEXP-TKN-RUN-TIME-ERR-CAUSE has a value in the range 0
through 5, this event message is an informative message only;
no corrective action is necessary unless other related event
messages appear--for instance, event messages reporting unrecoverable errors on the controller hardware associated with that
line handler.
If ZEXP-TKN-RUN-TIME-ERR-CAUSE has a value in the range 6 through
10, examine the SYSGEN configurations for both the EXPAND line
handler and the associated X25AM process or IPB monitor process
to ensure that the device names and subdevice names agree.
8-54
EVENT MANAGEMENT
117: ZEXP-EVT-NET-REQ-ABORT
117:
ZEXP-EVT-NET-REQ-ABORT
Network traffic has been aborted. This event is not a critical
event, and the event message is reported to the EMS collector,
$0.
This event message is equivalent to console message 117.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEXP-TKN-SYSNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
ZEXP-TKN-SYSNUM
ZEXP-TKN-REQ-ABORT-CAUSE
token-type
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-CHAR8.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-INT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
NETWORK REQUESTS ABORTED, CAUSE nn
Console-Compatible Format:
NETWORK REQUESTS ABORTED, CAUSE nn
8-55
EVENT MANAGEMENT
117: ZEXP-EVT-NET-REQ-ABORT
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
NET-REQ-ABORT (117).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEXP-TKN-SYSNAME.
ZEXP-TKN-SYSNAME is the system name of the system that is the
subject of this event message.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-FALSE, indicating
that this event is not a critical event. This token is described
in the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
ZEMS-TKN-LDEV is the logical device number of the path the
request was sent over.
ZEXP-TKN-SYSNUM is the system number of the system that is the
subject of this event message.
ZEXP-TKN-REQ-ABORT-CAUSE indicates the cause of the abort.
token can have the following values:
This
1
A level-4 protocol error occurred.
2
The NCP aborted the connection.
3
The NCP established a new connection over the same or a
different line handler.
4
The line handler switched ownership.
5
I/O power came on again after being off.
6
CPU power came on again after being off.
8-56
EVENT MANAGEMENT
117: ZEXP-EVT-NET-REQ-ABORT
ZEXP-TKN-REQ-ABORT-CAUSE corresponds to the value nn in the text
message.
Event-Message Text
In the text message, nn corresponds to the value of ZEXP-TKN-REQABORT-CAUSE.
Probable Cause
An event occurred that caused network traffic to be aborted. The
specific cause of the abort is given by the token ZEXP-TKN-REQABORT-CAUSE. An event message is generated for each system where
traffic was aborted.
Recommended Action
Recovery action depends on the cause of the abort given in the
token ZEXP-TKN-REQ-ABORT-CAUSE. If value 1, 2, 3, or 4 of ZEXPTKN-REQ-ABORT-CAUSE occurs frequently, you may want to trace the
problem. Run a trace on the NCP, and also a trace on the
line handler if you can identify which line handler is involved.
In the case of value 4 (ownership switch), trace the backup
processes as well.
8-57
EVENT MANAGEMENT
141: ZEXP-EVT-CLIP-DWLOADED
141:
ZEXP-EVT-CLIP-DWLOADED
The Communications Line Interface Processor (CLIP) associated
with an EXPAND line was successfully downloaded. This event is
not a critical event, and the event message is reported to the
EMS collector, $0.
This event message is equivalent to console message 141.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEMS-TKN-LDEVNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-CIU-PATH
token-type
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-ENUM.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev [ CU %ccu ] CLIP DOWNLOADED
Console-Compatible Format:
LDEV ldev [ CU %ccu ] CLIP DOWNLOADED
8-58
EVENT MANAGEMENT
141: ZEXP-EVT-CLIP-DWLOADED
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
CLIP-DWLOADED (141).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line with
which the CLIP is associated.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-FALSE, indicating
that this event is not a critical event. This token is described
in the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
(ZEMS-TKN-) LDEV and CU are standard EMS tokens described in the
Event Management Service (EMS) Manual. These tokens correspond
to the values ldev and ccu, respectively, in the text message.
ZEXP-TKN-CIU-PATH is the CIU path, as described in Section 6,
"Common Definitions."
Event-Message Text
In the text message, ldev corresponds to the value of ZEMS-TKNLDEV and ccu corresponds to the value of ZEMS-TKN-CU.
8-59
EVENT MANAGEMENT
141: ZEXP-EVT-CLIP-DWLOADED
Probable Cause
The CLIP was successfully downloaded. If this event occurs
repeatedly, the cause may be a configuration, hardware, or
software problem.
Recommended Action
If this event occurs once, no corrective action is necessary.
However, if it occurs repeatedly, check first for related
hardware problems with the CLIP; also check for configuration
problems. If neither kind of problem is apparent, turn automatic
downloading off (set ZAUTOLOAD field in ZEXP-MAP-ALTER-LINE to
ZSPI-VAL-FALSE) and take a CLIP dump.
8-60
EVENT MANAGEMENT
146: ZEXP-EVT-CSS-UNIT-ERROR
146:
ZEXP-EVT-CSS-UNIT-ERROR
The 6100 family controller hardware failed while attempting to
download the Communications Line Interface Processor (CLIP) or
the Communications Interface Unit (CIU) associated with an EXPAND
line. This event is a critical event, and the event message is
reported to the EMS collector, $0.
This event message is equivalent to console message 146. It
replaces event message 74, ZEXP-EVT-INTL-ERR, which the EXPAND
subsystem formerly generated to report the same situation.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEMS-TKN-LDEVNAME
ZEMS-TKN-LDEV
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEMS-TKN-CU
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-UINT.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-UINT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev [ CU %ccu ] X25: CSS DOWNLOAD UNIT ERROR,
CIU path #param3 [ %param4 ]
>
8-61
EVENT MANAGEMENT
146: ZEXP-EVT-CSS-UNIT-ERROR
Console-Compatible Format:
LDEV ldev [ CU %ccu ] X25: CSS DOWNLOAD UNIT ERROR,
CIU path #param3 [ %param4 ]
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number, as described in the
Event Management Service (EMS) Manual. Its value is ZEXP-EVTCSS-UNIT-ERROR (146).
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line with
which the affected CLIP or CIU is associated.
ZEMS-TKN-LDEV is the logical device number of the EXPAND line
that is the subject of this event message. It corresponds to the
value ldev in the text message. This token is described in the
Event Management Service (EMS) Manual.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating
that this event is a critical event. This token is described in
the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEMS-TKN-CU is a standard EMS token that contains the controller
and unit number. It corresponds to the value ccu in the text
message.
8-62
EVENT MANAGEMENT
146: ZEXP-EVT-CSS-UNIT-ERROR
Event-Message Text
In the text message, ldev corresponds to the value of ZEMS-TKNLDEV and ccu corresponds to the value of ZEMS-TKN-CU. The values
path, param3, and param4 do not correspond to the values of
tokens in the event message.
Probable Cause
The 6100 family controller hardware failed while attempting to
download the CLIP or the CIU. The CLIP or CIU is not downloaded
and remains in the starting and boot states.
This event message is usually accompanied by another event
message or by a file-system error message.
The value param3 in the text message contains the Communications
Subsystem Manager (CSM) error code, which can have the following
values:
1004
CSM attempted an operation in a processor that is down.
1005
The CIU was in the DIAGNOSE state when it received the
request; it could not perform the operation.
1008
There was an invalid header in the software image read
from the disk during an attempted download operation.
1009
CSM detected a disk error when trying to read the
software image during an attempted download.
1014
The user tried to SUSPEND an already suspended object.
1016
The named object has either stopped or was never
started, and the requested operation requires that the
object be started.
1017
The named object has been started, and the requested
operation requires that the object be stopped.
1018
The named object has been activated, and the requested
operation requires that the object be suspended.
1021
The user tried to initiate a trace on a data link with a
trace already in progress.
1022
The Communications Management Interface (CMI) request
contained an invalid message TYPE.
8-63
EVENT MANAGEMENT
146: ZEXP-EVT-CSS-UNIT-ERROR
1023
CSM received an attribute value that was invalid for one
or more of the following reasons:
1.
The value exceeded the allowed range.
2.
An integer or string value was expected but not
received.
3.
The values are out of sequence in a multivalue
attribute.
1025
The CIU needed to be in the DIAGNOSE state to perform
the requested operation.
1100
An I/O error occurred while the CSM was attempting the
requested operation.
1101
A timeout error occurred.
1102
There is not enough buffer space for the requested
operation.
1103
The requested operation was canceled.
1104
CSM attempted an I/O operation and detected a path
failure.
1105
An internal error occurred while the CSM was attempting
the requested operation.
1106
One of the following errors has occurred:
1.
A CLIP is busy conducting a periodic test or a
previously requested operation.
2.
No buffer or local pool buffer space is available to
perform the requested operation.
3.
The operation aborted because it was requested by
someone other than the owner of the process.
1107
This path is down.
1108
Both paths are down.
1148
The download file attribute is missing.
1149
The download file module is not compatible with CLIP or
LIM.
The value param4 in the text message, when present, indicates the
subchannel address of the CLIP to be downloaded and occasionally
contains a meaningless value.
8-64
EVENT MANAGEMENT
146: ZEXP-EVT-CSS-UNIT-ERROR
Recommended Action
Analyze the failure by looking at the CSM error code given by
param3 in the text message and at the accompanying event or
error message. Then issue a STOP command against the line before
trying to start it again.
8-65
EVENT MANAGEMENT
147: ZEXP-EVT-CSS-STATUS-PROBE-ERR
147:
ZEXP-EVT-CSS-STATUS-PROBE-ERR
The Communications Subsystem Manager (CSM) or the I/O process
received a status-probe response from the Communications Line
Interface Process (CLIP) associated with an EXPAND line. The
probe indicates that this CLIP is in the boot state instead of
the run state. This event is a critical event, and the event
message is reported to the EMS collector, $0.
This event message is equivalent to console message 147.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEMS-TKN-LDEVNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-CIU-PATH
ZEXP-TKN-CLIP-STATUS
token-type
token-type
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-ENUM.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev [ CU %ccu ] CSS STATUS PROBE ERROR,
CIU path %param3 %param4
>
8-66
EVENT MANAGEMENT
147: ZEXP-EVT-CSS-STATUS-PROBE-ERR
Console-Compatible Format:
LDEV ldev [ CU %ccu ] CSS STATUS PROBE ERROR,
CIU path %param3 %param4
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
CSS-STATUS-PROBE-ERR (147).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line with
which the CLIP is associated.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating
that this event is a critical event. This token is described in
the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
(ZEMS-TKN-) LDEV and CU are standard EMS tokens described in the
Event Management Service (EMS) Manual. These tokens correspond
to the values ldev and ccu, respectively, in the text message.
ZEXP-TKN-CIU-PATH is the CIU path, as described in Section 6,
"Common Definitions." This token corresponds to the value path
in the text message.
8-67
EVENT MANAGEMENT
147: ZEXP-EVT-CSS-STATUS-PROBE-ERR
ZEXP-TKN-CLIP-STATUS is the CLIP status byte. If the value of
this token is %377 or less, the rightmost byte of the value is
interpreted as follows:
Bit:
0
1
Not
Owner
In
Boot
2
3
4
5
6
7
Error
If the Not Owner bit is equal to 1, the status was received from
the backup port, which does not respond to a large number of
commands.
If the In Boot bit is equal to 1, the CLIP is operating from the
bootstrap, where the command set is limited.
The Error field typically reports fatal errors; that is, errors
that force the CLIP to reenter the bootstrap from running code.
The Error field can have the following values:
0
No error
1
CLIP PON
2
Deadman timer expired (nonmaskable interrupt)
3
RAM parity error
4
Reset command frame received
5
LIM power fault
6
Instruction failure (SWI2, SWI3, bad jump to
trap code)
7
Deadman timer expired (CLIP RESET)
8 through 15
Reserved
16
Buffer pool boundary tag destroyed (kernel
detected)
17
CLB task transmit state machine failure
18
CLB task receive state machine failure
19 through 31
Reserved for kernel or CLB errors
32 through 63
Reserved for application-detected failures
If the value of this token is -1, there was no response to the
status probe and the probe timed out.
8-68
EVENT MANAGEMENT
147: ZEXP-EVT-CSS-STATUS-PROBE-ERR
ZEXP-TKN-CLIP-STATUS corresponds to the value param3 in the text
message.
Event-Message Text
The following correspondences exist between values in the text
message and tokens in the event message.
Value
-------ldev
ccu
path
param3
Token
-------------------ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-CIU-PATH
ZEXP-TKN-CLIP-STATUS
The value param4 in the text message is not meaningful for this
event, and thus there is no token in the event message that
corresponds to this value.
Probable Cause
The CSM received a status probe response from the CLIP indicating
that the CLIP is in the boot state instead of the run state,
either because it was powered off and then on again or because of
some internal software or hardware problem. The Communications
Access Process (CAP) attempts to download the CLIP again. If the
CAP cannot do so on the primary path, it attempts a download on
another path.
Recommended Action
Decode the CLIP status byte in ZEXP-TKN-CLIP-STATUS to determine
which error occurred. If the CLIP does not restart
automatically, try to restart it manually by using the LOAD LINE
command in SCF or the CONTROL LINE, LOAD command in CMI. If
the problem persists and if the CLIP status indicates a software
problem, take a CLIP dump. Note the CLIP status value and
contact your Tandem representative.
8-69
EVENT MANAGEMENT
152: ZEXP-EVT-CSS-CLB-CMD-REJ
152:
ZEXP-EVT-CSS-CLB-CMD-REJ
A command to the CIU-to-LIU Bus (CLB) of a 6100 Communications
Subsystem (CSS) associated with an EXPAND line was rejected,
indicating that the Break Out Board (BOB) was not properly
synchronized with the host system. This event is not a critical
event, and the event message is reported to the EMS collector,
$0.
This event message is equivalent to console message 152.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEMS-TKN-LDEVNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-CIU-PATH
ZEXP-TKN-FRAME-A-C
ZEXP-TKN-SEQNUM-CAUSE
token-type
token-type
token-type
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-ENUM.
ZSPI-TYP-INT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev [ CU %ccu ] CSS CLB COMMAND REJECT,
CIU path %param3 %param4 %param5 (BELL)
8-70
EVENT MANAGEMENT
152: ZEXP-EVT-CSS-CLB-CMD-REJ
Console-Compatible Format:
LDEV ldev [ CU %ccu ] CSS CLB COMMAND REJECT,
CIU path %param3 %param4 %param5 (BELL)
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
CSS-CLB-CMD-REJ (152).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the EXPAND line
on whose attempted use the error occurred.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-FALSE, indicating
that this event is not a critical event. This token is described
in the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
(ZEMS-TKN-) LDEV and CU are standard EMS tokens described in the
Event Management Service (EMS) Manual. These tokens correspond
to the values ldev and ccu, respectively, in the text message.
ZEXP-TKN-CIU-PATH is the CIU path, as described in Section 6,
"Common Definitions." This token corresponds to the value path
in the text message.
ZEXP-TKN-FRAME-A-C contains the CIU-to-LIU Bus (CLB) frames A
and C. This token corresponds to the value param3 in the text
message.
8-71
EVENT MANAGEMENT
152: ZEXP-EVT-CSS-CLB-CMD-REJ
ZEXP-TKN-SEQNUM-CAUSE contains the sequence number and the cause
of the error. The sequence number is stored in the most
significant eight bits of the token value. The cause of the
command reject is stored in the least significant eight bits of
the token value, and is indicated by one of the following values:
0
The message checksum was invalid.
1
The command sequence number was invalid.
2
The command code was invalid.
3
A command parameter was invalid.
ZEXP-TKN-SEQNUM-CAUSE corresponds to the value param4 in the text
message.
Event-Message Text
The following correspondences exist between values in the text
message and tokens in the event message.
Value
-------ldev
ccu
path
param3
param4
Token
--------------------ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-CIU-PATH
ZEXP-TKN-FRAME-A-C
ZEXP-TKN-SEQNUM-CAUSE
The value param5 does not correspond to the value of a token in
the event message.
Probable Cause
The Break Out Board (BOB) and the host were not properly
synchronized. It is normal for this event to occur when the BOB
is powered on or powered off, or when processors are switched.
Recommended Action
In most cases, the BOB and the host recover (become properly
synchronized again) without any user action. If the error
persists, contact your Tandem representative.
8-72
EVENT MANAGEMENT
156: ZEXP-EVT-CSS-NO-RSP
156:
ZEXP-EVT-CSS-NO-RSP
The Communications Line Interface Processor (CLIP) associated
with an EXPAND line failed to respond to a periodic probe by
a line-handler process, and a NO RESPONSE message was received.
This event is not a critical event, and the event message is
reported to the EMS collector, $0.
This event message is equivalent to console message 156.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEMS-TKN-LDEVNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-CIU-PATH
ZEXP-TKN-CLIP-SEND-STATE
ZEXP-TKN-CLIP-RECV-STATE
token-type
token-type
token-type
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-ENUM.
ZSPI-TYP-INT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev [ CU %ccu ] CSS NO RESPONSE, CIU path
STATE %param3 EVENT %param4
8-73
EVENT MANAGEMENT
156: ZEXP-EVT-CSS-NO-RSP
Console-Compatible Format:
LDEV ldev [ CU %ccu ] CSS NO RESPONSE, CIU path
STATE %param3 EVENT %param4
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
CSS-NO-RSP (156).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line with
which the CLIP is associated.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-FALSE, indicating
that this event is not a critical event. This token is described
in the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
(ZEMS-TKN-) LDEV and CU are standard EMS tokens described in the
Event Management Service (EMS) Manual. These tokens correspond
to the values ldev and ccu, respectively, in the text message.
ZEXP-TKN-CIU-PATH is the CIU path, as described in Section 6,
"Common Definitions." This token corresponds to the value path
in the text message.
8-74
EVENT MANAGEMENT
156: ZEXP-EVT-CSS-NO-RSP
ZEXP-TKN-CLIP-SEND-STATE is the state of the CLIP.
can have the following values:
This token
0
The CLIP is not loaded.
1
The CLIP and CAP are in DIAGNOSE mode.
2
The CLIP is being downloaded, and the CSM has control.
3
The CLIP has been downloaded and is activating the path.
4
The CLIP has been downloaded and is started.
5
The CLIP has been downloaded and is stopped.
This token corresponds to the value param3 in the text message.
ZEXP-TKN-CLIP-RECV-STATE is the resulting state of the line. It
contains the value 66, meaning that the line is down. This token
corresponds to the value param4 in the text message.
Event-Message Text
The following correspondences exist between values in the text
message and tokens in the event message.
Value
-------ldev
ccu
path
param3
param4
Token
-----------------------ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-CIU-PATH
ZEXP-TKN-CLIP-SEND-STATE
ZEXP-TKN-CLIP-RECV-STATE
Probable Cause
The CLIP failed to respond to a periodic probe by a line-handler
process, and a NO RESPONSE message was received. In most cases,
the affected I/O process attempts to recover.
8-75
EVENT MANAGEMENT
156: ZEXP-EVT-CSS-NO-RSP
Recommended Action
If this event occurs once, no corrective action is necessary.
However, if it occurs repeatedly, note the values of ZEXPTKN-CLIP-SEND-STATE and ZEXP-TKN-CLIP-RECV-STATE and contact your
Tandem representative.
8-76
EVENT MANAGEMENT
157: ZEXP-EVT-CSS-FRAME-ERR
157:
ZEXP-EVT-CSS-FRAME-ERR
An invalid frame was received by the 6100 family controller
associated with an EXPAND line. This event is not a critical
event, and the event message is reported to the EMS collector,
$0.
This event message is equivalent to console message 157.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEMS-TKN-LDEVNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-CIU-PATH
ZEXP-TKN-FRAME-ERR
ZEXP-TKN-FRAME-A-C
ZEXP-TKN-FRAME-T-S
token-type
token-type
token-type
token-type
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-ENUM.
ZSPI-TYP-INT.
ZSPI-TYP-INT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev [ CU %ccu ] CSS FRAME ERROR,
CIU path ERROR=#nn A,C=%param1 T,S=%param2
>
8-77
EVENT MANAGEMENT
157: ZEXP-EVT-CSS-FRAME-ERR
Console-Compatible Format:
LDEV ldev [ CU %ccu ] CSS FRAME ERROR,
CIU path ERROR=#nn A,C=%param1 T,S=%param2
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
CSS-FRAME-ERR (157).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line over
which the invalid frame was received.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-FALSE, indicating
that this event is not a critical event. This token is described
in the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
(ZEMS-TKN-) LDEV and CU are standard EMS tokens described in the
Event Management Service (EMS) Manual. These tokens correspond
to the values ldev and ccu, respectively, in the text message.
ZEXP-TKN-CIU-PATH is the CIU path, as described in Section 6,
"Common Definitions." This token corresponds to the value path
in the text message.
8-78
EVENT MANAGEMENT
157: ZEXP-EVT-CSS-FRAME-ERR
ZEXP-TKN-FRAME-ERR contains the reason for the error. This token
corresponds to the value nn in the text message, and it can have
the following values:
0
Unexpected frame
1
Invalid A field (address)
2
Invalid C field (control)
3
Invalid T field (type)
4
Invalid S field (sequence number)
5
Invalid function
6
Not the expected response to the command
7
Type-6 error message received from the CLIP
8
Not the expected multiframe type received
ZEXP-TKN-FRAME-A-C contains the CIU-to-LIU Bus (CLB) frames A
and C. This token corresponds to the value param1 in the text
message.
ZEXP-TKN-FRAME-T-S contains the CLB frames T and S. This token
corresponds to the value param2 in the text message.
Event-Message Text
The following correspondences exist between values in the text
message and tokens in the event message.
Value
-------ldev
ccu
path
nn
param1
param2
Token
-----------------ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-CIU-PATH
ZEXP-TKN-FRAME-ERR
ZEXP-TKN-FRAME-A-C
ZEXP-TKN-FRAME-T-S
8-79
EVENT MANAGEMENT
157: ZEXP-EVT-CSS-FRAME-ERR
Probable Cause
An invalid frame was received. It is normal for this event
to occur during a path switch. Generally, the EXPAND software
recovers from this event automatically; if it cannot recover, it
brings down the line.
Recommended Action
If this event did not occur during a path switch, note the values
of ZEXP-TKN-FRAME-ERR, ZEXP-TKN-FRAME-A-C, and ZEXP-TKN-FRAME-T-S
and contact your Tandem representative.
8-80
EVENT MANAGEMENT
158: ZEXP-EVT-CSS-UNEXP-BRKPT
158:
ZEXP-EVT-CSS-UNEXP-BRKPT
The Communications Line Interface Processor (CLIP) associated
with an EXPAND line encountered an unexpected breakpoint. This
event is a critical event, and the event message is reported to
the EMS collector, $0.
This event message is equivalent to console message 158.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEMS-TKN-LDEVNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-CIU-PATH
ZEXP-TKN-FUNC-MODIF
token-type
token-type
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-ENUM.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev [ CU %ccu ] CSS UNEXPECTED BREAKPOINT,
CIU path FRAME F,M=%param
Console-Compatible Format:
LDEV ldev [ CU %ccu ] CSS UNEXPECTED BREAKPOINT,
CIU path FRAME F,M=%param
8-81
EVENT MANAGEMENT
158: ZEXP-EVT-CSS-UNEXP-BRKPT
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
CSS-UNEXP-BRKPT (158).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line with
which the CLIP is associated.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating
that this event is a critical event. This token is described in
the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
(ZEMS-TKN-) LDEV and CU are standard EMS tokens described in the
Event Management Service (EMS) Manual. These tokens correspond
to the values ldev and ccu, respectively, in the text message.
ZEXP-TKN-CIU-PATH is the CIU path, as described in Section 6,
"Common Definitions." This token corresponds to the value path
in the text message.
ZEXP-TKN-FUNC-MODIF contains the function and modifier parameter.
This token corresponds to the value param in the text message.
8-82
EVENT MANAGEMENT
158: ZEXP-EVT-CSS-UNEXP-BRKPT
Event-Message Text
The following correspondences exist between values in the text
message and tokens in the event message.
Value
------ldev
ccu
path
param
Token
------------------ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-CIU-PATH
ZEXP-TKN-FUNC-MODIF
Probable Cause
The CLIP encountered an unexpected breakpoint and stopped.
Recommended Action
Note the value of ZEXP-TKN-FUNC-MODIF and contact your Tandem
representative.
8-83
EVENT MANAGEMENT
160: ZEXP-EVT-CSS-LIU-CONFIG-ERR
160:
ZEXP-EVT-CSS-LIU-CONFIG-ERR
The Communications Line Interface Processor (CLIP) associated
with an EXPAND line received a line configuration different from
that in the I/O process. This event is a critical event, and the
event message is reported to the EMS collector, $0.
This event message is equivalent to console message 160.
Unconditional Tokens
ZSPI-TKN-SSID
ZEMS-TKN-EVENTNUMBER
ZEMS-TKN-SUBJECT-MARK
ZEMS-TKN-LDEVNAME
ZEMS-TKN-EMPHASIS
ZEMS-TKN-CONSOLE-PRINT
ZEMS-TKN-CPU
ZEMS-TKN-CRTPID
ZEMS-TKN-GENTIME
ZEMS-TKN-LOGTIME
ZEMS-TKN-PIN
ZEMS-TKN-SYSTEM
ZEMS-TKN-USERID
ZEXP-TKN-SYS-MSG-MODE
ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-CIU-PATH
ZEXP-TKN-FUNC-MODIF
token-type
token-type
token-type
token-type
token-type
token-type
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-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-ENUM.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev [ CU %ccu ] CSS LIU CONFIGURATION ERROR,
CIU path ERROR=nn %param1 %param2
Console-Compatible Format:
LDEV ldev [ CU %ccu ] CSS LIU CONFIGURATION ERROR,
CIU path ERROR=nn %param1 %param2
8-84
EVENT MANAGEMENT
160: ZEXP-EVT-CSS-LIU-CONFIG-ERR
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
CSS-LIU-CONFIG-ERR (160).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line with
which the CLIP is associated.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating
that this event is a critical event. This token is described in
the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
(ZEMS-TKN-) LDEV and CU are standard EMS tokens described in the
Event Management Service (EMS) Manual. These tokens correspond
to the values ldev and ccu, respectively, in the text message.
ZEXP-TKN-CIU-PATH is the CIU path, as described in Section 6,
"Common Definitions." This token corresponds to the value path
in the text message.
ZEXP-TKN-FUNC-MODIF contains the function and modifier parameter.
This token corresponds to the value nn in the text message.
8-85
EVENT MANAGEMENT
160: ZEXP-EVT-CSS-LIU-CONFIG-ERR
Event-Message Text
The following correspondences exist between values in the text
message and tokens in the event message.
Value
-----ldev
ccu
path
nn
Token
------------------ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-CIU-PATH
ZEXP-TKN-FUNC-MODIF
The values param1 and param2 do not correspond to the values of
tokens in the event message.
Probable Cause
The CLIP received a line configuration different from that in the
I/O process. The line does not come up.
Recommended Action
Note the value of ZEXP-TKN-FUNC-MODIF and contact your Tandem
representative.
8-86
EVENT MANAGEMENT
164: ZEXP-EVT-CSS-LINE-ERR
164:
ZEXP-EVT-CSS-LINE-ERR
The Communications Line Interface Processor (CLIP) associated
with an EXPAND line responded to the I/O process with an invalid
function modifier. This event is a critical event, and the event
message is reported to the EMS collector, $0.
This event message is equivalent to console message 164.
Unconditional Tokens
ZSPI-TKN-SSID
token-type
ZEMS-TKN-EVENTNUMBER
token-type
ZEMS-TKN-SUBJECT-MARK
token-type
ZEMS-TKN-LDEVNAME
token-type
ZEMS-TKN-EMPHASIS
token-type
ZEMS-TKN-CONSOLE-PRINT
token-type
ZEMS-TKN-CPU
token-type
ZEMS-TKN-CRTPID
token-type
ZEMS-TKN-GENTIME
token-type
ZEMS-TKN-LOGTIME
token-type
ZEMS-TKN-PIN
token-type
ZEMS-TKN-SYSTEM
token-type
ZEMS-TKN-USERID
token-type
ZEXP-TKN-SYS-MSG-MODE
token-type
ZEMS-TKN-LDEV
token-type
ZEMS-TKN-CU
token-type
ZEXP-TKN-CIU-PATH
token-type
ZEXP-TKN-FUNC-MODIF
token-type
ZEXP-TKN-CSS-LINE-ERR-TYPE
token-type
ZEXP-TKN-CSS-LINE-ERR
token-type
ZSPI-TYP-SSID.
ZSPI-TYP-ENUM.
ZSPI-TYP-MARK.
ZSPI-TYP-FNAME32.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-BOOLEAN.
ZSPI-TYP-UINT.
ZSPI-TYP-CRTPID.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-TIMESTAMP.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-BYTE-PAIR.
ZSPI-TYP-INT.
ZSPI-TYP-UINT.
ZSPI-TYP-UINT.
ZSPI-TYP-ENUM.
ZSPI-TYP-INT.
ZSPI-TYP-INT.
ZSPI-TYP-INT.
Tandem Internal Tokens
ZEMS-TKN-OPMSG
token-type ZEMS-TYP-OPMSG.
Event-Message Text
Display Format:
LDEV ldev [ CU %ccu ] CSS LINE ERROR, CIU path
F,M=%param1 ERROR=%param2 %param3
>
8-87
EVENT MANAGEMENT
164: ZEXP-EVT-CSS-LINE-ERR
Console-Compatible Format:
LDEV ldev [ CU %ccu ] CSS LINE ERROR, CIU path
F,M=%param1 ERROR=%param2 %param3
Unconditional Tokens
ZSPI-TKN-SSID is the EXPAND subsystem ID, and its value is ZEXPVAL-SSID. This token is described in the Distributed Systems
Management (DSM) Programming Manual.
ZEMS-TKN-EVENTNUMBER is the event number.
CSS-LINE-ERR (164).
Its value is ZEXP-EVT-
ZEMS-TKN-SUBJECT-MARK is the standard EMS token that always
immediately precedes the subject token--here, ZEMS-TKN-LDEVNAME.
ZEMS-TKN-LDEVNAME is the logical device name of the line with
which the CLIP is associated.
ZEMS-TKN-EMPHASIS contains the value ZSPI-VAL-TRUE, indicating
that this event is a critical event. This token is described in
the Event Management Service (EMS) Manual.
ZEMS-TKN-CONSOLE-PRINT contains the value ZSPI-VAL-TRUE. This
token is described in the Event Management Service (EMS) Manual.
(ZEMS-TKN-) CPU, CRTPID, GENTIME, LOGTIME, PIN, SYSTEM, and
USERID are standard EMS tokens described in the Event Management
Service (EMS) Manual.
ZEXP-TKN-SYS-MSG-MODE indicates what software component this
EXPAND event message relates to, as described in Section 6,
"Common Definitions."
(ZEMS-TKN-) LDEV and CU are standard EMS tokens described in the
Event Management Service (EMS) Manual. These tokens correspond
to the values ldev and ccu, respectively, in the text message.
ZEXP-TKN-CIU-PATH is the CIU path, as described in Section 6,
"Common Definitions." This token corresponds to the value path
in the text message.
ZEXP-TKN-FUNC-MODIF contains the function and modifier parameter.
This token corresponds to the value param1 in the text message.
8-88
EVENT MANAGEMENT
164: ZEXP-EVT-CSS-LINE-ERR
ZEXP-TKN-CSS-LINE-ERR-TYPE is the CSS line-error type. This
token corresponds to the value param2 in the text message.
ZEXP-TKN-CSS-LINE-ERR is the CSS line-error value. This token
corresponds to the value param3 in the text message.
Event-Message Text
The following correspondences exist between values in the text
message and tokens in the event message.
Value
-------ldev
ccu
path
param1
param2
param3
Token
-------------------------ZEMS-TKN-LDEV
ZEMS-TKN-CU
ZEXP-TKN-CIU-PATH
ZEXP-TKN-FUNC-MODIF
ZEXP-TKN-CSS-LINE-ERR-TYPE
ZEXP-TKN-CSS-LINE-ERR
Probable Cause
The CLIP responded to the I/O process with
modifier. The EXPAND software attempts to
reloading the CLIP. If this action is not
cannot be done, the EXPAND software resets
the line down.
an invalid function
clear the error by
successful or if it
the CLIP and brings
Recommended Action
Note the values of ZEXP-TKN-FUNC-MODIF, ZEXP-TKN-CSS-LINE-ERRTYPE, and ZEXP-TKN-CSS-LINE-ERR, and contact your Tandem
representative.
8-89
EVENT MANAGEMENT
Examples of Filters
EXAMPLES OF FILTERS
The following two examples illustrate simple filters that could
be created to select EXPAND event messages.
For both examples, the following assumptions have been made:
1.
All EXPAND definitions used in the filters have been loaded
into TACL before compilation.
2.
Tokens and subsystems that you have created have been defined
and loaded before compilation.
3.
All subsystem IDs that are not initialized in the filter have
been initialized by other means.
For more information on filters, refer to the Event Management
Service (EMS) Manual.
Example 1
The following filter selects all of the EXPAND event messages.
-- Filter that selects only event messages issued by the
-- EXPAND subsystem.
[#SET zexp^val^ssid
[zspi^val^tandem].[zspi^ssn^zexp].[zexp^val^version]]
FILTER expand^messages;
BEGIN
IF zspi^tkn^ssid = SSID(zexp^val^ssid) THEN
PASS
-- Return this event message
ELSE
FAIL;
-- Do not return this event message
END; -- of expand^messages
8-90
EVENT MANAGEMENT
Example 2
Example 2
The following filter selects all critical EXPAND event messages
that have a particular device as their subject.
-- Filter that selects only critical EXPAND event messages
-- that have as their subject token a particular device name
[#SET zexp^val^ssid
[zspi^val^tandem].[zspi^ssn^zexp].[zexp^val^version]]
FILTER critical^expand^msgs(
SSID(my^ssid,my^device^name) REQUIRED);
BEGIN
IF zspi^tkn^ssid = SSID(zexp^val^ssid) THEN
-- This is an EXPAND event message
IF zems^tkn^emphasis = [zspi^val^true] THEN
-- This is a critical event message
IF zems^tkn^ldevname = my^device^name THEN
-- This event message concerns the device
-- with the name my^device^name
PASS
ELSE
-- This event message concerns some other
-- device
FAIL
ELSE
-- This is not a critical event message
FAIL
ELSE
-- This is not an EXPAND event message
FAIL;
END; -- of critical^expand^msgs
For a third example of a simple filter, see the event-message
retrieval example that follows.
8-91
EVENT MANAGEMENT
Example of Event-Message Retrieval
EXAMPLE OF EVENT-MESSAGE RETRIEVAL
The following example is presented as modifications to the
example of retrieving event messages in Appendix C of the
Event Management Service (EMS) Manual. To use this example,
you will need to begin with the example in that manual and
its accompanying text. The text below explains the specific
modifications to be made to the basic example so that it
retrieves and handles a particular event message from the EXPAND
subsystem. Following the text are a filter and an event-handling
module to be substituted for the corresponding modules in the
basic example.
For the substitute event-handling module provided below, only TAL
code is given. You could write a TACL or COBOL85 module to
perform the same functions.
The filter in this EXPAND example selects only those event
messages with event number 33, ZEXP-EVT-NET-LINE-QUAL, and the
EXPAND subsystem ID. This event message indicates that a
positive or negative change of 5% or more has occurred in the
transmission quality of an EXPAND line.
This example begins by prompting the operator for a line-quality
threshold value (rather than for a CPU number). Instead of
displaying the retrieved event message, this example checks
whether the reported line quality is less than the operatorspecified threshold value (a typical value might be 60) and, if
so, brings the line down (stops the line) and generates an event
message of its own indicating that it has done so. In stopping
the line, it uses several modules of the example already given in
Section 7.
This example is intended to be an illustration of the basic
programming features one might use in handling an event message
from the EXPAND subsystem; it does not necessarily represent a
reasonable event-handling strategy for any given network. In
reality, you would probably need to use more complex logic. For
instance, you would likely want to do additional checks first to
determine whether the line should really be brought down. If
the line provides the only available path between two nodes, you
might want to use an alternate strategy. There are many other
possible considerations.
8-92
EVENT MANAGEMENT
Modifications to Example in EMS Manual
Modifications to Example in EMS Manual
To modify the basic example in the Event Management Service (EMS)
Manual, follow the instructions given below.
In the instructions for running the TAL version, insert the
following lines immediately after the line
"LDQ $SYSTEM.ZSPIDEF.ZEMSTACL":
LDQ $SYSTEM.ZSPIDEF.ZCOMTACL
LDQ $SYSTEM.ZSPIDEF.ZEXPTACL
At the end of the DDL source file, add the following lines:
! Filter parameter
TOKEN-CODE myap-tkn-quality-threshold
VALUE IS 2
TOKEN-TYPE IS ZSPI-TYP-INT.
! Event message generated by application
CONSTANT myap-evt-downed-low-line VALUE IS 1.
In place of the filter source file given in the basic example,
substitute the filter given below under "Filter Source File."
In the TAL source file, change the comment about getting the CPU
number from the user to a comment about getting the line-quality
threshold.
Immediately after the lines that turn off LIST, source in
MYAPTAL, and turn on LIST again, insert the following:
?NOLIST, SOURCE $SYSTEM.ZSPIDEF.ZCOMTAL
?LIST
?NOLIST, SOURCE $SYSTEM.ZSPIDEF.ZEXPTAL
?LIST
In the global declarations of type INT, replace cpu^num with
line^quality^threshold.
To the global declarations, add the following:
INT scp^file^num;
STRUCT .exp^buf(zexp^ddl^msg^buffer^def);
Immediately after the declaration of myap^val^ssid, insert the
following declaration for the EXPAND subsystem ID:
STRUCT .zexp^val^ssid(zexp^val^ssid^def);
8-93
EVENT MANAGEMENT
Modifications to Example in EMS Manual
In the SOURCE $SYSTEM.SYSTEM.EXTDECS0 statement following the
declarations, add the following procedures to the list: EMSINIT,
EMSADDTOKENS, WRITEREADX, FNAMECOLLAPSE, FNAMEEXPAND, and NUMOUT.
In place of the get^cpu^num procedure, substitute the following
procedures, in the order listed:
•
The procedures open^scp, handle^spi^error, call^scp,
build^cmd, and abort^line from the example at the end of
Section 7.
•
The get^threshold procedure given below under "Additional TAL
Source Modules."
In the spi^cmd^load^filter procedure, change the SSPUTTKN call
that places the filter-parameter token in the buffer to the
following:
spi^err := SSPUTTKN (spi^buf, myap^tkn^quality^threshold,
line^quality^threshold, !cnt!,
myap^val^ssid);
In place of the displ^event procedure, substitute the
abort^low^qual^line procedure given below under "Additional TAL
Source Modules."
In getevent^loop, replace the call to display the event message
with the following:
! Bring down the line and generate a custom event
! message indicating that the line was brought down
CALL abort^low^qual^line(event^buf);
In the main procedure, after the initialization of zems^val^ssid,
insert the following:
zexp^val^ssid ':=' [ZSPI^VAL^TANDEM,
ZSPI^SSN^ZEXP,
ZEXP^VAL^VERSION];
Delete the call to get^cpu^num and substitute the following:
! Prompt user for the line quality threshold
CALL get^threshold;
IF (error := open^scp) THEN CALL STOP;
8-94
EVENT MANAGEMENT
Filter Source File
Filter Source File
The filter for this example is as follows:
== File MYAPFS
[#SET zexp^val^ssid
[zspi^val^tandem].[zspi^ssn^zexp].[zexp^val^version]]
[#SET myap^val^ssid
[myap^val^owner].[myap^ssn^myap].[myap^val^version]]
-- Return EXPAND events of low line quality.
FILTER low^line^quality ( SSID(myap^val^ssid
, myap^tkn^quality^threshold) );
BEGIN
IF zems^tkn^eventnumber = [zexp^evt^net^line^qual]
AND zspi^tkn^ssid = [zexp^val^ssid] THEN
BEGIN
IF zexp^tkn^line^qual
< myap^tkn^quality^threshold THEN PASS;
END;
END;
Additional TAL Source Modules
This example requires the two additional TAL procedures given
below: get^threshold (to replace get^cpu^num in the EMS manual
example) and abort^low^qual^line (to replace displ^event in the
EMS manual example). The abort^low^qual^line procedure, in
turn, calls upon the following procedures from the example in
Section 7, and therefore must be preceded by them: open^scp,
handle^spi^error, call^scp, build^cmd, and abort^line.
PROC get^threshold;
BEGIN
INT got^it;
! This procedure prompts the operator for a line quality
! threshold, to be passed as a parameter to the filter
got^it := false;
WHILE ( NOT got^it ) DO
BEGIN
s^term^buf ':=' ["Bad Line Quality?: "]
-> @end^of^text;
text^len := @end^of^text '-' @s^term^buf;
8-95
EVENT MANAGEMENT
Additional TAL Source Modules
retry:
! Prompt for and read line quality threshold
CALL WRITEREAD ( term, term^buf, text^len, 14,
input^len);
IF > THEN ! EOF from terminal
CALL STOP;
IF < THEN ! Some unusual condition
BEGIN ! Check whether to retry
IF FILEERROR ( term ) THEN GOTO retry;
CALL DEBUG;
END;
! Terminate input with a null
s^term^buf[input^len] := 0;
! Translate number to internal integer
CALL NUMIN ( S^TERM^BUF, line^quality^threshold
, 10, ERROR);
IF ( ( ERROR = 0 ) AND
( line^quality^threshold >= 0 ) ) THEN
got^it := true;
END;
! WHILE
END;
! This procedure is called when the LOW^LINE^QUALITY filter
! finds a line with line quality lower than the threshold;
! it brings down the line and generates an event message
! indicating that it has done so.
!
PROC abort^low^qual^line ( event^buf );
INT .EXT event^buf;
BEGIN
INT
ldev^num;
! LDEV Number of line
STRUCT .ldev^name ( zspi^ddl^fname32^def );
INT
line^qual;
! Line quality from EXPAND event
STRUCT .line^name;
BEGIN
INT
len;
STRING objname [ 0:zcom^val^objname^len-1 ];
END;
STRING .text^buf
:= @evt^text^buf '<' 1;
STRING .eot;
! End Of Text pointer
INT
collector;
! File number of EMS collector
INT
event^len;
! Length of event message
8-96
EVENT MANAGEMENT
Additional TAL Source Modules
! Get name of line whose quality is so low it should be
! brought down
spi^err := EMSGETTKN ( event^buf, ZEMS^TKN^LDEVNAME
, ldev^name, 1);
IF (spi^err) THEN CALL DEBUG;
! Translate internal name
! to variable-length external string
line^name.len := FNAMECOLLAPSE ( ldev^name.z^localname
, line^name.objname
);
! Bring the line down
CALL abort^line ( line^name );
! Get tokens for the event message
spi^err := EMSGETTKN ( event^buf, zexp^tkn^line^qual
, line^qual, 1 );
IF (spi^err) THEN CALL DEBUG;
spi^err := EMSGETTKN ( event^buf, zems^tkn^ldev
, ldev^num, 1, !cnt!, zems^val^ssid );
IF (spi^err) THEN CALL DEBUG;
! Write event message indicating the line was brought down
spi^err := EMSINIT ( exp^buf, zexp^val^buflen
, myap^val^ssid
, myap^evt^downed^low^line
, ZEMS^TKN^LDEVNAME, ldev^name);
! Build text message
text^buf ':=' "LINE " & line^name.objname for line^name.len
& " ABORTED: LINE QUAL = " -> @eot;
CALL NUMOUT ( eot, line^qual, 10, 2 );
! Add tokens to event message
spi^err := EMSADDTOKENS ( exp^buf, zems^val^ssid
, zems^tkn^text, text^buf
, @eot[2] '-' @text^buf
, zems^tkn^ldev, ldev^num );
IF (spi^err) THEN CALL DEBUG;
spi^err := EMSADDTOKENS ( exp^buf, zexp^val^ssid
, zexp^tkn^line^qual, line^qual );
IF (spi^err) THEN CALL DEBUG;
! Send the event message to the collector
evt^text^buf ':=' "$0" & 0;
CALL FNAMEEXPAND ( evt^text^buf, ldev^name.z^localname
, ldev^name.z^localname );
CALL OPEN ( ldev^name.z^localname, collector );
spi^err := EMSGETTKN ( exp^buf, zspi^tkn^usedlen
, event^len );
IF (spi^err) THEN CALL DEBUG;
8-97
EVENT MANAGEMENT
Additional TAL Source Modules
CALL WRITEREADX ( collector, exp^buf, event^len, 0 );
CALL CLOSE ( collector );
END;
8-98
! abort^low^qual^line
APPENDIX A
ERROR NUMBERS AND ERROR LISTS
This appendix presents all the error numbers provided by the
EXPAND subsystem (that is, the values whose symbolic names begin
with ZEXP-ERR-), and describes the error lists associated with
these error numbers. These error numbers can occur as values of
the return token, ZSPI-TKN-RETCODE, and as part of the value of
the error token, ZSPI-TKN-ERROR.
What error lists are and how they are retrieved from the
buffer are described in the Distributed Systems Management
(DSM) Programming Manual. General information about how the
EXPAND subsystem handles errors is given in Section 5, "SPI
Programming Considerations for the EXPAND Subsystem." Errorhandling information pertaining to specific commands and their
responses is given in Section 7, "Commands and Responses."
In this appendix, all tokens and their values are represented in
DDL. For a quick explanation of DDL as it applies to SPI, refer
to the appendix "Overview of DDL for SPI" in the Distributed
Systems Management (DSM) Programming Manual.
NOTATION USED
For each error-list description on the following pages, there is
a box that lists all the tokens that can appear in the error
list, including the tokens ZSPI-TKN-ERRLIST and ZSPI-TKN-ENDLIST,
which start and end all error lists. With the exception of ZSPITKN-ERRLIST and ZSPI-TKN-ENDLIST, the order of the tokens in the
box is not necessarily the order in which they will actually
occur.
A-1
ERROR NUMBERS AND ERROR LISTS
Error-List Descriptions
The notation used in the box for simple tokens is a shorthand
version of the essential information given in the DDL TOKEN-CODE
statement.
Following the box, each token in the error list except ZSPITKN-ERRLIST and ZSPI-TKN-ENDLIST is described in the same order
in which it appeared in the box. These two tokens serve the
same function in all error lists, so they are not described
here. More information about these tokens can be found in the
Distributed Systems Management (DSM) Programming Manual.
ERROR-LIST DESCRIPTIONS
The descriptions on the following pages are given in ascending
order by error number; that is, in ascending order by the ZEXPERR- values.
Note that the error number ZEXP-ERR-EMPT-RSP does not have an
error list associated with it.
A-2
ERROR NUMBERS AND ERROR LISTS
1: ZEXP-ERR-TOO-MANY-OBJNAMES
1:
ZEXP-ERR-TOO-MANY-OBJNAMES
Too many object names were given in a command to the EXPAND
subsystem.
ZSPI-TKN-ERRLIST
ZSPI-TKN-ERROR
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-ENDLIST
token-type
token-type
token-type
token-type
token-type
ZSPI-TYP-LIST.
ZSPI-TYP-ERROR.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-SSCTL.
Tokens
ZSPI-TKN-ERROR is the standard SPI error token, as described in
the Distributed Systems Management (DSM) Programming Manual. Its
value consists of the EXPAND subsystem ID and the error number
ZEXP-ERR-TOO-MANY-OBJNAMES. This token is always present in the
error list.
ZCOM-TKN-OBJNAME is the object name on which the error occurred
in the command (that is, the thirty-first object name in the
command). This token is always present in the error list, and it
is described in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is the object type provided with the command on
which the error occurred. Its possible values are ZCOM-OBJ-LINE,
ZCOM-OBJ-NULL, ZCOM-OBJ-PATH, and ZCOM-OBJ-PROCESS. This token
is always present in the error list, and it is described in the
Communications Management Programming Manual.
Probable Cause
More than 30 object names appear in the command on which the
error occurred.
A-3
ERROR NUMBERS AND ERROR LISTS
1: ZEXP-ERR-TOO-MANY-OBJNAMES
Recommended Action
Reduce the number of object names in the command to 30 or fewer
names.
A-4
ERROR NUMBERS AND ERROR LISTS
2: ZEXP-ERR-NEG-LH-RSP
2:
ZEXP-ERR-NEG-LH-RSP
The EXPAND line handler returned a negative response because a
file-system error occurred.
ZSPI-TKN-ERRLIST
ZSPI-TKN-ERROR
ZEXP-TKN-LH-ERR-NUM
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-ENDLIST
token-type
token-type
token-type
token-type
token-type
token-type
ZSPI-TYP-LIST.
ZSPI-TYP-ERROR.
ZSPI-TYP-INT.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-SSCTL.
Tokens
ZSPI-TKN-ERROR is the standard SPI error token, as described in
the Distributed Systems Management (DSM) Programming Manual. Its
value consists of the EXPAND subsystem ID and the error number
ZEXP-ERR-NEG-LH-RSP. This token is always present in the error
list.
ZEXP-TKN-LH-ERR-NUM is the file-system error number identifying
the error the line handler encountered. This token has the token
number ZEXP-TNM-LH-ERR-NUM and the token type ZSPI-TYP-INT, and
it is always present in the error list. Commonly returned values
are the following:
12
A request was received to start a line, but that line was
already started.
160
In any case but "line already started," the request
was invalid for the current line state--for instance, a
request was received to stop a line, but that line was
already stopped.
248
The EXPAND line handler had previously performed an
ownership switch.
249
The NCP caused the line handler to terminate its traffic.
For information on these and other file-system errors, refer to
the System Procedure Errors and Messages Manual.
A-5
ERROR NUMBERS AND ERROR LISTS
2: ZEXP-ERR-NEG-LH-RSP
ZCOM-TKN-OBJNAME is the name of the object on which the error
occurred. This token is always present in the error list, and it
is described in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is the object type provided with the command on
which the error occurred. Its possible values are ZCOM-OBJ-LINE,
ZCOM-OBJ-NULL, ZCOM-OBJ-PATH, and ZCOM-OBJ-PROCESS. This token
is always present in the error list, and it is described in the
Communications Management Programming Manual.
Probable Cause
The cause of this error is given by the file-system error number
in ZEXP-TKN-LH-ERR-NUM. For information on file-system errors,
refer to the System Procedure Errors and Messages Manual.
Recommended Action
Recovery from this error depends on which file-system error
occurred. For information on file-system errors and how to
recover from them, refer to the System Procedure Errors and
Messages Manual.
A-6
ERROR NUMBERS AND ERROR LISTS
3: ZEXP-ERR-EMPT-RSP
3:
ZEXP-ERR-EMPT-RSP
This error number indicates an empty response record.
list is associated with this error number.
No error
Probable Cause
This error number is returned if, for example, you have assigned
the value ZSPI-VAL-ERR-AND-WARN to the token ZSPI-TKN-RESPONSETYPE (meaning that you want to see a response only if there is
an error or warning), and no errors or warnings occurred during
processing of the command. ZEXP-ERR-EMPT-RSP indicates that all
processing was completed successfully.
Recommended Action
This error number does not indicate an error; therefore, no
recovery action is necessary.
A-7
ERROR NUMBERS AND ERROR LISTS
4: ZEXP-ERR-TKN-CONFL
4:
ZEXP-ERR-TKN-CONFL
A token in a command conflicts with the values or presence of
other tokens in the command.
ZSPI-TKN-ERRLIST
ZSPI-TKN-ERROR
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-PARM-ERR
ZSPI-TKN-ENDLIST
token-type
token-type
token-type
token-type
token-type
token-type
ZSPI-TYP-LIST.
ZSPI-TYP-ERROR.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-PARM-ERR.
ZSPI-TYP-SSCTL.
Tokens
ZSPI-TKN-ERROR is the standard SPI error token, as described in
the Distributed Systems Management (DSM) Programming Manual. Its
value consists of the EXPAND subsystem ID and the error number
ZEXP-ERR-TKN-CONFL. This token is always present in the error
list.
ZCOM-TKN-OBJNAME is the first object name provided with the
command on which the error occurred. This token is always
present in the error list, and it is described in Section 6,
"Common Definitions."
ZCOM-TKN-OBJTYPE is the object type provided with the command
on which the error occurred. Its possible values are ZCOMOBJ-LINE, ZCOM-OBJ-PATH, and ZCOM-OBJ-PROCESS. This token is
always present in the error list, and it is described in the
Communications Management Programming Manual.
ZSPI-TKN-PARM-ERR is the standard SPI parameter-error token, as
described in the Distributed Systems Management (DSM) Programming
Manual. For this error list, this token identifies which token
in the command, and which field within that token, caused the
error. This token is always present in the error list.
Probable Cause
If this error occurs on the ALTER command, the command contains a
token that applies to a different object type than the one given
A-8
ERROR NUMBERS AND ERROR LISTS
4: ZEXP-ERR-TKN-CONFL
in the command. For example, this error is given if the ALTER
LINE command contains the token ZEXP-MAP-ALTER-PATH.
This error is given for the SWITCH command if both of the tokens
ZCOM-TKN-SWITCH-CPU and ZCOM-TKN-SWITCH-PATH are present in the
command.
Recommended Action
Correct the token that caused the error.
A-9
ERROR NUMBERS AND ERROR LISTS
5: ZEXP-ERR-OBJ-TYPE-NAME-MISMATC
5:
ZEXP-ERR-OBJ-TYPE-NAME-MISMATC
A conflict exists between the object type given in an EXPAND
command and an object name in that command.
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.
Tokens
ZSPI-TKN-ERROR is the standard SPI error token, as described in
the Distributed Systems Management (DSM) Programming Manual. Its
value consists of the EXPAND subsystem ID and the error number
ZEXP-ERR-OBJ-TYPE-NAME-MISMATC. This token is always present in
the error list.
ZCOM-TKN-OBJNAME is the object name on which the error occurred
in the command. This token is always present in the error list,
and it is described in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is the object type provided with the
on which the error occurred. Its possible values are
LINE and ZCOM-OBJ-PATH. This token is always present
error list, and it is described in the Communications
Programming Manual.
command
ZCOM-OBJin the
Management
Probable Cause
This error is given in either of the following situations:
1.
The command specifies an object type of ZCOM-OBJ-LINE, and it
contains an object name that is a path name only (the subtype
of the EXPAND line handler is 1).
2.
The command specifies an object type of ZCOM-OBJ-PATH, and it
contains an object name that is a line name only (the subtype
of the EXPAND line handler is 2 or 6).
A-10
ERROR NUMBERS AND ERROR LISTS
5: ZEXP-ERR-OBJ-TYPE-NAME-MISMATC
Recommended Action
Correct the object name or object type that caused the error.
A-11
ERROR NUMBERS AND ERROR LISTS
6: ZEXP-ERR-TRACE-NOT-STARTED
6:
ZEXP-ERR-TRACE-NOT-STARTED
An error occurred during the processing of a TRACE command
that traces the EXPAND manager process, so the tracing was not
started.
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.
Tokens
ZSPI-TKN-ERROR is the standard SPI error token, as described in
the Distributed Systems Management (DSM) Programming Manual. Its
value consists of the EXPAND subsystem ID and the error number
ZEXP-ERR-TRACE-NOT-STARTED. This token is always present in the
error list.
ZCOM-TKN-OBJNAME is an object-name token that contains the name
of the EXPAND manager process. This token is always present
in the error list, and it is described in Section 6, "Common
Definitions."
ZCOM-TKN-OBJTYPE is the object type ZCOM-OBJ-NULL. This token
is always present in the error list, and it is described in the
Communications Management Programming Manual.
Probable Cause
An incorrect value was given in the extensible structured token
ZCOM-MAP-TRACE-MODIF. The trace is not started.
Recommended Action
Correct the value or values that caused the error.
A-12
ERROR NUMBERS AND ERROR LISTS
9: ZEXP-ERR-NEG-NCP-RSP
9:
ZEXP-ERR-NEG-NCP-RSP
The NCP returned a negative response because a file-system error
occurred.
ZSPI-TKN-ERRLIST
ZSPI-TKN-ERROR
ZEXP-TKN-NCP-ERR-NUM
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-ENDLIST
token-type
token-type
token-type
token-type
token-type
token-type
ZSPI-TYP-LIST.
ZSPI-TYP-ERROR.
ZSPI-TYP-INT.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-SSCTL.
Tokens
ZSPI-TKN-ERROR is the standard SPI error token, as described in
the Distributed Systems Management (DSM) Programming Manual. Its
value consists of the EXPAND subsystem ID and the error number
ZEXP-ERR-NEG-NCP-RSP. This token is always present in the error
list.
ZEXP-TKN-NCP-ERR-NUM is the file-system error number identifying
the error the NCP encountered. This token has the token number
ZEXP-TNM-NCP-ERR-NUM and the token type ZSPI-TYP-INT, and it is
always present in the error list. Commonly returned values are
the following:
2
The specified system name was not valid.
12
A PROBE command was given, but a probe was already in
progress. The NCP allows only one probe at a time.
201
The path from this system to the specified system was
down.
250
All paths to the specified system were down.
For information on these and other file-system errors, refer to
the System Procedure Errors and Messages Manual.
ZCOM-TKN-OBJNAME is the name of the object on which the error
occurred. This token is always present in the error list, and it
is described in Section 6, "Common Definitions."
A-13
ERROR NUMBERS AND ERROR LISTS
9: ZEXP-ERR-NEG-NCP-RSP
ZCOM-TKN-OBJTYPE is the object type provided with the command
on which the error occurred. Its value is always ZCOM-OBJPROCESS. This token is always present in the error list, and it
is described in the Communications Management Programming Manual.
Probable Cause
The cause of this error is given by the file-system error number
in ZEXP-TKN-NCP-ERR-NUM. For information on file-system errors,
refer to the System Procedure Errors and Messages Manual.
Recommended Action
Recovery from this error depends on which file-system error
occurred. For information on file-system errors and how to
recover from them, refer to the System Procedure Errors and
Messages Manual.
A-14
ERROR NUMBERS AND ERROR LISTS
10: ZEXP-ERR-BAD-NETTRACE-RCVD
10:
ZEXP-ERR-BAD-NETTRACE-RCVD
An internal error occurred during execution of the PROBE command.
ZSPI-TKN-ERRLIST
ZSPI-TKN-ERROR
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZEXP-TKN-CALLED-SYS
ZEXP-TKN-SEL-SYS
ZSPI-TKN-ENDLIST
token-type
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-INT.
ZSPI-TYP-INT.
ZSPI-TYP-SSCTL.
Tokens
ZSPI-TKN-ERROR is the standard SPI error token, as described in
the Distributed Systems Management (DSM) Programming Manual. Its
value consists of the EXPAND subsystem ID and the error number
ZEXP-ERR-BAD-NETTRACE-RCVD. This token is always present in the
error list.
ZCOM-TKN-OBJNAME is an object-name token that contains the
process name "$NCP." This token is always present in the error
list, and it is described in Section 6, "Common Definitions."
ZCOM-TKN-OBJTYPE is the object type ZCOM-OBJ-PROCESS. This token
is always present in the error list, and it is described in the
Communications Management Programming Manual.
ZEXP-TKN-CALLED-SYS is the called system as specified in the
PROBE command. This token has the token number ZEXP-TNM-CALLEDSYS and the token type ZSPI-TYP-INT, and is always present in the
error list.
ZEXP-TKN-SEL-SYS is the selected system as specified in the PROBE
command. This token has the token number ZEXP-TNM-SEL-SYS and
the token type ZSPI-TYP-INT, and is always present in the error
list.
A-15
ERROR NUMBERS AND ERROR LISTS
10: ZEXP-ERR-BAD-NETTRACE-RCVD
Probable Cause
An internal error occurred in Tandem software.
completed.
The probe is not
Recommended Action
Note the values of ZEXP-TKN-CALLED-SYS and ZEXP-TKN-SEL-SYS and
contact your Tandem representative.
A-16
ERROR NUMBERS AND ERROR LISTS
11: ZEXP-ERR-INV-VALUE
11:
ZEXP-ERR-INV-VALUE
An invalid value was specified in a token for a command. Either
the value given was not valid for the corresponding attribute, or
a non-null value was given for an attribute that did not apply to
the given object name.
ZSPI-TKN-ERRLIST
ZSPI-TKN-ERROR
ZCOM-TKN-OBJNAME
ZCOM-TKN-OBJTYPE
ZSPI-TKN-PARM-ERR
ZSPI-TKN-ENDLIST
token-type
token-type
token-type
token-type
token-type
token-type
ZSPI-TYP-LIST.
ZSPI-TYP-ERROR.
ZSPI-TYP-STRING.
ZSPI-TYP-ENUM.
ZSPI-TYP-PARM-ERR.
ZSPI-TYP-SSCTL.
Tokens
ZSPI-TKN-ERROR is the standard SPI error token, as described in
the Distributed Systems Management (DSM) Programming Manual. Its
value consists of the EXPAND subsystem ID and the error number
ZEXP-ERR-INV-VALUE. This token is always present in the error
list.
ZCOM-TKN-OBJNAME is the first object name provided with the
command on which the error occurred. This token is always
present in the error list, and it is described in Section 6,
"Common Definitions."
ZCOM-TKN-OBJTYPE is the object type provided with the command
on which the error occurred. Its possible values are ZCOMOBJ-LINE, ZCOM-OBJ-PATH, and ZCOM-OBJ-PROCESS. This token is
always present in the error list, and it is described in the
Communications Management Programming Manual.
ZSPI-TKN-PARM-ERR is the standard SPI parameter-error token, as
described in the Distributed Systems Management (DSM) Programming
Manual. For this error list, this token identifies which token
in the command, and which field within that token, caused the
error. This token is always present in the error list.
A-17
ERROR NUMBERS AND ERROR LISTS
11: ZEXP-ERR-INV-VALUE
Probable Cause
An invalid value was specified in a token for a command. Either
the value given was not valid for the corresponding attribute, or
a non-null value was given for an attribute that did not apply to
the given object name.
Recommended Action
In the first case, supply a legal value for the attribute. In
the second case, do not supply any value for attributes that do
not apply to the named object, or correct the object name.
A-18
APPENDIX B
TOKEN CODES AND TOKEN MAPS
Table B-1 is a summary table of all token codes that are specific
to the EXPAND subsystem (that is, token codes whose names begin
with ZEXP-TKN-). For each token code, the token type is given.
The symbolic name of the token number of a token code can be
derived from the name of the token code by replacing -TKN- with
-TNM-; for example, token code ZEXP-TKN-SYSNAME has the token
number ZEXP-TNM-SYSNAME.
Table B-2 is a summary table of all token maps that are specific
to the EXPAND subsystem (that is, token maps whose names begin
with ZEXP-MAP-). For each token map, the symbolic name of the
DDL definition is given. The symbolic name of the token number
of a token map can be derived from the name of the token map by
replacing -MAP- with -TNM-; for example, token map ZEXP-MAP-INFOPATH has the token number ZEXP-TNM-INFO-PATH.
B-1
TOKEN CODES AND TOKEN MAPS
Table B-1.
B-2
EXPAND Token Codes (Page 1 of 2)
TOKEN CODE
(ZEXP-TKN-)
TOKEN TYPE
BAD-SYSGEN-CAUSE
ZSPI-TYP-INT
CALLED-SYS
ZSPI-TYP-INT
CIU-PATH
ZSPI-TYP-ENUM
CLIP-RECV-STATE
ZSPI-TYP-INT
CLIP-SEND-STATE
ZSPI-TYP-INT
CLIP-STATUS
ZSPI-TYP-INT
CPU-STATUS
ZSPI-TYP-INT
CSM-ERR
ZSPI-TYP-INT
CSS-LINE-ERR
ZSPI-TYP-INT
CSS-LINE-ERR-TYPE
ZSPI-TYP-INT
DEV-STATUS
ZSPI-TYP-INT
DEV-STATUS-MASK
ZSPI-TYP-INT
DISCONN-CAUSE
ZSPI-TYP-INT
FRAME-A-C
ZSPI-TYP-INT
FRAME-ERR
ZSPI-TYP-INT
FRAME-T-S
ZSPI-TYP-INT
FUNC-MODIF
ZSPI-TYP-INT
INFO-NCP-OPT
ZSPI-TYP-ENUM
IO-BUS-ERR
ZSPI-TYP-INT
LH-ERR-NUM
ZSPI-TYP-INT
LINE-NOT-READY-ERR
ZSPI-TYP-INT
LINE-QUAL
ZSPI-TYP-INT
TOKEN CODES AND TOKEN MAPS
Table B-1.
EXPAND Token Codes (Page 2 of 2)
TOKEN CODE
(ZEXP-TKN-)
TOKEN TYPE
NCP-ERR-NUM
ZSPI-TYP-INT
REQ-ABORT-CAUSE
ZSPI-TYP-INT
RUN-TIME-ERR-CAUSE
ZSPI-TYP-INT
SEL-SYS
ZSPI-TYP-INT
SEQNUM-CAUSE
ZSPI-TYP-INT
STATS-NCP-OPT
ZSPI-TYP-ENUM
SYS-MSG-MODE
ZSPI-TYP-INT
SYSNAME
ZSPI-TYP-CHAR8
SYSNUM
ZSPI-TYP-INT
B-3
TOKEN CODES AND TOKEN MAPS
Table B-2.
B-4
EXPAND Token Maps
TOKEN MAP
(ZEXP-MAP-)
DDL DEFINITION
(ZEXP-DDL-)
ALTER-LINE
ALTER-LINE
ALTER-PATH
ALTER-PATH
ALTER-PROC
ALTER-PROC
INFO-LINE-CSM
INFO-LINE-CSM
INFO-LINE-HDLC
INFO-LINE-HDLC
INFO-LINE-NAM
INFO-LINE-NAM
INFO-NCP-NETMAP
INFO-NCP-NETMAP
INFO-NCP-PATHMAP
INFO-NCP-PATHMAP
INFO-PATH
INFO-PATH
INFO-PROC
INFO-PROC
PROBE-NCP
PROBE-NCP
STATS-LINE-CSM
STATS-LINE-CSM
STATS-LINE-NCSM
STATS-LINE-NCSM
STATS-PATH
STATS-PATH
STATUS-LINE
STATUS-LINE
STATUS-PATH
STATUS-PATH
SYS-STATS-NCP
SYS-STATS-NCP
PKTS-STATS-NCP
PKTS-STATS-NCP
APPENDIX C
LINE ATTRIBUTES BY LINE-HANDLER TYPE
Table C-1 lists all of the attributes of EXPAND line objects that
can be altered or inquired about in an application that uses
the management-programming interfaces. It indicates which line
attributes are valid for lines controlled by the various types of
line handlers.
The names in the leftmost column of this table are the names
of fields in the extensible structured tokens ZEXP-MAP-ALTER-LINE
(for the ALTER LINE command) and ZEXP-MAP-INFO-LINE-HDLC, ZEXPMAP-INFO-LINE-CSM, and ZEXP-MAP-INFO-LINE-NAM (for the INFO LINE
command).
The entries in the table have the following meanings:
A
The attribute corresponding to this field can be both
altered and inquired about for this type of line
handler.
I
The attribute corresponding to this field can be
inquired about but not altered for this type of line
handler.
blank
The attribute corresponding to this field can be
neither altered nor inquired about for this type of
line handler.
C-1
LINE ATTRIBUTES BY LINE-HANDLER TYPE
Table C-1.
Line Attributes by Line-Handler Type (Page 1 of 3)
ATTRIBUTE
FIELD
HDLC NORMAL HDLC NORMAL HDLC EXTENDED
FOR BIT- AND FOR 6100
FOR BIT- AND
BYTE-SYNC
CSS
BYTE-SYNC
ZADDR
I
I
NAM
A
ZASSOC-DEV
A
ZASSOC-SUBDEV
A
ZAUTOLOAD
A
ZCHARSET
A
A
A
ZDELAY
I
A
I
I
I
ZDSR-TIMEOUT
A
ZFRAME-SIZE
I
I
I
ZIDLE-TIMEOUT
A
A
A
ZINTERF
A
A
A
ZMAX-RECONNS
A
ZPROG
A
ZPROTOID
I
A = alter and inquire
C-2
I = inquire only
blank = not valid
LINE ATTRIBUTES BY LINE-HANDLER TYPE
Table C-1.
Line Attributes by Line-Handler Type (Page 2 of 3)
ATTRIBUTE
FIELD
HDLC NORMAL HDLC NORMAL HDLC EXTENDED
FOR BIT- AND FOR 6100
FOR BIT- AND
BYTE-SYNC
CSS
BYTE-SYNC
ZREAD-BUFFS
A
A
A
ZRECV-WINDOW
ZRETRIES
NAM
A
A
A
A
ZRETRY-PROBE
A
ZSPEED
A
A
A
ZSYNCS
A
A
A
ZTEST-INTVL
A
A
ZTHRES
I
A
I
ZTIMEOUT
A
A
A
A
ZTIMER-BIND
A
ZTIMER-INACTV
A
ZTIMER-PROBE
A
ZTIMER-RECONN
A
A = alter and inquire
I = inquire only
blank = not valid
C-3
LINE ATTRIBUTES BY LINE-HANDLER TYPE
Table C-1.
Line Attributes by Line-Handler Type (Page 3 of 3)
ATTRIBUTE
FIELD
HDLC NORMAL HDLC NORMAL HDLC EXTENDED
FOR BIT- AND FOR 6100
FOR BIT- AND
BYTE-SYNC
CSS
BYTE-SYNC
ZTYPE
I
I
I
ZWINDOW
A
A
A
ZXMIT-WINDOW
A = alter and inquire
C-4
NAM
I
A
I = inquire only
blank = not valid
INDEX
ABORT command 7-7
Access to remote systems 1-5
Action events 8-4
ALTER LINE command 7-11
ALTER PATH command 7-20
ALTER PROCESS command 7-25
Applications
naming rules and guidelines for 4-3
obtaining event messages in 8-1
programmatic commands used by 2-3
relationship to architecture of 2-2
suggestions for 2-1
using letter Z in 4-3
Architecture of EXPAND subsystem 1-3
relationship of application to 2-2
Bad SYSGEN, event message 8-47
Buffer declarations 6-9
Buffer size
for an event message 8-4
recommended for commands 5-1
recommended for responses 5-3
Building the command buffer 5-1
CLB command reject error 8-70
CLIP downloaded, event message 8-58
CLIP or CIU download error 8-61
CMI 1-4
corresponding commands in 2-8
Command buffer, building 5-1
Command numbers 4-3
Command-number token 6-3
Commands 7-1/134
ABORT 7-7
ALTER LINE 7-11
ALTER PATH 7-20
ALTER PROCESS 7-25
Index-1
INDEX
Commands (continued)
building the buffer for 5-1
by object type 7-3
command numbers of 4-3
compared to CMI commands 2-8
compared to CUP commands 2-11
compared to NETMON commands 2-10
compared to PUP commands 2-12
compared to SCF commands 2-6
components of 4-7
continuation of 5-1
discontinuing 5-2
duplicate occurrences of tokens in 5-2
examples of 7-125/134
extensible structured tokens in 4-6
GETVERSION
of EXPAND manager process 7-29
of lines and paths 7-32
INFO LINE 7-35
INFO PATH 7-45
INFO PROCESS 7-50
list of 2-3
LOAD 7-58
multiple, in single request message 5-1
nonsensitive 7-4
notation used to describe 7-5
number of object names accepted in 4-4
order of tokens in 7-5
PROBE 7-61
recommended buffer size for 5-1
RESET 7-65
RESETSTATS LINE 7-68
RESETSTATS PATH 7-74
sending 3-1
sensitive 7-4
START 7-79
STATISTICS LINE 7-83
STATISTICS PATH 7-89
STATISTICS PROCESS 7-94
STATUS LINE 7-99
STATUS PATH 7-104
STOP 7-108
SWITCH 7-112
symbolic names of 7-2
TRACE
of EXPAND manager process 7-116
of lines and paths 7-121
of NCP process 7-121
Commands and responses 7-1/134
examples of 7-125/134
Common data-communications concepts 7-6
Common definitions 6-1
Common syntax elements 4-3
Index-2
INDEX
Communicating through SCP 3-1
Communications Management Interface
See CMI
Communications Utility Program
See CUP
Conditional tokens 8-5
Configuration attributes 7-6
for line-handler processes 7-56
for lines 7-12, 7-38
for paths 7-21, 7-47
Connection lost, event message 8-26
Connection made, event message 8-35
Console messages 8-5
Constructs involving multiple tokens 4-7
Continuation
of commands 5-1
of responses 5-3
Control-and-inquiry interface 1-4, 2-2
CPU status change, event message 8-41
Creating the EXPAND manager process 3-2
by NEWPROCESS call 3-4
by RUN command 3-3
Critical events 8-3
CSS frame error 8-77
CSS invalid function modifier error 8-87
CSS line error 8-87
CSS no response, event message 8-73
CSS status probe error 8-66
CSS unexpected breakpoint error 8-81
CSS unit error 8-61
CUP 1-4
corresponding commands in 2-11
Current path information 7-63
Data lists 4-7
representation of, in responses 7-6
Data-communications standard definitions
Decoding the response buffer 5-3
Definition files 4-2
Definitions
common 6-1
data-communications standard 6-5
EMS standard 6-4
EXPAND subsystem 6-8/25
files of 4-2
SPI standard 6-1
Device down, event message 8-20
Device error 8-10
Device up, event message 8-17
Discontinuing a command 5-2
6-5
Elements of SPI messages 4-1
Empty response record 5-4, A-7
Index-3
INDEX
EMS
1-4, 8-1/98
examples of event-message retrieval 8-92/98
examples of filters 8-90
standard definitions 6-4
See also Event messages
EMSTEXT procedure 8-5
Error handling 5-4
Error lists 4-7, A-1/18
extensible structured tokens in 4-7
issued by EXPAND subsystem A-1/18
notation used to describe A-1
order of tokens in A-1
representation of, in responses 7-6
Error numbers
issued by EXPAND subsystem A-1/18
with no error lists 5-4
Error token 6-3
Event management 1-4, 8-1/98
examples of event-message retrieval 8-92/98
examples of filters 8-90
interface 1-4, 2-2
programming 8-4
See also Event messages
Event Management Service
See EMS
Event messages 2-12, 8-1/98
buffer size for 8-4
categories of tokens in 8-5
components of 4-8
conditional tokens in 8-5
console-compatible-format text of 8-5
display-format text of 8-5
displayed on operator console 8-4
event numbers of 4-5
EXPAND subsystem ID in 8-1
extensible structured tokens in 8-4
filters for 8-4
issued by EXPAND subsystem 8-1/98
lists in 8-4
notation used to describe 8-4
obtaining in an application 8-1
order of tokens in 8-5
relationship to console messages of 8-5
reported by line-handler processes 8-2
reported by NCP 8-3
reported to EMS 8-4
reported to TMDS 8-4
standard header in text of 8-5
subjects of 4-5
Tandem internal tokens in 8-5
text version of 8-5
unconditional tokens in 8-5
volatile tokens in 8-5
Index-4
INDEX
Event numbers 4-5
Event-number token 6-5
Events 2-12, 8-1/98
action 8-4
critical 8-3
noncritical 8-3
processes that report 8-1
Examples
of commands and responses 7-125/134
of event-message retrieval 8-92/98
of filters 8-90
EXPAND definitions 6-8/25
buffer declarations 6-9
extensible structured tokens 6-12
field types 6-10
field values 6-10
simple tokens 6-11
token types 6-10
token values 6-10
tokens in error lists 6-24
tokens in event messages 6-25
EXPAND line
See Lines
EXPAND line-handler process
See Line-handler processes
EXPAND manager process 1-1
communicating with 3-1
creating 3-2
by NEWPROCESS call 3-4
by RUN command 3-3
format of object name of 4-4
in architecture of EXPAND subsystem 1-3
NULL object type for 6-7
object name of 6-7
obtaining server version of 7-29
PROCESS object type for 6-7
tracing 7-116
EXPAND network 1-1
EXPAND network-operating software 1-1
EXPAND path
See Paths
EXPAND subsystem
architecture of 1-3
background information on 7-6
command numbers supported by 4-3
commands accepted by 7-1/134
common syntax elements for 4-3
communicating with 3-1
configuration attributes for
See Configuration attributes
current path information for 7-63
data-communications definitions used 6-5
definitions provided by 6-8/25
Index-5
INDEX
EXPAND subsystem (continued)
definitions used by 6-1/25
elements of SPI messages for 4-1
EMS definitions used by 6-4
error handling in 5-4
error lists issued by A-1/18
error numbers issued by A-1/18
event messages issued by 8-1/98
event-message subjects issued by 4-5
format of object names for 4-4
interfaces to 1-4
management programming for 2-1
network map information for 7-53
object types supported by 4-4
objects controlled by 1-1
path map information for 7-54
programming considerations for 5-1/4
relationship with other subsystems 1-2
responses issued by 7-1/134
security for 5-4
SPI definitions used by 6-1
SPI programming considerations for 5-1/4
statistics
for communication between two systems 7-97
for network traffic through a system 7-97
subsystem ID of 6-11
subsystem number of 6-3
token codes defined by B-2
token maps defined by B-4
EXPAND subsystem ID 6-11
in event messages 8-1
Extensible structured tokens 4-6
in commands 4-6
in error lists 4-7
in event messages 8-4
in responses 4-6
using SSNULL to initialize 5-1
Field types 4-7
Fields
initializing 5-1
null values of 5-1
optional 7-5
predefined value names for 4-7
required 7-5
types of 4-7
File-system procedures 1-5
Files, definition 4-2
Filters 8-4
examples of 8-90
FOX subsystem, relationship with 1-2
Index-6
INDEX
GETVERSION command
for EXPAND manager process
for lines and paths 7-32
Hierarchy
of object types
7-29
6-7
I/O bus error 8-7
INFO LINE command 7-35
INFO PATH command 7-45
INFO PROCESS command 7-50
Initializing structured tokens
Interactive interfaces 1-4
Interfaces to EXPAND subsystem
5-1
1-4
Letter Z, using in applications 4-3
Line error 8-10
Line not ready, event message 8-32
LINE object
See Lines
Line ready, event message 8-29
Line-handler processes 1-1
changing attribute values of 7-25
event messages reported by 8-2
format of object names of 4-4
in architecture of EXPAND subsystem 1-3
object names of 6-7
object type of 6-7
obtaining attribute values of 7-50
switching between CIU paths 7-112
switching between processors 7-112
Line-quality event message 8-23
Lines 1-1
aborting 7-7
attributes of, by line-handler type C-1/4
changing attribute values of 7-11
clearing statistics counters of 7-68
commands affecting 7-3
downloading CLIPs for 7-58
format of object names of 4-4
initiating operation of 7-79
object names of 6-7
object type of 6-7
obtaining attribute values of 7-35
obtaining current state of 7-99
obtaining server banner of 7-32
obtaining statistics for 7-68, 7-83
relationship to paths 6-7
resetting CLIPs for 7-65
terminating operation of 7-7, 7-108
tracing 7-121
Index-7
INDEX
Lists
data lists 4-7
error lists 4-7
in event messages 8-4
LIU configuration error 8-84
LOAD command 7-58
Management applications
See Applications
Management functions, required 1-2
Management programming 2-1
Manager token 6-3
Manuals, prerequisite x, 2-13
Multiple tokens, constructs involving
4-7
Names
of objects, See Object names
of values 4-6
Naming rules and guidelines 4-3
NCP 1-1
event messages reported by 8-3
in architecture of EXPAND subsystem 1-3
object name of 6-7
PROCESS object type for 6-7
tracing 7-121
NETMON 1-4
corresponding commands in 2-10
Network connection lost, event message 8-26
Network connection made, event message 8-35
Network Control Process
See NCP
Network map information 7-53
obtaining 7-50
Network Monitor
See NETMON
Network timeout, event message 8-38
Network traffic aborted, event message 8-55
Network Utility Process
See $ZNUP
No response from CLIP, event message 8-73
No response from node, event message 8-44
Node 1-1
Noncritical events 8-3
Nonsensitive commands 7-4
NULL object
commands affecting 7-3
format of object name of 4-4
object name of 6-7
object type of 6-7
Object names 4-4
format of 4-4
number accepted in commands
Index-8
4-4
INDEX
Object names (continued)
of EXPAND manager process 6-7
of line-handler processes 6-7
of lines 6-7
of NCP 6-7
of NULL object 6-7
of paths 6-7
of PROCESS object 6-7
Object types 4-4
commands listed by 7-3
of EXPAND manager process 6-7
of line-handler processes 6-7
of lines 6-7
of NCP 6-7
of NULL object 6-7
of paths 6-7
of PROCESS object 6-7
Object-name token 6-7
Object-type header token 6-3
Object-type token 6-7
Objects
controlled by EXPAND subsystem 1-1
format of names of 4-4
number affected by one command 5-1
number in one response record 5-3
types of 4-4
Other subsystems, relationship with 1-2
Path information, current 7-63
Path map information 7-54
obtaining 7-50
PATH object
See Paths
Paths 1-1
aborting 7-7
changing attribute values of 7-20
clearing statistics counters of 7-74
commands affecting 7-4
format of object names of 4-4
initiating operation of 7-79
object names of 6-7
object type of 6-7
obtaining attribute values of 7-45
obtaining current state of 7-104
obtaining server banner of 7-32
obtaining statistics for 7-74, 7-89
relationship to lines 6-7
terminating operation of 7-7, 7-108
tracing 7-121
Peripheral Utility Program
See PUP
Predefined value names 4-6
Prerequisite manuals x, 2-13
Index-9
INDEX
PROBE command 7-61
Probe information 7-63
Procedures, file-system 1-5
PROCESS object
See Processes
Processes
commands affecting 7-4
EXPAND manager 1-1, 1-3
format of object names of 4-4
in EXPAND subsystem 1-3
line-handler 1-1, 1-3
NCP 1-1
NULL object type for 6-7
object names of 6-7
PROCESS object type for 6-7
that report events 8-1
$ZNUP 1-3
Processor status change, event message 8-41
Programmatic access to remote systems 1-5
Programmatic commands
See Commands
Programmatic interfaces 1-4
advantages of 2-1
Programming considerations 5-1/4
Programming for event management 8-4
PUP 1-4
corresponding commands in 2-12
Receiving the response buffer 5-3
Relationship with other subsystems 1-2
Request aborted, event message 8-55
Required management functions 1-2
RESET command 7-65
RESETSTATS LINE command 7-68
RESETSTATS PATH command 7-74
Response buffer, receiving and decoding
Response records
empty 5-4, A-7
multiple 5-3
number of in one reply message 5-3
number of objects described in 5-3
selecting kind to be returned 5-3
tokens in 7-5
Responses 7-1/134
components of 4-8
continuation of 5-3
decoding the buffer for 5-3
examples of 7-125/134
extensible structured tokens in 4-6
multiple response records in 5-3
notation used to describe 7-5
order of tokens in 7-5
receiving 3-1, 5-3
Index-10
5-3
INDEX
Responses (continued)
recommended buffer sizes for 5-3
selecting response records returned in
that describe multiple objects 5-3
Return token 6-4
Run-time error 8-52
5-3
SCF
1-4
corresponding commands in 2-6
SCP 3-1
communicating through 3-1
Security 5-4
Sensitive commands 7-4
Simple tokens 4-5
SPI 4-1
messages, elements of 4-1
programming considerations 5-1/4
standard definitions 6-1
SSNULL procedure 5-1
START command 7-79
Statistics
for communication between two systems 7-97
for network traffic through a system 7-97
STATISTICS LINE command 7-83
STATISTICS PATH command 7-89
STATISTICS PROCESS command 7-94
STATUS LINE command 7-99
STATUS PATH command 7-104
STOP command 7-108
Structured tokens
See Extensible structured tokens
Subject token 4-5
Subjects of event messages 4-5
Subsystem Control Facility
See SCF
Subsystem Control Point
See SCP
Subsystem Programmatic Interface
See SPI
SWITCH command 7-112
Syntax elements, common 4-3
SYSGEN error 8-47
Tandem internal tokens 8-5
Timeout event message 8-38
Token codes 4-5
defined by EXPAND subsystem B-2
Token maps 4-6
defined by EXPAND subsystem B-4
Token numbers, symbolic names of B-1
Token types 4-6
Index-11
INDEX
Tokens 4-1
categories of, in event messages 8-5
conditional 8-5
constructs involving multiple 4-7
duplicate occurrences of in commands 5-2
extensible structured 4-6
in one response record 7-5
optional 7-5
order of
in commands 7-5
in error lists A-1
in event messages 8-5
in responses 7-5
predefined value names for 4-6
required 7-5
simple 4-5
symbolic names of token numbers of B-1
Tandem internal 8-5
token codes 4-5
token maps 4-6
token numbers, symbolic names of B-1
token types 4-6
unconditional 8-5
volatile 8-5
TRACE command
for EXPAND manager process 7-116
for lines and paths 7-121
for NCP process 7-121
Types
of fields 4-7
of objects 4-4
of tokens 4-6
Unconditional tokens
8-5
Value names, predefined
Volatile tokens 8-5
4-6
X25AM subsystem, relationship with
Z, using in applications 4-3
ZCOM-CMDABORT 7-7
ALTER 7-11, 7-20, 7-25
GETVERSION 7-29, 7-32
INFO 7-35, 7-45, 7-50
LOAD 7-58
PROBE 7-61
RESET 7-65
RESETSTATS 7-68, 7-74
START 7-79
STATISTICS 7-83, 7-89, 7-94
STATUS 7-99, 7-104
Index-12
1-2
INDEX
ZCOM-CMD- (continued)
STOP 7-108
SWITCH 7-112
TRACE 7-116, 7-121
ZCOM-DDLREQID 6-6
TRACE-MODIF 6-6
ZCOM-ERROBJ-ALRDY-IN-SUMSTATE
in ABORT command 7-10
in START command 7-82
in STOP command 7-111
in SWITCH command 7-115
ZCOM-MAPREQID 6-6
TRACE-MODIF 6-6
for EXPAND manager process 7-118
for lines, paths, and the NCP 7-123
ZCOM-OBJLINE 6-7
NULL 6-7
PATH 6-7
PROCESS 6-7
ZCOM-TKNCMD-TIMEOUT 6-6
OBJNAME 6-7
OBJTYPE 6-7
SWITCH-CPU 7-113
SWITCH-PATH 7-113
TRACE-OPT
for EXPAND manager process 7-118
for lines, paths, and the NCP 7-123
ZCOM-VALPATH-A 6-25, 7-113
PATH-B 6-25, 7-113
SUMSTATE-STARTED 6-8
SUMSTATE-STOPPED 6-8
ZEMS-TKNCONSOLE-PRINT 6-5
EMPHASIS 8-3
EVENTNUMBER 6-5
LDEVNAME 6-5
SUBJECT-MARK 8-5
ZEXP-DDLALTER-LINE 7-11
ALTER-PATH 7-20
ALTER-PROC 7-25
INFO-LINE-CSM 7-36
INFO-LINE-HDLC 7-35
INFO-LINE-NAM 7-36
INFO-NCP-NETMAP 7-51
INFO-NCP-PATHMAP 7-51
INFO-PATH 7-45
Index-13
INDEX
ZEXP-DDL- (continued)
INFO-PROC 7-51
MSG-BUFFER 6-9
MSG-BUFFER-MAXLEN 6-9
PKTS-STATS-NCP 7-95
PROBE-NCP 7-62
STATS-LINE-CSM 6-12
STATS-LINE-NCSM 6-17
STATS-PATH 6-20
STATUS-LINE 7-99
STATUS-PATH 7-104
SYS-STATS-NCP 7-95
ZEXP-ERRBAD-NETTRACE-RCVD A-15
EMPT-RSP 5-4, A-7
INV-VALUE A-17
NEG-LH-RSP A-5
in ALTER LINE command 7-18, 7-19
in ALTER PATH command 7-24
NEG-NCP-RSP A-13
OBJ-TYPE-NAME-MISMATC A-10
TKN-CONFL A-8
in ALTER LINE command 7-19
in ALTER PATH command 7-24
in ALTER PROCESS command 7-28
in SWITCH command 7-115
TOO-MANY-OBJNAMES A-3
TRACE-NOT-STARTED A-12
ZEXP-EVTCLIP-DWLOADED 8-58
CSS-CLB-CMD-REJ 8-70
CSS-FRAME-ERR 8-77
CSS-LINE-ERR 8-87
CSS-LIU-CONFIG-ERR 8-84
CSS-NO-RSP 8-73
CSS-STATUS-PROBE-ERR 8-66
CSS-UNEXP-BRKPT 8-81
CSS-UNIT-ERROR 8-61
DEV-DOWN 8-20
DEV-ERR 8-10
DEV-UP 8-17
IO-BUS-ERR 8-7
NET-BAD-SYSGEN 8-47
NET-CONN 8-35
NET-CPU-STATUS 8-41
NET-DISCONN 8-26
NET-LINE-NOT-READY 8-32
NET-LINE-QUAL 8-23
NET-LINE-READY 8-29
NET-NO-RSP 8-44
NET-REQ-ABORT 8-55
NET-RUN-TIME-ERR 8-52
NET-TIMEOUT 8-38
Index-14
INDEX
ZEXP-MAPALTER-LINE
description of 7-12
structure of 7-11
ZADDR field 7-13
ZASSOC-DEV field 7-13
ZASSOC-SUBDEV field 7-13
ZAUTOLOAD field 7-13
ZCHARSET field 7-14
ZDELAY field 7-14
ZDSR-TIMEOUT field 7-14
ZIDLE-TIMEOUT field 7-14
ZINTERF field 7-14
ZMAX-RECONNS field 7-14
ZPROG field 7-15
ZREAD-BUFFS field 7-15
ZRECV-WINDOW field 7-15
ZRETRIES field 7-15
ZRETRY-PROBE field 7-15
ZSPEED field 7-15
ZSYNCS field 7-15
ZTEST-INTVL field 7-15
ZTHRES field 7-16
ZTIMEOUT field 7-16
ZTIMER-BIND field 7-16
ZTIMER-INACTV field 7-16
ZTIMER-PROBE field 7-16
ZTIMER-RECONN field 7-16
ZWINDOW field 7-17
ZXMIT-WINDOW field 7-17
ALTER-PATH
description of 7-21
structure of 7-20
ZCMPRSS field 7-22
ZNEXT-SYS field 7-22
ZOUT-OF-SEQ-SPACE field 7-22
ZOUT-OF-SEQ-TIMEOUT field 7-22
ZRETRIES field 7-22
ZTIMEOUT field 7-22
ALTER-PROC
description of 7-26
structure of 7-25
ZDEBUG field 7-26
INFO-LINE-CSM
description of 7-39
structure of 7-36
ZADDR field 7-39
ZAUTOLOAD field 7-39
ZCHARSET field 7-40
ZDELAY field 7-40
ZDSR-TIMEOUT field 7-40
Index-15
INDEX
ZEXP-MAPINFO-LINE-CSM (continued)
ZFRAME-SIZE field 7-40
ZIDLE-TIMEOUT field 7-40
ZINTERF field 7-40
ZPROG field 7-40
ZPROTOID field 7-40
ZREAD-BUFFS field 7-40
ZRETRIES field 7-41
ZSPEED field 7-41
ZSYNCS field 7-41
ZTEST-INTVL field 7-41
ZTHRES field 7-41
ZTIMEOUT field 7-41
ZTYPE field 7-41
ZWINDOW field 7-41
INFO-LINE-HDLC
description of 7-38
structure of 7-35
ZADDR field 7-38
ZCHARSET field 7-38
ZDELAY field 7-38
ZFRAME-SIZE field 7-38
ZIDLE-TIMEOUT field 7-38
ZINTERF field 7-38
ZREAD-BUFFS field 7-39
ZRETRIES field 7-39
ZSPEED field 7-39
ZSYNCS field 7-39
ZTHRES field 7-39
ZTIMEOUT field 7-39
ZTYPE field 7-39
ZWINDOW field 7-39
INFO-LINE-NAM
description of 7-41
structure of 7-36
ZASSOC-DEV field 7-41
ZASSOC-SUBDEV field 7-41
ZDELAY field 7-41
ZFRAME-SIZE field 7-41
ZMAX-RECONNS field 7-42
ZRECV-WINDOW field 7-42
ZRETRY-PROBE field 7-42
ZSPEED field 7-42
ZTIMEOUT field 7-42
ZTIMER-BIND field 7-42
ZTIMER-INACTV field 7-42
ZTIMER-PROBE field 7-42
ZTIMER-RECONN field 7-42
ZTYPE field 7-42
ZXMIT-WINDOW field 7-42
Index-16
INDEX
ZEXP-MAP- (continued)
INFO-NCP-NETMAP
description of 7-53
structure of 7-51
ZCALLED-SYS field 7-53
ZCONN-PATH field 7-54
ZCONN-STATE field 7-54
ZHOP-COUNT field 7-54
ZNSCB-TOSVERSION field 7-53
ZNUM-OF-PATH field 7-53
ZPATH-NUM field 7-54
ZSEL-SYS field 7-53
ZSYS-DIST-ENT field 7-54
ZTRAVEL-TIME field 7-54
INFO-NCP-PATHMAP
description of 7-54
structure of 7-51
ZCALLED-SYS field 7-54
ZDOWN-CAUSE field 7-55
ZLINE-LDEV field 7-55
ZLINE-STATUS field 7-55
ZNEIGHBOR-NUM field 7-55
ZNOPASS-THRU field 7-55
ZNUM-OF-LINES field 7-55
ZNUM-OF-PATH field 7-54
ZPATH-CPU-PIN field 7-55
ZPATH-ENT field 7-55
ZPATH-LDEV field 7-55
ZPATH-NUM field 7-55
ZSTATUS field 7-55
ZTIME-FACTOR field 7-55
INFO-PATH
description of 7-47
structure of 7-45
ZCMPRSS field 7-47
ZNEXT-SYS field 7-47
ZOUT-OF-SEQ-SPACE field 7-47
ZOUT-OF-SEQ-TIMEOUT field 7-47
ZRETRIES field 7-47
ZTIME-FACT field 7-47
ZTIMEOUT field 7-47
ZTYPE field 7-48
INFO-PROC
description of 7-56
structure of 7-51
ZDEBUG field 7-56
ZTYPE field 7-56
PKTS-STATS-NCP
description of 7-97
structure of 7-95
ZCALLED-SYS field 7-97
ZFWD-PKTS-RECV field 7-97
ZFWD-PKTS-SENT field 7-97
Index-17
INDEX
ZEXP-MAPPKTS-STATS-NCP (continued)
ZPKTS-RECV field 7-97
ZPKTS-SENT field 7-97
PROBE-NCP
description of 7-63
structure of 7-62
ZCALLED-SYS field 7-63
ZNUM-OF-SYS field 7-63
ZSEL-SYS field 7-63
ZSYS-LIST field 7-63
ZTRIP-TIME field 7-63
STATS-LINE-CSM
description of 6-12
structure of 6-12
ZALLOC-ERRS field 6-14
ZBCC-ERRS field 6-14
ZFRAMES-ERR field 6-14
ZFRAMES-TOTAL field 6-14
ZI-FRAMES-RECV field 6-13
ZI-FRAMES-SENT field 6-13
ZL2-ADDR-ERRS field 6-16
ZL2-CMDR-FRAMES-RECV field 6-15
ZL2-CMDR-FRAMES-SENT field 6-15
ZL2-DISC-FRAMES-RECV field 6-15
ZL2-DISC-FRAMES-SENT field 6-15
ZL2-DM-FRAMES-RECV field 6-15
ZL2-DM-FRAMES-SENT field 6-15
ZL2-FCS-ERRS field 6-16
ZL2-I-FRAMES-RECV field 6-15
ZL2-I-FRAMES-RECV-P field 6-15
ZL2-I-FRAMES-SENT field 6-14
ZL2-I-FRAMES-SENT-P field 6-14
ZL2-LEN-ERRS field 6-16
ZL2-MODEM-ERRS field 6-15
ZL2-RECV-ABORTED field 6-16
ZL2-RECV-BUFF field 6-16
ZL2-RECV-OVERRUN field 6-15
ZL2-REJ-FRAMES-RECV field 6-15
ZL2-REJ-FRAMES-SENT field 6-15
ZL2-RNR-FRAMES-RECV field 6-15
ZL2-RNR-FRAMES-SENT field 6-15
ZL2-RR-FRAMES-RECV field 6-15
ZL2-RR-FRAMES-SENT field 6-15
ZL2-SABM-FRAMES-RECV field 6-15
ZL2-SABM-FRAMES-SENT field 6-15
ZL2-SREJ-FRAMES-RECV field 6-16
ZL2-SREJ-FRAMES-SENT field 6-16
ZL2-STATE-CTS field 6-16
ZL2-STATE-DCD field 6-16
ZL2-STATE-DSR field 6-16
ZL2-TIMEOUT field 6-16
ZL2-UA-FRAMES-RECV field 6-15
Index-18
INDEX
ZEXP-MAPSTATS-LINE-CSM (continued)
ZL2-UA-FRAMES-SENT field 6-15
ZLAST-RESETSTATS-TMSTP field 6-13
ZLINE-BPID field 6-16
ZLINE-PPID field 6-16
ZQUAL-ERRS field 6-14
ZS-FRAMES-RECV field 6-14
ZS-FRAMES-SENT field 6-14
ZSTATS-CURR-TMSTP field 6-13
ZU-FRAMES-RECV field 6-14
ZU-FRAMES-SENT field 6-14
STATS-LINE-NCSM
description of 6-16
structure of 6-17
ZALLOC-ERRS field 6-18
ZBCC-ERRS field 6-18
ZFRAMES-ERR field 6-18
ZFRAMES-TOTAL field 6-18
ZI-FRAMES-RECV field 6-18
ZI-FRAMES-SENT field 6-18
ZL2-CMDR-FRAMES-RECV field 6-19
ZL2-CMDR-FRAMES-SENT field 6-19
ZL2-DISC-FRAMES-RECV field 6-19
ZL2-DISC-FRAMES-SENT field 6-19
ZL2-DM-FRAMES-RECV field 6-20
ZL2-DM-FRAMES-SENT field 6-20
ZL2-I-FRAMES-RECV field 6-19
ZL2-I-FRAMES-RECV-P field 6-19
ZL2-I-FRAMES-SENT field 6-19
ZL2-I-FRAMES-SENT-P field 6-19
ZL2-MODEM-ERRS field 6-20
ZL2-RECV-OVERRUN field 6-20
ZL2-REJ-FRAMES-RECV field 6-19
ZL2-REJ-FRAMES-SENT field 6-19
ZL2-RNR-FRAMES-RECV field 6-19
ZL2-RNR-FRAMES-SENT field 6-19
ZL2-RR-FRAMES-RECV field 6-19
ZL2-RR-FRAMES-SENT field 6-19
ZL2-SABM-FRAMES-RECV field 6-19
ZL2-SABM-FRAMES-SENT field 6-19
ZL2-SREJ-FRAMES-RECV field 6-20
ZL2-SREJ-FRAMES-SENT field 6-20
ZL2-UA-FRAMES-RECV field 6-19
ZL2-UA-FRAMES-SENT field 6-19
ZLAST-RESETSTATS-TMSTP field 6-17
ZLINE-BPID field 6-20
ZLINE-PPID field 6-20
ZQUAL-ERRS field 6-18
ZS-FRAMES-RECV field 6-18
ZS-FRAMES-SENT field 6-18
ZSTATS-CURR-TMSTP field 6-17
ZU-FRAMES-RECV field 6-18
Index-19
INDEX
ZEXP-MAPSTATS-LINE-NCSM (continued)
ZU-FRAMES-SENT field 6-18
STATS-PATH
description of 6-20
structure of 6-20
ZFRAMES-GT-4096 field 6-24
ZFRAMES-LE-1024 field 6-23
ZFRAMES-LE-128 field 6-23
ZFRAMES-LE-2048 field 6-23
ZFRAMES-LE-256 field 6-23
ZFRAMES-LE-4096 field 6-24
ZFRAMES-LE-512 field 6-23
ZFRAMES-LE-64 field 6-23
ZKNOWN-SYS field 6-24
ZL4-FWD-RECV field 6-22
ZL4-FWD-SENT field 6-22
ZL4-LINK-REQ-RECV field 6-22
ZL4-LINK-REQ-SENT field 6-22
ZL4-PKTS-RECV field 6-22
ZL4-PKTS-SENT field 6-22
ZL4-REQ-RECV-ACK field 6-23
ZL4-REQ-RECV-CANCEL field 6-23
ZL4-REQ-RECV-CONN field 6-22
ZL4-REQ-RECV-ENQ field 6-23
ZL4-REQ-RECV-LCMP field 6-23
ZL4-REQ-RECV-LRQ field 6-23
ZL4-REQ-RECV-NAK field 6-23
ZL4-REQ-RECV-NCP field 6-23
ZL4-REQ-RECV-TRACE field 6-22
ZL4-REQ-SENT-ACK field 6-22
ZL4-REQ-SENT-CANCEL field 6-22
ZL4-REQ-SENT-CONN field 6-22
ZL4-REQ-SENT-ENQ field 6-22
ZL4-REQ-SENT-LCMP field 6-22
ZL4-REQ-SENT-LRQ field 6-22
ZL4-REQ-SENT-NAK field 6-22
ZL4-REQ-SENT-NCP field 6-22
ZL4-REQ-SENT-TRACE field 6-22
ZLAST-RESETSTATS-TMSTP field 6-21
ZLOC-POOL-CURR-USED field 6-23
ZLOC-POOL-FAILS field 6-24
ZLOC-POOL-MAX-USED field 6-23
ZLOC-POOL-PAGES field 6-24
ZMAX-POOL-USED field 6-24
ZOUT-OF-SEQ-POOL-CURR-USED field 6-24
ZOUT-OF-SEQ-POOL-MAX-USED field 6-24
ZOUT-OF-SEQ-TIMEOUT field 6-24
ZPATH-BPID field 6-24
ZPATH-CHANGES-RECV field 6-24
ZPATH-CHANGES-SENT field 6-24
ZPATH-PPID field 6-24
ZSTATS-CURR-TMSTP field 6-21
Index-20
INDEX
ZEXP-MAP- (continued)
STATUS-LINE
description of 7-101
structure of 7-99
ZBKUP-SUBCHNL-ADDR field 7-101
ZCSM-LDEV field 7-101
ZLAST-ERR field 7-101
ZLINE-BPID field 7-101
ZLINE-PPID field 7-101
ZPATH field 7-101
ZPATH-LDEV field 7-101
ZPRIM-SUBCHNL-ADDR field 7-101
ZSTATE field 7-101
STATUS-PATH
description of 7-106
structure of 7-104
ZCLIP field 7-106
ZLAST-ERR field 7-106
ZLDEV field 7-106
ZPATH-BPID field 7-106
ZPATH-PPID field 7-106
ZSTATE field 7-106
ZTOTAL-LINES field 7-106
SYS-STATS-NCP
description of 7-97
structure of 7-95
ZCALLED-SYS field 7-97
ZLINK-RECV field 7-97
ZLINK-SENT field 7-97
ZPKTS-RECV field 7-97
ZPKTS-SENT field 7-97
ZSEL-SYS field 7-97
ZEXP-TKNBAD-SYSGEN-CAUSE 8-48
CALLED-SYS 6-11
CIU-PATH 6-25
CLIP-RECV-STATE 8-75
CLIP-SEND-STATE 8-75
CLIP-STATUS 8-68
CPU-STATUS 8-42
CSS-LINE-ERR 8-89
CSS-LINE-ERR-TYPE 8-89
DEV-STATUS 8-11
DEV-STATUS-MASK 8-15
DISCONN-CAUSE 8-27
FRAME-A-C 8-71, 8-79
FRAME-ERR 8-79
FRAME-T-S 8-79
FUNC-MODIF 8-82, 8-85, 8-88
INFO-NCP-OPT 7-52
IO-BUS-ERR 8-8
LH-ERR-NUM A-5
LINE-NOT-READY-ERR 8-33
Index-21
INDEX
ZEXP-TKN- (continued)
LINE-QUAL 8-24
NCP-ERR-NUM A-13
REQ-ABORT-CAUSE 8-56
RUN-TIME-ERR-CAUSE 8-53
SEL-SYS 6-11
SEQNUM-CAUSE 8-72
STATS-NCP-OPT 7-96
SYS-MSG-MODE 6-25
SYSNAME 6-25
SYSNUM 6-25
ZEXP-VALASCII 6-10
BUFLEN 5-1, 5-3, 6-10
EBCDIC 6-10
MAX-NUM-OF-PATHS 6-10
MAX-SYS-NUMBER 6-10
MAX-SYSTEMS 6-10
MAXBUFLEN 5-3, 6-10
MIN-SYS-NUMBER 6-10
NCP-MAPS 7-52
NCP-PATHS 7-52
NOT-READY 7-55
PATH-CONNECTED 7-54
PATH-CONNECTING 7-54
PATH-DISCONNECTED 7-54
PKTS-STATS 7-96
READY 7-55
RS232 6-11
RS422 6-11
SSID
description of 6-11
structure of 6-4
SYS-STATS 7-96
VERSION 6-11
ZSPI-ERROK 5-4
ZSPI-SSNZEXP 6-3
ZSPI-TKNALLOW-TYPE 5-2
COMMAND 6-3
DATALIST 7-5
ENDLIST 7-5, A-1
ERRLIST 7-5, A-1
ERROR 6-3
MANAGER 6-3
MAXRESP 5-3
OBJECT-TYPE 6-3
PARM-ERR A-8, A-17
RESPONSE-TYPE 5-3
RETCODE 6-4
Index-22
INDEX
ZSPI-TKN- (continued)
SERVER-BANNER
for EXPAND manager process
for lines and paths 7-33
SERVER-VERSION 6-4
SSID 6-4
7-30
$ZNUP
in architecture of EXPAND subsystem
1-3
Index-23