Display a text in a monitor picture depending on the result of an expression evaluation.

Format

DISPLAY SYMBOLIC expression "text-string" [,"text-string"]...

Description

The DISPLAY SYMBOLIC command displays one of the text strings depending on the value of expression. The first string is output if the expression's value is zero (0), the second string is output if the expression's value is 1, and so on. If the expression has a value for which there is no corresponding entry in the list of texts, then the value itself is printed. (Note that there is a limit of 255 characters on the size of one command to RTR, so large numbers of long strings should be avoided.)

The command can be used within a monitor file or issued at the RTR prompt when interactively defining a monitor picture for use in a subsequent MONITOR command.

Parameters

expression

The expression to be evaluated. Expression can either be the name of a single data item, or an expression combining several data items using simple arithmetic operations and constants. In the latter case, the data items must all be of the same type and EXPRESSION must be enclosed in quotation marks.

Qualifiers

/BLANK[=Boolean-expression]

/NOBLANK (D)

Specifies that the displayed value is replaced by blanks if Boolean-expression evaluates to True (non-zero).

/BLINK[=Boolean-expression]

/NOBLINK (D)

Specifies that the displayed value blinks if Boolean-expression evaluates to True (non-zero).

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

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

Related Commands

• MONITOR
• SHOW DISPLAY
• CLEAR
• DISPLAY BAR
• DISPLAY NUMERIC
• DISPLAY TEXT

Examples

See Section A.1 for examples of how to use the DISPLAY SYMBOLIC command.

Display text in a monitor picture.

Format

DISPLAY TEXT text

Description

The DISPLAY TEXT displays the specified text in a monitor picture. It can be used within a monitor file or issued at the RTR prompt when interactively defining a monitor picture for use in a subsequent MONITOR command.

Parameters

text

Specifies the text to be displayed. This text may contain any of the substitution symbols. See Section A.2, Substitution Symbols.

Qualifiers

/BELL[=Boolean-expression]

/NOBELL (D)

Sends a bell character to the terminal if Boolean-expression evaluates to True (non-zero).

/BLANK[=Boolean-expression]

/NOBLANK (D)

Specifies that the displayed value is replaced by blanks if Boolean-expression evaluates to True (non-zero).

/BLINK[=Boolean-expression]

/NOBLINK (D)

Specifies that the displayed value blinks if Boolean-expression evaluates to True (non-zero).

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

The facility name symbol ($FACILITY_NAME) will be replaced by the text "-ALL-" unless MONITOR/FACILITY=facility-name is used; in this case $FACILITY_NAME is replaced by facility-name.

/LINK

/NOLINK (D)

Specifies that symbol substitution in the text is carried out as if a link data item were being displayed. This means that the facility name symbol ($FACILITY_NAME) and the process related symbols ($PROCESS_ID, $PROCESS_NAME, $IMAGE_NAME, $FULL_IMAGE_NAME) are always replaced by the text "-ALL-". The link name symbol ($LINK_NAME) is replaced by the text "-ALL-" unless MONITOR/LINK=node-name is used, in which case $LINK_NAME is replaced by node-name.

/NODE

/NONODE

Specifies that symbol substitution in the text is carried out as if a node data item were being displayed. This means that the facility name symbol ($FACILITY_NAME), 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-".

/PROCESS

/NOPROCESS (D)

Specifies that symbol substitution in the text is carried out as if a process data item were being displayed. This means that the facility name symbol ($FACILITY_NAME) and the link name symbol ($LINK_NAME) are always replaced by the text "-ALL-".

The process related symbols ($PROCESS_ID, $PROCESS_NAME, $IMAGE_NAME, $FULL_IMAGE_NAME) are replaced by the text "-ALL-" unless MONITOR/IDENTIFICATION=process-id is used. In this case they are replaced by the appropriate strings for the process specified by process-id.

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

/SELECT[=Boolean-expression]

/NOSELECT (D)

Displays the item 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).

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

Related Commands

• MONITOR
• SHOW DISPLAY
• CLEAR
• DISPLAY NUMERIC
• DISPLAY BAR
• DISPLAY SYMBOLIC

Examples

See Section A.1, Interactive Definition of a Monitor Picture for examples of how to use the DISPLAY TEXT command.

Execute an operating system command.

Format

DO [operating-system-command]

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

The DO command is only suitable for commands producing line oriented output, use SPAWN if you want to execute a local operating system command that produces screen oriented output (for example, the OpenVMS MONITOR SYSTEM command, or screen mode editors).

Parameters

DCL-command

The operating system command that you want to execute.

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

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

