Dispatcher

ADMIN

This section contains the commands used for SAP J2EE Engine 6.20 Admin Service administration. You do not have to add these commands, as they are embedded in the Shell environment.

The System group provides additional commands for SAP J2EE Engine 6.20 general administration.

Syntax	GC
Description	Runs the JVM Garbage Collector.

INFO

Syntax

INFO [parameters]*

Argument	Description
-java	Displays the JavaVM information.
-system	Displays the system information.
-status <time>	Compares system information changes during the specified time (in milliseconds).

Description

If the command is invoked without any parameters, it displays the JavaVM and the system information.

LISTMNGPROPS

Syntax

LISTMNGPROPS [ClusterID] <ManagerName>

Argument	Description
[ClusterID]	ID of the cluster element. The default value is the ID of the current element.
<ManagerName>	The name of the manager whose properties are listed.

Description

Lists all properties of the specified manager.

LISTPROPS

Syntax

LISTPROPS [ClusterID] <ServiceName>

Argument	Description
[ClusterID]	ID of the cluster element. The default value is the ID of the current element.
<ServiceName>	The name of the service whose properties are listed.

Description

Lists all properties of the specified service.

LSC

Syntax	LSC
Description	Lists all active cluster machines.

LSCON

Syntax	LSCON
Description	Lists all current connections grouped by services.

LSM

Syntax

LSM [ClusterID]

Argument	Description
[ClusterID]	ID of the cluster element. The default value is the ID of the current cluster element.

Description

Lists all managers running on the specified cluster element.

LSP

Syntax

LSP [ClusterID]

Argument	Description
[ClusterID]	ID of the cluster element. The default value is the ID of the current cluster element.

Description

Lists all used ports, on the current cluster element, registered in the PortsManager, in the NetContext, and the ports used by the ClusterManager.

LSS

Syntax

LSS [ClusterID]

Argument	Description
[ClusterID]	ID of the cluster element. The default value is the ID of the current cluster element.

Description

Lists all services installed on the specified cluster element.

LST

Syntax	LST
Description	Displays the thread status of the cluster element.

MARKFORSHUTDOWN

Syntax

MARKFORSHUTDOWN [ClusterID [timeout]]

Argument	Description
[ClusterID]	ID of the element to mark. The default value is the ID of the current cluster element.
[timeout]	Time to wait before shutting down. The value is an integer.

Description

Marks a cluster element for shutdown.

MSC

Syntax	MSC
Description	Displays the memory status of the current cluster element.

REBOOT

Syntax

REBOOT [ClusterID]

Argument	Description
[ClusterID]	ID of the element to reboot. The default value is the ID of the current cluster element. If [ClusterID] is set to 0, the command reboots the whole cluster.

Description

Reboots a cluster element or the whole cluster.

Note: The reboot command is not supported in SAP J2EE Engine 6.20.

RESUME

Syntax

RESUME [ClusterID]

Argument	Description
[ClusterID]	ID of the element to resume. The default value is the ID of the current cluster element.

Description

Resumes (a suspended) cluster element.

SETMANAGERPROPS

Syntax

SETMANAGERPROPS <[-file <fileName>] | [-property <propertyKey> <value>]> [ClusterID] <managerName>

Argument	Description
[-file <fileName>]	Sets the properties from a file named fileName to the specified manager.
[-property <propertyKey> <value>]	Sets the property named <propertyKey>, with value <value> to the specified manager.
[ClusterID]	Sets the manager properties to the specified cluster element.
<managerName>	The manager whose properties are set.

Description

Loads new property values for the specified manager.

SETPROPS

Syntax

SETPROPS [-file <fileName>] | [-property <propertyKey> <value>] [ClusterID] <serviceName>

Argument	Description
[-file <fileName>]	Sets the properties from a file named fileName to the specified service.
[-property <propertyKey> <value>]	Sets the property named <propertyKey>, with value <value> to the specified service.
[ClusterID]	Sets the service properties to the specified cluster element.
<serviceName>	The service whose properties are set.

Description

Loads new property values for the specified service.

SHUTDOWN

Syntax

SHUTDOWN [ClusterID]

Argument	Description
[ClusterID]	ID of the element to shut down. The default value is the ID of the current cluster element. If [ClusterID] is set to 0, the command shuts down the whole cluster.

