# hp Reliable Transaction Router
System Manager's Manual

Previous | Contents | Index

# MONITOR

> The MONITOR command displays a monitor picture on the screen.

## Format

> MONITOR [monitor-filespec]

Command Qualifiers | Defaults
--- | ---
/CLUSTER | /NOCLUSTER
/COUNT=nr-updates | /COUNT=infinite
/FACILITY=facility-name | /NOFACILITY
/IDENTIFICATION=process-id | /NOIDENTIFICATION
/INTERVAL=delay-seconds | /INTERVAL=2
/LINK=link-name | /NOLINK
/NODE[=node-list] | /NODE=default-node
/OUTPUT[=filespec] | /OUTPUT=stdout
/PARTITION=partition-name | /NOPARTITION
/RESUME | /NORESUME
/VERIFY | /NOVERIFY

## Description

> The MONITOR command allows certain RTR status variables to be continuously displayed on your terminal.

> The individual items displayed in the monitor picture can be defined interactively using DISPLAY commands and then executed using a MONITOR/RESUME command.

> You can also put the DISPLAY commands into a file (called a monitor file) and then issue a MONITOR `monitor-filespec` command.

> See Chapter 7 for a description of standard monitor pictures.

## Parameters

> ### monitor-filespec

> Specifies a file containing DISPLAY commands. Monitor file names are of the form `monitor-filespec.mon`

> This file can specify either a user-defined display or one of the standard displays supplied with RTR. If `monitor-filespec` contains only the file-name portion of a file specification, the RTR utility first searches the platform-specific location for a standard monitor file.

## Qualifiers

> ### /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.

> ### /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. Use the /COUNT qualifier when the /OUTPUT qualifier is being used to redirect output to a file. In this case, `nr-updates` specifies how many screen images are written to the file.

> ### /FACILITY=facility-name

> ### /NOFACILITY (D)

> Specifies the name of the facility to be monitored. This is only meaningful if at least one facility counter is displayed.

> ### /IDENTIFICATION=process-id

> ### /NOIDENTIFICATION (D)

> Specifies the process-id of the process to be monitored. This is only meaningful if at least one process counter is to be displayed.

> ### /INTERVAL[=delay-seconds]

> ### /INTERVAL=2 (D)

> Specifies how frequently RTR updates the screen. `Delay-seconds` is the number of seconds that RTR waits after completing one screen update before starting the next. Note that the interval between updates will always be slightly longer than `Delay-seconds` , depending on the complexity of the display and the number of nodes being monitored.

> ### /LINK=link-name

> ### /NOLINK (D)

> Specifies the node name for the link to be monitored. This is only meaningful if at least one link counter is to be displayed.

> ### /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.

> ### /PARTITION=partition-name

> ### /NOPARTITION (D)

> Specifies the names of the partitions to be monitored. This is only meaningful if at least one partition counter is to be displayed.

> ### /RESUME

> ### /NORESUME (D)

> Re-executes the last MONITOR command. The qualifiers /OUTPUT, /INTERVAL and /COUNT may be used with /RESUME. All other qualifiers are ignored. Use this qualifier 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-filespec` are echoed on `stdout` . This is useful when developing monitor files to find the exact location of syntax errors.

### Related commands

- CLEAR
- DISPLAY BAR
- DISPLAY NUMERIC
- DISPLAY TEXT
- SCROLL

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` .

# QUIT

> The QUIT command quits from the RTR prompt.

> Note This command is not available in the RTR web browser interface.

## 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

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

> Note This command is not available in the RTR web browser interface.

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

# REGISTER RESOURCE_MANAGER (REGISTER RM)

> 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]

Command Qualifiers | Defaults
--- | ---
/OPEN_STRING=open_string | None
/CLOSE_STRING=close_string | None
/LIBRARY_PATH=library_path | None
/XASWITCH_NAME=switch_name | None

## 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, RTR 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.

Note Resource manager-related information such as open string, close string and the switch name are very vendor specific. Each resource manager may have a different requirement for accessing the XA library. The resource manager vendor is required to publicize all the specific information and restrictions. You should read their documentation about XA libraries thoroughly before using it.

### 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"

# RTR

> The RTR command invokes the RTR command line interface.

> Note This command is not available in the RTR web browser interface.

## Format

> RTR

## Description

> The RTR command causes the RTR command line interface to be invoked and presents the `RTR>` prompt to accept commands.

## Parameters

> ###

> None.

### Related commands

- START RTR

##

### Examples

     %  (1)
     RTR   (2)
     RTR> START RTR  (3)

> 1. Displays the operating system prompt.
> 2. Invokes the RTR CLI.
> 3. Starts the RTRACP application control process.

# SCROLL

> The SCROLL command scrolls a monitor picture.

> Note This command is not available in the RTR web browser interface.

## 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.

# SET ENVIRONMENT

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

> Note This command is not available in the RTR web browser interface.

## Format

> SET ENVIRONMENT

Command Qualifiers | Defaults
--- | ---
/CLUSTER | /NOCLUSTER
/NODE[=node-list] | /NODE=this_node

## 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. This command must be entered at the `RTR>` prompt. It cannot be executed from the operating system prompt or command line.

## 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` . The `node-list` is a comma-separated list of nodenames in parentheses. If `node-list` is omitted, or both the /NODE and /CLUSTER qualifiers are omitted, subsequent commands are executed on only the local or current node.

### Related commands

- SHOW ENVIRONMENT

##

### Examples

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

# SET FACILITY

> The SET FACILITY command sets various facility-related options.

## Format

> SET FACILITY facility-name

Command Qualifiers | Defaults
--- | ---
/BROADCAST_MINIMUM_RATE=Bps | /BROADCAST_MINIMUM_RATE=1000
/BALANCE | /NOBALANCE
/CLUSTER | /NOCLUSTER
/NODE[=node-list] | /NODE=default-node
/OUTPUT[=filespec] | /OUTPUT=stdout
/QUORUM_THRESHOLD=n | /QUORUM_THRESHOLD=0
/REPLY_CHECKSUM | /NOREPLY_CHECKSUM

## 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.8, Router Load Balancing and Flow Control, 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 node/role combinations that must 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.

> Note This command must be entered on a frontend.

### 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.

Previous | Next | Contents | Index