Related commands

• SCROLL
• CLEAR
• DISPLAY NUMERIC
• DISPLAY BAR
• DISPLAY TEXT

You can use the following keystrokes when a monitor picture is active:

Keystroke	Meaning
<CTRL>/W	Refresh
<CTRL>/P	Print to file
Q	Quit
q	Quit

Examples

 RTR> MONITOR CALLS/NODE=(TR2,TR1)/INTERVAL=10 (1)
 RTR> SHOW PROCESS  (2)
 RTR> MONITOR/RESUME  (3)
      

1. Display the CALLS picture, monitoring nodes TR2 and TR1 every 10 seconds.
2. The SHOW PROCESS command is entered, interrupting the display.
3. Redisplay the CALLS picture using the original parameters.

 RTR> MONITOR TRAFFIC/COUNT=10/OUTPUT=PICTURE.LIS 
      

This command stores 10 images of the TRAFFIC picture in the file PICTURE.LIS .

The QUIT command 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.

The RECALL command displays a previously entered command for subsequent command editing.

Format

RECALL [command-specifier]

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. Use the RECALL/ALL command to list the last 20 commands.

When you recall a command, the RTR Utility displays the command but does not execute it. To execute the command as it appears, press RETURN. You can also use the command editing facility to make changes in the command line and then press RETURN to process the revised version of the command.

Parameters

command-specifier

Specifies either the command number or the first few characters of the command you want to recall.

If command-specifier is omitted, the most recently entered command is recalled.

Qualifiers

/ALL

/NOALL (D)

Displays all the commands (and their numbers) available for recall.

Examples

 RTR> CREATE FACILITY QUOTES/FRONT=FE3/ROUTER=TR2 (1)
 RTR> SHOW FACILITY/LINK  (2)
 RTR> RECALL CREATE  (3)
 RTR> CREATE FACILITY QUOTES/FRONT=FE3/ROUTER=TR2  
 RTR> CREATE FACILITY ORDERS/FRONT=FE3/ROUTER=TR2 (4)
 
      

1. Create facility QUOTES.
2. Check the links.
3. Recall the CREATE FACILITY command.
4. Change the facility name to ORDERS and resubmit the command.

The REGISTER RESOURCE_MANAGER command registers an instance of a resource manager (RM) with RTR.

Format

REGISTER RESOURCE_MANAGER [resource_name]

REGISTER RM [resource_name]

Description

The REGISTER RESOURCE_MANAGER command registers multiple resource managers or instances of resource managers (up to 16) with the current transaction manager. A different resource manager (RM) instance name is needed for each referenced database. Use this command after the RTR ACP is started and before the RTR facilities associated with this resource manager are created. Each RM can be associated with only one facility, but one facililty can be associated with multiple RMs.

Refer to Appendix C, XA Support for support information about XA.

Note This command is available only on UNIX and Windows NT systems.

Parameters

resource_name

Specifies the name of the resource to be registered.

Any application program using this resource must specify the same name when it calls rtr_open_channel() .

Resource names can contain up to 30 characters. Letters, numbers and underline characters are all valid, but the first character of a resource name must be a letter.

The default value for resource_name is RTR$DEFAULT_RESOURCE .

Qualifiers

/OPEN_STRING=open_string

RTR uses the OPEN_STRING qualifier to open a connection to the underlying resource manager. Open_string is a null-terminated character string that may contain instance-specific information for the resource manager. The maximum length of the string is 256 bytes (including the null terminator). You must consult the resource manager system administrator to get the appropriate open string.

If this qualifier is not specified, RTR uses a null open string to open the resource manager.

/CLOSE_STRING=close_string

RTR uses the CLOSE_STRING qualifiers to close a connection to a resource manager. Close_string is a null-terminated character string with a maximum length of 256 bytes (including the null terminator). If the resource manager does not require a close string to close the connection to the resource manager, you do not need to use this qualifier. You must consult the resource manager's system administrator documentation to get the appropriate close string.

/LIBRARY_PATH=library_path

Specifies the path and name of the XA library provided by the resource manager. RTR uses the pathname to load the XA library and resolve symbols at runtime.

This qualifier is required.

/XASWITCH_NAME=switch-name

Specifies an XA switch structure name that RTR uses to resolve symbols when it loads an XA library. Each resource manager is required to provide an XA switch and publish the switch structure name so that a transaction manager such as RTR can gain access to the RM's XA routines. You must consult the resource manager's system administrator documentation to get the proper switch name.

This qualifier is required.

Related commands

• UNREGISTER RESOURCE_MANAGER
• SHOW RESOURCE_MANAGER

Examples

RTR> REGISTER RM rmi_1 - _RTR> /open_string="Oracle_XA+Acc=P - _RTR> /user/pw+SesTm=15+db=accounting" - _RTR> /close_string="" /xaswitch_name=xaosw - _RTR> /library_path="library_path"

The SCROLL command scrolls a monitor picture.

Format

SCROLL direction [amount]