Description

Shuts down a cluster element or the whole cluster.

STARTSERVICE

Syntax

STARTSERVICE [clusterID] <serviceName>

Argument	Description
[ClusterID]	ID of the cluster element on which to start the specified service. The default value is the ID of the current cluster element. If [ClusterID] is set to 0, the service starts on all cluster elements.
<serviceName>	The name of the service started.

Description

Starts a service on the specified cluster element.

STOPSERVICE

Syntax

STOPSERVICE [parameters] [ClusterID] <serviceName>

Argument	Description
[parameters]	Options: -f\|a. -f – forces the execution; -a – on all cluster elements.
[ClusterID]	ID of the cluster element on which to stop the specified service. The default value is the ID of the current cluster element. If [ClusterID] is set to 0, the service stops on all cluster elements.
<serviceName>	The name of the service to be stopped.

Description

Stops a service on the specified cluster element.

SUSPEND

Syntax

SUSPEND [ClusterID]

Argument	Description
[ClusterID]	ID of the element to be suspended. The default value is the ID of the current cluster element.

Description

Suspends the specified server cluster element.

VERSION

Syntax	VERSION
Description	Displays the version of the cluster.

DEBUG

This group of commands is used for viewing debug information for specific modules.

ENABLEDEBUG

Syntax

EnableDebug -true / -false

Argument	Description
-true	Enables setting session cookie for debugging.
-false	Disables setting session cookie for debugging.

Description

Enable or disable setting session cookie for debugging , which is made with this request: @@@DEBUG@@@?ELEMENT_ID=????

JMS

This section contains the commands used for SAP J2EE Engine 6.20 JMS Service administration. They are added to the Shell environment by executing ADD JMS on the command line.

Syntax	CLOSE <protocol_name>
Description	Closes the socket used by the specified protocol.

CONFIGURE

Syntax	CONFIGURE [protocol_name] [new_port_number]
Description	Sets a new port number for a specified protocol. If the command has no parameters, it shows all current started protocols.

JMSINFO

Syntax	INFO
Description	Shows information about the protocols supported by the dispatcher.

KEYSTORE

This section contains the commands used for SAP J2EE Engine 6.20 Keystore Service administration. Executing ADD KEYSTORE on the command line adds these commands to the Shell environment.

CREATIONDATE

Syntax

CREATIONDATE <alias>

Argument	Description
<alias>	The alias of the keystore entry.

Description

Displays the creation date of a keystore entry.

EXISTS

Syntax	EXISTS <alias>
Description	Checks whether an entry with the alias specified has been stored.

ISKEY

Syntax	ISKEY <alias>
Description	Checks if the keystore entry with the alias specified is a key.

LIST

Syntax	LIST
Description	Lists the aliases of the entries available in keystore.

SIZE

Syntax	SIZE
Description	Returns the number of entries in keystore.

LOG

This section contains the log commands used for SAP J2EE Engine 6.20 Log Service administration. They are added to the Shell environment by executing ADD LOG on the command line.

The results from the Log Service can be found in the following directories:

<SAPj2eeEngine_install_dir>/alone/services/log/
<SAPj2eeEngine_install_dir>/cluster/dispatcher/services/log/
<SAPj2eeEngine_install_dir>/cluster/server/services/log/

Both commands below concern the SAP Logging and Tracing API.

LOGGER

Syntax

LOGGER [loggerName]

Argument	Description
[loggerName]	The name of the logger.

Description

Registers a logger in the name space if loggerName is specified. If no parameter is specified, displays all registered loggers.

Example

LOGGER demoLogger

LOGCONFIGURE

Syntax

LOGCONFIGURE [key]

LOGCONFIGURE <key> <value>

LOGCONFIGURE file <fileName>

Argument	Description
<key>	The key part of the key-value pair. If the command is used only with this argument, displays the current value of the specified configuration key.
<value>	The value part of the key-value pair.
<fileName>	The name of the text file, having key-value pairs on each row. It is used to add the configurations located into it.

Description

Configures Loggers and Handlers. Displays or changes the current settings depending on the parameters provided. The settings are key-value pairs with the syntax described by the com.sap.tc.technology.logging package. It is also used to create Handlers to the Logger.

