Reliable Transaction Router
System Manager's Manual

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.

If /NOBALANCE is specified with the EXTEND FACILITY command, then the order in which router nodes are specified with the /ROUTER qualifier defines the preferred routing order.

Router-node is either the name of a node or @file-spec.

File-spec specifies a text file containing a router-list on each line.

Related Commands

CREATE FACILITY
DELETE FACILITY
SHOW FACILITY
TRIM FACILITY

Examples

See Chapter 2, Starting and Setting Up RTR, for examples of how to use the EXTEND FACILITY command.

INITIALIZE JOURNAL

See CREATE JOURNAL; INITIALIZE is only retained for compatibility reasons.

LOG

Specify RTR to write a log message to a log file.

Format

LOG

Command Qualifiers	Defaults
/CLUSTER	/NOCLUSTER
/NODE=node-list	/NODE=default-node-list
/OUTPUT[=file-spec]	/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. Do this by using SET LOG to specify a new file and deleting the old one.
If neither the /OPERATOR nor the /FILE qualifier is specified then logging is suppressed.

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

Related Commands

SHOW 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

Specifies the desired and maximum allowed sizes of RTR's recovery journal.

Format

MODIFY JOURNAL [disk-1] ... [,disk-n]

Command Qualifiers	Defaults
/CLUSTER	/NOCLUSTER
/BLOCKS=nr-blocks	/BLOCKS=1000
/MAXIMUM_BLOCKS=nr-blocks	/MAXIMUM_BLOCKS=1000
/NODE=node-list	/NODE=default-node-list
/OUTPUT[=file-spec]	/OUTPUT=stdout

Description

The MODIFY JOURNAL command specifies how the size of RTR recovery journal files on the specified disks can be modified. The target or desired size is specified using the /BLOCKS qualifier. The maximum_allowed size is specified using the /MAXIMUM_BLOCKS qualifier. /BLOCKS and /MAXIMUM_BLOCKS are a positional qualifiers, so journal files need not be the same size on each disk.
RTR only uses journal files on nodes that are configured to run servers, that is, on backends and on routers with call-out servers.
Note that the MODIFY JOURNAL command does not cause immediate journal file extension. Actual file size modifications take place on demand (by the RTRACP) within the limits defined by the MODIFY JOURNAL command.
The MODIFY JOURNAL command assumes that a journal already exists for the node. If a journal does not exist, an error message is output.
In contrast to the CREATE JOURNAL command, the MODIFY JOURNAL command is normally entered interactively, not automatically from a startup command procedure.

Parameters

disk-1 ... disk-n
Specifies a list of disk names where journal files are modified.
Refer to the CREATE JOURNAL command for information about disks used for journal files.

Qualifiers

/BLOCKS[=nr-blocks]

/BLOCKS=1000 (D)
Specifies the size of the journal file in blocks. This qualifier can be applied locally to each disk or globally for all disks.
/CLUSTER

/NOCLUSTER (D)
Specifies that the command is executed on all the nodes in the cluster.
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.
/MAXIMUM_BLOCKS[=nr-blocks]

/MAXIMUM_BLOCKS=1000 (D)
Specifies the maximum size that the journal file can use. This qualifier can be applied locally to each disk or globally for all disks.
/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.

Related Commands

CREATE JOURNAL
INITIALIZE JOURNAL
SHOW JOURNAL

OpenVMS Example

 RTR> MODIFY JOURNAL DISK1$:/BLOCKS=3000/MAXIMUM_BLOCKS=20000

This command specifies that the desired size of the journal file is 3000 blocks, and the maximum journal file size is 20,000 blocks.

Example

 RTR> MODIFY JOURNAL "/dev/rz3a" /BLOCK=2000 /MAXIMUM_BLOCKS=20000

This command specifies that the desired size of the journal file is 2000 blocks, and the maximum journal file size is 20,000 blocks.

MONITOR

Displays a monitor picture on the screen.

Format

MONITOR [monitor-file-spec]

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-list
/OUTPUT[=file-spec]	/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 may be defined interactively using DISPLAY commands and then executed using a MONITOR/RESUME command.
You may also put the DISPLAY commands into a file (called a monitor file) and then issue a MONITOR monitor-file-spec command.

Parameters

