User Guide

Get
Adobe Reader

Using the OSI TP Administration Utility

This section covers the following topics:

About the osiadmin Processor

Administration of the OSITP functions for BEA Tuxedo Mainframe Adapter for OSI TP is provided by the osiadmin processor. Administration commands are input from a command line or script file. osiadmin can be run regardless of whether or not the TMA OSI TP process is booted, allowing the user to perform configuration utilities, such as export and import, independently.

The osiadmin processor provides the following features:

Sets internal traces while the OSITP process is up and running.
Provides a snapshot dump of NW_BEA and NW_UNISYS internal tables.
Performs test of OSITP connection to a remote domain.
Imports configurations from eLink OSI TP 1.3 (DMCONFIG, OSITP configuration, and ULS configuration) and creates a comparable configuration in proper format for eLink OSI TP 4.x or BEA Tuxedo Mainframe Adapter for OSI TP 8.1.
Exports the dmconfig file and creates the correct format of the config-in.txt file needed for the UNISYS ClearPath systems.
Administers multiple local domains on the same system through one osiadmin processor.
Sends optional trace messages to the Tuxedo ULOG.

Initiating osiadmin

The osiadmin processor can be initiated in interactive, script, or batch mode. The OSIRUNDIR environment variable must be set in order to run the osiadmin utility. Refer to Setting Environment Variables for more information.

Initiating osiadmin in Interactive Mode

Enter the following interactive command at the command line:

osiadmin [LDOM]

The local domain name (LDOM) may be specified at osiadmin execution time. The LDOM is the LDOM identifier specified in the Local_Domains section of the DMCONFIG file.

Note: The LDOM identifier is case sensitive.

For example,

osiadmin BA.CENTRAL01

where BA.CENTRAL01 is the LDOM.

The LDOM is necessary for CONNECTIONSTATUS, DUMP, TRACE, TESTCONNECTION, and LISTRDOM commands. If the LDOM is not specified on the command line, the user must enter an LDOM command before using any of these commands.

Initiating osiadmin in Script Mode

Enter the following command at the command line:

osiadmin [LDOM]<input_script_name>osiadmin_output

where input_script_name is the name of a script file that you created with a series of one or more commands you wish to execute. If the script file is in a different directory, you must also enter the directory path. The script file is a text file that you can create with any text editor. Following is an example run of a script that might be used with osiadmin:

Listing 5-1 Example of an Osiadmin Input Script

>page off             Do not prompt for long output
>echo on              Echo input commands
>LDOM BA.CENTRAL01    Set local domain name for 
                         following commands
>lr                   List remote domains in 
                         BA.CENTRAL01 configuration
 BA.BRANCH01
 BA.BRANCH02
>tc BA.BRANCH01       Verify connection between
                         BA.CENTRAL01 and BA.BRANCH01
<Successfully connected to BA.BRANCH01
>tc BA.BRANCH02       Verify connection between 
                         BA.CENTRAL01 and BA.BRANCH02

 Successfully connected to BA.BRANCH02
>exit

Initiating osiadmin in Batch Mode

Enter the following command at the command line:

osiadmin -b

The "-b" option initiates the osiadmin in batch mode with the following conditions: the menu of commands that is normally displayed upon startup of osiadmin is not printed, pagination is set to off, command echo is set to on, and interactive prompts (for example, "Overwrite file, Y or N") are suppressed.

What Happens When You Execute an osiadmin Command?

When you initiate osiadmin or enter any of the other commands in interactive mode, the command executes if the syntax is correct. If the syntax is incorrect, an error message displays showing the correct syntax. When the command executes, results are printed to the screen. If the result is more than one page and PAGINATE=ON (which is the default), the prompt, "CONTINUE? Y or N" displays. Select Y to continue displaying another 20 lines or N to discontinue displaying the results.

At any time after a command has been executed, you can press Enter to redisplay the command syntax as shown by the Help command.

When you initiate osiadmin and enter commands using a script, the commands execute in order and the results are printed to the screen as the commands execute.

Using osiadmin Commands

All osiadmin commands are initiated through interactive mode or through a script containing one or more commands. The following sections explain how to get Help for osiadmin commands and provide descriptions for each command in detail.

Getting Help for osiadmin Commands

You can request a list of the valid osiadmin commands, request help for specific commands, or display command syntax after a command has been executed.

To display Help in interactive mode:

You can display a list of valid commands by entering the following command at the command line:

HELP

To display Help for a specific command:

Enter the following command at the command line:

HELP command

where command is any of the valid commands.

The exact syntax for the specified command displays.

osiadmin Commands

Following are descriptions of the valid osiadmin commands.

CONNECTIONSTATUS

Allows a user to display the connection status for one or more RDOMS or a pattern containing wildcard characters (*). For example, CONNECTIONSTATUS * lists the connection status for all RDOMS. CONNECTIONSTATUS x* lists the connection status for all RDOMS starting with the letter x.

When a wildcard character is used to specify the pattern for the CONNECTIONSTATUS command, only those RDOMs using the same protocol as the current LDOM are considered. For example, if the current LDOM is using the multiplex protocol, only the RDOMS configured with MULTIPLEX=Y are checked for connection status.

Syntax:

CONNECTIONSTATUS RDOM|pattern

CS RDOM|pattern