Example

Configure severity level for logger “demoLogger” to debug level:

> logconfigure demoLogger.severity DEBUG

Add console output handlers to logger “demoLogger”:

> logconfigure log[demoLogger] ConsoleLog
> logconfigure demoLogger.logs + log [demoLogger]

Configure SAP J2EE Engine 6.20 LogBridgeConnector:

> logconfigure log [demoLogger] com.inqmy.services.log.logging.tc.LogBridge

> logconfigure formatter[demoLogger].pattern(<key>’:’<value>’;’)*

Example:

> logconfigure formatter[demoLogger].pattern InfoLogFileName: ./log/example.log;…

MONITOR

This section contains the commands used for starting and stopping SAP J2EE Engine 6.20 Monitor Server. They are added to the Shell environment by executing ADD MONITOR on the command line.

STARTMONITORSERVER

Syntax

STARTMONITORSERVER [configFile]

Argument	Description
[configFile]	Specifies the monitor server configuration file.

Description

Starts a monitor server on the same virtual machine on which SAP J2EE Engine 6.20 is started. However, the monitor server specific shell commands cannot be executed on the command line in this case.

STOPMONITORSERVER

Syntax	STOPMONITORSERVER
Description	Stops the monitor server running on the same virtual machine.

R3STARTUP

This section contains the commands used for administering the SAP J2EE Engine 6.20 R3startup Service.

INVALIDATE_ETAG

Syntax

INVALIDATE_ETAG <name>

Argument	Description
<name>	Etags defined in response: sap-isc-etag header.

Description

Invalidates ICMAN cache based on etags.

INVALIDATE_URL

Syntax

INVALIDATE_URL <url>

Argument	Description
<url>	URL with wildcard (e.g. /j2ee/abc/?)

Description

Invalidate ICMAN cache based on URL.

SENDACTIVE

Syntax	SENDACTIVE
Description	Sends ACTIVE message.

SENDINACTIVE

Syntax	SENDINACTIVE
Description	Sends INACTIVE message.

SSL

This section contains the commands used for administering the SAP J2EE Engine 6.20 SSL Service. They are added to the Shell environment by executing ADD SSL on the command line.

Note: Before starting the SSL Service, the Keystore Service must be started.

ATC

Syntax

ATC [<host> <port>] <alias>

Argument	Description
[<host> <port>]	The host and port of the server socket, for which a command for adding trusted certificates is executed.
<alias>	The name of the certificate.

Description

Adds trusted certificate with the specified alias to the socket with the specified host and port.

LTC

Syntax

LTC [<host> <port>]

Argument	Description
[<host> <port>]	The host and port of the server socket, for which a command for listing trusted certificates is executed.

Description

Shows all trusted certificate names for the socket with the specified host and port.

RTC

Syntax

RTC [<host> <port>] <alias>

Argument	Description
[<host> <port>]	The host and port of the server socket, for which a command for removing trusted certificates is executed.
<alias>	The name of the certificate.

Description

Removes trusted certificate with the specified alias from the socket with the specified host and port.

SYSTEM

This group of commands concerns SAP J2EE Engine 6.20 general administration. You do not have to add these commands, as they are embedded in the Shell environment.

The Admin group provides additional commands for SAP J2EE Engine 6.20 general administration.

ADD

Syntax

ADD <groupName>

Argument	Description
<groupName>	Adds the specified group of commands to the groups activated by the user – that is, activates this group of commands.

Description

If no arguments are specified, displays all activated groups of commands.

CAT

Syntax

CAT <parameters> <fileName>

Argument	Description
-r <S1> <S2>	Requires two string parameters following it. Everywhere in the input stream, the second string replaces the first one.
-n	Prints the number of lines in the input stream.
-c	Prints the number of symbols in the input stream.
<fileName>	The relative path from < SAP_J2EE _Engine _install_dir/cluster/dispatcher> to the file.

Description

This command prints the file “filename” to the standard output. If the file is not identified, the command prints the standard input (for end of the input stream use EOF or CTRL-K, according to the operating system).

CLS

Syntax	CLS
Description	Clears the screen.

ECHO

Syntax

ECHO <parameter>*

