Page is loading ...
HP NonStop TMF
Management
Programming Manual
Abstract
This manual is for system and application programmers. It provides system-specific
information about the management programming interfaces to the HP NonStop™
Transaction Management Facility (TMF). These interfaces are based on the
Subsystem Programmatic Interface (SPI) and the Event Management Service (EMS).
They allow applications to send commands to, and monitor events reported by,
TMF 3.6.
Product Version
TMF H01
Supported Release Version Updates (RVUs)
This publication supports J06.03 and all subsequent J-series RVUs and H06.06 and all
subsequent H-series RVUs, until otherwise indicated by its replacement publications.
Part Number Published
540140-008 February 2013
Document History
Part Number Product Version Published
540140-003 TMF H01 April 2006
540140-004 TMF H01 May 2007
540140-005 TMF H01 February 2009
540140-006 TMF H01 August 2010
540140-007 TMF H01 February 2011
540140-008 TMF H01 Februrary 2013
Legal Notices
Copyright 2013 Hewlett-Packard Development Company L.P.
Confidential computer software. Valid license from HP required for possession, use or copying.
Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software
Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under
vendor's standard commercial license.
The information contained herein is subject to change without notice. The only warranties for HP
products and services are set forth in the express warranty statements accompanying such products
and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be
liable for technical or editorial errors or omissions contained herein.
Export of the information contained in this publication may require authorization from the U.S.
Department of Commerce.
Microsoft, Windows, and Windows NT are U.S. registered trademarks of Microsoft Corporation.
Intel, Itanium, Pentium, and Celeron are trademarks or registered trademarks of Intel Corporation or its
subsidiaries in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
Motif, OSF/1, UNIX, X/Open, and the "X" device are registered trademarks and IT DialTone and The
Open Group are trademarks of The Open Group in the U.S. and other countries.
Open Software Foundation, OSF, the OSF logo, OSF/1, OSF/Motif, and Motif are trademarks of the
Open Software Foundation, Inc.
OSF MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THE OSF MATERIAL PROVIDED
HEREIN, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
OSF shall not be liable for errors contained herein or for incidental consequential damages in
connection with the furnishing, performance, or use of this material.
© 1990, 1991, 1992, 1993 Open Software Foundation, Inc. This documentation and the software to
which it relates are derived in part from materials supplied by the following:
© 1987, 1988, 1989 Carnegie-Mellon University. © 1989, 1990, 1991 Digital Equipment Corporation.
© 1985, 1988, 1989, 1990 Encore Computer Corporation. © 1988 Free Software Foundation, Inc.
© 1987, 1988, 1989, 1990, 1991 Hewlett-Packard Company. © 1985, 1987, 1988, 1989, 1990, 1991,
1992 International Business Machines Corporation. © 1988, 1989 Massachusetts Institute of
Technology. © 1988, 1989, 1990 Mentat Inc. © 1988 Microsoft Corporation. © 1987, 1988, 1989,
1990, 1991, 1992 SecureWare, Inc. © 1990, 1991 Siemens Nixdorf Informationssysteme AG. © 1986,
1989, 1996, 1997 Sun Microsystems, Inc. © 1989, 1990, 1991 Transarc Corporation.
This software and documentation are based in part on the Fourth Berkeley Software Distribution
under license from The Regents of the University of California. OSF acknowledges the following
individuals and institutions for their role in its development: Kenneth C.R.C. Arnold,
Gregory S. Couch, Conrad C. Huang, Ed James, Symmetric Computer Systems, Robert Elz. © 1980,
1981, 1982, 1983, 1985, 1986, 1987, 1988, 1989 Regents of the University of California.
Printed in the US
Hewlett-Packard Company—540140-008
i
HP NonStop TMF Management
Programming Manual
Index Tables
Legal Notices
What’s New in This Manual vii
Manual Information vii
New and Changed Information viii
About This Manual xi
Who Should Read This Manual xii
How This Manual is Organized xii
TMF Documentation xiii
Other Documentation xiv
Notation Conventions xiv
HP Encourages Your Comments xv
1. Introduction to TMF
Management Programming for TMF 1-1
What is Management Programming? 1-1
How Does Management Programming Apply to TMF? 1-2
Why Use Management Programming for TMF? 1-2
TMF Basic Concepts
1-3
Transactions
1-3
Audit Trails
1-3
Database Tables and Files 1-5
Recovery Processes 1-5
Management Interfaces
1-6
TMFCOM
1-6
EMS 1-6
FUP
1-7
PATHCOM
1-8
Pathway SCREEN COBOL
1-9
Operating System Procedure Calls
1-10
TACL 1-11
Measure Subsystem
1-11
Contents
HP NonStop TMF Management Programming Manual—540140-008
ii
1. Introduction to TMF (continued)
1. Introduction to TMF (continued)
TMF Object Types 1-11
TMF Commands 1-12
TMF Event Messages 1-15
2. Communicating With the TMFSERVE Process
Communicating With the TMFSERVE Process 2-1
Starting and Opening TMFSERVE 2-2
Starting TMFSERVE 2-2
Startup Message 2-2
Opening TMFSERVE 2-2
Naming TMFSERVE 2-3
Closing TMFSERVE 2-3
Running an EMS Consumer Distributor 2-3
3. SPI Programming Considerations for TMF
Definition Files 3-1
Message Elements for TMF 3-3
Commands 3-3
Object Types 3-3
Object Names 3-4
Event Numbers 3-4
Other Tokens 3-4
Data Lists and Error Lists 3-4
Using SPI to Build Commands and Decode Responses 3-5
Building and Sending a Command Message
3-5
Discontinuing a Command in Progress 3-6
Receiving and Decoding a Response Message
3-6
Error Handling 3-7
Security
3-8
Retrieving and Decoding Event Messages 3-8
Event-Management Considerations for TMF
3-9
Critical Events
3-10
Filters 3-10
Templates and Labels
3-10
Naming Guidelines for Applications
3-11
4. Common Definitions
SPI Standard Definitions 4-1
Information Specific to TMF 4-3
Contents
HP NonStop TMF Management Programming Manual—540140-008
iii
4. Common Definitions (continued)
4. Common Definitions (continued)
EMS Standard Definitions 4-4
TMF Definitions 4-4
Buffer Declarations 4-5
Private Token and Field Types 4-6
Predefined Token and Field Values 4-11
Simple Tokens 4-11
Extensible Structured Tokens 4-11
Tokens in Event Messages 4-11
5. Commands and Responses
Command Summary 5-2
Command Descriptions 5-4
ABORT TRANSACTION 5-5
ADD AUDITTRAIL 5-8
ADD DATAVOLS 5-13
ADD DUMPS 5-17
ADD MEDIA 5-20
ADD RESOURCEMANAGER 5-23
ALTER AUDITDUMP 5-26
ALTER AUDITTRAIL 5-31
ALTER BEGINTRANS 5-38
ALTER CATALOG 5-43
ALTER DATAVOLS 5-45
ALTER DUMPS 5-47
ALTER MEDIA
5-49
ALTER PROCESS
5-51
ALTER TMF
5-56
CANCEL OPERATION 5-60
CLOSE RESOURCEMANAGER 5-61
DELETE CATALOG
5-63
DELETE DATAVOLS
5-64
DELETE DUMPS 5-66
DELETE MEDIA
5-68
DELETE RESOURCEMANAGER
5-70
DELETE TMF
5-73
DELETE TRANSACTION
5-74
DISABLE AUDITDUMP 5-76
DISABLE BEGINTRANS
5-78
Contents
HP NonStop TMF Management Programming Manual—540140-008
iv
5. Commands and Responses (continued)
5. Commands and Responses (continued)
DISABLE DATAVOLS 5-79
DUMP FILES 5-81
ENABLE AUDITDUMP 5-88
ENABLE BEGINTRANS 5-90
ENABLE DATAVOLS 5-91
INFO ATDUMPDM 5-93
INFO ATVOLUME 5-95
INFO AUDITDUMP 5-98
INFO AUDITTRAIL 5-101
INFO BEGINTRANS 5-105
INFO CATALOG 5-109
INFO DATAVOLS 5-111
INFO DUMPS 5-114
INFO MEDIA 5-121
INFO PROCESS 5-124
INFO RESOURCEMANAGER 5-128
INFO TMF 5-131
LIST AUDITTRAIL 5-134
NEXT AUDITTRAIL 5-136
RECOVER FILES 5-137
RELOCATE DISKDUMPS 5-145
RESOLVE TRANSACTION 5-148
START TMF 5-150
STATUS ATFILE 5-153
STATUS AUDITDUMP 5-158
STATUS AUDITTRAIL
5-161
STATUS BEGINTRANS 5-166
STATUS CATALOG 5-169
STATUS DATAVOLS
5-171
STATUS OPERATION
5-177
STATUS RESOURCEMANAGER 5-181
STATUS RMTRANSBRANCHES
5-186
STATUS TMF
5-190
STATUS TMFSERVER
5-195
STATUS TRANSACTION
5-198
STATUS TRANSACTIONCHILDREN 5-205
STOP TMF
5-207
Contents
HP NonStop TMF Management Programming Manual—540140-008
v
6. Event Messages
6. Event Messages
Common Tokens in Event Messages 6-1
Unconditional Tokens 6-2
Conditional Tokens 6-3
Obtaining TMF Event Messages 6-4
Sources of TMF Event Messages 6-4
TMP Event Messages 6-5
TMFMON Event Messages 6-13
Recovery Event Messages 6-13
TMF Dump/Restore Event Messages 6-16
TMF Catalog Event Messages 6-17
Event-Management Programming for TMF 6-18
Console Printing 6-19
Subsystem ID 6-19
Action Events 6-19
Buffer Size 6-19
Event Filtering 6-19
Descriptions of Event Messages 6-19
7. Error and Warning Messages
Error Information and Failure Data Capture 7-2
Errors 7-3
Archive Tape Errors and Warnings 7-55
Dump/Restore Errors and Warnings 7-65
Audit Reading Exceptions 7-81
A. TMF Configuration Limits and Defaults
Index
Tables
Table 1-1. FUP Commands for Designating Audit Files 1-7
Table 1-2. PATHCOM Commands for Configuring TMF Options 1-8
Table 1-3.
Pathway SCREEN COBOL Statements 1-9
Table 1-4.
Pathway SCREEN COBOL Registers 1-9
Table 1-5.
System Procedure Calls 1-10
Table 1-6.
TACL Built-In Functions 1-11
Table 1-7. TMFCOM Commands and Equivalent Programmatic Commands 1-13
Table 3-1.
File-System Errors Returned by TMFSERVE 3-8
Table 4-1. SPI Standard Definitions for Header Tokens 4-2
Contents
HP NonStop TMF Management Programming Manual—540140-008
vi
Tables (continued)
Tables (continued)
Table 4-2. SPI Standard Definitions for Other Simple Tokens 4-2
Table 4-3. SPI Standard Definitions for Special Tokens 4-2
Table 4-4. SPI Standard Definitions for Token Types 4-2
Table 4-5. SPI Standard Definitions for Structures 4-3
Table 4-6. SPI Standard Definitions for Value Names 4-3
Table 4-7. EMS Standard Definitions for Header Tokens 4-4
Table 4-8. EMS Standard Definition for Data-Portion Tokens 4-4
Table 4-9. TMF Buffer Declarations 4-5
Table 4-10. TMF Private Token and Field Types 4-5
Table 4-11. TMF Predefined Token and Field Values 4-5
Table 5-1. TMF Commands, by Command 5-2
Table 5-2. TMF Commands, by Object 5-3
Table 6-1. TMP Event Messages 6-5
Table 6-2. TMFMON Event Messages 6-13
Table 6-3. Recovery Event Messages 6-13
Table 6-4. TMF Dump/Restore Event Messages 6-16
Table 6-5. TMF Catalog Event Messages 6-17
Table A-1. TMF Global Limits and Defaults A-1
Table A-2. Audit Trail Limits and Defaults A-1
Table A-3. Transaction Limits and Defaults A-2
Table A-4. Audit Dump and Online Dump Limits and Defaults A-3
Table A-5. Resource Manager Limits and Defaults A-3
Table A-6. Process Limits and Defaults A-3
Table A-7. Default Program File Names for Processes A-5
HP NonStop TMF Management Programming Manual—540140-008
vii
What’s New in This Manual
Manual Information
HP NonStop TMF Management Programming Manual
Abstract
This manual is for system and application programmers. It provides system-specific
information about the management programming interfaces to the HP NonStop™
Transaction Management Facility (TMF). These interfaces are based on the
Subsystem Programmatic Interface (SPI) and the Event Management Service (EMS).
They allow applications to send commands to, and monitor events reported by,
TMF 3.6.
Product Version
TMF H01
Supported Release Version Updates (RVUs)
This publication supports J06.03 and all subsequent J-series RVUs and H06.06 and all
subsequent H-series RVUs, until otherwise indicated by its replacement publications.
Document History
Part Number Published
540140-008 February 2013
Part Number Product Version Published
540140-003 TMF H01 April 2006
540140-004 TMF H01 May 2007
540140-005 TMF H01 February 2009
540140-006 TMF H01 August 2010
540140-007 TMF H01 February 2011
540140-008 TMF H01 Februrary 2013
What’s New in This Manual
HP NonStop TMF Management Programming Manual—540140-008
viii
New and Changed Information
New and Changed Information
Changes to the H06.26/J06.15 manual:
Added the following event messages event Messages:
531: ZTMF-EVT-BTN-Registered on page 6-452
532: ZTMF-EVT-BTN-NotRegistered on page 6-453
533: ZTMF-EVT-BTN-DeRegistering on page 6-454
534: ZTMF-EVT-BTN-DeRegistered on page 6-455
535: ZTMF-EVT-BTN-ImpExportFailed on page 6-456
Changes to the H06.22/J06.11 manual:
Updated the description of ZMaxPioPerBuffer on page 4-9.
Added the following event messages in Table 6-1, TMP Event Messages:
480: ZTMF-EVT-TransPerCpu-Exceeded on page 6-11
481: ZTMF-EVT-NetTrnsPerCpu-Xceeded on page 6-12
499: ZTMF-EVT-OldTransId on page 6-12
Added 480: ZTMF-EVT-TransPerCpu-Exceeded on page 6-447.
Added 481: ZTMF-EVT-NetTrnsPerCpu-Xceeded on page 6-448.
Added 499: ZTMF-EVT-OldTransId on page 6-451.
Changes to the H06.21/J06.10 Manual
Supported release statements have been updated to include J-series RVUs.
Added the following fields in the ZTMF-MAP-Alter-BeginTrans token of the
ALTER BEGINTRANS command:
ZThreshAutoIncrease
ZThreshLowerLimit
ZThreshIncrAmount
ZThreshNumberOfIncr
Added the following fields in the ZTMF-MAP-Info-BeginTrans token of the
INFO BEGINTRANS command:
ZThreshAutoIncrease
ZThreshLowerLimit
What’s New in This Manual
HP NonStop TMF Management Programming Manual—540140-008
ix
Changes to the H06.21/J06.10 Manual
ZThreshIncrAmount
ZThreshNumberOfIncr
Added new tokens in the following commands:
DUMP FILES on page 5-84
INFO DUMPS on page 5-116
RECOVER FILES on page 5-140
Added new tokens in the following event messages:
78: ZTMF-EVT-Tx-Abort-ProcFail on page 6-26
288: ZTMF-EVT-TransAutoAborted on page 6-297
295: ZTMF-EVT-TransHung on page 6-307
296: ZTMF-EVT-TransAbort on page 6-308
297: ZTMF-EVT-DownNode on page 6-309
Added the following event messages in Table 6-1, TMP Event Messages:
447: ZTMF-EVT-AbortTxNodeDownRev on page 6-11
475: ZTMF-EVT-TmpNet-UnSup-Msg on page 6-11
476: ZTMF-EVT-TmpNet-Msg-Drop on page 6-11
482: ZTMF-EVT-ThreshLowerLimXceeded on page 6-12
485: ZTMF-EVT-ATOVThresholdExceed on page 6-12
Added 447: ZTMF-EVT-AbortTxNodeDownRev on page 6-415.
Added 475: ZTMF-EVT-TmpNet-UnSup-Msg on page 6-445.
Added 476: ZTMF-EVT-TmpNet-Msg-Drop on page 6-446.
Added 482: ZTMF-EVT-ThreshLowerLimXceeded on page 6-449.
Added 485: ZTMF-EVT-ATOVThresholdExceed on page 6-450.
Added the following error numbers:
193 ZTMF-ERR-InvThreshAutoIncrease
194 ZTMF-ERR-InvThreshLowerLimit
195 ZTMF-ERR-InvThreshIncrAmount
196 ZTMF-ERR-InvThreshNumberOfIncr
What’s New in This Manual
HP NonStop TMF Management Programming Manual—540140-008
x
Changes in the earlier version of the Manual
Changes in the earlier version of the Manual
This is the third edition of the HP NonStop TMF Management Programming Manual. It
has been updated to support the H06.10 release version update (RVU) of the TMF
product and to correct and clarify elements in the previous edition. The changes are as
follows:
Section 4, Common Definitions
Altered the following token description:
ZTMF-TYP-TmpWaitTimer on page 4-9
Section 7, Error and Warning Messages
Altered the following error message description:
481 ZTMF-ERR-InvTmpWaitTimer on page 7-46
HP NonStop TMF Management Programming Manual—540140-008
xi
About This Manual
This manual provides subsystem-specific information about the management
programming interfaces to the HP NonStop Transaction Management Facility (TMF) on
HP NonStop servers. These interfaces are based on the Subsystem Programmatic
Interface (SPI) and the Event Management Service (EMS). They allow applications to
send commands to, and monitor events reported by, TMF.
This manual serves as both a reference manual and a programmer’s guide. It does the
following:
Explains the architecture of TMF and how a management application fits into that
architecture
Explains how to communicate with TMF through the TMFSERVE process
Provides management programming considerations for TMF
Gives a complete reference to the contents of all tokens, token and field values,
commands, responses, event messages, and error lists defined by TMF
To learn more about this manual, read the following topics:
Topic Page
Who Should Read This Manual xii
How This Manual is Organized xii
TMF Documentation xiii
Other Documentation xiv
Notation Conventions xiv
About This Manual
HP NonStop TMF Management Programming Manual—540140-008
xii
Who Should Read This Manual
Who Should Read This Manual
You should read this manual if you are an experienced application programmer in one
of the following categories:
A Transaction Application Language (TAL), C, C++, or COBOL85 programmer
writing applications that need to control or monitor TMF
A TACL user writing macros or routines that control or monitor TMF
To use this manual effectively, you should be familiar with the following subjects:
Basic NonStop system architecture
Programming for the HP NonStop OS
Programming using TAL, TACL, C, C++, or COBOL85
Reading declarations written in the Data Definition Language (DDL), as described
in the “Summary of DDL for SPI” appendix in the SPI Programming Manual.
The Distributed Systems Management (DSM) facilities
The tasks necessary for managing TMF
How This Manual is Organized
In this manual, Sections 1 through 3 give background information and programming
considerations, including the following:
The architecture of TMF and how a management application fits into it (Section 1)
The types of objects managed by TMF and the operations necessary to manage
these objects (Section 1)
The kinds of events reported by TMF (Section 1)
How to set up communications with TMF, including how to start the TMFSERVE
process (Section 2)
Programming considerations for management applications that manage TMF
(Section 3)
Sections 4 through 7 provide reference information, as follows:
Subsystem-specific information about tokens, token values, and related definitions
defined by other sources (such as SPI and EMS) and used by the DSM interfaces
to TMF (Section 4)
Descriptions of tokens, token values, and related definitions defined by TMF
(Section 4
)
Detailed descriptions of all programmatic commands that can be directed to TMF
and their corresponding responses from TMF (Section 5
)
About This Manual
HP NonStop TMF Management Programming Manual—540140-008
xiii
TMF Documentation
Detailed descriptions of all event messages than can be returned by TMF (Section
6)
Detailed descriptions of all error and warning messages than can be returned by
TMF (Section 7)
Appendix A, TMF Configuration Limits and Defaults provides summarizes various TMF
limits.
TMF Documentation
Readers of this manual might also wish to refer to documentation describing the TMF
product and other related products.
Documentation Description
TMF Introduction
Read this manual first. It provides a general overview of TMF concepts and
capabilities for business professionals, application designers and programmers,
and system managers and administrators.
TMF Glossary
For the technical terms used in the TMF documentation set, see this manual.
TMF Planning and Configuration Guide
Read this guide for information about how to plan, configure, and manage a TMF
environment. This guide also describes how to move your applications between an
earlier TMF product version and the current one.
TMF Operations and Recovery Guide
Read this guide for information about how to perform and monitor standard TMF
operations, obtain online and audit dumps, and respond to a variety of TMF
exception conditions.
Audience Title
All readers TMF Introduction
TMF Glossary
System managers
and operators
TMF Planning and Configuration Guide
TMF Operations and Recovery Guide
TMF Reference Manual
Application pro-
grammers
TMF Application Programmer’s Guide
TMF Management Programming Manual (This manual)
About This Manual
HP NonStop TMF Management Programming Manual—540140-008
xiv
Other Documentation
TMF Reference Manual
For information about how to use the TMFCOM command interface to TMF, see
this manual. This manual includes syntax, cautionary considerations, and
command examples for TMFCOM.
TMF Application Programmer’s Guide
Read this guide for information about how to design requester and server modules
to run in the TMF programming environment. Also read it for information about a
set of procedures that are helpful in examining the content of TMF audit trails.
Other Documentation
In addition to the TMFCOM command and SPI programmatic interfaces provided with
the TMF, several other software products and interfaces support limited TMF
operations. Details about the TMF functionality they provide appear in the manuals that
cover these products and interfaces:
HP NonStop Operating System Procedure Calls
HP Tandem Advanced Command Language (TACL)
HP NonStop SQL Relational Database Management System
HP NonStop Transaction Services (TS/MP)
HP NonStop TUXEDO
Distributed Systems Management/Software Configuration Manager (DSM/SCM)
Event Management Service (EMS)
File Utility Program (FUP)
Measure Subsystem
Pathway/TS
Surveyor Subsystem
Various programming languages, including COBOL85, Pathway SCREEN COBOL,
FORTRAN, TAL, Pascal, C, C++, and SQL (NonStop SQL implementation).
Notation Conventions
Hypertext Links
Blue underline is used to indicate a hypertext link within text. By clicking a passage of
text with a blue underline, you are taken to the location described. For example:
This feature is not configurable; if it causes transactions to be aborted that should
not be aborted, you must increase audit trail capacity as described in Increasing
Audit Trail Capacity.
About This Manual
HP NonStop TMF Management Programming Manual—540140-008
xv
Notation for Management Programming Interfaces
Notation for Management Programming Interfaces
UPPERCASE LETTERS. Uppercase letters indicate names from definition files; enter these
names exactly as shown. For example:
ZCOM-TKN-SUBJ-SERV
lowercase letters.
Words in lowercase letters are words that are part of the notation, including Data
Definition Language (DDL) keywords. For example:
token-type
Change Bar Notation
Change bars are used to indicate substantive differences between this edition of the
manual and the preceding edition. Change bars are vertical rules placed in the right
margin of changed portions of text, figures, tables, examples, and so on. Change bars
highlight new or revised information. For example:
The message types specified in the REPORT clause are different in the COBOL85
environment and the Common Run-Time Environment (CRE).
The CRE has many new message types and some new message type codes for
old message types. In the CRE, the message type SYSTEM includes all messages
except LOGICAL-CLOSE and LOGICAL-OPEN.
HP Encourages Your Comments
HP encourages your comments concerning this document. We are committed to
providing documentation that meets your needs. Send any errors found, suggestions
for improvement, or compliments to [email protected].
Include the document title, part number, and any comment, error found, or suggestion
for improvement you have concerning this document.
About This Manual
HP NonStop TMF Management Programming Manual—540140-008
xvi
HP Encourages Your Comments
/