Description

The SCROLL command causes 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.

amount

Specifies the number of rows/columns by which the screen is scrolled. Amount is ignored if direction is specified as HOME .

Related commands

• MONITOR

Examples

 RTR> MONITOR TPS/INTERVAL=10) (1)
 RTR> SCROLL UP 10  (2)
 RTR> SCROLL HOME  (3)
      

1. Displays the TPS picture. This picture displays each process using RTR on a separate line. If there is insufficient space on the screen to display them all, the SCROLL command can be used to view a different portion of the list of processes.
2. Scrolls the picture up 10 lines. Note that SCROLL automatically redisplays the current picture.
3. Restores the original picture position.

The SET ENVIRONMENT command specifies the node where RTR commands entered from the same RTR> prompt are executed.

Format

SET ENVIRONMENT

Description

The SET ENVIRONMENT command causes RTR commands entered from the same RTR> prompt to be executed on the specified nodes. Entering SET ENVIRONMENT without any qualifiers causes RTR commands entered from the same RTR> prompt to be executed on the local node only.

Qualifiers

/CLUSTER

Specifies that RTR commands entered from the same RTR> prompt are executed on all nodes in the cluster.

/NODE[=node-list]

Specifies that subsequent RTR commands are executed on all nodes specified in node-list . If node-list is omitted, or both the /NODE and /CLUSTER qualifiers are omitted, subsequent commands are executed on only the local node.

Related commands

• SHOW ENVIRONMENT

Examples

See Section 1.4, Remote Commands, for examples of how to use the SET ENVIRONMENT command.

The SET FACILITY command sets various facility-related options.

Format

SET FACILITY facility-name

Description

The SET FACILITY command sets the router load balancing and quorum characteristics of a facility.

Qualifiers

/BROADCAST_MINIMUM_RATE=Bps

/BROADCAST_MINIMUM_RATE=1000

/BROADCAST_MINIMUM_RATE=nnnn specifies the minimum rate (in bytes per second) to which flow control can reduce broadcast traffic on outgoing facility links from the node concerned.

For example, consider a facility has 100 frontends and 99 of them are able to receive data at a rate of 2KB per second, but one frontend has become congested and is not able to receive any. This can result in all the frontends slowing down to the rate that the slowest can accept.

Specifying /BROADCAST_MINIMUM_RATE=2000 on the router ensures that the 99 frontends receive their broadcasts, and that RTR attempts to send the broadcasts to the congested frontend. However, broadcasts for the congested frontend are discarded (if absolutely necessary) rather than slowing down all frontends to the rate that the slowest can accept.

Specifying /BROADCAST_MINIMUM_RATE without a value gives a default 1000 bytes per second; if you do not use the qualifier, the minimum is zero.

/BALANCE

/NOBALANCE

/BALANCE specifies whether router load balancing is to be performed.

The default behavior (/NOBALANCE) is for a frontend to connect to the preferred router. Preferred routers are selected in the order specified in the /ROUTER qualifier of the CREATE FACILITY command. This preference is subject to the Router being available and quorate. See Section 2.7, Router Load Balancing, for more information on load balancing.

/CLUSTER

/NOCLUSTER (D)

Specifies that the command is executed on all the nodes in the cluster.

If neither /NODE nor /CLUSTER is specified, the command is executed on the nodes specified by the latest SET ENVIRONMENT command. If no SET ENVIRONMENT command has been entered, the command is executed only on the node where the command was issued.

Note In environments that do not support remote command capability, the /CLUSTER qualifier causes the relevant command to be executed on the local node only. See Section 1.4 for more information.

/NODE[=node-list]

/NODE=default-node (D)

Specifies that the command is executed on all nodes specified in node-list . If node-list is omitted, the command is executed only on the node where the command was issued.

/OUTPUT[=filespec]

/OUTPUT=stdout (D)

Specifies that the resulting information is written to the file filespec . If /OUTPUT or filespec is omitted, the standard or default output is used.

/QUORUM_THRESHOLD=n

/QUORUM_THRESHOLD=0

/QUORUM_THRESHOLD=n sets the minimum number of nodes/role combinations that have to be reachable to declare the configuration quorate .

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, this value should be reset to zero, the default setting. The current value of quorum_threshold can be displayed with the SHOW FACILITY /STATE command.

/REPLY_CHECKSUM

/NOREPLY_CHECKSUM (D)

Specifies that the reply consistency check (or Response Matching) feature for replayed messages is enabled. It is a check for reply consistency during a replay of a reply to client message.

RTR can enable, disable and display this feature.

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.

The SET LINK command sets various link related options.

Format

SET LINK link-name

Description

The SET LINK command sets options for one or more links. The options are link enabled or disabled, link autoisolate, link checksum and link inactivity timeout.

The parameter link-name is the node from which connect attempts are to be honored (or not). Note that disabling the link prevents incoming connections over an established link. It only takes affect when new connect attempts are made. It does not affect the ability to connect to a node whose link has been disabled. The link-name can be wildcarded.

