beautypg.com

Rtr command line interface – Compaq AA-Q88CE-TE User Manual

Page 77

background image

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.

Where possible, command qualifiers have been given the same names as the
parameters to the API calls. See the Application Programmer’s Reference
Manual
for details about the parameters to API calls.

Most commands can be issued on remote nodes by using the

/NODE=node-list

or

/CLUSTER

qualifiers, or by preceding them with the SET ENVIRONMENT

command to specify nodes where commands are to be executed. Commands such
as DEFINE KEY are intended for local execution only.

Output from each command can be redirected to another device or file using the

/OUTPUT

qualifier.

Because the RTR command utility keeps parameter checking to a minimum,
‘‘what if’’ questions can be answered quickly without having to write test
programs.

Note

In a mixed RTR Version 2 and Version 3 environment, you cannot execute
commands remotely with the /NODE qualifier.

6.2 RTR Command Reference

This section describes in detail each command in the RTR command utility.

The command descriptions are presented in alphabetical order.

RTR Command Line Interface 6–1