Argument	Description
<parameter>*	An arbitrary string.

Description

This command prints all parameters to the standard output. The symbol * is a metasymbol and means that there is no limit to the number of parameters.

EXEC

Syntax

EXEC [options] <commandName> [parameters]*

Argument	Description
-b	Starts the native process in background mode. If this option is not specified, the command starts the process in foreground mode.
<commandName>	Name of the system command.
[parameters]*	Parameters of the system command.

Description

Executes a system command.

EXIT

Syntax	EXIT
Description	This command stops the current process. Equivalent to QUIT.

GET

Syntax	GET <$variable>
Description	Reads a line from the standard input stream and sets it as a value of the specified variable.

GREP

Syntax

GREP [option]... <pattern> [file]...

Argument	Description
-p <file>	Obtains <pattern> from the specified file.
-i	Ignores case distinctions.
-w	Forces “pattern” to match only whole words.
-x	Forces “pattern” to match only whole lines.
-v	Selects non-matching lines.
-b	Prints the byte offset with output lines.
-n	Prints line number with output lines.
-f	Prints the filename for each match.
-d <action>	How to handle directories. <action> can be “read” or “recursive.”
-l	Only prints “file” names containing no match.
-m	Only prints “file” names containing matches.
-c	Only prints a count of matching lines per “file.”
-e <num>	Prints “num” lines of leading context.
-t <num>	Prints “num” lines of trailing context.
[file]	If not specified, the command reads from the standard input.

Description

Searches for a pattern in each file or standard input.

IMPORT

Syntax

IMPORT <commandName> <className>

Argument	Description
<commandName>	The name of the command to be imported.
<className>	The name of the class that executes the command.

Description

Imports a system command.

KILL

Syntax

KILL <processID>

Argument	Description
<processID>	The ID of the process to be killed.

Description

Kills the process with the specified ID.

LOADENV

Syntax

LOADENV <fileName>

Argument	Description
<fileName>	The file where the properties are stored.

Description

Reads all properties from the specified file and loads them into the current Shell environment.

MAN

Syntax

MAN [parameter] [groupName] [commandName]

Argument	Description
-g	If no other parameters are specified, displays all activated and deactivated groups of commands. If [groupName] is specified, the command displays all commands in the group.
[groupName]	Specifies the group name.
[commandName]	The name of the command.

Description

This command displays a help message for the specified command. If no parameters are specified, this command displays all activated commands.

Syntax

<command> <parameters>: MORE

Argument	Description
-r number	Specifies the number of rows in the console, where number is an integer.
-c number	Specifies the number of columns in the console, where number is an integer.

Description

Redirects the output from the specified command to the input formatted according to the -r and -c properties. Their default values are taken from the Shell environment.

Syntax	PS
Description	Displays all current processes.

QUIT

Syntax	QUIT
Description	This command stops the current process. Equivalent to EXIT.

REIMPORT

Syntax

REIMPORT [parameters] <commandName>

Argument	Description
-d	Removes the specified command.

Description

If no other parameters are specified, the command <commandName> is reloaded.

REMOVE

Syntax

REMOVE [groupName]

Argument	Description
[groupName]	The name of the group of commands to be removed.

Description

Removes the specified group of commands – that is, deactivates this group of commands. If no arguments are specified, all activated groups of commands are displayed.

RUN

Syntax

RUN [-b] <fileName>[.scr] [parameters]*

Argument	Description
[-b]	“-b” - Starts the script in background mode. If this option is not specified, starts the script in foreground mode.
<fileName>	A relative path from < SAP_J2EE _Engine _install_dir/cluster/dispatcher> to the script file.
[parameters]*	The values of the script file variables.

Description

Starts a script process.

SAVEENV

Syntax	SAVEENV <fileName>
Description	Saves the environment (system variables and imported commands) in <fileName>.

SET

Syntax

SET [$Variable = (variable | expression | String | Word)*]

Argument	Description
variable	Sets the value of this variable to be the value of the variable on the right side of the equation.
expression	Calculates the given expression and sets the result as a value of the specified variable.
String	Sets this String as a value of the specified variable.
Word	Sets this Word as a value of the specified variable.

Description

Sets a value to the specified variable. If the command has no parameters, it displays all available variables and their values.