The current state of the link can be displayed with the SHOW LINK/STATUS command. When looking at connection problems, both ends of the link counters should be used with the SHOW LINK/COUNTER command.

Qualifiers

/AUTOISOLATE

/NOAUTOISOLATE (D)

Any RTR node may disconnect a remote node if it finds the remote node is unresponsive or congested. The normal behavior following such action is automatic network link reconnection and recovery.

Node autoisolation allows a node (the isolator) to disconnect a congested or unresponsive remote node (the isolatee) in such a way that when the congested node attempts to reconnect, it receives an instruction to close all its network links and cease connection attempts. A node in this state is termed isolated.

Some applications require that a node suspected of causing congestion (that is, not processing network data quickly enough) is isolated from the rest of the network, so as to cause minimum disruption. The node autoisolation feature meets this requirement.

Remote node autoisolation can be enabled (at the isolator) where it applies to all links using SET NODE/AUTOISOLATE, or for specific links only with the SET LINK/AUTOISOLATE command. An isolated node (isolatee) remains isolated until you perform both of the following actions:

• Enable the link to the isolated node on all nodes that have isolated it, that is set link [isolated-node]/enable
• Exit the isolated state on the isolated node, that is set node/noisolate

Autoisolation is disabled (at the isolator) using the /NOAUTOISOLATE qualifier.

/CHECKSUM

/NOCHECKSUM (D)

/CHECKSUM specifies that checksum calculations for data packets over network links are performed. This qualifier is by default set to /NOCHECKSUM.

This command is useful for diagnosing errors over network links. To see the checksum state, use the SHOW LINK/STATE command.

/ENABLE

/DISABLE

/ENABLE specifies that connect attempts are honored from the node specified by link-name .

This command is used to enable a link in a disabled state. A link can be disabled either as a result of operator action, or automatically if it has been suspected of causing severe congestion. If a link is automatically disabled, an entry is made in the RTR error log.

/DISABLE specifies that connect attempts are no longer honored from the node link-name . Note that disabling the link does not have any immediate effect on an established link. It only takes effect when new connection attempts are made.

/CLUSTER

/NOCLUSTER (D)

Specifies that the command is executed on all the nodes in the cluster.

If neither /NODE nor /CLUSTER is specified, the command is executed on the nodes specified by the latest SET ENVIRONMENT command. If no SET ENVIRONMENT command has been entered, the command is executed only on the node where the command was issued.

Note In environments that do not support remote command capability, the /CLUSTER qualifier causes the relevant command to be executed on the local node only. See Section 1.4 for more information.

/INACTIVITY_TIMEOUT[=secs]

/INACTIVITY_TIMEOUT=node-default

/INACTIVITY_TIMEOUT[=secs] specifies the maximum elapsed time in seconds before RTR discards a link that is neither receiving traffic nor responding to explicit link state queries. Link failover occurs between the adjustable environmental timer parameters RTR_TIMEOUT_CONNECT , default of 60 seconds, and RTR_TIMEOUT_CONNECT_RELAX , default of 90 seconds, on a network link or remote node. When there is a failure, RTR detects it within the timer parameters stipulated and disconnects and retries the link according to the router preferences for a frontend. If a router fails to respond to the reconnect tries, there will be a time lapse of RTR_TIMEOUT_CONNECT plus RTR_TIMEOUT_CONNECT_RELAX for the link failover to occur.

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 .

You should not specify a value of less than five times the time required for a round trip over the link. If you don't know this value, RTR can measure it for you. Make sure that there is no transactional traffic over the link, and monitor the link (with the MONITOR LINK command) between the two nodes whose round trip time you want to measure. After a few minutes, look at the link counters ndb_lw_trips and ndb_lw_trips_ms using the SHOW LINK/COUNTER= ndb_lw_trips* command. Dividing the latter by the former yields the average round trip time in milliseconds.

Note The inactivity timeout is used for all RTR links, but the effect of a timeout and failover depends on what connections the link is supporting. In brief, a link between a router and a backend timing out causes a router or backend failover and quorum re-negotiations. A frontend will search for another router.

/NODE[=node-list]

/NODE=default-node (D)

Specifies that the command is executed on all nodes specified in node-list . If node-list is omitted, the command is executed only on the node where the command was issued.

/OUTPUT[=filespec]

/OUTPUT=stdout (D)

Specifies that the resulting information is written to the file filespec . If /OUTPUT or filespec is omitted, the standard or default output is used.

/SUSPECT

/NOSUSPECT

Obsolete. Available for compatibility reasons only; use /AUTOISOLATE instead.

Related commands

• SET NODE/AUTOISOLATE
• SHOW LINK/STATUS

Examples

 RTR> SET LINK JOEY/ENABLE
      

This command reallows connections from node JOEY.

 RTR> SET LINK JOEY/AUTOISOLATE
      

This command sets the autoisolate attribute on the link to node JOEY.