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: This manual supersedes Version 3.1D of the System Manager’s Manual Software Version: Reliable Transaction Router, Version 3.
June, 1999 COMPAQ COMPUTER CORPORATION SHALL NOT BE LIABLE FOR TECHNICAL OR EDITORIAL ERRORS OR OMISSIONS CONTAINED HEREIN, NOR FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES RESULTING FROM THE FURNISHING, PERFORMANCE, OR USE OF THIS MATERIAL. THIS INFORMATION IS PROVIDED "AS IS" AND COMPAQ COMPUTER CORPORATION DISCLAIMS ANY WARRANTIES, EXPRESS, IMPLIED OR STATUTORY AND EXPRESSLY DISCLAIMS THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR PARTICULAR PURPOSE, GOOD TITLE AND AGAINST INFRINGEMENT.
Contents Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi 1 Introduction 1.1 1.2 1.3 1.4 1.5 Getting Started . . . . . Entering Commands . Online Help . . . . . . . . Command Procedures Remote Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
.2.14 5.2.15 5.2.16 5.2.17 5.2.18 5.2.19 5.2.20 5.2.21 5.2.22 5.2.23 5.2.24 5.2.25 5.2.26 5.2.27 5.2.28 5.2.29 5.2.30 5.2.31 5.2.32 5.2.33 5.2.34 5.2.35 5.2.36 5.2.37 Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor Monitor IPCRATE . . Journal . . . . Link . . . . . . Netbytes . . . Netstat . . . . Partit . . . . . Queues . . . . Quorum . . . Recovery . . . Rejects . . .
DISPLAY BAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DISPLAY NUMERIC . . . . . . . . . . . . . . . . . . . . . . . . . . . DISPLAY STRING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DISPLAY SYMBOLIC . . . . . . . . . . . . . . . . . . . . . . . . . . DISPLAY TEXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FLUSH NAME_CACHE . . . . . . . . . . . . . . . . . . . . . . . .
STOP RTR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TRIM FACILITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UNREGISTER RESOURCE MANAGER (UNREGISTER RM) . . . . . . . . . 6–177 6–179 6–182 A Creating Monitor Pictures A.1 A.2 A.3 Interactive Definition of a Monitor Picture . . . . . . . . . . . . . . . . . . . . . . . . Substitution Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Figures 2–1 2–2 A–1 B–1 B–2 B–3 B–4 Configuration Example . . . . . . . . . . . . . . . Extend Configuration Example . . . . . . . . . Interactively Defined Monitor Picture . . . . Four Node Shadow/Standby Configuration . Server States . . . . . . . . . . . . . . . . . . . . . . . Client States . . . . . . . . . . . . . . . . . . . . . . . Router Partition States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
A–3 Arithmetic Operators in Display Commands . . . . . . . . . . . . . . . . . . . .
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. The reader is assumed to be familiar with their operating system, but not necessarily experienced with RTR operations.
Related Documentation • Release Notes • Installation Guide • Application Programmer’s Reference Manual • 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. Conventions Table 1 describes the conventions used in this guide.
Table 1 Conventions Used in this Guide Convention Meaning UPPERCASE lowercase Some operating systems differentiate between lowercase and 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.
1 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. In order to use RTR, you must install the RTR software and your application.
Introduction 1.2 Entering Commands or, when several commands are to be entered at the RTR prompt: % rtr RTR> start rtr RTR> create journal Note 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. Most RTR commands accept qualifiers: these are indicated by the forward slash (/) character.
Introduction 1.3 Online Help where error-identification is the identification part of the returned error. The following sequence returns an error message, RTRALRSTA, that can then be explained by the help errors rtralrsta command option: % 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. This error message is displayed by the RTR utility. RTR> 1.
Introduction 1.5 Remote Commands This command starts RTR on the three nodes. Note 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. For example Windows 95 systems do not support clustering.
2 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 facility must be defined on each node of the application’s environment. This is done by issuing the start rtr and create facility commands on each participating node.
Starting and Setting Up RTR 2.2 Setting Up—An Example Figure 2–1 Configuration Example Frontends ( F E ) Routers(TR) FE1 Backends(BE) BE1 TR1 BE2 FE2 TR2 BE3 FE3 SMM_CONFIG_EX01−99 In this example, the application client processes run on the nodes FE1, FE2 and FE3. The servers run on BE1, BE2 and BE3. Nodes TR1 and TR2 are routers and have no application processes running on them. This diagram shows all possible connections. The frontend connects to only one router at a time.
Starting and Setting Up RTR 2.2 Setting Up—An Example Example 2–2 illustrates how to use RTR remote commands to start the same configuration. The set environment command is used to send subsequent commands to a number of RTR nodes.
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 rtrjnl/groupname directory so that RTR will 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.
Starting and Setting Up RTR 2.4 Changing a Facility Example 2–3 Reconfiguration Using Delete and Create Facility % rtr RTR> stop rtr/node=FE3 1 RTR> delete facility funds_transfer/node=TR2 2 RTR> create facility funds_transfer/node=TR2 - 3 _RTR> /frontend=(FE1,FE2) _RTR> /router=TR2 ) RTR> delete facility funds_transfer/node=TR1 4 RTR> create facility funds_transfer/node=TR1 - 5 _RTR> /frontend=(FE1,FE2) _RTR> /router=TR1 ) 1 RTR is stopped on node FE3, the node being excluded from the network.
Starting and Setting Up RTR 2.4 Changing a Facility Figure 2–2 Extend Configuration Example FRONTENDS ROUTERS BACKENDS BE1 FE1 TR1 BE2 FE2 TR2 FE3 BE3 TR3 FE4 SMM_CONFIG_EX_EXT02−99 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. Likewise, TR3 must be informed about FE3 and FE4. Example 2–4 shows the extend facility command used for this reconfiguration.
Starting and Setting Up RTR 2.4 Changing a Facility Example 2–4 Reconfiguration Using Extend Facility % RTR RTR> start rtr /node=(TR3,FE4) RTR> set environment/node= - 1 _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) 2 RTR> extend facility funds_transfer _RTR> /router=TR1/frontend=FE4 3 1 The set environment is used to send the following command to all nodes in the facility, including the new nodes.
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> /router=(TR1,TR2) _RTR> /backend=(BE1,BE2,BE3) _RTR> /call_out=router 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.
Starting and Setting Up RTR 2.6 Router Load Balancing • Use /balance on frontend nodes only. Use of /balance on routers is supported 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 /balance.
Starting and Setting Up RTR 2.7 RTR Privileges The rtrinfo group is currently only used to allow applications to call rtr_request_info( ) For other users, create the groups rtroper and rtrinfo Users who do not fall into the above categories, but are members of the rtrinfo group can only use RTR commands that display information (SHOW, MONITOR, call rtr_request_info, etc.). If the groups rtroper and rtrinfo are not defined, then all users automatically belongs to them.
Starting and Setting Up RTR 2.8 RTR ACP Virtual Memory Sizing • 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 • Add the size of all replies The total of all the contributions listed will yield an estimate of the likely virtual memory requirements of the RTR ACP.
Starting and Setting Up RTR 2.8 RTR ACP Virtual Memory Sizing Use of /LINK and /PROCESSES do not take into account memory requirements for transactions. If an application passes a large amount of data from client to server or vice-versa this should be included in the sizing calculations. For further information on the START RTR qualifiers see the START RTR command in the Command Reference section.
Starting and Setting Up RTR 2.8 RTR ACP Virtual Memory Sizing 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. 2.
Starting and Setting Up RTR 2.9 Network Transports 2.9.2 Using RTR with DHCP and Internet Tunnels When using RTR with DHCP or an Internet tunnel, a nodename may not be fully known; special naming techniques are provided for these conditions. Anonymous Clients RTR allows the use of wild cards when specifying the frontends that a router is permitted to accept connections from (that is, in the facility definition on the router). Valid wild card characters are ‘‘*’’, ‘‘%’’ and ‘‘?’’.
Starting and Setting Up RTR 2.9 Network Transports This informs the system administrator that port number 46000/tcp is reserved for RTR. (Note that the RTR daemon is started by RTRACP and not by inetd). 2.9.3 Interoperation with RTR Version 2 Using DECnet Reliable Transaction Router is interoperable with RTR Version 2.2D ECO3 or later when running on a platform that supports DECnet; that is OpenVMS, Compaq Tru64 UNIX, SUN, Windows 95 or Windows NT.
Starting and Setting Up RTR 2.10 Network Protocol Selection on OpenVMS 2.10 Network Protocol Selection on OpenVMS • The default network transport protocol on OpenVMS is DECnet. You may change the default to TCP/IP by removing this line from RTR$STARTUP.COM: $ DEFINE/SYSTEM RTR_PREF_PROT RTR_DNA_FIRST If you are using TCP/IP, you will need to use the node-name prefix ‘‘dna.’’ if you specifically want DECnet transport to be used. This is required, for example, when connecting to Version 2.
Starting and Setting Up RTR 2.11 Running RTR as a Service on Windows NT 2.11.1 Customizing the RTR Windows NT Service While starting RTR, the Service looks for the file UsrStart.RTR in the RTR home directory. On finding the file, the Service executes any RTR commands it may contain. RTR commands from UsrStart.RTR execute after RTR has been started.
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 keyrange definition), consisting of one or more server application channels, which may or may not share a common process.
Starting and Setting Up RTR 2.
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.
Starting and Setting Up RTR 2.12 How RTR Selects Processing-states (Roles) for Nodes Site A Node-A1 Node-A2 Router Site B Node-B1 Node-B2 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.
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. This list specifically determines the preferred router. If the first router specified is not available, the next one on the list is chosen.
3 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.
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. 3.2.1 Default Partition Names Unless supplied by one of the methods described below, partitions receive automatically generated default names.
Partition Management 3.3 Life Cycle of a Partition 3.3.1 Implicit Partition Creation Partitions are created implicitly when an application program calls rtr_open_channel( ) to create a server channel, specifying the key segments and value ranges for the segments with the pkeyseg argument. Other partition attributes are established with the flags argument. Before RTR V3.2, this was the only way in which partitions could be created.
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> SET PARTITION • Programmed using rtr_set_info( ) Enter partition commands on the backend where the partition is located.
Partition Management 3.5 Entering Partition Commands The rtr_set_info( ) call completes asynchronously. If the function call is successful, completion will be signaled by the delivery of an RTR message of type rtr_mt_closed on the channel whose identifier is returned through the pchannel argument. The programmer should retrieve this message by using rtr_receive_message( ). The data accompanying the message is of type rtr_status_data_t.
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. Use the /SUSPEND qualifier to the SET PARTITION command to halt the presentation of new transactions to servers on the backend where the command is entered.
Partition Management 3.6 Managing Partitions 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 qualifier. Since this command bypasses parts of the recovery cycle use it with caution in cases where availability above consistency in application databases is desired. The recovery cycle can also be manually restarted with the /RESTART_RECOVERY qualifier.
Partition Management 3.6 Managing Partitions 3.6.4.2 Programming Information To set the partition backend priority list, program the set_qualifier argument of the rtr_set_info( ) call as follows: rtr_qualifier_value_t set_qualifiers[ 2 ]; char *szNodeList = "your,list,of,node,names,here" set_qualifiers[ set_qualifiers[ set_qualifiers[ set_qualifiers[ 0 0 1 1 ].qv_qualifier = rtr_partition_be_priority_list; ].qv_value = &szNodeList; ].qv_qualifier = rtr_qualifiers_end; ].qv_value = NULL; 3.6.
Partition Management 3.6 Managing Partitions • 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.
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. 3.7.0.
4 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.
Transaction Management 4.1 Overview this transaction is removed from memory and can no longer be monitored by the command. The RTR DUMP JOURNAL command can be used to trace and review the flow of a 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. The information will be kept until a transaction is committed and forgotten.
Transaction Management 4.1 Overview 4.1.2 Transaction State Changes There are eight valid state changes allowed for the SET TRANSACTION command. Attempting to change transaction state to a state that is not allowed produces an error message of %RTR-E-INVSTATCHANGE, Invalid to change from current state to the specified state. The Table 6–19 table identifies the valid state changes.
Transaction Management 4.1 Overview This is the case where, for example, a server crashed while performing an SQL commit immediately after receiving a mt_accepted message. The 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 command is executed the DUMP JOURNAL command can be used to verify the result.
5 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.
RTR Monitoring 5.2 Standard Monitor Pictures Note 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.
RTR Monitoring 5.2 Standard Monitor Pictures 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.
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. trans Displays transactions for a frontend, router and backend. v2calls Shows RTR Version 2 verb usage through the interoperability subsystem.
RTR Monitoring 5.2 Standard Monitor Pictures 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" The connecting link is configured, but the facility that it requests does not exist on the local node.
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 ID 11141 Process 11141 Image rtr Starts 5 Completions 5 Active 0 5 5 0 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. 5.2.
RTR Monitoring 5.2 Standard Monitor Pictures 5.2.6 Monitor Calls RTR api calls, Node: nodea.zuo.dec.
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. Summarizes link status and is less detailed than the monitor netstat display. 5.2.
RTR Monitoring 5.2 Standard Monitor Pictures 5.2.
RTR Monitoring 5.2 Standard Monitor Pictures 5.2.13 Monitor IPC RTR> Monitor IPC Node: LENGTH I P C S u m m a r y Fri Mar 5 1999 11:18:34 +----------------------------------------------------------------------------+ This screen displays usage information on IPC messages, byte counts and IO primitives. Display units are counts, kbytes and calls respectively.
RTR Monitoring 5.2 Standard Monitor Pictures 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. Standby journals are journals of standby nodes that are being accessed due to restart or catch-up situations.
RTR Monitoring 5.2 Standard Monitor Pictures 5.2.
RTR Monitoring 5.2 Standard Monitor Pictures Table 5–3 (Cont.) Monitor Partition States State Meaning active Server is active pri_act Server is active as primary shadow sec_act Server is active as secondary shadow remember Primary is running without shadow secondary 5.2.
RTR Monitoring 5.2 Standard Monitor Pictures Server recovery state meanings are shown in Table 5–4.
RTR Monitoring 5.2 Standard Monitor Pictures 5.2.
RTR Monitoring 5.2 Standard Monitor Pictures 5.2.26 Monitor Rolequorum QUORUM COUNTS BY FACILITY 7-JAN-1999 14:32:48, NODE: -ALLRouter View of Backend View of backends routers backend routers CNF RCH QRT CNF RCH QRT CNF RCH QRT CNF RCH QRT VIP 1 1 1 1 1 1 1 1 1 1 1 1 5.2.27 Monitor Routers ROUTER TRANSACTION COUNTERS AT 14:33:29 7-JAN-1999 Node: -ALLFacility: -ALLStarts: Enqueues: Commits: Aborts: Abs 116641 116641 116641 0 Rate 25.7 25.7 25.6 0.
RTR Monitoring 5.2 Standard Monitor Pictures 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.
RTR Monitoring 5.2 Standard Monitor Pictures 5.2.31 Monitor Stalls Total TR1 -> TR1 -> TR1 -> TR2 -> TR2 -> FE1 -> FE1 -> FE1 -> FE2 -> FE2 -> FE2 -> FE2 -> BE1 -> BE1 -> BE1 -> BE1 -> BE1 -> TR1 FE2 BE1 TR2 BE1 FE1 FE2 BE1 FE2 BE1 TR1 FE1 BE1 FE2 TR2 TR1 FE1 NETWORK STALLS AT 29-JAN-1999 15:35:03, ON NODE: TR1 QIOs Bytes Link Stalls Issued Rate Sent Drops Secs <3s <10s <30s >30s Tot 5467 0.0 327148 2 33 23 1 0 0 24 29 0.0 3718 0 0 0 0 0 0 0 509 0.0 20707 0 4 4 0 0 0 4 303 0.0 13707 0 3 3 0 0 0 3 111 0.
RTR Monitoring 5.2 Standard Monitor Pictures 5.2.32 Monitor System System Status at 10:27:51 Fri Apr 9 1999 node: NODEA Resource OK Facility QUORUM states...... Warning x JOURNAL free space.......... x Link CONNECTS............... x Link traffic STALLS......... x Note: Additional detail about a resource can be obtained by monitoring the subsystem specified in capital letters. FLOW control credits........ x For example, to get more information on links type MONITOR CONNECTS PARTITION states...........
RTR Monitoring 5.2 Standard Monitor Pictures 5.2.33 Monitor TPS TRANSACTION COMMITS BY PROCESS 14:37:23 7-JAN-1999 Node -ALL-ALLNODEA NODEA NODEB NODEB ID 00000000 00000000 20200BEA 20200C03 21400724 214005F0 Process -REQUESTERS-SERVERSRTRACP ANDERS_1 RTRACP ANDERS_1 Commits Abs. Rate 123298 31.8 123297 28.9 0 0.0 123297 28.9 0 0.0 123298 31.
RTR Monitoring 5.2 Standard Monitor Pictures 5.2.36 Monitor V2CALLS RTR> Monitor V2CALLS RTR system service calls, Node: NODEA , PID: 00000000, Process name: -ALLImage: -ALL13:09:18 5-MAR-1999 Accept Reject Success Failure Outstng Calls dcl_tx_prc/server 3 0 4 0 0 4 dcl_tx_prc/req. 1 dcl_tx_prc/shut.
6 RTR Command Line Interface Each RTR API call can be invoked at CLI level using the RTR command utility. 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( ) call is invoked using CALL RTR_ACCEPT_TX at the CLI-level.
ADD FACILITY ADD FACILITY See CREATE FACILITY; ADD FACILITY is retained for compatibility reasons only.
CALL RTR_ACCEPT_TX CALL RTR_ACCEPT_TX The CALL RTR_ACCEPT_TX command causes a command server to execute the rtr_accept_tx( ) routine and to display the returned status.
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. The default channel name is RTR$DEFAULT_CHANNEL. /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster.
CALL RTR_ACCEPT_TX Related Commands • CALL RTR_OPEN_CHANNEL • CALL RTR_REJECT_TX Examples Accept the current transaction with a reason of 42.
CALL RTR_BROADCAST_EVENT CALL RTR_BROADCAST_EVENT The CALL RTR_BROADCAST_EVENT command causes a command server to execute the rtr_broadcast_event( ) routine and to display the returned status. 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.
CALL RTR_BROADCAST_EVENT Table 6–2 Parameters for rtr_broadcast_event C Parameter Name C Parameter Value channel flags Command Line Specification /CHANNEL_NAME=name RTR_NO_FLAGS pmsg, msglen, msgfmt1 [none] [D] [message definition parameter list with positional qualifiers. ] evtnum 42 /EVENT_NUMBER=42 rcpspc "workstat*" /RECIPIENT_SPEC="workstat*" 1 The actual values used for command line parameter.
CALL RTR_BROADCAST_EVENT Table 6–3 Generated Format Strings Data Type With /LENGTH= With /NOLENGTH STRING SIGNED SIGNED SIGNED UNSIGNED UNSIGNED UNSIGNED =n, "%nC" =1, "%SB" =2, "%SW" =4, "%SL" =1, "%UB" =2, "%UW" =4, "%UL" "%nC" where n=strlen(string) "%SL" "%SL" "%SL" "%SL" "%SL" "%SL" Refer to Application Programmer’s Reference Manual, section ‘‘Defining a Message Format Description’’ for information on constructing a fmt-string parameter.
CALL RTR_BROADCAST_EVENT 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.
CALL RTR_CLOSE_CHANNEL CALL RTR_CLOSE_CHANNEL The CALL RTR_CLOSE_CHANNEL command causes a command server to execute the rtr_close_channel( ) routine and to display the returned status.
CALL RTR_CLOSE_CHANNEL /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster. If neither /NODE nor /CLUSTER is specified then the command is executed on the nodes specified by the latest SET ENVIRONMENT command. If no SET ENVIRONMENT command has been entered then the command is executed only on the node where the command was issued.
CALL RTR_ERROR_TEXT CALL RTR_ERROR_TEXT The CALL RTR_ERROR_TEXT command causes a command server to execute the rtr_error_text( ) routine and to display the returned error text. Format CALL RTR_ERROR_TEXT Command Qualifiers Defaults /OUTPUT[=file-spec] /STATUS=status-code /OUTPUT=stdout /none Description The CALL RTR_ERROR_TEXT command causes a command server to call the rtr_error_text( ) routine using the value supplied on the command line.
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.
CALL RTR_GET_TID If neither /NODE nor /CLUSTER is specified then the command is executed on the nodes specified by the latest SET ENVIRONMENT command. If no SET ENVIRONMENT 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.
CALL RTR_OPEN_CHANNEL CALL RTR_OPEN_CHANNEL The CALL RTR_OPEN_CHANNEL command causes a command server to execute the rtr_open_channel( ) routine and to display the returned status.
CALL RTR_OPEN_CHANNEL rtr_status_t rtr_open_channel ( rtr_channel_t rtr_ope_flag_t rtr_facnam_t rtr_rcpnam_t rtr_evtnum_t rtr_access_t rtr_numseg_t rtr_keyseg_t ) ; *pchannel, flags, facnam, rcpnam, *pevtnum, access, numseg, *pkeyseg 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.
CALL RTR_OPEN_CHANNEL /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 flags parameter in the call to rtr_open_channel( ). The channel is opened as a backend call-out server.
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.
CALL RTR_OPEN_CHANNEL length_of_key=nnnn Specifies the length of the key field in enqueued messages in 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 key-length is four bytes. offset_of_key=nnnn 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.
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 file-spec. If /OUTPUT or file-spec is omitted then the standard or default output is used.
CALL RTR_OPEN_CHANNEL /TYPE_OF_FIELD=key-field-type /TYPE_OF_FIELD=UNSIGNED (D) Specifies the field type of the key. The key-type must be one of UNSIGNED, 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.
CALL RTR_PREPARE_TX CALL RTR_PREPARE_TX The CALL RTR_PREPARE_TX command causes a command server to execute the rtr_prepare_tx( ) routine and to display the returned status.
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. Similar to the message types rtr_mt_accepted and rtr_mt_rejected, the rtr_mt_prepared message type returns data of type rtr_status_data_t in the user buffer.
CALL RTR_PREPARE_TX /REASON[=reason] /REASON=0 Use /REASON to supply a value for the reason parameter in the call to rtr_prepare_tx( ). The reason parameter to rtr_prepare_tx( ) is used in place of the reason parameter in the subsequent rtr_accept_tx call( ) (that is, the reason field in the call to rtr_accept_tx call( ) or rtr_reject_tx( ) which follows a call to rtr_prepare_tx( ) is ignored). The default for value for /REASON is 0.
CALL RTR_RECEIVE_MESSAGE CALL RTR_RECEIVE_MESSAGE The CALL RTR_RECEIVE_MESSAGE command causes a command server to execute the rtr_receive_message( ) routine and to display the returned status.
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, rtr_mt_opened, rtr_mt_msgn). the message length in bytes the transaction ID, user handle, are event number are shown if they are relevant for the message type. For message types that place a status code and reason code in the user buffer, the status code is converted to text and both are shown.
CALL RTR_RECEIVE_MESSAGE /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.
CALL RTR_REJECT_TX CALL RTR_REJECT_TX The CALL RTR_REJECT_TX command causes a command server to execute the rtr_reject_tx( ) routine and to display the returned status.
CALL RTR_REJECT_TX channel_name is not case sensitive. 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 nor /CLUSTER is specified then the command is executed on the nodes specified by the latest SET ENVIRONMENT command. If no SET ENVIRONMENT command has been entered then the command is executed only on the node where the command was issued.
CALL RTR_REJECT_TX Examples Reject the current transaction with a reason of 42.
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( ) routine and to display the returned status. 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.
CALL RTR_REPLY_TO_CLIENT Table 6–11 Parameters for rtr_reply_to_client C Parameter Name C Parameter Value channel flags Command Line Specification /CHANNEL_NAME=name RTR_NO_FLAGS none [D] RTR_F_REP_ACCEPT /ACCEPT [message definition parameter list with positional qualifiers.] pmsg, msglen, msgfmt1 1 The actual values used for command line parameter.
CALL RTR_REPLY_TO_CLIENT Table 6–12 Generated Format Strings Data Type With /LENGTH= With /NOLENGTH STRING SIGNED SIGNED SIGNED UNSIGNED UNSIGNED UNSIGNED =n, "%nC" =1, "%SB" =2, "%SW" =4, "%SL" =1, "%UB" =2, "%UW" =4, "%UL" "%nC" where n=strlen(string) "%SL" "%SL" "%SL" "%SL" "%SL" "%SL" Refer to Application Programmer’s Reference Manual, section ‘‘Defining a Message Format Description’’ for information on constructing a fmt-string parameter.
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.
CALL RTR_REQUEST_INFO CALL RTR_REQUEST_INFO The CALL RTR_REQUEST_INFO command causes a command server to execute the rtr_request_info( ) routine and to display the returned status.
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. The default channel name is RTR$DEFAULT_CHANNEL. /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster.
CALL RTR_REQUEST_INFO 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.
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( ) routine and to display the returned status. 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.
CALL RTR_SEND_TO_SERVER Table 6–14 Parameters for rtr_send_to_server C Parameter Name C Parameter Value channel flags /CHANNEL_NAME=name RTR_NO_FLAGS none [D] RTR_F_SEN_EXPENDABLE /EXPENDABLE RTR_F_SEN_READONLY /READONLY RTR_F_SEN_RETURN_TO_SENDER /RETURN_TO_SENDER [message definition parameter list with positional qualifiers. ] pmsg, msglen, msgfmt1 1 Command Line Specification The actual values used for command line parameter.
CALL RTR_SEND_TO_SERVER If /FORMAT is specified without fmt-string, RTR automatically generates a 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.
CALL RTR_SEND_TO_SERVER Examples This command sends a message to a server. The message is type string (the default).
CALL RTR_START_TX CALL RTR_START_TX The CALL RTR_START_TX command causes a command server to execute the rtr_start_tx( ) routine and to display the returned status.
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).
CALL RTR_START_TX /OUTPUT[=file-spec] /OUTPUT=stdout (D) Specifies that the resulting information is written to the file file-spec. If /OUTPUT or file-spec is omitted then the standard or default output is used. /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).
CLEAR CLEAR Interactively remove one or more displayed items from a monitor picture. Format CLEAR Command Qualifiers Defaults /ALL /X=column /Y=row /NOALL Description The 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 command. CLEAR /ALL removes all the displayed items from the screen, and is useful when commencing interactive definition of a new picture.
CLEAR Examples See Section A.1, Interactive Definition of a Monitor Picture, for an example of how to use the CLEAR command.
CREATE FACILITY CREATE FACILITY Create an RTR facility and ready it for transaction traffic.
CREATE FACILITY Qualifiers /ALL_ROLES=node-list /NOALL_ROLES (D) Specifies the names of the nodes that are to act as frontend, router and backend 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.
CREATE FACILITY 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) Frontend-list is a list of frontend-nodes separated by commas. If there is more than one frontend-node, then frontend-list must be enclosed in parentheses. Frontend-node is either the name of a node or @file-spec, where file-spec specifies a text file containing a frontend-list on each line.
CREATE FACILITY Examples See Chapter 2, Starting and Setting Up RTR, for examples of how to use the CREATE FACILITY command.
CREATE JOURNAL CREATE JOURNAL Create RTR’s recovery journal. Format CREATE JOURNAL [disk-1] ... [,disk-n] Command Qualifiers Defaults /CLUSTER /BLOCKS=nr-blocks /MAXIMUM_BLOCKS=nr-blocks /NODE=node-list /OUTPUT[=file-spec] /SUPERSEDE /NOCLUSTER /BLOCKS=1000 /MAXIMUM_BLOCKS=1000 /NODE=default-node-list /OUTPUT=stdout /NOSUPERSEDE Description The CREATE JOURNAL command creates RTR’s recovery journal files on the specified disks.
CREATE JOURNAL Table 6–17 Platform Specific Information Platform Journal Root Finding Disks Notes UNIX /rtrjnl Use df OpenVMS [RTRJNL] Use SHOW DEVICE Enter disk names as thay appear in /dev. Enclose disk names in quotes and separate names with commas. The journals reside in subdirectories of the /rtrjnl. If the SYSTEM account has insufficient disk quota for journal file creation, you must have the EXQUOTA privilege in order for the command to complete successfully.
CREATE JOURNAL 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$.
CREATE PARTITION CREATE PARTITION Creates an RTR partition. Format CREATE PARTITION [partition_name] Command Qualifiers Defaults /CLUSTER /CONCURRENT /FACILITY=facility-name /NODE[=node-list] /OUTPUT[=file-spec] /STANDBY /SHADOW /KEY1=keysegdesc /KEYn=keysegdesc /NOCLUSTER /NOCONCURRENT /NODE=default-node-list /OUTPUT=stdout /NOSTANDBY /NOSHADOW Description The CREATE PARTITION command defines an RTR partition.
CREATE PARTITION /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 rtr_open_channel( ) call.
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 file-spec. If /OUTPUT or file-spec is omitted then the standard or default output is used.
DEFINE /KEY DEFINE /KEY Assign a string to a keyboard function key. Format DEFINE /KEY key-name "equivalence-string" Command Qualifiers Defaults /ECHO /IF_STATE /LOCK_STATE /LOG /SET_STATE /TERMINATE /ECHO /NOIF_STATE /NOLOCK_STATE /NOLOG /NOSET_STATE /NOTERMINATE Description This command lets you assign a string to a function key, possibly overriding any predefined function that was bound to that key.
DEFINE /KEY Table 6–18 (Cont.) Key names Key-name LK201 VT100-type PF4 KP0, KP1 ..KP9 PERIOD COMMA MINUS ENTER E1 E2 E3 E4 E5 E6 HELP DO F6, F7, .. F20 PF4 Keypad 0 .. 9 Keypad period (.) Keypad comma (,) Keypad minus (-) ENTER Find Insert Here Remove Select Prev Screen Next Screen Help Do F6, F7, .. F20 PF4 Keypad 0 .. 9 Keypad period (.) Keypad comma (,) Keypad minus (-) ENTER equivalence-string Specifies the string to be processed when the specified key is pressed.
DEFINE /KEY /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. /SET_STATE changes the current state to state-name when you press the key. /NOSET_STATE (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 key is pressed.
DEFINE /KEY The word DEFAULT in the second line of the example refers to the fact that PF1 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.
DELETE FACILITY DELETE FACILITY Delete an RTR facility. Format DELETE FACILITY facility_name Command Qualifiers Defaults /CLUSTER /NODE=node-list /OUTPUT[=file-spec] /NOCLUSTER /NODE=default-node-list /OUTPUT=stdout Description The DELETE FACILITY command removes the specified facility on the node where the command is issued. After issuing this command applications are able to use the facility. Any outstanding transactions using the facility are aborted.
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 command.
DELETE JOURNAL DELETE JOURNAL Delete an RTR journal. Format DELETE JOURNAL Command Qualifiers Defaults /CLUSTER /NODE=node-list /OUTPUT[=file-spec] /NOCLUSTER /NODE=default-node-list /OUTPUT=stdout Description The DELETE JOURNAL command deletes a previously created RTR journal on the node where the command is issued. The DELETE JOURNAL command will fail if a journal does not exist, or if a journal has been created but is currently in use.
DELETE JOURNAL Examples See Chapter 2, Starting and Setting Up RTR, for examples of how to use the DELETE JOURNAL command.
DELETE PARTITION DELETE PARTITION Delete an RTR PARTITION. Format DELETE PARTITION PARTITION_name Command Qualifiers Defaults /CLUSTER /NODE=node-list /OUTPUT[=file-spec] /FACILITY /NOCLUSTER /NODE=default-node-list /OUTPUT=stdout Description The DELETE PARTITION command removes the specified partition on the node where the command is issued. Parameters PARTITION_name The name of the partition to delete. The parameter partition_name must be supplied.
DELETE PARTITION Related Commands • CREATE PARTITION • SHOW PARTITION 6–66 RTR Command Line Interface
DISPLAY BAR DISPLAY BAR Display a bar-graph in a monitor picture. Format DISPLAY BAR expression Command Qualifiers Defaults /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,...
DISPLAY BAR Qualifiers /AVERAGE=(keyword,...) /NOAVERAGE Specifies that the items being monitored relating to keyword are displayed as an average. This allows a number of items to be averaged in one qualifier.
DISPLAY BAR /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. The default is 10.
DISPLAY BAR Keyword Meaning PROCESS PARTITION FE_TRANSACTION TR_TRANSACTION BE_TRANSACTION Process data items Partition data items Frontend transaction data items Backend transaction data items Router transaction data items /TOTALIZE=(keyword,...) /NOTOTALIZE Specifies that the items being monitored relating to keyword are added together and displayed as a total.
DISPLAY BAR /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.
DISPLAY NUMERIC DISPLAY NUMERIC Display a number in a monitor picture. Format DISPLAY NUMERIC expression Command Qualifiers Defaults /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,...
DISPLAY NUMERIC The keyword can be one of the following: Keyword Meaning NODE LINK FACILITY PROCESS PARTITION FE_TRANSACTION TR_TRANSACTION BE_TRANSACTION Node data items Link data items Facility data items Process data items Partition data items Frontend transaction data items Backend transaction data items Router transaction data items /BELL[=Boolean-expression] /NOBELL (D) Sends a bell character to the terminal if Boolean-expression evaluates to True (non-zero).
DISPLAY NUMERIC /RATE[=interval] /NORATE (D) Specifies that the rate of change of the expression is to be displayed rather than the absolute value. When /RATE is used, interval specifies the time interval in 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 /RATE=60 results in transactions per minute being displayed instead of per second.
DISPLAY NUMERIC Keyword Meaning LINK FACILITY PROCESS PARTITION FE_TRANSACTION TR_TRANSACTION BE_TRANSACTION Link data items Facility data items Process data items Partition data items Frontend transaction data items Backend transaction data items Router transaction data items /UNDERLINE[=Boolean-expression] /NOUNDERLINE (D) Specifies that the displayed value is underlined if Boolean-expression evaluates to True (non-zero).
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 DISPLAY NUMERIC command.
DISPLAY STRING DISPLAY STRING Display a string in a monitor picture. Format DISPLAY STRING expression Command Qualifiers Defaults /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,...
DISPLAY STRING The keyword can be one of the following: Keyword Meaning NODE LINK FACILITY PROCESS PARTITION FE_TRANSACTION TR_TRANSACTION BE_TRANSACTION Node data items Link data items Facility data items Process data items Partition data items Frontend transaction data items Backend transaction data items Router transaction data items /BLANK[=Boolean-expression] /NOBLANK (D) Specifies that the displayed value is replaced by blanks if Boolean-expression evaluates to True (non-zero).
DISPLAY STRING /SEPARATE=(keyword,...) /NOSEPARATE Specifies that the items being monitored relating to keyword are separated from each other and displayed as a list. This allows a number of items to be separated in one qualifier.
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.
DISPLAY SYMBOLIC DISPLAY SYMBOLIC Display a text in a monitor picture depending on the result of an expression evaluation. Format DISPLAY SYMBOLIC expression "text-string" [,"text-string"]...
DISPLAY SYMBOLIC /BOLD[=Boolean-expression] /NOBOLD (D) Specifies that the item is displayed in high intensity if Boolean-expression 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 Boolean-expression evaluates to True (non-zero). /UNDERLINE[=Boolean-expression] /NOUNDERLINE (D) Specifies that the displayed value is underlined if Boolean-expression evaluates to True (non-zero).
DISPLAY TEXT DISPLAY TEXT Display text in a monitor picture.
DISPLAY TEXT /BOLD[=Boolean-expression] /NOBOLD (D) Specifies that the item is displayed in high intensity if Boolean-expression 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-".
DISPLAY TEXT /UNDERLINE[=Boolean-expression] /NOUNDERLINE (D) Specifies that the displayed value is underlined if Boolean-expression evaluates 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. /Y[=row] /Y=next-free-row (D) Specifies the screen row where the item is displayed (top row is 1).
DO DO Execute an operating system command. Format DO [operating-system-command] Command Qualifiers Defaults /CLUSTER /NODE=node-list /OUTPUT[=file-spec] /NOCLUSTER /NODE=default-node-list /OUTPUT=stdout Description The DO command enables an operating system command to be executed from RTR. By using the /NODE and /CLUSTER qualifiers the command can be executed on one or more remote nodes. (Note that the SPAWN command does not have this ability).
DO Related Commands • SPAWN Example RTR> DO/CLUSTER SHOW TIME This command shows the time on all nodes in a OpenVMS cluster. RTR> DO/NODE=(TR2,TR1) SHOW LOGICAL MYLOGICAL This command examines the logical name "MYLOGICAL" on nodes TR2 and TR1. RTR> SET ENVIRONMENT/NODE=(TR2,TR1) RTR> DO SHOW TIME RTR> DO SHOW LOGICAL MYLOGICAL The SET ENVIRONMENT command can be used if a series of DCL commands are to be issued on the same nodes.
FLUSH NAME_CACHE FLUSH NAME_CACHE Flushes RTR’s internal network name cache. Format FLUSH NAME_CACHE Command Qualifiers Defaults /CLUSTER /NODE[=node-list] /NOCLUSTER /NODE=default-node-list Description The FLUSH NAME_CACHE removes information for all known nodes from RTR’s 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.
EXECUTE EXECUTE Executes a file containing RTR commands. Format EXECUTE file-spec Command Qualifiers Defaults /VERIFY /NOVERIFY Description The EXECUTE command reads a file containing RTR commands and executes them. This command also has the form @file-spec. Parameters file-spec Specifies the name of the file containing commands to be executed. Qualifiers /VERIFY /NOVERIFY (D) Specifies that the commands being executed and the resulting information is displayed on the terminal.
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.
EXTEND FACILITY EXTEND FACILITY Adds new nodes or roles or both to an existing facility definition. Format EXTEND FACILITY [facility_name] Command Qualifiers Defaults /BACKEND=backend-list /BALANCE /CALL_OUT=role-list /CLUSTER /FRONTEND=frontend-list /NODE[=node-list] /OUTPUT[=file-spec] /ROUTER=router-list /NOBACKEND /NOBALANCE /NOCALL_OUT /NOCLUSTER /NOFRONTEND /NODE=default-node-list /OUTPUT=stdout /NOROUTER Description The EXTEND FACILITY command extends the configuration of an RTR facility.
EXTEND FACILITY $ RTR RTR> SET ENVIRONMENT /NODE=(FE,FETRBE) RTR> CREATE FACILITY facnam /FRONTEND=(FE,FETRBE) /ROUTER=FETRBE /BACKEND=FETRBE A new frontend NFE can be added to this facility as follows: $ 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 rtr_open_channel.
EXTEND FACILITY Backend-list is a list of backend-nodes separated by commas. If there is more than one backend-node, then backend-list must be enclosed in parentheses. Backend-node is either the name of a node or @file-spec, where file-spec specifies a file containing a backend-list on each line. /BALANCE /NOBALANCE (D) Specifies that load balancing is enabled for frontend/router connections across the facility.
EXTEND FACILITY /OUTPUT[=file-spec] /OUTPUT=stdout (D) Specifies that the resulting information is written to the file file-spec. If /OUTPUT or file-spec is omitted then the standard or default output is used. /ROUTER=router-list /NOROUTER (D) Specifies the names of the added nodes that act as routers for this facility. Router-list is a list of router-nodes separated by commas. If there is more than one router-node, then router-list must be enclosed in parentheses.
INITIALIZE JOURNAL INITIALIZE JOURNAL See CREATE JOURNAL; INITIALIZE is only retained for compatibility reasons.
LOG LOG Specify RTR to write a log message to a log file. Format LOG Command Qualifiers Defaults /CLUSTER /NODE=node-list /OUTPUT[=file-spec] /NOCLUSTER /NODE=default-node-list /OUTPUT=stdout Description The LOG 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. Log files must be periodically purged to avoid difficulties with full disks.
LOG 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> LOG/NODE=hostname "Message check HERE" This command tells RTR to write defined log message to the log to the hostname on the node list.
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 Defaults /CLUSTER /BLOCKS=nr-blocks /MAXIMUM_BLOCKS=nr-blocks /NODE=node-list /OUTPUT[=file-spec] /NOCLUSTER /BLOCKS=1000 /MAXIMUM_BLOCKS=1000 /NODE=default-node-list /OUTPUT=stdout Description The MODIFY JOURNAL command specifies how the size of RTR recovery journal files on the specified disks can be modified.
MODIFY JOURNAL If neither /NODE nor /CLUSTER is specified then the command is executed on the nodes specified by the latest SET ENVIRONMENT command. If no SET ENVIRONMENT 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.
MONITOR MONITOR Displays a monitor picture on the screen.
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 RTR> prompt. The default is that RTR updates the screen until CTRL-Z, CTRL-Y or another RTR command is entered. The /COUNT qualifier may be used when the /OUTPUT qualifier is being used to redirect output to a file.
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 monitor-file-spec are echoed on stdout. This is useful when developing monitor files to find the exact location of syntax errors.
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.
RECALL RECALL Display a previously entered command for subsequent command editing. Format RECALL [command-specifier] Command Qualifiers Defaults /ALL /NOALL Description When you enter commands to the RTR Utility, they are stored in a recall buffer for later use with the RECALL command. Commands can be recalled by either 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.
REGISTER RESOURCE MANAGER (REGISTER RM) REGISTER RESOURCE MANAGER (REGISTER RM) Registers an instance of a resource manager (RM) with RTR.
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
SCROLL SCROLL Scroll a monitor picture. Format SCROLL direction [amount] Description The SCROLL command causes the the last picture that was displayed using the MONITOR command to be scrolled in the direction specified and then redisplayed. Parameters direction Specifies the direction in which the screen is to be scrolled. Can be one of LEFT, RIGHT, UP, DOWN or HOME. HOME scrolls the picture so that its top left corner coincides with the top left corner of the screen.
SET ENVIRONMENT SET ENVIRONMENT Specify the node(s) where subsequent RTR commands are executed. Format SET ENVIRONMENT Command Qualifiers Defaults /CLUSTER /NODE=node-list /NOCLUSTER /NODE=this_node Description The SET ENVIRONMENT command causes subsequent RTR commands to be executed on the specified nodes. Entering SET ENVIRONMENT without any qualifiers causes subsequent RTR commands to be executed on the local node only.
SET FACILITY SET FACILITY Sets various facility related options. Format SET FACILITY facility-name Command Qualifiers Defaults /BROADCAST_MINIMUM_RATE=Bps /BROADCAST_MINIMUM_RATE=1000 /QUORUM_THRESHOLD=n /QUORUM_THRESHOLD=0 /BALANCE /NOBALANCE /CLUSTER /NOCLUSTER /NODE=node-list /NODE=default-node-list /OUTPUT[=file-spec] /OUTPUT=stdout /REPLY_CHECKSUM /NOREPLY_CHECKSUM Description The SET FACILITY command sets the router load balancing and quorum characteristics of a facility.
SET FACILITY Note 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. Before the rest of the nodes are started, it is recommended that this value is reset back to zero - the default setting.
SET FACILITY 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. RTR> SET FACILITY FINANCE/BALANCE This command tells RTR to use router load balancing.
SET LINK SET LINK Sets various link related options. Format SET LINK link-name Command Qualifiers Defaults /AUTOISOLATE /ENABLE /CHECKSUM /CLUSTER /INACTIVITY_TIMEOUT[=secs] /NODE=node-list /OUTPUT[=file-spec] /SUSPECT /NOAUTOISOLATE /DISABLE /NOCHECKSUM /NOCLUSTER /INACTIVITY_TIMEOUT=node-default /NODE=default-node-list /OUTPUT=stdout /NOSUSPECT Description The SET LINK command sets options for one or more or links.
SET LINK 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.
SET LINK The new value for secs becomes effective only after a time of about one third of the current value of the link inactivity timeout. The minimum useful value for secs is three. If a value is not specified, links 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.
SET LINK 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 LOG SET LOG Specify where RTR writes its log messages. Format SET LOG Command Qualifiers Defaults /CLUSTER /FILE=file-spec-list /NODE=node-list /OPERATOR /OUTPUT[=file-spec] /NOCLUSTER /NOFILE /NODE=default-node-list /NOOPERATOR /OUTPUT=stdout Description The SET LOG command specifies where RTR writes its log messages. You can write 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.
SET LOG /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 file-spec. If /OUTPUT or file-spec is omitted then the standard or default output is used. 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.
SET MODE SET MODE Specify whether RTR should run in a group mode or the nogroup (system) mode. Format SET MODE Command Qualifiers Defaults /CLUSTER /GROUP[=user-id] /NODE=node-list /OUTPUT[=file-spec] /NOCLUSTER /NOGROUP /NODE=default-node-list /OUTPUT=stdout Description The SET MODE command specifies whether RTR runs in group mode or nogroup mode. (Nogroup mode is the same as system mode.) Production systems use RTR in the default mode, i.e.
SET MODE /NODE[=node-list] /NODE=default-node-list (D) Specifies that the command is executed on all nodes specified in node-list. If 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 file-spec. If /OUTPUT or file-spec is omitted then the standard or default output is used.
SET NODE SET NODE Sets various node related options. Format SET node Command Qualifiers Defaults /AUTOISOLATE /CLUSTER /INACTIVITY_TIMEOUT[=secs] /ISOLATE /NODE=node-list /OUTPUT[=file-spec] /NOAUTOISOLATE /NOCLUSTER /INACTIVITY_TIMEOUT=60 /NOISOLATE /NODE=default-node-list /OUTPUT=stdout Description The SET NODE command sets the automatic isolation characteristics and the link timeout default of a node.
SET NODE /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster. If neither /NODE nor /CLUSTER is specified then the command is executed on the nodes specified by the latest SET ENVIRONMENT command. If no SET ENVIRONMENT command has been entered then the command is executed only on the node where the command was issued.
SET PARTITION SET PARTITION Sets various partition related options. Format SET PARTITION partition-name Command Qualifiers Defaults /FACILITY=[facility_name] /FAILOVER_POLICY=[SHADOW | STAND_BY] / /IGNORE_RECOVERY /NOIGNORE_RECOVERY /PRIORITY_LIST=backend-node-list / /RECOVERY_RETRY_COUNT=n / /RESTART_RECOVERY / /RESUME / /SHADOW /NOSHADOW /SUSPEND / /TIMEOUT=nn / Description The SET PARTITION command sets the characteristics of a named partition.
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. It instructs RTR to skip the current step in the recovery process.
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. /SUSPEND Stops presenting new transactions on the specified partition until a /RESUME is issued.
SET TRANSACTION SET TRANSACTION Sets various transaction related options.
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. RTR will try to determine whether the change also affects other portion of RTR environment.
SET TRANSACTION /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 may be one of the following: ABORT COMMIT DONE EXCEPTION Note that one cannot always change a transaction’s state from one legitimate transaction state to another. Some state changes are not valid. The following table shows state changes that are valid.
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.
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 Defaults /ALL_WINDOWS /CLUSTER /NODE=node-list /OUTPUT[=file-spec] /NOALL_WINDOWS /NOCLUSTER /NODE=default-node-list /OUTPUT=stdout Description The SHOW CHANNEL command shows the channel type (client or server), the channel name and owner process-id for channels opened using the CLI API.
SHOW CHANNEL Related Commands • call rtr_open_channel( ) • call rtr_close_channel( ) Examples RTR> SHOW CHANNEL/ALL_WINDOWS 1 Channel type Channel name server RTR$DEFAULT_CHANNEL client CLI_CHN client CLI_CHN2 (Owner pid) (28879) 2 (28879) 3 (26225) 4 1 Display information about all declared channels. 2 The channel called RTR$DEFAULT_CHANNEL is open as a server channel. 3 The channel called CLI_CHN is open as a client channel.
SHOW CLIENT SHOW CLIENT Display information about client channels. Format SHOW CLIENT Command Qualifiers Defaults /CLUSTER /FACILITY /FULL /IDENTIFICATION=process-id /NODE[=node-list] /OUTPUT[=file-spec] /NOCLUSTER /FACILITY="*" none /NOIDENTIFICATION /NODE=default-node-list /OUTPUT=stdout Description The SHOW CLIENT command displays information about client channels. Information such as PID, key range, state, event mask and event name are displayed.
SHOW CLIENT /NODE[=node-list] /NODE=default-node-list (D) Specifies that the command is executed on all nodes specified in node-list. If 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 file-spec. If /OUTPUT or file-spec is omitted then the standard or default output is used.
SHOW DISPLAY SHOW DISPLAY Show which items were displayed by the most recently issued MONITOR command or DISPLAY commands. Format SHOW DISPLAY Command Qualifiers Defaults /ALL /OUTPUT[=file-spec] /X=column /Y=row /NOALL /OUTPUT=stdout Description The SHOW DISPLAY command shows which items were displayed by the most recently issued MONITOR command. These may have been read in from a display file using the MONITOR file-spec command, or entered interactively using DISPLAY commands.
SHOW DISPLAY Examples RTR> MON CALLS 1 RTR> SHOW DISPLAY/ALL 2 DISPLAY TEXT "RTR api calls, Node: $node_name ,- 3 PID: $process_id, Process name: -ALL-" /X=1 /Y=1 /BOLD="1" . . . DISPLAY NUMERIC "rtr_open_channel_succ" /X=1 /Y=5 /BLANK /LABEL=" rtr_open_channel " /WIDTH=9 . . . 1 Display the CALLS monitor picture. 2 Show all the items contained in the monitor picture. 3 The items are displayed in DISPLAY command format.
SHOW ENVIRONMENT SHOW ENVIRONMENT Shows the default nodes used for remote command execution. Format SHOW ENVIRONMENT Description The SHOW ENVIRONMENT command shows which nodes are used by default for remote command execution.
SHOW FACILITY SHOW FACILITY Show the names, configuration and status of one or more facilities.
SHOW FACILITY /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, and 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. Whether reply consistency check for replayed messages is enabled.
SHOW FACILITY On a frontend, this qualifier can be used to find out whether the node is currently connected to a router.
SHOW FACILITY 5 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. This backend would also be the backend coordinator if load balancing was enabled.
SHOW JOURNAL SHOW JOURNAL Display information about current RTR journal files. Format SHOW JOURNAL Command Qualifiers Defaults /CLUSTER /FILENAMES /FULL /NODE[=node-list] /OUTPUT[=file-spec] /NOCLUSTER /NOFILENAMES /NOFULL /NODE=default-node-list /OUTPUT=stdout Description The SHOW JOURNAL command shows the disks where the RTR journal files reside, and (optionally) the maximum and allocated number of blocks for each journal file and the journal file name.
SHOW JOURNAL Related Commands • CREATE JOURNAL • DELETE JOURNAL • INITIALIZE JOURNAL Examples RTR> SHOW JOURNAL/FULL/FILENAMES 1 RTR journal:2 Disk(1): File(1): Disk(2): File(2): 3 4 5 6 /dev/rz3a Blocks: 1500 Allocated: 1502 Maximum: 3000 /dev/rz3a /rtrjnl/SYSTEM/BRONZE.J017 /dev/rz2c Blocks: 1500 Allocated: 1502 Maximum: 3000 /dev/rz2c /usr/users/rtrjnl/SYSTEM/BRONZE.J11 1 Show the disks used for RTR’s recovery journal and the filenames. 2 Two disks are currently in use. 3 Device name.
SHOW KEY SHOW KEY Display the key definitions created by the DEFINE /KEY command. Format SHOW KEY [key-name] Command Qualifiers Defaults /ALL /FULL /OUTPUT[=file-spec] /IF_STATE /NOALL /NOFULL /OUTPUT=stdout /NOIF_STATE Description The 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 DEFINE /KEY command for a list of the valid key names.
SHOW KEY Related Commands • DEFINE /KEY Examples RTR> SHOW KEY/FULL DEFAULT PF1 defined DEFAULT KP0 defined DEFAULT KP2 defined DEFAULT KP4 defined DEFAULT KP5 defined DEFAULT KP6 defined DEFAULT KP8 defined GOLD KP2 defined as GOLD KP4 defined as GOLD KP6 defined as GOLD KP8 defined as as "" as "MONITOR/RESUME" as "SCROLL DOWN 1" as "SCROLL LEFT 1" as "SCROLL HOME" as "SCROLL RIGHT 1" as "SCROLL UP 1" "SCROLL DOWN 10" "SCROLL LEFT 10" "SCROLL RIGHT 10" "SCROLL UP 10" RTR Command Line Interface 6–143
SHOW LINK SHOW LINK Display the configuration and status of the links to other nodes. Format SHOW LINK [node-name] Command Qualifiers Defaults /CLUSTER /COUNTER[=counter-name] /FACILITY /FULL /NODE[=node-list] /OUTPUT[=file-spec] /STATE /NOCLUSTER /NOCOUNTER /NOFACILITY /NOFULL /NODE=default-node-list /OUTPUT=stdout /NOSTATE Description The SHOW LINK command shows the configuration and status of the links to RTR nodes. If no qualifiers are given, a brief display of the links is shown.
SHOW LINK /FULL Equivalent to specifying /FACILITY/STATE. /NODE[=node-list] /NODE=default-node-list (D) Specifies that the command is executed on all nodes specified in node-list. If 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 file-spec. If /OUTPUT or file-spec is omitted then the standard or default output is used.
SHOW LOG SHOW LOG Display the names of the current log files. Format SHOW LOG Command Qualifiers Defaults /CLUSTER /NODE[=node-list] /OUTPUT[=file-spec] /NOCLUSTER /NODE=default-node-list /OUTPUT=stdout Description The SHOW LOG command shows the names of the current RTR log files as defined with the SET LOG command. Qualifiers /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster.
SHOW LOG Example RTR> SHOW LOG 1 Messages not being sent to operator console 2 Log file[1]: /usr/users/someone/rtr_logfile.log 3 1 Show where RTR log messages are currently written. 2 Currently not being sent to the operator log. 3 Currently being written to file rtr_logfile.log.
SHOW MODE SHOW MODE Displays the current RTR mode. Format SHOW MODE Command Qualifiers Defaults /CLUSTER /NODE[=node-list] /OUTPUT[=file-spec] /NOCLUSTER /NODE=default-node-list /OUTPUT=stdout Description The SHOW MODE command shows the currently running user group for RTR. For nogroup (system) mode, a null group name is displayed. SET MODE command for further information about modes. Qualifiers /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster.
SHOW MODE Examples RTR> SHOW MODE Group name is "develop" RTR Command Line Interface 6–149
SHOW NODE SHOW NODE Shows the node network status, the autoisolation state and the node inactivity timer. Format SHOW NODE Command Qualifiers Defaults /CLUSTER /NODE[=node-list] /OUTPUT[=file-spec] /NOCLUSTER /NODE=default-node-list /OUTPUT=stdout Description The SHOW NODE shows the network status, the autoisolation state (enabled or disabled) and the node inactivity timer. Qualifiers /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster.
SHOW NODE Examples RTR> SHOW NODE 1 Node properties: Network state: Auto isolation: Inactivity timer/s: enabled 2 disabled 3 60 4 1 SHOW NODE command. 2 Network status 3 Auto isolation state (enabled or disabled). 4 Inactivity timer value in seconds.
SHOW PARTITION SHOW PARTITION Display server data partition information. Format SHOW PARTITION Command Qualifiers Defaults /BACKEND /BRIEF /CLUSTER /FACILITY /FULL /NODE[=node-list] /OUTPUT[=file-spec] /ROUTER /BACKEND /NOBRIEF /NOCLUSTER /FACILITY="*" /NOFULL /NODE=default-node-list /OUTPUT=stdout /ROUTER Description The SHOW PARTITION command displays information about key range partitions, their states, and current transaction activity.
SHOW PARTITION Table 6–21 Router Partition States State Meaning BLOCKED ACTIVE CATCHUP TAKEOVR LAGGING Key range is recovering or awaiting journal access Primary server is ready to accept transactions Secondary server is catching up with primary Standby take-over is in progress Secondary is ready, primary is still recovering Qualifiers /BACKEND /NOBACKEND (D) Displays information about backend partitions; it shows the partition state and low and high bounds.
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.
SHOW PARTITION Partition name: Facility: RTR$DEFAULT_FACILITY Low Bound: "aaaa" Active Servers: 0 Transaction presentation: active Txns Active: 0 Failover policy: fail_to_standby RTR$DEFAULT_PARTITION_16777217 State: active High Bound: "mmmm" Free Servers: 1 Last Rcvy BE: Txns Rcvrd: 0 Key range ID: 16777217 Partition name: Facility: RTR$DEFAULT_FACILITY Low Bound: "nnnn" Active Servers: 0 Transaction presentation: active Txns Active: 0 Failover policy: fail_to_standby RTR$DEFAULT_PARTITION_16777218 Sta
SHOW PROCESS SHOW PROCESS Display information about processes which are using RTR. Format SHOW PROCESS Command Qualifiers Defaults /CLUSTER /COUNTER[=counter-name] /FULL /IDENTIFICATION=process-id /NODE[=node-list] /OUTPUT[=file-spec] /NOCLUSTER /NOCOUNTER /NOFULL /NOIDENTIFICATION /NODE=default-node-list /OUTPUT=stdout Description The SHOW PROCESS command displays information about the processes using RTR.
SHOW PROCESS /OUTPUT[=file-spec] /OUTPUT=stdout (D) Specifies that the resulting information is written to the file file-spec. If /OUTPUT or file-spec is omitted then the standard or default output is used.
SHOW REQUESTER SHOW REQUESTER See SHOW CLIENT. The SHOW REQUESTER command has been replaced by SHOW CLIENT and is retained for compatibility reasons only.
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 Defaults /CLUSTER /FULL /NODE[=node-list] /OUTPUT[=file-spec] /NOCLUSTER /NOFULL /NODE=default-node-list /OUTPUT=stdout Description The SHOW RESOURCE MANAGER command displays information for registered RMs.
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 node-list. If node-list is omitted then the command is executed only on the node where the command was issued.
SHOW RTR SHOW RTR Display the configuration and status of RTR. Format SHOW RTR Command Qualifiers Defaults /CLUSTER /COUNTER[=counter-name] /FULL /NODE[=node-list] /OUTPUT[=file-spec] /STATUS /VERSION /NOCLUSTER /NOCOUNTER /NOFULL /NODE=default-node-list /OUTPUT=stdout /NOSTATUS /NOVERSION Description The SHOW RTR command displays the configuration and status of RTR. Qualifiers /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster.
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 1 RTR running on node baby.home.dec.com in group: develpr 2 1 Show the state and configuration of RTR. 2 RTR has been started in group mode for group ‘‘develpr’’.
SHOW SEGMENT SHOW SEGMENT Display the type and size of routing key segments. Format SHOW SEGMENT Command Qualifiers Defaults /CLUSTER /FACILITY /FULL /NODE[=node-list] /OUTPUT[=file-spec] /NOCLUSTER /FACILITY="*" /NOFULL /NODE=default-node-list /OUTPUT=stdout Description The SHOW SEGMENT command displays the routing key segment definitions. The routing key definition is common to all servers in a facility.
SHOW SEGMENT Examples RTR> SHOW SEGMENT 1 Facility RTR$DEFAULT_FACILITY TEST_FAC Data Type UNSIGNED SIGNED Length 1 4 Offset 2 0 10 1 Show the routing key segments for all facilities. 2 The facility name, the routing key data type, key length and offset are shown for each facility.
SHOW SERVER SHOW SERVER Display information about server channels. Format SHOW SERVER Command Qualifiers Defaults /CLUSTER /FACILITY /FULL /IDENTIFICATION=process-id /NODE[=node-list] /OUTPUT[=file-spec] /NOCLUSTER /FACILITY="*" /NOFULL /NOIDENTIFICATION /NODE=default-node-list /OUTPUT=stdout Description The SHOW SERVER command displays information about server channels. Information such as PID, key range, state, event mask, event name and partition ID can be displayed.
SHOW SERVER Table 6–23 Server Flags FLAG Meaning BEC EXA EXP NCC NSB SHD SRV TRC Backend Call-out Explicit Accept Explicit Prepare No Concurrent No Standby Shadow Server Router Call-out Qualifiers /CLUSTER /NOCLUSTER (D) Specifies that the command is executed on all the nodes in the cluster. If neither /NODE nor /CLUSTER is specified then the command is executed on the nodes specified by the latest SET ENVIRONMENT command.
SHOW SERVER Examples RTR> SHOW SERVER Servers: Process-id 20828 20828 Facility RTR$DEFAULT_FACILITY RTR$DEFAULT_FACILITY Channel 589825 655362 Flags SRV SRV State active active RTR> SHOW SERVER/FULL Servers: Process-id: Channel: State: High Bo Uents: Partition-Id: 20828 589825 active mmmm 0 16973824 Facility: Flags: Low Bound: rcpnam: RTR Events: RTR$DEFAULT_FACILITY SRV aaaa "LOWER_SERV" 0 Process-id: Channel: State: High Bo User Events: Partition-Id: 20828 655362 active zzzz 0 16842753 Facilit
SHOW TRANSACTION SHOW TRANSACTION Displays information about currently active transactions.
SHOW TRANSACTION 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.
SHOW TRANSACTION Table 6–25 (Cont.) Key-Range States State Meaning active sec_act pri_act pri_lone sec_chup Active non-shadowed Secondary active Primary active Primary running alone Secondary is catching up Examples RTR> SHOW TRANSACTION/BACKEND/FULL Backend transactions: Tid: e100b810,0,0,0,0,a85,83290001 Facility: RTR$DEFAULT_FACILITY Frontend: ***** FE-User: anders.
SPAWN SPAWN Allows you to execute operating system commands without leaving the RTR utility. Format SPAWN [operating-system-command] Command Qualifiers Defaults /INPUT=file-spec /OUTPUT=file-spec /WAIT /NOINPUT /OUTPUT=stdout /WAIT Description The SPAWN command allows you to execute operating system commands without 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.
START RTR START RTR Start RTR on one or more nodes. Format START RTR Command Qualifiers Defaults /CLUSTER /NODE[=node-list] /OUTPUT[=file-spec] /NOCLUSTER /NODE=default-node-list /OUTPUT=stdout The following qualifiers are only relevant when running on OpenVMS.
START RTR Qualifiers /ASTLM=ast-limit /ASTLM=(max-links + max-processes)2 2 + 10 = default ast-limit (D) Specifies the AST limit for the RTR ACP. The value for ast-limit must include five for RTR ACP mailbox reads and timer 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 2 2) ).
START RTR /DIOLM=io-direct /DIOLM=(max-links + max-processes)2 2 + 10 = default io-direct (D) 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. The default for io-direct is automatically calculated based on the values for /LINKS and /PROCESSES.
START RTR The default value of page-file is automatically calculated, based on the values of /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 is 10. /PRIORITY=priority /PRIORITY=6 (D) Requires alter priority (ALTPRI) privilege to set the priority higher than your current process. Specifies the base priority at which the RTR ACP executes.
START RTR Related Commands • SHOW RTR • STOP RTR Examples See Chapter 2, Starting and Setting Up RTR, for examples of how to use the START RTR command.
STOP RTR STOP RTR Stop RTR on one or more nodes. Format STOP RTR Command Qualifiers Defaults /ABORT /CLUSTER /NODE[=node-list] /OUTPUT[=file-spec] /NOABORT /NOCLUSTER /NODE=default-node-list /OUTPUT=stdout Description The 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. Qualifiers /ABORT Specifying /ABORT causes RTR to stop, regardless of the state of any RTR user applications.
STOP RTR /OUTPUT[=file-spec] /OUTPUT=stdout (D) Specifies that the resulting information is written to the file file-spec. If /OUTPUT or file-spec is omitted then the standard or default output is used. Related Commands • SHOW RTR • START RTR Examples See Chapter 2, Starting and Setting Up RTR, for examples of how to use the STOP RTR command.
TRIM FACILITY TRIM FACILITY Removes nodes or roles or both from an existing facility definition. Format TRIM FACILITY [facility_name] Command Qualifiers Defaults /BACKEND=backend-list /CLUSTER /FRONTEND=frontend-list /NODE[=node-list] /OUTPUT[=file-spec] /ROUTER=router-list /NOBACKEND /NOCLUSTER /NOFRONTEND /NODE=default-node-list /OUTPUT=stdout /NOROUTER Description The TRIM FACILITY command removes nodes or roles or both from an RTR facility definition.
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 facnam, the nodes FE and NFE have only frontend roles, and node FETRBE has frontend, router and backend roles.
TRIM FACILITY /NOFRONTEND (D) Specifies the names of nodes where the frontend role is removed for this facility. frontend-list is a list of frontend-nodes separated by commas. If there is more than one frontend-node, then frontend-list must be enclosed in parentheses. frontend-node is either the name of a node or @file-spec, where file-spec specifies a text file containing a frontend-list on each line.
UNREGISTER RESOURCE MANAGER (UNREGISTER RM) UNREGISTER RESOURCE MANAGER (UNREGISTER RM) The UNREGISTER RESOURCE MANAGER command unregisters an instance of a resource manager. Format UNREGISTER RESOURCE MANAGER [resource_name] UNREGISTER RM [resource_name] Command Qualifiers Defaults /CLUSTER /NODE[=node-list] /OUTPUT[=file-spec] /NOCLUSTER /NODE=default-node-list /OUTPUT=stdout Description The UNREGISTER RESOURCE MANAGER command unregisters an instance of a resource manager.
A 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. The information displayed is composed of named data items which are continuously updated by RTR.
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.
Creating Monitor Pictures A.1 Interactive Definition of a Monitor Picture Figure A–1 Interactively Defined Monitor Picture THE TEST PICTURE AT 11:49:24 SOME DATA ITEM: 0 OTHER DATA ITEM: 0 Caution 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.
Creating Monitor Pictures A.3 Arithmetic Expressions and Operators Table A–3 Arithmetic Operators in Display Commands Characters Meaning - Minus + Plus * Multiply / Divide & Logical AND | Logical OR <= Less than or equal >= Greater than or equal != Not equal <> Not equal < Less than > Greater than = Equal Example A–2 shows how these operators are used.
Creating Monitor Pictures 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 /AVERAGE=( ) qualifier is specified.
B 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. It is possible to declare servers to be members of a pair of shadow sites for any particular RTR key-range.
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: • On initial startup if servers for the key-range are not already running on other nodes.
Server Shadowing and Recovery B.3 The RTR Journal System 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. Journal file extension occurs on demand when RTR detects that a ‘‘write to journal’’ would otherwise fail due to lack of space.
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, or 16384 times 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.
Server Shadowing and Recovery B.6 Performance 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. The two partners in a shadow pair should be connected with sufficient bandwidth to cater for the possibly large amounts of data which may need to be transferred during a shadow catchup operation. B.
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. This consideration is also valid for recovery of non-shadowed servers. B.
Server Shadowing and Recovery B.
Server Shadowing and Recovery B.10 Client States B.
Server Shadowing and Recovery B.11 Partition States B.
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.
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. In particular, there is no longer a need to include code to handle rtr_mt_msg1_uncertain messages. C.1.
D 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.
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.
RTR Utility Error Messages %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.
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. %RTR-W-DISKMNTVER, Disk is currently under mount verification Explanation: An attempt was made to create a journal on a disk which is in mount verification. Try later.
RTR Utility Error Messages %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. RTR can now see both the original and the copy and does not know which to use.
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. The subsequent message gives more details.
RTR Utility Error Messages %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" command was issued. The subsequent message gives more details.
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"). %RTR-E-FACTABFUL, The FAC table is full Explanation: This message is displayed when an "CREATE FACILITY" command is issued. It indicates that the maximum number of FACILITY to LINK relations has been reached.
RTR Utility Error Messages %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.
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. %RTR-F-INVMSGLEN, Invalid msglen argument Explanation: Invalid msglen argument.
RTR Utility Error Messages %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. The rejected portion of the command is displayed between backslashes.
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. %RTR-W-JOUINUSE, Journal is locked by another user Explanation: The journal is currently in use by another user.
RTR Utility Error Messages %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" command.
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 Utility Error Messages %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" privilege Explanation: "SETPRV" privilege is required to execute a remote command.
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.
RTR Utility Error Messages %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.
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. %RTR-E-NOSUCHPRC, No such process, process ID = [A] (0x[A]) Explanation: The process with PID = [A] does not exist or is not using RTR.
RTR Utility Error Messages %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" command then only one node may be monitored.
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. %RTR-I-PRTCREATE, Partition created Explanation: Message returned via rtr_open_channel( ) upon successful partition creation.
RTR Utility Error Messages %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 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.
RTR Utility Error Messages %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.
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. Probable cause: System management error. A user has copied a journal file, or a disk containing a journal file.
RTR Utility Error Messages %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. User Action: Issue the CREATE JOURNAL command specifying a smaller number of disks.
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. Check your program, and refer to the RTR Application Programmer’s Reference Manual for permissible values.
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.
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. Quorum and fault tolerance will be adversely affected. Check all network databases for consistency of node & host name and address consistency.
RTR log messages %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.
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.
RTR log messages %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.
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). %RTR-F-INCOMPAT, Incompatible RTR versions Explanation: Attempt to start up an incompatible version of RTR on the same network with shared facilities. %RTR-F-INTERFERENCE, Group/system interference. Start RTR from other account Explanation: Internal error.
RTR log messages %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.
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.
RTR log messages %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 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. %RTR-W-PRTSHDRECEXIT, Partition [A]:[A] shadow recovery terminated by operator [A] Explanation: Log message indicating that recovery wait override requested by operator.
RTR log messages %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.
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. This may be a reason for system manager intervention.
RTR log messages %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. You may be able to operate under this condition, but we recommend you review the system configuration and eliminate any unnecessary adapter/protocol combinations.
Index A Active Monitor, 5–2 Aggregation of Data Items, A–5 B Backend, 2–1 BAR DISPLAY, 6–67 Broadcast Monitor, 5–2 C 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 Monitor, 5–2 Channel Monitor, 5–2 CHANNEL SHOW, 6–129 CLEAR, 6–45,
DTC Support, C–2 E 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 F 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 FLUSH NAME_CACHE, 6–88 Frontend, 2–1 G Group Monitor, 5–2 H Help, 1–2 I Ipc Monitor, 5–2 Ipcrate Monitor, 5–2 J Journal Monitor, 5–3 JOURNAL CREATE, 6–51 DELETE, 6–63 JOURNAL, 2–3 Index–2 JOURNAL (cont’d) MODI
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 N NAME_CACHE FLUSH, 6–88 Netbytes Monitor, 5–3 Netstat Monitor, 5–3 Network transports, 2–13 NODE SET, 6–120 SHOW, 6–150 NUMERIC DISPLAY, 6–72 O Operating system command SPAWN, 6–86, 6–171 P Partit Monitor, 5–3 PARTITION CREATE, 6–54 DELETE, 6–65 SET, 6–122 SHOW, 6–152 PROCESS SHOW, 6–156 Q Queues Monitor, 5–3 QUIT, 6–103 Quo
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 SEGMENT, 6–163 SERVER, 6–165 TRANSACTION, 6–168 SHOW RESOURCE MANAGER, 6–159 SHOW RM, 6–159 SPAWN DCL command, 6–171 Stalls Monitor, 5–3 Start Rtr, 2–1 START RTR, 6–172 STOP RTR, 6–17
