Table of Contents

Advertisement

Quick Links

Reliable Transaction Router

System Manager's Manual
Order Number: AA-Q88CE-TE
June, 1999
This manual describes how to configure, manage and monitor Reliable
Transaction Router, Version 3.2 (RTR).
Revision/Update Information:
Software Version:
Compaq Computer Corporation
Houston, Texas
This manual supersedes Version 3.1D
of the System Manager's Manual
Reliable Transaction Router, Version
3.2

Advertisement

Table of Contents
loading

Summary of Contents for Compaq AA-Q88CE-TE

  • Page 1: Reliable Transaction Router

    Reliable Transaction Router System Manager’s Manual Order Number: AA-Q88CE-TE June, 1999 This manual describes how to configure, manage and monitor Reliable Transaction Router, Version 3.2 (RTR). Revision/Update Information: Software Version: Compaq Computer Corporation Houston, Texas This manual supersedes Version 3.1D of the System Manager’s Manual...
  • Page 2 The software may be used or copied only in accordance with the terms of the agreement. Compaq and the Compaq logo are registered in the United States Patent and Trademark Office. The following are trademarks of Compaq Computer Corporation: AlphaGeneration, AlphaServer,...
  • Page 3: Table Of Contents

    Preface ............1 Introduction Getting Started .
  • Page 4 Life Cycle of a Partition ........3.3.1 Implicit Partition Creation .
  • Page 5 5.2.14 Monitor IPCRATE ........5.2.15 Monitor Journal .
  • Page 6 DISPLAY BAR ..........DISPLAY NUMERIC .
  • Page 7 STOP RTR ..........TRIM FACILITY .
  • Page 8 Figures 2–1 Configuration Example ........2–2 Extend Configuration Example .
  • Page 9 A–3 Arithmetic Operators in Display Commands ....A–4...
  • Page 11: Preface

    Purpose of this Manual This manual describes how to configure, manage and monitor the operation of Reliable Transaction Router (RTR) using the RTR Command Line Interface (CLI). Intended Audience The System Manager’s Manual is intended for persons who perform system management functions to configure, test, monitor and maintain RTR applications.
  • Page 12: Related Documentation

    • Application Design Guide • Migration Guide Reader’s Comments Compaq welcomes your comments on this manual. Please send us your comments by email to rtrdoc@compaq.com Include the title of the manual, section and page numbers with your comments or suggestions.
  • Page 13: Conventions Used In This Guide

    Table 1 Conventions Used in this Guide Convention Meaning UPPERCASE Some operating systems differentiate between lowercase and lowercase uppercase characters. For these systems, examples, syntax descriptions, function definitions, and literal strings that appear in text must be typed exactly as shown. Commands typed to the RTR CLI are not case sensitive unless enclosed in quote marks A number sign ( # ) is the default operating system superuser prompt.
  • Page 15: Introduction

    For a general introduction to Reliable Transaction Router, Version 3.2 (RTR), you should read the introductory chapter in the Reliable Transaction Router Application Design Guide. Additional information about the Reliable Transaction Router is available in the Reliable Transaction Router Application Programmer’s Reference Manual.
  • Page 16: Online Help

    Introduction 1.2 Entering Commands or, when several commands are to be entered at the RTR prompt: % rtr RTR> start rtr RTR> create journal For convenience, the user prompt for the operating system is shown here as the ‘‘%’’ symbol. Your system may have a different prompt. The RTR CLI accepts commands that you type and can process procedures consisting of RTR commands.
  • Page 17: Command Procedures

    where error-identification The following sequence returns an error message, explained by the % rtr RTR> start rtr %RTR-F-RTRALRSTA, rtr already started RTR> help errors rtralrsta Errors RTRALRSTA RTR already started Explanation: RTR was already running when the "START RTR" command was executed.
  • Page 18 Introduction 1.5 Remote Commands This command starts RTR on the three nodes. The /CLUSTER and /NOCLUSTER command qualifiers refer to cluster support. These qualifiers are for operating systems that fully support clustering. Use of the /CLUSTER qualifier on systems that do not have clustering causes the relevant command to be executed on the local node only.
  • Page 19: Starting And Setting Up Rtr

    This chapter describes how to configure and start an RTR environment. Recovery journals, router load balancing and call-out servers are also discussed. 2.1 Introduction Before RTR applications can run, RTR must be started and the application’s must be defined on each node of the application’s environment. This facility is done by issuing the participating node.
  • Page 20: Local Configuration Of Each Node

    Starting and Setting Up RTR 2.2 Setting Up—An Example Figure 2–1 Configuration Example F r o n t e n d s ( F E ) F E 1 F E 2 F E 3 In this example, the application client processes run on the nodes FE1, FE2 and FE3.
  • Page 21: Creating A Recovery Journal

    Example 2–2 illustrates how to use RTR remote commands to start the same configuration. The commands to a number of RTR nodes. Example 2–2 Remote Setup from one Node % rtr RTR> set environment/node= - _RTR> (FE1, FE2, FE3, TR1, TR2, BE1, BR2, BR3) RTR>...
  • Page 22: Changing A Facility

    Starting and Setting Up RTR 2.3 Creating a Recovery Journal • The operator should move any duplicate copies of journal files to a location other than the see only the one it created. • Track duplicate copies of journal files in the log file to prevent RTR seeing more than the one it created and issuing the SPUJOUFIL error message.
  • Page 23: Reconfiguration Using Delete And Create Facility

    Example 2–3 Reconfiguration Using Delete and Create Facility % rtr RTR> stop rtr/node=FE3 RTR> delete facility funds_transfer/node=TR2 RTR> create facility funds_transfer/node=TR2 - _RTR> _RTR> RTR> delete facility funds_transfer/node=TR1 RTR> create facility funds_transfer/node=TR1 - _RTR> _RTR> RTR is stopped on node FE3, the node being excluded from the network. In order to prevent transactions being interrupted or aborted, application processes should be stopped in an orderly manner before issuing the ’stop rtr’...
  • Page 24: Extend Configuration Example

    Starting and Setting Up RTR 2.4 Changing a Facility Figure 2–2 Extend Configuration Example F R O N T E N D S F E 1 F E 2 F E 3 F E 4 All backend nodes must be informed when router configurations are changed. Because TR3 will be a router for the FE3 and FE4 frontends, these nodes must also be informed of its presence.
  • Page 25: Reconfiguration Using Extend Facility

    Example 2–4 Reconfiguration Using Extend Facility % RTR RTR> start rtr /node=(TR3,FE4) RTR> set environment/node= - _RTR> (FE1,FE2,FE3,TR1,TR2,BE1,BE2,BE3,TR3,FE4) RTR> extend facility funds_transfer - _RTR> /router=TR3/frontend=(FE3,FE4) - _RTR> /backend=(BE1,BE2,BE3) RTR> extend facility funds_transfer - _RTR> /router=TR1/frontend=FE4 set environment the facility, including the new nodes. extend facility Because the new router is also connected to the existing frontend FE3, this node must also be specified as a frontend.
  • Page 26: Configuration Of Callout Servers

    Starting and Setting Up RTR 2.5 Setting up Callout Servers Example 2–5 Configuration of Callout Servers % rtr RTR> set environment/node= - _RTR> (FE1,FE2,FE3,TR1,TR2,BE1,BE2,BE3) RTR> start rtr RTR> create facility funds_transfer/frontend=(FE1,FE2,FE3) - _RTR> _RTR> _RTR> 2.6 Router Load Balancing Router load balancing, or intelligent re-connection of frontends to a router is possible, allowing a frontend to select the router that has least loading.
  • Page 27: Rtr Privileges

    • /balance only to enable RTR Version 2 balancing. Use this qualifier only when you are connecting frontend nodes running RTR Version 2. See CREATE FACILITY and SET FACILITY for more information on • Commands to set/show load balancing are: create facility /balance Enables load balancing attribute on the executor node Significant only on router and frontend nodes...
  • Page 28: Rtr Acp Virtual Memory Sizing

    RTR ACP process is using. Compaq strongly recommends that you allocate as much virtual memory as possible. While there is no penalty for allocating more virtual memory than is used, the result of allocating too little can be catastrophic.
  • Page 29 • Add the size of all messages 2. For each transaction router: • Allow one Kbyte for each active transaction 3. For each back end: • Allow one Kbyte per active transaction • Allow fifty bytes for each message of a transaction •...
  • Page 30: Unix Virtual Memory Sizing

    The following are the minimum limits for the ACP on the following UNIX platforms: • On Compaq Tru64 UNIX: A minimum of 1024 open file descriptors A minimum of 1073742 Kbytes for virtual memory address space A minimum of 268436 Kbytes for a single file size A minimum of 419430 Kbytes for heap data segment sizing A minimum of 33555 Kbytes for core file size...
  • Page 31: Network Transports

    A minimum of 419430 Kbytes for heap data segment sizing A minimum of 33555 Kbytes for core file size A minimum of 8389 Kbytes for stack segment size A minimum of 0 for CPU time • On HPUX: A minimum of 1024 open file descriptors The START RTR qualifiers /LINK and /PROCESSES apply only to the OpenVMS platform and the determination of process quotas on UNIX platforms must be done through operating system handling of virtual memory sizing.
  • Page 32: Using Rtr With Dhcp And Internet Tunnels

    Valid wild card characters are ‘‘*’’, ‘‘%’’ and ‘‘?’’. The result of using a wild card character at facility configuration time is the creation of a template link. When operating RTR in conjunction with the Compaq Internet Personal Tunnel, a client system outside of the corporate firewall uses tunnel software to obtain a secure channel from the Internet to inside the corporate domain.
  • Page 33: Interoperation With Rtr Version 2 Using Decnet

    If the RTR V3 frontend fails to connect with the RTR V2 router node, then you can make a basic check by executing a OpenVMS router node. If this fails, consult your Network Manager. (For Compaq Tru64 UNIX machines, ensure that the DECnet library is installed as /libdna.so...
  • Page 34: Network Protocol Selection On Openvms

    If the value of the logical RTR_PREF_PROT is changed, the new value takes effect only after RTR has been restarted. • Reliable Transaction Router Version 3.2 for OpenVMS can use either Compaq TCP/IP Services for OpenVMS or TCPware Version 5.1 as the TCP/IP transport layer.
  • Page 35: Customizing The Rtr Windows Nt Service

    2.11.1 Customizing the RTR Windows NT Service While starting RTR, the Service looks for the file directory. On finding the file, the Service executes any RTR commands it may contain. RTR commands from From the point of view of the Service, the RTR home directory is found in the system-level environment variable the directory from which the Service was executed.
  • Page 36: How Rtr Selects Processing-States (Roles) For Nodes

    Starting and Setting Up RTR 2.12 How RTR Selects Processing-states (Roles) for Nodes 2.12 How RTR Selects Processing-states (Roles) for Nodes This section discusses how RTR assigns roles to backend node partitions, and how routers are selected. 2.12.1 Role Assignment for Backend Node Partitions RTR assigns a primary or secondary processing state to a partition (or a key- range definition), consisting of one or more server application channels, which may or may not share a common process.
  • Page 37 2.12 How RTR Selects Processing-states (Roles) for Nodes The SHOW PARTITION command on each backend node is as follows: Backend partitions on node BRONZE in group "test" at Mon Mar 22 14:52:32 1999 Partition name: Facility: RTR$DEFAULT_FACILITY Low bound: Active servers: Transaction presentation: active Active transaction count:...
  • Page 38 Starting and Setting Up RTR 2.12 How RTR Selects Processing-states (Roles) for Nodes 8. The network connection to node Gold is reestablished. The partition on Gold retained its original sequence number of 2 and retains the primary role while the partition on Bronze reassumes the secondary role. Alternately, the roles of backend nodes can be specifically assigned with the /PRIORITY_LIST qualifier to the SET PARTITION command.
  • Page 39: Router Selection

    2.12 How RTR Selects Processing-states (Roles) for Nodes Router If the relative priority (sequence number) for Node-A2 is changed to four it still becomes the primary active server if Node-A1 fails because the failover policy indicates a fail_to_standby requirement for this facility. SET PARTITION test/PRIORITY_LIST=(Node-A1,Node-B1,Node-B2,Node-A2) After issuing this command the router partition appears as follows.
  • Page 40 Starting and Setting Up RTR 2.12 How RTR Selects Processing-states (Roles) for Nodes relevant to a backend. It is where the backend goes to obtain and verify partition configuration and facility information. Routers are made known to the frontend systems through the list specified in the /ROUTER=(list) qualifier to the CREATE FACILITY command.
  • Page 41: Partition Management

    3.1 Overview This section describes the concepts and operations of RTR’s partitions. 3.1.1 What is a Partition? Partitions are subdivisions of a routing key range of values. They are used with a partitioned data model and RTR data content routing. Partitions exist for each distinct range of values in the routing key for which a server is available to process transactions.
  • Page 42: Partition Naming

    Partition Management 3.2 Partition Naming 3.2 Partition Naming A prerequisite for partition management is the ability to identify a partition in the system that is to be the subject of management commands. For this purpose, partitions have been given names, which may be drawn from a number of sources described below.
  • Page 43: Implicit Partition Creation

    3.3.1 Implicit Partition Creation Partitions are created implicitly when an application program calls rtr_open_channel( ) and value ranges for the segments with the attributes are established with the the only way in which partitions could be created. Partitions created in this way are automatically deleted when the last server channel to the partition is closed.
  • Page 44: Entering Partition Commands

    Partition Management 3.5 Entering Partition Commands 3.5 Entering Partition Commands Partitions can be managed by issuing partition commands directed at the required partition after they are created. Partition commands can be entered in one of two ways: • A command line processed by the RTR command line interface, for example RTR>...
  • Page 45: Managing Partitions

    rtr_set_info( ) successful, completion will be signaled by the delivery of an RTR message of type rtr_mt_closed argument. The programmer should retrieve this message by pchannel using rtr_receive_message( ) rtr_status_data_t accessed as the status field of the message data. 3.6 Managing Partitions To manage partitions a set of commands or program calls are used.
  • Page 46: Controlling Transaction Presentation

    Partition Management 3.6 Managing Partitions 3.6.2 Controlling Transaction Presentation Transaction presentation is the process of passing transactions to idle server channels for processing. While transaction presentation is active, new transactions are started on the first free server channel for the appropriate partition.
  • Page 47: Command Line Example

    If a partition enters a wait state or fails but has neither a local or remote journal, an operator can instruct RTR to skip the current step in the recovery process with the /IGNORE_RECOVERY recovery cycle use it with caution in cases where availability above consistency in application databases is desired.
  • Page 48: Programming Information

    Partition Management 3.6 Managing Partitions 3.6.4.2 Programming Information To set the partition backend priority list, program the of the rtr_set_info( ) rtr_qualifier_value_t char *szNodeList = "your,list,of,node,names,here" set_qualifiers[ 0 ].qv_qualifier = rtr_partition_be_priority_list; set_qualifiers[ 0 ].qv_value = &szNodeList; set_qualifiers[ 1 ].qv_qualifier = rtr_qualifiers_end; set_qualifiers[ 1 ].qv_value = NULL;...
  • Page 49: Controlling Transaction Replay

    • rtr_partition_fail_to_shadow • rtr_partition_pre32_compatible 3.6.6 Controlling Transaction Replay RTR has implemented the capability of controlling transaction replay in cases where a "killer message" happens during a transaction replay preventing recovery from continuing normally. A "killer message" presents a situation where server availability is lost because of the presence of a message capable of causing repeated server application failure during recovery.
  • Page 50: Displaying Partition Information

    Partition Management 3.7 Displaying Partition Information 3.7 Displaying Partition Information Information on the definition and state of a partition is displayed with the SHOW PARTITION command. The information of interest in the context of partition management relates to the backend instance of the partition. For more information see the SHOW PARTITION command in Chapter 6.
  • Page 51: Transaction Management

    4.1 Overview This section describes the concepts of RTR’s transaction management capability. The RTR transaction is the heart of an RTR application, and transaction state is the property that characterizes a transaction’s current condition. Whenever a transaction progresses from one stage to another, the transaction state is updated to reflect a transaction transition.
  • Page 52: Command Line Examples

    Transaction Management 4.1 Overview this transaction is removed from memory and can no longer be monitored by the command. The RTR DUMP JOURNAL transaction. The RTR journal saves all of the information about a transaction, its transaction journal state, the transaction messages (records) received from the RTR client, and the content of a message sent to the server.
  • Page 53: Transaction State Changes

    4.1.2 Transaction State Changes There are eight valid state changes allowed for the Attempting to change transaction state to a state that is not allowed produces an error message of state to the specified state changes. Table 4–19 Valid Transaction State Transitions Current State COMMIT SENDING...
  • Page 54 Transaction Management 4.1 Overview This is the case where, for example, a server crashed while performing an SQL commit immediately after receiving a transaction is in COMMIT state as recorded in the RTR journal and the transaction is also committed in the underlying database. After the SET TRANSACTION be used to verify the result.
  • Page 55: Rtr Monitoring

    This chapter contains a description of the RTR monitor. The RTR monitor gives you a means of viewing the activities of RTR and your applications. Many different aspects of RTR’s behaviour can be viewed, allowing the activities and performance of RTR to be analyzed. 5.1 Introduction The RTR monitor provides a means to continuously display the status of RTR and the applications using it.
  • Page 56 RTR Monitoring 5.2 Standard Monitor Pictures Obsolete monitor pictures have been removed from the documentation. Table 5–1 Standard Monitor Pictures Picture name Description accfail Shows link transport name for links on which a connection attempt was declined, with a reason for failure. The most recent entry is highlighted. acp2app Displays counts of messages and number of bytes from RTRACP to the application, as viewed from a specific node.
  • Page 57 Table 5–1 (Cont.) Standard Monitor Pictures Picture name Description jcalls Displays counts of successful (success), failed (fail) and total journal calls for local and remote journals. journal Displays the current journal usage on a node. Local node journal statistics are provided, and data for non-local journals accessed from the local node.
  • Page 58: Monitor Accfail (Link Acceptance Failures)

    RTR Monitoring 5.2 Standard Monitor Pictures Table 5–1 (Cont.) Standard Monitor Pictures Picture name Description traffic Displays a list of the links to other nodes. Shown for each link are: byte rate, packet rate, message rate and congestion, in both directions. Average packets per second is also shown.
  • Page 59: Monitor Acp2App

    your domain name, depending on how the name is entered in either your local hosts file or name server. DECnet-Plus systems may yield both a pseudonym and a link name; both are checked for a match with a template. • RTR_STS_FACNOTDEC - "facility name not matched"...
  • Page 60: Monitor Active

    RTR Monitoring 5.2 Standard Monitor Pictures 5.2.3 Monitor Active ACTIVE TRANSACTIONS BY PROCESS Fri Mar 12 1999 19:32:41 All processes: Node NodeA 11141 Displays a list of RTR processes, and for each process the number of transactions they have started, the number of transactions they have completed and the number of transactions still active.
  • Page 61: Monitor Calls

    5.2.6 Monitor Calls RTR api calls, Node: nodea.zuo.dec.com , PID: 2162 Image: -ALL- CALLS open_channel close_channel start_tx send_to_server reply_to_client prepare_tx accept_tx reject_tx broadcast_event set_user_handle get_tid request_info set_info error_text set_wakeup receive_message user wakeup Displays the total number of RTR API calls and their outcome for the processes on all the nodes being monitored.
  • Page 62: Monitor Event

    RTR Monitoring 5.2 Standard Monitor Pictures Displays the link protocol for connected links, and the fail reason as a text message for any links on which a connection has failed. Unconnected links where connection have been attempted are highlighted. Link state and architecture of the remote node are also displayed.
  • Page 63: Monitor Flow

    5.2.11 Monitor Flow FLOW CONTROL COUNTERS 7-JAN-1999 14:08:06, NODE: -ALL- , FACILITY: -ALL- CREDIT ROLE AVAILABLE FE=>TR 15000 TR=>BE 15000 BE=>TR TR=>FE 15000 LINK DATA RATE NODEA =>NODEA NODEA =>NODEB NODEB =>NODEB NODEB =>NODEA Displays the flow control internals. 5.2.12 Monitor Group % rtr monitor group Concurrency Measures krid...
  • Page 64: Monitor Ipc

    RTR Monitoring 5.2 Standard Monitor Pictures 5.2.13 Monitor IPC RTR> Monitor IPC Node: LENGTH +----------------------------------------------------------------------------+ This screen displays usage information on IPC messages, byte counts and IO primitives. Display units are counts, kbytes and calls respectively. +----------------------------------------------------------------------------+ | - - - - - O u t g o i n g / s - - - - | - - I n c o m i n g / s - -| Process Messages ...kbytes rtracp...
  • Page 65: Monitor Link

    Displays information about journal usage, including total number of entries and records written, number of records read, and how many bytes were involved. Bar graphs showing current usage of journal blocks (as a percentage of the total) are also provided. The local journal figures refer to journal usage for the displayed node.
  • Page 66: Monitor Netstat

    RTR Monitoring 5.2 Standard Monitor Pictures 5.2.18 Monitor Netstat C o n n e c t i o n Node: NODEA Ini Cnf Acc Abo Rej Loss Gain Ctmo Rstr State Type FailCode Node Link NODEA ->nodeb NODEA ->nodec NODEA ->noded NODEA ->nodee Displays the link status for connected links in detail and the fail code for any links on which a connection has failed.
  • Page 67: Monitor Queues

    Table 5–3 (Cont.) Monitor Partition States State active pri_act sec_act remember 5.2.20 Monitor Queues TRANSACTION QUEUES BY PARTITION 15-JAN-1999 12:42:53, NODE: NODEA Partition-name NODEA$NODEB$16842753 Shows transaction queues on a partition basis. Uses counters from Transaction Manager (TM) and the Requester/Server configurator (RSC). 5.2.21 Monitor Quorum QUORUM STATUS BY NODE AND FACILITY Tue Apr 6 1999 10:50:24, NODE: NODEA (node/role counts can be inaccurate for incorrectly configured facilities)
  • Page 68: Monitor Rejects

    RTR Monitoring 5.2 Standard Monitor Pictures Server recovery state meanings are shown in Table 5–4. Table 5–4 Monitor Recovery States State wt_tr_ok wt_quorum lcl_rec lcl_rec_fail lcl_rec_icpl lcl_rec_cpl shd_rec shd_rec_fail shd_rec_icpl shd_rec_cpl catchup standby active pri_act sec_act remember 5.2.23 Monitor Rejects NODE: NODEA Time -------------------...
  • Page 69: Monitor Rejhist

    5.2.24 Monitor Rejhist NODE: NODEA Time ------------------- Mon Mar 15 18:06:06 Mon Mar 15 18:06:41 Mon Mar 15 18:06:41 ------------------------------------------------------------------------------- Displays the last ten This picture should always be invoked with the /ID qualifier. The transaction identifier associated with the rejected transaction can be displayed with the SHOW PROCESS <...
  • Page 70: Monitor Rolequorum

    RTR Monitoring 5.2 Standard Monitor Pictures 5.2.26 Monitor Rolequorum QUORUM COUNTS BY FACILITY 7-JAN-1999 14:32:48, NODE: -ALL- Router View of backends CNF RCH QRT CNF RCH QRT CNF RCH QRT CNF RCH QRT 5.2.27 Monitor Routers ROUTER TRANSACTION COUNTERS AT 14:33:29 7-JAN-1999 Node: -ALL- Facility: -ALL-...
  • Page 71: Monitor Rscbe

    5.2.29 Monitor RSCBE RTR> Monitor rscbe Most Recent RSC Dclsrv Calls History on Backend LENGTH Thu Mar 4 1999,15:19:41 Key Range Id: 16777216 Image Name: RTR.EXE T-delta RSC calls 0 send_dcl_to_master sfranc 1 recv_status_ok 1 send_dcl_to_master sfranc 1 recv_status_ok 1 send_dcl_to_master sfranc 1 recv_status_ok 1 send_dcl_to_other 1 recv_status_ok...
  • Page 72: Monitor Stalls

    RTR Monitoring 5.2 Standard Monitor Pictures 5.2.31 Monitor Stalls NETWORK STALLS AT 29-JAN-1999 15:35:03, ON NODE: TR1 Total TR1 -> TR1 TR1 -> FE2 TR1 -> BE1 TR2 -> TR2 TR2 -> BE1 FE1 -> FE1 FE1 -> FE2 FE1 -> BE1 FE2 ->...
  • Page 73: Monitor System

    5.2.32 Monitor System Resource Facility QUORUM states... JOURNAL free space... x Link CONNECTS... Link traffic STALLS... x FLOW control credits... x PARTITION states... x CALL Msg outstanding... Transaction QUEUES... x Transaction REJECTS... x Broadcast EVENT discards... x Displays the state of critical resources within the RTR environment. If a resource has exceeded a predefined threshold, a warning indicator is displayed.
  • Page 74: Monitor Tps

    RTR Monitoring 5.2 Standard Monitor Pictures 5.2.33 Monitor TPS TRANSACTION COMMITS BY PROCESS 14:37:23 7-JAN-1999 Node -ALL- 00000000 -REQUESTERS- -ALL- 00000000 -SERVERS- NODEA 20200BEA RTRACP NODEA 20200C03 ANDERS_1 NODEB 21400724 RTRACP NODEB 214005F0 ANDERS_1 Same as TOPTPS except that a given process is always displayed at the same position on the screen, that is, the list is not sorted by TPS.
  • Page 75: Monitor V2Calls

    5.2.36 Monitor V2CALLS RTR> Monitor V2CALLS RTR system service calls, Node: NODEA , PID: 00000000, Process name: -ALL- Image: -ALL- dcl_tx_prc/server dcl_tx_prc/req. dcl_tx_prc/shut. start_tx start_tx /timeout enq_tx enq_tx /broadcast enq_tx /reply deq_tx deq_tx /reply commit_tx abort_tx vote_tx /commit vote_tx /abort vote_tx /forget Displays RTR Version 2 calls when running RTR Version 2 or mixture of RTR Version 3 and 2 environment.
  • Page 77: Rtr Command Line Interface

    Each RTR API call can be invoked This is provided to facilitate testing. For example, clients may be tested before the corresponding servers have been written by manually entering the server’s API calls. 6.1 Introduction The commands that invoke the RTR API calls are similar to the call names. For example, the rtr_accept_tx( ) CLI-level.
  • Page 78: Add Facility

    ADD FACILITY ADD FACILITY See CREATE FACILITY; ADD FACILITY is retained for compatibility reasons only. 6–2 RTR Command Line Interface...
  • Page 79: Parameters For Rtr_Accept_Tx

    CALL RTR_ACCEPT_TX The CALL RTR_ACCEPT_TX command causes a command server to execute rtr_accept_tx( ) Format CALL RTR_ACCEPT_TX Command Qualifiers /CHANNEL_NAME=channel-name /CLUSTER /FORGET /INDEPENDENT /NODE[=node-list] /OUTPUT[=file-spec] /REASON[=reason] Description The CALL RTR_ACCEPT_TX command causes a command server to call the rtr_accept_tx( ) The numeric status returned from the call is then converted to its textual representation and displayed.
  • Page 80 CALL RTR_ACCEPT_TX Qualifiers /CHANNEL_NAME=channel_name /CHANNEL_NAME=RTR$DEFAULT_CHANNEL Specifies the channel for which the operation is to be performed. The command server uses a combination of the channel_name and the window from which the call was issued to uniquely identify which channel to use. channel_name is not case sensitive.
  • Page 81: Call Rtr_Accept_Tx

    Related Commands • CALL RTR_OPEN_CHANNEL • CALL RTR_REJECT_TX Examples Accept the current transaction with a reason of 42. RTR> CALL RTR_ACCEPT_TX /REASON=42 %RTR-S-OK, normal successful completion CALL RTR_ACCEPT_TX RTR Command Line Interface 6–5...
  • Page 82 CALL RTR_BROADCAST_EVENT CALL RTR_BROADCAST_EVENT The CALL RTR_BROADCAST_EVENT command causes a command server to execute the rtr_broadcast_event( ) Format CALL RTR_BROADCAST_EVENT [message-field1] [,message-field2...] Parameters [message-field1] [,message-field2...] Specify the message to be sent (if any) as one or more comma separated parameter values. You can use the /TYPE_OF_DATA and /LENGTH_OF_DATA positional qualifiers on each parameter value to specify the data type and length of each field.
  • Page 83: Call Rtr_Broadcast_Event

    Table 6–2 Parameters for rtr_broadcast_event C Parameter Name C Parameter Value channel flags RTR_NO_FLAGS pmsg, msglen, msgfmt evtnum rcpspc "workstat*" pmsg msglen The actual values used for command line parameter. The command server uses message data specified as command line parameter values to generate a record containing the message data (for the the message length (for the parameter).
  • Page 84: Generated Format Strings

    CALL RTR_BROADCAST_EVENT Table 6–3 Generated Format Strings Data Type STRING SIGNED SIGNED SIGNED UNSIGNED UNSIGNED UNSIGNED Refer to Application Programmer’s Reference Manual, section ‘‘Defining a Message Format Description’’ for information on constructing a parameter. /LENGTH_OF_FIELD=field-length Enter the size of the message field that you want to define. The default for string types is the length of the message entered, plus one (for the zero termination byte).
  • Page 85 RTR> CALL RTR_BROADCAST_EVENT "Dollar is up"/EVENT_NUMBER=23 %RTR-S-OK, Normal successful completion The following command broadcasts user event number 24 to all recipients whose /RECIPIENT_NAME matches the DEALER% string (that is, DEALER1, DEALER2, DEALERx). Note that only the event is broadcast, there is no associated message.
  • Page 86: Call Rtr_Close_Channel

    CALL RTR_CLOSE_CHANNEL CALL RTR_CLOSE_CHANNEL The CALL RTR_CLOSE_CHANNEL command causes a command server to execute the rtr_close_channel( ) Format CALL RTR_CLOSE_CHANNEL Command Qualifiers /CHANNEL_NAME=channel-name /CLUSTER /IMMEDIATE /NODE[=node-list] /OUTPUT[=file-spec] Description The CALL RTR_CLOSE_CHANNEL command causes a command server to call rtr_close_channel( ) The numeric status returned from the call is then converted to its textual representation and displayed.
  • Page 87: Call Rtr_Close_Channel

    /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster. If neither /NODE nodes specified by the latest command has been entered then the command is executed only on the node where the command was issued. Note: In environments that do not support clustering, use of the /CLUSTER qualifier will cause the relevant command to be executed on the local node only.
  • Page 88: Call Rtr_Error_Text

    CALL RTR_ERROR_TEXT CALL RTR_ERROR_TEXT The CALL RTR_ERROR_TEXT command causes a command server to execute rtr_error_text( ) Format CALL RTR_ERROR_TEXT Command Qualifiers /OUTPUT[=file-spec] /STATUS=status-code Description The CALL RTR_ERROR_TEXT command causes a command server to call the rtr_error_text( ) rtr_error_text( ) Reference Manual. The prototype of char Table 6–5 shows the correspondence between values you supply on the command...
  • Page 89: Call Rtr_Get_Tid

    CALL RTR_GET_TID The CALL RTR_GET_TID command causes a command server to execute the rtr_get_tid( ) routine and to display the returned status. Format CALL RTR_GET_TID Command Qualifiers /CHANNEL_NAME=channel-name /CLUSTER /NODE[=node-list] /OUTPUT[=file-spec] Description The CALL RTR_GET_TID command causes a command server to call to the rtr_get_tid( ) routine using values supplied on the command line.
  • Page 90: Call Rtr_Get_Tid

    CALL RTR_GET_TID If neither /NODE nodes specified by the latest command has been entered then the command is executed only on the node where the command was issued. Note: In environments that do not support clustering, use of the /CLUSTER qualifier will cause the relevant command to be executed on the local node only.
  • Page 91 CALL RTR_OPEN_CHANNEL The CALL RTR_OPEN_CHANNEL command causes a command server to execute the rtr_open_channel( ) Format CALL RTR_OPEN_CHANNEL Command Qualifiers /ACCEPT_EXPLICIT /ACCESS=access /BE_CALL_OUT /CHANNEL_NAME=channel-name /CLIENT /CLUSTER /CONCURRENT /EVENTS[=event-nr-list] /FACILITY_NAME[=facility-name] /FOREIGN_TM[=tm_id] /HIGH_BOUND=high-bound /KEY1=keysegdesc /KEYn=keysegdesc /LENGTH_OF_FIELD=key-field-length /LENGTH_OF_FIELD=4 /LOW_BOUND=low-bound /NODE[=node-list] /OFFSET_OF_KEY=offset /OUTPUT[=file-spec] /PARTITION_NAME=partition-name /PREPARE_EXPLICIT /RECIPIENT_NAME=rcpnam /SERVER...
  • Page 92: Parameters For Rtr_Open_Channel

    CALL RTR_OPEN_CHANNEL rtr_status_t Table 6–7 shows the correspondence between values you supply on the command line and the C language parameter values produced and used for the call. Table 6–7 Parameters for rtr_open_channel C Parameter Name C Parameter Value channel flags RTR_NO_FLAGS RTR_F_OPE_CLIENT...
  • Page 93 /ACCESS=access /NOACCESS (D) Specifies an access string (that is, a password). All application programs (clients and servers) must specify the same access string for a given facility. /BE_CALL_OUT /NOBE_CALL_OUT (D) Specifies that the RTR_F_OPE_BE_CALL_OUT flag is set in the in the call to rtr_open_channel( ) server.
  • Page 94: Call Rtr_Open_Channel

    CALL RTR_OPEN_CHANNEL /FACILITY_NAME=facility-name /FACILITY=RTR$DEFAULT_FACILITY (D) Specifies the name of the facility for which the channel is declared. An application must specify the facility name when using the RTR CLI. The default facility name is RTR$DEFAULT_FACILITY. /FOREIGN_TM[=tm_id] /NOFOREIGN_TM (D) Valid for client channels only. This indicates that the global coordinating Transaction Manager (TM) is a Foreign TM (denoted as FTM), and that all TXs on this channel will be coordinated by the FTM.
  • Page 95 Specifies the length of the key field in enqueued messages in length_of_key=nnnn bytes. Use this qualifier only if the key field type is string, since the key length is in other cases implied by the key type. The default value for bytes.
  • Page 96 CALL RTR_OPEN_CHANNEL /OFFSET_OF_KEY=offset /OFFSET_OF_KEY=0 (D) Specifies the offset of the key within the messages in bytes. The default is zero, that is, the key is at the start of the messages. Note that only one key segment definition is allowed. /OUTPUT[=file-spec] /OUTPUT=stdout (D) Specifies that the resulting information is written to the file...
  • Page 97 /TYPE_OF_FIELD=key-field-type /TYPE_OF_FIELD=UNSIGNED (D) Specifies the field type of the key. The SIGNED or STRING. The default is UNSIGNED. Related Commands • CALL RTR_CLOSE_CHANNEL Examples This command opens a server channel called RTR$DEFAULT_CHANNEL that may not have concurrent servers, explicitly accepts transactions and listens for all RTR events.
  • Page 98: Call Rtr_Prepare_Tx

    CALL RTR_PREPARE_TX CALL RTR_PREPARE_TX The CALL RTR_PREPARE_TX command causes a command server to execute rtr_prepare_tx( ) Format CALL RTR_PREPARE_TX Command Qualifiers /CHANNEL_NAME=channel-name /DATA[=data] /NODE[=node-list] /OUTPUT[=file-spec] /REASON[=reason] Description The CALL RTR_PREPARE_TX command causes a command server to call the rtr_prepare_tx( ) The numeric status returned from the call is then converted to its textual representation and displayed.
  • Page 99 CALL RTR_PREPARE_TX The CALL RTR_PREPARE_TX can only be used in the context of nested transactions (rtr_start_tx was called with the parameter join_txid not equal to NOJOIN_TXID). If this call returns RTR_STS_OK, then the first (prepare) phase of the RTR 2PC protocol has been initiated. The message type associated with this command is rtr_mt_prepared .
  • Page 100 CALL RTR_PREPARE_TX /REASON[=reason] /REASON=0 Use /REASON to supply a value for the rtr_prepare_tx( ) The reason parameter to parameter in the subsequent the call to rtr_accept_tx call( ) rtr_prepare_tx( ) Related commands • CALL RTR_OPEN_CHANNEL • CALL RTR_REJECT_TX Examples Prepare the current transaction with a reason of 42. RTR>...
  • Page 101: Call Rtr_Receive_Message

    CALL RTR_RECEIVE_MESSAGE The CALL RTR_RECEIVE_MESSAGE command causes a command server to execute the rtr_receive_message( ) Format CALL RTR_RECEIVE_MESSAGE Command Qualifiers /CHANNEL_NAME=channel-name /CLUSTER /NODE[=node-list] /OUTPUT[=file-spec] /TIMEOUT_MS=timoutms Description The CALL RTR_RECEIVE_MESSAGE command causes a command server to call the rtr_receive_message( ) line. The numeric status returned from the call is then converted to its textual representation and displayed.
  • Page 102 CALL RTR_RECEIVE_MESSAGE For all messages received, RTR displays the contents of the message status block (msgsb) as follows: the message type (for example, the message length in bytes the transaction ID, user handle, are event number are shown if they are relevant for the message type.
  • Page 103 /TIMEOUT_MS=timoutms /TIMEOUT_MS=0 (D) The timoutms argument defines a timeout for the receive, in milliseconds. The default value is an infinite timeout. /TIMEOUT_MS specifies an immediate timeout. Examples The following example shows two CALL RTR_RECEIVE_MESSAGE commands on RTR$DEFAULT_CHANNEL. RTR> CALL RTR_RECEIVE_MESSAGE /TIMEOUT_MS %RTR-S-OK, normal successful completion channel name: RTR$DEFAULT_CHANNEL msgsb...
  • Page 104: Parameters For Rtr_Reject_Tx

    CALL RTR_REJECT_TX CALL RTR_REJECT_TX The CALL RTR_REJECT_TX command causes a command server to execute rtr_reject_tx( ) Format CALL RTR_REJECT_TX Command Qualifiers /CHANNEL_NAME=channel-name /CLUSTER /NODE[=node-list] /OUTPUT[=file-spec] /REASON[=rsnsts] /RETRY Description The CALL RTR_REJECT_TX command causes a command server to call the rtr_reject_tx( ) The numeric status returned from the call is then converted to its textual representation and displayed.
  • Page 105 is not case sensitive. channel_name The default channel name is RTR$DEFAULT_CHANNEL. /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster. If neither /NODE nodes specified by the latest command has been entered then the command is executed only on the node where the command was issued.
  • Page 106: Call Rtr_Reject_Tx

    CALL RTR_REJECT_TX Examples Reject the current transaction with a reason of 42. RTR> CALL RTR_REJECT_TX /REASON=42 %RTR-S-OK, normal successful completion 6–30 RTR Command Line Interface...
  • Page 107: Call Rtr_Reply_To_Client

    CALL RTR_REPLY_TO_CLIENT The CALL RTR_REPLY_TO_CLIENT command causes a command server to execute the rtr_reply_to_client( ) Format CALL RTR_REPLY_TO_CLIENT [message-field1] [,message-field2...] Parameters [message-field1] [,message-field2...] Specify the message to be sent as one or more comma separated parameter values. You can use the /TYPE_OF_DATA and /LENGTH_OF_DATA positional qualifiers on each parameter value to specify the data type and length of each field.
  • Page 108: Parameters For Rtr_Reply_To_Client

    CALL RTR_REPLY_TO_CLIENT Table 6–11 Parameters for rtr_reply_to_client C Parameter Name C Parameter Value channel flags RTR_NO_FLAGS RTR_F_REP_ACCEPT pmsg, msglen, msgfmt pmsg msglen The actual values used for command line parameter. The command server uses message data specified as command line parameter values to generate a record containing the message data (for the the message length (for the msgfmt...
  • Page 109: Generated Format Strings

    Table 6–12 Generated Format Strings Data Type STRING SIGNED SIGNED SIGNED UNSIGNED UNSIGNED UNSIGNED Refer to Application Programmer’s Reference Manual, section ‘‘Defining a Message Format Description’’ for information on constructing a parameter. /INDEPENDENT NOINDEPENDENT Use the /INDEPENDENT qualifier to specify the flags parameter RTR_F_ACC_ INDEPENDENT in the call to rtr_reply_to_client( ).
  • Page 110 CALL RTR_REPLY_TO_CLIENT Examples The following example replies a message to the client. RTR> CALL RTR_REPLY_TO_CLIENT "Getting that info for you" %RTR-S-OK, Normal successful completion The following example shows a message of type unsigned and entered as a hexadecimal number. RTR> CALL RTR_REPLY_TO_CLIENT "0xFA9BC0"/TYPE_OF_DATA=UNSIGNED %RTR-S-OK, Normal successful completion 6–34 RTR Command Line Interface...
  • Page 111: Call Rtr_Request_Info

    CALL RTR_REQUEST_INFO The CALL RTR_REQUEST_INFO command causes a command server to execute the rtr_request_info( ) Format CALL RTR_REQUEST_INFO Command Qualifiers /CHANNEL_NAME=channel-name /CLUSTER /GETITM=item-name /INFCLA=infoclass /NODE[=node-list] /OUTPUT[=file-spec] /SELITM=item-name /SELVAL=item-value Description The CALL RTR_REQUEST_INFO command causes a command server to call to rtr_request_info( ) rtr_request_info( ) Reference Manual.
  • Page 112 CALL RTR_REQUEST_INFO Qualifiers /CHANNEL_NAME=channel_name /CHANNEL_NAME=RTR$DEFAULT_CHANNEL Specifies the channel for which the operation is to be performed. The command server uses a combination of the channel_name and the window from which the call was issued to uniquely identify which channel to use. channel_name is not case sensitive.
  • Page 113 Examples This command requests the backend transaction IDs for the facility ‘‘CASHFAC’’. RTR> CALL RTR_REQUEST_INFO/CHANNEL=INFOCHAN /INFCLA="btx"/SELITM=fac_id/SELVAL=CASHFAC /GETITMS=tb_txdx.tx_id The information can then be viewed by repeatedly executing the following command until the channel is closed. RTR> CALL RTR_RECEIVE_MESSAGE/CHANNEL=INFOCHAN/TIMEOUT CALL RTR_REQUEST_INFO RTR Command Line Interface 6–37...
  • Page 114 CALL RTR_SEND_TO_SERVER CALL RTR_SEND_TO_SERVER The CALL RTR_SEND_TO_SERVER command causes a command server to execute the rtr_send_to_server( ) Format CALL RTR_SEND_TO_SERVER [message-field1] [,message-field2...] Parameters [message-field] [,message-field2...] Specify the message to be sent as one or more comma separated parameter values. You can use the /TYPE_OF_DATA and /LENGTH_OF_DATA positional qualifiers on each parameter value to specify the data type and length of each field.
  • Page 115: Parameters For Rtr_Send_To_Server

    Table 6–14 Parameters for rtr_send_to_server C Parameter Name C Parameter Value channel flags RTR_NO_FLAGS RTR_F_SEN_EXPENDABLE RTR_F_SEN_READONLY RTR_F_SEN_RETURN_TO_SENDER pmsg, msglen, msgfmt pmsg msglen The actual values used for command line parameter. The command server uses message data specified as command line parameter values to generate a record containing the message data (for the the message length (for the parameter).
  • Page 116: Call Rtr_Send_To_Server

    CALL RTR_SEND_TO_SERVER If /FORMAT is specified without format string. The format string is generated using the parameters given for the qualifiers /SIGNED, /UNSIGNED, /STRING and /LENGTH. The following table shows permitted values for these qualifiers when using /FORMAT without fmt-string Table 6–15 Generated Format Strings Data Type STRING...
  • Page 117 CALL RTR_SEND_TO_SERVER Examples This command sends a message to a server. The message is type string (the default). RTR> CALL RTR_SEND_TO_SERVER "Get that info for me, please" %RTR-S-OK, Normal successful completion RTR Command Line Interface 6–41...
  • Page 118: Call Rtr_Start_Tx

    CALL RTR_START_TX CALL RTR_START_TX The CALL RTR_START_TX command causes a command server to execute the rtr_start_tx( ) Format CALL RTR_START_TX Command Qualifiers /CHANNEL_NAME=channel-name /CLUSTER /JOIN_TXID=txid-number /NODE[=node-list] /OUTPUT[=file-spec] /TIMEOUT_MS=timoutms /TXID_TYPE=txid-type Description The CALL RTR_START_TX command causes a command server to call the rtr_start_tx( ) The numeric status returned from the call is then converted to its textual representation and displayed.
  • Page 119: Call Rtr_Start_Tx

    phase cannot be executed on an client FTM channel, may be relaxed in a future release.) When a nested transaction is started (join_txid not equal to NOJOIN_ TXID), then that transaction is given a new RTR TXID (which the operator can retrieve by calling rtr_get_tid). The foreign TXID passed in join_txid is used only to identify the transaction for the foreign TM (for example, when the foreign TM goes through recovery and requests RTR to return all transactions in prepared state).
  • Page 120 CALL RTR_START_TX /OUTPUT[=file-spec] /OUTPUT=stdout (D) Specifies that the resulting information is written to the file /OUTPUT file-spec /TIMEOUT_MS=timoutms /TIMEOUT_MS=0 (D) The timoutms argument defines a timeout for the transaction, in milliseconds. The default value is an infinite timeout. /TIMEOUT_MS specifies an immediate timeout (timeout if no message to receive).
  • Page 121: Clear

    CLEAR Interactively remove one or more displayed items from a monitor picture. Format CLEAR Command Qualifiers /ALL /X=column /Y=row Description CLEAR command enables you to interactively remove one or all of the displayed items from a monitor picture. The picture can then be redisplayed using the MONITOR /RESUME CLEAR /ALL...
  • Page 122 CLEAR Examples See Section A.1, Interactive Definition of a Monitor Picture, for an example of how to use the CLEAR 6–46 RTR Command Line Interface command.
  • Page 123: Create Facility

    CREATE FACILITY Create an RTR facility and ready it for transaction traffic. Format CREATE FACILITY Command Qualifiers /ALL_ROLES=node-list /BACKEND=backend-list /BALANCE /CALL_OUT=role-list /CLUSTER /FRONTEND=frontend-list /NODE[=node-list] /OUTPUT[=file-spec] /REPLY_CHECKSUM /RESOURCE_MANAGER=resource-list /ROUTER=router-list Description CREATE FACILITY and readies it for transaction traffic (that is, establishes links to other the participating nodes).
  • Page 124 CREATE FACILITY Qualifiers /ALL_ROLES=node-list /NOALL_ROLES (D) Specifies the names of the nodes that are to act as frontend, router in this facility. Note that the definition order of nodes may be significant. This applies to the order of router node definitions when frontend load balancing is not enabled. Nodes defined with the /ROUTER qualifier have the higher priority and are followed by nodes defined by the /ALL_ROLES qualifier.
  • Page 125 Note: In environments that do not support clustering, use of the /CLUSTER qualifier will cause the relevant command to be executed on the local node only. /FRONTEND=frontend-list /NOFRONTEND (D) is a list of Frontend-list than one frontend-node Frontend-node is either the name of a node or specifies a text file containing a /NODE[=node-list] /NODE=default-node-list (D)
  • Page 126 CREATE FACILITY Examples See Chapter 2, Starting and Setting Up RTR, for examples of how to use the CREATE FACILITY 6–50 RTR Command Line Interface command.
  • Page 127: Create Journal

    CREATE JOURNAL Create RTR’s recovery journal. Format CREATE JOURNAL [disk-1] ... [,disk-n] Command Qualifiers /CLUSTER /BLOCKS=nr-blocks /MAXIMUM_BLOCKS=nr-blocks /NODE=node-list /OUTPUT[=file-spec] /SUPERSEDE Description The CREATE JOURNAL command creates RTR’s recovery journal files on the specified disks. The target size of the files is specified using the /BLOCKS qualifier (512 byte blocks).
  • Page 128: Platform Specific Information

    CREATE JOURNAL Table 6–17 Platform Specific Information Platform Journal Root UNIX /rtrjnl OpenVMS [RTRJNL] Qualifiers /BLOCKS[=nr-blocks] /BLOCKS=1000 (D) Specifies the target size of the journal file in 512 byte blocks. This qualifier can be applied locally to each disk or globally for all disks. /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster.
  • Page 129 If /NOSUPERSEDE is specified (default), then a journal is created only if no journal previously existed. Related commands • DELETE JOURNAL • MODIFY JOURNAL • SHOW JOURNAL Examples RTR> CREATE JOURNAL /SUPERSEDE DISK1$:/BLOCK=1000/MAX_BLOCK=10000, - _RTR> DISK2$:/BLOCK=2000/MAX_BLOCK=200000 This command deletes any existing journal files and then creates new ones on DISK1$ and DISK2$.
  • Page 130: Create Partition

    CREATE PARTITION CREATE PARTITION Creates an RTR partition. Format CREATE PARTITION Command Qualifiers /CLUSTER /CONCURRENT /FACILITY=facility-name /NODE[=node-list] /OUTPUT[=file-spec] /STANDBY /SHADOW /KEY1=keysegdesc /KEYn=keysegdesc Description CREATE PARTITION characteristics that may be defined include key range or ranges and whether attached server processes can be shadows or standbys. The command must be issued before any server application programs using the partition are started.
  • Page 131 /CONCURRENT (D) /NOCONCURRENT Specifies that concurrent servers are allowed for this partition. /KEYn=keysegdesc Specifies a partition key segment. Up to nine key segments may be defined for a partition (KEY1, KEY2,... up to KEY9). (If more than nine key segements are required, a named partiton can be created using the The syntax of the KEYn qualifier is: /KEYn= (type_of_key=[signed|unsigned|string], -...
  • Page 132 CREATE PARTITION /STANDBY (D) /NOSTANDBY Specifies that standby servers are allowed for this partition. /SHADOW /NOSHADOW (D) Specifies that shadow servers are allowed for this partition. /OUTPUT[=file-spec] /OUTPUT=stdout (D) Specifies that the resulting information is written to the file /OUTPUT file-spec Related Commands •...
  • Page 133: Define /Key

    DEFINE /KEY Assign a string to a keyboard function key. Format DEFINE /KEY key-name "equivalence-string" Command Qualifiers /ECHO /IF_STATE /LOCK_STATE /LOG /SET_STATE /TERMINATE Description This command lets you assign a string to a function key, possibly overriding any predefined function that was bound to that key. When you then press the key, the RTR Utility enters the currently associated string into your command line.
  • Page 134 DEFINE /KEY Table 6–18 (Cont.) Key names Key-name KP0, KP1 ..KP9 PERIOD COMMA MINUS ENTER HELP F6, F7, .. F20 equivalence-string Specifies the string to be processed when the specified key is pressed. Typically, this is all or part of an RTR command. If the string contains spaces or non-alphanumeric characters, it must be enclosed in quotation marks.
  • Page 135 /LOG /NOLOG (D) Controls whether a message is displayed indicating that the key definition has been successfully created. /SET_STATE=state-name /NOSETSTATE (D) Controls whether pressing the key changes the current key state. changes the current state to (the default) causes the current state to remain in effect. /TERMINATE /NOTERMINATE (D) Controls whether the specified string is to be terminated (processed) when the...
  • Page 136 DEFINE /KEY The word DEFAULT in the second line of the example refers to the fact that has been defined in the default state. Note the space before the word CREATE in the second DEFINE /KEY command. If the space is omitted, the system fails to recognize CREATE as the keyword for the HELP command.
  • Page 137: Delete Facility

    DELETE FACILITY Delete an RTR facility. Format DELETE FACILITY Command Qualifiers /CLUSTER /NODE=node-list /OUTPUT[=file-spec] Description DELETE FACILITY the command is issued. After issuing this command applications are able to use the facility. Any outstanding transactions using the facility are aborted. Parameters facility_name The name of the facility to delete.
  • Page 138 DELETE FACILITY Related Commands • CREATE FACILITY • SHOW FACILITY Examples See Chapter 2, Starting and Setting Up RTR, for examples of how to use the DELETE FACILITY 6–62 RTR Command Line Interface command.
  • Page 139: Delete Journal

    DELETE JOURNAL Delete an RTR journal. Format DELETE JOURNAL Command Qualifiers /CLUSTER /NODE=node-list /OUTPUT[=file-spec] Description DELETE JOURNAL node where the command is issued. DELETE JOURNAL has been created but is currently in use. The command causes the previous contents of the journal, if any, to be destroyed. Qualifiers /CLUSTER /NOCLUSTER (D)
  • Page 140 DELETE JOURNAL Examples See Chapter 2, Starting and Setting Up RTR, for examples of how to use the command. DELETE JOURNAL 6–64 RTR Command Line Interface...
  • Page 141: Delete Partition

    DELETE PARTITION Delete an RTR PARTITION. Format DELETE PARTITION Command Qualifiers /CLUSTER /NODE=node-list /OUTPUT[=file-spec] /FACILITY Description DELETE PARTITION where the command is issued. Parameters PARTITION_name The name of the partition to delete. The parameter partition_name <or as partition_name Qualifiers /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster.
  • Page 142 DELETE PARTITION Related Commands • CREATE PARTITION • SHOW PARTITION 6–66 RTR Command Line Interface...
  • Page 143: Display Bar

    DISPLAY BAR Display a bar-graph in a monitor picture. Format DISPLAY BAR expression Command Qualifiers /AVERAGE=(keyword,...) /BELL=Boolean-expression /BLANK=Boolean-expression /BLINK=Boolean-expression /BOLD=Boolean-expression /CHARACTER=char /DAMPING=damping-factor /LABEL=text /LENGTH=nr-chars /MAXIMUM=max-value /MINIMUM=min-value /RATE=interval /REVERSE=Boolean-expression /ROWS=nr-rows /SELECT=Boolean-expression /SEPARATE=(keyword,...) /TOTALIZE=(keyword,...) /UNDERLINE=Boolean-expression /VALUE=value-type /X=column /Y=row Description DISPLAY BAR picture. It can be used within a monitor file or issued at the interactively defining a monitor picture for use in a subsequent MONITOR command.
  • Page 144 DISPLAY BAR Qualifiers /AVERAGE=(keyword,...) /NOAVERAGE Specifies that the items being monitored relating to average. This allows a number of items to be averaged in one qualifier. can be one of the following: keyword Keyword NODE LINK FACILITY PROCESS PARTITION FE_TRANSACTION TR_TRANSACTION BE_TRANSACTION /BELL[=Boolean-expression]...
  • Page 145 /LABEL=text /NOLABEL (D) Specifies the text used to label the value being displayed. Symbols are substituted at display time. (See Section A.2, Substitution Symbols). /LENGTH[=nr-chars] /LENGTH=50 (D) Specifies the number of characters in a bar chart representing the maximum value. The default is 50. /MAXIMUM[=max-value] /MAXIMUM=10 (D) Specifies the maximum value represented on a bar chart.
  • Page 146 DISPLAY BAR Keyword PROCESS PARTITION FE_TRANSACTION TR_TRANSACTION BE_TRANSACTION /TOTALIZE=(keyword,...) /NOTOTALIZE Specifies that the items being monitored relating to and displayed as a total. can be one of the following: keyword Keyword NODE LINK FACILITY PROCESS PARTITION FE_TRANSACTION TR_TRANSACTION BE_TRANSACTION /UNDERLINE[=Boolean-expression] /NOUNDERLINE (D) Specifies that the displayed value is underlined if to True (non-zero).
  • Page 147 /X=previous-column (D) Specifies the screen column where the item is displayed (the leftmost column is 1). By default, items are displayed in the same column as defined by the previous DISPLAY command. /Y[=row] /Y=next-free-row (D) Specifies the screen row where the item is displayed (top row is 1). By default, items are displayed on the next free row after the item defined by the previous DISPLAY command.
  • Page 148: Display Numeric

    DISPLAY NUMERIC DISPLAY NUMERIC Display a number in a monitor picture. Format DISPLAY NUMERIC Command Qualifiers /AVERAGE=(keyword,...) /BELL=Boolean-expression /BLANK=Boolean-expression /BLINK=Boolean-expression /BOLD=Boolean-expression /DAMPING=damping-factor /DECIMALS=decimal-places /LABEL=text /RATE=interval /REVERSE=Boolean-expression /ROWS=nr-rows /SELECT=Boolean-expression /SEPARATE=(keyword,...) /TOTALIZE=(keyword,...) /UNDERLINE=Boolean-expression /VALUE=value-type /WIDTH=field-width /X=column /Y=row Description DISPLAY NUMERIC in a monitor picture. It can be used within a monitor file or issued at the prompt when interactively defining a monitor picture for use in a subsequent MONITOR command.
  • Page 149 can be one of the following: keyword Keyword Meaning NODE Node data items LINK Link data items FACILITY Facility data items PROCESS Process data items PARTITION Partition data items FE_TRANSACTION Frontend transaction data items TR_TRANSACTION Backend transaction data items BE_TRANSACTION Router transaction data items /BELL[=Boolean-expression] /NOBELL (D)
  • Page 150 DISPLAY NUMERIC /RATE[=interval] /NORATE (D) Specifies that the rate of change of the the absolute value. When seconds used to calculate the rate of change. This has no effect on the sampling, it simply allows the rate to be displayed in another unit. For example, displaying the start transaction counter with being displayed instead of per second.
  • Page 151 Keyword Meaning LINK Link data items FACILITY Facility data items PROCESS Process data items PARTITION Partition data items FE_TRANSACTION Frontend transaction data items TR_TRANSACTION Backend transaction data items BE_TRANSACTION Router transaction data items /UNDERLINE[=Boolean-expression] /NOUNDERLINE (D) Specifies that the displayed value is underlined if to True (non-zero).
  • Page 152 DISPLAY NUMERIC Related Commands • MONITOR • SHOW DISPLAY • CLEAR • DISPLAY BAR • DISPLAY SYMBOLIC • DISPLAY TEXT Examples See Section A.1 for examples of how to use the 6–76 RTR Command Line Interface command. DISPLAY NUMERIC...
  • Page 153: Display String

    DISPLAY STRING Display a string in a monitor picture. Format DISPLAY STRING expression Command Qualifiers /AVERAGE=(keyword,...) /BELL=Boolean-expression /BLANK=Boolean-expression /BLINK=Boolean-expression /BOLD=Boolean-expression /JUSTIFY=keyword /LABEL=text /REVERSE=Boolean-expression /ROWS=nr-rows /SELECT=Boolean-expression /SEPARATE=(keyword,...) /TOTALIZE=(keyword,...) /UNDERLINE=Boolean-expression /WIDTH=field-width /X=column /Y=row Description DISPLAY STRING alphanumeric in a monitor picture. It can be used within a monitor file or issued at the a subsequent MONITOR command.
  • Page 154 DISPLAY STRING can be one of the following: keyword Keyword NODE LINK FACILITY PROCESS PARTITION FE_TRANSACTION TR_TRANSACTION BE_TRANSACTION /BLANK[=Boolean-expression] /NOBLANK (D) Specifies that the displayed value is replaced by blanks if evaluates to True (non-zero). /BLINK[=Boolean-expression] /NOBLINK (D) Specifies that the displayed value blinks if (non-zero).
  • Page 155 /SEPARATE=(keyword,...) /NOSEPARATE Specifies that the items being monitored relating to each other and displayed as a list. This allows a number of items to be separated in one qualifier. keyword can be one of the following: Keyword Meaning NODE Node data items LINK Link data items FACILITY...
  • Page 156 DISPLAY STRING /X[=column] /X=previous-column (D) Specifies the screen column where the item is displayed (the leftmost column is 1). By default, items are displayed in the same column as defined by the previous DISPLAY command. /Y[=row] /Y=next-free-row (D) Specifies the screen row where the item is displayed (top row is 1). By default, items are displayed on the next free row after the item defined by the previous DISPLAY command.
  • Page 157: Display Symbolic

    DISPLAY SYMBOLIC Display a text in a monitor picture depending on the result of an expression evaluation. Format DISPLAY SYMBOLIC Command Qualifiers /BELL=Boolean-expression /BLANK=Boolean-expression /BLINK=Boolean-expression /BOLD=Boolean-expression /REVERSE /UNDERLINE=Boolean-expression /X=column /Y=row Description DISPLAY SYMBOLIC the value of expression zero (0), the second string is output if the expression’s value is 1, and so on. If the expression has a value for which there is no corresponding entry in the list of texts, then the value itself is printed.
  • Page 158 DISPLAY SYMBOLIC /BOLD[=Boolean-expression] /NOBOLD (D) Specifies that the item is displayed in high intensity if evaluates to True (non-zero). /REVERSE[=Boolean-expression] /NOREVERSE (D) Specifies that the item is displayed with the foreground and background visual attributes swapped if /UNDERLINE[=Boolean-expression] /NOUNDERLINE (D) Specifies that the displayed value is underlined if to True (non-zero).
  • Page 159: Display Text

    DISPLAY TEXT Display text in a monitor picture. Format DISPLAY TEXT text Command Qualifiers /BELL=Boolean-expression /BLANK=Boolean-expression /BLINK=Boolean-expression /BOLD=Boolean-expression /FACILITY /LINK /NODE /PROCESS /REVERSE=Boolean-expression /SELECT=Boolean-expression /UNDERLINE /X=column /Y=row Description DISPLAY TEXT within a monitor file or issued at the monitor picture for use in a subsequent MONITOR command. Parameters text Specifies the text to be displayed.
  • Page 160 DISPLAY TEXT /BOLD[=Boolean-expression] /NOBOLD (D) Specifies that the item is displayed in high intensity if evaluates to True (non-zero). /FACILITY /NOFACILITY (D) Specifies that the symbol substitution in the text is carried out as if a facility data item were being displayed. This means that the link name symbol ($LINK_ NAME) and the process related symbols ($PROCESS_ID, $PROCESS_NAME, $IMAGE_NAME, $FULL_IMAGE_NAME) are always replaced by the text "-ALL-".
  • Page 161 /UNDERLINE[=Boolean-expression] /NOUNDERLINE (D) Specifies that the displayed value is underlined if to True (non-zero). /X[=column] /X=previous-column (D) Specifies the screen column where the item is displayed (the leftmost column is 1). By default, items are displayed in the same column as defined by the previous DISPLAY command.
  • Page 162 Execute an operating system command. Format DO [operating-system-command] Command Qualifiers /CLUSTER /NODE=node-list /OUTPUT[=file-spec] Description command enables an operating system command to be executed from RTR. By using the on one or more remote nodes. (Note that the SPAWN command does not have this ability).
  • Page 163 Example RTR> DO/NODE=(TR2,TR1) "ps" This command displays the processes running on Compaq Tru64 UNIX nodes TR2 and TR1. command can be used if a series of DCL commands are to RTR Command Line Interface 6–87...
  • Page 164: Flush Name_Cache

    FLUSH NAME_CACHE FLUSH NAME_CACHE Flushes RTR’s internal network name cache. Format FLUSH NAME_CACHE Command Qualifiers /CLUSTER /NODE[=node-list] Description FLUSH NAME_CACHE internal network name cache. Network links could become unstable if a Distributed Name Service (DNS) was configured improperly or the service was slow in responding. During extreme DNS latency, RTR could time-out the connections to nodes waiting for a DNS response.
  • Page 165: Execute

    EXECUTE Executes a file containing RTR commands. Format EXECUTE file-spec Command Qualifiers /VERIFY Description The EXECUTE command reads a file containing RTR commands and executes them. This command also has the form Parameters file-spec Specifies the name of the file containing commands to be executed. Qualifiers /VERIFY /NOVERIFY (D)
  • Page 166: Exit

    EXIT EXIT Exits from the RTR prompt. Format EXIT Description The EXIT command exits from the RTR prompt and returns control to the operating system prompt. The command has no parameters or qualifiers. Same as QUIT. 6–90 RTR Command Line Interface...
  • Page 167: Extend Facility

    EXTEND FACILITY Adds new nodes or roles or both to an existing facility definition. Format EXTEND FACILITY Command Qualifiers /BACKEND=backend-list /BALANCE /CALL_OUT=role-list /CLUSTER /FRONTEND=frontend-list /NODE[=node-list] /OUTPUT[=file-spec] /ROUTER=router-list Description EXTEND FACILITY New nodes and roles can be added to a facility definition using the EXTEND FACILITY command.
  • Page 168 EXTEND FACILITY $ RTR RTR> SET ENVIRONMENT /NODE=(FE,FETRBE) RTR> CREATE FACILITY facnam /FRONTEND=(FE,FETRBE) - /ROUTER=FETRBE - /BACKEND=FETRBE A new frontend $ RTR RTR> SET ENVIRONMENT /NODE=(FETRBE,NFE) RTR> EXTEND FACILITY facnam /FRONTEND=NFE - /ROUTER=FETRBE Parameters facility_name Specifies the name of the facility to be extended. Any application program which uses this facility must specify the same name when it calls the Facility names can contain up to thirty-one characters.
  • Page 169 is a list of Backend-list backend-nodes than one backend-node , then backend-list is either the name of a node or Backend-node specifies a file containing a backend-list /BALANCE /NOBALANCE (D) Specifies that load balancing is enabled for frontend/router connections across the facility.
  • Page 170 EXTEND FACILITY /OUTPUT[=file-spec] /OUTPUT=stdout (D) Specifies that the resulting information is written to the file /OUTPUT file-spec /ROUTER=router-list /NOROUTER (D) Specifies the names of the added nodes that act as routers for this facility. is a list of Router-list than one router-node If /NOBALANCE is specified with the EXTEND FACILITY command, then the order in which router nodes are specified with the /ROUTER qualifier defines the...
  • Page 171: Initialize Journal

    INITIALIZE JOURNAL INITIALIZE JOURNAL See CREATE JOURNAL; INITIALIZE is only retained for compatibility reasons. RTR Command Line Interface 6–95...
  • Page 172: Log

    Specify RTR to write a log message to a log file. Format Command Qualifiers /CLUSTER /NODE=node-list /OUTPUT[=file-spec] Description command specifies a defined log entry to be written to its log messages. You can write log messages to the operator console and to a maximum of four log files.
  • Page 173 Examples RTR> LOG/OUTPUT=RTRLOG.LOG "Message check here" This command tells RTR to write a log message to the file RTRLOG.LOG. RTR> LOG/CLUSTER="Check for this message to see if logging is working" This command tells RTR to write log messages to all members of a cluster. RTR>...
  • Page 174: Modify Journal

    MODIFY JOURNAL MODIFY JOURNAL Specifies the desired and maximum allowed sizes of RTR’s recovery journal. Format MODIFY JOURNAL [disk-1] ... [,disk-n] Command Qualifiers /CLUSTER /BLOCKS=nr-blocks /MAXIMUM_BLOCKS=nr-blocks /NODE=node-list /OUTPUT[=file-spec] Description The MODIFY JOURNAL command specifies how the size of RTR recovery journal files on the specified disks can be modified.
  • Page 175 If neither /NODE nodes specified by the latest command has been entered then the command is executed only on the node where the command was issued. Note: In environments that do not support clustering, use of the /CLUSTER qualifier will cause the relevant command to be executed on the local node only. /MAXIMUM_BLOCKS[=nr-blocks] /MAXIMUM_BLOCKS=1000 (D) Specifies the maximum size that the journal file can use.
  • Page 176: Monitor

    MONITOR MONITOR Displays a monitor picture on the screen. Format MONITOR [monitor-file-spec] Command Qualifiers /CLUSTER /COUNT=nr-updates /FACILITY=facility-name /IDENTIFICATION=process-id /INTERVAL=delay-seconds /LINK=link-name /NODE=node-list /OUTPUT[=file-spec] /PARTITION=partition-name /RESUME /VERIFY Description command allows certain RTR status variables to be continuously MONITOR displayed on your terminal. The individual items displayed in the monitor picture may be defined interactively using command.
  • Page 177 MONITOR Note: In environments that do not support clustering, use of the /CLUSTER qualifier will cause the relevant command to be executed on the local node only. /COUNT=nr-updates /COUNT=infinite (D) Specifies how many times the RTR utility updates the screen before exiting or returning to the prompt.
  • Page 178 MONITOR qualifier can be used to reset all the averages currently being displayed. It is also useful if monitoring is resumed after issuing one or more RTR commands. /VERIFY /NOVERIFY (D) Specifies that the contents of useful when developing monitor files to find the exact location of syntax errors. Related Commands •...
  • Page 179: Quit

    QUIT Quits from the RTR prompt. Format QUIT Description The QUIT command exits from the RTR prompt and returns control to the operating system prompt. The command has no parameters or qualifiers. Same as EXIT. QUIT RTR Command Line Interface 6–103...
  • Page 180: Recall

    RECALL RECALL Display a previously entered command for subsequent command editing. Format RECALL [command-specifier] Command Qualifiers /ALL Description When you enter commands to the RTR Utility, they are stored in a recall buffer for later use with the entering the first few characters of the command or the command’s number. The RECALL/ALL command can be used to list the last twenty commands.
  • Page 181: Register Resource Manager (Register Rm)

    REGISTER RESOURCE MANAGER (REGISTER RM) Registers an instance of a resource manager (RM) with RTR. Format REGISTER RESOURCE MANAGER [resource_name] REGISTER RM [resource_name] Command Qualifiers /open_string /close_string /switch_name /library_path /protocol Description The REGISTER RESOURCE MANAGER command registers multiple resource managers or instances of resource managers (up to 16) with the current transaction manager.
  • Page 182 REGISTER RESOURCE MANAGER (REGISTER RM) Examples RTR> REGISTER RM rmi_1/open_string="Oracle_XA+Acc=P/user/pw+SesTm=15+db=accounting" /close_string="" /xaswitch_name=xaosw /library_path="library_path" 6–106 RTR Command Line Interface...
  • Page 183: Scroll

    SCROLL Scroll a monitor picture. Format SCROLL direction [amount] Description command causes the the last picture that was displayed using the SCROLL command to be scrolled in the direction specified and then redisplayed. MONITOR Parameters direction Specifies the direction in which the screen is to be scrolled. Can be one of RIGHT DOWN scrolls the picture so that its top left corner coincides with the top left corner...
  • Page 184: Set Environment

    SET ENVIRONMENT SET ENVIRONMENT Specify the node(s) where subsequent RTR commands are executed. Format SET ENVIRONMENT Command Qualifiers /CLUSTER /NODE=node-list Description SET ENVIRONMENT on the specified nodes. Entering subsequent RTR commands to be executed on the local node only. Qualifiers /CLUSTER Currently only fully supported in an OpenVMS environment, in which case it specifies that subsequent RTR commands are executed on all nodes in the...
  • Page 185: Set Facility

    SET FACILITY Sets various facility related options. Format SET FACILITY facility-name Command Qualifiers /BROADCAST_MINIMUM_RATE=Bps /BROADCAST_MINIMUM_RATE=1000 /QUORUM_THRESHOLD=n /BALANCE /CLUSTER /NODE=node-list /OUTPUT[=file-spec] /REPLY_CHECKSUM Description SET FACILITY characteristics of a facility. Qualifiers /BROADCAST_MINIMUM_RATE=Bps /BROADCAST_MINIMUM_RATE=1000 /BROADCAST_MINIMUM_RATE=nnnn to which flow control can reduce broadcast traffic on outgoing facility links from the node concerned.
  • Page 186 SET FACILITY A node that combines both backend and router roles is counted twice in determining the threshold. A value of zero implies that the RTR determined threshold (half the number of node/role pairs configured plus one) is used. This is the default value; do not alter it unless you are sure that the unreachable nodes are really down.
  • Page 187 Related Commands • SHOW FACILITY Examples RTR> SET FACILITY FINANCE/QUORUM_THRESHOLD=4 quorum threshold set to 4 (from 0) for facility FINANCE The SET FACILITY command tells RTR to set the quorum threshold to four for facility FINANCE. This command should be used on all the backend and router nodes in the facility.
  • Page 188: Set Link

    SET LINK SET LINK Sets various link related options. Format SET LINK link-name Command Qualifiers /AUTOISOLATE /ENABLE /CHECKSUM /CLUSTER /INACTIVITY_TIMEOUT[=secs] /NODE=node-list /OUTPUT[=file-spec] /SUSPECT Description command sets options for one or more or links. The options are link SET LINK enabled or disabled, link autoisolate, link checksum and link inactivity timeout. The parameter link-name honored (or not).
  • Page 189 Remote node autoisolation may be enabled (at the isolator) where it applies to all links using SET NODE/AUTOISOLATE, or for specific links only with the SET LINK/AUTOISOLATE command. An isolated node (isolatee) remains isolated until you carry out both of the following actions: •...
  • Page 190 SET LINK The new value for the current value of the link inactivity timeout. The minimum useful value for inherit the current value of the node inactivity timeout. (See SET NODE /INACTIVITY_TIMEOUT.) You can check the current value of the link inactivity timeout with the command SHOW LINK linkname/COUNTER=ndb_lw_inact You should not specify a value of less than five times the time required for a round trip over the link.
  • Page 191 Examples RTR> SET LINK JOEY/ENABLE This command re-allows connections from node JOEY. RTR> SET LINK JOEY/AUTOISOLATE This command sets the autoisolate attribute on the link to node JOEY. SET LINK RTR Command Line Interface 6–115...
  • Page 192: Set Log

    SET LOG SET LOG Specify where RTR writes its log messages. Format SET LOG Command Qualifiers /CLUSTER /FILE=file-spec-list /NODE=node-list /OPERATOR /OUTPUT[=file-spec] Description command specifies where RTR writes its log messages. You can write SET LOG log messages to the operator console and to a maximum of four log files. Log files must be periodically purged to avoid difficulties with full disks.
  • Page 193 /OPERATOR /NOOPERATOR (D) Specifies that messages are written to the operator log. /OUTPUT[=file-spec] /OUTPUT=stdout (D) Specifies that the resulting information is written to the file /OUTPUT file-spec Related Commands • SHOW LOG Examples RTR> SET LOG/FILE=RTRLOG.LOG/OPERATOR This command tells RTR to write log messages to the file RTRLOG.LOG and to the operator log.
  • Page 194: Set Mode

    SET MODE SET MODE Specify whether RTR should run in a group mode or the nogroup (system) mode. Format SET MODE Command Qualifiers /CLUSTER /GROUP[=user-id] /NODE=node-list /OUTPUT[=file-spec] Description SET MODE command specifies whether RTR runs in group mode or nogroup mode.
  • Page 195 /NODE[=node-list] /NODE=default-node-list (D) Specifies that the command is executed on all nodes specified in is omitted then the command is executed only on the node where the node-list command was issued. /OUTPUT[=file-spec] /OUTPUT=stdout (D) Specifies that the resulting information is written to the file /OUTPUT file-spec Related Commands...
  • Page 196: Set Node

    SET NODE SET NODE Sets various node related options. Format SET node Command Qualifiers /AUTOISOLATE /CLUSTER /INACTIVITY_TIMEOUT[=secs] /ISOLATE /NODE=node-list /OUTPUT[=file-spec] Description command sets the automatic isolation characteristics and the link SET NODE timeout default of a node. Qualifiers /AUTOISOLATE /NOAUTOISOLATE (D) Any RTR node may disconnect a remote node if it finds the remote node is unresponsive or congested.
  • Page 197 /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster. If neither /NODE nodes specified by the latest command has been entered then the command is executed only on the node where the command was issued. Note: In environments that do not support clustering, use of the /CLUSTER qualifier will cause the relevant command to be executed on the local node only.
  • Page 198: Set Partition

    SET PARTITION SET PARTITION Sets various partition related options. Format SET PARTITION partition-name Command Qualifiers /FACILITY=[facility_name] /FAILOVER_POLICY=[SHADOW | STAND_BY] /IGNORE_RECOVERY /PRIORITY_LIST=backend-node-list /RECOVERY_RETRY_COUNT=n /RESTART_RECOVERY /RESUME /SHADOW /SUSPEND /TIMEOUT=nn Description SET PARTITION backend partitions may be manipulated with this command; the command must be entered on the backend where the partition is located.
  • Page 199 SET PARTITION /IGNORE_RECOVERY /NOIGNORE_RECOVERY (D) Forces the partition to exit any current wait state it may be in. If a partition should enter a wait state or fail because of the unavailability of either a local or remote journal, this command can be used to override the default RTR behaviour.
  • Page 200 SET PARTITION Once shadowing is disabled, the secondary site servers will be unable to startup in shadow mode until shadowing is enabled again. Shadowing for the partition can be turned on by entering the command at the current active member or any of its standbys. If shadowing is already in the desired mode the command has no effect.
  • Page 201: Set Transaction

    SET TRANSACTION Sets various transaction related options. Format SET TRANSACTION transaction-id Command Qualifiers /BEFORE[=date] /STATE=current_state /FACILITY=facility_name /NEW_STATE=new_state /NODE[=node_list /OUTPUT[=file-spec] /PARTITION=partition_name /SINCE[=date] /USER=username Description The SET TRANSACTION command could damage your journal and database integrity if used incorrectly. Ensure that you fully understand the reason and impact for changing a transaction state before altering your RTR system.
  • Page 202 SET TRANSACTION Usage Notes The command can only be executed on a backend node in which the journal is located and the RTR log file must be turned on to record the transaction changes. RTR needs to be started before using this command. When a transaction’s state is changed, the new state is written to the RTR journal synchronously.
  • Page 203: Valid Transaction State Changes

    /NEW_STATE Specifies the new transaction state that selected transactions will be changed to. This qualifier is required and new state value must be specified. Value of new_state ABORT COMMIT DONE EXCEPTION Note that one cannot always change a transaction’s state from one legitimate transaction state to another.
  • Page 204 SET TRANSACTION Examples RTR> SET TRANSACTION "50d01f10,0,0,0,0,2166,522b2001" - _RTR> /NEW=ABORT /CURRENT=SENDING /PART=DB_PART Abort this specified transaction running in the DB_PART partition. RTR> SET TRANSACTION /NEW=ABORT /CURRENT=VOTED /PART=DB_PART For all transactions that are in VOTED transaction state and are running in DB_PART partition and in "RTR$DEFAULT_FACILITY facility, abort them.
  • Page 205: Show Channel

    SHOW CHANNEL Show the names and state of channels that have been opened using the CLI API. Format SHOW CHANNEL [channel-name] Command Qualifiers /ALL_WINDOWS /CLUSTER /NODE=node-list /OUTPUT[=file-spec] Description SHOW CHANNEL name and owner process-id for channels opened using the CLI API. Parameters channel-name Specifies the name of the channel to be displayed.
  • Page 206 SHOW CHANNEL Related Commands • call rtr_open_channel( ) • call rtr_close_channel( ) Examples RTR> SHOW CHANNEL/ALL_WINDOWS Channel type Channel name server RTR$DEFAULT_CHANNEL client CLI_CHN client CLI_CHN2 Display information about all declared channels. The channel called The channel called The channel called opened by another process (in another window).
  • Page 207: Show Client

    SHOW CLIENT Display information about client channels. Format SHOW CLIENT Command Qualifiers /CLUSTER /FACILITY /FULL /IDENTIFICATION=process-id /NODE[=node-list] /OUTPUT[=file-spec] Description SHOW CLIENT Information such as PID, key range, state, event mask and event name are displayed. Qualifiers /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster. If neither /NODE nodes specified by the latest...
  • Page 208 SHOW CLIENT /NODE[=node-list] /NODE=default-node-list (D) Specifies that the command is executed on all nodes specified in is omitted then the command is executed only on the node where the node-list command was issued. /OUTPUT[=file-spec] /OUTPUT=stdout (D) Specifies that the resulting information is written to the file /OUTPUT file-spec Examples...
  • Page 209: Show Display

    SHOW DISPLAY Show which items were displayed by the most recently issued DISPLAY commands. Format SHOW DISPLAY Command Qualifiers /ALL /OUTPUT[=file-spec] /X=column /Y=row Description SHOW DISPLAY recently issued MONITOR file using the MONITOR file-spec DISPLAY commands. The item definitions are shown in DISPLAY command format. (The command SHOW DISPLAY/OUTPUT=file Qualifiers /ALL...
  • Page 210 SHOW DISPLAY Examples RTR> MON CALLS RTR> SHOW DISPLAY/ALL DISPLAY TEXT "RTR api calls, Node: $node_name ,- PID: $process_id, Process name: -ALL-" - /X=1 /Y=1 - /BOLD="1" DISPLAY NUMERIC /X=1 /Y=5 - /BLANK - /LABEL=" rtr_open_channel /WIDTH=9 Display the CALLS Show all the items contained in the monitor picture.
  • Page 211: Show Environment

    SHOW ENVIRONMENT Shows the default nodes used for remote command execution. Format SHOW ENVIRONMENT Description SHOW ENVIRONMENT remote command execution. Related Commands • SET ENVIRONMENT Examples RTR> SET ENVIRONMENT/NODE=(FE2,FE3) RTR> SHOW ENVIRONMENT %RTR-S-COMARESEN, commands sent by default to node FE2 %RTR-S-COMARESEN, commands sent by default to node FE3 Set the command environment so that subsequent commands will be executed on nodes FE2 and FE3.
  • Page 212: Show Facility

    SHOW FACILITY SHOW FACILITY Show the names, configuration and status of one or more facilities. Format SHOW FACILITY [facility-name] Command Qualifiers /BALANCE /CLUSTER /CONFIGURATION /COUNTER[=counter-name] /FULL /LINKS /STATE /OUTPUT[=file-spec] /NODE[=node-list] Description SHOW FACILITY facilities on the node where the command is executed. If no qualifiers are used, only the facility name or names and the roles in the facility on the node are displayed.
  • Page 213 /CONFIGURATION /NOCONFIGURATION (D) Specifies that the facility configuration is to be displayed. The configuration information indicates the role(s) of the the node where the command is executed, Whether router call-out servers or backend call-out servers have been configured, Whether load balancing has been configured, Whether quorum check is being handled on this node.
  • Page 214 SHOW FACILITY On a frontend, this qualifier can be used to find out whether the node is currently connected to a router. Related Commands • CREATE FACILITY • DELETE FACILITY • SHOW LINK Examples RTR> SHOW FACILITY/FULL/NODE=BRONZE Facility: FUNDS_TRANSFER Configuration:- Frontend: State:- FE ->...
  • Page 215 The facility’s links. The first link shown (to node ‘‘bronze’’ i.e. itself) shows that it is a router, connected to the backend, and the router is quorate. The router is not current because there is no frontend on this connection. The link is also a backend, connected to the router, and this backend is quorate.
  • Page 216: Show Journal

    SHOW JOURNAL SHOW JOURNAL Display information about current RTR journal files. Format SHOW JOURNAL Command Qualifiers /CLUSTER /FILENAMES /FULL /NODE[=node-list] /OUTPUT[=file-spec] Description SHOW JOURNAL and (optionally) the maximum and allocated number of blocks for each journal file and the journal file name. Qualifiers /CLUSTER /NOCLUSTER (D)
  • Page 217 Related Commands • CREATE JOURNAL • DELETE JOURNAL • INITIALIZE JOURNAL Examples RTR> SHOW JOURNAL/FULL/FILENAMES RTR journal:- Disk(1): /dev/rz3a File(1): /dev/rz3a /rtrjnl/SYSTEM/BRONZE.J01 Disk(2): /dev/rz2c File(2): /dev/rz2c /usr/users/rtrjnl/SYSTEM/BRONZE.J11 Show the disks used for RTR’s recovery journal and the filenames. Two disks are currently in use. Device name.
  • Page 218: Show Key

    SHOW KEY SHOW KEY Display the key definitions created by the Format SHOW KEY [key-name] Command Qualifiers /ALL /FULL /OUTPUT[=file-spec] /IF_STATE Description SHOW KEY command shows the key definitions created by the DEFINE /KEY command. Parameters key-name Specifies the name of the key whose definition you want displayed. See the description of the Qualifiers /ALL...
  • Page 219 Related Commands • DEFINE /KEY Examples RTR> SHOW KEY/FULL DEFAULT PF1 defined as "" DEFAULT KP0 defined as "MONITOR/RESUME" DEFAULT KP2 defined as "SCROLL DOWN 1" DEFAULT KP4 defined as "SCROLL LEFT 1" DEFAULT KP5 defined as "SCROLL HOME" DEFAULT KP6 defined as "SCROLL RIGHT 1" DEFAULT KP8 defined as "SCROLL UP 1"...
  • Page 220: Show Link

    SHOW LINK SHOW LINK Display the configuration and status of the links to other nodes. Format SHOW LINK [node-name] Command Qualifiers /CLUSTER /COUNTER[=counter-name] /FACILITY /FULL /NODE[=node-list] /OUTPUT[=file-spec] /STATE Description command shows the configuration and status of the links to RTR SHOW LINK nodes.
  • Page 221 /FULL Equivalent to specifying /NODE[=node-list] /NODE=default-node-list (D) Specifies that the command is executed on all nodes specified in node-list is omitted then the command is executed only on the node where the command was issued. /OUTPUT[=file-spec] /OUTPUT=stdout (D) Specifies that the resulting information is written to the file /OUTPUT file-spec /STATE...
  • Page 222: Show Log

    SHOW LOG SHOW LOG Display the names of the current log files. Format SHOW LOG Command Qualifiers /CLUSTER /NODE[=node-list] /OUTPUT[=file-spec] Description SHOW LOG command shows the names of the current RTR log files as defined with the SET LOG Qualifiers /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster.
  • Page 223 Example RTR> SHOW LOG Messages not being sent to operator console Log file[1]: Show where RTR log messages are currently written. Currently not being sent to the operator log. Currently being written to file /usr/users/someone/rtr_logfile.log rtr_logfile.log RTR Command Line Interface 6–147 SHOW LOG...
  • Page 224: Show Mode

    SHOW MODE SHOW MODE Displays the current RTR mode. Format SHOW MODE Command Qualifiers /CLUSTER /NODE[=node-list] /OUTPUT[=file-spec] Description SHOW MODE command shows the currently running user group for RTR. For nogroup (system) mode, a null group name is displayed. further information about modes. Qualifiers /CLUSTER /NOCLUSTER (D)
  • Page 225 SHOW MODE Examples RTR> SHOW MODE Group name is "develop" RTR Command Line Interface 6–149...
  • Page 226: Show Node

    SHOW NODE SHOW NODE Shows the node network status, the autoisolation state and the node inactivity timer. Format SHOW NODE Command Qualifiers /CLUSTER /NODE[=node-list] /OUTPUT[=file-spec] Description shows the network status, the autoisolation state (enabled or SHOW NODE disabled) and the node inactivity timer. Qualifiers /CLUSTER /NOCLUSTER (D)
  • Page 227 Examples RTR> SHOW NODE Node properties: Network state: Auto isolation: Inactivity timer/s: SHOW NODE command. Network status Auto isolation state (enabled or disabled). Inactivity timer value in seconds. enabled disabled RTR Command Line Interface 6–151 SHOW NODE...
  • Page 228: Show Partition

    SHOW PARTITION SHOW PARTITION Display server data partition information. Format SHOW PARTITION Command Qualifiers /BACKEND /BRIEF /CLUSTER /FACILITY /FULL /NODE[=node-list] /OUTPUT[=file-spec] /ROUTER Description SHOW PARTITION their states, and current transaction activity. This information is useful for diagnosing bottlenecks or partition difficulties in RTR. The ‘‘States’’...
  • Page 229: Router Partition States

    Table 6–21 Router Partition States State BLOCKED ACTIVE CATCHUP TAKEOVR LAGGING Qualifiers /BACKEND /NOBACKEND (D) Displays information about backend partitions; it shows the partition state and low and high bounds. /BACKEND with /FULL provides more detailed information for a partition, giving the current queue depth (transactions active) on a partition. This is useful for determining whether a server is processing transactions correctly.
  • Page 230 SHOW PARTITION • The state of transaction presentation - one of active, suspended or suspending • The current failover policy - one of fail_to_standby, fail_to_shadow or pre_ v32_compatibilty The SHOW PARTITION comand displays callout server data as backend server data because a callout server uses server, not router, data structures. A callout server actually runs on the router identified for its facility.
  • Page 231 Partition name: Facility: RTR$DEFAULT_FACILITY Low Bound: "aaaa" Active Servers: Transaction presentation: active Txns Active: Failover policy: fail_to_standby Partition name: Facility: RTR$DEFAULT_FACILITY Low Bound: "nnnn" Active Servers: Transaction presentation: active Txns Active: Failover policy: fail_to_standby SHOW PARTITION RTR$DEFAULT_PARTITION_16777217 State: High Bound: Free Servers: Last Rcvy BE: Txns Rcvrd:...
  • Page 232: Show Process

    SHOW PROCESS SHOW PROCESS Display information about processes which are using RTR. Format SHOW PROCESS Command Qualifiers /CLUSTER /COUNTER[=counter-name] /FULL /IDENTIFICATION=process-id /NODE[=node-list] /OUTPUT[=file-spec] Description SHOW PROCESS Qualifiers /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster. If neither /NODE nodes specified by the latest...
  • Page 233 /OUTPUT[=file-spec] /OUTPUT=stdout (D) Specifies that the resulting information is written to the file /OUTPUT file-spec Examples RTR> SHOW PROCESS Processes: Process-id is omitted then the standard or default output is used. Process Name RTR Command Line Interface 6–157 SHOW PROCESS .
  • Page 234: Show Requester

    SHOW REQUESTER SHOW REQUESTER See SHOW CLIENT. The SHOW REQUESTER command has been replaced by SHOW CLIENT and is retained for compatibility reasons only. 6–158 RTR Command Line Interface...
  • Page 235: Show Resource Manager (Show Rm)

    SHOW RESOURCE MANAGER (SHOW RM) Displays resource manager instance (RM) information. This command is available only on UNIX and Windows NT systems. Format SHOW RESOURCE MANAGER [resource_name] SHOW RM [resource_name] Command Qualifiers /CLUSTER /FULL /NODE[=node-list] /OUTPUT[=file-spec] Description The SHOW RESOURCE MANAGER command displays information for registered RMs.
  • Page 236 SHOW RESOURCE MANAGER (SHOW RM) /FULL /NOFULL (D) Displays additional information for facilities that reference a particular RM. If no rmi_name is included, displays information for all RMs. /NODE[=node-list] /NODE=default-node-list (D) Specifies that the command is executed on all nodes specified in is omitted then the command is executed only on the node where the node-list command was issued.
  • Page 237: Show Rtr

    SHOW RTR Display the configuration and status of RTR. Format SHOW RTR Command Qualifiers /CLUSTER /COUNTER[=counter-name] /FULL /NODE[=node-list] /OUTPUT[=file-spec] /STATUS /VERSION Description command displays the configuration and status of RTR. SHOW RTR Qualifiers /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster. If neither /NODE nodes specified by the latest...
  • Page 238 SHOW RTR /STATUS (D) /NOSTATUS Displays the current status of RTR (started, stopped and so on). /VERSION /NOVERSION (D) Displays the RTR version. Related Commands • STOP RTR • START RTR Example RTR> SHOW RTR RTR running on node baby.home.dec.com in group: develpr Show the state and configuration of RTR.
  • Page 239: Show Segment

    SHOW SEGMENT Display the type and size of routing key segments. Format SHOW SEGMENT Command Qualifiers /CLUSTER /FACILITY /FULL /NODE[=node-list] /OUTPUT[=file-spec] Description SHOW SEGMENT The routing key definition The routing key specifies the data within a message sent from clients used to route the message to a particular key range server.
  • Page 240 SHOW SEGMENT Examples RTR> SHOW SEGMENT Facility RTR$DEFAULT_FACILITY TEST_FAC Show the routing key segments for all facilities. The facility name, the routing key data type, key length and offset are shown for each facility. 6–164 RTR Command Line Interface Data Type Length UNSIGNED SIGNED...
  • Page 241: Show Server

    SHOW SERVER Display information about server channels. Format SHOW SERVER Command Qualifiers /CLUSTER /FACILITY /FULL /IDENTIFICATION=process-id /NODE[=node-list] /OUTPUT[=file-spec] Description SHOW SERVER Information such as PID, key range, state, event mask, event name and partition ID can be displayed. The ‘‘State:’’ field of the SHOW SERVER command can display the following values: Table 6–22 Key-range States State...
  • Page 242: Server Flags

    SHOW SERVER Table 6–23 Server Flags FLAG Qualifiers /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster. If neither /NODE nodes specified by the latest command has been entered then the command is executed only on the node where the command was issued.
  • Page 243 Examples RTR> SHOW SERVER Servers: Process-id Facility 20828 RTR$DEFAULT_FACILITY 20828 RTR$DEFAULT_FACILITY RTR> SHOW SERVER/FULL Servers: Process-id: Channel: State: High Bo Uents: Partition-Id: Process-id: Channel: State: High Bo User Events: Partition-Id: Channel 589825 655362 20828 Facility: RTR$DEFAULT_FACILITY 589825 Flags: active Low Bound: mmmm rcpnam: RTR Events:...
  • Page 244: Show Transaction

    SHOW TRANSACTION SHOW TRANSACTION Displays information about currently active transactions. Format SHOW TRANSACTION Command Qualifiers /BACKEND /CLUSTER /FACILITY /FRONTEND /FULL /IDENTIFICATION=process-id /NODE[=node-lisft] /OUTPUT[=file-spec] /ROUTER Description SHOW TRANSACTION transaction ID, facility, transaction state, frontend user, start time and router node. Qualifiers /BACKEND /NOBACKEND (D) Specifies that information should be listed for transactions in a backend node.
  • Page 245: Key-Range States

    Note: In environments that do not support clustering, use of the /CLUSTER qualifier will cause the relevant command to be executed on the local node only. /FRONTEND /NOFRONTEND (D) Specifies that information should be listed for transactions in a frontend node. If none of /BACKEND, /FRONTEND or /ROUTER are specified, then information for all of them are displayed.
  • Page 246 SHOW TRANSACTION Table 6–25 (Cont.) Key-Range States State active sec_act pri_act pri_lone sec_chup Examples RTR> SHOW TRANSACTION/BACKEND/FULL Backend transactions: Tid: Facility: RTR$DEFAULT_FACILITY Frontend: State: Router: Active-Key-Ranges: Total-Tx-Enqs: Server-Pid: Journal-Node: First-Enq: Nr-Replies: 6–170 RTR Command Line Interface Meaning Active non-shadowed Secondary active Primary active Primary running alone Secondary is catching up...
  • Page 247: Spawn

    SPAWN Allows you to execute operating system commands without leaving the RTR utility. Format SPAWN [operating-system-command] Command Qualifiers /INPUT=file-spec /OUTPUT=file-spec /WAIT Description command allows you to execute operating system commands without SPAWN leaving the RTR session. If you specify an operating system command as the parameter to SPAWN, the command is executed in the context of a spawned subprocess.
  • Page 248: Start Rtr

    START RTR START RTR Start RTR on one or more nodes. Format START RTR Command Qualifiers /CLUSTER /NODE[=node-list] /OUTPUT[=file-spec] The following qualifiers are only relevant when running on OpenVMS. Command Qualifiers /ASTLM=ast-limit /BIOLM=io-buffered /BYTLM=buffer-limit /CPULM=time-limit /DIOLM=io-direct /ENQLM=enqueue-limit /FILLM=file-limit /JTQUOTA=job-table-quota /LINKS=max-links /PARTITIONS=max-partitions /PGFLQUOTA=page-file /PRCLM=subprocess-limit...
  • Page 249 Qualifiers /ASTLM=ast-limit /ASTLM=(max-links + max-processes) Specifies the AST limit for the RTR ACP. The value for ast-limit scheduling and a minimum of two per DECNET logical link maintained by RTR. For example, in a 20-node configuration, a router node needs an ASTLM of at least 45 ( 5 + (20 In systems where a lot of traffic is expected, defining additional ASTLM quota will enable lookahead I/O to be booked to channels without RTR ACP being held...
  • Page 250 START RTR /DIOLM=io-direct /DIOLM=(max-links + max-processes) Specifies the maximum number of direct I/O operations that the RTR ACP can have outstanding at any one time. If you do not specify a direct I/O quota, the default value established at system generation time is used.
  • Page 251 The default value of is automatically calculated, based on the values of page-file /LINKS and /PROCESSES. /PRCLM=subprocess-limit /PRCLM=10 (D) Specifies the maximum number of subprocesses that the RTR ACP can create. The default for subprocess-limit /PRIORITY=priority /PRIORITY=6 (D) Requires alter priority (ALTPRI) privilege to set the priority higher than your current process.
  • Page 252 START RTR Related Commands • SHOW RTR • STOP RTR Examples See Chapter 2, Starting and Setting Up RTR, for examples of how to use the command. START RTR 6–176 RTR Command Line Interface...
  • Page 253: Stop Rtr

    STOP RTR Stop RTR on one or more nodes. Format STOP RTR Command Qualifiers /ABORT /CLUSTER /NODE[=node-list] /OUTPUT[=file-spec] Description STOP RTR command stops RTR in an orderly manner. Alternatively, RTR can be stopped in an abrupt manner (/ABORT), and any applications using RTR are forced to exit.
  • Page 254 STOP RTR /OUTPUT[=file-spec] /OUTPUT=stdout (D) Specifies that the resulting information is written to the file /OUTPUT file-spec Related Commands • SHOW RTR • START RTR Examples See Chapter 2, Starting and Setting Up RTR, for examples of how to use the command.
  • Page 255: Trim Facility

    TRIM FACILITY Removes nodes or roles or both from an existing facility definition. Format TRIM FACILITY [facility_name] Command Qualifiers /BACKEND=backend-list /CLUSTER /FRONTEND=frontend-list /NODE[=node-list] /OUTPUT[=file-spec] /ROUTER=router-list Description TRIM FACILITY definition. A node can be removed from a facility or a role can be removed from a node.
  • Page 256 TRIM FACILITY RTR MONITOR QUORUM displays a monitor picture which allows the quorum negotiations to be observed. You can use this after using a TRIM FACILITY command; once quorum has been re-attained, the participating nodes return to the quorate state. For example, in a three node facility called only frontend roles, and node This facility could have been created as follows:...
  • Page 257 /NOFRONTEND (D) Specifies the names of nodes where the frontend role is removed for this facility. is a list of frontend-list than one frontend-node is either the name of a node or frontend-node specifies a text file containing a /NODE[=node-list] /NODE=default-node-list (D) Specifies that the command is executed on all nodes specified in is omitted then the command is executed only on the node where the...
  • Page 258: Unregister Resource Manager (Unregister Rm)

    UNREGISTER RESOURCE MANAGER (UNREGISTER RM) UNREGISTER RESOURCE MANAGER (UNREGISTER RM) UNREGISTER RESOURCE MANAGER resource manager. Format UNREGISTER RESOURCE MANAGER [resource_name] UNREGISTER RM [resource_name] Command Qualifiers /CLUSTER /NODE[=node-list] /OUTPUT[=file-spec] Description The UNREGISTER RESOURCE MANAGER command unregisters an instance of a resource manager. The command succeeds only when no facility references it.
  • Page 259: A Creating Monitor Pictures

    Creating Monitor Pictures The standard monitor pictures provided with RTR (described in Chapter 5) are sufficient for most needs. You may also create your own monitor pictures to suit particular needs. This appendix tells you how to do this. The RTR monitor utility provides a means to continuously display the status of RTR and the applications using it.
  • Page 260: Interactive Definition Of A Monitor Picture

    Creating Monitor Pictures The commands used to define and display monitor pictures are: CLEAR DISPLAY BAR DISPLAY NUMERIC DISPLAY STRING DISPLAY SYMBOLIC DISPLAY TEXT MONITOR SCROLL SHOW DISPLAY These commands are described in the following sections. A.1 Interactive Definition of a Monitor Picture Example A–1 shows a monitor picture being defined in an interactive RTR session.
  • Page 261: Interactively Defined Monitor Picture

    Figure A–1 Interactively Defined Monitor Picture SOME DATA ITEM: OTHER DATA ITEM: 0 Because monitor file definitions depend on the internal structure and data items of RTR, they may need to be changed for future versions of RTR. A.2 Substitution Symbols The text and labels in the DISPLAY commands that are used to define monitor pictures can contain symbols which are substituted when the picture is displayed.
  • Page 262: Arithmetic Expressions And Operators

    Creating Monitor Pictures A.3 Arithmetic Expressions and Operators Table A–3 Arithmetic Operators in Display Commands Characters & <= >= <> < > Example A–2 shows how these operators are used. Example A–2 Arithmetic Operators Examples RTR> DISPLAY NUMERIC RTR_SOME_DATA_ITEM+2 RTR> MONITOR RTR>...
  • Page 263 A.3 Arithmetic Expressions and Operators Aggregation of Data Items DISPLAY commands which select multiple instances of a data item (for example, multiple instances of a process counter) can use the following keywords to control the way the items are aggregated. _MIN—select the data item instance with the lowest value _MAX—select the data item instance with the higheest value By default, data items are totaled unless the...
  • Page 265: B Server Shadowing And Recovery

    Server Shadowing and Recovery RTR shadowing gives you the ability to recover from a site disaster without the need for special coding within your application program. This appendix is an introduction to RTR shadowing. A server for a database partition is said to be shadowed when two copies of the same server perform identical actions on identical database copies on separate nodes.
  • Page 266: The Rtr Journal System

    Server Shadowing and Recovery B.2 Automatic Features • RTR_EVTNUM_SRSHADOWGAIN - Server has gained its shadow partner • RTR_EVTNUM_SRRECOVERCMPL - Server has completed recovery The shadow events are delivered with no special status and no data. They are delivered only to the server(s) whose state has changed. A server receives RTR_EVTNUM_SRPRIMARY under the following circumstances: •...
  • Page 267: Shadow Site Failure And Journaling

    The number of blocks specified by the /BLOCKS qualifier specifies the size of the journal that RTR attempts to keep to. (The actual number of blocks used may vary, depending upon the load on RTR.) The command MODIFY JOURNAL also accepts the /BLOCKS and /MAXIMUM_ BLOCKS qualifiers.
  • Page 268: Maximum Journal Size

    Server Shadowing and Recovery B.4 Shadow Site Failure and Journaling B.4.1 Maximum Journal Size The current maxima for the size of a journal are: Number of blocks per disk: 524288 (This is max_segments_per_disk * disk_blocks_per_segment 32.) Number of disks per journal: 16. B.5 Standby for Shadows Shadowed sites can either be two nodes within a single cluster, or can be two separate clusters.
  • Page 269: Shadows In Action

    Note that RTR does not have to wait for the secondary shadow server to complete its processing. It only needs to know that the primary has committed the transaction and that the journal file of the secondary shadow server contains the final vote status.
  • Page 270: B.9 Server States

    Server Shadowing and Recovery B.8 Application Considerations • Any physical reference to the transaction which is unique to the executing server, e.g. Channel Id, system time, DB-key, etc., should not be passed back to the client for future references within its subsequent messages, as this could lead to inconsistent handling when a different server is involved in shadow operations.
  • Page 271: Server States

    Figure B–2 Server States INITIAL Propose KR Backend not to Routers yet quorate W A I T − T R − R E T R Y Retry W A I T _ Q U O R U M Router detects definition clash Propose KR to Routers...
  • Page 272: Client States

    Server Shadowing and Recovery B.10 Client States B.10 Client States The current state of a client process can be examined as follows: RTR> show client/full Clients: Process-id: Channel: State: User Events: Figure B–3 describes the client state changes which appear in the "State:" field Figure B–3 Client States Requester State Transitions INITIAL...
  • Page 273: Partition States

    B.11 Partition States The current state of a key-range partition can be examined using the command for the routers and the backends: PARTITION/FULL RTR> show partition/router/full Facility: RTR$DEFAULT_FACILITY Low Bound: Failover policy: Backends: States: Primary Main: Backend partitions: RTR> show partition/backend/full Partition name: Facility: RTR$DEFAULT_FACILITY...
  • Page 275: C Xa Support

    This appendix explains how RTR may be used with a X/OPEN Distributed Transaction Processing (DTP) conformant Resource Manager. C.1 Introduction The X/OPEN Distributed Transaction Processing (DTP) architecture defines a standard interface that lets application programs share resources provided by resource managers. The XA interface uses the two-phase commit protocol to commit transactions, and is a system-level bidirectional interface between the transaction manager (TM) and the resource manager (RM).
  • Page 276: Modified Rtr Api

    XA Support C.1 Introduction facility_name = user-specified facility name /resource_manager = the name of those RMs this facility references For example: CREATE FACILITY test /front=N1 /back=N2/router=N3 /resource_manager=(employ_rm,payroll_rm) C.1.3 Modified RTR API An application written to use RTR with XA does not need all existing RTR application programming interface statements.
  • Page 277: D Rtr Utility Error Messages

    RTR Utility Error Messages This appendix describes the various error messages that can be returned by the RTR utility. %RTR-F-ABKEYW, Ambiguous qualifier or keyword - supply more characters Explanation: Too few characters were used to truncate a keyword or qualifier name to make the keyword or qualifier name unique. %RTR-F-ABVERB, Ambiguous command verb - supply more characters Explanation: Too few characters were used to truncate a command name to make the command name unique.
  • Page 278 RTR Utility Error Messages %RTR-F-BADDSKWRI, Unable to create/extend a journal file Explanation: An attempt to create or extend a journal file on disk failed. Check that the disk(s) you are using for journals have sufficient free space. %RTR-E-BADOP, Unable to complete operation @[A] line [A] Explanation: Processing definition incomplete or undefined - report occurrence together with supporting information on current command to RTR Engineering.
  • Page 279 %RTR-E-CLOSEPEND, Send failed due to close pending on channel - call rtr_ receive_message Explanation: Sending of data to the ACP has been aborted due to the presence of an undelivered mt_closed message on the channel. The application may retrieve the reason for the channel closure, by calling the receive_message verb to receive the mt_closed message.
  • Page 280 RTR Utility Error Messages %RTR-S-DISITMCLR, [A] display item(s) cleared Explanation: Indicates how many display items [A] were successfully cleared after issuing a CLEAR DISPLAY command. %RTR-W-DISKALL, Disk is not available to RTR Explanation: An attempt was made to create a journal on a disk which is allocated to a different process.
  • Page 281 %RTR-F-DUPJOUFIL, Duplicate RTR journal file found - remove duplicate file or CREATE JOURNAL /SUPERSEDE Explanation: A duplicate RTR journal file has been found. This status may be returned by the CREATE FACILITY and SHOW JOURNAL commands. Probable cause: System management error. A user has copied a journal file, or a disk containing a journal file.
  • Page 282 RTR Utility Error Messages %RTR-F-ERRACCDIR, Directory [A], cannot be accessed or opened Explanation: A directory cannot be accessed or opened. %RTR-E-ERRACCFIL, Error accessing file [A] Explanation: Displays the name [A] of a file that the RTR utility was unable to access. %RTR-E-ERRACCMBX, Error accessing mailbox Explanation: An error occurred whilst accessing a mailbox.
  • Page 283 %RTR-E-ERRSTAACP, Unable to start ACP Explanation: The RTR ACP process could not be started when a "START RTR" command was issued. The subsequent message gives more details. %RTR-E-ERRSTARCH, Unable to start remote client handler Explanation: The RTR remote client handler process could not be started when a "START REMOTE_CLIENT_HANDLER"...
  • Page 284 RTR Utility Error Messages %RTR-E-FACNAMLON, Facility name [A] is longer than 30 characters Explanation: Facility name [A] is too long. %RTR-E-FACNAMSTA, Facility name [A] does not start with a letter Explanation: Facility name [A] does not start with a capital letter ("A" to "Z").
  • Page 285 %RTR-E-ILLPARTCHAR, Legal characters are alphanumeric and under-score Explanation: Illegal chars in partition name argument. %RTR-E-ILLREMDEV, Device [A] contains a node specification Explanation: RTR cannot create its journal files on remote systems. Re-issue the "CREATE JOURNAL" command for local disk. %RTR-E-INSUFPRIV, Insufficient privileges to run RTR Explanation: More privileges required to run the RTR utility.
  • Page 286 RTR Utility Error Messages %RTR-F-INVKSTYPE, Invalid ks_type argument Explanation: Invalid ks_type argument. %RTR-F-INVMSGFMT, Invalid format argument Explanation: Invalid format argument. Possible reasons include the use of an invalid character or expression in the format string, or a mismatch in the number of bytes specified by the format string and the message length argument.
  • Page 287 %RTR-E-ITMALREXI, There is already something displayed at x = [A], y = [A] Explanation: Indicates that invalid coordinates were specified on a "DISPLAY" command within a display file. There already is an item at point [A], [B]. %RTR-F-IVKEYW, Unrecognized keyword - check validity and spelling n [A] Explanation: A keyword specified in a command is not valid for the command.
  • Page 288 RTR Utility Error Messages %RTR-F-JOUFORCHA, Journal format has been changed - CREATE JOURNAL /SUPERSEDE Explanation: The journal file(s) found have an out-of-date format. This status may be returned by the CREATE FACILITY and SHOW JOURNAL commands after a new version of RTR has been installed on a system. Corrective action: Issue an RTR CREATE JOURNAL /SUPERSEDE command.
  • Page 289 %RTR-S-JOURNALINI, Journal has been created on device [A] Explanation: Confirms that the RTR journal has been successfully created on device [A] after issuing the "CREATE JOURNAL" command. %RTR-S-JOURNALMOD, Journal has been modified on device [A] Explanation: Confirms that the RTR journal has successfully modified the size requirements on device [A] after issuing the "MODIFY JOURNAL"...
  • Page 290 RTR Utility Error Messages %RTR-E-LOCKFAIL, Cannot obtain lock for resource [A] Explanation: Failed to obtain lock. Enable logging for more information about error. %RTR-S-LOGFILSET, Logging to [A] Explanation: Displays which log files will be used after issuing a "SET LOG" command with the "/FILE" or "/OPERATOR" or both qualifiers. %RTR-S-LOGFILSUP, Logging suppressed Explanation: Indicates that logging is successfully suppressed after issuing a "SET LOG command"...
  • Page 291 %RTR-E-NDBTABFUL, The NDB table is full Explanation: This message is displayed when an "CREATE FACILITY" command is issued. It indicates that the total number of different nodes specified with this and all previous "CREATE FACILITY" commands would exceed the limit specified with the "/LINKS" qualifier when RTR was started. %RTR-E-NFW, Operation requires "SETPRV"...
  • Page 292 RTR Utility Error Messages %RTR-E-NODNA, DECnet specified for [A], but transport protocol unavailable or disabled Explanation: DECnet was specified as required through use of a node name prefix ("dna." or a substitute), but no corresponding entry in the node database can be found. Add an entry for the indicated node to your local node name database or to you name server.
  • Page 293 %RTR-E-NOKEYSEGS, You must specify at least one keysegment - use /KEY1 - /KEY9 Explanation: Except for a callout partition, it is necessary to define the key range, so the absence of any key segment descriptors is an error. %RTR-F-NOKEYW, Qualifier name is missing - append the name to the slash Explanation: A slash character is on the command line but is not followed by a qualifier keyword name.
  • Page 294 RTR Utility Error Messages %RTR-E-NOSUCHITM, Nothing displayed at x = [A], y = [A] Explanation: Indicates that invalid coordinates were specified on a "CLEAR DISPLAY" or "SHOW DISPLAY" command. No item is displayed at point [A], [B]. %RTR-E-NOSUCHNOD, No such node, [A] Explanation: The requested node [A] does not exist.
  • Page 295 %RTR-E-NUMCONILL, Numeric constant has illegal syntax, [A] Explanation: The numeric constant [A] is invalid. %RTR-W-OBSQUAL, Qualifier [A] is obsolete - value ignored Explanation: An obsolete qualifier has been specified on a command line. The qualifier no longer has any effect, and the specified value will be ignored. %RTR-E-ONLONENOD, Only one node allowed if process ID specified Explanation: If a process ID is supplied on "MONITOR"...
  • Page 296 RTR Utility Error Messages %RTR-E-PRTBADCMD, Partition command invalid or not implemented in this version of RTR Explanation: Status return indicating that the ACP received a request for an unknown partition command. %RTR-E-PRTBADFPOL, Unrecognised partition failover policy code Explanation: Status indicating that an invalid value was specified for the partition failover policy.
  • Page 297 %RTR-S-PRTNCREATED, Partition created Explanation: The requested partition was successfully created. %RTR-S-PRTNDELETED, Partition deleted Explanation: The requested partition was successfully deleted. %RTR-S-PRTNEWFPOLS, Failover policy set Explanation: Status indicating successful change to the partition failover policy. %RTR-S-PRTNEWPOLWAIT, Failover policy stored - awaiting servers before taking effect Explanation: Status indicating successful change to the partition failover policy, but the change will only take effect once servers have been started.
  • Page 298 RTR Utility Error Messages %RTR-E-PRTRUNDOWN, Partition is in rundown prior to deletion - no action taken Explanation: Cannot perform the requested action since the partition is being deleted. %RTR-I-PRTSHDOFF, Partition [A]:[A] shadow state set to off by operator [A] Explanation: Written to log file in response to a user request to change the state of partition shadow state.
  • Page 299 %RTR-E-RTRALRSTA, RTR already started Explanation: RTR was already running when the "START RTR" command was executed. %RTR-S-RTRLOGENT, [A] Explanation: The RTR LOG command was used to make an entry in the RTR LOG %RTR-I-RTRNOTRUN, RTR not running Explanation: Message created specifically for the STOP RTR command if RTR is not currently running, so that the IVP does not report a fatal message.
  • Page 300 RTR Utility Error Messages %RTR-F-SPUJOUFIL, Spurious RTR journal file found - remove extra file, or CREATE JOURNAL /SUPERSEDE and submit SPR Explanation: A spurious RTR journal file has been found which does not correspond to the other journal files on the system. This status may be returned by the CREATE FACILITY and SHOW JOURNAL commands.
  • Page 301 %RTR-E-TOOMANCHN, Too many channels Explanation: Displayed when a "SYS$DCL_TX_PRC" command is issued and the channel table is full. %RTR-F-TOOMANDIS, Too many disks specified in journal definition Explanation: Explanation: Too many disks were specified in journal definition. The RTR journal can be defined to use up to a maximum of sixteen disks.
  • Page 302 RTR Utility Error Messages %RTR-E-UNEXPEND, Expression ended before [A] encountered Explanation: The expression is invalid because it terminated where when token [A] was expected. %RTR-E-UNKNOWQUAL, Invalid qualifier keyword value - check your program Explanation: Status return indicating that an unrecognised qualifier keyword value was supplied.
  • Page 303: E Rtr Log Messages

    This appendix describes the various error messages that can be sent to the operator console or written to RTR’s operator log file. %RTR-E-ABODEAREQ, Transaction aborted that was started by client that has since exited Explanation: Indicates that a transaction has been aborted that was started by a client that has since exited.
  • Page 304 RTR log messages %RTR-E-BADIDSIZ, Bad node ID size [A] detected at 0x[A] Explanation: This message indicates that errors have been detected in processing of an internal node identifier. The presence of this message indicates a serious problem in the configuration of the network name/address databases, and RTR will likely be unable to operate correctly.
  • Page 305 %RTR-F-BRODISLIN, Broadcast message(s) discarded because of link unavailability Explanation: One or more broadcast messages had to be discarded because there is no logical link to the destination node. %RTR-I-CLUENABLED, RTR cluster [A] is enabled using [A] Explanation: Information message indicating whether RTR is making use of any specific cluster software.
  • Page 306 RTR log messages %RTR-I-CONNALIAS, Link [A] connected as [A] Explanation: Support for internet tunnels allows for the configuration of links from which connections appear to originate with an source address other than that by which the local node is registered locally, for example, the connection may appear to originate from an pseudo-adapter address assigned by the tunnel server.
  • Page 307 %RTR-I-FACLOSTFE, Facility [A] lost Frontend node [A] Explanation: This node is no longer a current router on facility [A], for frontend node [B] %RTR-I-FACLOSTTR, Facility [A] lost Router node [A] Explanation: A connection has been lost with router node [B] on facility [A] %RTR-E-FACNOTDEC, Facility name not matched Explanation: Result of a connection attempt to a remote node specifying a facility that does not (yet) exist on the remote node.
  • Page 308 RTR log messages full). RTR has ensured that the TX has been committed, but the operator should nevertheless check the condition on the BE where the TX was aborted to determine why this occurred (possible resource problems on the server, for example).
  • Page 309 %RTR-I-JOUSEACOM, Journal search on facility [A] completed. [A] recoverable transactions found Explanation: Journal search has completed. This message appears when RTR is started The number of transactions needing recovery is indicated by [A]. %RTR-F-JOUSEQERR, RTR journal record sequence error - CREATE JOURNAL /SUPERSEDE and submit SPR Explanation: An inconsistency has been found in the record sequence within the RTR journal.
  • Page 310 RTR log messages %RTR-E-NOCURRTR, Current router search failed for facility [A] Explanation: None of the routers specified for facility [A] are currently connectable. The search will continue after a short interval. %RTR-W-NODENOTCNFG, Node is not configured for the facility Explanation: Result of a connection attempt to a remote node where the connecting link is not configured in the requested facility at the remote node.
  • Page 311 %RTR-I-PRTCMDFRMBE, Command received for partition [A]:[A] from backend node [A] Explanation: Log file message indicating the origin of a command. %RTR-E-PRTDELCAN, Partition deleted - operation canceled Explanation: Status used to terminate a pending operation when the partition is deleted prior to completion of the operation. %RTR-W-PRTLCLRECEXIT, Partition [A]:[A] local recovery terminated by operator [A] Explanation: Log message indicating that recovery wait override requested...
  • Page 312 RTR log messages %RTR-E-PRTSETFAILTR, Router unable to process command Explanation: A partition set command failed at the router. An entry is written to the log file describing the problem. Message arguments are the facility name and the KR ID. A second message is written detailing the nature of the problem.
  • Page 313 %RTR-F-QIROVERFLOW, No more QIRs left Explanation: This status is used to indicate an inadequacy in the static reservations for the internal query initiation descriptors. Make a note of all QRM counters using SHOW RTR /COUNTER=QRM* Send SPR with the corresponding RTRACP dump. %RTR-F-RAEOVERFLOW, No more RAEs Explanation: This status is used to indicate an inadequacy in the static reservations for the internal response acceptor elements.
  • Page 314 RTR log messages %RTR-W-RSPFAC, Response from Node [A] about Facility [A] Explanation: A negotiation with remote node [A] about facility [B] has failed for the reason reported in the following line. This may be a reason for system manager intervention. %RTR-W-RSPNODE, Connection to node [A] failed : reason is Explanation: A negotiation with remote node [A] about facility [B] has failed for the reason reported in the following line.
  • Page 315 %RTR-W-TOOMANYNETIDS, Too many net IDs for node ’[A]’ - check for and eliminate any unnecessary adapter/protocol combinations Explanation: On a system configured to run multiple network protocols over multiple adpaters, RTR can run out of space to store and communicate the resultant node IDs.
  • Page 317: Index

    Active Monitor, 5–2 Aggregation of Data Items, A–5 Backend, 2–1 DISPLAY, 6–67 Broadcast Monitor, 5–2 Call Rtr_accept_tx, 6–3 rtr_prepare_tx, 6–22 CALL RTR_BROADCAST_EVENT, 6–6 RTR_CLOSE_CHANNEL, 6–10 RTR_ERROR_TEXT, 6–12 RTR_GET_TID, 6–13 RTR_OPEN_CHANNEL, 6–15 RTR_RECEIVE_MESSAGE, 6–25 RTR_REJECT_TX, 6–28 RTR_REPLY_TO_CLIENT, 6–31 RTR_REQUEST_INFO, 6–35 RTR_SEND_TO_SERVER, 6–38 RTR_START_TX, 6–42 Call-out server, 2–7 Calls...
  • Page 318 DTC Support, C–2 ENVIRONMENT SET, 1–4, 6–108 SHOW, 6–135 Errors, 1–2 Event Monitor, 5–2 EXECUTE, 6–89 EXIT, 6–90 EXTEND FACILITY, 6–91 Facility, 1–1 Create, 2–1 Monitor, 5–2 FACILITY CREATE, 6–47 DELETE, 2–4, 6–61 EXTEND, 6–91 SET, 6–109 SHOW, 6–136 TRIM, 6–179 @file, 1–3 Flow Monitor, 5–2...
  • Page 319 Monitor (cont’d) Routing, 5–3 Rtr, 5–3 Stalls, 5–3 System, 5–3 Tps, 5–3 Tpslo, 5–3 Traffic, 5–3 V2calls, 5–4 XA, 5–4 MONITOR, 5–1, 6–100 Monitor file, 5–1 Monitor picture, 5–1, A–1 NAME_CACHE FLUSH, 6–88 Netbytes Monitor, 5–3 Netstat Monitor, 5–3 Network transports, 2–13 NODE SET, 6–120 SHOW, 6–150...
  • Page 320 SET (cont’d) MODE, 6–118 NODE, 6–120 PARTITION, 6–122 TRANSACTION, 6–125 SHOW CHANNEL, 6–129 CLIENT, 6–131 DISPLAY, 6–133, A–2 ENVIRONMENT, 6–135 FACILITY, 6–136 JOURNAL, 6–140 KEY, 6–142 LINK, 6–144 LOG, 6–146 MODE, 6–148 NODE, 6–150 PARTITION, 6–152 PROCESS, 6–156 REQUESTER, 6–158 RESOURCE MANAGER, 6–159 RM, 6–159 RTR, 6–161...

This manual is also suitable for:

Reliable transaction router, version 3.2

Table of Contents