Version and Copyright Information Document Title XACI Command Reference Manual Abstract This document describes the user aspects of the command-line, administrative interface for XABroker. This interface is implemented as a library linked into the XABroker product and provides administration for XABroker. Product Version HP NonStop XACI v1.0 Supported Release Version Updates (RVUs) This publication supports J06.03 and all subsequent J-series RVUs and H06.
© Copyright 2010 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.
Computer Systems, Robert Elz. © 1980, 1981, 1982, 1983, 1985, 1986, 1987, 1988, 1989 Regents of the University of California.
XACI Command Reference Manual Next Version and Copyright Information Published May 2010 Table of Contents What's New in This Guide About This Guide Who Should Read This Guide? Document Structure Related Documents Abbreviations 1. Overview of XACI Command Reference Architecture Overview General Features and Functionalities 2.
Part Number 543716-002 Legal Notices
What's New in This Guide Prev Next What's New in This Guide Changes to the 543716-002 manual: ● Updated Security Requirement. ● Updated Command Objects. ● Updated Commands for the XABroker Object. ● Added Chapter 3, XACI Error Messages. Changes to the 543716-001 Manual This is a new manual, which describes the user aspects of the command-line, administrative interface for XABroker.
About This Guide Prev Next About This Guide Who Should Read This Guide? Document Structure Related Documents Abbreviations Who Should Read This Guide? This manual is intended for users who want to manage and administer the XABroker either interactively or by using batch files Document Structure This document is a set of linked HTML files (Web pages). Each file corresponds to the list described in the following table: Table 1.
Abbreviations API. application program interface EMS. Event Management Services JDBC. Java Database Connectivity MXCS. HP NonStop SQL/MX Connectivity Service OSS. Open System Services RVU. Release Version Update RM. Resource Manager SQL/MX. Structured Query Language/MX STM. Superior Transaction Manager TM. Transaction Manager TID. Local Transaction ID TMF. Transaction Management Facility XID. Global Transaction ID Prev What's New in This Guide Part Number 543716-002 Up Home Next Chapter 1.
Chapter 1. Overview of XACI Command Reference Prev Next Chapter 1. Overview of XACI Command Reference Architecture Overview General Features and Functionalities Architecture Overview The basic purpose of the XABroker Command Line Interface (XACI) is to process the commands that administer the XABroker. These commands manipulate the XABroker and its transactions for administrative needs. The target usage of XABroker will be through users of the MXCS.
Chapter 2. Command Summary Prev Next Chapter 2. Command Summary Overview User Interface Input command syntax rules Output report syntax notation and conventions Security requirement Command Objects Commands for the XABroker Object Commands for the XADef Object Commands for the XATrans Object Commands for the XASession Object Overview This section covers some common concepts for all commands and then defines the formal syntax of each supported command.
Input Command Syntax Rules The basic syntax rules for the XACI commands are: 1. Each command must end with a semi-colon. Tabs, white spaces, and new-lines may be used in a command to separate parameters. 2. Users of XACI are permitted to do only INFO type commands unless they are registered as super. super. 3.
For XABROKER: [[\system-name.]$XABroker-name] For XADEF: [[\system-name.]XA-index] For XATRANS: [[\system-name.]XAID-handle] For XASESSION: [[\system-name.]session-ID] \system-name is the name of the system where the target XABroker process is running. The default starts as the system where XACI is executing. This component is a system name data type, so must begin with a backslash. ● $XABroker-name is the name of the running XABroker process.
● Commands for the XABroker Object ● Commands for the XADef Object ● Commands for the XATrans Object ● Commands for the XASession Object Commands for the XABroker Object This object represents the XABroker process on the system. Only one XABroker process can be running per node because of TMF restriction and the process name is always $XABR. When the XABroker stops, the ACTIVE transactions are aborted automatically by TMF.
2 ------- ERROR + INFO + DEBUG The versioning is used for handshaking between two programs. If there is a new version of the XABroker with new interfaces and using the old application, the XABroker cannot use these new features and vice-versa. The version does not have any connections with the transactions. XACI>>INFO XABROKER $XABR; -- INFO XABROKER \NSK6.$XABR Report PName #ssns Transaction Statistics Commited Aborted H.
Example: XACI>> Alter XABroker \sys.$XABR, Conn 500, MsgLVL 1; -- ALTER XABR \SYS.$XABR Successful RUN XABROKER This command will run an already configured XABroker from the XACONFIG table with active flag set. The user has to set the Active Flag of the desired XABroker Configuration that has to be started using the Alter XADef command before using this command. This is a sensitive command (the user needs super privilege to execute this command) and “*” wild card is not supported.
is the name of the XABroker process to be terminated. Example: XACI>>Kill XABroker \sys.$XABR, reason ‘need to be restarted with new attributes’, after now; -- KILL XABR \SYS.$XABR Successful Commands for the XADef Object This object represents the definition of XACONFIG table. Each row has unique index to identify the XABroker configuration. To start the broker with a specific configuration, the active flag should be set to 1 and only one row can have active flag set to 1.
The following example displays the information about the XACONFIG table: XACI>>Info XADef \sys.*; -- INFO XADEF \SYS.* Report Ind PName Trans Cons MLVL Act DM Path 11 $XABR 100 100 2 1 RK_\CANCUN_$XABR /G/data01/XABR 129 $XABR 150 200 1 0 RK_\CANCUN_$XABR /G/system/XABR ADD XADEF This command adds a user-specified XABroker configuration(definition) to the XACONFIG table. This is a sensitive command (the user needs super privilege to execute this command) and “*” wildcard is not supported.
2 ------- ERROR + INFO + DEBUG active is the flag to identify which configuration/row from the table is active to start the broker. Only one row can have active set to ON. The default is OFF. Example: This example will add one row with XABroker configuration to the table: XACI>> Add XADef, Program XABR, Path /G/data01/XABR, DM BRK_sys.$XABR, Trans 1000, Conn 100, MsgLVL 2, active 0; -- ADD XADEF.
is the level of messages sent to EMS. There are three levels of messages. 1. ERROR_LVL = 0 2. INFO_LVL = 1 3. DEBUG_LVL = 2 0 ------- ERROR messages sent to $0 1 ------- ERROR + INFO 2 ------- ERROR + INFO + DEBUG active is the flag to identify which configuration/row from the table is active to start the broker. Only one row can have active set to ON and the default is OFF.
identify. This will avoid the trouble of typing the complete XID as this might be very long; State attribute is optional. The default is to display all states. With the state option, the user can specify the transactions in prepared, active, or heuristically completed transactions. This is not a sensitive command and “*” wild card is supported. INFO XATRANS obj-name[,detail][,state]; The obj-name can be: [[\system-name.]XAID_HANDLE|*] DETAIL is a flag requesting all attributes.
RESOLVE XATRANS obj-name[,action {commit|rollback}][,only {prepared|active}], reason tex[,after{now/idle}]t; The obj-name can be: [[\system-name.]XAID_HANDLE|*] action is the option to commit or rollback a transaction. only is the option to resolve prepared or active transaction REASON text text is a nonempty string literal up to 70 characters explaining why the transaction is being resolved . This will be written to the EMS collector if the command is accepted.
INFO XASESSION obj-name; The obj-name can be: [[\system-name.]SID|*] SID is the session ID of this connection. Example: The following commands will display the information of specific session. The server is the process name of the MXCS server that started the session. StartTime is the time stamp when the connection was established. XACI>> Info XASession \sys.200; -- INFO XASESSION \SYS.200 SID ----200 Server Prepared Active H.
The following commands will close the specific session ID: XACI>> Kill XASession 123456, reason ‘dis’, after now; -- Kill XASession 123456 Successful Prev Chapter 1. Overview of XACI Command Reference Part Number 543716-002 Up Home Next Chapter 3.
Chapter 3. XACI Error Messages Prev Next Chapter 3. XACI Error Messages About the Message Format This section lists the error messages generated by XACI in numerical order. The error description includes the following: ● ERRORCODE Message text. ● Cause Reason that triggered the error message. ● Effect Result of the problem that occurred. ● Recovery Diagnosis and solution to the problem. 1500 User Unprivileged to perform this Operation. Cause.
Effect. The XACI command fails. Recovery. Enter a valid XA Handle. 1504 Cannot Alter Active Flag When Broker is Running. Cause. You attempted to alter the Active Flag of the XAConfiguration when XABroker is running using the XACI command. Effect. The XACI command fails. Recovery. Stop XABroker before altering the Active Flag of the XAConfiguration. 1505 Only One Configuration Can Be Active Configuration with handle is Active. Cause.
Cause. You attempted to delete the active XABroker configuration using the XACI command. Effect. The XACI command fails. Recovery. Deactivate the XABroker configuration before deleting it. 1510 Reason String is Mandatory. Cause. You attempted to use a KILL or Resolve XATrans command without a reason string. Effect. The KILL or Resolve XATrans command fails. Recovery. Enter a reason string while using the KILL XABROKER, KILL XASESSION, and Resolve XATrans commands. 1511 XABROKER Is Not Running. Cause.
1515 Session is Non-existent. Cause. The session you specified in the XACI command does not exist. Effect. The XACI command fails. Recovery. Enter a valid Session ID. 1516 Broker Process Already Running. Cause. You attempted to start XABroker using the XACI command when it is already running. Effect. The XACI command fails. Recovery. Stop the XABroker and then restart it. Do not start XABroker when one instance of XABroker is already running. 1517 SQL/MX Error Returned from DataBase.
Recovery. Prepare the transaction before commit. 1521 Unsupported Feature - STOP SESSION WHEN IDLE. Cause. The STOP SESSION command includes the after attribute with the IDLE option. Effect. An unsupported feature error is reported. Recovery. Remove the after attribute and the IDLE option from the STOP SESSION command. 1522 Expecting one of the Commands: ADD, ALTER, DELETE, INFO, RUN, RESOLVE, KILL. Cause. An invalid command is entered. Effect. The command fails. Recovery. Enter a valid command.
Recovery. Enter a valid Session ID. 1527 Transaction ID Required. Cause. The specified XACI command does not include a Transaction ID. Effect. The XACI command fails. Recovery. Enter a valid Transaction ID. 1528 Cannot Resolve transaction . Cause. The rollback transaction fails while executing the XACI command. Effect. The XACI command fails. Recovery. None. 1529 Object Type Invalid. Cause. An XACI command includes an invalid object type. Effect. The XACI command fails. Recovery.
Recovery. None. 1533 Quoted String in Command is Invalid. Cause. The quoted string in the XACI command is invalid or empty. Effect. The XACI command fails. Recovery. Enter a valid reason string. Prev Chapter 2.
Glossary Prev Glossary A|B|C|D|E|F|G|H|I|J|K|L|M|N|O|P|Q|R|S|T|U|V|W|X|Y|Z A API See application program interface (API). application program interface (API) A set of services (such as programming language functions or procedures) that are called by an application program to communicate with other software components. For example, an application program in the form of a client might use an API to communicate with a server program. B There are no entries for this section.
A Distributed Systems Management (DSM) productthat provides event collection, event logging, and event distribution facilities. EMS provides different event descriptions for interactive and programmatic interfaces, lets an operator or an application select specific event-message data, and allows for flexible distribution of event messages within a system or network. F There are no entries for this section. G gtrid Global Transaction Identifier.
● A file access system (FAP). Typically, a FAP does not support a transactional model; however enscribe does support the local transaction model. S Superior Transaction Manager (STM) A trasaction manager that performs all coordination between the TMs supporting the global transaction. System A system in NonStop terms is a set up to 16 CPUs that have the same expand network address.
contains information such as XA_ID, XA_ProcessName, XA_ProgramName, XA_OssPath XA_DomainName, XA_MaxTransactions, XA_MaxConnections, and XA_MsgLevel XA_Active. Y There are no entries for this section. Z There are no entries for this section. Prev Chapter 3.
