Show TOC

 Shell Console AdministratorLocate this document in the navigation structure

Purpose

The J2EE Engine Console Administrator is an alternative to the Visual Administrator . Unlike the Visual Administrator, it is not a GUI and the runtime control and administration is done using specific commands in the shell language. The commands are entered on the command line, in the console where the cluster element is running. This tool enables monitoring of the processes started on the different elements of the cluster and provides an opportunity for prompt and adequate reaction whenever problems occur. The Console Administrator enables remote administration through Telnet clients or applets that simulate Telnet client, as well as continuous deployment of applications and additional libraries.

Caution

The J2EE Engine Shell Console Administrator can be accessed and used only through Telnet. For more information, see Connecting and Working Using Telnet .

Features

Command Groups

The Console Administrator shell commands are organized in groups according to their functions. You can use a shell commands from a group of shell commands only after you add that group to the shell environment. When starting J2EE Engine, the only groups of commands available are ADMIN and SYSTEM , because of their vital importance.

  • To add a group of shell commands to the shell environment, enter ADD [groupName] on the command line. The groupName parameter is the name of the group of shell commands to be added.
  • To view the names of all groups of shell commands (both added and not added to the shell environment), execute the ADD command, but do not specify the [groupName] variable.
  • To view all groups added to the shell environment and their shell commands, execute the MAN command.

Help Messages

To view the help messages for a shell command, execute the command and -h on the command line.

Tip

COMMAND -h

Shell Language Conventions

The following conventions are used when using the shell language commands:

  • The brackets encompassing the shell command parameters have a special meaning explained below. There is no need to type them when executing a command on the command line, unless it is indicated explicitly in the corresponding command description.
  • The <> type of brackets means that the parameter is required. If this parameter is not specified when executing the shell command, the command displays the help message.
  • The [] type of brackets means that the parameter is optional.
    Tip

    MAN [parameter] [groupName] [commandName]

    where [paramter], [groupName], and [commandName] are optional.

  • The commands are displayed in capital letters - for example, MAN ; however, you do not have to type them in capital letters on the command line. The shell language is case-insensitive.
  • If the parameters of a shell command contain key words, when executing the shell command, you must specify the key words exactly as they are given in the command syntax. That is, you must not replace the key words with other values. Key words are identified by the - (hyphen), with which they begin.
    Note

    GENERATE_PERSISTENT <earName> <-dbVendor dbVendorName> [-dsName datasourceName] [-classpath jar1;jar2;…]

System Variables

Variable Name Description

$PATH

The path to look for client scripts.

$CLASSPATH

The path to look for the client classes when REIMPORT command is executed.

$1, $2,..., $n

The parameters, with which the current script is started.

$0

The number of parameters, with which the current script is started.

$USER_NAME, $HOST, $PORT

These variables are used and modified by the LOGIN command.

$MAX_LINE, $MAX_COLUMN

These variables specify the console size.

$STD_IN, $STD_OUT, $STD_ERR

These parameters are standard Input/Output streams. Their possible values are: FileName , SYSTEM , NULL .

$TEMP_BUFFER_SIZE

The size of the buffer (in bytes) for storing the temporary information when pipe commands are executed. A temporary file called n1n2temp.tmp is used when this value is exceeded, where n1 is the process number and n2 is a temporary number of this file. After the construction execution, the temporary files are destroyed.

$PROMPT, $SUBPROMT

The primary and the secondary prompt.

$PASSWORD

The value of this variable is always read from the standard input (until ENTER is reached).

$ECHO

This variable takes only two values - ON and OFF . When $ECHO = OFF , the result of the command execution is shown directly. When $ECHO = ON , the execution is shown step by step.

Tip

>SET  $ECHO = ON >SET  $A = 5 >ECHO  $A >ECHO 5 >5 >SET  $ECHO = OFF >SET  $A = 5 >ECHO  $A >5

$AUTORUN

Contains a script that is executed automatically when the console administrator is started.

See also:

Shell Administration Commands