DUMP

Produces a dump of internal TMA OSI TP tables including the NW_BEA and the NW_UNISYS portion of code for diagnostic purposes. If a filename is entered, that file is used for the dump. If the filename is not entered, the default dump file, OSITPDUMP.TXT, is used.

Syntax:

DUMP [filename]

DU [filename]

ECHO

Displays input command lines as they are entered when set to ON. If no option is given, the current setting is toggled and the new setting is printed. The initial setting is OFF.

Syntax:

ECHO [OFF|ON]

E [OFF|ON]

EXPORTCFG

Exports TMA OSI TP configuration information from the DMCONFIG file and creates configuration files readable by OSI-TP on UNISYS ClearPath servers. The names of the files produced are <output directory>TAILOR-IN.TXT and <output directory>CONFIG-IN.TXT. The output directory is optional. The current directory is the default if none is specified.

Syntax:

EXPORTCFG RDOM DMCONFIG-SOURCE [<output directory>]

EXCFG RDOM DMCONFIG-SOURCE [<output directory>]

IMPORTCFG

Imports the correct configuration information for the TMA gateway by automatically upgrading configurations from version 1.3 of the eLink gateway. importcfg specifies the DMCONFIG file, OSITP configuration file, and the ULS configuration file to be used for input. The DMCONFIG file is used as input to the dmloadcf processor. A DMCONFIG file is created as the output. The ULS-TAILOR and NEW-TAILOR files are optional and are only valid on Unix. If the output file already exists, a message is sent to confirm before overwriting the file. If no parameters are specified, the user is prompted for the filenames.

Syntax:

IMPORTCFG [<outfile> DMCONFIG-SOURCE OSITP-CONFIGFILE {ULS-TAILOR-SOURCE NEW-TAILOR-SOURCE}]

IMCFG [<outfile> DMCONFIG-SOURCE OSITP-CONFIGFILE {ULS-TAILOR-SOURCE NEW-TAILOR-SOURCE}]

Note: OSITP-CONFIGFILE is the source configuration file and not the current.cfg file that was required for older versions of BEA Tuxedo Mainframe Adapter for OSI TP.

LDOM

Sets the local domain name. The LDOM must be set for the DUMP, CONNECTIONSTATUS, TRACE, TESTCONNECTION, and LISTRDOM commands. The LDOM can also be specified as an argument when executing the osiadmin.

Syntax:

LDOM [LDOM name]

LISTRDOM

Retrieves and displays a list of all RDOMs. The list indicates if the RDOMs are offline or online, indicates if the online RDOMs are currently available, and indicates that communications with unavailable RDOMs are not operational. TMA OSI TP will try to establish communications until successful.

When the LISTRDOM command is run, only those RDOMs using the same protocol as the current LDOM are displayed. For example, if the current LDOM is using the multiplex protocol, only the RDOMS configured with MULTIPLEX=Y are listed.

Syntax:

LISTRDOM

LR

ONLINERDOM

Resets RDOM configured to be offline at startup to online. Once an RDOM is set OFFLINE, it must be manually reset to ONLINE before communications with the peer can continue. All remote services associated with the RDOM will be advertised.

The ONLINERDOM command changes the state of an RDOM to online. The state also immediately changes to available.

Multiplex Protocol

If the current LDOM and the specified RDOM are using multiplexed protocol, and the multiplex policy is STARTUP, then TMA OSI TP immediately attempts to establish a connection from the LDOM to the RDOM. If this fails, the state changes to online and unavailable; then connection attempts are retried until successful.

If the current LDOM and the specified RDOM are using multiplexed protocol, and the multiplex policy is DEMAND, then TMA OSI TP does not attempt to establish a connection from the LDOM to the RDOM until it is needed to perform a CALL or CONNECTION. If this later connection fails, the state changes to online and unavailable; then connection attempts are retried until successful.

Non-Multiplex Protocol

If the current LDOM and the specified RDOM are using non-multiplexed protocol, then TMA OSI TP immediately attempts to establish a connection from the LDOM to the RDOM. If this later connection fails, the state changes to online and unavailable; then connection attempts are retried until successful.

Syntax:

ONLINERDOM RDOM

ONL RDOM

PAGINATE

Turns paginate mode ON or OFF. Default is ON.

Syntax:

PAGINATE {OFF|ON}

PAGE   {OFF|ON}

TESTCONNECTION

Use the TESTCONNECTION command to verify that a connection to the RDOM can be established. This is useful to verify that the configuration is correct and the network is working properly.

Multiplex Protocol

If the current LDOM is using multiplexed protocol, this command checks to see if a connection already exists. If so, the command returns immediately indicating success. If no connection exists, this command attempts to establish a new connection and waits for the result before returning. The new connection is left open for future use.

Non-Multiplex Protocol

If the current LDOM is using non-multiplexed protocol, this command attempts to establish a new connection and waits for the result before returning. Then the new connection is closed.

Syntax:

TESTCONNECTION RDOM

TC RDOM

TRACE

Sets trace levels in TMA OSI TP for diagnostics and debugging purposes. When TRACE is set to ON, messages are written to the Tuxedo ULOG. If the TRACE command is entered without any options, it returns the current trace level.

Syntax:

TRACE {OFF|ON}

TR {OFF|ON}