CONTENTS   NextPrevious  



Server

ADMIN

This section contains the commands used SAP J2EE Engine 6.20 Admin Service administration. These commands are embedded in the Shell environment; therefore, it is not necessary to add them.

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

APPTRACE

Syntax

APPTRACE [-enable|-enableall|-disable]

 

Argument

Description

-enableall

Enables application tracing for all applications and users.

-enable

Enables application tracing that must be additionally specified by user, for example in HTTP request.

 

-disable

Disables application tracing.

Description

This command is used to enable or disable application tracing option.

 

GC

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 interval (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 which 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. Available to servers only.

<ServiceName>

The name of the service for which properties are listed.

Description

Lists all properties of the specified service.

 

LOG

Syntax

LOG [-s|m] [-type <string>] [-service <string>] [-last n] [-cluster n]

 

Argument

Description

-m

Displays the managers log on the cluster.

-s

Displays the services log on the cluster.

-type <string>

Displays the specified logtype, the value of <string> can be one of the following: debug, info, notice, warning, error, critical, alert, emergency. If this parameter is not specified, all log messages are displayed.

-service <string>

Displays the log of the specified service or manager. To view the services or managers proper names use the LSS/LSM command.

-last n

Displays the last n log entries in the specified log category. If this parameter is omitted, then the last 20 log messages are displayed.

-cluster n

Displays the log messages on the specified cluster element. To see all cluster elements use “-cluster all”.

Description

Prints the contents of the specified logfiles.

Example

log -m -service MemoryManager -last 20
log -s -type info -service telnet -last 200
log -cluster all

 

LSC

Syntax

LSC

Description

Lists all active cluster machines.

 

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.

 

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 which 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 for which 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 SAP J2EE Engine 6.20 cluster.

 

APPCLIENT

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

LISTCLIENTS

Syntax

LISTCLIENTS

Description

Lists all running application clients.

 

RUNCLIENT

Syntax

RUNCLIENT <name> [args] [file]

 

Argument

Description

<name>

Name of the application client to be started.

[args]

The arguments to pass to the application client.

[file]

The file to which to dump the application client output. If specified, this command dumps the output and immediately stops the client.

Description

Starts an application client.

 

STOPCLIENT

Syntax

STOPCLIENT <parameters>

 

Argument

Description

name

Name of the application client to be stopped.

[file]

The file to which to dump the application client output.

Description

Stops an application client.

 

DBMS

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

DBMSSHELL

Syntax

DBMSSHELL

Description

Starts the DBMS Shell, used for administration of this service. The description of the commands used in the DBMS, are placed in a separate section, named DBMSSHELL, at the end of the DBMS group.

 

GET_REPLICATION_INFO

Syntax

GET_REPLICATION_INFO [sid]

 

Argument

Description

[sid]

ID of the server for which replication information must be retrieved. If ID is not explicitly specified, replication information about the current server node is retrieved. The [sid] parameter must represent a valid ID in the cluster. If the parameter is set to ‘all’, the command displays replication information about all server nodes in the cluster.

Description

Displays information about the replication in the DBMS service.

 

GET_STATISTICS

Syntax

GET_STATISTICS [statistics]

 

Argument

Description

[statistics]

Identifies a specific type of information to be displayed. If this parameter is not specified, it is equivalent to ‘all’.

      all

Displays all currently available statistics.

      ActiveTran
sactions (AT)

Shows the number of currently active transactions.

Description

Shows current database statistics.

 

MAKE_NON_PRIMARY_SERVER

Syntax

MAKE_NON_PRIMARY_SERVER [sid]

 

Argument

Description

[sid]

The server ID. The default value is the current server ID. The [sid] parameter must represent a valid ID in this cluster.

Description

Makes the server with server ID [sid] to be a subordinate storage server.

 

MAKE_PRIMARY_SERVER

Syntax

MAKE_PRIMARY_SERVER [sid]

 

Argument

Description

[sid]

The server ID. The default value is the current server ID. The [sid] parameter must represent a valid ID in this cluster.

Description

Makes the server with server ID [sid] primary storage server.

 

DBMSSHELL

This group of commands forms a separate shell sub group. These commands are active after executing the DBMSSHELL command.

EXIT (BYE)

Syntax

EXIT
BYE

Description

Exits the DBMS shell.

 

HELP (?)

Syntax

HELP
?

Description

Prints a short description of the commands.

 

BEGIN

Syntax

BEGIN

Description

Starts a transaction. The optional timeout parameter is in milliseconds.

 

COMMIT

Syntax

COMMIT

Description

Commits a transaction.

 

ROLLBACK

Syntax

ROLLBACK

Description

Rollbacks a transaction.

 

CHECKPOINT (CP)

Syntax

CHECKPOINT
CP

Description

Checkpoints a transaction.

 

UNDOCHECKPOINT (UCP)

Syntax

UNDOCHECKPOINT
UCP

Description

Undoes a checkpoint on a transaction.

 

AUTOCOMMIT (AC)

Syntax

AC [true|false]
 AUTOCOMMIT [true|false]

Description

Switches the auto commit mode on and off. If no parameter is supplied it displays the current mode.

 

CREATECONTAINER (CC)

Syntax

CREATECONTAINER [name] [/u]
CC [name] [/u]

 

Argument

Description

[name]

Indicates the name of the newly created container.

[/u]

A key denoting that the new container will not contain objects with equal names.

Description

Creates a container.

 

DESTROYCONTAINER (DC)

Syntax

DESTROYCONTAINER cid
DC cid

 

Argument

Description

cid

The id of the container to be destroyed.

Description

Destroys a container.

 

GETALLCONTAINERS (GAC)

Syntax

GETALLCONTAINERS
GAC

Description

Lists all containers.

 

FINDCONTAINERS (FC)

Syntax

FINDCONTAINERS name
FC name

 

Argument

Description

name

The name of the container to display.

Description

Lists all containers with the given name.

 

GETCONTAINERNAME (GCN)

Syntax

GETCONTAINERNAME cid
GCN cid

 

Argument

Description

cid

The id of the container to display.

Description

Displays the name of a specified container.

 

GETROOTCONTAINER (GRC)

Syntax

GETROOTCONTAINER
GRC

Description

Displays the root container.

 

MODIFYCONTAINER (MC)

Syntax

MODIFYCONTAINER cid newdata
MC cid newdata

 

Argument

Description

cid

The id of the container to modify.

newdata

The new container byte array.

Description

Modifies the byte array of a container.

 

READCONTAINER (RC)

Syntax

READCONTAINER cid
RC cid

 

Argument

Description

cid

The id of the container to read.

Description

Reads a given container.

 

SETCONTAINERNAME (SCN)

Syntax

SETCONTAINERNAME cid [name]
SCN cid [name]

 

Argument

Description

cid

The id of the container to modify.

[name]

The new container name. If no name is supplied the last parameter is set to null.

Description

Sets a new name for the specified container.

 

CREATEOBJECT (CO)

Syntax

CREATEOBJECT cid data [name]
CO cid data [name]

 

Argument

Description

cid

The container ID.

data

The new object data.

[name]

The name of the new object.

Description

Creates an object in a specified container.

 

DELETEOBJECT (DO)

Syntax

DELETEOBJECT cid oid
DO cid oid

 

Argument

Description

cid

The container ID of the object.

oid

The object ID.

Description

Deletes an object.

 

GETALLOBJECTS (GAO)

Syntax

GETALLOBJECTS cid
GAO cid

 

Argument

Description

cid

The ID of the container.

Description

Lists all the objects in a specified container.

 

FINDOBJECTS (FO)

Syntax

FINDOBJECTS cid
FO cid

 

Argument

Description

cid

The ID of the container.

name

The name of the object.

Description

Lists all objects with the given name in the specified container.

 

GETLINKEDCONTAINER (GLC)

Syntax

GETLINKEDCONTAINER cid oid
GLC cid oid

 

Argument

Description

cid

The container ID.

oid

The object ID.

Description

Displays the linked container for a given object.

 

GETOBJECTNAME (GON)

Syntax

GETOBJECTNAME cid oid
GON cid oid

 

Argument

Description

cid

The container ID.

oid

The object ID.

Description

Displays the name of a given object.

 

MODIFYOBJECT (MO)

Syntax

MODIFYOBJECT cid oid newdata
MO cid oid newdata

 

Argument

Description

cid

The container ID.

oid

The object ID.

newdata

The object’s new byte array.

Description

Modifies the byte array of a given object.

 

MOVEOBJECT (MOVOBJ)

Syntax

MOVEOBJECT cid oid newcid
MOVOBJ cid oid newcid

 

Argument

Description

cid

The container ID.

oid

The object ID.

newcid

The new container ID.

Description

Moves a specified object from one container to another.

 

READOBJECT (RO)

Syntax

READOBJECT cid oid
RO cid oid

 

Argument

Description

cid

The container ID.

oid

The object ID.

Description

Reads a specified object.

 

SETLINKEDCONTAINER (SLC)

Syntax

SETLINKEDCONTAINER cid oid linked
SLC cid oid linked

 

Argument

Description

cid

The container ID.

oid

The object ID.

linked

The linked container ID.

Description

Sets a linked container for a specified object.

 

SETOBJECTNAME (SON)

Syntax

SETOBJECTNAME cid oid name
SON cid oid name

 

Argument

Description

cid

The container ID.

oid

The object ID.

name

The new object name.

Description

Sets a new name for a specified object.

 

CONTAINERREADLOCK (CRL)

Syntax

CONTAINERREADLOCK
CRL

Description

Sets container read lock.

 

CONTAINERWRITELOCK (CWL)

Syntax

CONTAINERWRITELOCK
CWL

Description

Sets container write lock.

 

OBJECTREADLOCK (ORL)

Syntax

OBJECTREADLOCK
ORL

Description

Sets object read lock.

 

OBJECTWRITELOCK (OWL)

Syntax

OBJECTWRITELOCK
OWL

Description

Sets object write lock.

 

BENCHMARK (BM)

Syntax

BENCHMARK
BM

Description

Executes performance test on DBMS and prints the results.

 

SETTRANSACTIONTIMEOUT (STT)

Syntax

SETTRANSACTIONTIMEOUT timeout
STT timeout

 

Argument

Description

timeout

The transaction timeout in milliseconds.

Description

Sets transaction timeout.

 

GETTRANSACTIONTIMEOUT (GTT)

Syntax

GETTRANSACTIONTIMEOUT
GTT

Description

Gets the transaction timeout.

 

SETISOLATIONLEVEL (SIL)

Syntax

SETISOLATIONLEVEL isolationlevel
SIL isolationlevel

Description

Sets isolation level for the current transaction.

 

GETISOLATIONLEVEL (GIL)

Syntax

GETISOLATIONLEVEL
GIL

Description

Gets the isolation level of the current transaction.

 

ISACTIVE (IA)

Syntax

ISACTIVE
IA

Description

Tests whether the current transaction is active (i.e. no commit or rollback has been performed after starting).

 

ISROLLBACKED (IR)

Syntax

ISROLLBACKED
IR

Description

Tests whether current transaction has been rolled back.

 

FINDCONTAINER (FCR)

Syntax

FINDCONTAINER name
FCR name

 

Argument

Description

name

The name of the container.

Description

Finds the specified container.

 

FINDOBJECT (FOBJ)

Syntax

FINDOBJECT cid name
FOBJ cid name

 

Argument

Description

cid

The container ID.

name

The object name.

Description

Finds an object with a specified name in a given container.

 

MAKEPRIMARYSERVER (MPS)

Syntax

MAKEPRIMARYSERVER [serverID]
MPS [serverID]

 

Argument

Description

[serverID]

The server ID. If no server ID is specified, the default is the current one.

Description

Makes a specified server to be primary storage server.

 

MAKENONPRIMARYSERVER (MNPS)

Syntax

MAKENONPRIMARYSERVER [serverID]
MNPS [serverID]

 

Argument

Description

[serverID]

The server ID. If no server ID is specified, the default is the current one.

Description

Sets the specified with [serverID] server to be a subordinate storage server.

 

GETREPLICATIONINFO (GRI)

Syntax

GETREPLICATIONINFO [serverID]
GRI [serverID]

 

Argument

Description

[serverID]

The server ID. If the parameter is set to all, the command displays replication information about all server nodes in the cluster.

Description

Displays replication information about the server node specified with [serverID] .

 

GETSTATISTICS (GS)

Syntax

GETSTATISTICS
GS

Description

Displays current database statistics.

 

GETDATABASEFULLSTAT (GDBFS)

Syntax

GETDATABASEFULLSTAT
GDBFS

Description

Displays current database comprehensive statistics.

 

DBPOOL

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

CHANGE_POOL_PROPS

Syntax

CHANGE_POOL_PROPS pool_name -<sw>:[value] [-<sw>:[value]]

 

Argument

Description

-<sw>

Switches:

switch name: driver
default value: no default value
description: Driver class name
available values:

 

switch name: user
default value: null
description: Database user
available values:

 

switch name: password
default value: null
description: Database password
available values:

 

switch name: url
default value: null
description: no default value
available values:

 

switch name: jarName
default value: no default value
description: Jar name containing jdbc driver
available values:

 

switch name: driverSpecific
default value: null
description: Driver specific properties
available values:

 

switch name: initConn
default value: 0
description: Initial number of allocated connections
available values: positive int

 

switch name: defConn
default value: 2
description: Default number of allocated connections
available values: positive int

 

switch name: maxConn
default value: 2
description: Max number of allocated connections in pool
available values: positive int

 

switch name: expireTimeout
default value: 60
description: Connection expiration interval in seconds
available values: positive int

 

switch name: expireThread
default value: 600
description: Connection expire thread activation in seconds
available values: positive int

 

switch name: xapool
default value: true
description: Enable transaction support
available values: true,false

 

switch name: pooling
default value: true
description: Enable connection pooling
available values: true,false

 

switch name: fake2pc
default value: true
description: Enable two phase commit for non-XA databases
available values: true,false

 

switch name: aliases
default value: null
description: Creates aliases to this pool. Pool can be looked up by name or aliases
available values:

 

switch name: isolation
default value: none
description: Sets connections isolation level
available values: none,ruc,rc,rr,s
none - default isolation
ruc - TRANSACTION_READ_UNCOMMITED
rc - TRANSACTION_READ_COMMITED
rr - TRANSACTION_REPEATABLE_READ
s - TRANSACTION_SERIALIZABLE

 

The following switches are specific for JDBC 2.0 drivers:

switch name: serverName

description: name of the database server

 

switch name: portNumber

description: port, on which database listens for connections

 

switch name: CPDSFactoryClassName

description: the classname of the factory for XADataSource objects

 

switch name: CPDSClassName

description: classname of XADataSource instance

 

Note: If the JDBC 2.0 driver has additional specific properties, they must be specified as switches in the format <switch name: value>.

Description

Changes the properties of an existing pool.

Example

CHANGE_POOL_PROPS DB1

-jarName:d:\cts1.2.1\lib\OracleDriver.zip
-user:cts1 -password:cts1 -driver:oracle.jdbc.driver.OracleDriver
-url:jdbc:oracle:thin:@<host>:1521:CTS

 

CHECK_DRIVER

Syntax

CHECK_DRIVER <driver_name>

Description

Verifies if the specified driver has been registered.

Example

CHECK_DRIVER solid.jdbc.SolidDriver

 

CLOSE_CONN

Syntax

CLOSE_CONN <pool_name> <conn_id>

 

Argument

Description

<pool_name>

The name of the pool where the connection is to be returned.

<conn_id>

ID of the connection to be returned to the pool.

Description

Returns a connection with specified ID to a pool specified by name.

 

CLOSE_POOL

Syntax

CLOSE_POOL <pool_name>

Description

Closes the pool with the specified name.

Example

CLOSE_POOL test

 

DELETE_POOL

Syntax

DELETE_POOL <pool_name>

Description

Removes the specified pool.

Example

DELETE_POOL test

 

DESTROY_CONN

Syntax

DESTROY_CONN <pool_name> <conn_id>

 

Argument

Description

<pool_name>

The name of the pool where is the connection to be destroyed.

<conn_id>

ID of the connection to be destroyed.

Description

Destroys a connection with specified ID.

 

GET_ALL_CONN

Syntax

GET_ALL_CONN <pool_name>

Description

Returns the count of the connection (both free and used) in the specified pool.

Example

GET_ALL_CONN test

 

GET_DRIVERS

Syntax

GET_DIRVERS

Description

Displays a list of all registered drivers.

 

GET_FREE_CONN

Syntax

GET_FREE_CONN <pool_name>

Description

Returns the count of the free connections in the specified pool.

Example

GET_FREE_CONN test

 

GET_USED_CONN

Syntax

GET_USED_CONN <pool_name>

Description

Returns the count of the used connections in the specified pool.

Example

GET_USED_CONN test

 

GET_POOLS

Syntax

GET_POOLS

Description

Lists the names of all existing pools.

 

GET_POOL_PROPS

Syntax

GET_POOL_PROPS <poolname>

Description

Displays a list of properties for the specified pool, if it exists.

Example

GET_POOL_PROPS test

 

IS_POOL_OPEN

Syntax

IS_POOL_OPEN <pool_name>

Description

Checks if the specified pool is open.

Example

IS_POOL_OPEN test

 

IS_RUNNING

Syntax

IS_RUNNING

Description

Checks if Pool Manager is running.

 

LIST_CONN

Syntax

LIST_CONN <pool_name>

Description

Returns a list of the connection in the specified pool and their IDs.

Example

LIST_CONN test

 

OPEN_POOL

Syntax

OPEN_POOL <pool_name>

Description

Opens the specified pool, if it exists.

Example

OPEN_POOL test

 

REGISTER_DRIVER

Syntax

REGISTER_DRIVER <driver_name> <serializable_file_name>

Description

Registers a driver by specified name and archive file that contains it.

Example

REGISTER_DRIVER solid.jdbc.SolidDriver c:\solid\SolidDriver.zip

 

REGISTER_POOL

Syntax

REGISTER_POOL [pool_name] -<sw>:[value] [-<sw>:[value]]

 

Argument

Description

-<sw>

Switches:

switch name: driver
default value: no default value
description: Driver class name
available values:

 

switch name: user
default value: null
description: Database user
available values:

 

switch name: password
default value: null
description: Database password
available values:

 

switch name: url
default value: null
description: no default value
available values:

 

switch name: jarName
default value: no default value
description: Jar name containing jdbc driver
available values:

 

switch name: driverSpecific
default value: null
description: Driver specific properties
available values:

 

switch name: initConn
default value: 0
description: Initial number of allocated connections
available values: positive int

 

switch name: defConn
default value: 2
description: Default number of allocated connections
available values: positive int

 

switch name: maxConn
default value: 2
description: Max number of allocated connections in pool
available values: positive int

 

switch name: expireTimeout
default value: 60
description: Connection expiration interval in seconds
available values: positive int

 

switch name: expireThread
default value: 600
description: Connection expire thread activation in seconds
available values: positive int

 

switch name: xapool
default value: true
description: Enable transaction support
available values: true,false

 

switch name: pooling
default value: true
description: Enable connection pooling
available values: true,false

 

switch name: fake2pc
default value: true
description: Enable two phase commit for non-XA databases
available values: true,false

 

switch name: aliases
default value: null
description: Creates aliases to this pool. Pool can be looked up by name or aliases
available values:

 

switch name: isolation
default value: none
description: Sets connections isolation level
available values: none,ruc,rc,rr,s
none - default isolation
ruc - TRANSACTION_READ_UNCOMMITED
rc - TRANSACTION_READ_COMMITED
rr - TRANSACTION_REPEATABLE_READ
s - TRANSACTION_SERIALIZABLE

 

The following switches are specific for JDBC 2.0 drivers:

switch name: serverName

description: name of the database server

 

switch name: portNumber

description: port, on which database listens for connections

 

switch name: CPDSFactoryClassName

description: the classname of the factory for XADataSource objects

 

switch name: CPDSClassName

description: classname of XADataSource instance


switch name: delistBeforeCompletion

description: specifies if the XAResource is delisted before the transaction is committed or rolled back
available values: true, false
true – for drivers that require XAResource delistment (for example,  Merant SequeLink driver)
false – for drivers that require XAResource not to be delisted (for example, Oracle and MSSQL)

 

Note: If the JDBC 2.0 driver has additional specific properties, they must be specified as switches in the format <switch name: value>.

Description

Creates a pool with the specified name and property values.

Example

DB1
-jarName:d:\cts1.2.1\lib\OracleDriver.zip -user:cts1
-password:cts1 -driver:oracle.jdbc.driver.OracleDriver
-url:jdbc:oracle:thin:@<host>:1521:CTS

 

REMOVE_DRV

Syntax

REMOVE_DRV <driver_name>

Description

Removes the specified driver from the drivers registered within the system.

Example

REMOVE_DRV solid.jdbc.SolidDriver

 

TEST_POOL

Syntax

TEST_POOL <pool_name> <sql_statement>

Description

Tests if the specified pool functions properly.

Example

TEST_POOL pool1 select * from test

 

DEPLOY

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

CHANGELIB

Syntax

CHANGELIB <-d|u|r> <libname> <jarnames> <mappings>

 

Argument

Description

<-d>

<-u>

<-r>

Deploys a library.

Updates a library.

Removes a library.

<libname>

Library name. By default all libraries must start with “library:<name>”.

<jarnames>

The names of the jar files in this library; the elements of this array are be divided by “;”. This parameter is not obligatory when removing a library.

<mappings>

Directory or path to the directory where the library files are installed. If an array element is empty, jar files are installed in server directory additional-lib .

Description

Deploys, updates, and removes libraries on servers in the clusters.

CHANGEREF

Syntax

CHANGEREF <-m|r> <fromApp> <toLibraries>

 

Argument

Description

<-m>

 

<-r>

 

<fromApp>

Makes the references between the given application and libraries.

Removes the references between the given application and libraries.

The name of an application. By default all applications must start with “library:<name>”, which means a reference to a library. If the reference is to a service, this argument must be “service:<name>”.

<toLibraries>

The names of libraries, which have been already deployed. If more than one, they must be divided with semicolon (;). By default all libraries must start with “library:<name>”.

Description

Makes and removes references between applications and libraries.

CLIENTJARS

Syntax

CLIENTJARS <-d outputdir> <-a app_name*>

 

Argument

Description

<-a app_name*>

The name of the application for which client jar is required.

<-d outputdir>

The name of the directory where the client jars are stored after obtaining them from the server.

Description

Obtains an array of jar files, containing the classes of a client application that uses the specified components.

 

DEPLOY

Syntax

DEPLOY [-j2eeVersion 1.2|1.3] [-r support*] [-rl] [-ct a|b] <earName>

 

Argument

Description

<earName>

The name of the archive that is deployed

[-ct a|b]

The type of the EJB container: “a” or “b”. If specified, this parameter must be placed before <earName>. EJB Container type “a” supports single instance per primary key for bean managed entity beans. EJB Container type “b” supports many instances per primary key for bean managed entity beans. The default value is “b”.

[-r support*]

A list of remote communication protocols for which the deployed components will have generated support. The default one is p4.

[-rl]

This parameter must be set only if the application beans must be able to lookup objects bound in the root of the naming system.

[-j2eeVersion 1.2|1.3]

Shows which J2EE specification version is used in the deployed EAR. The default one is 1.2. Tip: if you have EJB2.0 in the EAR use version 1.3.

Description

Deploys all recognized components found in archive file named <earName>on the specified servers.

 

DEPLOYLANGLIB

Syntax

DEPLOYLANGLIB <appName> <langlib*>

 

Argument

Description

<appName>

The name of the application, for which language libraries are deployed.

<langlib>

File path to the library archive(s).

Description

Deploys language libraries for an application on all server nodes in the cluster.

 

GETSTATUS

Syntax

GETSTATUS <-a applicationName>

 

Argument

Description

<-a applicationName>

The name of the application, which status are displayed.

Description

Displays the status of specified application – stopped or started.

 

LISTAPP

Syntax

LISTAPP

Description

Lists all applications deployed on the specified container in the specified servers, and displays their status. If no applications are deployed, a corresponding message is displayed.

 

LISTEL

Syntax

LISTEL [-s serverNames*] [-c containerName] <-a application name>

 

Argument

Description

[-c containerName]

The name of the container on which the application components are deployed.

<-a application name>

The name of the application to which the listed components belong.

[-s serverNames*]

A list of server names.

Description

Lists all components that belong to <-a application name> and are deployed on the specified container in the specified servers. If conatinerName is omitted, all components of the specified application on all registered containers are listed. If serverNames are not specified, all application components deployed on the specified container in all server nodes in the cluster are listed.

 

REMOVEAPP

Syntax

REMOVEAPP <-a applicationName>

 

Argument

Description

<-a applicationName>

The name of the application that are removed.

Description

Removes the specified application from all servers in the cluster.

 

STARTAPP

Syntax

STARTAPP <applicationName>

 

Argument

Description

<applicationName>

The name of the application that are started.

Description

Starts the specified application. If the application is started already, an exception occurs.

 

STOPAPP

Syntax

STOPAPP <applicationName>

 

Argument

Description

<applicationName>

The name of the application that are stopped.

Description

Stops the specified application. If the application is stopped already, an exception occurs.

 

UNLOCKAPP

Syntax

UNLOCKAPP <appName>

 

Argument

Description

<appName>

The name of the application that are unlocked.

Description

Unlocks an application that has been automatically locked by the system during execution of another command from the DEPLOY group. An application is locked if the attempts to execute another command from the DEPLOY group result in the following message: “ Already started operation with the same application in the cluster. No other operation over this application is allowed at the moment. ”

Note: Use this command in case of emergency only! Make sure that it is not executed simultaneously with another command from the DEPLOY group on the same application.

 

UPDATE

Syntax

UPDATE [-j2eeVersion 1.2|1.3] [-rl] [-ct a|b] <earName>

 

Argument

Description

[-j2eeVersion 1.2|1.3]

Shows which J2EE version is used in the updating EAR. The default one is 1.2. If you have EJB 2.0 in the EAR, use version 1.3.

[-rl]

This parameter must be set only if the application EJBeans must be able to lookup objects bound to the root of the naming system.

[-ct a|b]

The type of the EJB container: “a” or “b”. If specified, this parameter must be placed before <earName>. EJB Container type “a” supports single instance per primary key for bean-managed entity Beans. EJB Container type “b” supports many instances per primary key for bean-managed entity Beans. The default value is “b”.

<earName>

The name of the archive that is updated.

Description

Updates all components found in the archive file, named <earName> on all servers in the cluster.

 

EISCONNECTOR

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

CHANGE_CONNECTOR_PROPS

Syntax

CHANGE_CONNECTOR_PROPS ConnectorName InstanceName -<sw>:<list>[;<list>][<-sw>:<list>[;<list>]...].

 

Argument

Description

<list>

<key#value>[, <key#value>] | value.

<sw>

switches.

switches

List.

DisplayName

Display name need not be unique.

VendorName

Vendor name.

SpecVersion

Specification version.

Version

String-based version.

EISType

EISConnector type.

License

description#"value", license_required#"TRUE or FALSE".

ManConnFactoryClass

Class that implements javax.resource.spi.ManagedConnectionFactory.

ConnFactoryInterface

ConnectionFactory interface supported by the resource adapter.

ConnFactoryImplClass

ConnectionFactory class that implements resource adapter specific ConnectionFactory interface.

ConnInterface

Connection interface supported by the resource adapter.

ConnImplClass

Connection class that implements resource adapter specific Connection interface.

TransSupport

Level of transaction support provided by the resource adapter.

ReauthSupport

Supports re-authentication of existing ManagedConnection instance.

ConfigProps

Declaration of configuration property for a ManagedConnectionFactory instance in such way: name#"value", type#"value", value#"value", description#"value".

AuthMech

Specifies type of an authentication mechanism in such way: description#"value", type#"value", CredInterface#"value", displayName#"value".

SecPerm

Specifies a security permission that is required by the resource adapter code in such way: description#"value", SecPermSpec#"value", displayName#"value".

Description

Changes the properties of a specified connector.

 

DELETE_AUTH_MECHANISM

Syntax

DELETE_AUTH_MECHANISM <ConnectorName> <AuthenticationDisplayName>

 

Argument

Description

<ConnectorName>

The name of a specified connector.

<AuthenticationDisplayName>

The name of the authentication to be displayed.

Description

Deletes an authentication specified by <ConnectorName> and <AuthenticationDisplayName>

 

DELETE_CONNECTOR

Syntax

DELETE_CONNECTOR <ConnectorName>

 

Argument

Description

<ConnectorName>

The name of the connector to be deleted.

Description

Removes the specified connector.

 

DELETE_CONNECTOR_INSTANCE

Syntax

DELETE_CONNECTOR_INSTANCE <ConnectorName> <InstanceName>

 

Argument

Description

<ConnectorName>

The name of the connector.

<InstanceName>

The name of the instance to be deleted.

Description

Deletes a specified connector instance.

 

DELETE_SEC_PERMISSION

Syntax

DELETE_SEC_PERMISSION <ConnectorName> <PermissionName>

 

Argument

Description

<ConnectorName>

The name of the connector.

<PermissionName>

The name of the security permission to be deleted.

Description

Deletes specified security permission.

 

GET_CONNECTORS

Syntax

GET_CONNECTORS

Description

Lists the names of all existing connectors.

 

REGISTER_AUTH_MECHANISM

Syntax

REGISTER_AUTH_MECHANISM ConnectorName InstanceName [-force] -<sw>:<list> [;<list>] [<-sw>:<list>[;<list>]...].

 

Argument

Description

<list>

<key#value>[, <key#value>] | value.

<sw>

Switches.

switches

List.

AuthMech

Declaration of property for Authentication instance.

Description

Registers an authentication mechanism.

 

REGISTER_CONNECTOR

Syntax

REGISTER_CONNECTOR <resource_adapter_file>

 

Argument

Description

<resource_adapter_file>

The file name of the resource adapter.

Description

Registers a specified connector.

Example

REGISTER_CONNECTOR BlackBoxNoTx.rar

 

REGISTER_CONNECTOR_INSTANCE

Syntax

REGISTER_CONNECTOR_INSTANCE ConnectorName InstanceName [-force] -<sw>:<list>[;<list>] [<-sw>:<list>[;<list>]...].

 

Argument

Description

<list>

<key#value>[, <key#value>] | value.

<sw>

Switches.

switches

List.

ConfigProps

Configuration property Declaration for a ManagedConnectionFactory instance.

Description

Registers a new connector instance.

 

REGISTER_SEC_PERMISSION

Syntax

REGISTER_SEC_PERMISSION ConnectorName InstanceName [-force] -<sw>:<list> [;<list>] [<-sw>:<list>[;<list>]...].

 

Argument

Description

<list>

<key#value>[, <key#value>] | value.

<sw>

Switches.

switches

List.

SecPerm

Configuration property declaration for SecurityPermission instance.

Description

Registers a new secondary permission.

 

EJB20

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

CREATE_TABLES

Syntax

CREATE_TABLES <earName> <datasourceName> [tempDir]

 

Argument

Description

<earName>

Specifies the full path to the ear file for which tables in the database need to be created.

<datasourceName>

Specifies the name of the data source, which refers to an optional database.

[tempDir]

Specifies the auxiliary directory, which are used. If not specified d:\xmlTemp\ are used.

Description

This command creates tables into the database

 referred by the data source with a specified <datasourceName>.

 

DROP_TABLES

Syntax

DROP_TABLES <earName> <datasourceName> [tempDir]

 

Argument

Description

<earName>

Specifies the full path to the ear file for which tables in the database are deleted.

<datasourceName>

Specifies the name of the data source, which refers to an optional database.

[tempDir]

Specifies the auxiliary directory, which are used. If not specified d:\xmlTemp\ are used.

Description

This command deletes tables from the database referred by the data source with a specified <datasourceName>.

 

MAKE_JMS_CONNECTIONFACTORY

Syntax

MAKE_JMS_CONNECTIONFACTORY -factoryName <factoryName> -namingEnabled <namingEnabled> -linkFactoryName [linkFactoryName] -initialContextFactory [initialContextFactory] -providerURL [providerURL] -securityPrincipal [securityPrincipal] -securityCredentials [securityCredentials]

 

Argument

Description

<factoryName>

Specifies the name of the factory, which are created.

<namingEnabled>

This parameter is set to “true” if the specified JMS provider provides Naming system. Otherwise, it is set to “false”.

*  [linkFactoryName]

Specifies the name of the factory on the remote JMS server. Using this name, lookup is performed from the remote Naming system.

* [initialContextFactory]

Specifies the name of the new InitialContext object.

* [providerURL]

Specifies the provider URL.

* [security

Principal]

Specifies the user. For instance: Administrator, guest and so on

* [security

Credentials]

Specifies the user’s password.

[objectFactoryName]

Specifies the name of JMS provider's objectFactory.

[className]

Specifies the class name of connection factory.

-propertyName

Specifies the name of the property for the connection factory.

-propertyValue

Specifies the value of the property for the connection factory.

Description

This command makes JMS ConnectionFactory without a JMS provider or for a specified JMS provider. Consider the “Usage” section below to figure out how to use this command in either of the two cases. Arguments, denoted with ‘*’, are used in the case with a specified JMS provider.

Example

(with naming):
make_jms_connectionFactory -factoryName QueueConnectionFactory  -namingEnable true -linkFactoryName QueueConnectionFactory -initialContextFactory com.inqmy.services.jndi.InitialContextFactoryImpl -providerUrl localhost -securityPrincipal Administrator –securityCredentials

(without naming):
make_jms_connectionFactory  -factoryName myTopic-2Sonic -namingEnable false -createInstance progress.message.jclient.TopicConnectionFactory brokerURL localhost:2506

 

GENERATE_PERSISTENT

Syntax

GENERATE_PERSISTENT <earName> [tempDir]

 

Argument

Description

<earName>

Specifies the name of the ear file.

<tempDir>

Specifies the name of the auxiliary directory. If not specified, d:\xmlTemp\ is used by default.

Description

This command transforms 1.1 bean’s meta-inf\storage.xml into meta-inf\persistent.xml . If the storage.xml does not exist, a default persistent.xml is generated. Then it is added to the bean’s jar meta-inf directory in the specified ear file.

 

MAKE_ADAPTER

Syntax

MAKE_ADAPTER [adapter_name] [file_name]

 

Argument

Description

[adapter_name]

Specifies the name of the ConnectionObjectFactory.

[file_name]

Specifies ConnectionObjectFactory RAR file.

Description

This command deploys ConnectionObjectFactory by specified name and archive file.

 

MAKE_DATA_SOURCE

Syntax

MAKE_DATA_SOURCE [-options]

 

Arguments

Description

-classpath

Specifies JAR files for XADataSource; if more than one files are specified, they must be separated by semicolon (;).

-xml

Specifies XML file containing DataSource properties.

Description

This command creates a DataSource or/and a XADataSource object. It requires two parameters. If only a DataSource object is being created and it will use an existing XADataSource, classpath is not required.

 

REMOVE_DATA_SOURCE

Syntax

REMOVE_DATA_SOURCE [dataSourceName]<true/false>

 

Arguments

Description

[dataSourceName]

Specifies name of DataSource to be removed.

<true/false>

This parameter is optional. If set to “true” or not specified, both DataSource and XADataSource are removed; otherwise, only the specified DataSource are deleted. 

Description

This command removes a DataSource specified by name.

 

REMOVE_XADS

Syntax

REMOVE_XADS [xadsName]

 

Arguments

Description

[xadsName]

Specifies name of XADataSource to be removed.

Description

This command removes a XADataSource by specified name.

 

HTTP

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

CLEARHTTPCACHE

Syntax

CLEARHTTPCACHE

Description

Removes all files in the cache previously stored there by the HTTP Service. When using the cache, if a file has been modified the cache returns the previous content (not the modified one). For a modification to take effect, the cache has to be cleared first and then it will cache the new content.

 

JMS

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

CONFIGURE

Syntax

CONFIGURE <destination_name> <value>

 

Argument

Description

<destination_name>

The name of the destination.

<key>

The property, which value is changed.

<value>

The new value of the property.

Description

Changes the value of property <key> from the specified destination to the specified new value.

 

DESTINATION

Syntax

DESTINATION <queue|topic> <destination_name>

 

Argument

Description

<queue|topic>

Choose whether to create queue or topic.

<destination_name>

The name of the destination.

Description

Creates a new topic or queue with the specified name.

 

JMSREMOVE

Syntax

JMSREMOVE <destination_name>

Description

Removes the destination named <destination_name>.

 

SHOW

Syntax

SHOW [destination_name]

Description

Displays the parameters of the destination named [destination_name]. If the [destination_name] is not specified, the command lists all destinations.

 

STORAGE

Syntax

STORAGE <destination_name>

 

Argument

Description

<destination_name>

The name of the destination.

Description

Displays the messages stored in the specified destination.

 

KEYSTORE

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

 

BACKDOWN

Syntax

BACKDOWN <backup_file_name>

Description

Loads the keystore backup file.

 

BACKUP

Syntax

BACKUP < backup_file_name>

Description

Creates a backup file for the keystore.

 

CREATIONDATE

Syntax

CREATIONDATE <alias>

 

Argument

Description

<alias>

The alias of the keystore entry.

Description

Displays the creation date of a keystore entry.

 

DELETE

Syntax

DELETE <alias>

Description

Deletes a keystore entry identified by the specified alias.

 

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.

 

LOAD

Syntax

LOAD <alias> <format> <file-name> [<cert1> <cert2> ..]

Description

Loads a key or certificate with the specified alias from a file, named <file-name>.

 

READ

Syntax

READ <key> <alias> <file-name> <cert1> [cert2 ..]
READ <certificate> <alias> <file-name>

Description

Reads a keystore entry from a specified file.

 

SIZE

Syntax

SIZE

Description

Returns the number of entries in keystore.

 

STORE

Syntax

STORE <alias> <format> [<asn-type>] [<password>] <file-name>

Description

Stores a key or certificate with the specified alias in the specified file.

 

WRITE

Syntax

WRITE certificate <alias> <file-name>
WRITE chain <alias> <file-name>
WRITE key <alias> <file-name>

Description

Saves a keystore entry with the specified alias in the specified file.

 

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:

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;…

 

 

LOGIN

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

The Policy, Resource and Users groups provide additional commands to administer the Security Service.

EXPIRATION

Syntax

EXPIRATION

Description

Displays the default period after which a session expires.

 

LOGGEDUSERS

Syntax

LOGGEDUSERS

Description

Displays information about all users logged on to SAP J2EE Engine 6.20 cluster at present.

 

LOGIN

Syntax

LOGIN <user_name> [password]

Description

Logs in a registered user to SAP J2EE Engine 6.20 cluster by <user_name> and [password].

 

LOGOUT

Syntax

LOGOUT [session-id]

Description

This command forces logout on a user specified by [session-id]. If [session-id] is not specified, the command logs out the user logged in at present.

 

SESSIONS

Syntax

SESSIONS

Description

Displays the number of active sessions.

 

USERLIMIT

Syntax

USERLIMIT [<max-users>]

Description

Specifies the maximum users allowed at the same time.

 

MONITOR

This section contains the commands used to start and stop 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.

 

NAMING

This section contains the commands used for the SAP J2EE Engine 6.20 Naming Service administration. They are added to the Shell environment by executing ADD NAMING on the command line. When executing the commands in this group, the command arguments must be executed along with the specified brackets.

BIND

Syntax

BIND <[-loc:]location> <[-txt:]string>

 

Argument

Description

<[-loc:]location>

The path to the location.

<[-txt:]string>

The text to bind.

Description

Binds the specified parameters to the specified location.

 

JNDISHELL

Syntax

LOGIN <user_name> [password]

Description

Starts the JNDI Shell. The description of the commands used in the JNDI are placed in a separate section, named JNDISHELL, at the end of the Naming group.

 

LOOKUP

Syntax

LOOKUP <[-loc:]location>

 

Argument

Description

<[-loc:]location>

The path to the location.

Description

Looks up according to the specified parameter.

 

LSEC

Syntax

LSEC [-loc:location]

 

Argument

Description

[-loc:location]

The context for which to list the security permissions.

Description

Lists the security permissions for the specified context.

 

LSN

Syntax

LSN

 

Argument

Description

-c

Output class names.

Description

Displays the naming system as a tree.

 

LSR

Syntax

LSR

Description

Displays the containers in the database as a tree.

 

MSUB

Syntax

MSUB <-loc:location>

 

Argument

Description

<-loc:location>

The name of the new subcontext.

Description

Creates a subcontext.

 

REBIND

Syntax

REBIND <[-loc:]location> <[-txt:]string>

 

Argument

Description

<[-loc:]location>

The path to the location.

<[-txt:]string>

The text to rebind.

Description

Rebind the specified parameters to the specified location.

 

 

RSUB

Syntax

RSUB <[-loc:]location>

 

Argument

Description

<[-loc:]location>

The name of the subcontext.

Description

Removes a subcontext.

 

UNBIND

Syntax

UNBIND <[-loc:]location>

 

Argument

Description

<[-loc:]location>

The path to the location.

Description

Unbinds the specified context.

 

JNDISHELL

This group of commands forms a separate Shell subgroup. These commands are active after executing the JNDISHELL command. Apart from the commands described below, all commands in the Naming group are also active in this subshell.

RENAME

Syntax

RENAME (location, location)

 

Argument

Description

location

The name of the existing binding.

location

The name of the new binding.

Description

Binds a new name to the object bound to an old name, and unbinds the old name.

 

 

MENV

Syntax

MENV (property, string)

 

Argument

Description

property

The name of the environment property to add. The property cannot be null.

string

The value of the property to add. The value cannot be null.

Description

Adds a new environment property to the environment of this context. If the property already exists, its value is overwritten.

 

 

RENV

Syntax

RENV (property)

 

Argument

Description

property

The name of the environment property to remove. The property cannot be null.

Description

Removes an environment property from the environment of this context.

 

GENV

Syntax

LOGIN <user_name> [password]

Description

Prints the environment.

 

PRINT

Syntax

PRINT (Location, [Full Names], [Show Attributes])

 

Argument

Description

location

The context location.

[Full Names]

Prints the context contents with their full names.

[Show Attributes]

Prints the attributes.

Description

Prints the naming. If no location is specified, prints the root directory.

 

SATTR

Syntax

SATTR (attribute, string)

 

Argument

Description

attribute

The name of the attribute.

string

The value of the attribute.

Description

Sets a fake attribute.

 

 

RATTR

Syntax

RATTR (attribute)

 

Argument

Description

attribute

The name of the attribute.

Description

Removes a fake attribute.

 

GATTR

Syntax

GATTR (attribute)

 

Argument

Description

attribute

The name of the attribute.

Description

Prints a fake attribute.

 

CATTR

Syntax

CATTR

Description

Clears the fake attributes.

 

AATTR

Syntax

AATTR (attribute, string)

 

Argument

Description

attribute

The name of the attribute.

string

The value of the attribute.

Description

Adds to a fake attribute.

 

 

PATTR

Syntax

PATTR

Description

Prints all fake attributes.

 

GATR

Syntax

GATR (location)

 

Argument

Description

location

The name of the object from which to retrieve attributes.

Description

Prints a fake attribute.

 

AATR

Syntax

AATR (location, attribute)

 

Argument

Description

location

The name of the object whose attributes are to be updated.

attribute

The attributes to be used for the modification. These attributes cannot be null.

Description

Adds an attribute with the specified values.

 

 

RPATR

Syntax

RPATR (location, attribute)

 

Argument

Description

location

The name of the object whose attributes are to be updated.

attribute

The attributes to be used for the modification. These attributes cannot be null.

Description

Replace an attribute with specified values.

 

 

RMATR

Syntax

RMATR (location, attribute)

 

Argument

Description

location

The name of the object whose attributes are to beupdated.

attribute

The attributes to be used for the modification. These attributes cannot be null.

Description

Deletes the specified attribute values from the attribute.

 

 

SEARCH

Syntax

SEARCH (location)

 

Argument

Description

location

The location to search.

Description

Searches in a single context for objects that contain a specified set of attributes.

 

FIND

Syntax

FIND (location, filters)

 

Argument

Description

location

The location to search.

filters

The format and interpretation of filter follows RFC 2254 specification.

Description

Searches in the named context or object for entries that satisfy the given search filter. Performs the search as specified by the search controls.

 

 

STIME

Syntax

STIME ([time])

 

Argument

Description

[time]

The time in milliseconds.

Description

Sets the time limit to perform search.

 

SCOUNT

Syntax

SCOUNT ([count])

 

Argument

Description

[count]

The number of entries that to be returned.

Description

Sets the maximum number of entries to be returned because of the search.

 

SSCOPE

Syntax

SSCOPE ([scope])

 

Argument

Description

[scope]

The search scope of this SearchControls.

Description

Sets the search scope to one of: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE.

   OBJECT_SCOPE – searches the named object.
   ONELEVEL_SCOPE – searches one level of the named context.
   SUBTREE_SCOPE – searches the entire subtree rooted at the named object.

 

BYE

Syntax

BYE

Description

Exits the JNDISHELL.

 

POLICY

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

The Login, Resource and Users groups provide additional commands to administer the Security Service.

DENY

Syntax

DENY [<domain_name> <permission>]

 

Argument

Description

<domain_name>

The domain name.

<permission>

Possible values are: all, property name action, runtime action, awt name, net action, reflect name, serializable name, files path_fo_file action, socket host action, resource.

Description

Removes a permission from the ProtectionDomain PremissionCollection.

 

Example

DENY domain_name all
DENY domain_name property name action
DENY domain_name runtime action
DENY domain_name awt name
DENY domain_name net action
DENY domain_name reflect name
DENY domain_name serializable name
DENY domain_name files path_fo_file action
DENY domain_name socket host action
DENY domain_name resource

 

DOMAINS

Syntax

DOMAINS

Description

Displays a list of ProtectionDomains stored in the Protection Manager.

 

GRANT

Syntax

GRANT [<domain_name> <permission>], while <permission> := <permissionName> <  > [<action>]

 

Argument

Description

<domain_name>

The domain name.

<permission>

Possible values are: all, property name action, runtime action, awt name, net action, reflect name, serializable name, files path_fo_file action, socket host action, resource.

Description

Adds a new permission to the ProtectionDomain PremissionCollection.

 

Example

GRANT domain_name all
GRANT domain_name property name action
GRANT domain_name runtime action
GRANT domain_name awt name
GRANT domain_name net action
GRANT domain_name reflect name
GRANT domain_name serializable name
GRANT domain_name files path_fo_file action
GRANT domain_name socket host action
GRANT domain_name resource

 

PERMISSION

Syntax

PERMISSION [<type permission>]

Description

This command lists all available types of permissions and their aliases. If <type permission> parameter is specified, the command displays a list of actions that are mapped to the specified permission.

 

POLICY

Syntax

POLICY <domain_name> [permission_name]

 

Argument

Description

<domain_name>

Shows the permissions for the specified domain.

[permission_name]

Displays a list of actions mapped to the specified permission for the given service.

Description

Provides a list of permissions for the specified service.

 

 

RESOURCE

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

The Login, Policy and Users groups provide additional commands to administer the Security Service.

 

CHECK

Syntax

CHECK <resourceAlias> <userName> <password> <actionId> <instanceId>

 

Argument

Description

<resourceAlias>

The alias of the resource as registered with the resource context.

<userName>

The name of the user to login.

<password>

The password of the user to login.

<actionId>

The identifier of the action as registered with the resource context, where <actionId> is an integer.

<instanceId>

The identifier of the instance as registered with the resource context, where <instanceId> is an integer.

Description

Checks if the user has permissions to use the specified resource.

 

CREATERESOURCE

Syntax

CREATERESOURCE -r <resourceAlias>

CREATERESOURCE -a <resourceAlias> <actionAlias>

CREATERESOURCE –i <resourceAlias> <instanceAlias>

 

Parameter

Description

<resourceAlias>

The alias of the resource.

<actionAlias>

The name of the action.

<instanceAlias>

The name of the instance.

Description

Creates resource, instance or name with the specified alias.

 

DESTROY

Syntax

DESTROY -r <resourceAlias>

DESTROY -a <resourceAlias> <actionId>

DESTROY -i <resourceAlias> <instanceId>

 

Parameter

Description

<resourceAlias>

The alias of the resource.

<actionId>

The identifier of the action, where <actionId> is an integer.

<instanceId>

The identifier of the instance, where <instanceId> is an integer.

Description

Destroys the resource, action or instance with the specified alias.

 

GRANTRESOURCE

Syntax

GRANTRESOURCE <grant|deny> <userId> <actionId> <resourceId> <instanceId>

 

Argument

Description

<grant|deny>

Grants or denies access to the specified resource.

<userId>

The identifier of the user, where <userId> is an integer.

<actionId>

The identifier of the action, where <actionId> is an integer.

<resourceId>

The identifier of the resource, where <resourceId> is an integer.

<instanceId>

The identifier of the instance, where <instanceId> is an integer.

Description

Associates or denies the user specified by <userId> to an action, resource, or instance.

 

GROUPRESOURCE

Syntax

GROUPRESOURCE <true|false> <resourceAlias> <instanceId><parentId>

 

Argument

Description

<true|false>

Choose “true” to group, or “false” to ungroup specified resources.

<resourceAlias>

Specifies alias of the resource to be grouped or ungrouped.

<instanceId>

Specifies ID of the resource that to be grouped or ungrouped.

<parented>

This argument is specified if resources are grouped. It provides the ID of the parent resource.

Description

This command is used to group or ungroup the resources specified by ID and alias.

 

RENAME

Syntax

RENAME <alias> <newAlias>

 

Argument

Description

<alias>

The resource name as registered with the resource context.

<newAlias>

The new resource alias.

Description

Renames the specified resource, instance or action.

 

RESID

Syntax

RESID -u <userName> <user>

 

Argument

Description

<userName>

The name of the user.

<user>

Possible values: “true” for users and “false” for groups.

Description

Returns the identifier of the specified user or group.

 

SERVLET_JSP

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

 

HTTPSESSIONS

Syntax

HTTPSESSIONS [full]

 

Argument

Description

[full]

If parameter [full] is supplied, the command provides the following details: userName, HttpSessionId, creation date, expiration date, and date of last access to it. Otherwise, only userName and expiration date are displayed.

Description

Prints a list of HTTP sessions for users that are logged on to SAP J2EE Engine 6.20. Displays the sessions in all started applications in the Web container.

 

SYSTEM

This group of commands concerns SAP J2EE Engine 6.20 general administration. You do not have to add these commands, as 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 (EOF or CTRL-K are used for the end of the input stream 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 on 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, 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 print 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, this command displays all activated and deactivated groups of commands. If [groupName] is specified, 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.

 

MORE

Syntax

<command> <parameters>: MORE

 

Argument

Description

<parameters>

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

 

PS

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

[parameters]

      -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]

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 file <fileName>.

 

SET

Syntax

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

 

Arguments on the right side of the equation

Description

variable

Sets the value of this variable to be the value of the variable on the right-hand 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.

 

USERS

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

The Policy, Resource and Login groups provide additional commands to administer the Security Service.

CREATEUSER

Syntax

CREATEUSER -u <name> – creates a user with an empty password.

CREATEUSER -u <name> <password> [parent] – creates a user with the specified password and with parent if given.

CREATEUSER -g <name> [parent] – creates a group with parent if given.

Description

Creates a new server user or group with the specified characteristics.

 

DISABLE

Syntax

DISABLE <user-name> – disables the user with the specified name.

Description

Denies login permission to user named <user-name>.

 

ENABLE

Syntax

ENABLE <user-name> – enables the user with the specified name.

Description

Gives login permission to user named <user-name>.

 

GROUP

Syntax

GROUP <user-name> <group-name>

Description

Adds a user or a group named <user-name> to a group named <group-name>.

 

PARENTS

Syntax

PARENTS <user-name>

Description

Shows in which groups a user or a group named <user_name> is located.

 

PASSWORD

Syntax

PASSWORD [<user-name>] <password> – changes the user password.

Description

Changes the password of a specified user.

 

REMOVEUSER

Syntax

REMOVE -user <name> – removes the user with the specified name.

REMOVE -group <name> – removes the group with the specified name.

Description

Removes the specified user or group.

 

UNGROUP

Syntax

UNGROUP <user-name> <group-name>

Description

Removes a user or group named <user-name> from a group named <group-name>.

 

USERS

Syntax

USERS [<group_name>]

Description

Lists all users in the specified group. If <group_name> is not specified, lists all current users. When <group_name> is specified, lists only the users that belong to this group.

 

Previous  Next