Example

 RTR> DO/NODE=(TR2,TR1) "ps"

This command displays the processes running on Compaq Tru64 UNIX nodes TR2 and TR1.

Flushes RTR's internal network name cache.

Format

FLUSH NAME_CACHE

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. During extreme DNS latency, RTR could time-out the connections to nodes waiting for a DNS response. To avoid these problems, RTR has implemented an internal node-name-to-id cache; this reduces RTR's exposure to degraded name servers. The contents of the cache can be deleted the command FLUSH NAME_CACHE.

FLUSH NAME_CACHE may be used if the network has been reconfigured or nodes have changed their addresses.

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.

Executes a file containing RTR commands.

Format

EXECUTE file-spec

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.

Examples

 RTR> execute facility_startup

This command executes the file facility_startup . This file might contain commands such as:

start rtr 
create journal 
create facility funding/fontend=(node1,node2)/router=(node3)... 

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.

Adds new nodes or roles or both to an existing facility definition.

Format

EXTEND FACILITY [facility_name]

Description

The EXTEND FACILITY command extends the configuration of an RTR facility. New nodes and roles can be added to a facility definition using the EXTEND FACILITY command. Thus a new node can be introduced into a facility, or a new role can be added to an existing node (for example, a router node can be extended to have a backend role).

Notes: New router nodes must have all backend nodes defined and new backend nodes must have all router nodes defined. Routers need only be defined with the frontends that they can connect to. Frontends need only be defined with the routers they can connect to.

When using this command, the facility being extended may temporarily lose quorum until the affected nodes agree upon the new facility definition. During this time server applications will not be presented with any new transactions.

The RTR MONITOR QUORUM displays a monitor picture which allows the quorum negotiations to be followed after a TRIM or EXTEND of a facility. Once quorum has been attained, the participating nodes return to state "qrt".

As with CREATE FACILITY, nodes or roles may be specified which are superfluous. That is, you may specify backend nodes on a node which only has a frontend role, and frontend nodes may be specified on a node which only has a backend role. This permits a single RTR management command to be issued on many nodes, and each node only accepts those parts of the command which are relevant to it.

For example, in a two node facility called facnam, the node FE has the frontend role only, and node FETRBE that has frontend, router and backend roles can be created as follows:

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

Facility names can contain up to thirty-one characters. Letters, numbers and underline characters are all valid, but the first character of a facility name must be a letter.

The default value for facility_name is RTR$DEFAULT_FACILITY.

The /ROUTER qualifier, and at least one of /FRONTEND or /BACKEND must be specified.

An EXTEND FACILITY command executed on a node where the facility is not defined is interpreted as a CREATE FACILITY command.

To maintain consistency in a facility, the following rules apply when adding nodes or roles or both:

• If a frontend role is added, then the node where it is added must know about at least one router of the facility.
• If a backend role is added, then the node where it is added must know about all routers of the facility. If any router nodes are not known by a backend, then problems may occur in achieving quorum.
• If a router role is added, then the node upon which it is added must know about all backends of the facility. If not all backend nodes are known by a router, then problems will occur in achieving quorum. At least one frontend must be defined on a node that has the router role.
• In order to have a consistent facility definition across all nodes in the facility (and thus avoid problems in attaining quorum), the command to add a router role must be executed on all relevant nodes, that is, the node gaining the router role and all backend nodes.

Qualifiers

/BACKEND=backend-list

/NOBACKEND (D)

Specifies the names of the added nodes that are to act as backends for this 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.

In order for load balancing to function correctly, /BALANCE must be defined on all routers, as well as on those frontends requiring load balancing.

It has no significance on a backend node, and will be ignored if specified.

The default behavior (/NOBALANCE) is for a frontend to connect to the preferred Router. Preferred routers are defined by the order specified in the /ROUTER qualifier of the EXTEND FACILITY command. Note that this preference is subject to the router being available and quorate.

For more details on frontend load balancing, see Section 2.6, Router Load Balancing.

/CALL_OUT[=role-list]

/NOCALL_OUT (D)

Specifies which node types are to have call-out servers running on them.

Role-list is a comma separated list of roles. If role-list contains more than one role then it must be enclosed in parentheses.

Role is one of the keywords ROUTER or BACKEND.

The default for role-list is (ROUTER,BACKEND).

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

/FRONTEND=frontend-list

/NOFRONTEND (D)

Specifies the names of the added nodes that act as frontends in 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.

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

/ROUTER=router-list

/NOROUTER (D)

Specifies the names of the added nodes that act as routers for this facility.

---

Previous

Next

Contents

Index