monitor-file-spec
Specifies a file containing DISPLAY commands. Monitor file names are of the form monitor-file-spec.mon
This file may specify either a user defined display or one of the standard displays supplied with RTR. If monitor-file-spec contains only the file-name portion of a file specification then the RTR utility first searches the platform-specific location(s) for a standard monitor file.

Qualifiers

/CLUSTER

/NOCLUSTER (D)
Specifies that all nodes in the cluster are monitored.
If neither /NODE nor /CLUSTER is specified then the nodes specified with the latest SET ENVIRONMENT command is monitored. If no SET ENVIRONMENT has been issued then the MONITOR command is executed on the node where it 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.
/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. 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 hexadecimal 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-list (D)
Specifies the names of the nodes to be monitored. If node-list is omitted then the local node is monitored.
/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.
/PARTITION=partition-name

/NOPARTITION (D)
Specifies the names of the partitions to be monitored. Partitions names have the form node$facility$partition-id.
/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. This 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.

Related Commands

SCROLL
PRINT
CLEAR
DISPLAY NUMERIC
DISPLAY BAR
DISPLAY TEXT

Examples

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

Display the CALLS picture, monitoring nodes TR2 and TR1 every ten seconds.
The SHOW PROCESS command is entered, interrupting the display.
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

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

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.
When you recall a command, the RTR Utility displays the command but does not execute it. If you want 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 then 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  (4)
 RTR> CREATE FACILITY ORDERS/FRONT=FE3/ROUTER=TR2 (5)

Create facility "QUOTES"
Check the links
Recall the CREATE FACILITY command
Change the facility name to "ORDERS" and resubmit the command.

REGISTER RESOURCE MANAGER (REGISTER RM)

Registers an instance of a resource manager (RM) with RTR.

Format

REGISTER RESOURCE MANAGER [resource_name]
REGISTER RM [resource_name]

Command Qualifiers	Defaults
/open_string	/see the Oracle8 Administrator's Reference manual
/close_string	/see the Oracle8 Administrator's Reference manual
/switch_name	/see the Oracle8 Administrator's Reference manual
/library_path	/path to an XA library
/protocol	/XA

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 RTR ACP is started and before RTR facilities that reference this resource manager are created.

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

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

Parameters

resource_name
Specifies the name of the resource to be registered.
Any application program which uses this resource must specify the same name when it calls rtr_open_channel() .
Resource names can contain up to thirty 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.

Related Commands

UNREGISTER RESOURCE MANAGER
SHOW RESOURCE MANAGER

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"

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

Previous Next Contents Index

Reliable Transaction RouterSystem Manager's Manual

Related Commands

Examples

INITIALIZE JOURNAL

LOG

Format

Description

Qualifiers

/CLUSTER

/NOCLUSTER (D)

/NODE[=node-list]

/NODE=default-node-list (D)

/OUTPUT[=file-spec]

/OUTPUT=stdout (D)

Related Commands

Examples

MODIFY JOURNAL

Format

Description

Parameters

disk-1 ... disk-n

Qualifiers

/BLOCKS[=nr-blocks]

/BLOCKS=1000 (D)

/CLUSTER

/NOCLUSTER (D)

/MAXIMUM_BLOCKS[=nr-blocks]

/MAXIMUM_BLOCKS=1000 (D)

/NODE[=node-list]

/NODE=default-node-list (D)

/OUTPUT[=file-spec]

/OUTPUT=stdout (D)

Related Commands

OpenVMS Example

Example

MONITOR

Format

Description

Parameters

monitor-file-spec

Qualifiers

/CLUSTER

/NOCLUSTER (D)

/COUNT=nr-updates

/COUNT=infinite (D)

/FACILITY=facility-name

/NOFACILITY (D)

/IDENTIFICATION=process-id

/NOIDENTIFICATION (D)

/INTERVAL[=delay-seconds]

/INTERVAL=2 (D)

/LINK=link-name

/NOLINK (D)

/NODE=node-list

/NODE=default-node-list (D)

/OUTPUT[=file-spec]

/OUTPUT=stdout (D)

/PARTITION=partition-name

/NOPARTITION (D)

/RESUME

/NORESUME (D)

/VERIFY

/NOVERIFY (D)

Related Commands

Examples

QUIT

Format

Description

RECALL

Format

Description

Parameters

command-specifier

Qualifiers

/ALL

/NOALL (D)

Examples

REGISTER RESOURCE MANAGER (REGISTER RM)

Format

Description

Reliable Transaction Router
System Manager's Manual