HP NonStop TMF Owner's manual

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