1. jeusadmin
This section describes the jeusadmin and its usage.
jeusadmin is a console tool used to directly manage JEUS. This tool can be used to perform basic management of JEUS servers like startup, termination, and application management including deployment/undeployment, changing logger levels, and checking the JMX Mbean list.
The following is the basic syntax of the commands used in jeusadmin.
COMMAND [COMMAND_OPTIONS]
[GLOBAL_OPTIONS]
(>|>>) FILENAME
-
COMMAND
Command name or alias.
-
COMMAND_OPTIONS
Command options.
If a command option includes another command or a blank space, enclose the option by using double quotation marks (" ").
If the double quotation marks must be used two or more times, use escape characters depending on your OS.
OS Escape Character Linux
Backslash (\)
The following is an example.
[ Linux OS ] jeusadmin -u jeus -p 11111111 -host localhost:9116 "help -g \"Data Source and Connection Pool\""
-
GLOBAL_OPTIONS
Common options that apply to all commands.
Option Description -verbose
Outputs the stack trace if an error occurs.
-repeat <count>
Number of times to execute the command.
-interval <seconds>
Interval for commands to repeat (Unit: sec).
If this option is used without setting the -repeat option, an error is thrown.
-
(>|>>) FILENAME
Name of the file in which command execution results are saved.
Usage:
offline>help > result.txt or offline>help >> result.txt
1.1. Commands for Starting and Ending jeusadmin
The following describes the commands that start and end jeusadmin.
| Command | Description |
|---|---|
Starts jeusadmin. |
|
Ends jeusadmin. |
1.1.1. jeusadmin
Executes jeusadmin. The file is in the 'JEUS_HOME/bin' directory.
-
Usage
jeusadmin [-u,--username <user-name>] [-p,--password <password>] [-f <file-name>] [-cachelogin] [-d,--domain <domain-name>] [-host <server-address>] [-port <server-port>] [-verbose] [-help] [<target-command>] [-version] [-fullversion] [-buildversion] [-licensedue] [-licenseinfo] [-debug] [-script (<script-file>|"<script-file> <args> ...")] [-i,--ignore] -
Parameters
Parameter Description [-u, --username <user-name>]
User name.
If set, jeusadmin tries to access the server when it starts.
[-p, ---password <password>]
Password.
If set, jeusadmin tries to access the server when it starts.
[-f <file-name>]
File that contains the user name and password required to access the server.
[-cachelogin]
Option to cache the user name and password used to access a specific domain or the default domain.
[-d, --domain <domain-name>]
Name of the domain to connect.
[-host <server-address>
Server address to connect to.
If the [-u] and [-p] options are set without the host option, jeusadmin tries to connect to the localhost.
[-port <server-port>]
Port number to connect to.
If the [-u] and [-p] options are set without the port option, jeusadmin tries to connect through port 9736.
[-verbose]
Option to display details when an error occurs.
[-help]
Option to display help for jeusadmin.
[<target-command>]
Option to re-execute the <target-command>. This is useful when using a script.
If the command requires a connection to the server, required options, such as [-u], [-p], [-host], and [-port], must be provided.
[-version]
Option to display the major version of JEUS.
[-fullversion]
Option to display major and minor versions of JEUS.
[-buildversion]
Option to display major and build versions of JEUS.
[-licensedue]
Option to display the number of days the license is valid. If the number is 0, JEUS can no longer run, and a new license must be issued by TmaxSoft.
[-licenseinfo]
Option to display the current license information.
[-debug]
Option to display the log messages in jeusadmin through Jeus Logger.
[-script (<script-file>|"<script-file> <args> …")]
Executes jeusadmin in script mode. File extenders must be .py (Python), or .rb (Ruby).
[-i,--ignore]
Option to continuolsy execute the script even if an when running JEUS command exception occurs in script mode. Only available in the script mode.
-
Example
The following example assumes that the user name is 'administrator' and password is 'jeus'.
-
Executing jeusadmin
The following is an example of executing jeusadmin.
JEUS_HOME/bin$jeusadmin JEUS 9 Administration Tool To view help, use the 'help' command. offline>
-
Connecting to the server at startup (1st method)
The following is an example of connecting to the server at localhost:9736.
JEUS_HOME/bin$jeusadmin -u administrator -p jeus Attempting to connect to 127.0.0.1:9736. The connection has been established to JEUS Master Server [adminServer] in the domain [domain1]. JEUS 9 Administration Tool To view help, use the 'help' command. [MASTER]domain1.adminServer>
-
Connecting to a server when starting up (2nd method)
The following is an example of connecting to the server by specifying the IP address and port number.
JEUS_HOME/bin$jeusadmin -u administrator -p jeus -host 192.168.0.1 -port 9746 Attempting to connect to 192.168.0.1:9746. The connection has been established to JEUS Master Server [adminServer] in the domain [domain1]. JEUS 9 Administration Tool To view help, use the 'help' command. [MASTER]domain1.adminServer>
-
Checking the license information
The following is an example of checking for the JEUS license.
JEUS_HOME/bin$jeusadmin -licensedue Unlimited JEUS_HOME/bin$jeusadmin -licenseinfo ==================== LICENSE INFORMATION ===================== == EDITION : Enterprise (Trial License) == ISSUE-DAY : 2016/1/16 == LICENSE SEQNO : xxx-xxxx-xxx-xxxx ================================================================
-
-
Connecting to jeusadmin using SSL
In order to connect to jeusadmin using SSL, configure the following system properties in the jeusadmin execution script file. The values of system properties depend on the SSL configuration of the server.
. . . # execute jeusadmin "${JAVA_HOME}/bin/java" -Xmx128m -classpath "${BOOTSTRAP_CLASSPATH}" ${TOOL_OPTION} -Djmx.remote.x.request.timeout=600000 -Djeus.home="${JEUS_HOME}" -Djeus.tool.console.useJLine="false" -Djava.naming.factory.initial=jeus.jndi.JEUSContextFactory -Djava.naming.factory.url.pkgs=jeus.jndi.jns.url -Djava.util.logging.config.file="${JEUS_HOME}/bin/logging.properties" -Djeus.net.client.use-ssl=true -Djavax.net.ssl.trustStore=${JEUS_HOME}/domains/domain1/config/truststore -Djavax.net.ssl.trustStorePassword=changeit -Djavax.net.ssl.trustStoreType=JKS -Dssl.TrustManagerFactory.algorithm=SunX509 ${JAVA_ARGS} jeus.tool.console.ConsoleBootstrapper ${BOOT_PARAMETER}
1.2. Local Commands
The following is a list of common commands used in jeusadmin.
| Command | Description |
|---|---|
Tries to access JEUS Master Server or Managed Server. |
|
Disconnects and returns to an offline state. |
|
Displays command help information. |
|
Displays the history of entered commands. |
|
Executes a previously entered command. If no option is specified, the previous command is executed. |
|
Removes specified user login information from the cache file stored via the cachelogin function. |
|
Specifies the default value for the server option. |
|
Specifies the default value for the servers option. |
|
Starts the recording function that stores entered commands in script format. |
|
Stops the recording function. |
|
Deletes the default values specified by set-server-option. |
|
Deletes the default values specified by set-servers-option. |
|
Displays details when executing a command. |
1.2.1. connect
Connects to a server. The user name and password must be specified.
-
Alias
login
-
Usage
connect [-u,--username <user-name>] [-p,--password <password>] [-f <file-name>] [-cachelogin] [-h,--host <server-address>] [-port <server port>] [-d,--domain <domain name>] -
Parameters
Parameter Description [-u, --username <user-name>]
User name.
[-p, --password <password>]
Password.
[-f <file-name>]
Name of the password file that contains the user name and password.
[-cachelogin]
Records the user name and password in a file.
[-h, --host <server-address>]
Server address to connect to. If not specified, jeusadmin tries to connect to the localhost.
[-port <server-port>
Server port to connect to. If not specified, the default value is used. (Default: 9736)
[-d,--domain <domain name>]
Domain name, which is used to search for the security.key file.
-
Example
-
The following connects to a host specified with [-h] by using the user name specified with [-u] and the password specified with [-p].
offline>connect -u administrator -p jeus -h 127.0.0.1 Attempting to connect to 127.0.0.1:9736. The connection has been established to JEUS Master Server [adminServer] in the domain [domain1]. [MASTER]domain1.adminServer>
-
The following connects to the localhost because [-h] is not used.
offline>connect -u administrator -p jeus Attempting to connect to 127.0.0.1:9736. The connection has been established to JEUS Master Server [adminServer] in the domain [domain1]. [MASTER]domain1.adminServer>
-
-
Note
This command can be used without being connected to the server.
1.2.2. disconnect
Closes the connection and returns to an offline state.
-
Alias
logout
-
Usage
disconnect
-
Example
offline>connect Enter the server address: User name: administrator Password: Attempting to connect to 127.0.0.1:9736. The connection has been established to JEUS Master Server [adminServer] in the domain [domain1]. [MASTER]domain1.adminServer>disconnect The connection has been closed. offline>
-
Note
This command can be used without being connected to the server.
1.2.3. help
Displays command help information. If the command is executed without any other options, a list of commands and an explanation of the basic syntax of the commands are displayed.
-
Usage
help [-g,--group <group-name> | <command-name> | -l,--list]
-
Parameters
Parameter Description [-g,--group <group-name>]
Displays a list of commands and simple descriptions that belong to the given group name.
[<command-name>]
Displays help information of the specified command (command name).
Displays information about the command such as command name, alias, usage, and options.
Options can be omitted.
[-l,--list]
Displays a simple description of all commands.
-
Example
-
When only the help command is used
offline>help LIST OF AVAILABLE COMMANDS [Local]____________________________________________________________________ connect disconnect exit help history p remove-login-cache set-server-option set-servers-option start-record stop-record unset-server-option unset-servers-option verbose [Server Management]________________________________________________________ local-shutdown [Domain Configuration]_____________________________________________________ apply-configuration-plan create-domain delete-domain list-domains pack-domain unpack-domain [Application]______________________________________________________________ install-application install-deployment-plan redeploy-application [Library]__________________________________________________________________ install-library [Web]______________________________________________________________________ precompile-jsp COMMAND GRAMMAR Command Usage COMMAND [COMMAND_OPTIONS] [GLOBAL_OPTIONS] [(>|>>) FILENAME] Details COMMAND: target command to execute. [COMMAND_OPTIONS]: Options for target command. [GLOBAL_OPTIONS]: Common options for all commands. -verbose Prints the stack trace for errors. -repeat <count> Repeats the target command X times. -interval <seconds> Specifies the interval at which to repeat execution, in seconds. [(>|>>) FILENAME] Prints the result of the target command to the specified file. Examples help -l -repeat 3 -interval 10 > result.txt To show detailed information for a command, use 'help [COMMAND_NAME]'. ex) help connect offline> -
When the help command is used with the [-l] option
offline>help -l [Local]____________________________________________________________________ connect Attempting to authenticate with the target server. disconnect Disconnects from the currently connected server. ...... [Server Management]________________________________________________________ local-shutdown Shuts down the currently connected server. ...... To show detailed information for a command, use 'help [COMMAND_NAME]'. ex) help connect offline> -
When the help command is used with the [-g] option
The following is an example of displaying a list of the 'Server Management' group commands.
offline>help -g "Server Management" [Server Management]________________________________________________________ local-shutdown Shuts down the currently connected server. To show detailed information for a command, use 'help [COMMAND_NAME]'. ex) help connect offline>
-
When the help command is used with the [<command name>] option, help information for the specified command is displayed.
The following is an example of displaying the help information of the add-server command.
[MASTER]domain1.adminServer>help add-server NAMES add-server Adds a new server to the domain configuration. If a server name is not provided, the current server list in this domain will be shown. Alias addserver USAGE add-server <server-name> [-target,--duptargetserver <target-server>] [-port,--baseport <base-port>] [-addr,--baseaddr <base-addr>] [-http,--httpport <http-port>] [-node,--nodeName <node-name>] [-jvm,--jvmOptions <jvm-options>] [-logdir,--logHomeDirectory <server-log-home-directory>] [-a,--actionOnResourceLeak <action-on-resource-leak>] [-l,--logStdoutToRawFormat <print-stdout-to-raw-format>] [-m,--mejb <enable-MEJB>] [-c,--classFtp <enable-class-ftp-service>] [-f,--forceLock] [-detail] OPTIONS <server-name> the name of server you want to modify configuration of [-target,--duptargetserver <target-server>] duplicate the configuration of the target server [-port,--baseport <base-port>] base service listen port of the server [-addr,--baseaddr <base-addr>] base service listen address of the server [-http,--httpport <http-port>] http listen port of the server [-node,--nodeName <node-name>] name of the node this server is located [-jvm,--jvmOptions <jvm-options>] jvm configurations applied to this server jvm [-logdir,--logHomeDirectory <server-log-home-directory>] the log directory which has all the log files created by this server [-a,--actionOnResourceLeak <action-on-resource-leak>] strategy when resource leak is detected. it must be one of AutoClose, NoAction, Warning [-l,--logStdoutToRawFormat <print-stdout-to-raw-format>] [Dynamic] whether stdout is printed in row format or in JEUS Logger format. [-m,--mejb <enable-MEJB>] [Dynamic] whether using MEJB or not .true, false [-c,--classFtp <enable-class-ftp-service>] [Dynamic] whether using class ftp service or not .true, false [-f,--forceLock] Acquires the configuration lock forcibly. [-detail] Show detail results
-
-
Note
This command can be used without being connected to the server.
1.2.4. history
Displays a list of previously executed commands.
The list of commands is stored in ${user.home}/.jeusadmin/commandHistory. Use the p command to re-execute a command. The maximum number of commands in the list is 100.
-
Usage
history [-clear | <size>]
-
Parameters
Parameter Description [-clear]
Resets the list of commands.
[<size>]
Number of commands to display. Displays as many commands as size, in chronological order.
-
Example
offline>history 1 : help history 2 : connect -u administrator -p jeus 3 : disconnect To execute a command in the history, please use '!' command (e.g. ! 7) offline>history 3 3 : disconnect To execute a command in the history, please use '!' command (e.g. ! 7) offline>history -clear The command history has been cleared. offline>
-
Note
This command can be used without being connected to the server.
1.2.5. p
Re-executes a previous command. Use the history command to view the list of previously executed commands.
-
Alias
!
-
Usage
p [<history-number>]
-
Parameters
Parameter Description [<history-number>]
History number of the command to be re-executed.
-
Example
offline>history 1 : connect -u jeus -p jeus 2 : disconnect To execute a command in the history, please use '!' command (e.g. ! 7) offline>p 1 connect -u jeus -p jeus Attempting to connect to 127.0.0.1:9736. The connection has been established to JEUS Master Server [adminServer] in the domain [domain1]. [MASTER]domain1.adminServer>! 2 disconnect The connection has been closed. offline>
-
Note
This command can be used without being connected to the server.
1.2.6. remove-login-cache
Deletes the specified user login information from the cache file stored by the cachelogin function.
The information stored by cachelogin is distinguished by <domain-name> and <user-name>.
-
Usage
remove-login-cache [-domain <domain-name>] [-u <user-name>] [-f <file-name>] -
Parameters
Parameter Description [-domain <domain-name>]
Domain name used to store the login information.
[-u <user-name>]
User name used to store the login information.
[-f <file-name>]
Name of the password file that contains the user name and password.
-
Example
offline>remove-login-cache -domain domain1 -u user1 The cached login information [domain1:user1] has been successfully removed from /home/OSUser/.jeusadmin/.jeuspasswd.
-
Note
This command can be used without being connected to the server.
1.2.7. set-server-option
Sets the default value for the -server option. If no option is specified, the current default value is displayed.
-
Alias
setserver
-
Usage
set-server-option <server-name>
-
Parameters
Parameter Description <server-name>
Sets the server name as the default server option value.
-
Example
Set "adminServer" as the default value and execute the jndi-info command. Before a value is set, an error occurs when executing the jndi-info command because the server option is missing. After the value is set, the jndi-info command executes on adminServer without the server option.
[MASTER]domain1.adminServer>jndi-info The following options are missing: server [MASTER]domain1.adminServer>set-server-option The default server name is not set. [MASTER]domain1.adminServer>set-server-option adminServer The default server name has been set: adminServer. [MASTER]domain1.adminServer>set-server-option The current default server name: adminServer. [MASTER]domain1.adminServer>jndi-info The JNDI list on the adminServer List of the context / ================================================================================ +---------------------+----------------------------------------+---------------+ | Name | Value | Local Binding | +---------------------+----------------------------------------+---------------+ | ConnectionFactory | jeus.jms.client.facility.factory.JeusC | false | | |onnectionFactory | | ...... [MASTER]domain1.adminServer> -
Note
This command can be used without being connected to the server.
1.2.8. set-servers-option
Sets the default value for the -servers option. If no option is specified, the current default value is displayed.
-
Alias
setservers
-
Usage
set-servers-option [<server-list>]
-
Parameters
Parameter Description [<server-list>]
Specifies the server names to be used as default values for the servers option. Each server name is separated by a comma.
-
Example
The following is an example of using the set-servers-option command to specify the deploy targets (servers), and then using the deploy command to deploy applications to the specified targets (servers).
[MASTER]domain1.adminServer>set-servers-option The default server list is not set. [MASTER]domain1.adminServer>set-servers-option adminServer,server1 The default server list has been set: adminServer,server1. [MASTER]domain1.adminServer>set-servers-option The current default server list: adminServer,server1. [MASTER]domain1.adminServer>deploy sample deploy the application for the application [sample] succeeded. [MASTER]domain1.adminServer>appinfo Application information for the domain [domain1]. ================================================================================ +----------+-----------+---------+-------------+----------+--------------------+ | Applicati|Application| State | Target | Target | Application Path | | on ID | Type | | Servers | Clusters | | +----------+-----------+---------+-------------+----------+--------------------+ | sample | WAR | RUNNING | server1,admi| | ${INSTALL_HOME}/sam| | | | |nServer | |ple/sample.war | +----------+-----------+---------+-------------+----------+--------------------+ ================================================================================ -
Note
This command can be used without being connected to the server.
1.2.9. start-record
Starts the recording function that records entered commands in a script file.
Commands are stored according to the extensions of the specified recording files by using the following script. Once recording starts, "-Rec*" is added to the prompt.
-
Alias
startrecord
-
Usage
start-record [<recfile>]
-
Parameters
Parameter Description [<recfile>]
Specifies the file that will record commands. This is stored as a script file, so only the currently supported script’s extensions, ".py" and ".rb" can be used.
-
Example
-
Store commands in record_script_[timestamp].py when executing without specifying an option.
offline>start-record Starting recording to file : record_script_20150101123456.py offline-Rec*>
-
Store commands in the applicable file when [<recfile>] is specified.
offline>start-record record.py Starting recording to file : record.py offline-Rec*>
-
-
Note
This command can be used without being connected to the server.
1.2.10. stop-record
Stops the recording function.
-
Alias
stoprecord
-
Usage
stop-record
-
Example
offline-Rec*>stop-record Stopping recording to file : recrod.py offline>
-
Note
This command can be used without being connected to the server.
1.2.11. unset-server-option
Deletes the default value set by the set-server-option command.
-
Alias
unset-server-option
-
Usage
unset-server-option
-
Example
Reset the default value set by the set-server-option command. If the jndi-info command is executed after resetting the default value, an error occurs that states the server option is missing.
[MASTER]domain1.adminServer>set-server-option The current default server name: adminServer. [MASTER]domain1.adminServer>unset-server-option The default server name has been unset. [MASTER]domain1.adminServer>set-server-option The default server name is not set. [MASTER]domain1.adminServer>jndi-info The following options are missing: server
-
Note
This command can be used without being connected to the server.
1.2.12. unset-servers-option
Deletes the default value set by the set-servers-option command.
-
Alias
unsetservers
-
Usage
unset-servers-option
-
Example
[MASTER]domain1.adminServer>set-servers-option The current default server list: adminServer,server1. [MASTER]domain1.adminServer>unset-servers-option The default server list has been unset. [MASTER]domain1.adminServer>set-servers-option The default server list is not set. [MASTER]domain1.adminServer>
-
Note
This command can be used without being connected to the server.
1.2.13. verbose
Displays the details of the command process. If no option is specified, the system displays the current setting for this property. If this setting is activated and an error occurs while processing the command, a stack trace is displayed.
-
Usage
verbose [-off | -on]
-
Parameters
Parameter Description [-on]
Activates the command.
[-off]
Deactivates the command.
-
Example
-
To check if the command was activated
offline>verbose Verbose output disabled. offline>
-
Execution example
offline>verbose Verbose output disabled. offline>help notexistcommand Command notexistcommand not found offline>verbose -on Verbose output is enabled. offline>help notexistcommand Command notexistcommand not found jeus.tool.console.executor.CommandException: Command notexistcommand not found ...... offline>verbose -off Verbose output disabled. offline>help notexistcommand Command notexistcommand not found offline>
-
-
Note
This command can be used without being connected to the server.
1.3. Server Management Commands
The following is a list of server management commands.
| Command | Description |
|---|---|
Dynamically registers a custom resource to servers. |
|
Dynamically registers data sources to a server. |
|
Dynamically registers an external resource to servers. |
|
Adds an invocation to a lifecyle invocation. |
|
Adds a library reference to a lifecyle invocation. |
|
Adds JVM to a server. |
|
Adds a lifecycle invocation to a server or cluster. |
|
Adds a listener to a server. |
|
Dynamically adds a handler to a server logger. |
|
Dynamically adds a logger to a server. |
|
Sets SSL for a listener. |
|
Sets the initialization point of the internal engines (Servlet, EJB, and JMS) of the servers to when the application was deployed. |
|
Selectively disables the use of the internal engines (Servlet, EJB, and JMS) of a server. |
|
Outputs the thread dump(s) of a server or servers that belongs to a cluster. |
|
Sets the initialization point of the internal engines (Servlet, EJB, and JMS) of the servers to when the server boots. |
|
Selectively enables the use of the internal engines (Servlet, EJB, and JMS) of a server. |
|
Displays a list of binding names of objects bound to the JNDI context of a server. |
|
Displays the information of a lifecycle invocation. |
|
Displays the JVM configuration of a server. |
|
Displays lifecycle invocations of a server or cluster. |
|
Displays the information of the handlers registered to a server logger. |
|
Displays the information of the loggers registered to a server. |
|
Displays the configuration of listeners of a server. |
|
Terminates the currently connected server. |
|
Checks for a logger registered to a specific server and the levels of the handlers registered to the logger. |
|
Displays a list of Mbeans registered to a server. |
|
Displays the memory information of a specific server or a server that belongs to a specific cluster. |
|
Changes an invocation of a specific lifecycle invocation. |
|
Changes a library reference of a specify lifecycle invocation. |
|
Changes JVM configuration of a specific server. |
|
Changes a lifecycle invocation of a specific server or cluster. |
|
Changes a listener configuration of a server. |
|
Changes a handler registered to a server logger. |
|
Dynamically changes a logger registered to a server. |
|
Dynamically deletes a custom resource registered to servers. |
|
Dynamically deletes a data sources registered to a server. |
|
Dynamically deletes an external resource registered to servers. |
|
Deletes an invocation from a specific lifecycle invocation. |
|
Deletes a library reference from a spcific lifecycle invocation. |
|
Deletes the JVM configuration from a server. |
|
Deletes a lifecycle invocation from a server or cluster. |
|
Deletes a listener from a server. |
|
Dynamically deletes a hander registered to a server logger. |
|
Dynamically deletes a logger registered to a server. |
|
Dynamically deletes a replicate group specified in a server or server template. |
|
Resumes a temporarily suspended server. |
|
Executes full gc on a server or servers that belong to a cluster. |
|
Displays the current status of a server. |
|
Checks the logs of a server. |
|
Dynamically specifies a replicate group to a server or server template. |
|
Checks the replicate group of a server or server template. |
|
Monitors the current SCF view. |
|
Starts a managed server. |
|
Terminates managed servers that belong to a cluster. Even if the JEUS master server is included in the cluster, it is not terminated. Only available for the master server and managed server structure. |
|
Terminates Managed Servers that belong to the current domain. Only available for the master server and managed server structure. |
|
Terminates one or more managed servers. |
|
Temporarily suspends a running server. |
|
Displays the system information of a server. |
1.3.1. add-custom-resource-to-servers
Dynamically registers a custom resource to servers.
-
Alias
add-cr-to-servers
-
Usage
add-custom-resource-to-servers <export-name> -servers <server-list> [-f,--forceLock] [-detail] -
Parameters
Parameter Description <export-name>
JNDI bind name of the custom resource to be registered in the server.
-servers <server-list>
Server list in which the custom resource is registered.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>add-custom-resource-to-servers custom/dog -servers server1 Successfully performed the ADD operation for A custom resource. Check the results using "list-custom-resources"
1.3.2. add-data-sources-to-server
Dynamically registers data sources to a server.
-
Alias
adddstosvr
-
Usage
add-data-sources-to-server -server <server-name> [-ids <data-source-id-list> | -all] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -server <server-name>
Server name in which data sources are registered.
[-ids <data-source-id-list>]
List of data source IDs to add in the server.
To specify multiple IDs, separate each ID with a comma (,).
[-all]
Registers all data sources defined in the domain.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>add-data-sources-to-server -server server1 -all Successfully performed the ADD operation for data sources to the server [server1]. Check the results using "add-data-sources-to-server -server server1"
1.3.3. add-external-resource-to-servers
Dynamically registers an external resource to servers.
-
Alias
add-er-to-servers
-
Usage
add-external-resource-to-servers <export-name> -servers <server-list> [-f,--forceLock] [-detail] -
Parameters
Parameter Description <export-name>
External resource name to be registered in the server.
-servers <server-list>
Server list in which the external resource is registered.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>add-external-resource-to-servers test/ext -servers server1 Successfully performed the ADD operation for A external resource. Check the results using "list-external-resources"
1.3.4. add-invocation
Adds an invocation to a specific lifecycle invocation.
-
Alias
addinvo, addinvocation
-
Usage
add-invocation <method> -type <invocation-type> [-params <method-params>] [-args <invocation-argument>] -class <class> -s,--server <server> | -c,--cluster <cluster> [-f,--forceLock] [-detail] -
Parameters
Parameter Description <method>
Method name of the invocation to add.
-type <invocation-type>
Type of the invocation (time of calling the method).
Specify one of the follows.
-
BOOT
-
BEFORE_DEPLOY
-
AFTER_DEPLOY
-
READY
-
BEFORE_UNDEPLOY
-
AFTER_UNDEPLOY
For more information about the types, refer to the Invocation Type part of in Lifecycle Invocation Setting in JEUS Server Guide.
[-params <method-params>]
Changes the fully qualified class name of the method parameter. For multiple parameters, use spaces as delimiters.
(Example: -params java.lang.String boolean)
[-args <invocation-argument>]
Arguments used to call the method. For multiple arguments, use spaces as delimiters. If an argument includes a space, enclose it in quotation marks.
(Example: -args "tmaxsoft jeus" "hello world")
-class <class>
Class name of the lifecycle invocation to add.
-s,--server <server> | -c,--cluster <cluster>
Name of the server or cluster where the lifecycle invocation is located.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the configuration changes.
-
-
Example
[MASTER]domain1.adminServer>add-invocation methodName -type BOOT -class invo.invoTestClass -s server1 -params java.lang.String boolean -args "invocation test" true Successfully performed the ADD operation for Invocation [methodName](Invocation ID = 0), but all changes were non-dynamic. They will be applied after restarting. Check the results using "list-lifecycle-invocations or lifecycle-invocation-info".
1.3.5. add-invocation-library
Adds a library reference to a specific lifecycle invocation.
-
Alias
addinvolib, addinvocationlibrary
-
Usage
add-invocation-library <library> -specVer <version> [-specMatch <true | false>] -implVer <version> [-implMatch <true | false>] [-fail,--failOnError <true | false>] -class <class> -s,--server <server> | -c,--cluster <cluster> [-f,--forceLock] [-detail] -
Parameters
Parameter Description <library>
Name of the library to add.
-specVer <version>
Specification version of the libarary to add.
[-specMatch <true | false>]
Option to enforce matching the specification version. (Default value: false)
-implVer <version>
Implementation version of the library to add.
[-implMatch <true | false>]
Option to enforce matching the implementation version. (Default value: false)
[-fail,--failOnError <true | false>]
Option to fail the deployment if a shared library cannot be found. (Default value: false)
-class <class>
Class name of the lifecycle invocation to which a library reference is added.
-s,--server <server> | -c,--cluster <cluster>
Name of the server or cluster where the lifecycle invocation is located.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the configuration changes.
-
Example
[MASTER]domain1.adminServer>add-invocation-library libName -specVer 1 -implVer 1 -class invo.invoTestClass -s server1 Successfully performed the ADD operation for Invocation Library [libName], but all changes were non-dynamic. They will be applied after restarting. Check the results using "list-lifecycle-invocations or lifecycle-invocation-info".
1.3.6. add-jvm-option
Adds JVM to a server.
-
Alias
add-jvmopt, addjvmopt, add-jvm-config, add-jvmcfg, addjvmcfg
-
Usage
add-jvm-option -server <server-name> [-opt,--jvmOption <jvm-option>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -server <server-name>
Server name.
[-opt,--jvmOption <jvm-option>]
JVM configuration to be added.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the configuration changes.
-
Example
[MASTER]domain1.adminServer>add-jvm-option -server server1 -opt "-Xmx256m -XX:MaxPermSize=128m" Successfully performed the ADD operation for JVM configuration for the server (sever1)., but all changes were non-dynamic. They will be applied after restarting. Check the results using "list-jvm-options or add-jvm-option"
1.3.7. add-lifecycle-invocation
Adds a lifecycle invocation to a specific server or cluster.
-
Alias
addlifeinvo, addlifecycleinvocation
-
Usage
add-lifecycle-invocation <class> -s,--server <server> | -c,--cluster <cluster> [-m,--method <invocation-method>] [-type <invocation-type>] [-params <method-params>] [-args <invocation-argument>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description <class>
Class name of the lifecycle invocation to add.
-s,--server <server> | -c,--cluster <cluster>
Name of the server or cluster where a lifecycle invocation is to be added.
[-m,--method <invocation-method>]
[Invocation option] To add an invocation along with a lifecycle invocation, you need to specify the method name of the invocation. Additionally, when adding an invocation, you must specify the invocation type. Therefore, the [Invocation option] must also be specified using the -type parameter.
[-type <invocation-type>]
[Invocation option] Type of the invocation (time of calling the method). To add an invocation along with a lifecycle invocation, you must specify [Invocation option] using -m and --method parameters.
Specify one of the follows.
-
BOOT
-
BEFORE_DEPLOY
-
AFTER_DEPLOY
-
READY
-
BEFORE_UNDEPLOY
-
AFTER_UNDEPLOY
For more information about the types, see the Invocation Type part of in Lifecycle Invocation Setting in JEUS Server Guide.
[-params <method-params>]
[Invocation option] Fully qualified class name of the method parameter. For multiple parameters, use spaces as delimiters.
(Example: -params java.lang.String boolean)
[-args <invocation-argument>]
[Invocation option] Arguments used to call the method. For multiple arguments, use spaces as delimiters. If an argument includes a space, enclose it in quotation marks.
(Example: -args "tmaxsoft jeus" "hello world")
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the configuration changes.
-
-
Example
[MASTER]domain1.adminServer>add-lifecycle-invocation sampleClass1 -s server1 Successfully performed the ADD operation for Lifecycle Invocation Class [sampleClass1], but all changes were non-dynamic. They will be applied after restarting. Check the results using "list-lifecycle-invocations". [MASTER]domain1.adminServer>add-lifecycle-invocation sampleClass2 -s server1 -m methodName -type BOOT Successfully performed the ADD operation for Lifecycle Invocation Class [sampleClass2] and Invocation [methodName](Invocation ID = 0), but all changes were non-dynamic. They will be applied after restarting. Check the results using "list-lifecycle-invocations".
1.3.8. add-listener
Dynamically adds a listener to a server.
-
Alias
addlistener, createlistener
-
Usage
add-listener -server <server-name> -name <listener-name> [-addr <address>] -port <port> [-selectors <selectors>] [-dual] [-backlog <backlog>] [-timeout <read-timeout>] [-keepaliveTimeout <keepalive-timeout>] [-rt,--reservedthreads <reserved-threads>] [-f,--forceLock] -
Parameters
Parameter Description -server <server-name>
Server name.
-name <listener-name>
Listener name to be added.
[-addr <address>]
Address of the listener to be added.
-port <port>
Port number of the listener to be added. The value must be between 1 ~ 65535, and the port number cannot conflict with the port numbers of other listeners.
[-selectors <selectors>]
Number of selectors to use.
[-dual]
Uses separate selectors for reading and writing.
[-backlog <backlog>]
Backlog of the listener to be added.
[-timeout <read-timeout>]
[Dynamic] Read timeout for the listener to be added.
[-keepaliveTimeout <keepalive-timeout>]
Maximum time to wait before closing an unused socket.
[-rt,--reservedthreads <reserved-threads>]
Number of reserved threads used by the listener to be added.
[-f,--forceLock]
Forcibly obtains a lock for adding a listener.
-
Example
[MASTER]domain1.adminServer>add-listener -server server1 -name Test -port 10000 Executed Successfully Check the result using 'list-server-listeners -server server1 -name Test. [MASTER]domain1.adminServer>list-server-listeners -server server1 -name Test =============================================================== Test +---------------------------------------------------+---------+ | address | 0.0.0.0 | | port | 10000 | | selectors | 1 | | dual-selector | false | | backlog | 128 | | read-timeout | 30000 | | keepalive-timeout | not-set | | reserved-threads | 0 | +---------------------------------------------------+---------+ ===============================================================
1.3.9. add-log-handler
Dynamically adds a handler to a server logger.
-
Alias
addloghandler, add-handler, addhandler
-
Usage
add-log-handler -server <server-name> -logger <logger-name> [<handler-name>] [-level <handler-level>] [-filter <filter-class>] [-encoding <encoding>] [-filename <file-name>] [-enable <true | false>] [-count <rotation-count>] [-dir <rotation-dir>] [-buffer <buffer-size>] [-append <true | false>] [-hour <hour> | -day <day> | -size <size>] [-f,--forceLock] [-detail] [-permission <permission>] [-chown <chown>] -
Parameters
Parameter Description -server <server-name>
Server name.
-logger <logger-name>
Name of the logger that adds the handler.
[<handler-name>]
Handler name to be added.
[-level <handler-level>]
[Dynamic] Log level of the handler (Default value: FINEST)
[-filter <filter-class>]
Class name of the filter for log messages.
[-encoding <encoding>]
Encoding value for log messages.
[-filename <file-name>]
File name where logs are recorded.
(Default value: loggerName.log. JeusServer.log for the JEUS logger)
[-enable <true | false>]
Option to enable file rotation (Default value: true).
[-count <rotation-count>]
Maximum number of log files for backup.
[-dir <rotation-dir>]
Path to the directory that stores backup log files.
[-buffer <buffer-size>]
Size of the buffer used to record log messages to a file.
[-append <true | false>]
Option to append logs to the previous file if the server reboots.
(true | false, default value: true)
[-hour <hour>]
Writes a new log file every specified number of hours.
[-day <day>]
Writes a new log file every specified number of days.
[-size <size>]
Creates a new log file of the specified size.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
[-permission <permission>]
Permission used to set a log file. (Example: rwxrwxrwx)
[-chown <chown>]
Owner used to set a log file. The owner and group are separated by comma(,). (Example: owner-id,group-id)
-
Example
[MASTER]domain1.adminServer>add-log-handler -server server1 -logger jeus.jndi fileHandler -day 10 Successfully performed the ADD operation for The handler for the logger(jeus.jndi) on the server(server1)., but all changes were non-dynamic. They will be applied after restarting. Check the results using "list-log-handlers or add-log-handler"
1.3.10. add-logger
Dynamically adds a logger to a server.
-
Alias
addlogger
-
Usage
add-logger -server <server-name> [<logger-name>] [-level <log-level>] [-useParentHandlers <true | false>] [-filter <filter-class>] [-formatter <formatter-class>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -server <server-name>
Server name.
[<logger-name>]
Name of the logger to be added in the server.
[-level <log-level>]
[Dynamic] Log level of the logger.
[-useParentHandlers <true | false>]
[Dynamic] Option to use the parent logger handler. (true | false)
[-filter <filter-class>]
Class name of the filter for log messages.
[-formatter <formatter-class>]
Class name of the formatter to be applied to the logger.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>add-logger -server server1 jeus.security -level FINE Successfully performed the ADD operation for The logger for the server(server1). , but all changes were non-dynamic. They will be applied after restsarting. Check the results using "list-loggers or add-logger"
1.3.11. config-listener-ssl
Sets SSL for a listener.
-
Alias
configssl
-
Usage
config-listener-ssl -server <server-name> -name <listener-name> -set | -del | -show [-need | -want | -noauth,--unnecessary] [-p,--protocol <protocol>] [-cs,--cipherSuite <cipher-suites>] [-ks,--keystore <keystore-file>] [-kp,--keystorePass <keystore-pass>] [-kkp,--keystoreKeypass <keystore-keypass>] [-kt,--keystoreType <keystore-type>] [-kma,--keyManagementAlgorithm <key-management-algorithm>] [-alias,--keyAlias <key-alias>] [-ts,--truststore <truststore-file>] [-tp,--truststorePass <truststore-pass>] [-tt,--truststoreType <truststore-type>] [-tma,--trustManagementAlgorithm <trust-management-algorithm>] [-crl <crl-file>] [-f,--forceLock] -
Parameters
Parameter Description -server <server-name>
Server name.
-name <listener-name>
Listener name.
-set | -del | -show
Option to set, delete, or show SSL configuration of the specified listener.
[-need |-want| -noauth,--unnecessary]
Client authentication method.
[-p,--protocol <protocol>]
Type of the SSL protocol to use in the specified listener.
[-cs,--cipherSuite <cipher-suites>]
Encoding method to use in the specified listener.
[-ks,--keystore <keystore-file>]
File that stores the server key to use in the specified listener and its corresponding authentication certificate.
[-kp,--keystorePass <keystore-pass>]
Key to open the specified keystore file.
[-kkp,--keystoreKeypass <keystore-keypass>]
Encrypted value for the server key stored in the specified keystore file.
[-kt,--keystoreType <keystore-type>]
Type of the specified keystore.
[-kma,--keyManagementAlgorithm <key-management-algorithm>]
Management algorithm for the key in the keystore file.
[-alias,--keyAlias <key-alias>]
Key alias of the authentication certificate.
[-ts,--truststore <truststore-file>]
File that stores the server authentication certificate.
[-tp,--truststorePass <truststore-pass>]
Password to open the truststore file.
[-tt,--truststoreType <truststore-type>]
Type of the specified truststore.
[-tma,--trustManagementAlgorithm <trust-management-algorithm>]
Management algorithm of the key stored in the truststore file.
[-crl <crl-file>]
File that stores the certificate revocation lists.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer>config-listener-ssl -server server1 -name Test -set Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server.
1.3.12. disable-engine-init-on-boot
Sets the initialization point of the internal engines (Servlet, EJB, JMS, ProObject) of the servers to when the application was deployed. To apply changes, restart the servers.
-
Related schema
jeus-domain.xsd
-
Alias
lazyengine
-
Usage
disable-engine-init-on-boot <server-list> [-f,--forceLock] -
Parameters
Parameter Description <server-list>
Server name. To specify multiple servers, separate each server with a comma (,).
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer>disable-engine-init-on-boot adminServer,server1 EngineInitOnBoot was successfully disabled. Applying configuration ... ================================================================================ +------------------------------------------------------------------------------+ | Result | +------------------------------------------------------------------------------+ | Successfully changed only the JEUS Domain Configuration. | | Restart the server to apply the changes. | +------------------------------------------------------------------------------+ ================================================================================
1.3.13. disable-engines
Disables the use of the internal engines (Servlet, EJB, JMS, and ProObject) of a server. To apply the setting, restart the server.
-
Related schema
jeus-domain.xsd
-
Alias
engineoff
-
Usage
disable-engines <server-list> [-all] [-web] [-ejb] [-jms] [-f,--forceLock] -
Parameters
Parameter Description <server-list>
Server name. To specify multiple servers, separate each server with a comma (,).
[-all]
Apply to all web, ejb, jms engines.
[-web]
Apply to the web engine.
[-ejb]
Apply to the ejb engine.
[-jms]
Apply to the jms engine.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer>disable-engines adminServer -all [adminServer] Change Engine to Disabled: Web EJB JMS Applying configuration ... ================================================================================ +------------------------------------------------------------------------------+ | Result | +------------------------------------------------------------------------------+ | Successfully changed only the JEUS Domain Configuration. | | Restart the server to apply the changes. | +------------------------------------------------------------------------------+ ================================================================================ ... [MASTER]domain1.adminServer>disable-engines server1 -all [server1] Change Engine to Disabled: Web EJB JMS Applying configuration ... ================================================================================ +------------------------------------------------------------------------------+ | Result | +------------------------------------------------------------------------------+ | Successfully changed only the JEUS Domain Configuration. | | Restart the server to apply the changes. | +------------------------------------------------------------------------------+ ================================================================================ ... [MASTER]domain1.adminServer>disable-engines server2 -web -ejb [server2] Change Engine to Disabled: Web EJB Applying configuration ... ================================================================================ +------------------------------------------------------------------------------+ | Result | +------------------------------------------------------------------------------+ | Successfully changed only the JEUS Domain Configuration. | | Restart the server to apply the changes. | +------------------------------------------------------------------------------+ ================================================================================ ...
1.3.14. dump
Outputs the thread dump(s) of a server or servers that belongs to a cluster. Output is recorded in the server logs.
-
Usage
dump [-clusters <cluster-list> | -servers <server-list>]
-
Parameters
Parameter Description [-clusters <cluster-list>]
Cluster name. To specify multiple clusters, separate each cluster with a comma (,).
[-servers <server-list>]
Server name. To specify multiple servers, separate each server with a comma (,).
-
Example
[MASTER]domain1.adminServer>dump -servers server1 Dumping to the servers. The result of executing a dump of server processes. =============================================================== +--------+----------------------------------------------------+ | Server | Result | +--------+----------------------------------------------------+ | server1| Successfully dumped. | +--------+----------------------------------------------------+ ===============================================================
1.3.15. enable-engine-init-on-boot
Sets the initialization point of the internal engines (Servlet, EJB, JMS, ProObject) of the servers to when the server boots. To apply changes, restart the servers.
-
Related schema
jeus-domain.xsd
-
Alias
eagerengine
-
Usage
enable-engine-init-on-boot <server-list> [-f,--forceLock] -
Parameters
Parameter Description <server-list>
Server name. To specify multiple servers, separate each server with a comma (,).
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer>enable-engine-init-on-boot adminServer EngineInitOnBoot was successfully enabled. Applying configuration ... ================================================================================ +------------------------------------------------------------------------------+ | Result | +------------------------------------------------------------------------------+ | Successfully changed only the JEUS Domain Configuration. | | Restart the server to apply the changes. | +------------------------------------------------------------------------------+ ================================================================================
1.3.16. enable-engines
Enables the use of the internal engines (Servlet, EJB, JMS, and ProObject) of a server. To apply the setting, restart the server.
-
Related schema
jeus-domain.xsd
-
Alias
engineon
-
Usage
enable-engines <server-list> [-all] [-web] [-ejb] [-jms] [-f,--forceLock] -
Parameters
Parameter Description <server-list>
Server name. To specify multiple servers, separate each server with a comma (,).
[-all]
Apply to all web, ejb, jms engines.
[-web]
Apply to the web engine.
[-ejb]
Apply to the ejb engine.
[-jms]
Apply to the jms engine.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer>enable-engines adminServer -all [adminServer] Change Engine to Enabled: Web EJB JMS Applying configuration ... ================================================================================ +------------------------------------------------------------------------------+ | Result | +------------------------------------------------------------------------------+ | Successfully changed only the JEUS Domain Configuration. | | Restart the server to apply the changes. | +------------------------------------------------------------------------------+ ================================================================================ ... [MASTER]domain1.adminServer>enable-engines server1 -all [server1] Change Engine to Enabled: Web EJB JMS Applying configuration ... ================================================================================ +------------------------------------------------------------------------------+ | Result | +------------------------------------------------------------------------------+ | Successfully changed only the JEUS Domain Configuration. | | Restart the server to apply the changes. | +------------------------------------------------------------------------------+ ================================================================================ ... [MASTER]domain1.adminServer>enable-engines server2 -web -ejb [server2] Change Engine to Enabled: Web EJB Applying configuration ... ================================================================================ +------------------------------------------------------------------------------+ | Result | +------------------------------------------------------------------------------+ | Successfully changed only the JEUS Domain Configuration. | | Restart the server to apply the changes. | +------------------------------------------------------------------------------+ ================================================================================ ...
1.3.17. jndi-info
Displays a list of binding names of the objects bound to the JNDI context of a server.
-
Alias
jndiinfo, jndilist
-
Usage
jndi-info -server <server-name> [<context-name>] -
Parameters
Parameter Description -server <server-name>
Server name.
[<context-name>]
JNDI context name.
If <context-name> is a context, all objects bound to the context are displayed. If <context-name> is a leaf node, details of the object are displayed.
-
Example
-
context
[MASTER]domain1.adminServer>jndi-info -server server1 The JNDI list on the server1 List of the context / ================================================================================ +------------+-------------------------------------------------+---------------+ | Name | Value | Local Binding | +------------+-------------------------------------------------+---------------+ | JEUSMQ_DLQ | jeus.jms.common.destination.JeusQueue | false | | mgmt | jeus.jndi.JNSContext | false | +------------+-------------------------------------------------+---------------+ ================================================================================ [MASTER]domain1.adminServer>jndi-info -server server1 mgmt The JNDI list on the server1 List of the context /mgmt =============================================================== +------+--------------------------------------+---------------+ | Name | Value | Local Binding | +------+--------------------------------------+---------------+ | rmbs | jeus.jndi.JNSContext | false | +------+--------------------------------------+---------------+ ===============================================================
-
leaf node
[MASTER]domain1.adminServer>jndi-info -server server1 mgmt/rmbs/adminServer The JNDI list on the server1 List of the context /mgmt/rmbs/server1 ================================================================================ +-------------------+------------------------------------------+---------------+ | Name | Value | Local Binding | +-------------------+------------------------------------------+---------------+ | mgmt/rmbs/server1 | javax.management.remote.JMXConnector | false | +-------------------+------------------------------------------+---------------+ Reference class name : javax.management.remote.JMXConnector Reference Factory class name : jeus.management.remote.jeusmp.JeusmpConnectorFactory [0] StringRefAddr : jmxmp, RefAddr type : protocol [1] StringRefAddr : Administrator, RefAddr type : host [2] StringRefAddr : 19736, RefAddr type : port [3] StringRefAddr : /JEUSMP_server1, RefAddr type : urlPath [4] StringRefAddr : 60000, RefAddr type : checktmout [5] StringRefAddr : 61.77.153.160, RefAddr type : ipaddr end of RefAddr ================================================================================
-
1.3.18. lifecycle-invocation-info
Displays the information of a lifecycle invocation.
-
Alias
invoinfo, lifecycleinvocationinfo, lifeinvoinfo
-
Usage
lifecycle-invocation-info -s,--server <server> | -c,--cluster <cluster> [-class <lifecycle-invocation-class>] [-lib,--library] [-invo,--invocation] -
Parameters
Parameter Description -s,--server <server> | -c,--cluster <cluster>
Server or cluster in which the lifecycle invocation to display is located.
[-class <lifecycle-invocation-class>]
Class name for displaying the class of a specific lifecycle invocation.
[-lib,--library]
Displays library references of a lifecycle invocation.
[-invo,--invocation]
Displays invocations of a lifecycle invocation.
-
Example
[MASTER]domain1.adminServer>lifecycle-invocation-info -s server1 Target Name : server1 Target Type : Server Lifecycle Invocation Class Name: invocation.ClassName1 Library Ref Information: ================================================================================ +--------------+-----------------------+------------------------+--------------+ | Library Name | Specification Version | Implementation Version | Failon Error | | | (Exact match) | (Exact match) | | +--------------+-----------------------+------------------------+--------------+ (No data available) ================================================================================ Invocation Information: ================================================================================ +-------------+---------------+----------------------+-----------+-------------+ | Invocation | Invocation | Invocation Argument | Method | Method | | ID | Type | | Name | Params | +-------------+---------------+----------------------+-----------+-------------+ | 0 | BOOT | | bootMethod| | +-------------+---------------+----------------------+-----------+-------------+ ================================================================================
1.3.19. list-jvm-options
Displays the JVM configuration of a server.
-
Alias
list-jvmopt, listjvmopt, list-jvm-config, list-jvmcfg, listjvmcfg
-
Usage
list-jvm-options <server-name>
-
Parameters
Parameter Description <server-name>
Server name.
-
Example
[MASTER]domain1.adminServer>list-jvm-config adminServer List of JVM Configurations ================================================================================ +------------------------------------------------------------------------------+ | JVM Configs | +------------------------------------------------------------------------------+ | -Xmx256m -XX:MaxPermSize=128m | +------------------------------------------------------------------------------+ ================================================================================
1.3.20. list-lifecycle-invocations
Displays lifecycle invocations of a server or cluster.
-
Alias
listinvo, listlifecycleinvocations, listlifeinvo
-
Usage
list-lifecycle-invocations [-s,--server <server> | -c,--cluster <cluster>]
-
Parameters
Parameter Description [-s,--server <server> | -c,--cluster <cluster>]
Displays lifecyle invocations of a specified server or cluster.
-
Example
[MASTER]domain1.adminServer>list-lifecycle-invocations List of Lifecycle invocations ================================================================================ +------------------+------------------------+---------------------+------------+ | Target | Lifecycle Invocation | Invocation Library | Invocation | | | Class | Ref | | +------------------+------------------------+---------------------+------------+ | [Server]adminSer | lifecycle.LifeCycleTes | | [0]boot | |ver |ter | | | +------------------+------------------------+---------------------+------------+ | [Server]server1 | invocation.ClassName1 | | [0]bootMet | | | | |hod | +------------------+------------------------+---------------------+------------+ | [Server]server1 | invocation.ClassName2 | libName | [0]method1,| | | | | [1]method2 | +------------------+------------------------+---------------------+------------+ ================================================================================ Use the "lifecycle-invocation-info" command for more information about Lifecycle invocation.
1.3.21. list-log-handlers
Displays the information of handlers registered to a server logger.
-
Alias
listloghandlers, listhandlers, list-handlers
-
Usage
list-log-hanlders -server <server-name> <logger-name> -
Parameters
Parameter Description -server <server-name>
Server name.
<logger-name>
Name of the logger.
-
Example
[MASTER]domain1.adminServer>list-log-handlers -server adminServer jeus.deploy List of Loggers ================================================================================ +-------------------+----------------------------------------------------------+ | Name | Value | +-------------------+----------------------------------------------------------+ | Handler Name | fileHandler | | Handler Type | FileHandlerType | | Handler Level | FINEST | | Filename | jeus.deploy.log | | Enable Rotation | true | | Rotation Directory| ${SERVER_HOME}/logs | | Valid Day | 1 | | Buffer Size | 1024 | | Logging to Append | true | +-------------------+----------------------------------------------------------+ ================================================================================
1.3.22. list-loggers
Displays the information of loggers registered to a server.
-
Alias
listloggers
-
Usage
list-loggers <server-name> [-logger <logger-name>] -
Parameters
Parameter Description <server-name>
Server name.
[-logger<logger-name>]
Logger name.
-
Example
[MASTER]domain1.adminServer>list-loggers server1 List of Loggers =========================================================================== +------------------+------+----------------------------+-------+----------+ | Logger Name | Level| Use Parent Handlers | Filter| Formatter| +------------------+------+----------------------------+-------+----------+ | jeus | INFO | false | | | | jeus.security | FINE | true | | | +------------------+------+----------------------------+-------+----------+ ===========================================================================
1.3.23. list-server-listeners
Dynamically displays the configuration of listeners of a server.
-
Alias
listener, serverlistener
-
Usage
list-server-listeners -server <server-name> [-name <listener-name>] -
Parameters
Parameter Description -server <server-name>
Server name.
[-name <listener-name>]
Name of the listener to display.
-
Example
[MASTER]domain1.adminServer>list-server-listeners -server adminServer ========================================================= +--------------------------------------+---------+------+ | listener-name | address | port | +--------------------------------------+---------+------+ | base | 0.0.0.0 | 9736 | | jms | 0.0.0.0 | 9741 | | http-listener | not-set | 8088 | +--------------------------------------+---------+------+ ========================================================= [MASTER]domain1.adminServer>list-server-listeners -server adminServer -name base =============================================================== base +---------------------------------------------------+---------+ | address | 0.0.0.0 | | port | 9736 | | selectors | | | dual-selector | false | | backlog | 128 | | read-timeout | 30000 | | reserved-threads | 0 | +---------------------------------------------------+---------+ ===============================================================
1.3.24. local-shutdown
Terminates the currently connected server.
-
Alias
localdown, localjeusexit
-
Usage
local-shutdown [-to,--shutdowntimeout <timeout> | -f,--force | -g,--graceful] [-i] -
Parameters
Parameter Description [-f, --force]
Forcibly shuts down the server instead of gracefully shutting down.
[-g, --graceful]
Option to shut down servers gracefully. If set, the system waits indefinitely for a server to complete the current request.
[-to, --shutdowntimeout <timeout>]
Sets the timeout to shut down the server gracefully. The server waits the specified period for the current request to complete. (Unit: second)
[-i]
Terminates the servers immediately without the user’s consent.
-
Example
Terminates the currently connected server by using the local-shutdown command.
[MASTER]domain1.adminServer>local-shutdown Executing this command affects the service. Do you want to continue? (y/n)n [local-shutdown] has been canceled. [MASTER]domain1.adminServer>local-shutdown -i The server [adminServer] has been shut down successfully. offline>
1.3.25. log-level
Checks for a logger registered to a specific server and the levels of the handlers registered to the logger.
-
Alias
loglevel
-
Usage
log-level -server <server-name> <logger-name> -
Parameters
Parameter Description -server <server-name>
Server name.
<logger-name>
Name of the logger to be checked.
-
Example
[MASTER]domain1.adminServer>log-level -server server1 jeus The logger[jeus] information for the server [server1] Information about the logger[jeus]. ========================================================== Logger Name : jeus Level : INFO Use Parent Handlers : false +-------------+-------------+----------------------------+ | Handler Name| Handler Type| Handler Level | +-------------+-------------+----------------------------+ | FileHandler | FileHandler | FINEST | +-------------+-------------+----------------------------+ ==========================================================
1.3.26. mbean-info
Displays a list of Mbeans registered to a server.
-
Alias
mbeaninfo
-
Usage
mbean-info -server <server-name> [<object-name>] -
Parameters
Parameter Description -server <server-name>
Server name.
[<object-name>]
Query for an object name.
Used to query a list of MBeans with a specific object name. For more information about the object name queried, refer to JEUS JMX Guide.
-
Example
[MASTER]domain1.adminServer>mbean-info -server server1 The object names of MBeans on the server [server1]. ================================================================================ +------------------------------------------------------------------------------+ | JEUS:j2eeType=JeusService,jeusType=ServerNodeManagerService,JMXManager=server| |1,J2EEServer=server1,name=server1 | | JEUS:j2eeType=J2EEServer,JMXManager=server1,isTargetable=true,J2EEDomain=doma| |in1,name=server1 | | JEUS:j2eeType=JMSResource,JMXManager=server1,J2EEServer=server1,name=server1_| |jms | | JEUS:j2eeType=JeusService,jeusType=SecurityDomain,JMXManager=server1,J2EEDoma| |in=domain1,SecurityService=SecurityService,name=SYSTEM_DOMAIN | | JEUS:j2eeType=JeusService,jeusType=JEUSMPConnector,JMXManager=server1,J2EESer| |ver=server1,name=server1 | | JEUS:j2eeType=JeusService,jeusType=ThreadPool,JMXManager=server1,J2EEServer=s| |erver1,name=threadpool.System | | JEUS:j2eeType=JeusService,jeusType=WebListener,JMXManager=server1,WebEngine=s| |erver1_servlet,J2EEServer=server1,name=ADMIN-HTTP | | JEUS:j2eeType=JeusService,jeusType=ThreadPool,JMXManager=server1,J2EEServer=s| |erver1,name=EJBTimerService | | JEUS:j2eeType=JDBCResource,JMXManager=server1,J2EEServer=server1,name=server1| | JEUS:j2eeType=JeusService,jeusType=ThreadPool_WEBC,JMXManager=server1,WebEngi| |ne=server1_servlet,J2EEServer=server1,WebListener=ADMIN-HTTP,name=ADMIN-HTTP | | JEUS:j2eeType=JeusService,jeusType=EJBEngine,JMXManager=server1,J2EEServer=se| |rver1,name=server1_ejb | | JEUS:j2eeType=JeusService,jeusType=JNDIResourceService,JMXManager=server1,J2E| |EServer=server1,name=server1 | | JEUS:j2eeType=JeusService,jeusType=SecurityService,JMXManager=server1,J2EEDom| |ain=domain1,J2EEServer=server1,name=SecurityService | | JEUS:j2eeType=JeusService,jeusType=WebEngine,JMXManager=server1,J2EEServer=se| |rver1,name=server1_servlet | | JEUS:j2eeType=JeusService,jeusType=SecuritySubject,JMXManager=server1,J2EEDom| |ain=domain1,SecurityDomain=SYSTEM_DOMAIN,name=Subject | | JEUS:j2eeType=JeusService,jeusType=ThreadPool,JMXManager=server1,J2EEServer=s| |erver1,name=server1 | | JEUS:j2eeType=JeusService,jeusType=JMSServiceChannel,JMXManager=server1,J2EES| |erver=server1,JMSResource=server1_jms,name=JMSServiceChannel-default | | JEUS:j2eeType=Console,JMXManager=server1,J2EEServer=server1,name=server1 | | JEUS:j2eeType=JeusService,jeusType=JDBCResourceService,JMXManager=server1,J2E| |EServer=server1,name=server1 | | JEUS:j2eeType=JVM,JMXManager=server1,J2EEServer=server1,name=server1 | | JEUS:j2eeType=JTAResource,JMXManager=server1,J2EEServer=server1,name=server1 | | JEUS:j2eeType=JeusService,jeusType=JMSEngine,JMXManager=server1,J2EEServer=se| |rver1,name=server1_jms | | JEUS:j2eeType=JeusService,jeusType=JMSDestinationResource,JMXManager=server1,| |J2EEServer=server1,JMSResource=server1_jms,name=JEUSMQ_DLQ | | JEUS:j2eeType=JeusService,jeusType=SecurityPolicy,JMXManager=server1,J2EEDoma| |in=domain1,SecurityDomain=SYSTEM_DOMAIN,name=Policy | +------------------------------------------------------------------------------+ ================================================================================
1.3.27. memory-info
Displays the memory information of a specific server or a server that belongs to a specific cluster.
-
Alias
memorystatus, memstatus, memoryinfo, meminfo
-
Usage
memory-info [-clusters <cluster-list> | -servers <server-list>]
-
Parameters
Parameter Description [-clusters <cluster-list>]
Cluster name. To specify multiple clusters, separate each cluster with a comma (,).
[-servers <server-list>]
Server name. To specify multiple servers, separate each server with a comma (,).
-
Example
[MASTER]domain1.adminServer>memory-info -servers server1 Domain [domain1] Memory Information Memory Information ============================================================================= +--------+------------------------+-----------------------------------------+ | Server | Total Amount of Memory | The Current Amount of Memory | +--------+------------------------+-----------------------------------------+ | server1| 110362624 | 55153456 | +--------+------------------------+-----------------------------------------+ =============================================================================
1.3.28. modify-invocation
Changes an invocation of a specific lifecycle invocation.
-
Alias
modinvo, modifyinvocation, modifyinvo
-
Usage
modify-invocation -id <invocation-id> | -m,--method <invocation-method> [-mv,--rename <invocation-method>] [-type <invocation-type>] [-params <method-params>] [-args <invocation-argument>] -class <class> -s,--server <server> | -c,--cluster <cluster> [-f,--forceLock] [-detail] -
Parameters
Parameter Description -id <invocation-id> | -m,--method <invocation-method>
Specifies invocations as either IDs or method names to be changed. If there are multiple invocations with the same method names, specify them using their corresponding IDs.
[-mv,--rename <invocation-method>]
Changes method names of invocations.
[-type <invocation-type>]
Changes the invocation type (time of calling method).
Specify one of the follows.
-
BOOT
-
BEFORE_DEPLOY
-
AFTER_DEPLOY
-
READY
-
BEFORE_UNDEPLOY
-
AFTER_UNDEPLOY
For more information about the types, refer to the Invocation Type part of in Lifecycle Invocation Setting in JEUS Server Guide.
[-params <method-params>]
Changes the fully qualified class name of the method parameter. For multiple parameters, use spaces as delimiters.
(Example: -params java.lang.String boolean)
[-args <invocation-argument>]
Changes the argument used to call methods. For multiple parameters, use spaces as delimiters. If an argument includes a space, enclose it in quotation marks.
(Example: -args "tmaxsoft jeus" "hello world")
-class <class>
Class name of the lifecycle invocation the invocation is located.
-s,--server <server> | -c,--cluster <cluster>
Name of the server or cluster where the lifecycle invocation is located.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the configuration changes.
-
-
Example
[MASTER]domain1.adminServer>modify-invocation -m bootMethod -mv newMethod -class invocation.ClassName1 -s server1 Successfully performed the MODIFY operation for Invocation [newMethod](Invocation ID = 0), but all changes were non-dynamic. They will be applied after restarting. Check the results using "list-lifecycle-invocations or lifecycle-invocation-info".
1.3.29. modify-invocation-library
Changes a library reference of a specify lifecycle invocation.
-
Alias
modinvolib, modifyinvocationlibrary, modifyinvolib
-
Usage
modify-invocation-library <library> [-mv,--rename <invocation-library>] [-specVer <version>] [-specMatch <true | false>] [-implVer <version>] [-implMatch <true | false>] [-fail,--failOnError <true | false>] -class <class> -s,--server <server> | -c,--cluster <cluster> [-f,--forceLock] [-detail] -
Parameters
Parameter Description <library>
Name of a library refrence.
[-mv,--rename <invocation-library>]
Changes a library reference.
[-specVer <version>]
Modifies the specification version of the library.
[-specMatch <true | false>]
Changes the option to enforce matching the specification version.
[-implVer <version>]
Changes the implementation version of the library.
[-implMatch <true | false>]
Changes the option to enforce matching the implementation version.
[-fail,--failOnError <true | false>]
Changes the option to fail the deployment if a shared library cannot be found.
-class <class>
Class name of the lifecycle invocation where the library reference is located.
-s,--server <server> | -c,--cluster <cluster>
Name of the server or cluster where the lifecycle invocation is located.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the configuration changes.
-
Example
[MASTER]domain1.adminServer>modify-invocation-library libName -mv newLibName -class invo.invoTestClass2 -s server1 Successfully performed the MODIFY operation for Invocation Library [newLibName], but all changes were non-dynamic. They will be applied after restarting. Check the results using "list-lifecycle-invocations or lifecycle-invocation-info".
1.3.30. modify-jvm-option
Changes the JVM configuration of a server.
-
Alias
modify-jvmopt, modifyjvmopt, modify-jvm-config, modify-jvmcfg
-
Usage
modify-jvm-option -server <server-name> [-old,--oldOption <jvm-option>] [-new,--newOption <jvm-option>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -server <server-name>
Server name.
[-old,--oldOption <jvm-option>]
JVM configuration before change. The current JVM configuration.
[-new,--newOption <jvm-option>]
JVM configuration to be changed.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the configuration changes.
-
Example
[MASTER]domain1.adminServer>modify-jvm-option -server server1 -old "-Xmx256m -XX:Ma xPermSize=128m" -new "-Xmx512m -XX:MaxPermSize=128m" Successfully performed the MODIFY operation for JVM configuration for the server (server1)., but all changes were non-dynamic. They will be applied after restarting. Check the results using "list-jvm-options or modify-jvm-option"
1.3.31. modify-lifecycle-invocation
Changes a lifecycle invocation of a specific server or cluster.
-
Alias
modlifeinvo, modifylifecycleinvocation, modifylifeinvo
-
Usage
modify-lifecycle-invocation <class> [-mv,--rename <lifecycle-invocation-class>] -s,--server <server> | -c,--cluster <cluster> [-f,--forceLock] [-detail] -
Parameters
Parameter Description <class>
Class name of the lifecycle invocation to modify.
[-mv,--rename <lifecycle-invocation-class>]
Changes the class name of the lifecycle invocation.
-s,--server <server> | -c,--cluster <cluster>
Name of the server or cluster where the lifecycle invocation is located.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the configuration changes.
-
Example
[MASTER]domain1.adminServer>modify-lifecycle-invocation sampleClass1 -mv className3 -s server1 Successfully performed the ADD operation for Lifecycle Invocation Class [className3], but all changes were non-dynamic. They will be applied after restarting. Check the results using "list-lifecycle-invocations".
1.3.32. modify-listener
Changes the listener configuration of a server.
-
Alias
modifylistener, editlistener
-
Usage
modify-listener -server <server-name> -name <listener-name> [-addr <address>] [-port <port>] [-selectors <selectors>] [-dual] [-backlog <backlog>] [-timeout <read-timeout>] [-keepaliveTimeout <keepalive-timeout>] [-rt,--reservedthreads <reserved-threads>] [-f,--forceLock] -
Parameters
Parameter Description -server <server-name>
Server name.
-name <listener-name>
Listener name to be changed.
[-addr <address>]
Address of the listener to be changed.
-port <port>
Port number of the listener to be changed. The value must be between 1 ~ 65535, and the port number cannot conflict with the port numbers of other listeners.
[-selectors <selectors>]
Number of selectors to use.
[-dual]
Uses separate selectors for reading and writing.
[-backlog <backlog>]
Backlog of the listener to be changed.
[-timeout <read-timeout>]
[Dynamic] Read timeout for the listener to be changed.
[-keepaliveTimeout <keepalive-timeout>]
Maximum time to wait before closing an unused socket.
[-rt,--reservedthreads <reserved-threads>]
Number of reserved threads used by the listener to be changed.
[-f,--forceLock]
Forcibly gets a lock for changing the listener configuration.
-
Example
[MASTER]domain1.adminServer>modify-listener -server adminServer -name base -dual -b acklog 250 Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. Check the result using 'list-server-listeners -server adminServer -name base. [MASTER]domain1.adminServer>list-server-listeners -server adminServer -name base =============================================================== base +---------------------------------------------------+---------+ | address | 0.0.0.0 | | port | 9736 | | selectors | 1 | | dual-selector | true | | backlog | 250 | | read-timeout | 30000 | | keepalive-timeout | not-set | | reserved-threads | 0 | +---------------------------------------------------+---------+ ===============================================================
1.3.33. modify-log-handler
Dynamically changes a handler registered to a server logger.
-
Alias
modifyloghandler, modify-handler, modifyhandler
-
Usage
modify-log-handler -server <server-name> -logger <logger-name> <handler-name> [-level <handler-level>] [-filter <filter-class>] [-encoding <encoding>] [-filename <file-name>] [-enable <true | false>] [-count <rotation-count>] [-dir <rotation-dir>] [-buffer <buffer-size>] [-append <true | false>] [-hour <hour> | -day <day> | -size <size>] [-f,--forceLock] [-detail] [-permission <permission>] [-chown <chown>] -
Parameters
Parameter Description -server <server-name>
Server name.
<logger-name>
Name of the logger.
<handler-name>
Name of the handler to be changed.
[-level <handler-level>]
[Dynamic] Log level of the handler (Default value: FINEST)
[-filter <filter-class>]
Class name of the filter for log messages.
[-encoding <encoding>]
Encoding value for log messages.
[-filename <file-name>]
File name where logs are recorded.
(Default value: loggerName.log. JeusServer.log for the JEUS logger)
[-enable <true | false>]
Option to enable file rotation (Default value: true).
[-count <rotation-count>]
Maximum number of log files for backup.
[-dir <rotation-dir>]
Path to the directory that stores backup log files.
[-buffer <buffer-size>]
Size of the buffer used to record log messages to a file.
[-append <true | false>]
Option to append logs to the previous file if the server reboots.
(true | false, default value: true)
[-hour <hour>]
Writes a new log file every hour an entry is made.
[-day <day>]
Writes a new log file each day an entry is made.
[-size <size>]
Writes a new log file according to the input size.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
[-permission <permission>]
Permission used to set a log file. (Example: rwxrwxrwx)
[-chown <chown>]
Owner used to set a log file. The owner and group are separated by comma(,). (Example: owner-id,group-id)
-
Example
[MASTER]domain1.adminServer>modify-log-handler -server server1 -logger jeus newHandler -level CONFIG Successfully performed the MODIFY operation for The handler(FileHandler) for the logger(jeus) in server (server1). Check the results using "modify-log-handler"
1.3.34. modify-logger
Dynamically changes a logger registered to a server.
-
Alias
modifylogger
-
Usage
modify-logger -server <server-name> <logger-name> [-level <log-level>] [-useParentHandlers <true | false>] [-filter <filter-class>] [-formatter <formatter-class>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -server <server-name>
Server name.
<logger-name>
Name of the logger.
[-level <log-level>]
[Dynamic] Log level of the logger.
[-useParentHandlers <true | false>]
[Dynamic] Option to use the parent logger handler.
[-filter <filter-class>]
Class name of the filter for log messages.
[-formatter <formatter-class>]
Class name of the formatter to be applied to the logger.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>modify-logger -server server1 jeus.security -level FINEST -useParentHandlers false Successfully performed the MODIFY operation for The logger[jeus.security] inform ation for the server [server1]. Check the results using "modify-logger"
1.3.35. remove-custom-resource-from-servers
Dynamically deletes the custom resource registered to servers.
-
Alias
remove-cr-from-servers
-
Usage
remove-custom-resource-from-servers <export-name> -servers <server-list> [-f,--forceLock] [-detail] -
Parameters
Parameter Description <export-name>
JNDI bind name of the custom resource to be deleted from the server.
-servers <server-list>
Server list from which the custom resource is deleted.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>remove-custom-resource-from-servers custom/dog -servers server1 Successfully performed the REMOVE operation for A custom resource. Check the results using "list-custom-resources"
1.3.36. remove-data-sources-from-server
Dynamically deletes data sources registered to a server.
-
Alias
rmdsfromsvr
-
Usage
remove-data-sources-from-server -server <server-name> [-ids <data-source-id-list> | -all] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -server <server-name>
Server name from which data sources are to be deleted.
[-ids <data-source-id-list>]
List of data source IDs to delete in the server.
To specify multiple IDs, separate each ID with a comma (,).
[-all]
Deletes all data sources registered in the server.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>remove-data-sources-from-server -server server1 -ids data-source1 Successfully performed the REMOVE operation for data sources from the server [server1]. Check the results using "remove-data-sources-from-server -server server1"
1.3.37. remove-external-resource-from-servers
Dynamically deletes an external resource registered to servers.
-
Alias
remove-er-from-servers
-
Usage
remove-external-resource-from-servers <export-name> -servers <server-list> [-f,--forceLock] [-detail] -
Parameters
Parameter Description <export-name>
External resource name to be deleted from the servers.
-servers <server-list>
Server list from which the external resource is deleted.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>remove-external-resource-from-servers test/ext -servers server1 Successfully performed the REMOVE operation for A external resource. Check the results using "list-external-resources"
1.3.38. remove-invocation
Deletes an invocation from a specific lifecycle invocation.
-
Alias
rminvo, removeinvocation, removeinvo
-
Usage
remove-invocation -id <invocation-id> | -m,--method <invocation-method> -class <class> -s,--server <server> | -c,--cluster <cluster> [-f,--forceLock] [-detail] -
Parameters
Parameter Description -id <invocation-id> | -m,--method <invocation-method>
Specifies invocations as either IDs or method names to be deleted. If there are multiple invocations with the same method names, specify them using their corresponding IDs.
-class <class>
Class name of the lifecycle invocation where the invocation is located.
-s,--server <server> | -c,--cluster <cluster>
Name of the server or cluster where the lifecycle invocation is located.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the configuration changes.
-
Example
[MASTER]domain1.adminServer>remove-invocation -m bootMethod -class invocation.ClassName1 -s server1 Successfully performed the REMOVE operation for Invocation [bootMethod](Invocation ID = 0), but all changes were non-dynamic. They will be applied after restarting. Check the results using "list-lifecycle-invocations or lifecycle-invocation-info".
1.3.39. remove-invocation-library
Delets a library reference from a spcific lifecycle invocation.
-
Alias
rminvolib, removeinvocationlibrary, removeinvolib
-
Usage
remove-invocation-library <library> -class <class> -s,--server <server> | -c,--cluster <cluster> [-f,--forceLock] [-detail] -
Parameters
Parameter Description <library>
Name of the library reference to be deleted.
-class <class>
Class name of the lifecycle invocation where the library reference is located.
-s,--server <server> | -c,--cluster <cluster>
Name of the server or cluster where the lifecycle invocation is located.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the configuration changes.
-
Example
[MASTER]domain1.adminServer>remove-invocation-library newLibName -class invo.invoTestClass2 -s server1 Successfully performed the REMOVE operation for Invocation Library [newLibName], but all changes were non-dynamic. They will be applied after restarting. Check the results using "list-lifecycle-invocations or lifecycle-invocation-info".
1.3.40. remove-jvm-option
Deletes the JVM configurations from a server.
-
Alias
remove-jvmopt, rm-jvmopt, rmjvmopt, remove-jvm-config, remove-jvmcfg, rm-jvmcfg, rmjvmcfg
-
Usage
remove-jvm-option -server <server-name> [-opt,--jvmOption <jvm-option>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -server <server-name>
Server name.
[-opt,--jvmOption <jvm-option>]
JVM configuration to be deleted from the server.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the configuration changes.
-
Example
[MASTER]domain1.adminServer>remove-jvm-option -server server1 -opt "-Xmx256m -XX:Ma xPermSize=128m" Successfully performed the REMOVE operation for JVM configuration for the server (server1)., but all changes were non-dynamic. They will be applied after restarting. Check the results using "list-jvm-options or remove-jvm-option"
1.3.41. remove-lifecycle-invocation
Deletes a lifecycle invocation from a server or cluster.
-
Alias
rmlifeinvo, removelifecycleinvocation, removelifeinvo
-
Usage
remove-lifecycle-invocation <class> -s,--server <server> | -c,--cluster <cluster> [-f,--forceLock] [-detail] -
Parameters
Parameter Description <class>
Class name of the lifecycle invocation to be deleted.
-s,--server <server> | -c,--cluster <cluster>
Name of the server or cluster where the lifecycle invocation is located.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the configuration changes.
-
Example
[MASTER]domain1.adminServer>remove-lifecycle-invocation className3 -s server1 Successfully performed the REMOVE operation for Lifecycle Invocation Class [className3], but all changes were non-dynamic. They will be applied after restarting. Check the results using "list-lifecycle-invocations".
1.3.42. remove-listener
Deletes a listener from a server. The base listener and listeners used in other configurations cannot be deleted.
-
Alias
removelistener, deletelistener
-
Usage
remove-listener -server <server-name> -name <listener-name> [-f,--forceLock] -
Parameters
Parameter Description -server <server-name>
Server name.
-name <listener-name>
Listener name to be deleted.
[-f,--forceLock]
Forcibly gets a lock for deleting a listener.
-
Example
[MASTER]domain1.adminServer>list-server-listeners -server adminServer ======================================================== +------------------------------------+---------+-------+ | listener-name | address | port | +------------------------------------+---------+-------+ | base | 0.0.0.0 | 9736 | | jms | 0.0.0.0 | 9741 | | http-listener | not-set | 8088 | | Test | not-set | 10000 | +------------------------------------+---------+-------+ ======================================================== [MASTER]domain1.adminServer>remove-listener -server adminServer -name Test Executed Successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. Check the result using 'list-server-listeners -server adminServer. [MASTER]domain1.adminServer>list-server-listeners -server adminServer ========================================================= +--------------------------------------+---------+------+ | listener-name | address | port | +--------------------------------------+---------+------+ | base | 0.0.0.0 | 9736 | | jms | 0.0.0.0 | 9741 | | http-listener | not-set | 8088 | +--------------------------------------+---------+------+ =========================================================
1.3.43. remove-log-handler
Dynamically deletes a handler registered to a server logger.
-
Alias
removeloghandler, removehandler, remove-handler
-
Usage
remove-log-handler -server <server-name> -logger <logger-name> [<handler-name>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -server <server-name>
Server name.
-logger <logger-name>
Name of the logger from which a handler is deleted.
[<handler-name>]
Handler name to be deleted.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>remove-log-handler -server server1 -logger jeus newHandler Successfully performed the REMOVE operation for The handler for the logger(jeus) on the server(server1).. Check the results using "list-log-handlers or remove-log-handler"
1.3.44. remove-logger
Dynamically deletes a logger registered to a server.
-
Alias
removelogger
-
Usage
remove-logger -server <server-name> [<logger-name>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -server <server-name>
Server name.
[<logger-name>]
Name of the logger to be deleted.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>remove-logger -server server1 jeus.security Successfully performed the REMOVE operation for The logger for the server(server1).. Check the results using "list-loggers or remove-logger"
1.3.45. remove-replicate-group
Dynamically deletes a replicate group specified in a server or server template.
-
Alias
rmrg
-
Usage
remove-replicate-group [-template <name>] [-server <name>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [-template <name>]
Name of the server template where a replicate group is to be deleted. It cannot be used with the server option.
[-server <name>]
Name of the server where a replicate group is to be deleted. It cannot be used with the template option.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>remove-replicate-group -server server1 Successfully performed the REMOVE operation for Replicate Group Name. Check the results using "show-replicate-group".
1.3.46. resume-server
Resumes a temporarily suspended server or cluster.
-
Alias
resume
-
Usage
resume-server [-clusters <cluster-list> | -servers <server-list>]
-
Parameters
Parameter Description [-clusters <cluster-list>]
Cluster name. To specify multiple clusters, separate each cluster with a comma (,).
[-servers <server-list>]
Server name. To specify multiple servers, separate each server with a comma (,).
-
Example
[MASTER]domain1.adminServer>resume-server -servers server1 Successfully resumed the servers.
1.3.47. run-garbage-collection
Executes Full Garbage Collection on a server or servers that belong to a cluster.
-
Alias
rungc, gc
-
Usage
run-garbage-collection [-clusters <cluster-list> | -servers <server-list>]
-
Parameters
Parameter Description [-clusters <cluster-list>]
Cluster name. To specify multiple clusters, separate each cluster with a comma (,).
[-servers <server-list>]
Server name. To specify multiple servers, separate each server with a comma (,).
-
Example
[MASTER]domain1.adminServer>run-garbage-collection -servers server1 ============================================================ +--------+-------------------------------------------------+ | Server | Result | +--------+-------------------------------------------------+ | server1| Succeeded to GC. | +--------+-------------------------------------------------+ ============================================================
1.3.48. server-info
Displays the current status of a server.
-
Alias
svrinfo, serverinfo, si
-
Usage
server-info [-server <server-name>] [-state | -pid] [-g, --group <group-name> | -c, --cluster <cluster-name> | -n, --node <node-name>] -
Parameters
Parameter Description [-server <server-name>]
Server name.
[-state]
If a server is specified, this option displays the server state.
[-pid]
If a server is specified, this option displays the server PID.
[-g, --group <group-name>]
Displays information about server in a specified group.
[-c, --cluster <cluster-name>]
Displays information about servers in a specified cluster.
[-n, --node <node-name>]
Displays information about servers in a specified node.
-
Example
[MASTER]domain1.adminServer>server-info Information about Domain (domain1) ============================================================================================== +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+ | Server | Status | Node| PID | Clus| Latest | Need to| Listen Ports| Running | | | |Name | | ter | StartTime/Shut |Restart | | Engines | | | | | | | downTime | | | | +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+ | adminSe| RUNNING | N/A | 12154 | N/A | 2016-08-26 | false | base-0.0.0.0| jms, | |rver (*)|(00:21:46| | | |(Fri) PM | |:9736 | ejb, web | | |) | | | |02:29:03 KST | | http-server-| | | | | | | | | |0.0.0.0:8088 | | +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+ | server1| RUNNING |node1| 12171 | clus| 2016-08-26 | false | base-192.167| jms, | | |(00:04:03| | |ter1 |(Fri) PM | |.0.124:9836 | ejb, web | | |) | | | |02:36:22 KST | | | | +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+ | server2| RUNNING |node1| 12172 | clus| 2016-08-26 | false | base-192.167| jms | | |(00:04:03| | |ter1 |(Fri) PM | |.0.124:9936 | ejb, web | | |) | | | |02:36:22 KST | | | | +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+ | ds1 (d)| SHUTDOWN|node1| N/A | temp| N/A | N/A | N/A | N/A | | | | | |late1| | | | | | | | | | | | | | | +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+ | ds2 (d)| SHUTDOWN|node1| N/A | temp| N/A | N/A | N/A | N/A | | | | | |late1| | | | | | | | | | | | | | | +--------+---------+-----+-------+-----+----------------+--------+-------------+-------------+ ==============================================================================================
-
For the JEUS Master Server, asterisk (*) is attached to its name.
-
For a dynamic server, (d) is attached to its name.
-
1.3.49. server-log
Checks the logs of a specific server.
-
Alias
serverlog
-
Usage
server-log -server <server-name> [-basetime, <base-time>] [-endtime, <end-time>] [-line, <number-of-line>] -
Parameters
Parameter Description -server <server-name>
Name of the server that retrieves the log.
[-basetime, <base-time>]
Starting point of the log in time format.
(Format: "yyyy.MM.dd HH:mm:ss" or "HH:mm:ss")
[-endtime, <end-time>]
Ending point of the log in time format.
(Format: "yyyy.MM.dd HH:mm:ss" or "HH:mm:ss")
[-line, <number-of-line>]
Starting point of the log as a line number.
-
Example
[MASTER]domain1.adminServer>server-log -server adminServer -line 10 [2016.08.26 20:00:39][2] [adminServer-33] [NodeManager-0062] Exceed to count to connecting to the node manager. Verify that the node manager is functioning normally. [2016.08.26 20:00:59][2] [adminServer-33] [Console-0010] Attempting to execute a command: server-log from heejin@192.168.15.59. [2016.08.26 20:00:59][2] [adminServer-33] [Console-0012] An exception occurred while processing a command: server-log from heejin@192.168.15.59. [2016.08.26 20:01:45][2] [adminServer-76] [Console-0010] Attempting to execute a command: server-log from heejin@192.168.15.59. [2016.08.26 20:01:45][2] [adminServer-76] [Console-0012] An exception occurred while processing a command: server-log from heejin@192.168.15.59. [2016.08.26 20:02:26][2] [adminServer-36] [Console-0010] Attempting to execute a command: server-log from heejin@192.168.15.59. [2016.08.26 20:02:26][2] [adminServer-36] [Console-0014] The command: server-log from heejin@192.168.15.59 is executed successfully. [2016.08.26 20:02:40][2] [adminServer-73] [Console-0010] Attempting to execute a command: server-log from heejin@192.168.15.59. [2016.08.26 20:02:40][2] [adminServer-73] [Console-0014] The command: server-log from heejin@192.168.15.59 is executed successfully. [2016.08.26 20:08:16][2] [adminServer-76] [Console-0010] Attempting to execute a command: server-log from heejin@192.168.15.59. Successfully got the log messages from the server(adminServer). [MASTER]domain1.adminServer>
1.3.50. set-replicate-group
Dynamically specifies a replicate group to a server or server template.
-
Alias
setrg
-
Usage
set-replicate-group <ReplicateGroupName> [-template <name>] [-server <name>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description <ReplicateGroupName>
Name of the replicate group.
[-template <name>]
Name of the server template to which the replicate group will be specified. It cannot be used with server option.
[-server <name>]
Name of the server to which the replicate group will be specified. It cannot be used with the server template option.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>set-replicate-group RepGrp -server server1 Successfully performed the ADD operation for Replicate Group Name, but all changes were non-dynamic. They will be applied after restarting. Check the results using "show-replicate-group".
1.3.51. show-replicate-group
Checks the replicate group of a server or server template.
-
Alias
showrg
-
Usage
show-replicate-group [-template <name>] [-server <name>] -
Parameters
Parameter Description [-template <name>]
Name of the server template to which the replicate group will be specified. It cannot be used with server option.
[-server <name>]
Name of the server to which the replicate group will be specified. It cannot be used with the server template option.
-
Example
[MASTER]domain1.adminServer>show-replicate-group Replicate Group Name in Server / Server Template ================================================================ +----------+-------------+-------------------------------------+ | Type | Name | Replicate Group Name | +----------+-------------+-------------------------------------+ | Server | adminServer | | | Server | server1 | RepGrp | | Server | server2 | | | Template | tm1 | Test | +----------+-------------+-------------------------------------+ ================================================================ [MASTER]domain1.adminServer>show-replicate-group -server ms1 Replicate Group Name in Server / Server Template ================================================================ +--------+---------+-------------------------------------------+ | Type | Name | Replicate Group Name | +--------+---------+-------------------------------------------+ | Server | server1 | RepGrp | +--------+---------+-------------------------------------------+ ================================================================ [MASTER]domain1.adminServer>show-replicate-group -template tm1 Replicate Group Name in Server / Server Template ================================================================ +----------+------+--------------------------------------------+ | Type | Name | Replicate Group Name | +----------+------+--------------------------------------------+ | Template | tm1 | Test | +----------+------+--------------------------------------------+ ================================================================
1.3.52. show-current-scf-view
Monitors the current SCF view.
-
Alias
scfview, showscf
-
Usage
show-current-scf-view [-dump]
-
Parameters
Parameter Description [-dump]
Used to dump the server log.
-
Example
[MASTER]domain1.adminServer>show-current-scf-view ================================================================================ Current SCF Views +------------------------------------------------------------------------------+ | Group Leader | +------------------------------------------------------------------------------+ | adminServer | +------------------------------------------------------------------------------+ ================================================================================ ================================================================================ Synchronized View +----------+---------------+-------+-----------------------+-------+-----------+ | Server | Address | PID | Started Time | State | Groups | | Name | | | | | | +----------+---------------+-------+-----------------------+-------+-----------+ | adminSer | 192.168.1.1:9 | 29660 | Tue Aug 30 02:43:15 | ALIVE | [domain1] | |ver |736 | |KST 2022 | | | +----------+---------------+-------+-----------------------+-------+-----------+ | server1 | 192.168.1.5:1 | 20500 | Mon Aug 29 10:21:27 | ALIVE | [domain1] | | |9736 | |KST 2022 | | | +----------+---------------+-------+-----------------------+-------+-----------+ ================================================================================ ================================================================================ Individual View +----------+---------------+-------+-----------------------+-------+-----------+ | Server | Address | PID | Started Time | State | Groups | | Name | | | | | | +----------+---------------+-------+-----------------------+-------+-----------+ | adminSer | 192.168.1.1:9 | 29660 | Tue Aug 30 02:43:15 | ALIVE | [domain1] | |ver |736 | |KST 2022 | | | +----------+---------------+-------+-----------------------+-------+-----------+ | server1 | 192.168.1.5:1 | 20500 | Mon Aug 29 10:21:27 | ALIVE | [domain1] | | |9736 | |KST 2022 | | | +----------+---------------+-------+-----------------------+-------+-----------+ ================================================================================ [MASTER]domain1.adminServer>show-current-scf-view -dump ================================================================================ Current SCF Views +------------------------------------------------------------------------------+ | Group Leader | +------------------------------------------------------------------------------+ | adminServer | +------------------------------------------------------------------------------+ ================================================================================ ================================================================================ Synchronized View +----------+---------------+-------+-----------------------+-------+-----------+ | Server | Address | PID | Started Time | State | Groups | | Name | | | | | | +----------+---------------+-------+-----------------------+-------+-----------+ | adminSer | 192.168.1.1:9 | 29660 | Tue Aug 30 02:43:15 | ALIVE | [domain1] | |ver |736 | |KST 2022 | | | +----------+---------------+-------+-----------------------+-------+-----------+ | server1 | 192.168.1.5:1 | 20500 | Mon Aug 29 10:21:27 | ALIVE | [domain1] | | |9736 | |KST 2022 | | | +----------+---------------+-------+-----------------------+-------+-----------+ ================================================================================ ================================================================================ Individual View +----------+---------------+-------+-----------------------+-------+-----------+ | Server | Address | PID | Started Time | State | Groups | | Name | | | | | | +----------+---------------+-------+-----------------------+-------+-----------+ | adminSer | 192.168.1.1:9 | 29660 | Tue Aug 30 02:43:15 | ALIVE | [domain1] | |ver |736 | |KST 2022 | | | +----------+---------------+-------+-----------------------+-------+-----------+ | server1 | 192.168.1.5:1 | 20500 | Mon Aug 29 10:21:27 | ALIVE | [domain1] | | |9736 | |KST 2022 | | | +----------+---------------+-------+-----------------------+-------+-----------+ ================================================================================ Successfully dumped to server log. [MASTER]domain1.adminServer>
1.3.53. start-server
Starts a specific MS. Available when the server is in STANDBY state.
-
Alias
startserver, boot
-
Usage
start-server <server-name> [-f, --force] [-seq,--sequential] -
Parameters
Parameter Description <server-name>
Server name.
[-f, --force]
Starts the server forcibly.
[-seq, --sequential]
Sequentially starts the given servers.
-
Example
[MASTER]domain1.adminServer>start-server server1 Successfully started the server[server1]. The server state is now RUNNING.
1.3.54. stop-cluster
Terminates the managed servers that belong to a cluster. If the cluster includes the JEUS Master Server, it it not terminated.
-
Alias
stopcluster, shutdowncluster, downcluster
-
Usage
stop-cluster <cluster-name> [-to,--shutdowntimeout <timeout> | -f, --force | -g,--graceful] -
Parameters
Parameter Description <cluster-name>
Cluster name.
[-to,--shutdowntimeout <timeout>]
Sets the timeout to terminate servers gracefully. The server waits the specified period for the current request to complete. (Unit: ms)
[-f, --force]
Forcibly shuts down the servers instead of gracefully shutting down.
[-g, --graceful]
Option to shut down servers gracefully. If set, the system waits indefinitely for a server to complete the current request.
-
Example
[MASTER]domain1.adminServer>stop-cluster cluster1 The cluster [cluster1] was successfully stopped.
1.3.55. stop-domain
Terminates the Managed Servers that belong to the current domain. The local-shutdown command can be used to terminate the JEUS Master Server.
-
Alias
stopdomain, shutdownall, downall
-
Usage
stop-domain [-to,--shutdowntimeout <timeout> | -f, --force | -g,--graceful] [-i] -
Parameters
Parameter Description [-f, --force]
Forcibly shuts down the servers instead of gracefully shutting down.
[-g, --graceful]
Option to shut down servers gracefully. If set, the system waits indefinitely for a server to complete the current request.
[-to,--shutdowntimeout <timeout>]
Sets the timeout to terminate servers gracefully.
The server waits the specified period for the current request to complete. (Unit: second)
[-i]
Terminates the servers immediately without the user’s consent.
-
Example
[MASTER]domain1.adminServer>stop-domain Executing this command affects the service. Do you want to continue? (y/n)n [stop-domain] has been canceled. [MASTER]domain1.adminServer>stop-domain -i Stopping servers [adminServer, ms1]. Stop server message to all managed servers in the domain were successfully sent. Unable to shut down JEUS Master Server. To shutdown JEUS Master Server, use the jeusadmin's "local-shutdown" command instead.
1.3.56. stop-server
Terminates one or more Managed Servers. You can use a timeout or enable graceful shutdown to protect transaction results.
-
Alias
stopserver, down, shutdown, jeusexit
-
Usage
stop-server <server-list> [-to,--shutdowntimeout <timeout> | -f, --force | -g,--graceful] -
Parameters
Parameter Description <server-list>
Server name. To specify multiple servers, separate each server with a comma (,).
[-to,--shutdowntimeout <timeout>]
Sets the timeout to terminate servers gracefully.
The server waits the specified period for the current request to complete. (Unit: second)
[-f, --force]
Forcibly shuts down the servers instead of gracefully shutting down. (Default value)
[-g, --graceful]
Option to shut down servers gracefully. If set, the system waits indefinitely for a server to complete the current request.
-
Example
[MASTER]domain1.adminServer>stop-server server1 Stop server message to server [server1] was successfully sent.
1.3.57. suspend-server
Temporarily suspends a running server.
-
Alias
suspend
-
Usage
suspend-server [-clusters <cluster-list>| -servers <server-list>]
-
Parameters
Parameter Description [-clusters <cluster-list>]
Cluster name. To specify multiple clusters, separate each cluster with a comma (,).
[-servers <server-list>]
Server name. To specify multiple servers, separate each server with a comma (,).
-
Example
[MASTER]domain1.adminServer>suspend-server -servers server1 Successfully suspended server(s).
1.3.58. system-info
Displays the system information of a server.
-
Alias
systeminfo, sysinfo, sys-info, system-information, system-ststus, systemstatus, systemst
-
Usage
system-info [-process,--process | -jvm,--jvm | -CPU,--cpu | -patch,--patch | -memory,--memory] <server-name> -
Parameters
Parameter Description [-process,--process]
Displays process information.
[-jvm,--jvm]
Displays JVM information.
[-CPU,--cpu]
Displays CPU information.
[-patch,--patch]
Displays the patch information applied to the server.
[-memory,--memory]
Displays memory information.
<server-name>
Name of the server that displays system information.
-
Example
[MASTER]domain1.adminServer>system-info -process adminServer System Information of Server [adminServer] Process Information [adminServer] ================================================================ +-----------------------------------------------------+--------+ | Key | Value | +-----------------------------------------------------+--------+ | Process Id | 719151 | | Thread Count | 106 | | Process CPU Load | 0.6 % | | User Name | User | +-----------------------------------------------------+--------+
1.4. Domain Configuration Commands
The following is a list of domain configuration commands.
| Command | Description |
|---|---|
Dynamically adds a cluster. Only available for the JEUS Master Server and Managed Server structure. |
|
Dynamically adds a custom resource. |
|
Dynamically adds a custom resource to clusters. Only available for the JEUS Master Server and Managed Server structure. |
|
Dynamically adds data sources to a cluster. Only available for the JEUS Master Server and Managed Server structure. |
|
Dynamically adds an external resource. |
|
Dynamically adds an external resource to clusters. Only available for the JEUS Master Server and Managed Server structure. |
|
Dynamically adds a server. Only available for the JEUS Master Server and Managed Server structure. |
|
Dynamically adds a server to a cluster. Only available for the JEUS Master Server and Managed Server structure. |
|
Adds a server template that can be dynamically applied to multiple servers. Only available for the JEUS Master Server and Managed Server structure. |
|
Creates a cluster that consists of servers that are created automatically by using a template. Only available for the JEUS Master Server and Managed Server structure. |
|
Offline command that creates a new domain.xml file, which is created by applying a configuration plan to the current domain.xml file. |
|
Creates a new domain. This is a offline command. For a user created by default, the password must be entered separately. |
|
Deletes a domain. This is an offline command. |
|
Disables JsonCommand. |
|
Disables the synchronization of applications when the Managed Server state changes from INDEPENDENT to DEPENDENT. Only available for the JEUS Master Server and Managed Server structure. |
|
Enables JsonCommand. |
|
Enables the synchronization of applications when the Managed Server state changes from INDEPENDENT to DEPENDENT. Only available for the JEUS Master Server and Managed Server structure. |
|
Displays information about clusters in the current domain. Only available for the JEUS Master Server and Managed Server structure. |
|
Displays the custom resources defined in the current domain. |
|
Retrieves external resources defined in the current domain. |
|
Displays a list of domains. |
|
Displays the configuration information about servers in the current domain. |
|
Dynamically modifies a cluster. Only available for the JEUS Master Server and Managed Server structure. |
|
Dynamically modifies a server. |
|
Modifies the configurations of a cluster created with dynamically configured servers. Only available for the JEUS Master Server and Managed Server structure. |
|
Packs a domain directory for recovery by using domain backup. This is an offline command. |
|
Dynamically deletes a cluster. Only available for the JEUS Master Server and Managed Server structure. |
|
Dynamically deletes a custom resource. |
|
Dynamically deletes a custom resource from clusters. Only available for the JEUS Master Server and Managed Server structure. |
|
Dynamically deletes the data sources registered in a cluster. Only available for the JEUS Master Server and Managed Server structure. |
|
Deletes the owner and permission setting of log files in the domain. |
|
Dynamically deletes an external resource. |
|
Dynamically deletes a registered external resource from clusters. Only available for the JEUS Master Server and Managed Server structure. |
|
Dynamically deletes a server. |
|
Dynamically deletes servers from a cluster. Only available for the JEUS Master Server and Managed Server structure. |
|
Sets the owner and permission of log files in the domain. This setting is applied if the log file owner and permission are not specified in the logger settings for servers in the domain. |
|
Displays the owner and permission setting of log files in the domain. |
|
Displays the configurations of a cluster created with dynamically configured servers. Only available for the JEUS Master Server and Managed Server structure. |
|
Displays the configurations of a server template. Only available for the JEUS Master Server and Managed Server structure. |
|
Unpacks the files packed by the pack-domain command when a server has a failure |
1.4.1. add-cluster
Dynamically adds a cluster.
-
Usage
add-cluster [<cluster-name>] [-servers <server-list>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [<cluster-name>]
Cluster name to be added.
[-servers <server-list>]
Name of the server to be added to the cluster.
To specify multiple servers, separate each server with a comma (,).
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
-
Checking the current clusters
[MASTER]domain1.adminServer>list-clusters List of Clusters =================================================================== +----------+------------------------+-------+-----------+---------+ | Cluster | Server List | MEJB | Class FTP | Running | +----------+------------------------+-------+-----------+---------+ | cluster1 | server1, server2 | false | false | true | +----------+------------------------+-------+-----------+---------+ ===================================================================
-
Creating a new cluster that contains servers that do not belong to other clusters
[MASTER]domain1.adminServer>add-cluster cluster2 -servers server3,server4 Successfully performed the ADD operation for cluster (cluster2). Check the results using "list-clusters or add-cluster"
-
1.4.2. add-custom-resource
Dynamically adds a custom resource.
-
Alias
addcustomresource, addcr
-
Usage
add-custom-resource [<export-name>] [-resource,--resourceClass <resource-class>] [-factory,--factoryClass <factory-class>] [-p,--properties <properties>] [-servers <server-list>] [-clusters <cluster-list>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [<export-name>]
JNDI binding name of the custom resource to be added.
[-resource,--resourceClass <resource-class >]
Class name of the custom resource.
[-factory,--factoryClass <factory-class >]
Name of the factory class that creates the custom resource.
[-p,--properties <properties>]
Property of the custom resource.
[-servers <server-list>]
Adds a custom resource to the domain and concurrently registers the custom resource in the given server list.
[-clusters <cluster-list>]
Adds a custom resource to the domain and concurrently registers the custom resource in the given cluster list.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>add-custom-resource custom/dog -resource dog.Dog -factory dog.DogFactory Successfully performed the ADD operation for A custom resource. Check the results using "list-custom-resources or add-custom-resource"
1.4.3. add-custom-resource-to-clusters
Dynamically adds a custom resource to clusters.
-
Alias
add-cr-to-clusters
-
Usage
add-custom-resource-to-clusters <export-name> -clusters <cluster-list> [-f,--forceLock] [-detail] -
Parameters
Parameter Description <export-name>
JNDI binding name of the custom resource to be added.
-clusters <cluster-list>
Cluster list in which the custom resource is registered.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>add-custom-resource-to-clusters custom/dog -clusters cluster1 Successfully performed the ADD operation for A custom resource. Check the results using "list-custom-resources"
1.4.4. add-data-sources-to-cluster
Dynamically adds data sources to a cluster.
-
Alias
adddstocluster
-
Usage
add-data-sources-to-cluster -cluster <cluster-name> [-ids <data-source-id-list> | -all] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -cluster <cluster-name>
Cluster name in which data sources are registered.
[-ids <data-source-id-list>]
List of data source IDs to be registered in a cluster.
To specify multiple IDs, separate each ID with a comma (,).
[-all]
Registers all data sources defined in the domain.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>add-data-sources-to-cluster -cluster cluster1 -ids datasource1 Successfully performed the ADD operation for data sources to the cluster [cluster1]. Check the results using "add-data-sources-to-cluster -cluster cluster1"
1.4.5. add-external-resource
Dynamically adds an external resource.
-
Alias
addexternalresource, adder
-
Usage
add-external-resource [<export-name>] [-class,--resourceClass <resource-class>] [-p,--properties <properties>] [-servers <server-list>] [-clusters <cluster-list>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [<export-name>]
External resource name to be added.
[-class,--resourceClass <resource-class >]
Class name of the external resource.
[-p,--properties <properties>]
Properties of the external resource.
[-servers <server-list>]
Adds an external resource to the domain and concurrently registers the custom resource in the given server list.
[-clusters <cluster-list>]
Adds an external resource to the domain and concurrently registers the custom resource in the given cluster list.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>add-external-resource test/ext -resource test.ext.TestResourceBootstrapper Successfully performed the ADD operation for A external resource. Check the results using "list-external-resources or add-external-resource"
1.4.6. add-external-resource-to-clusters
Dynamically adds an external resource to clusters.
-
Alias
add-er-to-clusters
-
Usage
add-external-resource-to-clusters <export-name> -clusters <cluster-list> [-f,--forceLock] [-detail] -
Parameters
Parameter Description <export-name>
External resource name to be added to clusters.
-clusters <cluster-list>
Registers the external resource in the given cluster list.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>add-external-resource-to-cluster test/ext -clusters cluster1 Successfully performed the ADD operation for A external resource. Check the results using "list-external-resources"
1.4.7. add-server
Dynamically adds a server.
-
Alias
addserver
-
Usage
add-server [<server-name>] [-target,--duptargetserver <target-server>] [-port,--baseport <base-port>] [-addr,--baseaddr <base-addr>] [-http,--httpport <http-port>] [-rg,--replicate-group <name>] [-node,--nodeName <node-name>] [-jvm,--jvmOptions <jvm-options>] [-logdir,--logHomeDirectory <server-log-home-directory>] [-a,--actionOnResourceLeak <action-on-resource-leak>] [-l,--logStdoutToRawFormat <true | false>] [-m,--mejb <true | false>] [-c,--classFtp <true | false>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [<server-name>]
Server name.
[-target,--duptargetserver <target-server>]
Target server name to which the server configurations are copied.
[-port,--baseport <base-port>]
Base port of the server.
9736 is the default value. If multiple servers run on the same machine, each port must be unique to avoid conflicts.
[-addr,--baseaddr <base-addr>]
Address of the server.
[-http,--httpport <http-port>]
HTTP listener port number of the server.
8088 is the default value. If multiple servers run on the same machine, each port must be unique to avoid conflicts.
[-rg,--replicate-group <name>]
JNDI naming server replicate group of the server.
Independent of the cluster, it is a JNDI naming server group whose servers with the same values operate in the same way as the cluster for binding object replication, group management, and other functions within the JNDI. Even if server clustering is not performed, it is possible to achieve clustering effects only for JNDI and EJB.
[-node,--nodeName <node-name>]
Node name of the machine on which the server is running.
[-jvm,--jvmOptions <jvm-options>]
JVM options that apply to the server.
If the option contains whitespace, wrap the option with double quotes (" ").
[-logdir,--logHomeDirectory <server-log-home-directory>]
Log directory in which logs created by the server are located.
[-a,--actionOnResourceLeak <action-on-resource-leak>]
Action to take when a resource leak occurs.
Input options:
-
AutoClose
-
NoAction
-
Warning
[-l,--logStdoutToRawFormat <true | false>]
[Dynamic] Option to print stdout as is or in JEUS logger format. (true | false)
[-m,--mejb <true |false>]
[Dynamic] Option to use MEJB. (true | false)
[-c,--classFtp <true | false>]
[Dynamic] Option to use the FTP service class. (true | false)
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
-
Example
-
Checking the list of servers
[MASTER]domain1.adminServer>list-servers List of Editable Servers ================================================================================ +------+--------+-----+--------+---------+---------+-----+-----+---------+-----+ | Serv | Base | Node| JVM | Action | Stdout | MEJB| Cla | Server | Type| | er | Listen | |Configs | On | to Raw | | ss |Log Home | | | |Address | | |Resource | Format | | FTP | Directo | | | | /Port | | | Leak | | | | ry | | +------+--------+-----+--------+---------+---------+-----+-----+---------+-----+ | admi |0.0.0.0 | nod | -Xmx10 | Warning | true | fal | true| none | ser | |nServ |/ 9736 |e1 |24m | | |se | | |ver | |er | | |-XX:Max | | | | | | | | | | |Metaspa | | | | | | | | | | |ceSize= | | | | | | | | | | |512m | | | | | | | +------+--------+-----+--------+---------+---------+-----+-----+---------+-----+ | serve|0.0.0.0 | nod | -Xmx10 | Warning | true | fal | fal | none | ser | |r1 |/ 19736 |e1 |24m | | |se |se | |ver | | | | |-XX:Max | | | | | | | | | | |Metaspa | | | | | | | | | | |ceSize= | | | | | | | | | | |512m | | | | | | | +------+--------+-----+--------+---------+---------+-----+-----+---------+-----+ ================================================================================
-
Adding a server with a new name
[MASTER]domain1.adminServer>add-server server2 -port 10000 -node node1 -m false Successfully performed the ADD operation for server (server2). NOTICE : base-addr [0.0.0.0] base-port [10000] http-port [8088] Check the results using "list-servers or add-server" [MASTER]domain1.adminServer>add-server server3 -port 11000 -http 18088 -node node1 Successfully performed the ADD operation for server (server3). NOTICE : base-addr [0.0.0.0] base-port [11000] http-port [18088] Check the results using "list-servers or add-server"
-
1.4.8. add-servers-to-cluster
Dynamically adds a server to a cluster.
-
Usage
add-servers-to-cluster <cluster-name> [-servers <server-list>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [<cluster-name>]
Cluster name.
[-servers <server-list>]
Name of the server to be added to the cluster.
To specify multiple servers, separate each server with a comma (,).
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>add-servers-to-cluster cluster1 -servers server1 Successfully performed the ADD operation for The server list for cluster(cluster1).. Check the results using "list-clusters cluster1 or add-servers-to-cluster cluster1"
1.4.9. add-server-template
Adds a server template that can be dynamically applied to multiple servers.
-
Usage
add-server-template [<server-template-name>] [-port,--baseport <base-port>] [-addr,--baseaddr <base-addr>] [-http,--httpport <http-port>] [-node,--nodeName <node-name>] [-rg,--replicate-group <name>] [-jvm,--jvmOptions <jvm-options>] [-logdir,--logHomeDirectory <server-log-home-directory>] [-a,--actionOnResourceLeak <action-on-resource-leak>] [-l,--logStdoutToRawFormat <true | false>] [-m,--mejb <true | false>] [-c,--classFtp <true | false>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description <server-template-name>
Server template name to be added.
[-port,--baseport <base-port>]
Base port of the server.
9736 is the default value.
[-addr,--baseaddr <base-addr>]
Address of the server.
[-http,--httpport <http-port>]
HTTP listener port number of the server.
8088 is the default value.
[-node,--nodeName <node-name>]
Node name of the machine on which the server is running.
[-rg,--replicate-group <name>]
JNDI naming server replicate group of the server.
Independent of the cluster, it is a JNDI naming server group whose servers with the same values operate in the same way as the cluster for binding object replication, group management, and other functions within the JNDI. Even if server clustering is not performed, it is possible to achieve clustering effects only for JNDI and EJB.
[-jvm,--jvmOptions <jvm-options>]
JVM options to be added to the template.
If the option contains whitespace, wrap the option with double quotes (" ").
[-logdir,--logHomeDirectory <server-log-home-directory>]
Log directory that contains logs created by the server set by the template.
[-a,--actionOnResourceLeak <action-on-resource-leak>]
Action to take when a resource leak occurs.
Input options:
-
AutoClose
-
NoAction
-
Warning
[-l,--logStdoutToRawFormat <true | false>]
[Dynamic] Option to print stdout as is or in JEUS logger format. (true | false)
[-m,--mejb <true |false>]
[Dynamic] Option to use MEJB. (true | false)
[-c,--classFtp <true | false>]
[Dynamic] Option to use the FTP service class. (true | false)
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
-
Example
[MASTER]domain1.adminServer>add-server-template temp1 Successfully performed the ADD operation for server template (temp1), but all changes were non-dynamic. They will be applied after restarting. NOTICE : base-addr [0.0.0.0] base-port [9736] http-port [8088] Check the results using "list-servers or show-server-template or add-server-template".
1.4.10. add-dynamic-servers
Creates a cluster that consists of servers that are created automatically by using a template. The template must be preset with the configuration information in advance.
-
Alias
adddservers
-
Usage
add-dynamic-servers <cluster-name> -count <the-number-of-dynamic-servers> [-nodes,--nodeNames <node-names>] [-prefix,--serverNamePrefix <server-name-prefix>] -template,--serverTemplateName <server-template-name> [-step,--listenPortStep <listen-port-step>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description <cluster-name>
Name of a cluster to be created using dynamically configured servers.
-count <the-number-of-dynamic-servers>
Number of servers to be included in the cluster.
[-nodes,--nodeNames <node-names>]
Names of nodes where the servers to be added are located. Multiple nodes can be specified by using a comma (,) delimiter.
[-prefix,--serverNamePrefix <server-name-prefix>]
Prefix to be added to a server name.
If not set, '_server_' is preceded by a cluster name.
-template,--serverTemplateName <server-template-name>
Template to be applied to dynamic servers.
[-step,--listenPortStep <listen-port-step>]
Number to be incremented in the port number of the servers created in the same node.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>add-dynamic-servers cluster1 -count 2 -nodes node1 -template temp1 Successfully performed the ADD operation for Dynamic servers configuration in the cluster (cluster1). Check the results using "list-clusters or show-dynamic-servers".
1.4.11. apply-configuration-plan
Command that creates a new domain.xml file, which is created by applying a configuration plan to the current domain.xml file.
-
Alias
applycp
-
Usage
apply-configuration-plan -plan,--configPlanPath <configuration-plan-path> -src,--configSourcePath <configuration-source-path> -target,--configTargetPath <configuration-target-path> -
Parameters
Parameter Description -plan,--configPlanPath <configuration-plan-path>
Path to the configuration plan.
-src,--configSourcePath <configuration-source-path>
Path to the current domain.xml file, which the configuration plan is applied to.
-target,--configTargetPath <configuration-target-path>
Path to the file, which is the result of applying the configuration plan.
-
Example
offline>apply-configuration-plan -src /home/jeus/domains/domain1/config/domain.xml -plan /home/plans/jeus-configuration-plan.xml -target /home/jeus/domains/domain1/config/domain.xml.new Successfully applied configuration plan.
-
Note
This command can be used without being connected to the server.
1.4.12. create-domain
Creates a new domain. For a user created by default, the password must be entered separately.
It is encrypted in AES. The default value of the option is set in JEUS_HOME\setup\domain-config-template.properties.
-
Alias
createdomain
-
Usage
create-domain -domain <domain-name> [-mastername <master-name>] [-baseport <master-base-port>] [-baseaddress <master-base-address>] [-jmsport <jms-port>] [-user <user-name>] [-httpport <http-port>] [-jvmconfig <jvm-config>] [-node <node-name>] [-pw,--password] [-ttype,--transport.type <transport-type>] [-productionmode,--productionmode] [-taddress,--transport.address <transport-address>] [-tport,--transport.port <transport-port>] -
Parameters
Parameter Description -domain <domain-name>
Domain name.
[-mastername <master-name>]
JEUS Master Server name that manages the domain.
[-baseport <master-base-port>]
JEUS Master Server base port.
[-baseaddress <master-base-address>]
Base address of the JEUS Master Server.
[-user <user-name>]
Domain user name.
[-httpport <http-port>]
HTTP port of the JEUS Master Server.
[-jvmconfig <jvm-config>]
JVM configurations to be applied to the JEUS Master Server.
[-node <node-name>]
Node name to be applied to the JEUS Master Server.
[-pw,--password]
Receive password only from the console regardless of the template property file configuration.
[-ttype,--transport.type <transport-type>]
SCF transport type.
[-productionmode,--productionmode]
Option to use the created JEUS domain in production mode.
[-taddress,--transport.address <transport-address>]
Transport address used in SCF.
[-tport,--transport.port <transport-port>]
Transport port used in SCF.
-
Example
offline>create-domain -domain domain1 -mastername adminServer -baseport 9763 -jvmconfig "-Xmx1024m -XX:MaxPermSize=256m" Enter the password for [administrator]: ********** Confirm the password: ********** Do you want to encrypt the password? (y/n): y ================================================================================ The domain [domain1] was created successfully. +--------------------------------+---------------------------------------------+ | Property | Value | +--------------------------------+---------------------------------------------+ | Domain name | domain1 | +--------------------------------+---------------------------------------------+ | JEUS Master Server Name | adminServer | +--------------------------------+---------------------------------------------+ | JEUS Master Server Base Listen | 9763 | | Port | | +--------------------------------+---------------------------------------------+ | JEUS Master Server Base Listen | 0.0.0.0 | | Address | | +--------------------------------+---------------------------------------------+ | HTTP Port | 8088 | +--------------------------------+---------------------------------------------+ | User Name | administrator | +--------------------------------+---------------------------------------------+ | Node Name | node1 | +--------------------------------+---------------------------------------------+ | Password | {AES:256}lBljYlIlBrujFDC7v3NSoHZQprgnncVmdB | | |bkt4oxDRg= | +--------------------------------+---------------------------------------------+ | JVM Option | -Xmx1024m -XX:MaxMetaspaceSize=256m | +--------------------------------+---------------------------------------------+ | Production Mode | true | +--------------------------------+---------------------------------------------+ | Transport Type | HYBRID | +--------------------------------+---------------------------------------------+ ================================================================================ -
Note
This command can be used without being connected to the server.
1.4.13. delete-domain
Deletes a created domain. The domain of the currently connected server cannot be deleted.
-
Alias
deletedomain
-
Usage
delete-domain -domain <domain-name> [-f, --force] -
Parameters
Parameter Description -domain <domain-name>
Domain name.
[-f, --force]
Forcibly deletes the domain without asking whether to delete the domain.
-
Example
offline>delete-domain -domain newDomain Delete the following domain: [newDomain] Do you want to execute the delete domain command? (y/n)y Deleting the domain directory was successful. offline>delete-domain -domain newDomain -f Deleting the domain directory was successful.
-
Note
This command can be used without being connected to the server.
1.4.14. disable-json-command
Disables JsonCommand.
-
Alias
suspend-json-command, jsonoff
-
Usage
disable-json-command [-f,--forceLock]
-
Parameters
Parameter Description [-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer>disable-json-command JsonCommand was successfully disabled. Applying configuration ... ================================================================================ +------------------------------------------------------------------------------+ | Result | +------------------------------------------------------------------------------+ | Successfully applied the configuration changes. | | Restart the server to apply the changes. | +------------------------------------------------------------------------------+ ================================================================================
1.4.15. disable-to-resynchronize-applications
Disables the synchronization of applications when the Managed Server state changes from INDEPENDENT to DEPENDENT.
-
Alias
disable-resync-apps, disable-resyncapps
-
Usage
disable-to-resynchronize-applications [-f,--forceLock]
-
Parameters
Parameter Description [-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer>disable-to-resynchronize-applications ResyncAppsCommand was successfully disabled. Applying configuration ... ================================================================================ +------------------------------------------------------------------------------+ | Result | +------------------------------------------------------------------------------+ | Successfully applied the configuration changes. | +------------------------------------------------------------------------------+ ================================================================================
1.4.16. enable-json-command
Enables JsonCommand.
-
Alias
resume-json-command, jsonon
-
Usage
enable-json-command [-f,--forceLock]
-
Parameters
Parameter Description [-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer>enable-json-command JsonCommand was successfully enabled. Applying configuration ... ================================================================================ +------------------------------------------------------------------------------+ | Result | +------------------------------------------------------------------------------+ | Successfully applied the configuration changes. | | Restart the server to apply the changes. | +------------------------------------------------------------------------------+ ================================================================================
1.4.17. enable-to-resynchronize-applications
Enables the synchronization of applications when the Managed Server state changes from INDEPENDENT to DEPENDENT.
-
Alias
enable-resynch-apps, enable-resyncapps, enableresyncapps
-
Usage
enable-to-resynchronize-applications [-f,--forceLock]
-
Parameters
Parameter Description [-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer>enable-to-resynchronize-applications ResyncAppsCommand was successfully enabled. Applying configuration ... ================================================================================ +------------------------------------------------------------------------------+ | Result | +------------------------------------------------------------------------------+ | Successfully applied the configuration changes. | +------------------------------------------------------------------------------+ ================================================================================
1.4.18. list-clusters
Displays information about clusters in the current domain.
-
Usage
list-clusters [<cluster-name>]
-
Parameters
Parameter Description [<cluster-name>]
Cluster name.
-
Example
[MASTER]domain1.adminServer>list-clusters List of Clusters ================================================================================ +---------+------------------------------------------+-----+----------+--------+ | Cluster | Server List | MEJB| Class FTP| Running| +---------+------------------------------------------+-----+----------+--------+ | cluster1| newServer, server1 | | | true | +---------+------------------------------------------+-----+----------+--------+ ================================================================================
1.4.19. list-custom-resources
Displays the custom resources defined in the current domain.
-
Alias
listcustomresources, list-cr, listcr
-
Usage
list-custom-resources [-name <export-name>] | [-cluster <cluster-name>] | [-server <server-name>] -
Parameters
Parameter Description [-name <export-name>]
Custom resource name.
[-cluster <cluster-name>]
Name of the cluster that checks the custom resource registered in the cluster.
[-server <server-name>]
Name of the server that checks the custom resource registered in the server.
-
Example
[MASTER]domain1.adminServer>list-custom-resources List of Custom Resources ================================================================================ +-------------+--------------------+--------------------------+----------------+ | Export Name | Resource Class | Factory Class | Properties | +-------------+--------------------+--------------------------+----------------+ | custom/dog | dog.Dog | dog.DogFactory | [test=1, | | | | |test1=2] | +-------------+--------------------+--------------------------+----------------+ ================================================================================
1.4.20. list-external-resources
Checks the external resource defined in the current domain.
-
Alias
listexternalresources, list-er, lister
-
Usage
list-external-resources [-name <export-name>] | [-cluster <cluster-name>] | [-server <server-name>] -
Parameters
Parameter Description [-name <export-name>]
External resource name.
[-cluster <cluster-name>]
Name of the cluster that checks the external resource registered in the cluster.
[-server <server-name>]
Name of the server that checks the external resource registered in the server.
-
Example
[MASTER]domain1.adminServer>list-external-resources List of External Resources ================================================================================ +-------------+---------------------------------------------------+------------+ | Export Name | Resource Class | Properties | +-------------+---------------------------------------------------+------------+ | test/ext | test.ext.TestResourceBootstrapper | [] | +-------------+---------------------------------------------------+------------+ ================================================================================
1.4.21. list-domains
Displays a list of domains.
-
Alias
listdomains
-
Usage
list-domains
-
Example
offline>list-domains List Domains ================================================================================ +------------------------------------------------------------------------------+ | Domains | +------------------------------------------------------------------------------+ | domain1 | +------------------------------------------------------------------------------+ ================================================================================
-
Note
This command can be used without being connected to the server.
1.4.22. list-servers
Displays the configuration information about servers in the current domain. Use the server-info command to display server state information.
-
Usage
list-servers [<server-name>]
-
Parameters
Parameter Description [<server-name>]
Server name.
-
Example
[MASTER]domain1.adminServer>list-servers List of Editable Servers ================================================================================ +------+--------+-----+--------+---------+---------+-----+-----+---------+-----+ | Serv | Base | Node| JVM | Action | Stdout | MEJB| Cla | Server | Type| | er | Listen | |Configs | On | to Raw | | ss |Log Home | | | |Address | | |Resource | Format | | FTP | Directo | | | | /Port | | | Leak | | | | ry | | +------+--------+-----+--------+---------+---------+-----+-----+---------+-----+ | admi |0.0.0.0 | nod | -Xmx10 | Warning | true | fal | true| none | ser | |nServ |/ 9736 |e1 |24m | | |se | | |ver | |er | | |-XX:Max | | | | | | | | | | |Metaspa | | | | | | | | | | |ceSize= | | | | | | | | | | |512m | | | | | | | +------+--------+-----+--------+---------+---------+-----+-----+---------+-----+ | serv | 192.16 | nod | -Xmx10 | Warning | true | fal | fal | none | ser | |er1 |8.0.124 |e1 |24m | | |se |se | |ver | | | / 9836 | |-XX:Max | | | | | | | | | | |Metaspa | | | | | | | | | | |ceSize= | | | | | | | | | | |512m | | | | | | | +------+--------+-----+--------+---------+---------+-----+-----+---------+-----+ | serv | 192.16 | nod | -Xmx10 | Warning | true | fal | fal | none | ser | |er2 |8.0.124 |e1 |24m | | |se |se | |ver | | | / 9936 | |-XX:Max | | | | | | | | | | |Metaspa | | | | | | | | | | |ceSize= | | | | | | | | | | |512m | | | | | | | +------+--------+-----+--------+---------+---------+-----+-----+---------+-----+ | dy_s |0.0.0.0 | nod | -Xmx10 | Warning | true | fal | fal | none | dyn | |erver |/ 9737 |e1 |24m | | |se |se | |amic | |_1 | | | | | | | | |(t1) | +------+--------+-----+--------+---------+---------+-----+-----+---------+-----+ | dy_s |0.0.0.0 | nod | -Xmx10 | Warning | true | fal | fal | none | dyn | |erver |/ 9837 |e1 |24m | | |se |se | |amic | |_1 | | | | | | | | |(t1) | +------+--------+-----+--------+---------+---------+-----+-----+---------+-----+ ================================================================================
1.4.23. modify-cluster
Dynamically modifies a cluster.
-
Alias
modifycluster, clusterconf, clusterconfig
-
Usage
modify-cluster <cluster-name> [-m,--mejb <true | false>] [-c,--classFtp <true | false>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [<cluster-name>]
Cluster name.
[-m,--mejb <true |false>]
[Dynamic] Option to use MEJB. (true | false)
[-c,--classFtp <true | false>]
[Dynamic] Option to use the FTP service class. (true | false)
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>modify-cluster cluster1 -m true Successfully performed the MODIFY operation for cluster (cluster1). Check the results using "list-clusters cluster1 or modify-cluster cluster1"
1.4.24. modify-server
Dynamically modifies a server.
-
Alias
serverconf, serverconfig, modify-server-template
-
Usage
modify-server <server-name> [-removelogdir,--removeLogHomeDirectory] [-node,--nodeName <node-name>] [-jvm,--jvmOptions <jvm-options>] [-logdir,--logHomeDirectory <server-log-home-directory>] [-a,--actionOnResourceLeak <action-on-resource-leak>] [-l,--logStdoutToRawFormat <true | false>] [-m,--mejb <true | false>] [-c,--classFtp <true | false>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [<server-name>]
Server name.
[-removelogdir, --removeLogHomeDirectory]
Option to delete the log directory that contains logs created by the server.
[-node,--nodeName <node-name>]
Node name of the machine on which the server is running.
[-jvm,--jvmOptions <jvm-options>]
JVM options that apply to the server.
If the option contains whitespace, wrap the option with double quotes (" ").
[-logdir,--logHomeDirectory <server-log-home-directory>]
Log directory in which logs created by the server are located.
[-a,--actionOnResourceLeak <action-on-resource-leak>]
Action to take when a resource leak occurs.
Input options:
-
AutoClose
-
NoAction
-
Warning
[-l,--logStdoutToRawFormat <true | false>]
[Dynamic] Option to print stdout as is or in JEUS logger format. (true | false)
[-m,--mejb <true |false>]
[Dynamic] Option to use MEJB. (true | false)
[-c,--classFtp <true | false>]
[Dynamic] Option to use the FTP service class. (true | false)
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
-
Example
[MASTER]domain1.adminServer>modify-server server1 -a AutoClose -l false Successfully performed the MODIFY operation for server (server1). Check the results using "list-servers server1 or modify-server server1"
1.4.25. modify-dynamic-servers
Modifies the configurations of a cluster created with dynamically configured servers.
-
Alias
modifydservers
-
Usage
modify-dynamic-servers <cluster-name> [-count <the-number-of-dynamic-servers>] [-nodes,--nodeNames <node-names>] [-prefix,--serverNamePrefix <server-name-prefix>] [-template,--serverTemplateName <server-template-name>] [-step,--listenPortStep <listen-port-step>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description <cluster-name>
Name of a cluster that will modify the configurations of dynamically configured servers.
[-count <the-number-of-dynamic-servers>]
Number of servers to be included in the cluster.
[-nodes,--nodeNames <node-names>]
Names of nodes where servers are located.
Multiple nodes can be specified by using a comma (,) delimiter. To target all nodes, use this option without an argument.
[-prefix,--serverNamePrefix <server-name-prefix>]
Prefix to be added to a server name.
If not set, 'server' is preceded by a cluster name.
[-template,--serverTemplateName <server-template-name>]
Template to be applied to dynamic servers.
[-step,--listenPortStep <listen-port-step>]
Number to be incremented in the port number of the servers created in the same node.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>modify-dynamic-servers cluster1 -count 3 Successfully performed the MODIFY operation for Dynamic servers configuration in the cluster (cluster1). Check the results using "modify-dynamic-servers or show-dynamic-servers".
1.4.26. pack-domain
Packs a domain directory for recovery by using domain backup.
-
Alias
packdomain
-
Usage
pack-domain <domain-name> [-p <dir-path>] -
Parameters
Parameter Description <domain-name>
Domain name.
[-p <dir-path>]
Path to the packed file.
(Default value: JEUS_HOME/backups/<domain-name>_packed.zip)
-
Example
offline>pack-domain domain1 Packing the domain [domain1] configuration completed successfully at the path [JEUS_HOME/backups/domain1_packed.zip].
1.4.27. remove-cluster
Dynamically deletes a cluster.
-
Usage
remove-cluster [<cluster-name>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [<cluster-name>]
Cluster name.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
-
Checking the current clusters
[MASTER]domain1.adminServer>list-clusters List of Clusters =================================================================== +----------+------------------------+-------+-----------+---------+ | Cluster | Server List | MEJB | Class FTP | Running | +----------+------------------------+-------+-----------+---------+ | cluster1 | server1, server2 | false | false | true | +----------+------------------------+-------+-----------+---------+ | cluster2 | server3, server4 | true | true | true | +----------+------------------------+-------+-----------+---------+ ===================================================================
-
Deleting a cluster after checking the list of clusters
[MASTER]domain1.adminServer>remove-cluster cluster2 Successfully performed the REMOVE operation for cluster (cluster1). Check the results using "list-clusters or remove-cluster"
-
1.4.28. remove-custom-resource
Dynamically deletes a custom resource.
-
Alias
removecr, rmcr
-
Usage
remove-custom-resource [<export-name>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [<export-name>]
JNDI binding name of the custom resource to be deleted.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>remove-custom-resource custom/dog Successfully performed the REMOVE operation for A custom resource. Check the results using "list-custom-resources or remove-custom-resource"
1.4.29. remove-custom-resource-from-clusters
Dynamically deletes a custom resource from clusters.
-
Alias
remove-cr-from-clusters
-
Usage
remove-custom-resource-from-clusters <export-name> -clusters <cluster-list> [-f,--forceLock] [-detail] -
Parameters
Parameter Description <export-name>
JNDI bind name of the customer resource to be deleted from clusters.
-cluster <cluster-list>
Cluster list from which the custom resource is deleted.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>remove-custom-resource-from-clusters custom/dog -clusters cluster1 Successfully performed the REMOVE operation for A custom resource. Check the results using "list-custom-resources"
1.4.30. remove-data-sources-from-cluster
Dynamically deletes data sources registered in a cluster.
-
Alias
rmdsfromcluster
-
Usage
remove-data-sources-from-cluster -cluster <cluster-name> [-ids <data-source-id-list> | -all] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -cluster <cluster-name>
Cluster name from which data sources are deleted.
[-ids <data-source-id-list> ]
List of IDs of data sources to be deleted from the cluster.
To specify multiple IDs, separate each ID with a comma (,).
[ -all]
Deletes all data sources registered with the cluster.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>remove-data-sources-from-cluster -cluster cluster1 -all Successfully performed the REMOVE operation for data sources from the cluster [cluster1]. Check the results using "remove-data-sources-from-cluster -cluster cluster1"
1.4.31. remove-domain-log-config
Deletes the owner and permission setting of log files in the domain.
Even after the setting is deleted, the owner and permission setting of the existing log files are not changed.
-
Alias
rmdomainlog, rmdomainlogcon, rmdomainlogconfig
-
Usage
remove-domain-log-config [-perm,--permission] [-own,--owner] -
Parameters
Parameter Description [-perm,--permission]
Deletes the permission setting of log files in the domain.
[-own,--owner]
Deletes the owner setting of log files in the domain.
-
Example
[MASTER]domain1.adminServer>remove-domain-log-config -own Successfully performed the REMOVE operation for Domain Log file configuration for domain1. Check the results using "show-domain-log-config".
1.4.32. remove-external-resource
Dynamically deletes an external resource.
-
Alias
removecr, rmcr
-
Usage
remove-external-resource [<export-name>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [<export-name>]
External resource name to be deleted.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>remove-external-resource test/ext Successfully performed the REMOVE operation for A external resource. Check the results using "list-external-resources or remove-external-resource"
1.4.33. remove-external-resource-from-clusters
Dynamically deletes an external resource from clusters.
-
Alias
remove-er-from-clusters
-
Usage
remove-external-resource-from-clusters <export-name> -clusters <cluster-list> [-f,--forceLock] [-detail] -
Parameters
Parameter Description <export-name>
External resource name to be deleted from clusters.
-clusters <cluster-list>
Cluster list from which the external resource is deleted.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>remove-external-resource-from-clusters test/ext -clusters cluster1 Successfully performed the REMOVE operation for A external resource. Check the results using "list-external-resources"
1.4.34. remove-server
Dynamically deletes a server.
-
Usage
remove-server [<server-name>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [<server-name>]
Server name.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
-
Checking the list of servers
[MASTER]domain1.adminServer>server-info Information about Domain (domain1) ================================================================================ +--------+--------+-----+-----+-----+----------+-------+-----------+-----------+ | Server | Status |Node | PID | Clu | Latest | Need | Listen | Running | | | |Name | |ster | Start | to | Ports | Engines | | | | | | | Time / |Restart| | | | | | | | | Shutdown | | | | | | | | | | Time | | | | +--------+--------+-----+-----+-----+----------+-------+-----------+-----------+ | adminS | RUNNIN | nod | 237 | N/A | 2021-03- | false | base-0.0. | jms, web, | |erver |G(00:46 |e1 |60 | |25 (Thu) | |0.0:9736 |ejb | |(*) |:06) | | | |PM | | http-serv | | | | | | | |01:13:48 | |er-0.0.0.0 | | | | | | | |KST | |:8088 | | +--------+--------+-----+-----+-----+----------+-------+-----------+-----------+ | server | RUNNIN | nod | 132 | N/A | 2021-03- | false | base-0.0. | jms, web, | |1 |G(00:02 |e1 |75 | |25 (Thu) | |0.0:9836 |ejb | | |:45) | | | |PM | | | | | | | | | |01:13:48 | | | | | | | | | |KST | | | | +--------+--------+-----+-----+-----+----------+-------+-----------+-----------+ | server | SHUTDO | nod | N/A | N/A | N/A | N/A | N/A | N/A | |2 |WN |e1 | | | | | | | +--------+--------+-----+-----+-----+----------+-------+-----------+-----------+ ================================================================================
-
Deleting a server after checking if the server terminated
[MASTER]domain1.adminServer>remove-server server2 Successfully performed the REMOVE operation for server (server1). Check the results using "list-servers or remove-server"
-
1.4.35. remove-servers-from-cluster
Dynamically deletes servers from a cluster.
-
Usage
remove-servers-from-cluster <cluster-name> [-servers <server-lists>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description <cluster-name>
Cluster name.
[-servers <server-lists>]
Name of the server(s) to be deleted from the cluster.
To specify multiple servers, separate each server with a comma (,).
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>remove-servers-from-cluster cluster1 -servers server1 Successfully performed the REMOVE operation for The server list for cluster(cluster1).. Check the results using "list-clusters cluster1 or remove-servers-from-cluster cluster1"
1.4.36. set-domain-log-config
Sets the owner and permission of log files in the domain. This setting is applied if the log file owner and permission are not specified in the logger settings for servers in the domain.
However, the owner and permission setting in the logger overrides this setting.
-
Alias
setdomainlog, setdomainlogcon, setdomainlogconfig
-
Usage
set-domain-log-config [-perm,--permission <permission>] [-own,--owner <chown>] -
Parameters
Parameter Description [-perm,--permission <permission>]
Sets the permission of log files in the domain in the rwxrw-r-- format. This setting is available only in a POSIX-compatible OS.
[-own,--owner <chown>]
Sets the owner of log files in the domain in the 'owner name, group' format.
If only one of them is specified, enter 'owner name' or ',group'
-
Example
[MASTER]domain1.adminServer>set-domain-log-config -own user,tmax Successfully performed the MODIFY operation for Domain Log file configuration for domain1, but all changes were non-dynamic. They will be applied after restarting. Check the results using "show-domain-log-config or set-domain-log-config". [MASTER]domain1.adminServer>set-domain-log-config -own ,tmax -perm rwxrwxrwx Successfully performed the MODIFY operation for Domain Log file configuration for domain1, but all changes were non-dynamic. They will be applied after restarting. Check the results using "show-domain-log-config or set-domain-log-config".
1.4.37. show-domain-log-config
Displays the owner and permission configuration of log files in the domain.
-
Alias
showdomainlog, showdomainlogcon, showdomainlogconfig
-
Usage
show-domain-log-config
-
Example
[MASTER]domain1.adminServer>show-domain-log-config Shows the current configuration. Domain Log file configuration for domain1 ===================================================================== +-------------------------------------------------------+-----------+ | Domain Log file permission | (not set) | | Domain Log file owner | (not set) | +-------------------------------------------------------+-----------+ =====================================================================
1.4.38. show-dynamic-servers
Displays the configurations of a cluster created with dynamically configured servers.
-
Alias
showdservers
-
Usage
show-dynamic-servers <cluster-name>
-
Parameters
Parameter Description <cluster-name>
Name of a cluster whose configurations will be displayed.
-
Example
[MASTER]domain1.adminServer>show-dynamic-servers cluster1 Shows the current configuration. Dynamic servers configuration in the cluster (cluster1) ==================================================================== +----------------------------------------------------------+-------+ | Server Count | 2 | | Nodes | node1 | | Base Listen Port | 9736 | | HTTP Listen Port | 8088 | | JMS Listen Port | 9741 | | Server Template Name | temp1 | | Listen Port Step | 100 | +----------------------------------------------------------+-------+ ====================================================================
1.4.39. show-server-template
Displays the configurations of a server template.
-
Alias
show-template
-
Usage
show-server-template [<server-template-name>]
-
Parameters
Parameter Description [<server-template-name>]
Name of a server template whose configurations will be displayed.
-
Example
offline>show-server-template temp1 Shows the current configuration. server template (temp1) ===================================================================== +---------------------------------------------------------+---------+ | Action On Resource Leak | WARNING | | Stdout to Raw Format | true | | MEJB | false | | Class FTP | false | | Server Log Home Directory | none | +---------------------------------------------------------+---------+ =====================================================================
1.4.40. unpack-domain
Unpacks the files packed by the pack-domain command when a server has a failure. The address and port number of the JEUS Master Server can be changed if they are set or the JEUS Master Server’s node name is set in the domain configuration.
-
Alias
unpackdomain
-
Usage
unpack-domain -p <file-path> | <domain-name> [-delete] [-overwrite] [-masterurl <master-url>] [-nodename <node-name>] -
Parameters
Parameter Description -p <file-path>
Path to the packed file.
(Example: JEUS_HOME/<domain-name>_packed.zip)
<domain-name>
Domain name of the file to unpack.
The file to unpack must be in the JEUS_HOME/backups directory.
[-delete]
If the name of the domain to be unpacked already exists in DOMAIN_HOME, the domain will be deleted and then the unpack will be executed.
[-overwrite]
If the name of the domain to be unpacked already exists in DOMAIN_HOME, the existing domain will be overwritten by the domain to be unpacked.
[-masterurl <master-url>]
URL of JEUS Master Server to be configured in the domain.xml file.
[-nodename <node-name>]
Name of a node to be configured in the domain.xml.file.
-
Example
offline>unpack-domain domain1 The JEUS Master Server listener address is already set to [192.168.34.55]. Do you want to change it? (y/n): y Enter the JEUS Master Server base listener address: 192.168.34.56 The JEUS Master Server listener port is already set to [9736]. Do you want to change it? (y/n): n The JEUS Master Server nodename is already set to [node1]. Do you want to change it? (y/n): y Enter the JEUS Master Server nodename: node2 Unpacking the domain [domain1] configuration completed successfully.
1.5. Thread Management Commands
The following is a list of thread management commands.
| Command | Description |
|---|---|
Sends an interrupt signal to a servlet or an EJB RMI thread. |
|
Dynamically changes the thread pool dedicated to a server. |
|
Dynamically changes the system thread pool. |
|
Displays stack traces of a servlet thread or an EJB RMI thread. |
|
Displays information about a service thread pool that uses the system thread pool of a server. |
|
Displays the system thread pool information of a server. |
|
Displays information about servlet threads or EJB RMI threads that handle requests. |
1.5.1. interrupt-thread
Sends an interrupt signal to a servlet or an EJB RMI thread. For more information about the result of sending an interrupt signal to a thread, refer to Thread monitoring and control in JEUS Server Guide.
|
This function only sends an interrupt signal. It does not guarantee that the thread stops its operation. |
-
Alias
interruptthread, interrupt, intthread
-
Usage
interrupt-thread [-server <server-name>] -ctx <web-context-name> | -wc <Web Connection Name> | <thread-id> [-svg <Service Group Name>] -
Parameters
Parameter Description [-server <server-name>]
Server name.
-ctx <web-context-name> | -wc <web-connection-name> | <thread-id>
-
-ctx <web-context-name>: If the thread pool that will be interrupted is at the context level, the context name is set as an argument.
-
-wc: If the thread pool that will be interrupted is at the web-connction level, the web-connection name is set as an argument.
-
<thread-id>: ID of the thread to which the signal is sent.
-svg <Service Group Name>
Name of the thread pool at the context level. Only available when the -ctx option is specified. If not, all thread pools at the context level are interrupted.
-
-
Example
[MASTER]domain1.adminServer>interrupt-thread -server server1 50 Sent an interrupt hint signal to the thread [tid=50] on the server server1.
1.5.2. modify-service-thread-pool
Dynamically changes the thread pool dedicated to a server. This command applies only for the naming server, scheduler, and the transaction thread pool that use the current integrated configuration. If the configuration is unspecified, this command displays the current configuration.
-
Alias
modify-svctp, modifysvctp, svctpconfig, svctpconf
-
Usage
modify-service-thread-pool -service <service name> <server-name> [-min <min>] [-max <max>] [-k,--keepalivetime <keep-alive-time>] [-q,--queuesize <queue-size>] [-m,--maxstuckthreadtime <max-stuck-thread-time>] [-a,--actiononstuckthread <action-on-stuck-thread>] [-stcp,--stuckthreadcheckperiod <stuck-thread-check-period>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -service <service name>
Service name that uses the system thread pool.
Input options:
-
transaction
-
scheduler
-
namingserver
<server-name>
Server name.
[-min <min>]
[Dynamic] Minimum number of threads in the thread pool.
[-max <max>]
[Dynamic] Maximum number of threads in the thread pool.
[-k,--keepalivetime <keep-alive-time>]
[Dynamic] If the number of threads is greater than the minimum number, threads idle for a specified period of time are deleted.
[-q,--queuesize <queue-size>]
Maximum number of worker threads in a queue.
[-m,--maxstuckthreadtime <max-stuck-thread-time>]
[Dynamic] Determines a thread to be in the STUCK state if the execution time of the thread exceeds the specified period.
[-a,--actiononstuckthread <action-on-stuck-thread>]
[Dynamic] Method for handling threads in the STUCK state.
Input options:
-
IgnoreAndReplace
-
Interrupt
-
None
[-stcp,--stuckthreadcheckperiod <stuck-thread-check-period>]
[Dynamic] Sets the interval at which to check threads in the STUCK state. (Unit: ms)
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
-
Example
88% [MASTER]domain1.adminServer>modify-service-thread-pool server1 -service transaction -min 10 -max 20 Successfully performed the MODIFY operation for The transaction thread pool of the server (server1)., but all changes were non-dynamic. They will be applied after restarting. Check the results using "show-service-thread-pool server1 -service transaction or modify-service-thread-pool server1 -service transaction"
1.5.3. modify-system-thread-pool
Dynamically changes the system thread pool. This command can modify the number of threads allocated to services that use the system thread pool.
-
Alias
modify-systp, modifysystp, systpconfig, systpconf
-
Usage
modify-system-thread-pool <server-name> [-min <min>] [-max <max>] [-k,--keepalivetime <keep-alive-time>] [-q,--queuesize <queue-size>] [-m,--maxstuckthreadtime <max-stuck-thread-time>] [-a,--actiononstuckthread <action-on-stuck-thread>] [-stcp,--stuckthreadcheckperiod <stuck-thread-check-period>] [-service <service-name>] [-r,--reservednum <reserved-number>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description <server-name>
Server name.
[-min <min>]
[Dynamic] Minimum number of threads in the thread pool.
[-max <max>]
[Dynamic] Maximum number of threads in the thread pool.
[-k,--keepalivetime <keep-alive-time>]
[Dynamic] If the number of threads is greater than the minimum number, threads remaining idle for a specified period of time are deleted.
[-q,--queuesize <queue-size>]
Maximum number of worker threads in a queue.
[-m,--maxstuckthreadtime <max-stuck-thread-time>]
[Dynamic] Determines a thread to be in the STUCK state if the execution time of the thread exceeds the specified period.
[-a,--actiononstuckthread <action-on-stuck-thread>]
[Dynamic] Method for handling threads in the STUCK state.
Input options:
-
IgnoreAndReplace
-
Interrupt
-
None
[-stcp,--stuckthreadcheckperiod <stuck-thread-check-period>]
[Dynamic] Sets the interval at which to check threads in the STUCK state. (Unit: ms)
[-service <service-name>]
Service name that uses the system thread pool.
Input options:
-
transaction
-
scheduler
-
namingserver
[-r,--reservednum <reserved-number>]
[Dynamic] Minimum number of threads allocated to services that use the system thread pool.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
-
Example
85% [MASTER]domain1.adminServer>modify-system-thread-pool server1 -min 10 -max 60 -service transaction -reservednum 20 -detail Successfully performed the MODIFY operation for the system thread pool of the server (server1). ================================================================================ +-----------------------------------------------------------+-------+----------+ | servers.server.{? name == 'server1' }.systemThreadPool | MODIFY| ACTIVATED| | servers.server.{? name == 'server1' }.tmConfig | MODIFY| ACTIVATED| +-----------------------------------------------------------+-------+----------+ ================================================================================ Check the results using "modify-system-thread-pool server1 or show-system-thread -pool server1" ------------------details------------------- servers.server.{? name == 'server1' }.tmConfig : ACTIVATED servers.server.{? name == 'server1' }.tmConfig.pooling : ACTIVATED servers.server.{? name == 'server1' }.tmConfig.pooling.shared : ACTIVATED servers.server.{? name == 'server1' }.tmConfig.pooling.shared.reservedThreadNum : ACTIVATED previous value : 0, edited value : 20, result value : 20 servers.server.{? name == 'server1' }.systemThreadPool : ACTIVATED servers.server.{? name == 'server1' }.systemThreadPool.min : ACTIVATED previous value : 0, edited value : 10, result value : 10 servers.server.{? name == 'server1' }.systemThreadPool.max : ACTIVATED previous value : 100, edited value : 60, result value : 60
1.5.4. print-stack-trace
Displays stack traces of a servlet thread or an EJB RMI thread.
-
Alias
stacktrace, strace
-
Usage
print-stack-trace [-server <server-name>] -ctx <web-context-name> | -wc <Web Connection Name> | <thread-id> [-svg <Service Group Name>] -
Parameters
Parameter Description [-server <server-name>]
Server name.
-ctx <web-context-name> | -wc <web-connection-name> | <thread-id>
-
-ctx <web-context-name>: If the thread pool is at the context level when it displays stack traces, the context name is set as an argument.
-
-wc: If the thread pool is at the web-connction level when it displays stack traces, the web-connection name is set as an argument.
-
<thread-id>: Thread ID.
-svg <Service Group Name>
Name of the thread pool at the context level. Only available when the -ctx option is specified. If not, stack traces of all thread pools at the context level are displayed.
-
-
Example
[MASTER]domain1.adminServer>print-stack-trace -server server1 50 servlet thread [tid=50] Stack trace of http1-1 [server1-50] tid=50 java.lang.Thread.State: WAITING at sun.misc.Unsafe.park(Native Method) at java.util.concurrent.locks.LockSupport.park(LockSupport.java:156) at java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject.await(AbstractQueuedSynchronizer.java:1987) at java.util.concurrent.LinkedBlockingQueue.take(LinkedBlockingQueue.java:399) at jeus.util.ThreadPoolExecutor.getTask(ThreadPoolExecutor.java:1291) at jeus.servlet.engine.WebThreadPoolExecutor.getTask(WebThreadPoolExecutor.java:68) at jeus.util.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:1215) at jeus.servlet.engine.WebThreadPoolExecutor$WebRequestWorker.run(WebThreadPoolExecutor.java:332) at java.lang.Thread.run(Thread.java:662)
1.5.5. show-service-thread-pool
Displays the system thread pool information of a server.
-
Alias
show-svctp, showsvctp
-
Usage
show-service-thread-pool <server-name> -service <service-name> -
Parameters
Parameter Description <server-name>
Server name.
-service <service-name>
Service name.
Input options:
-
transaction
-
scheduler
-
namingserver
-
-
Example
[MASTER]domain1.adminServer>show-service-thread-pool server1 -service transaction Shows the current configuration. ===================================================================== +----------------------------------------------------------+--------+ | Min | 10 | | Max | 20 | | Keep-Alive Time | 60000 | | Queue Size | 4096 | | Max Stuck Thread Time | 3600000| | Action On Stuck Thread | NONE | | Stuck Thread Check Period | 300000 | +----------------------------------------------------------+--------+ =====================================================================
1.5.6. show-system-thread-pool
Displays the system thread pool information of a server.
-
Alias
show-systp, showsystp
-
Usage
show-system-thread-pool <server-name> [-service <service-name>] -
Parameters
Parameter Description <server-name>
Server name.
[-service <service-name>]
Service name.
Input options:
-
transaction
-
scheduler
-
namingserver
-
-
Example
[MASTER]domain1.adminServer>show-system-thread-pool server1 Shows the current configuration. the system thread pool of the server (server1). ====================================================================== +------------------------------------------------------------+-------+ | Min | 10 | | Max | 60 | | Keep-Alive Time | 300000| | Queue Size | 4096 | | Max Stuck Thread Time | 0 | | Action On Stuck Thread | NONE | | Stuck Thread Check Period | 300000| | Reserved Threads for the Service transaction | 0 | +------------------------------------------------------------+-------+ ======================================================================
1.5.7. thread-info
Displays information about servlet threads or EJB RMI threads that handle requests and about other JEUS thread pools.
For servlets, information about the listener’s thread pool and each worker thread can be checked. For EJB, information about EJB RMI threads that handle remote requests can be checked. From the server, information about server thread pools can be basically checked, and information about all pools can be checked as well depending on the selected option. For batch applications, the information of configured thread pool can be checked.
-
Alias
threadinfo, ti
-
Usage
thread-info -server <server-name> [-type <thread-type>] [-wc <web-connection-name> | -ctx <web-context-name>] [-r,--request | -a,--all] [-s <thread-state>] [-os,--only-stats] [-st,--stacktrace] -
Parameters
Parameter Description -server <server-name>
Server name.
[-type <thread-type>]
Input options:
-
servlet : Servlet Thread
-
ejb : EJB RMI Thread
-
jms : JMS Thread
-
server : Server Thread Pool
-
batch: Thread pool used in the batch application
If the -ctx option is specified, enter the following values.
-
context: Context Thread Pool
-
webasync: Thread pool for servlet 3.0 async processing
-
upgrade: Thread pool for Async Send of WebSocket Container or HTTP Upgrade NIO Servlet
[-wc <web-connection-name> | -ctx <context-name>]
Specifies a web connection or web context. If a web connection is specified, its thread pool information is displayed. If a web context is specified, a desired thread pool can be specified. For no option specified, all information of Context, WebAsync, and WebSocket Thread Pool is displayed.
[-r,--request | -a,--all]
-
-r: Checks only the request information of the servlet thread. Valid only for servlet threads.
-
-a: For servlets, checks the information of all servlet threads. For servers, checks the information about all thread pools within JEUS.
[-s <thread-state>]
To search for threads in a specific state, enter the state.
-
active
-
idle
-
blocked
-
reconn
[-os,--only-stats]
Servlet only displays statistical information by listener. Server displays only statistical information of pools.
[-st,--stacktrace]
Searches the traces of all active threads (thread currently running for actual tasks) that belong to the pools searched by the server. This option only applies to servers.
-
-
Example
[MASTER]domain1.adminServer>thread-info -server server1 Thread information for the server [server1] There are no EJB RMI threads for the server [server1]. There is no batch thread pool in server [server1]. ============================================================= The web engine threads for 'ADMIN-HTTP'. +----+------------------------------+--------+---------+----+ | tid| name | state | elapsed | uri| +----+------------------------------+--------+---------+----+ | 45 | ADMIN-HTTP-w00 | waiting| 48521870| | +----+------------------------------+--------+---------+----+ elsapsed: Elapsed time (ms) ============================================================= =================================================================== Thread statistics for the 'ADMIN-HTTP'. +---------------------------+------+-------+-----+--------+-------+ | | total| active| idle| blocked| reconn| +---------------------------+------+-------+-----+--------+-------+ | The number of threads. | 1 | 0 | 1 | 0 | 0 | +---------------------------+------+-------+-----+--------+-------+ total = active + idle, reconn: reconnecting =================================================================== ===================================================== The web engine threads for 'http1'. +------+--------------------+--------+---------+----+ | tid | name | state | elapsed | uri| +------+--------------------+--------+---------+----+ | 46 | http1-w00 | waiting| 48521873| | | 47 | http1-w01 | waiting| 48521868| | | 48 | http1-w02 | waiting| 48521868| | | 49 | http1-w03 | waiting| 48521868| | | 51 | http1-w05 | waiting| 48521862| | | 52 | http1-w06 | waiting| 48521858| | | 53 | http1-w07 | waiting| 48521858| | | 54 | http1-w08 | waiting| 48521857| | | 55 | http1-w09 | waiting| 48521857| | | 21203| http1-w10 | waiting| 37629 | | +------+--------------------+--------+---------+----+ elsapsed: Elapsed time (ms) ===================================================== =================================================================== Thread statistics for the 'http1'. +---------------------------+------+-------+-----+--------+-------+ | | total| active| idle| blocked| reconn| +---------------------------+------+-------+-----+--------+-------+ | The number of threads. | 10 | 0 | 10 | 0 | 0 | +---------------------------+------+-------+-----+--------+-------+ total = active + idle, reconn: reconnecting =================================================================== ====================================================================== The threads for the 'threadpool.System' thread pool. +-----+------------------------------+---------------+---------------+ | tid | name | thread state | active thread | +-----+------------------------------+---------------+---------------+ | 93 | threadpool.System-2 | TIMED_WAITING | false | | 92 | threadpool.System-1 | TIMED_WAITING | false | | 94 | JMXMP [adminServer-94] | RUNNABLE | true | +-----+------------------------------+---------------+---------------+ ====================================================================== ================================================================================ The statistics for the 'threadpool.System' thread pool. +-----------+-----------+-----------+-----------+----------+-------------------+ | pool name | minimum | maximum | current | work | remaining work | | | pool size | pool size | pool size |queue size| queue size | +-----------+-----------+-----------+-----------+----------+-------------------+ | threadpool| 0 | 100 | 3 | 4096 | 4096 | |.System | | | | | | +-----------+-----------+-----------+-----------+----------+-------------------+ ================================================================================ ========================================================== The threads for the 'chunk_checkpoint' thread pool. +-----+------+--------------+----------------------------+ | tid | name | thread state | active thread | +-----+------+--------------+----------------------------+ (No data available) ========================================================== ================================================================================ The statistics for the 'chunk_checkpoint' thread pool. +-----------+-----------+-----------+-----------+----------+-------------------+ | pool name | minimum | maximum | current | work | remaining work | | | pool size | pool size | pool size |queue size| queue size | +-----------+-----------+-----------+-----------+----------+-------------------+ | chunk_che | 0 | 10 | 0 | 4096 | 4096 | |ckpoint | | | | | | +-----------+-----------+-----------+-----------+----------+-------------------+ ================================================================================
1.6. Application Commands
The following is a list of application commands.
| Command | Description |
|---|---|
Adds a new application repository. |
|
Adds a server or cluster as a target of a deployed application. Deploys the application to a server or cluster. Only available for the JEUS Master Server and Managed Server structure. |
|
Displays information about applications in the domain. |
|
Deploys an installed application to the target servers. If deployment fails on a single server, application are undeployed from all successful servers. |
|
Deploys a library to a server or cluster. |
|
Displays the information of an installed deployment plan. |
|
Distributes an installed application to each server or cluster. In order to run the service, the application must be started using the start-application command. |
|
Installs an application. The application ID can be set. |
|
Installs a deployment plan. At this time, the deployment plan identifier can be defined. |
|
Installs a library file in a domain. |
|
Displays information about the libraries that are installed and deployed in a current domain. |
|
Displays the information of registered application repositories. |
|
Redeploys an application. |
|
Deletes an registered application repository. |
|
Deletes an application deployed or distributed on a server or cluster from the server or cluster. Only available for the JEUS Master Server and Managed Server structure. |
|
Starts the deployed application. |
|
Suspends a running application. |
|
Undeploys a deployed application. |
|
Deletes an installed application. |
|
Deletes an installed deployment plan. |
|
Undeploys a library deployed in a server or cluster. |
|
Uninstalls a library file from a domain. |
1.6.1. add-application-repository
Adds a new application repository to the domain.
-
Alias
addapprepo, installapps
-
Usage
add-application-repository [<application-repository-path>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [<application-repository-path>]
Absolute path to the application repository to be added.
[-f, --forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed information.
-
Example
[MASTER]domain1.adminServer>add-application-repository /home/user1/apps Successfully performed the ADD operation for An application repository. Check the results using "add-application-repository or list-application-repositories"
1.6.2. add-application-target
Adds a server or cluster as a target of a deployed application. Deploys the application to a server or cluster. This command can only be used when the application is in the DEPLOYED, DISTRIBUTED, or RUNNING state. Only available for the JEUS Master Server and Managed Server structure.
-
Alias
addapptarget, addtarget
-
Usage
add-application-target <application-id> [-servers <server-list>] [-clusters <cluster-list>] [-vh,--virtualHost <virtual-host>] -
Parameters
Parameter Description <application-id>
ID of the application to which the target is added.
Use only when the application is in the DEPLOYED, DISTRIBUTED, or RUNNING states.
[-servers <server-list>]
Names of the servers to which the application is added. To specify multiple servers, separate each server with a comma (,).
[-clusters <cluster-list>]
Names of the clusters to which the application is added. To specify multiple clusters, separate each cluster with a comma (,).
[-vh,--virtualHost <virtual-host>]
Virtual host name.
-
Example
[MASTER]domain1.adminServer>add-application-target myApp -servers server1 add a target server or cluster to the application for the application [deployment_helloear] succeeded.
1.6.3. application-info
Displays information about applications in the domain.
-
Alias
appinfo, list-applications
-
Usage
application-info [-server <server-name>] [-id <application-id> | -state <application-state>] [-type <application-type>] [-module <module-name>] [-bean <bean-name>] [-jndi <jndi-context>] [-mod <jndi-module-name>] [-comp <jndi-component-name>] [-detail,--detail] [-sps,--stateperserver] -
Parameters
Parameter Description [-server <server-name>]
Name of the server in which the application information is displayed in detail.
[-id,--applicationId <application-id>]
Application ID.
[-state <application-state>]
Displays information about applications in the specified state.
[-type <application-type>]
Displays information about applications of the specified type.
Input options:
-
EAR
-
EJB
-
WAR
-
CAR
-
RAR
[-module <module-name>]
Displays the module information of EAR.
[-bean <bean-name>]
Displays detailed information about an EJB Bean.
Server, ID, and module information are required.
[-jndi <jndi-context>]
Displays the JNDI information about an application.
Server and ID information are required.
[-mod <jndi-module-name>]
Displays the JNDI namespace of a module.
[-comp <jndi-component-name>]
Displays the namespace of a component.
[-detail,--detail]
Displays detailed information about a stand-alone module.
For a web module, lists of servlets, filters, listeners, WebSocket Server Endpoints, and EJB Bean (EJB in a .war) are displayed.
[-sps,--stateperserver]
Displays the server status for each application.
Servers without a status (e.g. server down) are displayed as 'NO_STATE'.
-
-
Example
-
A basic example.
The following is the result.
[MASTER]domain1.adminServer>application-info Application information for the domain [domain1]. ================================================================================ +----------+-----------+---------+-------------+----------+--------------------+ | Applicat | Applicati | State | Target | Target | Application Path | | ion ID | on Type | | Servers | Clusters | | +----------+-----------+---------+-------------+----------+--------------------+ | myApp | EAR | RUNNING | adminServer | | ${INSTALL_HOME}/my | | | | | | |App/myApp.ear | +----------+-----------+---------+-------------+----------+--------------------+ | myEJB | EJB | RUNNING | | cluster1 | ${INSTALL_HOME}/my | | | | | | |EJB/myEJB.jar | +----------+-----------+---------+-------------+----------+--------------------+ | myWeb | WAR | RUNNING | server1,adm | | ${INSTALL_HOME}/my | | | | |inServer | |Web/myWeb.war | +----------+-----------+---------+-------------+----------+--------------------+ ================================================================================ -
An example where the stateperserver option is used.
The server status for each application is displayed. Servers without a status are displayed as 'NO_STATE'.
[MASTER]domain1.adminServer>application-info -sps Application information for the domain [domain1]. ================================================================================ +----------+-----------+---------+-------------+----------+--------------------+ | Applicat | Applicati | State | Target | Target | Application Path | | ion ID | on Type | | Servers | Clusters | | +----------+-----------+---------+-------------+----------+--------------------+ | myApp | EAR | RUNNING | adminServer | | ${INSTALL_HOME}/my | | | | | | |App/myApp.ear | +----------+-----------+---------+-------------+----------+--------------------+ | myEJB | EJB | RUNNING | | cluster1 | ${INSTALL_HOME}/my | | | | | | |EJB/myEJB.jar | +----------+-----------+---------+-------------+----------+--------------------+ | myWeb | WAR | RUNNING | server1,adm | | ${INSTALL_HOME}/my | | | | |inServer | |Web/myWeb.war | +----------+-----------+---------+-------------+----------+--------------------+ ================================================================================ Server-specific state information for each application in the domain [domain1] ================================================================================ +-----------+-------------+----------+---------+----------+--------------------+ | Applicati | Application | State | Server | Cluster | Application Path | | on ID | Type | | | | | +-----------+-------------+----------+---------+----------+--------------------+ | myApp | EAR | RUNNING | adminSe | | ${INSTALL_HOME}/my | | | | |rver | |App/myApp.ear | +-----------+-------------+----------+---------+----------+--------------------+ | myEJB | EJB | RUNNING | server2 | cluster1 | ${INSTALL_HOME}/my | | | | | | |EJB/myEJB.jar | +-----------+-------------+----------+---------+----------+--------------------+ | myEJB | EJB | NO STATE | server3 | cluster1 | ${INSTALL_HOME}/my | | | | | | |EJB/myEJB.jar | +-----------+-------------+----------+---------+----------+--------------------+ | myWeb | WAR | NO STATE | server1 | | ${INSTALL_HOME}/my | | | | | | |Web/myWeb.war | +-----------+-------------+----------+---------+----------+--------------------+ | myWeb | WAR | RUNNING | adminSe | | ${INSTALL_HOME}/my | | | | |rver | |Web/myWeb.war | +-----------+-------------+----------+---------+----------+--------------------+ ================================================================================
-
1.6.4. deploy-application
Deploys an installed application to the target servers. If deployment fails on a single server, application are undeployed from all successful servers.
-
Alias
deployapp, deploy
-
Usage
deploy-application [<application-id>] [-path,--applicationPath <path>] [-servers <server-list>] [-clusters <cluster-list>] [-all] [-exmaster,--excludeMaster] [-vh,--virtualHost <virtual-host>] [-svh,--systemVirtualHost] [-type,--applicationType <application-type>] [-cl,--classloading <classloading-mode>] [-auto,--autoRedeployCheckInterval <auto-redeploy-check-interval>] [-security,--securityDomainName <security-domain-name>] [-fast,--fastDeploy] [-keep,--keepGenerated] [-shared,--sharedDisk] [-u,--upgrade] [-plan,--deploymentPlanName <deployment-plan-name>] [-ctxp,--contextPath <context-path>] [-staging] [-lib,--libraryId <library-IDs>] [-version,--libraryVersion <library-versions>] [-con,--concurrent] [-thn <thread-pool-name>] [-tmin <thread-pool-min>] [-tmax <thread-pool-max>] [-tidle <thread-pool-maxIdleTimeout>] [-qs <thread-pool-maxQueueCount>] [-b <thread-pool base> | -uri <thread-pool-uri>] [-jwdp <jeus-web-dd.xml path>] [-wp <web.xml path>] [-ss,--sessionScope <scope-name>] -
Parameters
Parameter Description [<application-id>]
Application ID entered when the application was installed. To specify multiple application IDs, separate each ID with a comma (,). An ID can be given to an application when a file path is used for distribution. When using a file path, only one ID and one path can be entered.
[-path,--applicationPath <path>]
Path to application files. This option can be used when using the file path without installing the application. This is possible only when the files are in the same machine as JEUS Master Server.
[-servers <server-list>]
Names of the servers to which the application is to be deployed. To specify multiple servers, separate each server with a comma (,).
[-clusters <cluster-list>]
Names of the clusters to which the application is to be deployed. To specify multiple clusters, separate each cluster with a comma (,).
[-all]
Deploys to all the servers in the domain.
[-exmaster,--excludeMaster]
Excludes the JEUS Master Server from the list of servers to which applications are deployed when the 'all' option is used.
[-vh,--virtualHost <virtual-host>]
Virtual host address. A virtual host name defined in the web engine can be selected. This option only operates in a web module.
[-svh,--systemVirtualHost]
Deploys an application to a system virtual host.
[-type,--applicationType <application-type>]
Sets the application type.
Input options:
-
EAR
-
EJB
-
WAR
-
CAR
-
RAR
If not specified, this option can be set automatically through DD or annotation.
[-cl,--classloading <classloading-mode>]
Sets the class loading type.
Input options:
-
SHARED
-
ISOLATED (Default value)
[-auto,--autoRedeployCheckInterval <auto-redeploy-check-interval>]
Interval at which to check for automatic application redeployment.
(Unit: ms)
[-security,--securityDomainName <security-domain-name>]
Security domain name to be applied to the application.
By default, the value set in default-application-domain of the domain configuration is used.
[-fast,--fastDeploy]
Option to use previously created files (if any exists) to speed up the deployment process.
[-keep,--keepGenerated]
Option to keep the files generated during deployment.
[-shared,--sharedDisk]
Uses NAS to avoid copying the application file.
[-u,--upgrade]
Changes the DD format of JEUS 6 or earlier to make it compatible with the current version before deploying an application that has not been installed.
[-plan,-deploymentPlanName <deployment-plan-name>]
Sets the deployment plan file name.
[-ctxp,--contextPath <context-path>]
Sets the context for web applications.
[-staging]
Compresses applications in an exploded module type to send to other machines.
[-lib,--libraryId <library-IDs>]
Library to be referenced by applications. Multiple libraries can be specified by using a comma (,) delimiter.
[-version,--libraryVersion <library-versions>]
Version of the library to be referenced. Multiple libraries can be specified by using a comma (,) delimiter.
[-con, --concurrent]
Option to deploy multiple applications concurrently.
[-thn <thread-pool name>]
Name of a thread pool that will process application-related requests. One context thread pool can be set with the command. For this parameter, -tmin and -tmax options are required.
[-tmin <thread-pool min>]
Minimum number of worker threads maintained in a context thread pool.
[-tmax <thread-pool max>]
Maximum number of worker threads maintained in a context thread pool.
[-tidle <thread-pool max-idle-time>]
Maximum time during which a worker thread is in the idle state before removed from a context thread pool.
[-qs <thread-pool max-queue>]
Maximum requests that can wait in a queue in a context thread pool.
[-b <thread-pool base> | -uri <thread-pool uri>]
Option to identify whether a thread pool to add is a base thread pool or service group thread pool. If '-b' option is specified, the thread pool is recognized as a base thread pool. If no option is specified, a service group thread pool is created, and uri will be an empty string. Multiple URIs can be specified by using a comma (,) delimiter.
[-jwdp <jeus-web-dd.xml path>]
Path to the jeus-web-dd.xml file to be used.
If there are multiple jeus-web-dd.xml, only one with the highest priority is applied. The order of priority is as follows: path mentioned in DeploymentPlan and DeployApplicationCommand, WEB-INF.
[-ejbjar <ejb-jar.xml_path>]
Path to the web.xml file to be used.
If there are multiple web.xml files, only one with the highest priority is applied, which cannot be merged. The order of priority is as follows: path specified in DeploymentPlan and DeployApplicationCommand, WEB-INF, domain/config/servlet.
[-ss,--sessionScope <scope-name>]
Scope to include applications.
-
-
Example
[MASTER]domain1.adminServer>deploy-application myApp -servers server1 deploy the application for the application [myApp] succeeded.
1.6.5. deploy-library
Deploys a library installed in a domain to a server or cluster.
-
Alias
deploylib
-
Usage
deploy-library <library-id> [-version,--libraryVersion <version>] [-all] [-clusters <cluster-list>] [-servers <server-list>] -
Parameters
Parameter Description <library-id>
ID of the library to be deployed.
[-version,--libraryVersion <version>]
Version of the library to be deployed.
[-all]
Deploys the library to all servers.
[-clusters <cluster-list>]
Clusters to which the application is to be deployed. To specify multiple clusters, separate each cluster with a comma (,).
[-servers <server-list>]
Server where the library will be deployed to. Multiple servers can be specified by using a comma (,) delimiter.
-
Example
[MASTER]domain1.adminServer>deploy-library log4j -version 1.2.17 -servers adminServer deploy the library [log4j] succeeded.
1.6.6. deployment-plan-info
Displays the information of an installed deployment plan.
-
Alias
dpinfo
-
Usage
deployment-plan-info [-name,--deploymentPlanName <deployment-plan-name>]
-
Parameters
Parameter Description [-name,--deploymentPlanName <deployment-plan-name>]
Sets the deployment plan name (identifier).
-
Example
[MASTER]domain1.adminServer>deployment-plan-info The list of deployment plans installed in the domain and the applications to which each deployment plan applies =========================================================== +------------------------------------------+--------------+ | Deployment plan | Applications | +------------------------------------------+--------------+ | plan1 | | +------------------------------------------+--------------+ ===========================================================
1.6.7. distribute-application
Distributes an installed application to each server or cluster. In order to run the service, the application must be started using the start-application command.
-
Alias
distributeapp, distapp, distribute
-
Usage
distribute-application [<application-id>] [-path,--applicationPath <path>] [-servers <server-list>] [-clusters <cluster-list>] [-all] [-exmaster,--excludeMaster] [-vh,--virtualHost <virtual-host>] [-svh,--systemVirtualHost] [-type,--applicationType <application-type>] [-cl,--classloading <classloading-mode>] [-auto,--autoRedeployCheckInterval <auto-redeploy-check-interval>] [-security,--securityDomainName <security-domain-name>] [-fast,--fastDeploy] [-keep,--keepGenerated] [-shared,--sharedDisk] [-u,--upgrade] [-plan,--deploymentPlanName <deployment-plan-name>] [-ctxp,--contextPath <context-path>] [-staging] [-lib,--libraryId <library-IDs>] [-version,--libraryVersion <library-versions>] [-con,--concurrent] -
Parameters
Parameter Description [<application-id>]
Application ID entered when the application was installed. To specify multiple application IDs, separate each ID with a comma (,). An ID can be given to an application when a file path is used for distribution. When using a file path, only one ID and one path can be entered.
[-path,--applicationPath <path>]
Path to application files. This option can be used when using the file path without installing the application. This is possible only when the files are in the same machine as JEUS Master Server.
[-servers <server-list>]
Names of the servers to which the application is distributed. To specify multiple servers, separate each server with a comma (,).
[-clusters <cluster-list>]
Names of the clusters to which the application is distributed. To specify multiple clusters, separate each cluster with a comma (,).
[-all]
Installs onto all servers in the domain.
[-exmaster,--excludeMaster]
Excludes the JEUS Master Server from the list of servers to which applications are deployed when the 'all' option is used.
[-vh,--virtualHost <virtual-host>]
Virtual host address. A virtual host name defined in the web engine can be selected. This option only operates in a web module.
[-svh,--systemVirtualHost]
Deploys an application to a system virtual host.
[-type,--applicationType <application-type>]
Sets the application type.
Input options:
-
EAR
-
EJB
-
WAR
-
CAR
-
RAR
If not specified, this option can be set automatically through DD or annotation.
[-cl,--classloading <classloading-mode>]
Sets the class loading type.
Input options:
-
SHARED
-
ISOLATED (Default value)
[-auto,--autoRedeployCheckInterval <auto-redeploy-check-interval>]
Interval at which to check for automatic application redeployment.
(Unit: ms)
[-security,--securityDomainName <security-domain-name>]
Security domain name to be applied to the application. By default, the value set in default-application-domain of the domain configuration is used.
[-fast,--fastDeploy]
Option to use previously created files (if any exists) to speed up the deployment process.
[-keep,--keepGenerated]
Option to keep the files generated during deployment.
[-shared,--sharedDisk]
Uses NAS to avoid copying the application file.
[-u,--upgrade]
Changes the DD format of JEUS 6 or earlier to make it compatible with the current version before deploying an application that has not been installed.
[-plan,-deploymentPlanName <deployment-plan-name>]
Sets the deployment plan file name.
[-ctxp,--contextPath <context-path>]
Sets the context for web applications.
[-staging]
Compresses applications in an exploded module type to send to other machines.
[-lib,--libraryId <library-IDs>]
Library to be referenced by applications. Multiple libraries can be specified by using a comma (,) delimiter.
[-version,--libraryVersion <library-versions>]
Version of the library to be referenced. Multiple libraries can be specified by using a comma (,) delimiter.
[-con, --concurrent]
Option to deploy multiple applications simultaneously during deployment.
-
-
Example
[MASTER]domain1.adminServer>distribute-application myApp -servers server1 distribute the application for the application [myApp] succeeded.
1.6.8. install-application
Installs an application. The application ID can be set. The application file name can be used instead of the ID, and the '.' character is replaced with the '_' character.
-
Alias
installapp, install-app
-
Usage
install-application <application-source-path> [-id,--applicationId <application-id>] [-f,--force] [-u,--upgrade] -
Parameters
Parameter Description <application-source-path>
Path to the application.
[-id,--applicationId <application-id>]
Application ID.
[-f,--force]
Overwrites the existing application with the same ID.
[-u,--upgrade]
Changes the DD format of JEUS 6 or earlier versions to make it compatible with the current version.
-
Example
[MASTER]domain1.adminServer>install-application /home/apps/myApp.ear -id myApp Successfully installed the application [myApp].
1.6.9. install-deployment-plan
Installs a deployment plan. An identifier of the deployment plan can be defined.
-
Alias
installdp
-
Usage
install-deployment-plan -path,--deploymentPlanPath <deployment-plan-path> [-name,--deploymentPlanName <deployment-plan-name>] [-f,--force] -
Parameters
Parameter Description -path,--deploymentPlanPath <deployment-plan-path>
Path to the deployment plan.
[-name,--deploymentPlanName <deployment-plan-name>]
Sets the deployment plan name (identifier).
[-f,--force]
Overwrites the existing deployment plan with the same name.
-
Example
[MASTER]domain1.adminServer>install-deployment-plan -path /home/plans/jeus-deployment-plan.xml -name plan1 Installing the deployment plan [plan1] was successful.
1.6.10. install-library
Installs a library file in a domain.
-
Alias
installlib, install-lib
-
Usage
install-library <library-id> -path <library-source-path> [-version,--libraryVersion <version>] -
Parameters
Parameter Description <library-id>
ID of the library to be installed.
-path <library-source-path>
Path to the library to be installed.
[-version,--libraryVersion <version>]
Version of the library to be installed. (Default value: 1.0)
-
Example
[MASTER]domain1.adminServer>install-library log4j -path /home/lib/apache-log4j-1.2.17/log4j-1.2.17.jar -version 1.2.17 Successfully installed the library [log4j] version [1.2.17].
1.6.11. library-info
Displays information about the libraries that have been installed and deployed.
-
Alias
libinfo, list-libraries
-
Usage
library-info
-
Example
[MASTER]domain1.adminServer>library-info Library information ================================================================================ +-----------+--------+--------+---------------+------------------+-------------+ | Library ID| Version| State | Target Servers| Target Clusters | Applications| +-----------+--------+--------+---------------+------------------+-------------+ | log4j | 1.2.17 | RUNNING| adminServer | | | +-----------+--------+--------+---------------+------------------+-------------+ ================================================================================
1.6.12. list-application-repositories
Displays the information about registered application repositories.
-
Alias
listapprepos
-
Usage
list-application-repositories
-
Example
[MASTER]domain1.adminServer>list-application-repositories Application Repositories ================================================================================ +------------------------------------------------------------------------------+ | Path of Application Repository | +------------------------------------------------------------------------------+ | /home/user1/apps/ | | //host1/shared/apps | +------------------------------------------------------------------------------+ ================================================================================
1.6.13. redeploy-application
Redeploys an application.
-
Alias
redepapp, redeploy
-
Usage
redeploy-application <application-id> [-path,--uploadPath <application-upload-path>] [-masterPath,--pathManuallyInstalled <application-source-path-in-master>] [-to <graceful-timeout>] [-f,--force] [-distonly,--distributeOnly] [-plan,-deploymentPlanName <deployment-plan-name>] [-lib,--libraryId <library-IDs>] [-version,--libraryVersion <library-versions>] [-u,--upgrade] -
Parameters
Parameter Description <application-id>
Application ID. To specify multiple application IDs, separate each ID with a comma (,).
[-path, --uploadPath <application-upload-path>]
Path to the modified application files. This can be used to reinstall files.
[-masterPath, --pathManuallyInstalled <application-source-path-in-master>]
Path to the local files of the changed application. This can be accessed from the JEUS Master Server. This does not include the installation steps.
[-to <graceful-timeout>]
Timeout value for graceful undeployment. (Unit: second)
[-f,--force]
Keeps the existing application running on the server.
[-distonly,--distributeOnly]
Distributes the application to each server.
[-plan,-deploymentPlanName <deployment-plan-name>]
Sets the deployment plan file name.
[-lib,--libraryId <library-IDs>]
Library to be referenced by applications. Multiple libraries can be specified by using a comma (,) delimiter.
[-version,--libraryVersion <library-versions>]
Version of the library to be referenced. Multiple libraries can be specified by using a comma (,) delimiter.
[-u, --upgrade]
Upgrades the DD of a new application for the current version of JEUS. This option is enabled only when the application has been specified using the path option or the masterPath option.
-
Example
[MASTER]domain1.adminServer>redeploy-application myApp redeploy application on JEUS Master Server for the application [myApp] succeeded.
1.6.14. remove-application-repository
Deletes a registered application repository.
-
Alias
rmapprepo, removeapprepo, uninstallapps
-
Usage
remove-application-repository [<application-repository-path>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [<application-repository-path>]
Path to the application repository to be deleted.
[-f, --forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed information.
-
Example
[MASTER]domain1.adminServer>remove-application-repository /home/user1/apps Successfully performed the REMOVE operation for An application repository. Check the results using "remove-application-repository or list-application-repositories"
1.6.15. remove-application-target
Deletes an application deployed or distributed on a server or a cluster from a server or cluster. Only available for the JEUS Master Server and Managed Server structure.
-
Alias
remove-app-target, remove-target, rm-app-target, rmapptarget
-
Usage
remove-application-target <application-id> [-servers <server-list>] [-clusters <cluster-list>] [-vh,--virtualHost <virtual-host>] -
Parameters
Parameter Description <application-id>
ID of the application to be deleted.
[-servers <server-lists>]
Server from which the application is deleted. To specify multiple servers, separate each server with a comma (,).
[-clusters <cluster-lists>]
Cluster from which the application is deleted. To specify multiple clusters, separate each cluster with a comma (,).
[-vh,--virtualHost <virtual-host>]
Virtual host name.
-
Example
[MASTER]domain1.adminServer>remove-application-target myApp -servers server1 remove server or cluster target from the application for the application [myApp] succeeded.
1.6.16. start-application
Starts the deployed application.
-
Alias
startapp, start-app
-
Usage
start-application <application-id> [-con,--concurrent] -
Parameters
Parameter Description <application-id>
ID of the application to be started. To specify multiple applications, separate each application with a comma (,).
[-con, --concurrent]
Option to start multiple applications simultaneously.
-
Example
[MASTER]domain1.adminServer>start-application myApp start the application for the application [myApp] succeeded.
1.6.17. stop-application
Suspends a running application.
-
Alias
stopapp, stop-app
-
Usage
stop-application <application-id> [-con,--concurrent] -
Parameters
Parameter Description <application-id>
ID of the application to be stopped. To specify multiple applications, separate each application with a comma (,).
[-con, --concurrent]
Option to stop multiple applications simultaneously.
-
Example
[MASTER]domain1.adminServer>stop-application myApp stop the application for the application [myApp] succeeded.
1.6.18. undeploy-application
Undeploys a deployed application.
-
Alias
undeployapp, undeploy
-
Usage
undeploy-application <application-id> [-to,--gracefultimeout <graceful-undeploy-timeout>] [-f,--force <non-graceful undeploy>] [-new | -old | -all] [-con,--concurrent] [-rss,--removeSessionScope] -
Parameters
Parameter Description <application-id>
Application ID. To specify multiple application IDs, separate each ID with a comma (,).
[-to,--gracefultimeout <graceful-undeploy-timeout>]
Period in which to apply graceful undeployment. Waits the specified period for the current request to complete. (Unit: second)
[-f,--force <non-graceful undeploy>]
Graceful undeployment is not performed. The current process requests are ignored, and the application is undeployed.
[-new]
When gracefully redeploying, undeploys a new application and runs the existing application.
[-old]
When gracefully redeploying, undeploys the existing application.
[-all]
When gracefully redeploying, undeploys both new and existing applications.
[-con, --concurrent]
Option to undeploy multiple applications concurrently.
[-rss,--removeSessionScope]
Deletes applications within the configured scope.
-
Example
[MASTER]domain1.adminServer>undeploy-application myApp Undeploying [myApp] (This may take time due to graceful undeployment) .......... undeploy the application for the application [myApp] succeeded. Successfully undeployed (elapsed = 2822ms)
1.6.19. undeploy-library
Undeploys a library deployed to a server or cluster.
-
Alias
undeploylib
-
Usage
undeploy-library <library-id> [-version,--libraryVersion <version>] -
Parameters
Parameter Description <library-id>
ID of the library to be undeployed.
[-version,--libraryVersion <version>]
Version of the library to be undeployed.
-
Example
[MASTER]domain1.adminServer>undeploy-library log4j -version 1.2.17 undeploy the library [log4j] succeeded.
1.6.20. uninstall-application
Deletes installed applications.
-
Alias
uninstallapp, uninstall
-
Usage
uninstall-application <application-id> | [-all]
-
Parameters
Parameter Description <application-id>
Application ID. To specify multiple application IDs, separate each ID with a comma (,).
[-all]
Deletes all applications from the domain.
-
Example
[MASTER]domain1.adminServer>uninstall-application myApp uninstall the application for the application [myApp] succeeded. : Successfully deleted [myApp].
1.6.21. uninstall-deployment-plan
Deletes the installed deployment plan.
-
Alias
uninstalldp
-
Usage
uninstall-deployment-plan <deployment-plan-name> | [-all]
-
Parameters
Parameter Description <deployment-plan-name>
Deployment plan identifier (name) to be deleted.
[-all]
Deletes all deployment plans.
-
Example
[MASTER]domain1.adminServer>uninstall-deployment-plan plan1 Uninstalling the deployment plan was successful.
1.6.22. uninstall-library
Uninstalls a library file from a domain.
-
Alias
uninstalllib
-
Usage
uninstall-library <library-id> [-version,--libraryVersion <version>] -
Parameters
Parameter Description <library-id>
ID of the library to be uninstalled.
[-version,--libraryVersion <version>]
Version of the library to be uninstalled.
-
Example
[MASTER]domain1.adminServer>uninstall-library log4j -version 1.2.17 uninstall the library [log4j] succeeded. : Successfully deleted [log4j].
1.7. EJB Engine Commands
The following is a list of EJB engine commands.
| Command | Description |
|---|---|
Cancels the EJB timer of a server. |
|
Displays the EJB timer information of a server. |
|
Changes the active management of a server. |
|
Changes the resolution of a server. |
|
Displays the active management information of a server. |
|
Displays the resolution information of a server. |
1.7.1. cancel-ejb-timer
Cancels the EJB timer of a server.
-
Alias
cancelejbtimer, canceltimer
-
Usage
cancel-ejb-timer -server <server-name> -module <module-id> | -timer <timer-id> -
Parameters
Parameter Description -server <server-name>
Server name.
-module <module-id>
ID of the module for which the timer will be canceled.
-timer <timer-id>
ID of the timer to be canceled.
-
Example
[MASTER]domain1.adminServer>cancel-ejb-timer -server server1 -timer 502 Successfully canceled.
1.7.2. ejb-timer-info
Displays the EJB timer information of a server.
-
Alias
ejbtimerinfo, timerinfo, scheduler
-
Usage
ejb-timer-info -server <server-name> [-module <module-id> | -all] [-detail] -
Parameters
Parameter Description -server <server-name>
Server name.
[-module <module-id> ]
Name of the EJB module for which the timer information is to be displayed.
[-all]
Displays the timer information for all EJB modules.
[-detail]
Displays detailed timer information.
-
Example
[MASTER]domain1.adminServer>ejb-timer-info -server server1 -all -detail Persistent Timer List: server[server1] Module ID: Timer ================================================================================ +----+-------------+---------+--------------------+------+---------------------+ | ID | BEAN | METHOD | SCHEDULE | INFO | NEXT | +----+-------------+---------+--------------------+------+---------------------+ | 52 | Persistence | print() | sec=*,min=*,hour=* | | 2016-08-29 (Mon) PM | | |TestBean | |,dayOfMonth=*,dayOf | | 03:50:34 KST | | | | |Week=*,month=*,year | | | | | | |=* | | | +----+-------------+---------+--------------------+------+---------------------+ ================================================================================
1.7.3. modify-active-management
Changes the active management of a server.
-
Alias
modifyam
-
Usage
modify-active-management -server <server-name> [-mbt,--maxBlockedThread <max-blocked-thread>] [-mit,--maxIdleTime <max-idle-time>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -server <server-name>
Server name.
[-mbt,--maxBlockedThread <max-blocked-thread>]
[Dynamic] Maximum number of blocked threads.
[-mit,--maxIdleTime <max-idle-time>]
[Dynamic] Maximum idle time to determine the blocked state.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>modify-active-management -server server1 -mbt 5 -mit 300001 Successfully performed the MODIFY operation for active-management for the server (server1).. Check the results using "show-active-management -server server1"
1.7.4. modify-check-resolution
Changes the resolution of a server.
-
Alias
modifyresolution, ejbengineresolution
-
Usage
modify-check-resolution -server <server-name> [-r,--resolution <resolution>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -server <server-name>
Server name.
[-r,--resolution <resolution>]
[Dynamic] Resolution of the EJB engine to be changed.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>modify-check-resolution -server server1 -r 3000001 Successfully performed the MODIFY operation for The EJB engine resolution of the server (server1).. Check the results using "show-check-resolution -server server1"
1.7.5. show-active-management
Displays the active management information of a server.
-
Alias
showam
-
Usage
show-active-management -server <server-name>
-
Parameters
Parameter Description -server <server-name>
Server name.
-
Example
[MASTER]domain1.adminServer>show-active-management -server server1 Shows the current configuration. active-management for the server (server1). =================================================================== +---------------------------------------------------------+-------+ | Max Blocked Thread | 5 | | Max Idle Time | 300001| +---------------------------------------------------------+-------+ ===================================================================
1.7.6. show-check-resolution
Displays the resolution information of a server.
-
Alias
showresolution
-
Usage
show-check-resolution -server <server-name>
-
Parameters
Parameter Description -server <server-name>
Server name.
-
Example
[MASTER]domain1.adminServer>show-check-resolution -server server1 Shows the current configuration. The EJB engine resolution of the server (server1). ======================================================== +---------------------------------------------+--------+ | Resolution | 3000001| +---------------------------------------------+--------+ ========================================================
1.8. Web Engine Commands
The following are two types of web engine commands.
-
Monitoring and control commands
These commands are for checking or controlling the states of web contexts that are deployed. These commands also check and control the states of web engines.
Command Description Resumes a temporarily suspended web component (servlet).
Suspends a web component (servlet).
Reloads the specified context from a disk dynamically.
Displays web engine configurations.
Displays different statistics information about a web engine.
Specifies whether to delete thread local information stored in the web-connection thread pool.
Resets the statistical data requested by the specified component.
Displays the process flow for a request received through a URL pattern or a specific host name.
Precompiles the JSP files of deployed web contexts.
Notifies added or deleted web servers or JEUS managed servers.
-
Configuration change commands
These commands dynamically add, delete, or change the configuration of the web engine. Some commands may not immediately apply the changes to configurations. The modified configurations are saved in the domain.xml file but are not reflected in the currently running service (memory area). In order to apply the changes to the actual service, the server must be restarted.
Command Description Adds an HTTP Cookie Policy to the web engine.
Changes the HTTP Cookie Policy configurations of the web engine.
Deletes a Cookie Policy configuration.
Adds a Character Set Encoding configuration.
Changes the property configurations of the web engine.
Deletes a Character Set Encoding configuration.
Adds property configurations to the web engine.
Changes the property configurations of the web engine.
Deletes property configurations from the web engine.
Adds an HTTP Response Custom Header configuration.
Changes the HTTP Response Custom Header configuration.
Deletes an HTTP Response Custom Header configuration.
Changes the JSP engine configurations.
Adds a virtual host.
Changes certain configurations of virtual hosts.
Deletes a virtual host.
Adds a valve.
Deletes a valve.
Adds a valve property configuration.
Deletes a valve property configuration.
Adds a WebtoB connector.
Changes certain configurations of a WebtoB connector.
Deletes a WebtoB connector.
Displays WebtoB connector information.
Adds a backup WebtoB.
Deletes a backup WebtoB.
Adds a Tmax connector.
Changes the configuration of a Tmax connector.
Deletes a Tmax connector.
Adds an AJP listener.
Adds an HTTP listener.
Adds a TCP listener.
Changes the configuration of HTTP, TCP, and AJP listeners.
Deletes an HTTP, TCP, or AJP listener.
Changes the web engine configuration dynamically.
1.8.1. Shared Options
The following options are shared by web engine commands. Only one of the following options can be set.
-
[-cluster <cluster-name>] option
-
This option is used to specify the cluster to which each command applies. If the option is not set, the command is applied to the web engine of the currently connected server.
-
The description of this option is omitted from each command option description. Note that precompile-jsp does not offer this option.
-
-
[-server <server-name>] option
-
This option is used to specify the server to which each command is applied. If this option is not set, the command is applied to the web engine of the currently connected server.
-
The description of this option is omitted from each command option description.
-
|
1.8.2. add-ajp-listener
Adds an AJP listener.
-
Related schema
web-engine.xsd - web-engine/web-connections/ajp13-listener
-
Alias
addajpl
-
Usage
add-ajp-listener [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] -name <web-connection-name> -slref <server-listener-ref-name> -tmin <minimum-thread-num> [-tmax <maximum-thread-num>] [-tidle <max-idle-time>] [-qs <max_queue>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-name <web-connection-name>
Listener name.
-slref <server-listener-ref-name>
Service listener name registered to the server.
-tmin <minimum-thread-num>
Minimum number of threads in the thread pools.
[-tmax <maximum-thread-num>]
Maximum number of threads in the thread pools. If not specified, it is the same as the -tmin value.
[-tidle <max-idle-time>]
Maximum idle time of worker threads before they are removed from the thread pools.
[-qs <max_queue>]
Size of the queue that holds tasks waiting to be processed in the thread pools.
-
Example
add-ajp-listener -name ajp1 -server server1 -slref ajp-server -tmin 10
1.8.3. add-backup-webtob
Adds a backup WebtoB.
-
Related schema
web-engine.xsd - web-engine/web-connections/webtob-connector/webtob-backup
-
Alias
addbackupwebtob
-
Usage
add-backup-webtob -cluster <cluster-name> | -server <server-name> [-f, --forceLock] -name <web-connection-name> [-addr <server-address>] -port <server-port> | -dsocket [-wbhome <webtob-home>] [-ipcport <ipc-base-port>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-name <web-connection-name>
Name of the WebtoB connector to which a backup WebtoB will be added.
-addr <server-address>
Backup WebtoB server address. If -port is used, this option is required.
-port <server-port>
Backup WebtoB server port number.
-dsocket
Option to use Unix domain sockets (pipes) for communication between JEUS and WebtoB.
-wbhome <webtob-home>
Absolute path to the backup WebtoB in case it is installed in the same machine as JEUS.
-ipcport <ipc-base-port>
Default port number used for communication between internal processes of WebtoB in a Windows environment.
-
Example
add-backup-webtob -server server1 -name webtob1 -port 9999 -addr localhost
1.8.4. add-http-listener
Adds an HTTP listener.
-
Related schema
web-engine.xsd - web-engine/web-connections/http-listener
-
Alias
addhttpl
-
Usage
add-http-listener [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] -name <web-connection-name> -slref <server-listener-ref-name> -tmin <minimum-thread-num> [-tmax <maximum-thread-num>] [-tidle <max-idle-time>] [-qs <max_queue>] [-http2] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-name <web-connection-name>
Listener name.
-slref <server-listener-ref-name>
Service listener name registered to the server.
-tmin <minimum-thread-num>
Minimum number of threads in the thread pools.
[-tmax <maximum-thread-num>]
Maximum number of threads in the thread pools. If not specified, it is the same as the -tmin value.
[-tidle <max-idle-time>]
Maximum idle time of worker threads before they are removed from the thread pools.
[-qs <max_queue>]
Size of the queue that holds tasks waiting to be processed in the thread pools.
[-http2]
Option to use HTTP/2.
-
Example
add-http-listener -name http1 -server server1 -slref http-server -tmin 5 -tmax 10 -http2
1.8.5. add-response-header
Adds an HTTP Response Header configuration to the web engine. The Response Header is not case-sensitive. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - web-engine/response-header
-
Alias
addwebrh
-
Usage
add-response-header [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] [-n,--name <header-name>] [-v,--value <header-value>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
[-n,--name <header-name>]
Name of HTTP Response Header to be added. The name is case-insensitive. Each header name must be unique.
[-v,--value <header-value>]
Value of HTTP Response Header to be added. The value is case-insensitive.
-
Example
add-response-header -server server1 -n testHeader -v testValue
1.8.6. add-tcp-listener
Adds a TCP listener. However, the TCP listener is only reflected in the domain.xml file. To apply the listener to services, the server must be restarted.
-
Related schema
web-engine.xsd - web-engine/web-connections/tcp-listener
-
Alias
addtcpl
-
Usage
add-tcp-listener [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] -name <web-connection-name> -slref <server-listener-ref-name> -dcc <dispatcher-config-class> -tmin <minimum-thread-num> [-tmax <maximum-thread-num>] [-tidle <max-idle-time>] [-qs <max_queue>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-name <web-connection-name>
Listener name.
-slref <server-listener-ref-name>
Service listener name registered to the server.
-dcc <dispatcher-config-class>
Class name that implements the jeus.servlet.tcp.TCPDispatcherConfig interface.
-tmin <minimum-thread-num>
Minimum number of threads in the thread pools.
[-tmax <maximum-thread-num>]
Maximum number of threads in the thread pools. If not specified, it is the same as the -tmin value.
[-tidle <max-idle-time>]
Maximum idle time of worker threads before they are removed from the thread pools.
[-qs <max_queue>]
Size of the queue that holds tasks waiting to be processed in the thread pools.
-
Example
add-tcp-listener -name tcp1 -slref tcp -server server1 -dcc tcp.DispatcherConfigImpl -tmin 5 -tmax 10
1.8.7. add-tmax-connector
Adds a Tmax connector. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - web-engine/web-connections/tmax-connector
-
Alias
addtmaxcon
-
Usage
add-tmax-connector [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] -name <web-connection-name> -addr <server-address> -port <server-port> -svrg <server-group-name> -svr <server-name> -dcc <dispatcher-config-class> -tmin <minimum-thread-num> [-tmax <maximum-thread-num>] [-tidle <max-idle-time>] [-qs <max_queue>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-name <web-connection-name>
Tmax connector name.
-addr <server-address>
Tmax server address.
-port <server-port>
Tmax server port number.
[-svrg <server-group-name>]
Server group name of Tmax server.
[-svr <server-name>]
Tmax server name.
-dcc <dispatcher-config-class>
Class name that implements the jeus.servlet.tcp.TCPDispatcherConfig interface.
-tmin <minimum-thread-num>
Minimum number of threads in the thread pools.
[-tmax <maximum-thread-num>]
Maximum number of threads in the thread pools. If not specified, it is the same as the -tmin value.
[-tidle <max-idle-time>]
Maximum idle time of worker threads before they are removed from the thread pools.
[-qs <max_queue>]
Size of the queue that holds tasks waiting to be processed in the thread pools.
-
Example
add-tmax-connector -name tmax1 -addr 5.0.1.2 -port 1024 -svrg group1 -svr server1 -server server1 -dcc serice.DispatcherConfig
1.8.8. add-virtual-host
Adds a virtual host.
-
Related schema
web-engine.xsd - web-engine/virtual-host
-
Alias
addvh
-
Usage
add-virtual-host [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] <virtual-host-name> -list <host-name-list> [-tmin <minimum-thread-num>] [-tmax <maximum-thread-num>] [-tidle <max-idle-time>] [-qs <max-queue>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
<virtual-host-name>
Virtual host name.
-list <host-name-list>
Domain name or IP address to be registered in the virtual host.
[-tmin <minimum-thread-num>]
Minimum number of threads in the thread pools.
[-tmax <maximum-thread-num>]
Maximum number of threads in the thread pools.
[-tidle <max-idle-time>]
Maximum idle time of worker threads before they are removed from the thread pools.
[-qs <max-queue>]
Maximum number of requests waiting in the queue of the thread pools.
-
Example
add-virtual-host -server server1 host2 -list www.foo.com,192.168.1.2 -tmin 1 -tmax 10 -tidle 20000
1.8.9. add-valve
Adds a valve.
-
Related schema
web-engine.xsd - pipeline/valve
-
Alias
addvlv
-
Usage
add-valve [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] -cn, --classname <class-name> -p, --properties <property> [-vh <virtual-host-name>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-cn, --classname <class-name>
Specifies a valve class to apply to a server and virtual host. It must be a class that inherits JEUS ValveBase.
[-p,--properties <properties>]
Valve properties.
-
For a single property, use the "key=value" format.
-
To specify multiple properties, separate each property with a comma (,).
[-vh <virtual-host-name>]
Name of the virtual host to add a valve to. If not set, a valve is added at the server level.
-
-
Example
add-valve -server server1 -cn UserValveBase -p jeus.servlet.jsp.compile-java-source-concurrently=false,userProperty=myValue
1.8.10. add-web-cookie-policy
Adds an HTTP cookie policy configuration. It is applied only in the domain.xml file. To apply the added setting to the actual service, restart the server.
-
Related schema
web-engine.xsd - web-engine/cookie-policy
-
Alias
addcookie
-
Usage
add-web-cookie-policy [-cluster <cluster-name> | -server <server-name>] [-f, -forceLock] [-auer,--apply-url-encoding-rule <apply-url-encoding-rule>] [-enc,--charset-encoding <charset-encoding>] [-vh <virtual-host-name>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
[-auer,--apply-url-encoding-rule <apply-url-encoding-rule>]
Option to apply URL encoding rules.
[-enc,--charset-encoding <charset-encoding>]
Charset encoding used when applying URL encoding rules. If not set, the request encoding value is used.
[-vh <virtual-host-name>]
Virtual host.
-
Example
add-web-cookie-policy -server server1 -auer true add-web-cookie-policy -server server1 -enc EUC-KR
1.8.11. add-web-encoding
Adds a Character Set Encoding to the web engine. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted. (To add an encoding, delete the existing encoding first. When encoding is changed, the change is applied after the server restarts.)
-
Related schema
web-engine.xsd - web-engine/encoding
-
Alias
addenc
-
Usage
add-web-encoding [-cluster <cluster-name> | -server <server-name>] [-f, -forceLock] <charset-encoding> [-co | -default | -forced] [-url] [-req] [-res] [-vh <virtual-host-name>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
<charset-encoding>
Character set encoding name to be set. If an invalid value is entered, an error message is displayed and the command fails.
-co | -default | -forced
Sets the entered encoding to either 'default' or 'forced'. For a request encoding, 'client-override' also can be set in addition to the two options.
[-url]
Character set encoding of Request URL.
[-req]
Character set encoding of requests.
[-res]
Character set encoding of responses.
[-vh <virtual-host-name>]
Virtual host.
-
Example
add-web-encoding -server server1 -default -url UTF-8 addenc -server server1 UTF-8 -forced -req -res
1.8.12. add-web-properties
Adds property configurations to the web engine. The added property is case-sensitive. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - web-engine/properties
-
Alias
addwebpr
-
Usage
add-web-properties [-cluster <cluster-name> | -server <server-name>] [-f, -forceLock] -p,--properties <properties> [-vh <virtual-host-name>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-p,--properties <properties>
Properties to be added to the web engine.
-
For a single property, use the "key=value" format.
-
To specify multiple properties, separate each property with a comma (,).
[-vh <virtual-host-name>]
Virtual host.
-
-
Example
add-web-properties -server server1 -p jeus.servlet.jsp.modern=false add-web-properties -server server1 -p jeus.servlet.jsp.compile-java-source-concurrently1=false,jeus.servlet.jsp.assure-utf8-file-encoding-detection=true
1.8.13. add-webtob-connector
Adds a WebtoB connector. The added WebtoB connector can be used for the actual service. Once added, the WebtoB address and port cannot be changed.
-
Related schema
web-engine.xsd - web-engine/web-connections/webtob-connector
-
Alias
addwebtobcon
-
Usage
add-webtob-connector [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] -name <web-connection-name> -conn <connection-count> -regid <registration-id> -tmin <minimum-thread-num> [-tmax <maximum-thread-num>] [-tidle <max-idle-time>] [-qs <max_queue>] [-hth <hth-count>] [-useNio <use-nio>] [-ver <wjp-version>>] [-addr <server-address>] -port <server-port> | -dsocket [-wbhome <webtob-home>] [-ipcport <ipc-base-port>] [-sndbuf <send-buffer-size>] [-rcvbuf <receive-buffer-size>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-name <web-connection-name>
WebtoB connector name.
-conn <connection-count>
Number of connections to WebtoB.
-tmin <minimum-thread-num>
Minimum number of threads in the thread pools.
[-tmax <maximum-thread-num>]
Maximum number of threads in the thread pools. If not specified, it is the same as the -tmin value.
[-tidle <max-idle-time>]
Maximum idle time of worker threads before they are removed from the thread pools.
[-qs <max_queue>]
Size of the queue that holds tasks waiting to be processed in the thread pools.
[-hth <hth-count>]
Number of HTH processes.
-ver <wjp-version>
Version of the protocol used to communicate with WebtoB. Enter 1 or 2.
-addr <server-address>
WebtoB server address. If -port is used, this option is required.
-port <server-port>
WebtoB server port.
-regid <registration-id>
Registration ID in WebtoB.
-dsocket
Option to use Unix domain sockets (pipes) for communication between JEUS and WebtoB.
-wbhome <webtob-home>
Absolute path to WebtoB in case it is installed in the same machine as JEUS.
-ipcport <ipc-base-port>
Default port number used for communication between internal processes of WebtoB in a Windows environment.
-sndbuf <send-buffer-size>
SO_SNDBUF. The size of the send buffer of a TCP socket or the Unix domain socket.
If set to 0, the default value of the OS is used.
-rcvbuf <receive-buffer-size>
SO_RCVBUF. The size of the receive buffer of a TCP socket or the Unix domain socket.
If set to 0, the default value of the OS is used.
-
Example
add-webtob-connector -server server1 -name webtob1 -conn 10 -tmin 10 -hth 2 -regid MyGroup -port 9999 -addr localhost
1.8.14. clear-thread-local
Specifies whether to delete the thread local information stored in all web-connection thread pools. By default, it is not deleted, and if deleted, each thread checks and deletes before executing a task. This function can be switched on/off.
-
Related schema
web-engine.xsd
-
Alias
clrtl, cltl
-
Usage
clear-thread-local [-cluster <cluster-name> | -server <server-name>] [-f,--forceLock] -wc <web-connection-name> -off | -on -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-wc <web-connection-name>]
Web connection name.
-off | -on
-
-off: Does not clear thread locals.
-
-on: Clears thread locals.
-
-
Example
clear-thread-local -server server1 -wc http-listener -on
1.8.15. clear-web-statistics
Resets the statistical data requested by the specified component.
-
Related schema
web-engine.xsd
-
Alias
clrstat, clst, clrwebstat
-
Usage
clear-web-statistics [-server <server-name>] [-ctx,--context <context-name>] [-servlet <servlet-name>] -
Parameters
Parameter Description [-ctx <context-name>]
Context for which the request count, processing time records, and work thread information are deleted.
[-servlet <servlet-name>]
Servlet for which the request count and processing time records are deleted.
-
Example
clear-web-statistic -server server1 -ctx ctx1
1.8.16. modify-jsp-engine
Changes the JSP engine configurations of the web engine. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - web-engine/jsp-engine
-
Alias
modjsp
-
Usage
modify-jsp-engine [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] [-rjwd,--remove-jsp-work-dir | -jwd,--jsp-work-dir <jsp-work-dir>] [-javac,--java-compiler <java-compiler>] [-cod,--compile-output-dir <compile-output-dir> | -rcod,--remove-compile-output-dir] [-rcopt,--remove-compile-option | -copt,--compile-option <compile-option>] [-cij,--check-included-jspfile <check-included-jspfile>] [-kg,--keep-generated <keep-generated>] [-gjr,--graceful-jsp-reloading <graceful-jsp-reloading>] [-gjrp,--graceful-jsp-reloading-period <graceful-jsp-reloading-period>] [-umc,--use-in-memory-compilation <use-in-memory-compilation>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
[-rjwd,--remove-jsp-work-dir | -jwd,--jsp-work-dir <jsp-work-dir>]
The -jwd,--jsp-work-dir <jsp-work-dir> sets the location of the files created in Java from JSP and the class files created by compiling the files. The value must be a absolute path.
The configuration can be deleted using -rjwd,--remove-jsp-work-dir. If deleted, the default value of the engine is used.
[-javac,--java-compiler <java-compiler>]
Java compiler, which is used to compile Java source files of JSP to servlet class files.
Input options:
-
java6 (Default value)
-
sun.tools.javac
-
javac
-
com.sun.tools.javac
-
eclipse
The default value is recommended because it is the most efficient.
[-cod,--compile-output-dir <compile-output-dir> | -rcod,--remove-compile-output-dir]
The -cod,--compile-output-dir <compile-output-dir> stores class files created from JSP files to a different directory instead of the JSP Work Dir. If not set, class files are located in the JSP Work Dir.
The configuration can be deleted using -rcod,--remove-compile-output-dir. If deleted, the default value of the engine is used.
[-rcopt,--remove-compile-option | -copt,--compile-option <compile-option>]
Options used in the servlet compiler.
The value can be deleted using -rcopt,--remove-compile-option.
[-cij,--check-included-jspfile <check-included-jspfile>]
Checks if the included JSP file and Tag files are changed. If the file are changed, this option determines whether to recompile the JSP files.
[-kg,--keep-generated <keep-generated>]
Compiles Java source files created from JSP pages to create servlet class files, and then determines whether to store the Java source files.
[-gjr,--graceful-jsp-reloading <graceful-jsp-reloading>]
Compiles JSP files, which are exclusive on a JVM, into a batch type Java file. The JSP sources and compiled class files are shared.
This option only works when a shared directory is specified in JSP Work Dir.
[-gjrp,--graceful-jsp-reloading-period <graceful-jsp-reloading-period>]
Interval at which to perform Graceful JSP reloading.
[-umc,--use-in-memory-compilation <use-in-memory-compilation>]
When recompiling JSP files that are in use, 'java' and '.class' files are created in memory and compiled. '.class' files are written on a file system using a background thread so they are not recompiled during reboot.
If <keep-generated> is true, '.java' files are written on a file system using a background thread.
-
-
Example
modify-jsp-engine -server server1 -jwd /home/jeus/jsp
1.8.17. modify-response-header
Changes the Response Header configuration to the web engine. The Response Header is not case-sensitive. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - web-engine/response-header
-
Alias
modwebrh
-
Usage
modify-response-header [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] [-n,--name <header-name>] [-v,--value <header-value>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
[-n,--name <header-name>]
Name of the HTTP Response Header to be changed. The name is case-insensitive. Each header name must be unique.
[-v,--value <header-value>]
Value of the HTTP Response Header to be changed. The value is case-insensitive.
-
Example
modify-response-header -server server1 -n testheader -v testvalue3
1.8.18. modify-tmax-connector
Changes the thread pool configuration of a Tmax connector.
-
Related schema
web-engine.xsd - web-engine/web-connections/tmax-connector
-
Alias
modtmaxcon
-
Usage
modify-tmax-connector [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] -name <web-connection-name> [-tmin <minimum-thread-num>] [-tmax <maximum-thread-num>] [-tidle <max-idle-time>] [-obuf <output-buffer-size>] [-addr <server-address>] [-port <server-port>] [-svrg <server-group-name>] [-svr <server-name>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-name <web-connection-name>
Tmax connector name.
[-tmin <minimum-thread-num>]
[Dynamic] Minimum number of threads in the thread pools.
[-tmax <maximum-thread-num>]
[Dynamic] Maximum number of threads in the thread pools.
[-tidle <max-idle-time>]
Maximum idle time of threads in the thread pools.
[-obuf <output-buffer-size>]
Servlet response buffer size.
[-addr <server-address>]
Tmax server address.
[-port <server-port>]
Tmax server port number.
[-svrg <server-group-name>]
Server group name of Tmax server.
[-svr <server-name>]
Tmax server name.
-
Example
modify-tmax-connector -name tmax1 -tmin 30 -server server1 -obuf 20000
1.8.19. modify-virtual-host
Changes the access log format configuration of virtual hosts. If the access log of a virtual host is not in the enable state, the server must be restarted to apply the command to the actual service.
-
Related schema
web-engine.xsd - web-engine/virtual-host
-
Alias
modvh
-
Usage
modify-virtual-host [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] <virtual-host-name> [-tmin <minimum-thread-num>] [-tmax <maximum-thread-num>] [-tidle <max-idle-time>] [-aluph <true | false>| -alf <access-log-format> | -aluse <true | false> | -alhnl <true | false> | -alext <access-log-excluded-extensions>] [-hnrm <host-name> | -hnadd <host-name>] [-ast <attach-stacktrace-on-error>] [-fhn <access-log-handler-file-handler-name>] [-fhp <access-log-handler-file-handler-permission>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
<virtual-host-name>
Virtual host name.
[-tmin <minimum-thread-num>]
[Dynamic] Minimum number of threads in the thread pools.
[-tmax <maximum-thread-num>]
[Dynamic] Maximum number of threads in the thread pools.
[-tidle <max-idle-time>]
Maximum idle time of threads in the thread pools.
[-aluph <true | false>]
[Dynamic] Option to record a web engine access log.
(true | false or t | f)
[-alf <access-log-format>]
[Dynamic] Access log format. If the option contains whitespace, wrap the option with double quotes (" "). For more information about log formats, refer to Access log format settings in JEUS Web Engine Guide.
[-aluse <true | false>]
[Dynamic] Option to use the access logs.
(true | false or t | f)
[-alhnl <true | false>]
[Dynamic] Option to use DNS Resolution for the IP address when logging in the %h format.
(true | false or t | f)
[-alext <access-log-excluded-extentions>]
[Dynamic] Extensions that do not leave any records in the access logs. To specify multiple extensions, separate each extension with a comma(,). E.g., '.gif', '.jpg'. Enter only a comma for no entry.
-hnrm <host-name>
Deletes a host name registered to the virtual host.
-hnadd <host-name>
Registers a new host name to the virtual host.
[-ast <attach-stacktrace-on-error>]
Option to attach the stack trace to the error page sent by JEUS.
[-fhn <access-log-handler-file-handler-name>]
Name of the file handler where permission is modified. This option is required when using the '-fhp'.
[-fhp <access-log-handler-file-handler-permission>]
Modifies the permission for accessing the log file. This option is required when using the '-fhn'.
-
Example
modify-virtual-host -server server1 vhost1 -tmin 1 -tmax 20 -alf "common %I"
1.8.20. modify-web-cookie-policy
Changes the HTTP Cookie Policy configurations of the web engine. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - web-engine/cookie-policy
-
Alias
modcookie
-
Usage
modify-web-cookie-policy [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] [-auer,--apply-url-encoding-rule <apply-url-encoding-rule>] [-enc,--charset-encoding <charset-encoding>] [-vh <virtual-host-name>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
[-auer,--apply-url-encoding-rule <apply-url-encoding-rule>]
Option to apply URL encoding rules.
[-enc,--charset-encoding <charset-encoding>]
Charset encoding used when applying URL encoding rules.
[-vh <virtual-host-name>]
Virtual host.
-
Example
modify-web-cookie-policy -server server1 -auer false modify-web-cookie-policy -server server1 -enc UTF-8
1.8.21. modify-web-encoding
Changes the encoding of the web engine. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - web-engine/encoding
-
Alias
modenc
-
Usage
modify-web-encoding [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] <charset-encoding> -co | -default | -forced [-url] [-req] [-res] [-vh <virtual-host-name>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
<charset-encoding>
Character set encoding name to be changed. If an invalid value is entered, an error message is displayed and the command fails.
-co | -default | -forced
Sets the entered encoding to either 'default' or 'forced'. For a request encoding, 'client-override' also can be set in addition to the two options.
[-url]
Character set encoding of Request URL.
[-req]
Character set encoding of requests.
[-res]
Character set encoding of responses.
[-vh <virtual-host-name>]
Virtual host.
-
Example
modify-web-encoding -server server1 EUC-KR -forced -url modify-web-encoding -server server1 ISO-8859-1 -default -url -res -req
1.8.22. modify-web-properties
Changes property configurations of the web engine. The changed properties are case-sensitive. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - web-engine/properties
-
Alias
modwebpr
-
Usage
modify-web-properties [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] -p,--properties <properties> [-vh <virtual-host-name>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-p,--properties <properties>
Properties to be changed in the web engine.
-
For a single property, use the "key=value" format.
-
To specify multiple properties, separate each property with a comma (,).
[-vh <virtual-host-name>]
Virtual host.
-
-
Example
modify-web-properties -server server1 -p jeus.servlet.jsp.compile-java-source-concurrently=false
1.8.23. modify-web-engine-configuration
Changes the web engine configuration dynamically. The command can only change the configurations that apply to the actual service. The monitoring cycle and the access log format information can be updated.
-
Related schema
web-engine.xsd - web-engine
-
Alias
setwebcfg, setwebconf, set-web-engine-configuration, modwebcfg, modwebconf
-
Usage
modify-web-engine-configuration [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] [-tpp <monitoring/check-thread-pool>] [-crp <monitoring/check-class-reload>] [-sp <monitoring/check-session>] [-alf <access-log-format>] [-aluse <true | false>] [-alhnl <true | false>] [-alext <access-log-excluded-extensions>] [-ast <attach-stacktrace-on-error>] [-att <async-timeout-min-threads>] [-rerp | -erp <default-error-page>] [-fhn <access-log-handler-file-handler-name>] [-fhp <access-log-handler-file-handler-permission>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
[-tpp <monitoring/check-thread-pool>]
Thread Pool check cycle.
[-crp <monitoring/check-class-reload>]
Web context reloading check cycle.
[-sp <monitoring/check-session>]
Session check cycle.
[-alf <access-log-format>]
[Dynamic] Access log format. If the option contains whitespace, wrap the option with double quotes (" "). For more information about log formats, refer to Access log format settings in JEUS Web Engine Guide.
[-aluse <true | false>]
[Dynamic] Option to use the access logs.
(true | false or t | f)
[-alhnl <true | false>]
[Dynamic] Option to use DNS Resolution for the IP address when logging in the %h format.
(true | false or t | f)
[-alext <access-log-excluded-extentions>]
[Dynamic] Extensions that do not leave any records in the access logs. To specify multiple extensions, separate each extension with a comma(,). E.g., '.gif', '.jpg'. Enter only a comma for no entry.
[-ast <attach-stacktrace-on-error>]
Option to attach the stack trace to the error page sent by JEUS.
[-att <async-timeout-min-threads>]
Minimum number of threads pools used to handle timeout when asynchronous servlets in Servlet 3.0 are used.
Set a value greater than or equal to 1. Otherwise, timeout may not be handled correctly.
[-rerp | -erp <default-error-page>]
-erp <default-error-page> sets the error page used when an error page is not set in web applications. Only a static page (HTML, HTM) can be set. Use an absolute path. Using the -rerp option can delete the configuration.
[-fhn <access-log-handler-file-handler-name>]
Name of the file handler where permission is modified. This option is required when using the '-fhp'.
[-fhp <access-log-handler-file-handler-permission>]
Modifies the permission for accessing the log file. This option is required when using the '-fhn'.
-
Example
-
The [-alf <access-log-format>] option is used.
modify-web-engine-configuration -server server1 -alf "common %I" modify-web-engine-configuration -server server1 -alf "%h %l %u %t \"%r\" %>s %b"
-
The [-aluse <use-access-log >] option is used.
modify-web-engine-configuration -server server1 -aluse false
-
The [-alext <access-log-excluded-extentions>] option is used.
modify-web-engine-configuration -server server1 -alext .gif modify-web-engine-configuration -server server1 -alext .gif,.jpg
-
The [-alext <access-log-excluded-extentions>] option is used to remove the existing extension information.
modify-web-engine-configuration -server server1 -alext
-
The [-tpp <monitoring/check-thread-pool>], [-crp <monitoring/check-class-reload>], and [-sp <monitoring/check-session>] options are used.
modify-web-engine-configuration -tpp 10000 -crp 20000 -server server1 -sp 25000
-
The [-ast <attach-stacktrace-on-error>] option is used.
modify-web-engine-configuration -server server1 -ast true
-
The [-att <async-timeout-min-threads>] option is used.
modify-web-engine-configuration -server server1 -att 10
-
The [-rerp | -erp <default-error-page>] option is used.
modify-web-engine-configuration -server server1 -erp /home/jeus/error/error.html
-
1.8.24. modify-web-listener
Changes the thread pool configurations of the HTTP, TCP, and AJP listeners.
-
Related schema
web-engine.xsd - web-engine/web-connections/http-listener, ajp13-listener, tcp-listener
-
Alias
modwebl
-
Usage
modify-web-listener [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] -name <web-connection-name> [-tmin <minimum-thread-num>] [-tmax <maximum-thread-num>] [-tidle <max-idle-time>] [-obuf <output-buffer-size>] [-http2 <enable-http2>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-name <web-connection-name>
Listener name.
[-tmin <minimum-thread-num>]
[Dynamic] Minimum number of threads in the thread pools.
[-tmax <maximum-thread-num>]
[Dynamic] Maximum number of threads in the thread pools.
[-tidle <max-idle-time>]
Maximum idle time of threads in the thread pools.
-obuf <output-buffer-size>
Response buffer size used by servlets.
[-http2 <enable-http2>]
Option for a listener to use HPPT/2. This option is applied only to HTTP listeners.
-
Example
modify-web-listener -name http1 -server server1 -obuf 200000 -http2
1.8.25. modify-webtob-connector
Changes the thread pool configuration of a WebtoB connector. The number of threads in the thread pools changes during the thread pool check cycle.
-
Related schema
web-engine.xsd - web-engine/web-connections/webtob-connector
-
Alias
modwebtobcon
-
Usage
modify-webtob-connector [-cluster <cluster-name> | -server <server-name>] [-f,--forceLock] -name <web-connection-name> [-conn <connection-count>] [-hth <hth-count>] [-tmin <minimum-thread-num>] [-tmax <maximum-thread-num>] [-tidle <max-idle-time>] [-obuf <output-buffer-size>] [-ver <wjp-version>] [-addr <server-address>] [-port <server-port> | -dsocket] [-wbhome <webtob-home>] [-cloud <cloud-mode>] [-ipcport <ipc-base-port>] [-regid <registration-id>] [-sndbuf <send-buffer-size>] [-rcvbuf <receive-buffer-size>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-name <web-connection-name>
WebtoB connector name.
[-conn <connection-count>]
[Dynamic] Number of connections to WebtoB.
[-hth <hth-count>]
Number of HTH processes.
[-tmin <minimum-thread-num>]
[Dynamic] Minimum number of threads in the thread pools.
[-tmax <maximum-thread-num>]
[Dynamic] Maximum number of threads in the thread pools.
[-tidle <max-idle-time>]
Maximum idle time of threads in the thread pools.
[-obuf <output-buffer-size>]
Servlet response buffer size.
-ver <wjp-version>
Version of the protocol used to communicate with WebtoB. Enter 1 or 2.
-addr <server-address>
WebtoB server address. If -port is used, this option is required.
-port <server-port>
WebtoB server port.
-regid <registration-id>
Registration ID in WebtoB.
[-dsocket]
Option to use Unix domain sockets (pipes) for communication between JEUS and WebtoB.
-wbhome <webtob-home>
Absolute path to WebtoB when WebtoB is installed on the same machine as JEUS.
[-cloud <cloud-mode>]
Option to use the cloud mode.
[-ipcport <ipc-base-port>]
Default port number used for communication between internal processes of WebtoB in a Windows environment. Can be set when using -dsocket.
[-sndbuf <send-buffer-size>]
SO_SNDBUF. The size of the send buffer of a TCP socket or the Unix domain socket.
If set to 0, the default value of the OS is used.
[-rcvbuf <receive-buffer-size>]
SO_RCVBUF. The size of the receive buffer of a TCP socket or the Unix domain socket.
If set to 0, the default value of the OS is used.
-
Example
modify-webtob-connector -name webtob1 -conn 30 -tmin 30 -sndbuf 1200 -rcvbuf 2400 -server server1
1.8.26. notify-auto-scale
Notifies added or deleted web servers or JEUS managed servers.
-
Related schema
web-engine.xsd
-
Alias
nas
-
Usage
notify-auto-scale -wscaleout | -wscalein | -wunlink | -jscaleout | -jscalein -address <ip-address> -port <server-port> [-group <group-id>] -
Parameters
Parameter Description -wscaleout
Notifies that a web server has been added.
-wscalein
Notifies that a web server has been deleted.
-wunlink
Notifies that a web server has been terminated.
-jscaleout
Notifies that JEUS managed server has been added.
-jscalein
Notifies that JEUS managed server has been deleted.
-address <ip-address>
IP address of a added or deleted server.
[-port <server-port>]
Port of a added or deleted server.
If you are using WebtoB, enter the JSVPORT value specified in the WebtoB settings, which is otherwise not used.
[-group <group-id>]
ID of the group to perform CWDP.
-
Example
notify-auto-scale -wscaleout -address 192.168.0.2 -port 9900 notify-auto-scale -wscalein -address 192.168.0.2 -port 9900
1.8.27. precompile-jsp
Precompiles the JSP files of deployed web contexts.
JSP files are generally compiled when the web engine receives JSP file requests from web browsers. Initial JSP file requests consume a large amount of resources for parsing and compiling, which lengthens the response time.
If there is a large number of JSP files and frequent web user requests, the time and resources required to handle the initial request can affect overall service. To prevent this effect, the precompile-jsp command is used, and the JSP source files are compiled in advance before the service starts.
The precompile-jsp command compiles the deployed modules after JEUS boots up. To use the command when JEUS is not started, use appcompiler instead.
|
-
Related schema
web-engine.xsd
-
Alias
jspc
-
Usage
precompile-jsp [-server <server-name>] [-ctx <context-name> | -id <application-id>] [-e <excluded-jsp-list-file> | -l <included-jsp-list-file>] -
Parameters
Parameter Description [-ctx <context-name>]
Web context name. If the context is in EAR, the input format must be ear-name#context-name.
[-id <application-id>]
ID of the application that includes the web context. If the application is in an EAR file, the ID cannot be set, the '-ctx' option must be used.
[-e <excluded-jsp-list-file>]
Text file that describes paths that are not compiled based on a web context. JSP paths must be relative paths from the context root and must start with a slash (/).
Use an absolute path to jsp-list-file.
[-l <included-jsp-list-file>]
Text file that describes paths compiled based on a web context. JSP paths must be relative paths from the context root and must start with a slash (/).
Use an absolute path to jsp-list-file.
-
Example
precompile-jsp -server server1 -ctx myctx
-
Note
This command can be used without being connected to the server.
1.8.28. reload-web-context
Reloads the specified entity (web context) from a disk. Reloads already loaded servlets (JSP) and classes. This command can be used when the reload functions of a servlet or class, such as enable-reload and check-class-reload, are deactivated. (enable-reload, check-class-reload).
-
Related schema
jeus-web-dd.xsd
-
Alias
webreload, reloadctx
-
Usage
reload-web-context [-cluster <cluster-name> | -server <server-name>] -ctx <context-name> -
Parameters
Parameter Description -ctx <context-name>
Context to be reloaded. A value is required.
-
Example
reload-web-context -server server1 -ctx servlets-examples
1.8.29. remove-backup-webtob
Deletes a backup WebtoB.
-
Related schema
web-engine.xsd - web-engine/web-connections/webtob-connector/webtob-backup
-
Alias
rmbackupwebtob
-
Usage
remove-backup-webtob [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] -name <web-connection-name> -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-name <web-connection-name>
Name of the WebtoB connecter that has a backup to delete.
-
Example
remove-backup-webtob -server server1 -name webtob1
1.8.30. remove-response-header
Deletes an HTTP Response Custom Header configuration from the web engine. The deleted Response Headers are case-insensitive. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - web-engine/response-header
-
Alias
rmwebrh
-
Usage
remove-response-header [-cluster <cluster-name> | -server <server-name>] [-f,--forceLock] [-a,--all | -n,--name <header-name>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
[-a,--all | -n,--name <header-name>]
-
-n, --name <header-name> deletes an HTTP Response Header. The value is case-insensitive. To specify multiple headers, separate each header with a comma (,).
-
-a, --all deletes all HTTP Response Headers that are currently set.
-
-
Example
remove-response-header -server server1 -n testheader remove-response-header -server server1 -n testheader2,testheader4 remove-response-header -server server1 -a
1.8.31. remove-tmax-connector
Deletes a Tmax connector. This command only applies to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - web-engine/web-connections/tmax-connector
-
Alias
rmtmaxcon
-
Usage
remove-tmax-connector [-cluster <cluster-name> | -server <server-name>] [-f,--forceLock] <web-connection-name> -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-name <web-connection-name>
Tmax connector name.
-
Example
remove-tmax-connector -server server1 tmax1
1.8.32. remove-virtual-host
Deletes a virtual host.
-
Related schema
web-engine.xsd - web-engine/virtual-host
-
Alias
rmvh
-
Usage
remove-virtual-host [-cluster <cluster-name> | -server <server-name>] [-f,--forceLock] <virtual-host-name> -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
<virtual-host-name>
Virtual host name.
-
Example
remove-virtual-host -server server1 host2
1.8.33. remove-valve
Deletes a valve.
-
Related schema
web-engine.xsd - pipeline/valve
-
Alias
rmvlv
-
Usage
remove-valve [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] -cn, --classname <class-name> [-vh <virtual-host-name>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-cn, --classname <class-name>
Valve class to delete from a server or virtual host.
[-vh <virtual-host-name>]
Virtual host from which a valve will be deleted. If not set, a valve is deleted from a server.
-
Example
remove-valve -server server1 -cn UserValveBase -vh host1
1.8.34. remove-valve-property
Deletes a valve property configuration. The changes only apply to the .xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - pipeline/valve/property
-
Alias
rmvlvprop
-
Usage
remove-valve-property [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] -cn, --classname <class-name> -k, --key <key> [-vh <virtual-host-name>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-cn, --classname <class-name>
Valve class that contains a property to delete. It must ba a class that inherits JEUS’s ValveBase.
-k, --key <key>
Key of a property to delete.
[-vh <virtual-host-name>]
Name of the virtual host that contains a valve of a property to delete. If not set, a property of a valve is deleted from a server.
-
Example
remove-valve-property -server server1 -cn UserValveBase -k userProperty -vh host1
1.8.35. remove-web-cookie-policy
Removes an HTTP Cookie Policy configuration from the web engine. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - web-engine/cookie-policy
-
Alias
rmcp, rmcookie
-
Usage
remove-web-cookie-policy [-cluster <cluster-name> | -server <server-name>] [-f,--forceLock] [-auer,--apply-url-encoding-rule] [-enc,--charset-encoding] [-vh <virtual-host-name>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
[-auer,--apply-url-encoding-rule]
Deletes the configuration that determines whether to apply URL Encoding Rule.
[-enc,--charset-encoding]
Deletes Charset Encoding, which is used when applying URL Encoding Rule.
[-vh <virtual-host-name>]
Virtual host.
-
Example
remove-web-cookie-policy -server server1 -auer
1.8.36. resume-web-component
Resumes a temporarily suspended web component (servlet).
|
In JEUS 6, the |
-
Related schema
web-engine.xsd - web-engine/web-connections
-
Alias
webresume
-
Usage
resume-web-component [-cluster <cluster-name> | -server <server-name>] -ctx,--context <context> -svl,--servlet <servlet> -
Parameters
Parameter Description -ctx, --context <context>
Web context that contains the servlet to be started.
This parameter must be used in conjunction with the -svl option.
Set <context> to the module name from the result of executing the command that used the application-information -type option.
[-svl,--servlet <servlet>]
Servlet to be restarted. This parameter can be used only when the context option is set.
-
Example
-
[-svl,--servlet <servlet>] option is used
resume-web-component -server server1 -ctx servlets -svl CookieExample
-
1.8.37. remove-web-encoding
Deletes a Character Set Encoding from the web engine. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - web-engine/encoding
-
Alias
rmenc
-
Usage
remove-web-encoding [-cluster <cluster-name> | -server <server-name>] [-f,--forceLock] [-url] [-req] [-res] [-vh <virtual-host-name>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
[-url]
Deletes the character set encoding of a request URL.
[-req]
Deletes the character set encoding of a request.
[-res]
Deletes the character set encoding of a response.
[-vh <virtual-host-name>]
Virtual host.
-
Example
remove-web-encoding -server server1 -url remove-web-encoding -server server1 -req -res
1.8.38. remove-web-listener
Deletes an HTTP, TCP, or AJP listener. This command only applies to the domain.xml file. In order to apply changes to the actual service, the server must be restarted. The ADMIN-HTTP listener is not deleted.
-
Related schema
web-engine.xsd - web-engine/web-connections/http-listener, ajp13-listener, tcp-listener
-
Alias
rmwebl
-
Usage
remove-web-listener [-cluster <cluster-name> | -server <server-name>] [-f,--forceLock] <web-connection-name> -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-name <web-connection-name>
Listener name.
-
Example
remove-web-listener -server server1 http1
1.8.39. remove-web-properties
Deletes property configurations from the web engine. The deleted properties are case-sensitive. The changes only apply to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - web-engine/properties
-
Alias
rmwebpr
-
Usage
remove-web-properties [-cluster <cluster-name> | -server <server-name>] [-f,--forceLock] -a,--all | -k,--keys <keys> [-vh <virtual-host-name>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-a,--all | -k,--keys <keys>
-
-k, --keys <keys> deletes a specified property from the web engine. The value is case-sensitive. To specify multiple keys, separate each key with a comma (,).
-
-a, --all deletes all properties currently set.
[-vh <virtual-host-name>]
Virtual host.
-
-
Example
remove-web-properties -server server1 -k jeus.servlet.jsp.compile-java-source-concurrently1 remove-web-properties -server server1 -a
1.8.40. remove-webtob-connector
Deletes a WebtoB connector. This command only applies to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - web-engine/web-connections/webtob-connector
-
Alias
rmwebtobcon
-
Usage
remove-webtob-connector [-cluster <cluster-name> | -server <server-name>] [-f,--forceLock] <web-connection-name> -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-name <web-connection-name>
WebtoB connector name.
-
Example
remove-webtob-connector -server server1 webtob1
1.8.41. set-valve-property
Adds a valve property configuration. An added property is case-sensitive. This command only applies to the domain.xml file. In order to apply changes to the actual service, the server must be restarted.
-
Related schema
web-engine.xsd - pipeline/valve/property
-
Alias
addvlvprop
-
Usage
set-valve-property [-cluster <cluster-name> | -server <server-name>] [-f, --forceLock] -cn, --classname <class-name> -k, --key <key> -v, --value <value> [-vh <virtual-host-name>] -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-cn, --classname <class-name>
Valve class to add a property to. It must ba a class that inherits JEUS’s ValveBase.
-k, --key <key>
Key to add to valve.
-v, --value <value>
Value to add to valve.
[-vh <virtual-host-name>]
Name of the virtual host to add a property. If not set, a property of a valve is added to a server.
-
Example
set-valve-property -server server1 -cn UserValveBase -k userProperty -v true -vh host1
1.8.42. show-request-processing-flow
Displays the process flow for a request received through a URL pattern or a host name.
-
Related schema
web-app_4_0.xsd
-
Alias
reqflow
-
Usage
show-request-processing-flow [-cluster <cluster-name> | -server <server-name>] -path <url-pattern> [-hostname <host-name>] -
Parameters
Parameter Description -path <url-pattern>
URL pattern that starts with a slash (/).
[-hostname <host-name>]
Host name specified in the HTTP host header.
-
Example
show-request-processing-flow -server server1 -path /test/index.jsp show-request-processing-flow -server server1 -path /test -hostname examples.com
1.8.43. show-web-engine-configuration
Displays web engine configurations. For more information about the items and fields displayed when executing this command, refer to the web engine structure reference in the domain.xml file.
An item not set in the domain.xml file is not displayed. In other words, if a value is displayed, the configuration is set or is assigned a default value.
-
Related schema
web-engine.xsd - web-gine
-
Alias
webcfg, webconf, showwebcfg, showwebconf
-
Usage
show-web-engine-configuration [-cluster <cluster-name> | -server <server-name>] [-vh,--virtual host] [-cn,--web-connections <connection-type>] [-al,--access-log] [-sc,--session-config] [-rh,--response-header] [-mo,--monitoring] [-enc,--encoding] [-cp,--cookie-policy] [-jsp,--jsp-engine] [-pr,--properties] [-erp,--error-page] [-att,--async-timeout_thread] [-ast,--attach-stacktrace] -
Parameters
Parameter Description [-vh,--virtual host]
Displays the virtual host configuration information.
[-cn,--web-connections <connection-type>]
Displays all web connection configuration information. If a connection type is specified, only the corresponding information will be displayed.
[-al,--access-log]
Displays the access log configuration information.
[-sc,--session-config]
Displays the web engine session configuration information.
[-rh,--response-header]
Displays the response header configuration information.
[-mo,--monitoring]
Displays the web engine monitoring configuration information.
[-enc,--encoding]
Displays the web engine encoding configuration information.
[-cp,--cookie-policy]
Displays the cookie policy configuration information.
[-jsp,--jsp-engine]
Displays the JSP engine configuration information.
[-pr,--properties]
Displays the web engine property configuration information.
[-erp,--error-page]
Displays the default error page configuration of the web engine.
[-att,--async-timeout_thread]
Displays the timeout thread configuration information of an asynchronous servlet.
[-ast,--attach-stacktrace]
Displays the configuration that determines whether to add the stack trace when an error occurs.
-
Example
-
Display all web engine configurations.
show-web-engine-configuration -server server1
-
Display web engine configurations by options.
show-web-engine-configuration -erp -att -server server1 show-web-engine-configuration -server server1 -sc
-
1.8.44. show-web-statistics
Displays the JVM memory information of the web engine, the thread pool states of each listener and connector of the web engine, and the request count and the process time of the context.
-
Related schema
web-engine.xsd
-
Alias
webstats, stat, st
-
Usage
show-web-statistics [-server <server-name>] [-ctx,--context <context-name>] [-t,--thread | -s,--session | -r,--request |-m,--memory] -
Parameters
Parameter Description [-t,--thread]
Displays the thread pool states of the web engine at each WebContainer and context level. The information displayed includes the number of allocated worker threads, the number of clients in the wait queue, and the maximum number of threads in the thread pool.
[-s,--session]
Displays the connection information of the session servers in the web engine.
The information displayed includes the name of the currently connected session server, the total number of sessions, and the number of session servers and connections used in the pool.
[-r,--request]
Displays the accumulated number of processed requests and the average process time for each context.
[-m,--memory]
Displays the state of the memory used by the current JVM in the web engine.
-
Example
-
Display thread pool information.
show-web-statistics -server server1 -ctx test -t
-
Display session server information.
show-web-statistics -server server1 -s
-
1.8.45. show-webtob-connector
Displays WebtoB connection information. It shows the current connection status.
-
Related schema
web-engine.xsd - web-engine/web-connections/webtob-connector
-
Alias
webtobcon
-
Usage
show-webtob-connector [-cluster <cluster-name> | -server <server-name>] [-f,--forceLock] -name <web-connection-name> -
Parameters
Parameter Description [-f, --forceLock]
Forcibly applies the configuration changes.
-name <web-connection-name>
WebtoB connector name.
-
Example
show-webtob-connector -server server1 -name webtob1
1.8.46. suspend-web-component
Suspends the specified servlet and shows an error page for a client.
|
In JEUS 6, the websuspend and webtob -s commands are two separate commands. From JEUS 7 onwards, however, the two commands are merged into one command. In addition, starting from JEUS 7, the suspend command for web contexts is no longer supported. Instead, it is recommended to use the stop-application command in JEUS Master Server. |
-
Related schema
web-engine.xsd - web-engine/web-connections
-
Alias
websuspend
-
Usage
suspend-web-component [-cluster <cluster-name> | -server <server-name>] -ctx,--context <context> -svl,--servlet <servlet> -
Parameters
Parameter Description -ctx, --context <context>
Web context that contains the servlet to be suspended. This parameter must be used in conjunction with the -svl option.
Set <context> to the module name from the result of executing the command that used the application-information -type option.
-svl,--servlet <servlet>
Servlet to be suspended. This parameter can be used only when the context option is set.
-
Example
-
[-svl,--servlet <servlet>] option is used
suspend-web-component -svl CookieExample -server server1 -ctx servlets
-
1.9. Session Commands
The following are two types of session commands.
-
Monitoring and control commands
These commands are used for checking or controlling the states of sessions.
Command Description Displays the information of sessions sorted by idle time.
Removes sessions that have been idle during a specified period of time regardless of a session timeout.
Displays the current backup table information of a session server.
-
Configuration change commands
These commands add, delete, or change the configuration of the session. Any modified configurations apply to the domain.xml file but not to the currently running service (memory area). Only the domain.xml file is changed. In order to apply the changes to the actual service, the server must be restarted.
Command Description Displays session information.
Changes the session configurations.
-
Session server commands
These commands are used for session storage configuration. To apply the configuration, server must restart.
Command Description Displays the existing session storage list.
Adds a session storage to a session server. For multiple session storages to be added, each name of the session storage must be unique.
Deletes a session storage from a session server.
Changes the name of session storage.
Adds or changes a session storage property.
Deletes a session storage property.
Adds a scope to a session storage. For multiple scopes to be added, each scope must be unique. If a scope is set to DOMAIN_WIDE, it can be used in the DOMAIN_WIDE cluster mode.
Changes an application or cluster that will be included in a scope.
Deletes a scope from a session storage.
Sets session configuration to be used in the context within a scope.
Displays a list of session server properties.
Adds or changes a session server property.
Deletes a session server property.
Sets up JEUS’s internal central session server.
1.9.1. Shared Options
The following options are shared by monitoring and control commands. Only one of the following options can be set.
-
[-server <server-name> ] option
-
This option is used to specify the server to which each command is applied. If this option is not set, the command is applied to the web engine of the currently connected server.
-
The description of this option is omitted from each command option description.
-
|
1.9.2. list-session
Displays the information of sessions sorted in idle time.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
lisession, lss
-
Usage
list-session [-server <server-name>] [-s,--simple ] [-count <count>] [-target <manager-name>] [-id <target-id>] -
Parameters
Parameter Description [-s,--simple ]
Results are displayed in a simple format.
[-count <count>]
Number of sessions to be monitored. (Default value: 100)
[-target <manager-name>]
Target session manager whose session information will be displayed. If not set, information about all managers within a server will be displayed.
[-id <target-id>]
Session ID used to search for a session.
-
Example
-
No option is used.
list-session -server server1
-
The [-s,--simple ] option is used.
list-session -server server1 --simple
-
1.9.3. remove-session
Removes the sessions that have been idle during a specified period of time regardless of session timeout.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
rmsession, rms
-
Usage
remove-session [-server <server-name>] [-time,--timeout <timeout(min)>] -
Parameters
Parameter Description [-time,--timeout <timeout(min)>]
Sets the timeout for removing a session.
-
Example
-
The [-time,--timeout <timeout(min)>] option is used.
remove-session -server server1 --timeout 3
-
1.9.4. show-session-server-backup-table
Displays the current backup table information of a session server.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
sssbt, sbt
-
Usage
show-session-server-backup-table [-server <server-name>]
-
Example
show-session-server-backup-table -server server1
1.9.5. show-session-configuration
Displays session information.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
getsc, ssc
-
Usage
show-session-configuration [-server <server-name>] [-h, --help] -
Parameters
Parameter Description [-server <server-name>]
Displays the configurations about the sessions set in a web engine.
[-h, --help]
Displays usage and describes each parameter. Using this command without an option will have the same result.
-
Example
-
The [-server <server-name>] option is used.
show-session-configuration -server server1
-
1.9.6. modify-session-configuration
Changes the session configurations.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
setsc, msc
-
Usage
modify-session-configuration [-server <server-name>] [-f,--forceLock] [-to,--timeout <int timeout>] [-mc,--max-session-count <int limit count>] [-rp,--reload-persistent <boolean reload-persistent>] [-tmc,--tracking-mode.cookie <boolean enable-cookie>] [-tmu,--tracking-mode.url <boolean enable-url>] [-tms,--tracking-mode.ssl <boolean enable-ssl>] [-scn,--session-cookie.cookie-name <string cookie-name>] [-sucn,--session-cookie.url-cookie-name <string url-cookie-name>] [-scv,--session-cookie.version <int version(1 or 0)>] [-scd,--session-cookie.domain <string domain-scope>] [-scp,--session-cookie.path <string path-scope>] [-scm,--session-cookie.max-age <int max-age(sec)>] [-scs,--session-cookie.secure <boolean secure] [-sch,--session-cookie.http-only <boolean http-only>] [-sca,--session-cookie.same-site <string same-site>] [-scc,--session-cookie.comment <string comment>] -
Parameters
Parameter Description [-server <server-name>]
Changes the configurations for the sessions set in a web engine.
[-f, --forceLock]
Forcibly applies the configuration changes.
[-to,--timeout <int timeout>]
Session timeout of session-config.
[-mc,--max-session-count <int maxCount>]
Maximum number of sessions to be stored.
[-rp,--reload-persistent <boolean reload-persistent>]
Reload persistent of session-config.
[-tmc,--tracking-mode.cookie <boolean enable-cookie>]
Cookie for the session-config tracking mode.
[-tmu,--tracking-mode.url <boolean enable-url>]
URL rewriting for the session-config tracking mode.
[-tms,--tracking-mode.ssl <boolean enable-ssl>]
SSL for the session-config tracking mode.
[-scn,--session-cookie.cookie-name <string cookie-name>]
Session cookie name.
[-sucn,--session-cookie.url-cookie-name <string url-cookie-name>]
Session cookie name used when sending a session by using url rewriting
[-scv,--session-cookie.version <int version(1 or 0)>]
Compilation version of session cookies.
[-scd,--session-cookie.domain <string domain-scope>]
Determines the domain scope of session cookies.
[-scp,--session-cookie.path <string path-scope>]
Determines the path scope of session cookies.
[-scm,--session-cookie.max-age <int max-age>]
Determines the length of time to keep session cookies on a browser.
[-scs,--session-cookie.secure <boolean secure>]
Determines if a browser sends cookies only over SSL.
[-sch,--session-cookie.http-only <boolean http-only>]
Determines if a browser uses session cookies only for HTTP requests.
[-sca,--session-cookie.same-site <string same-site>]
Security to prevent session ID cookies from being used in an unintentional request (cross-site request forgery).
[-scc,--session-cookie.comment <string comment>]
Session cookie description when the cookie version is 1.
-
Example
-
The [-server <server-name>] option is used.
modify-session-configuration -server server1 -to 40 -sh true -scs true
-
1.9.7. list-sessionstorages
Displays the existing session storage list.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
listsessionstorages, listss
-
Usage
list-sessionstorages
1.9.8. add-sessionstorage
Adds a session storage to a session server. For multiple session storages to be added, each name of the session storage must be unique.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
addsessionstorage, addss, addsessionstor
-
Usage
add-sessionstorage <session-storage-name> [-provider <provider>] [-property <property>] -
Parameters
Parameter Description <session-storage-name>
Name of the session storage to add.
[-provider <provider>]
Provider of the session manager to use. Set a reserved word or the used package.
Use the entire package name except for the reserved words. (e.g. jeus.session.impl.distributed.JeusDistributedWebSessionManagerProvider)
Reserved words:
-
JEUS: Uses the default session manager provided by JEUS.
-
REDIS: Uses the Redis session manager provided by JEUS.
-
HAZELCAST: Uses the Hazelcast session manager provided by JEUS.
-
RUNTIME: If another provider exists, the provider is used. If not, the JEUS session manager is used.
[-property <property >]
Property of the session storage.
-
-
Example
add-sessionstorage sessionStorage1 -provider JEUS -property connect-timeout=10000,full-search-timeout=20000
1.9.9. remove-sessionstorage
Deletes a session storage from a session server.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
removess, rmss, removesessionstor, rmsessionstor, rm,sessionstorage
-
Usage
remove-sessionstorage <session-storage-name>
-
Parameters
Parameter Description <session-storage-name>
Name of the session storage to delete.
-
Example
remove-sessionstorage sessionStorage1
1.9.10. rename-sessionstorage
Changes the name of session storage.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
renamesessionstor, renamesessionstor
-
Usage
rename-sessionstorage <session-storage-name> -name <new-session-storage-name> -
Parameters
Parameter Description <session-storage-name>
Name of the session storage to change.
-name <new-session-storage-name>
New session storage name.
-
Example
rename-sessionstorage sessionStorage1 -name new_sessionStorage
1.9.11. set-sessionstorage-property
Adds or changes a session storage property.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
setsessionstorageproperty, setsessionstorprop, setsstorprop
-
Usage
set-sessionstorage-property <session-storage-name> [-key <key-of-property>] [-value <value-of-property>] [-property <property>] -
Parameters
Parameter Description <session-storage-name>
Name of the session storage to add property.
[-key <key-of-property>]
Key of a property to add or change. Change the property value of an existing key if it is already configured, or add a new key if none is configured.
This cannot be used with the [-property] option.
[-value <value-of-property>]
Value of the property to add or change.
Required if the [-key] option is used.
[-property <property >]
Property to add or change. Change the property value of an existing key if it is already configured, or add a new key if none is configured.
This cannot be used with the [-key] option.
-
Example
-
Example of using [-key <key-of-property> -value <value-of-property>] option
set-sessionstorage-property sessionStorage1 -key full-search-timeout -value 10000
-
Example of using the [-property <property>] option
set-sessionstorage-property sessionStorage1 -property full-search-timeout=10000,backup-queue-size=200
-
1.9.12. remove-sessionstorage-property
Deletes a session storage property.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
rmsessionstorageproperty, rmsessionstorprop, rmsstorprop
-
Usage
remove-sessionstorage-property <session-storage-name> -key <key-of-property> -
Parameters
Parameter Description <session-storage-name>
Name of the session storage from which to delete the property.
-key <key-of-property>
Key of the property to delete from the session storage.
-
Example
remove-sessionstorage-property sessionStorage1 -key full-search-timeout
1.9.13. add-sessionstorage-scope
Adds a scope to a session storage. For multiple scopes to be added, each scope must be unique.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
addsessionstoragescope, addssscope, addsessionstorscope, addsss
-
Usage
add-sessionstorage-scope <scope-name> -target <storage-name> [-clusters <target-cluster-list>] [-applications <target-application-list>] -
Parameters
Parameter Description <scope-name>
Name of a session scope to add.
-target <storage-name>
Name of the session storage to add a scope. Required.
[-clusters <target-cluster-list>]
Cluster list to be included in the scope. It cannot be used with the [-applications] option.
[-applications <target-application-list>]
Application list to be included in the scope. It cannot be used with the [-clusters] option.
[-sessionType <jeus-session-type>]
Sets the type of the session server to use when the provider is JEUS. If the storage provider is not JEUS, this setting is ignored. (Default: DISTRIBUTED)
-
CENTRAL: Uses the JEUS internal central session server.
-
DISTRIBUTED: Uses the JEUS distributed session server.
-
-
Example
-
Example of using the [-clusters <target-cluster-list> ] option
add-sessionstorage-scope scope1 -target sessionStorage -clusters cluster1,cluster2 -sessionType DISTRIBUTED
-
Example of using [-applications <target-application-list>] option
add-sessionstorage-scope scope1 -target sessionStorage -applications app1,app2 -sessionType CENTRAL
-
1.9.14. set-sessionstorage-scope
Changes an application or cluster that will be included in a scope. The existing target-application or targe-cluster is deleted and newly configured.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
setsessionstoragescope, setsessionstorscope, setsss, setssscope
-
Usage
set-sessionstorage-scope <scope-name> [-clusters <target-cluster-list>] [-applications <target-application-list>] -
Parameters
Parameter Description <scope-name>
Name of a session scope to add.
[-clusters <target-cluster-list>]
Cluster list to be included in the scope. It cannot be used with the [-applications] option.
[-applications <target-application-list>]
Application list to be included in the scope. It cannot be used with the [-clusters] option.
[-sessionType <jeus-session-type>]
Sets the type of the session server to use when the provider is JEUS. If the storage provider is not JEUS, this setting is ignored. (Default: DISTRIBUTED)
-
CENTRAL: Uses the JEUS internal central session server.
-
DISTRIBUTED: Uses the JEUS distributed session server.
-
-
Example
-
Example of using the [-clusters <target-cluster-list> ] option
set-sessionstorage-scope scope1 -clusters cluster1,cluster2 -sessionType DISTRIBUTED
-
Example of using [-applications <target-application-list>] option
set-sessionstorage-scope scope1 -applications app1,app2
-
1.9.15. remove-sessionstorage-scope
Deletes a scope from a session storage.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
removessscope, rmssscope, rmsessionstorscope, removesessionstoragescope
-
Usage
remove-sessionstorage-scope <scope-name>
-
Parameters
Parameter Description <scope-name>
Name of the session scope to delete.
-
Example
remove-sessionstorage-scope scope1
1.9.16. set-sessionstorage-scope-session-config
Sets the session configuration to be used in the context within a scope.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
setsessionstoragescopesessionconfig, setssssc, setsessionstorscopesc
-
Usage
set-sessionstorage-scope-session-config <scope-name> [-timeout <timeout>] [-msc, --max-session-count <limit-count>] [-rp, --reload-persistent <reload-persistent>] [-tm, --tracking-mode <tracking-mode>] [-sc, --session-cookie <session-cookie>] -
Parameters
Parameter Description <scope-name>
Name of the scope to set session configuration.
[-timeout <timeout>]
Session timeout of session-config. (Default value: 30)
[-msc, --max-session-count <limit-count>]
Maximum number of sessions to be stored. (Default value: -1 (Unlimited))
[-rp, --reload-persistent <reload-persistent>]
Reload persistent of session-config. (Default value: false)
[-tm, --tracking-mode <tracking-mode>]
Property to add or change. Change the property value of an existing key if it is already configured, or add a new key if none is configured.
Key of the property:
-
cookie: Sets cookie for the session-config tracking mode. The value type is Boolean. (Default value: true)
-
url: Sets URL rewriting for the session-config tracking mode. The value type is Boolean. (Default value: false)
-
ssl: Sets SSL for the session-config tracking mode. The value type is Boolean. (Default value: false)
[-sc, --session-cookie <session-cookie>]
Property to add or change. Change the property value of an existing key if it is already configured, or add a new key if none is configured.
Key of the property:
-
cookie-name: Sets a session cookie name when the cookie is used to send the session. The value type is string. (Default value: JSESSIONID)
-
url-cookie-name: Sets a session cookie name when url rewriting is used to send the session. The value type is string. (Default value: jsessionid)
-
version: Sets cookie ID version. The value type is integer. (Default value: 0)
-
domain: Sets a domain name to apply the session cookie. The value type is string that contains at least one character.
-
path: Sets a path to apply the session cookie. The value type is string that contains at least one character.
-
max-age: Sets the length of time to keep the session cookie on browser. The value type is integer. (Default value: -1)
-
secure: Sets secure property of the session ID cookie. If set to true, the session ID cookie is only sent to the secure HTTP connection. The value type is Boolean. (Default value: false)
-
http-only: Determines if a browser uses the session cookie only for HTTP reqeusts. The value type is Boolean. (Default value: true)
-
same-site: Sets the security option to prevent attacks (Cross-Site Request Forgery) wherein the session cookie ID is used for unintended requests. The value type is one of the following: None, Strict, Lax or Disable.
-
comment: Records purposes or description of the cookie. The value type is string that contains at least one character.
-
-
Example
set-sessionstorage-scope-session-config scope1 -timeout 20 -shared true -session-cookie secure=true,http-only=true,path=/ -tracking-mode cookie=true
1.9.17. list-sessionserver-property
Displays a list of session server properties.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
listsessionserverproperty, listssp, listsessionservprop
-
Usage
list-sessionserver-property
1.9.18. set-sessionserver-property
Adds or changes a session server property.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
setsessionserverproperty, setsessionservprop, setsservprop
-
Usage
set-sessionserver-property [-key <key-of-property>] [-value <value-of-property>] [-property <property>] -
Parameters
Parameter Description [-key <key-of-property>]
Key of a property to add or change. Change the property value of an existing key if it is already configured, or add a new key if none is configured.
This cannot be used with the [-property] option.
[-value <value-of-property>]
Value of the property to add or change.
Required if the [-key] option is used.
[-property <property>]
Property to add or change. Change the property value of an existing key if it is already configured, or add a new key if none is configured.
This cannot be used with the [-key] option.
-
Example
-
Example of using [-key <key-of-property> -value <value-of-property>] option
set-sessionserver-property -key encoding-rule -value base64
-
Example of using the [-property <property>] option
set-sessionserver-property -property encoding-rule=raw
-
1.9.19. remove-sessionserver-property
Deletes a session server property.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
removesessionserverproperty, rmsessionservprop, rmsservprop
-
Usage
remove-sessionserver-property -key <key-of-property>
-
Parameters
Parameter Description -key <key-of-property>
Key of the property to delete from a session server.
-
Example
remove-sessionserver-property -key excluded-servers
1.9.20. set-jeus-central-session-server
Sets up JEUS’s internal central session server.
-
Related schema
jeus-session-server.xsd, jeus-session-domain.xsd
-
Alias
setjcss, setcentralss
-
Usage
set-jeus-central-session-server -primary <primary central session server> -seconday <secondary central session server> -
Parameters
Parameter Description -primary <primary central session server>
Name of the server to use as the primary session server.
-seconday <secondary central session server>
Name of the server to use as the secondary session server.
-
Example
set-jeus-central-session-server -primary server1 -secondary server2
1.10. JMS Engine Commands
The following is a list of JMS engine commands.
| Command | Description |
|---|---|
Forcibly disconnects from a JMS client. |
|
Dynamically adds a new connection factory. |
|
Dynamically adds a new destination to the JMS engine. |
|
Adds a new durable subscription. |
|
Dynamically dds a new message sort. |
|
Add s a new quota. |
|
Add a new service config. |
|
Forcibly commits a pending transaction. |
|
Controls the service status of a specified destination. |
|
Controls service status of a specified durable subscription. |
|
Deletes messages from a destination. |
|
Exports an XML type message from a specified destination. |
|
Imports an XML type message exported to a specified destination. |
|
Displays a list of all connected clients. |
|
Displays a list of all connection factories registered with the JMS engine or the information of a specified connection factory. |
|
Displays a list of all destinations registered with the JMS engine or the information of a specified destination. |
|
Displays a list of all durable subscriptions. |
|
Displays a list of message sorts. |
|
Displays destination message information. |
|
Displays a list of pending transactions. |
|
Displays a list of quotas or information of a specified quota. |
|
Displays a list of service configs or information of a specified service config. |
|
Modifies the information of a specified connection factory. |
|
Modifies the information of a specified destination. |
|
Modifies the information of a specified durable subscription. |
|
Modifies the information of a specified message sort. |
|
Modifies the information of a specified quota. |
|
Modifies the information of a specified service config. |
|
Moves messages to a different destination. |
|
Dynamically deletes a specified connection factory. |
|
Dynamically deletes a destination from the JMS engine. |
|
Dynamically deletes a specified durable subscription. |
|
Deletes a specified message sort. |
|
Deletes a specified quota. |
|
Deletes a specified service config. |
|
Sets a quota of the JMS engine. |
|
Sets an option to check whether the JMS engine is alive before failover. |
|
Sets a persistence store of the JMS engine. |
|
Displays detailed information of a specified message. |
1.10.1. Shared Options
The following options are shared by JMS engine commands. Only one of the following options can be set.
-
[-cluster <cluster-name> ] option
-
This option is used to specify the cluster to which each command applies. This option can only be used when connected to the Master Server. If connected to a Managed Server, the server command is used.
-
This option is only supported for destination related commands.
-
-
[-server <server-name> ] option
-
This option is used to specify the server to which each command applies. This option can only be used when connected to the Master Server. If connected to a Managed Server, the server command is used.
-
This option is only supported for non-destination related commands.
-
1.10.2. add-jms-connection-factory
Dynamically adds a new connection factory to the JMS engine. A queue or a topic connection factory can be created.
-
Alias
add-connection-factory, addconf, createconf
-
Usage
add-jms-connection-factory -server <server-name> -type <factory-type> -name <factory-name> [-export <export-name>] [-clientid <client-id>] -
Parameters
Parameter Description -server <server-name>
Target server name.
-type <factory-type>
Connection factory type
Input options:
-
nonxa
-
xa
-
queue
-
topic
-
xaqueue
-
xatopic
-name <factory-name>
Connection factory name.
The name must be unique within the JMS engine.
[-export <export-name>]
JNDI name of the new connection factory.
The name must be unique within the JEUS JNDI server.
[-clientid <client-id>]
Client ID given to a connection created by the connection factory.
-
-
Example
[MASTER]domain1.adminServer>add-jms-connection-factory -server adminServer -type nonxa -name MyConnectionFactory Executed Successfully. View the results using 'list-jms-connection-factories -server adminServer -name MyConnectionFactory'. [MASTER]domain1.adminServer>list-jms-connection-factories -server adminServer Connection Factory Information ================================================================================ +-------------------------------------+--------------------------------+-------+ | Factory Name | Export Name | Type | +-------------------------------------+--------------------------------+-------+ | ConnectionFactory | ConnectionFactory | nonxa | | MyConnectionFactory | MyConnectionFactory | nonxa | | XAConnectionFactory | XAConnectionFactory | xa | +-------------------------------------+--------------------------------+-------+ ================================================================================
1.10.3. add-jms-destination
Dynamically adds a new destination to the JMS engine.
-
Alias
add-destination, adddest, createdest
-
Usage
add-jms-destination -cluster <cluster-name | -server <server-name> -type <destination-type> -name <destination-name> [-export <export-name>] -
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Cluster or server to which the destination belongs.
-type <destination-type>
Destination type. (queue or topic)
-name <destination-name>
Destination name to be created.
The name must be unique within the JMS engine.
[-export <export-name>]
JNDI name of the new connection factory.
The name must be unique within the JEUS JNDI server. If not specified, the value of destination-name is used.
-
Example
[MASTER]domain1.adminServer>add-jms-destination -server adminServer -type queue -name MyQueue Executed Successfully. View the results using 'list-jms-destinations -server adminServer -name MyQueue'. [MASTER]domain1.adminServer>list-jms-destinations -server adminServer Destination information in Server adminServer ================================================================================ +---------+---------+-------+------------+-------------+-----------+-----------+ | Name | Export | Type | Remaining | Dead Letter | Produce | Consume | | | Name | | Messages | Destination | Suspended | Suspended | +---------+---------+-------+------------+-------------+-----------+-----------+ | MyQueue | MyQueue | Queue | 0 | JEUSMQ_DLQ | false | false | +---------+---------+-------+------------+-------------+-----------+-----------+ | Examples| Examples| Topic | 0 | JEUSMQ_DLQ | false | false | |Topic |Topic | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ | Examples| Examples| Queue | 0 | JEUSMQ_DLQ | false | false | |Queue |Queue | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ | JEUSMQ_D| JEUSMQ_D| Queue | 0 | JEUSMQ_DLQ | false | false | |LQ |LQ | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ For detailed information, use the -name option ================================================================================
1.10.4. add-jms-durable-subscription
Dynamically adds a new durable subscription to the JMS engine.
-
Alias
add-durable, adddur, createdur
-
Usage
add-jms-durable-subscription -cluster <cluster-name> | -server <server-name> -clientid <client-id> -name <durable-subscription-name> -topic <topic-name> [-shared] -
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Cluster or server to which the durable subscription belongs.
-clientid <client-id>
ID of the client to subscribe.
-name <durable-subscription-name>
Name of the durable subscription to create.
The name must be unique and not match any existing durable subscription within the JMS engine.
-topic <topic-name>
Name of a durable subscription topic.
[-shared]
Option to create a shared durable subscription.
-
Example
[MASTER]domain1.adminServer>add-jms-durable-subscription -server adminServer -clientid testClient -name testDurable -topic testTopic Executed Successfully. View the results using 'list-jms-durable-subscriptions -server adminServer'. [MASTER]domain1.adminServer>list-jms-durable-subscriptions -server adminServer Durable Subscription Information ================================================================================ +--------------+-----------+--------+------------------+-----------------------+ | Durable Name | Client ID | Shared | Message Selector | Remaining Messages | +--------------+-----------+--------+------------------+-----------------------+ | testDurable | testClient| false | | 0 | +--------------+-----------+--------+------------------+-----------------------+ ================================================================================
1.10.5. add-jms-message-sort
Adds a new message sort to the JMS engine.
-
Alias
add-message-sort, addmsgsort
-
Usage
add-jms-message-sort -server <server-name> -name <message-sort-name> -key <key> [-type <type>] -direction <direction> -
Parameters
Parameter Description -server <server-name>
Server to which the message sort belongs.
-name <message-sort-name>
Name of the message sort to create.
The name must be unique and not match any existing message sort within the JMS engine.
-key <key>
Key as a criterion for sorting messages.
[-type <type>]
Key type.
-direction <direction>
Sorting order of messages.
-
Example
[MASTER]domain1.adminServer>add-jms-message-sort -server adminServer -name testSort -key JMSPriority -type Integer -direction Ascending Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. View the results using 'list-jms-message-sorts -server adminServer -name testSort'. [MASTER]domain1.adminServer>list-jms-message-sorts -server adminServer -name testSort Detailed Message Sort Information ============================================================= testSort +---------------------------------------------+-------------+ | Message Sort Name | testSort | | Key | JMSPriority | | Type | INTEGER | | Direction | ASCENDING | +---------------------------------------------+-------------+ =============================================================
1.10.6. add-jms-quota
Add a new quota to the JMS engine.
-
Alias
add-quota, addquota
-
Usage
add-jms-quota -server <server-name> -name <quota-name> [-byte <max-bytes>] [-msg <max-messages>] [-shared <shared>] -
Parameters
Parameter Description -server <server-name>
Server to which the quota belongs.
-name <quota-name>
Name of the quota to create. The name must be unique and not match any existing quota within the JMS engine.
[-byte <max-bytes>]
Maximum bytes.
[-msg <max-messages>]
Maximum number of messages.
[-shared <shared>]
Determines whether to share the quota with multiple destinations.
-
Example
[MASTER]domain1.adminServer>add-jms-quota -server adminServer -name testQuota -byte 128M -msg 1M -shared false Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. View the results using 'list-jms-quotas -server adminServer -name testQuota'. [MASTER]domain1.adminServer>list-jms-quotas -server adminServer -name testQuota Detailed Quota Information =========================================================== testQuota +--------------------------------------------+------------+ | Quota Name | testQuota | | Max Bytes | 128M | | Max Messages | 1M | | Shared | false | +--------------------------------------------+------------+ ===========================================================
1.10.7. add-jms-service-config
Adds a new service to the JMS engine.
-
Alias
add-service-config, addjmsservice
-
Usage
add-jms-service-config -server <server-name> -name <service-name> [-limit <client-limit>] [-timeout <client-keepalive-timeout>] [-listener <listener>] [-virtual] [-address <address>] [-port <port>] -
Parameters
Parameter Description -server <server-name>
Server to which the service belongs.
-name <service-name>
Name of the service to create. The name must be unique and not match any existing quota within the JMS engine.
[-limit <client-limit>]
Maximum allowed clients.
[-timeout <client-keepalive-timeout>]
Time to wait for reconnection in the event of abnormal termination.
[-listener <listener>]
Listener of the service.
[-virtual]
Option to use a virtual listener.
[-address <address>]
Address of the virtual listener.
[-port <port>]
Port of the virtual listener.
-
Example
[MASTER]domain1.adminServer>add-jms-service-config -server adminServer -name testService -limit 1000 -timeout 30 -listener base Executed Successfully. View the results using 'list-jms-service-configs -server adminServer -name testService'. [MASTER]domain1.adminServer>list-jms-service-configs -server adminServer -name testService Detailed Service Config Information =================================================================== testService +---------------------------------------------------+-------------+ | Service Config Name | testService | | Client Limit | 1000 | | Client Keepalive Timeout | 30 | | Listener Name | base | +---------------------------------------------------+-------------+ ===================================================================
1.10.8. ban-jms-client
Forcibly disconnects a connection with a JMS client.
-
Alias
killentry, banentry
-
Usage
ban-jms-client -server <server-name> -name <entry-name> -
Parameters
Parameter Description -server <server-name>
Server name.
-name <entry-name>
JMS client name to which a connection is forcibly closed. The name can be displayed using the list-jms-clients command.
1.10.9. commit-jms-pending-transaction
Forcibly commits a pending transaction.
-
Alias
jmsptcommit, ptcommit
-
Usage
commit-jms-pending-transaction -server <server-name> -id <tx-id> -
Parameters
Parameter Description -server <server-name>
Server name.
-id <tx-id>
Transaction ID to be forcibly committed. The list-jms-pending-transactions command can be used to check the ID.
1.10.10. control-jms-destination
Controls the service status of a specified destination.
-
Alias
destctrl
-
Usage
control-jms-destination -cluster <cluster-name> | -server <server-name> -dest <destination-name> -suspend | -resume [-produce] [-consume] -
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Cluster or server to which the destination belongs.
-dest <destination-name>
Destination name to be controlled.
-suspend | -resume
Destination state to be controlled.
-
suspend: The destination service is temporarily suspended.
-
resume: The destination service is resumed.
[-produce]
Determines whether to control the produce of the specified destination.
[-consume]
Determines whether to control the consume of the specified destination.
-
-
Example
[MASTER]domain1.adminServer>control-jms-destination -server adminServer -dest ExamplesQueue -suspend -produce Controlling destination is successful in ExamplesQueue : [production] is suspended [MASTER]domain1.adminServer>control-jms-destination -server adminServer -dest ExamplesQueue -resume -produce Controlling destination is successful in ExamplesQueue : [production] is resumed
1.10.11. control-jms-durable-subscription
Controls service status of a specified durable subscription in the JMS engine.
-
Alias
control-durable, durctrl
-
Usage
control-jms-durable-subscription -cluster <cluster-name> | -server <server-name> -name <durable-subscription-name> -suspend | -resume -
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Cluster or server to which the durable subscription belongs.
-name <durable-subscription-name>
Name of the durable subscription to control.
-suspend | -resume
Status of the durable subscription to control.
-
suspend: Suspends the durable subscription service.
-
resume: Resumes the durable subscription service.
-
-
Example
[MASTER]domain1.adminServer>control-jms-durable-subscription -server adminServer -name testDS -suspend Executed Successfully View the results using 'list-jms-durable-subscriptions -server adminServer'. [MASTER]domain1.adminServer>list-jms-durable-subscriptions -server adminServer Durable Subscription Information ================================================================================ +----------+-------+--------+------------+---------------------+---------------+ | Durable |Client | Shared | Message | Remaining Messages | Suspended | | Name | ID | | Selector | (current) | (current) | +----------+-------+--------+------------+---------------------+---------------+ | testDS | testDS| false | | 0 | true | +----------+-------+--------+------------+---------------------+---------------+ ================================================================================
1.10.12. delete-jms-messages
Deletes a message or all messages from a queue or durable subscriber.
-
Alias
deletemsg, deletemessage, removemsg, removemessage, rmmsg
-
Usage
delete-jms-message -cluster <cluster-name> | -server <server-name> -dest <destination-name> | -durable <client-id>_<durable-name> -id <message-id> | -all -
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Cluster or server name to which the destination or the durable subscriber belongs.
-dest <destination-name> | -durable <client-id>_<durable-name>
Destination name or durable subscriber name of the message to be deleted.
-id <message-id> | -all
ID of the message to be deleted. Individual message IDs or all messages can be selected.
1.10.13. export-jms-messages
Exports a message of a destination in the XML type.
-
Alias
exmsg
-
Usage
export-jms-message -cluster <cluster-name> | -server <server-name> -dest <destination-name> | -durable <client-id>_<durable-name> -path <file-path> -id <message-id> | -all -
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Cluster or server name to which the destination or the durable subscriber belongs.
-dest <destination-name> | -durable <client-id>_<durable-name>
Destination name or durable subscriber name of the message to be exported.
-path <file-path>
Path to the file to which exported messages are saved.
-id <message-id> | -all
ID of the message to be exported. Individual message IDs or all messages can be selected.
-
Example
[MASTER]domain1.adminServer>export-jms-messages -server adminServer -dest ExamplesQueue -all -path exported.xml Successfully exported 5 messages.
1.10.14. import-jms-messages
Imports all messages from an XML file in a destination.
-
Alias
immsg
-
Usage
import-jms-message -cluster <cluster-name> | -server <server-name> -dest <destination-name> -path <file-path> [-overwrite] -
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Cluster or server to which the destination belongs.
-dest <destination-name>
Target destination of the message.
-path <file-path>
Path to the file to which imported messages are saved.
[-overwrite]
Does not issue a new JMSMessageID for an imported message. A message with the same ID is overwritten.
-
Example
[MASTER]domain1.adminServer>list-jms-messages -server adminServer -dest ExamplesQueue There are no messages in ExamplesQueue. [MASTER]domain1.adminServer>import-jms-messages -server adminServer -dest ExamplesQueue -path exported.xml Successfully imported 5 of 5 messages. [MASTER]domain1.adminServer>list-jms-messages -server adminServer -dest ExamplesQueue Messages in Destination ExamplesQueue ==================================================================================== +----------------------------+--------------+--------------------------------------+ | Message ID | Message Type | Created Time | +----------------------------+--------------+--------------------------------------+ | ID:796886517700001:1:5 | Text | Tue Nov 19 19:52:54 KST 2016 | | ID:796886517700001:1:6 | Text | Tue Nov 19 19:52:54 KST 2016 | | ID:796886517700001:1:7 | Text | Tue Nov 19 19:52:54 KST 2016 | | ID:796886517700001:1:8 | Text | Tue Nov 19 19:52:54 KST 2016 | | ID:796886517700001:1:9 | Text | Tue Nov 19 19:52:54 KST 2016 | +----------------------------+--------------+--------------------------------------+ ====================================================================================
1.10.15. list-jms-clients
Displays a list of all connected clients.
-
Alias
jmsclient, jmsentry
-
Usage
list-jms-clients -server <server-name>
-
Parameters
Parameter Description -server <server-name>
Server name of which a list of clients is displayed.
-
Example
[MASTER]domain1.adminServer>list-jms-clients -server adminServer JEUS MQ client information ================================================================================ +---------------+----------------------+------------------+----------+---------+ | Entry Name | Remote Address | Start Time |Connection| Session | | | | | Count | Count | +---------------+----------------------+------------------+----------+---------+ | JMSClient-RE63| 192.168.34.33/192.168| Tue Nov 07 | 1 | 1 | |675900002 |.34.33:49490 |16:14:32 KST 2016 | | | +---------------+----------------------+------------------+----------+---------+ | JMSClient-RE63| 192.168.34.33/192.168| Tue Nov 07 | 1 | 1 | |675900001 |.34.33:49484 |16:14:23 KST 2016 | | | +---------------+----------------------+------------------+----------+---------+ ================================================================================
1.10.16. list-jms-connection-factories
Displays a list of all connection factories registered with the JMS engine or the information of a specified connection factory.
-
Alias
jmscf, jmsconf
-
Usage
list-jms-connection-factoryies -server <server-name> [-n, --name <factory-name>] -
Parameters
Parameter Description -server <server-name>
Server name to which the connection factory belongs.
[-n, --name <factory-name>]
Connection factory name. If not specified, brief descriptions of all connection factories are displayed.
-
Example
[MASTER]domain1.adminServer>list-jms-connection-factories -server adminServer Connection Factory Information ================================================================================ +-------------------------------------+--------------------------------+-------+ | Factory Name | Export Name | Type | +-------------------------------------+--------------------------------+-------+ | ConnectionFactory | ConnectionFactory | nonxa | | XAConnectionFactory | XAConnectionFactory | xa | +-------------------------------------+--------------------------------+-------+ ================================================================================ [MASTER]domain1.adminServer>list-jms-connection-factories -server adminServer -name ConnectionFactory =================================================================== ConnectionFactory +---------------------------------------------+-------------------+ | Factory Name | ConnectionFactory | | Export Name | ConnectionFactory | | Type | nonxa | | Client ID | not-set | | Max Client Session Threads | 100 | | Clustered | false | | Broker Selection Policy | round-robin | +---------------------------------------------+-------------------+ =================================================================== ================================================================================ +------------------------------------------------------------------------------+ | Addresses | +------------------------------------------------------------------------------+ | 192.168.0.26:9741(JMSServiceChannel-internal) | +------------------------------------------------------------------------------+ ================================================================================
1.10.17. list-jms-destinations
Displays a list of all destinations registered with the JMS engine or the information of a specified destination.
-
Alias
jmsdest, dest
-
Usage
list-jms-destinations -cluster <cluster-name> | -server <server-name> [-n, --name <destination-name>] -
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Cluster or server to which the destination belongs.
[-n, --name <destination-name>]
Destination name. If not specified, brief descriptions of all destinations are displayed.
-
Example
[[MASTER]domain1.adminServer>list-jms-destinations -server adminServer Destination information in Server adminServer ================================================================================ +---------+---------+-------+------------+-------------+-----------+-----------+ | Name | Export | Type | Remaining | Dead Letter | Produce | Consume | | | Name | | Messages | Destination | Suspended | Suspended | +---------+---------+-------+------------+-------------+-----------+-----------+ | Examples| Examples| Topic | 0 | JEUSMQ_DLQ | false | false | |Topic |Topic | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ | Examples| Examples| Queue | 0 | JEUSMQ_DLQ | false | false | |Queue |Queue | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ | JEUSMQ_D| JEUSMQ_D| Queue | 0 | JEUSMQ_DLQ | false | false | |LQ |LQ | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ For detailed information, use the -name option ================================================================================ [MASTER]domain1.adminServer>list-jms-destinations -server adminServer -name ExamplesQueue Detailed destination information in Server adminServer ================================================================== ExamplesQueue +------------------------------------------------+---------------+ | Export Name | ExamplesQueue | | Type | Queue | | Dead Letter Destination | JEUSMQ_DLQ | | Consumer Count | 0 | | Processed Messages | 0 | | Remaining Messages | 0 | | Pending Messages | 0 | | Dispatched Messages | 0 | | Delivered Messages | 0 | | Expired Messages | 0 | | Moved Messages | 0 | | Memory Usage (current) | 0kb | | Memory Usage (high mark) | 0kb | | Produce Suspended | false | | Consume Suspended | false | +------------------------------------------------+---------------+ ==================================================================
1.10.18. list-jms-durable-subscriptions
Displays a list of all durable subscriptions registered with the JMS engine.
-
Alias
durable, dur
-
Usage
list-jms-durable-subscriptions -cluster <cluster-name> | -server <server-name>
-
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Server or cluster whose list of durable subscribers is displayed.
-
Example
[MASTER]domain1.adminServer>list-jms-durable-subscriptions -server adminServer Durable Subscription Information ================================================================================ +--------------+-----------+--------+------------------+-----------------------+ | Durable Name | Client ID | Shared | Message Selector | Remaining Messages | +--------------+-----------+--------+------------------+-----------------------+ | testDurable | testClient| false | | 5 | +--------------+-----------+--------+------------------+-----------------------+ ================================================================================
1.10.19. list-jms-message-sorts
Displays a list of all message sorts registered with the JMS engine or information of a specified message sort.
-
Alias
list-message-sorts, msgsort
-
Usage
list-jms-destinations -server <server-name> [-name <message-sort-name>] -
Parameters
Parameter Description -server <server-name>
Server to which the message sort belongs.
[-name <message-sort-name>]
Name of the message sort to display its information. If not specified, brief descriptions of all message sorts is displayed.
-
Example
[[MASTER]domain1.adminServer>list-jms-message-sorts -server adminServer Message Sort Information ============================================================= +-----------------------------------+-------------+---------+ | Message Sort Name | Key | Type | +-----------------------------------+-------------+---------+ | testSort | JMSPriority | INTEGER | +-----------------------------------+-------------+---------+ ============================================================= [[MASTER]domain1.adminServer>list-jms-message-sorts -server adminServer -name testSort Detailed Message Sort Information ============================================================= testSort +---------------------------------------------+-------------+ | Message Sort Name | testSort | | Key | JMSPriority | | Type | INTEGER | | Direction | DESCENDING | +---------------------------------------------+-------------+ =============================================================
1.10.20. list-jms-messages
Displays destination message information.
-
Alias
message, msg
-
Usage
list-jms-messages -cluster <cluster-name> | -server <server-name> -dest <destination-name> | -durable <client-id>_<durable-name> [-s,--selector <message-selector>] [-offset <offset>] [-size <size>] [-id <message-id-pattern>] [-type <message-type>] [-from <YYYY:MM:DD:HH:MM:SS>] [-to <YYYY:MM:DD:HH:MM:SS>] -
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Cluster or server name to which the destination or the durable subscriber belongs.
-dest <destination-name> | -durable <client-id>_<durable-name>
Destination name or durable subscriber name of the message to be displayed.
[-s, --selector <message-selector>]
Only messages with the specified message selector can be displayed.
[-offset <offset>]
Offset from which messages are displayed when messages are divided before displayed.
[-size <size>]
Number of messages to be displayed when messages are divided before displayed.
[-id <message-id-pattern>]
Only messages with the specified message ID pattern can be displayed.
[-type <message-type>]
Only messages with the specified message type can be displayed.
[-from <YYYY:MM:DD:HH:MM:SS>]
Only messages received after the specified time can be displayed.
[-to <YYYY:MM:DD:HH:MM:SS>]
Only messages received before the specified time can be displayed.
-
Example
[MASTER]domain1.adminServer>list-jms-messages -server adminServer -dest ExamplesQueue Messages in Destination ExamplesQueue. ================================================================================== +-----------------------------+-------------+------------------------------------+ | Message ID | Message Type| Created Time | +-----------------------------+-------------+------------------------------------+ | ID:7968865177000001:1:1 | Text | Mon Nov 07 20:10:01 KST 2016 | | ID:7968865177000001:1:2 | Text | Mon Nov 07 20:10:03 KST 2016 | | ID:7968865177000001:1:3 | Text | Mon Nov 07 20:10:04 KST 2016 | | ID:7968865177000001:1:4 | Text | Mon Nov 07 20:10:06 KST 2016 | +-----------------------------+-------------+------------------------------------+ ==================================================================================
1.10.21. list-jms-pending-transactions
Displays a list of transactions in the indoubt state.
-
Alias
jmspt, pt
-
Usage
list-jms-pending-transactions -server <server-name>
-
Parameters
Parameter Description -server <server-name>
Name of the server whose transactions are in the indoubt state are displayed.
1.10.22. list-jms-quotas
Displays a list of all quotas registered with the JMS engine or information of a specified quota.
-
Alias
list-quotas, jmsquota
-
Usage
list-jms-quotas -server <server-name> [-name <quota-name>] -
Parameters
Parameter Description -server <server-name>
Server to which the quota belongs.
[-name <quota-name>]
Name of the quota to display its information. If not specified, brief descriptions of all quotas are displayed.
-
Example
[[MASTER]domain1.adminServer>list-jms-quotas -server adminServer Quota Information ==================================================== +-----------------------------+-----------+--------+ | Quota Name | Max Bytes | Shared | +-----------------------------+-----------+--------+ | testQuota | 128M | false | +-----------------------------+-----------+--------+ ==================================================== [MASTER]domain1.adminServer>list-jms-quotas -server adminServer -name testQuota Detailed Quota Information =========================================================== testQuota +---------------------------------------------+-----------+ | Quota Name | testQuota | | Max Bytes | 128M | | Max Messages | 1M | | Shared | false | +---------------------------------------------+-----------+ ===========================================================
1.10.23. list-jms-service-configs
Displays a list of service registered with the JMS engine or information of a specified service.
-
Alias
list-service-config, jmsservice
-
Usage
list-jms-service-configs -server <server-name> [-name <service-name>] -
Parameters
Parameter Description -server <server-name>
Server to which the service belongs.
[-name <service-name>]
Name of the service to display its information. If not specified, brief descriptions of all services are displayed.
-
Example
[[MASTER]domain1.adminServer>list-jms-service-configs -server adminServer Service Config Information ================================================================================ +------------------------------+---------------------+-------------------------+ | Service Config Name | Listener Name | Virtual Listener | +------------------------------+---------------------+-------------------------+ | default | jms | | | testService | base | | +------------------------------+---------------------+-------------------------+ ================================================================================ [MASTER]domain1.adminServer>list-jms-service-configs -server adminServer -name testService Detailed Service Config Information =================================================================== testService +---------------------------------------------------+-------------+ | Service Config Name | testService | | Client Limit | 1000 | | Client Keepalive Timeout | 30 | | Listener Name | base | +---------------------------------------------------+-------------+ ===================================================================
1.10.24. modify-jms-connection-factory
Modifies the information of a specified connection factory
-
Alias
modify-connection-factory, modifyconf
-
Usage
modify-jms-connection-factory -server <server-name> -name <factory-name> [-type <factory-type>] [-service <service-name>] [-export <export-name>] [-clientid <client-id>] [-policy <server-selection-policy>] [-time <request-blocking-time>] [-re <reconnect-enabled>] [-period <reconnect-period>] [-interval <reconnect-interval>] -
Parameters
Parameter Description -server <server-name>
Server name.
-name <factory-name>
Name of the connection factory to modify.
[-type <factory-type>]
Connection factory type.
Input options:
-
nonxa
-
xa
-
queue
-
topic
-
xaqueue
-
xatopic
[-service <service-name>]
Service of the connection factory.
[-export <export-name>]
JNDI name of the new connection factory.
The name must be unique within the JEUS JNDI server.
[-clientid <client-id>]
Client ID given to a connection created by the connection factory.
[-policy <server-selection-policy>]
Policy of selecting a channel when creating a connection.
Input options:
-
Round-robin
-
Random
[-time <request-blocking-time>]
Time for the client to wait for a response.
[-re <reconnect-enabled>]
Determines whether to reconnect when the connection is lost.
[-period <reconnect-period>]
Maximum time to attempt reconnection.
[-interval <reconnect-interval>]
Interval of attempting recconection.
-
-
Example
[MASTER]domain1.adminServer>modify-jms-connection-factory -server adminServer -name MyConnectionFactory -type xa -service testService -export MyCF -clientid MyId -policy Random Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. View the results using 'list-jms-connection-factories -server adminServer -name MyConnectionFactory'. [MASTER]domain1.adminServer>list-jms-connection-factories -server adminServer -name MyConnectionFactory Detailed Connection Factory Information ==================================================================== MyConnectionFactory +--------------------------------------------+---------------------+ | Factory Name | MyConnectionFactory | | Export Name | MyCF | | Type | xa | | Client ID | MyId | | Max Client Session Threads | 100 | | Clustered | false | | Server Selection Policy | Random | +--------------------------------------------+---------------------+ ==================================================================== ================================================================================ +------------------------------------------------------------------------------+ | Addresses | +------------------------------------------------------------------------------+ | 192.168.13.13:9736(JMSServiceChannel-testService) | +------------------------------------------------------------------------------+ ================================================================================
1.10.25. modify-jms-destination
Modifies the information of a specified destination.
-
Alias
modify-destination, modifydest
-
Usage
modify-jms-destination -cluster <cluster-name> | -server <server-name> -name <destination-name> [-type <destination-type>] [-export <export-name>] [-subLimit <subscription-limit>] [-quota <quota>] [-pendLimit <max-pending-limit>] [-dispatch <resume-dispatch-factor>] [-sort <message-sort>] [-deadLetter <dead-letter-destination>] [-policy <expiration-policy>] [-delay <redelivery-delay>] -
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Cluster or server to which the destination to be modified belongs.
-name <destination-name>
Name of the destination to modify.
[-type <destination-type>]
Destination type. (queue or topic)
[-export <export-name>]
JNDI name of the destination.
The name must be unique within the JEUS JNDI server.
[-subLimit <subscription-limit>]
Maximum consumers that can access the destination.
[-quota <quota>]
Quota to limit message data of the destination.
[-pendLimit <max-pending-limit>]
Maximum allowable messages that did not receive an acknowledgement.
[-disptach <resume-dispatch-factor>]
Factor to dispatch the pending messages.
[-sort <message-sort>]
Message sort to be applied to the destination.
[-deadLetter <dead-letter-destination>]
Name of the destination to store unprocessed messages.
[-policy <expiration-policy>]
Option of handling the expired messages:
Input options:
-
Delete
-
Redirect
[-delay <redelivery-delay>]
Delay time until a message is resent.
-
-
Example
[MASTER]domain1.adminServer>modify-jms-destination -server adminServer -name MyQueue -type topic -export MyTopic -deadLetter ExamplesTopic Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. View the results using 'list-jms-destinations -server adminServer -name MyQueue'. [MASTER]domain1.adminServer>list-jms-destinations -server adminServer -name MyQueue Detailed destination information in Server adminServer ====================================================================== MyQueue +----------------------------------------------------+---------------+ | Export Name | MyTopic | | Type | Topic | | Dead Letter Destination | ExamplesTopic | | Consumer Count | 0 | | Processed Messages | 0 | | Remaining Messages (current) | 0 | | Remaining Messages (high mark) | 0 | | Pending Messages | - | | Dispatched Messages | - | | Delivered Messages | 0 | | Expired Messages | 0 | | Moved Messages | - | | Removed Messages | - | | Poisoned Messages | 0 | | Memory Usage (current) | 0kb | | Memory Usage (high mark) | 0kb | | Production Suspended | false | | Consumption Suspended | false | +----------------------------------------------------+---------------+ ======================================================================
1.10.26. modify-jms-durable-subscription
Modifies the information of a specified durable subscription
-
Alias
modify-durable-subscription, modify-durable, modifydur
-
Usage
modify-jms-durable-subscription -cluster <cluster-name> | -server <server-name> -name <durable-subscription-name> [-clientid <client-id>] [-topic <topic-name>] [-shared <shared>] [-selector <message-selector>] [-sort <message-sort>] -
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Cluster or server to which a durable subscription to be modified belongs.
-name <durable-subscription-name>
Name of the durable subscription to modify.
[-clientid <client-id>]
ID of the client to subscribe.
[-topic <topic-name>]
Topic name of the durable subscription.
[-shared <shared>]
Determines whether the durable subscription is shared.
[-selector <message-selector>]
Message selector name of the durable subscription.
[-sort <message-sort>]
Message sort name of the durable subscription.
-
Example
[MASTER]domain1.adminServer>modify-jms-durable-subscription -server adminServer -name testDS -clientid testClientID -shared false -selector TESTNO>=1 Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. View the results using 'list-jms-durable-subscriptions -server adminServer'. [MASTER]domain1.adminServer>list-jms-durable-subscriptions -server adminServer Durable Subscription Information ================================================================================ +---------+---------+--------+------------+---------------------+--------------+ | Durable | Client | Shared | Message | Remaining Messages | Suspended | | Name | ID | | Selector | (current) | (current) | +---------+---------+--------+------------+---------------------+--------------+ | testDS | testCli | false | TESTNO>=1 | 0 | false | | |entID | | | | | +---------+---------+--------+------------+---------------------+--------------+ ================================================================================
1.10.27. modify-jms-message-sort
Modifies the information of a specified message sort.
-
Alias
modify-message-sort, modmsgsort
-
Usage
modify-jms-message-sort -server <server-name> -name <message-sort-name> [-key <key>] [-type <type>] [-direction <direction>] -
Parameters
Parameter Description -server <server-name>
Server to which the message sort to be modified belongs.
-name <message-sort-name>
Name of the message sort to modify.
[-key <key>]
Key as a criterion for sorting messages.
[-type <type>]
Key type.
[-direction <direction>]
Sorting order of messages.
-
Example
[MASTER]domain1.adminServer>modify-jms-message-sort -server adminServer -name testSort -key JMSMessageID -type String -direction Descending Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. View the results using 'list-jms-message-sorts -server adminServer -name testSort'. [MASTER]domain1.adminServer>list-jms-message-sorts -server adminServer -name testSort Detailed Message Sort Information ============================================================= testSort +--------------------------------------------+--------------+ | Message Sort Name | testSort | | Key | JMSMessageID | | Type | STRING | | Direction | DESCENDING | +--------------------------------------------+--------------+ =============================================================
1.10.28. modify-jms-quota
Modifies the information of a specified quota
-
Alias
modify-quota, modquota
-
Usage
modify-jms-quota -server <server-name> -name <quota-name> [-byte <max-bytes>] [-msg <max-messages>] [-shared <shared>] -
Parameters
Parameter Description -server <server-name>
Server to which the quota to be modified belongs.
-name <quota-name>
Name of the quota to modify.
[-byte <max-bytes>]
Maximum bytes.
[-msg <max-messages>]
Maximum number of messages.
[-shared <shared>]
Determines whether to share the quota with multiple destinations.
-
Example
[MASTER]domain1.adminServer>modify-jms-quota -server adminServer -name testQuota -byte 256M -msg 2M -shared true Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. View the results using 'list-jms-quotas -server adminServer -name testQuota'. [MASTER]domain1.adminServer>list-jms-quotas -server adminServer -name testQuota Detailed Quota Information =========================================================== testQuota +---------------------------------------------+-----------+ | Quota Name | testQuota | | Max Bytes | 256M | | Max Messages | 2M | | Shared | true | +---------------------------------------------+-----------+ ===========================================================
1.10.29. modify-jms-service-config
Modifies the information of a specified service.
-
Alias
modify-service-config, modifyjmsservice
-
Usage
modify-jms-service-config -server <server-name> -name <service-name> [-limit <client-limit>] [-timeout <client-keepalive-timeout>] [-listener <listener>] [-virtual] [-address <address>] [-port <port>] -
Parameters
Parameter Description -server <server-name>
Server to which the service to be modified belongs.
-name <service-name>
Name of the service to modify.
[-limit <client-limit>]
Maximum allowed clients.
[-timeout <client-keepalive-timeout>]
Time to wait for reconnection in the event of abnormal termination.
[-listener <listener>]
Listener of the service.
[-virtual]
Option to use a virtual listener.
[-address <address>]
Address of the virtual listener.
[-port <port>]
Port of the virtual listener.
-
Example
[MASTER]domain1.adminServer>modify-jms-service-config -server adminServer -name testService -limit 2000 -timeout 100 Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. View the results using 'list-jms-service-configs -server adminServer -name testService'. [MASTER]domain1.adminServer>list-jms-service-configs -server adminServer -name testService Detailed Service Config Information =================================================================== testService +---------------------------------------------------+-------------+ | Service Config Name | testService | | Client Limit | 2000 | | Client Keepalive Timeout | 100 | | Listener Name | base | +---------------------------------------------------+-------------+ ===================================================================
1.10.30. move-jms-messages
Moves messages to a different destination.
-
Alias
mvmsg
-
Usage
move-jms-message -cluster <cluster-name> | -server <server-name> -dest <destination-name> | -durable <client-id>_<durable-name> -id <message-id> | -all -target <destination-name> -
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Cluster or server name to which the destination or the durable subscriber belongs.
-dest <destination-name> | -durable <client-id>_<durable-name>
Destination name or durable subscriber name of the message to be displayed.
-id <message-id> | -all
ID of the message to be moved. Individual message IDs or all messages can be selected.
-target <destination-name>
Target destination of the message.
-
Example
[MASTER]domain1.adminServer>list-jms-destinations -server adminServer Destination information in Server adminServer ================================================================================ +---------+---------+-------+------------+-------------+-----------+-----------+ | Name | Export | Type | Remaining | Dead Letter | Produce | Consume | | | Name | | Messages | Destination | Suspended | Suspended | +---------+---------+-------+------------+-------------+-----------+-----------+ | MyQueue | MyQueue | Queue | 0 | JEUSMQ_DLQ | false | false | +---------+---------+-------+------------+-------------+-----------+-----------+ | Examples| Examples| Topic | 0 | JEUSMQ_DLQ | false | false | |Topic |Topic | | | | | | +---------+---------+-------+------------+-------------+-----------+------- ----+ | Examples| Examples| Queue | 5 | JEUSMQ_DLQ | false | false | |Queue |Queue | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ | JEUSMQ_D| JEUSMQ_D| Queue | 0 | JEUSMQ_DLQ | false | false | |LQ |LQ | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ For detailed information, use the -name option ================================================================================ [MASTER]domain1.adminServer>move-jms-messages -server adminServer -dest ExamplesQueue -all -target MyQueue Successfully moved all messages from ExamplesQueue to MyQueue is successful [MASTER]domain1.adminServer>list-jms-destinations -server adminServer Destination information in Server adminServer ================================================================================ +---------+---------+-------+------------+-------------+-----------+-----------+ | Name | Export | Type | Remaining | Dead Letter | Produce | Consume | | | Name | | Messages | Destination | Suspended | Suspended | +---------+---------+-------+------------+-------------+-----------+-----------+ | MyQueue | MyQueue | Queue | 5 | JEUSMQ_DLQ | false | false | +---------+---------+-------+------------+-------------+-----------+-----------+ | Examples| Examples| Topic | 0 | JEUSMQ_DLQ | false | false | |Topic |Topic | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ | Examples| Examples| Queue | 0 | JEUSMQ_DLQ | false | false | |Queue |Queue | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ | JEUSMQ_D| JEUSMQ_D| Queue | 0 | JEUSMQ_DLQ | false | false | |LQ |LQ | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ For detailed information, use the -name option ================================================================================
1.10.31. remove-jms-connection-factory
Dynamically deletes a specified connection factory from the JMS engine.
-
Alias
remove-connection-factory, deleteconf, removeconf
-
Usage
remove-jms-connection-factory -server <server-name> -name <factory-name> -
Parameters
Parameter Description -server <server-name>
Server name to which the connection factory belongs.
-name <factory-name>
Connection factory to be deleted.
-
Example
[MASTER]domain1.adminServer>list-jms-connection-factories -server adminServer Connection Factory information ================================================================================ +-------------------------------------+--------------------------------+-------+ | Factory Name | Export Name | Type | +-------------------------------------+--------------------------------+-------+ | ConnectionFactory | ConnectionFactory | nonxa | | MyConnectionFactory | MyConnectionFactory | nonxa | | XAConnectionFactory | XAConnectionFactory | xa | +-------------------------------------+--------------------------------+-------+ ================================================================================ [MASTER]domain1.adminServer>remove-jms-connection-factory -server adminServer -name MyConnectionFactory Executed Successfully. View the results using 'list-jms-connection-factories -server adminServer'. [MASTER]domain1.adminServer>list-jms-connection-factories -server adminServer Connection Factory information ================================================================================ +-------------------------------------+--------------------------------+-------+ | Factory Name | Export Name | Type | +-------------------------------------+--------------------------------+-------+ | ConnectionFactory | ConnectionFactory | nonxa | | XAConnectionFactory | XAConnectionFactory | xa | +-------------------------------------+--------------------------------+-------+ ================================================================================
1.10.32. remove-jms-destination
Dynamically deletes a destination from the JMS engine.
-
Alias
remove-destination, deletedest, removedest
-
Usage
remove-jms-destination -cluster <cluster-name> | -server <server-name> -name <destination-name> -
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Cluster or server to which the destination belongs.
-name <destination-name>
Destination name to be deleted.
-
Example
[MASTER]domain1.adminServer>list-jms-destinations -server adminServer Destination information in Server adminServer ================================================================================ +---------+---------+-------+------------+-------------+-----------+-----------+ | Name | Export | Type | Remaining | Dead Letter | Produce | Consume | | | Name | | Messages | Destination | Suspended | Suspended | +---------+---------+-------+------------+-------------+-----------+-----------+ | MyQueue | MyQueue | Queue | 0 | JEUSMQ_DLQ | false | false | +---------+---------+-------+------------+-------------+-----------+-----------+ | Examples| Examples| Topic | 0 | JEUSMQ_DLQ | false | false | |Topic |Topic | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ | Examples| Examples| Queue | 0 | JEUSMQ_DLQ | false | false | |Queue |Queue | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ | JEUSMQ_D| JEUSMQ_D| Queue | 0 | JEUSMQ_DLQ | false | false | |LQ |LQ | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ For detailed information, use the -name option ================================================================================ [MASTER]domain1.adminServer>remove-jms-destination -server adminServer -name MyQueue Executed Successfully. View the results using 'list-jms-destinations -server adminServer'. [MASTER]domain1.adminServer>list-jms-destinations -server adminServer Destination information in Server adminServer ================================================================================ +---------+---------+-------+------------+-------------+-----------+-----------+ | Name | Export | Type | Remaining | Dead Letter | Produce | Consume | | | Name | | Messages | Destination | Suspended | Suspended | +---------+---------+-------+------------+-------------+-----------+-----------+ | Examples| Examples| Topic | 0 | JEUSMQ_DLQ | false | false | |Topic |Topic | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ | Examples| Examples| Queue | 0 | JEUSMQ_DLQ | false | false | |Queue |Queue | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ | JEUSMQ_D| JEUSMQ_D| Queue | 0 | JEUSMQ_DLQ | false | false | |LQ |LQ | | | | | | +---------+---------+-------+------------+-------------+-----------+-----------+ For detailed information, use the -name option ================================================================================
1.10.33. remove-jms-durable-subscription
Dynamically deletes a specified durable subscription from the JMS engine.
-
Alias
remove-durable, deletedur, removedur
-
Usage
remove-jms-durable-subscription -cluster <cluster-name> | -server <server-name> -name <durable-subscription-name> -
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Cluster or server to which the durable subscription belongs.
-name <durable-subscription-name>
Name of the durable subscription to delete.
-
Example
[MASTER]domain1.adminServer>list-jms-durable-subscriptions -server adminServer Durable Subscription Information ================================================================================ +--------------+-----------+--------+------------------+-----------------------+ | Durable Name | Client ID | Shared | Message Selector | Remaining Messages | +--------------+-----------+--------+------------------+-----------------------+ | testDurable1 | client1 | false | | 5 | | testDurable2 | client2 | false | | 0 | +--------------+-----------+--------+------------------+-----------------------+ ================================================================================ [MASTER]domain1.adminServer>remove-jms-durable-subscription -server adminServer -name testDurable2 Executed Successfully. View the results using 'list-jms-durable-subscriptions -server adminServer'. [MASTER]domain1.adminServer>list-jms-durable-subscriptions -server adminServer Durable Subscription Information ================================================================================ +--------------+-----------+--------+------------------+-----------------------+ | Durable Name | Client ID | Shared | Message Selector | Remaining Messages | +--------------+-----------+--------+------------------+-----------------------+ | testDurable1 | client1 | false | | 5 | +--------------+-----------+--------+------------------+-----------------------+ ================================================================================
1.10.34. remove-jms-message-sort
Deletes a specified message sort from the JMS engine.
-
Alias
remove-message-sort, removemsgsort
-
Usage
remove-jms-message-sort -server <server-name> -name <message-sort-name> -
Parameters
Parameter Description -server <server-name>
Server to which the message sort belongs.
-name <message-sort-name>
Name of the message sort to delete.
-
Example
[MASTER]domain1.adminServer>list-jms-message-sorts -server adminServer Message Sort Information ============================================================= +----------------------------------+--------------+---------+ | Message Sort Name | Key | Type | +----------------------------------+--------------+---------+ | testSort | JMSMessageID | STRING | | testSort2 | JMSPriority | INTEGER | +----------------------------------+--------------+---------+ ============================================================= [MASTER]domain1.adminServer>remove-jms-message-sort -server adminServer -name testSort2 Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. View the results using 'list-jms-message-sorts -server adminServer'. [MASTER]domain1.adminServer>list-jms-message-sorts -server adminServer Message Sort Information ============================================================= +-----------------------------------+--------------+--------+ | Message Sort Name | Key | Type | +-----------------------------------+--------------+--------+ | testSort | JMSMessageID | STRING | +-----------------------------------+--------------+--------+ =============================================================
1.10.35. remove-jms-quota
Deletes a specified quota from the JMS engine.
-
Alias
remove-quota, removequota
-
Usage
remove-jms-quota -server <server-name> -name <quota-name> -
Parameters
Parameter Description -server <server-name>
Server to which the quota belongs.
-name <quota-name>
Name of the quota to delete.
-
Example
[MASTER]domain1.adminServer>list-jms-quotas -server adminServer Quota Information ==================================================== +-----------------------------+-----------+--------+ | Quota Name | Max Bytes | Shared | +-----------------------------+-----------+--------+ | testQuota | 256M | true | | testQuota2 | 128M | false | +-----------------------------+-----------+--------+ ==================================================== [MASTER]domain1.adminServer>remove-jms-quota -server adminServer -name testQuota2 Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. View the results using 'list-jms-quotas -server adminServer'. [MASTER]domain1.adminServer>list-jms-quotas -server adminServer Quota Information ==================================================== +-----------------------------+-----------+--------+ | Quota Name | Max Bytes | Shared | +-----------------------------+-----------+--------+ | testQuota | 256M | true | +-----------------------------+-----------+--------+ ====================================================
1.10.36. remove-jms-service-config
Deletes a specified service config from the JMS engine.
-
Alias
remove-service-config,deletejmsservice, removejmsservice
-
Usage
remove-jms-service-config -server <server-name> -name <service-name> -
Parameters
Parameter Description -server <server-name>
Server to which the service belongs.
-name <service-name>
Name of the service to delete.
-
Example
[MASTER]domain1.adminServer>list-jms-service-configs -server adminServer Service Config Information ================================================================================ +------------------------------+---------------------+-------------------------+ | Service Config Name | Listener Name | Virtual Listener | +------------------------------+---------------------+-------------------------+ | default | jms | | | testService | base | | +------------------------------+---------------------+-------------------------+ ================================================================================ [MASTER]domain1.adminServer>remove-jms-service-config -server adminServer -name testService Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. View the results using 'list-jms-service-configs -server adminServer'. [MASTER]domain1.adminServer>list-jms-service-configs -server adminServer Service Config Information ================================================================================ +------------------------------+---------------------+-------------------------+ | Service Config Name | Listener Name | Virtual Listener | +------------------------------+---------------------+-------------------------+ | default | jms | | +------------------------------+---------------------+-------------------------+ ================================================================================
1.10.37. set-jms-engine-quota
Sets a quota of the JMS engine.
-
Alias
set-engine-quota
-
Usage
set-jms-engine-quota -server <server-name> [-byte <max-bytes>] [-msg <max-messages>] -
Parameters
Parameter Description -server <server-name>
Server to which the JMS engine to configure belongs.
[-byte <max-bytes>]
Maximum bytes allowed in the JMS engine.
[-msg <max-messages>]
Maximum number of messages allowed in the JMS engine.
-
Example
[MASTER]domain1.adminServer>set-jms-engine-quota -server adminServer -byte 256M -msg 1M Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. View the results using 'set-jms-engine-quota -server adminServer'. [MASTER]domain1.adminServer>set-jms-engine-quota -server adminServer Engine Quota Information =============================================================== JMS Engine +-----------------------------------------------------+-------+ | Max Bytes | 256M | | Max Messages | 1M | +-----------------------------------------------------+-------+ ===============================================================
1.10.38. set-jms-failover-check
Sets an option to check whether the JMS engine is alive before failover
-
Alias
set-jms-failover, set-failover
-
Usage
set-jms-failover-check -server <server-name> [-timeout <timeout>] [-count <count>] -
Parameters
Parameter Description -server <server-name>
Server to which the JMS engine to configure belongs.
[-timeout <timeout>]
Time to check whether the JMS engine is alive before failover.
[-count <count>]
Maximum number of checks to determine whether the JMS engine is alive before failover.
-
Example
[MASTER]domain1.adminServer>set-jms-failover-check -server adminServer -timeout 10 -count 5 Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. View the results using 'set-jms-failover-check -server adminServer'. [MASTER]domain1.adminServer>set-jms-failover-check -server adminServer Failover check Information ===================================================================== JMS Engine +-----------------------------------------------------------+-------+ | Failover Check Timeout | 10 | | Failover Check Count | 5 | +-----------------------------------------------------------+-------+ =====================================================================
1.10.39. set-jms-persistence-store
Sets a persistence store of the JMS engine.
-
Alias
set-jms-store, set-persistence-store, setjmsstore
-
Usage
set-jms-persistence-store -server <server-name> -none | -journal | -jdbc [-dir <base-dir>] [-init <initial-log-file-count>] [-max <max-log-file-count>] [-size <log-file-size>] [-dest <destination-table>] [-durSub <durable-subscription-table>] [-property <property>] [-source <data-source>] [-msg <message-table>] [-subMsg <subscription-message-table>] [-tx <transaction-table>] -
Parameters
Parameter Description -server <server-name>
Server to which the JMS engine to configure belongs.
-none | -journal | -jdbc
Option to select the store type.
[-dir <base-dir>]
Directory where the journal store is configured.
[-init <initial-log-file-count>]
Number of log files to initially create when creating a journal store.
[-max <max-log-file-count>]
Maximum number of log files of the journal store.
[-size <log-file-size>]
Log file size of the journal store.
[-dest <destination-table>]
Destination table name of the journal and JDBC store.
[-durSub <durable-subscription-table>]
Durable subscription table name of the journal and JDBC store.
[-property <property>]
Additional setting of the journal store.
[-source <data-source>]
Data Source of the JDBC store.
[-msg <message-table>]
Message table name of the JDBC store.
[-subMsb <subscription-message-table>]
Subscription table name of the JDBC store.
[-tx <transaction-table>]
Transaction table name of the JDBC store.
-
Example
[MASTER]domain1.adminServer>set-jms-persistence-store -server adminServer -journal -dir store -init 5 -max 50 -size 256M -dest ADMIN_DEST -durSub ADMIN_DS Executed successfully, but some configurations were not applied dynamically. It might be necessary to restart the server. View the results using 'set-jms-persistence-store -server adminServer'. [MASTER]domain1.adminServer>set-jms-persistence-store -server adminServer Persistence Store Information ==================================================================== Persistence Store +-----------------------------------------------------+------------+ | Persistence Store Type | Journal | | Base Dir | store | | Initial Log File Count | 5 | | Max Log File Count | 50 | | Log File Size | 256M | | Destination Table | ADMIN_DEST | | Durable Subscription Table | ADMIN_DS | | Property | | +-----------------------------------------------------+------------+ ====================================================================
1.10.40. view-jms-message
Displays detailed information of a specified message.
-
Alias
viewmsg
-
Usage
view-jms-messages -cluster <cluster-name> | -server <server-name> -dest <destination-name> | -durable <client-id>_<durable-name> -id <message-id> -
Parameters
Parameter Description -cluster <cluster-name> | -server <server-name>
Cluster or server name to which the destination or the durable subscriber belongs.
-dest <destination-name> | -durable <client-id>_<durable-name>
Destination name or durable subscriber name of the message to be displayed.
-id <message-id>
Message ID of the message to be displayed.
-
Example
[MASTER]domain1.adminServer>list-jms-messages -server adminServer -dest ExamplesQueue Messages in Destination ExamplesQueue ================================================================================== +--------------------+--------------+--------------------------------------------+ | Message ID | Message Type | Created Time | +--------------------+--------------+--------------------------------------------+ | ID:1242976880:1:0 | Text | Tue Nov 19 15:53:17 KST 2016 | | ID:1242976880:1:1 | Text | Tue Nov 19 15:53:17 KST 2016 | | ID:1242976880:1:2 | Text | Tue Nov 19 15:53:17 KST 2016 | | ID:1242976880:1:3 | Text | Tue Nov 19 15:53:17 KST 2016 | | ID:1242976880:1:4 | Text | Tue Nov 19 15:53:17 KST 2016 | +--------------------+--------------+--------------------------------------------+ ================================================================================== [MASTER]domain1.adminServer>view-jms-message -server adminServer -dest ExamplesQueue -id ID:1242976880:1:0 Message ID:1242976880:1:0 ================================================================================ +------------------+-----------------------------------------------------------+ | Attribute name | Value | +------------------+-----------------------------------------------------------+ | Message ID | ID:1242976880:1:0 | | Destination Name | ExamplesQueue | | Delivery Mode | 2 | | Message Type | Text | | Correlation ID | | | Created Time | Tue Nov 19 15:53:17 KST 2016 | | Expiration Time | - | | Time-to-live | 0 | | Priority | 4 | | Redelivered | false | | Delivery Time | Tue Nov 19 15:53:17 KST 2016 | | Redelivery Limit | 4 | | Reply To | | | Message Body | Test Message | +------------------+-----------------------------------------------------------+ ================================================================================
1.11. Data Source Commands
The following is a list of data source commands that manage data sources and change data source configurations.
| Command | Description |
|---|---|
Dynamically adds a cluster data source to the domain. |
|
Dynamically adds a data source to the domain. |
|
Displays a list of all cluster data sources in the domain. If a data source ID is specified, its configuration is displayed in detail. |
|
Displays a list of all data sources in the domain. If a data source ID is specified, its configuration is displayed in detail. |
|
Changes the configuration of a cluster data source. Most configurations can be changed dynamically. |
|
Changes the configuration of a data source. Some configurations can be changed dynamically. |
|
Deletes a cluster data source from the domain. |
|
Deletes a data source from the domain. |
|
Checks if a data source configuration is correct. |
1.11.1. add-cluster-data-source
Dynamically adds a cluster data source to the domain.
-
Alias
addcds
-
Usage
add-cluster-data-source [-id,--dataSourceID <data-source-id>] [-en,--exportName <export-name>] [-dss,--dataSourceSelector <data-source-selector>] [-lb,--loadBalance <true | false>] [-ipc,--isPreConn <is-pre-conn>] [-ufb,--useFailback <use-failback>] [-cds,--componentDataSources <component-data-sources>] [-oc,--onsConfig <ons-config>] [-dsa,--dataSourceAffinity <data-source-affinity>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [-id,--dataSourceID <data-source-id>]
Cluster data source ID. The cluster data source ID must be unique within a domain.
[-en,--exportName <export-name>]
JNDI name of the cluster data source.
If two data sources are guaranteed to be bound to different JNDIs on different servers, they can have the same JNDI name. Different data sources with the same JNDI names are not allowed on the same server.
If not specified, the cluster data source ID is used as the JNDI name.
Multiple JNDI names can be specified by using comma (,) delimiter, and JNDI lookup can be used for any of these specified JNDI names.
[-dss,--dataSourceSelector <data-source-selector>]
When obtaining connections from cluster data sources, users or developers can customize policies for a specific component data source selection by inheriting and implementing the jeus.jdbc.helper.DataSourceSelector abstract class. Next, the class name to include the implementation class package name must be set. After it is set, the Load Balance configuration is ignored, and failover and failback are performed unconditionally.
-
Failover is performed for one round, starting from the next index of the component data source that was initially selected.
-
Failback is performed in the same fashion as when Use Failback is set. The implementor must consider synchronization when defining the policy.
[-lb,--loadBalance <true | false>]
Option to use load balancing.
-
true : the configuration --useFailback is ignored.
[-ipc,--isPreConn <is-pre-conn>]
Option to create connection pools of component data sources that belong to the cluster data source, in advance. Although creating connection pools in advance can improve performance, it is not a good use of resources.
[-ufb,--useFailback <use-failback>]
This option provides compatibility with earlier versions of JEUS that only support failover.
Option to perform failback using the main data source after performing failover using the assistant data source. By default, failback is performed.
To perform failback, --checkQuery and --checkQueryPeriod must be set for the main data source.
[-cds,--componentDataSources <component-data-sources>]
Data source ID of the component data sources that belong to the cluster data source.
[-oc,--onsConfig <ons-config>]
Set to use a cluster data source associated with ONS. Specify an IP address and a port number used for each ONS RAC node to perform ONS communication. The cluster data source uses the information to make a socket connection and operates as an ONS client.
Use the following format.
nodes=host1:6200,host2:6200
[-dsa,--dataSourceAffinity <data-source-affinity>]
Option for data source affinity configuration for transactions. If this option is turned on, a transaction process is executed only for a single member data source instance. Therefore, global transaction performance is improved, and the performance is ensured even for local transactions with XA emulation configuration when using cluster data sources.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays the detailed results of the configuration changes.
-
-
Example
[MASTER]domain1.adminServer>add-cluster-data-source -id cds1 -cds ds1,ds2 Successfully performed the ADD operation for cluster data source [cds1] to domain. Check the results using "add-cluster-data-source"
1.11.2. add-data-source
Dynamically adds a data source to the domain.
-
Alias
addds
-
Usage
add-data-source [-id,--dataSourceID <data-source-id>] [-user,--user <user>] [-pw,--password <password>] [-algorithm,--algorithm <algorithm>] [-ac,--autoCommit <auto-commit-value>] [-sqt,--stmtQueryTimeout <statement-query-timeout>] [-aocl,--actionOnConnectionLeak <action-on-connection-leak>] [-min,--min <minimum-size>] [-max,--max <maximum-size>] [-step,--step <resizing-step>] [-period,--period <resizing-period>] [-ew,--enableWait <true | false>] [-wt,--waitTime <wait-time>] [-dds,--delegationDataSource <delegation-data-source>] [-muc,--maxUseCount <max-use-count>] [-cq,--checkQuery <check-query>] [-cqt,--checkQueryTimeout <check-query-timeout>] [-nvi,--nonValidationInterval <non-validation-interval>] [-cqp,--checkQueryPeriod <check-query-period>] [-cqrc,--checkQueryRetrialCount <check-query-retrial-count>] [-dpocq,--destroyPolicyOnCheckQuery <destroy-policy-on-check-query>] [-scs,--stmtCachingSize <stmt-caching-size>] [-sfs,--stmtFetchSize <stmt-fetch-size>] [-ct,--connectionTrace <true | false>] [-gct,--getConnectionTrace <get-connection-trace>] [-act,--autoCommitTrace <auto-commit-trace>] [-ust,--useSqlTrace <use-sql-trace>] [-kcho,--keepConnectionHandleOpen <keep-connection-handle-open>] [-en,--exportName <export-name>] [-dscn,--dataSourceClassName <data-source-class-name>] [-dst,--dataSourceType <data-source-type>] [-vendor,--vendor <vendor>] [-desc,--description <description>] [-sn,--serverName <server-name>] [-pn,--portNumber <port-number>] [-dn,--databaseName <database-name>] [-lt,--loginTimeout <login-timeout>] [-il,--isolationLevel <isolation-level>] [-pdt,--poolDestroyTimeout <pool-destroy-timeout>] [-prop,--property <property>] [-sxe,--supportXaEmulation <support-xa-emulation>] [-ddba,--delegationDba <delegation-dba>] [-dbat,--dbaTimeout <dba-timeout>] [-cqc,--checkQueryClass <check-query-class>] [-is,--initSql <init-sql>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [-id,--dataSourceID <data-source-id>]
Data source ID. The data source ID must be unique within the domain.
[-user,--user <user>]
Database user ID. The user must have the proper permissions to handle transactions.
[-pw,--password <password>]
Database user password. To encrypt the password before storing, use the '{algorithm:keysize}ciphertext' format.
[-algorithm,--algorithm <algorithm>]
[Dynamic] Encryption algorithm for the database user password. This option must be used with the -password option.
The following algorithm can be used:
-
base64
-
DES
-
DESede
-
AES
-
SEED
-
Blowfish
[-ac,--autoCommit <TRUE | FALSE | DRIVER> ]
Option to use the auto-commit configuration of the data source.
-
TRUE
-
FALSE
-
DRIVER: If DRIVER is selected, the auto-commit configuration of the JDBC driver is used. The configuration value can only be set when the transaction is not linked to the connection pool data sources that use the XA emulation function or linked to XA data sources.
[-sqt,--stmtQueryTimeout <statement-query-timeout> ]
Query timeout used for java.sql.Statement objects created through the data source connection.
JEUS calls the query timeout configuration method (java.sql.Statement#setQueryTimeout) defined in the JDBC API and implemented by the JDBC driver vendor. The query timeout differs depending on the JDBC driver vendors. (Unit: ms)
[-aocl,--actionOnConnectionLeak <action-on-connection-leak>]
Determines the action JEUS takes when it detects JDBC connections used by applications (stateless component - servlet/JSP, stateless session bean, MDB), but not yet returned.
Input options: (If not specified, the configuration of the server is used.)
-
NO_ACTION: Take no actions.
-
WARNING: Log the information of the JDBC connections that are not returned.
-
AUTO_CLOSE: Log the information of the unreturned JDBC connections and collect them.
[-min,--min <minimum-size>]
Minimum number of connections in the connection pool.
[-max,--max <maximum-size>]
Maximum number of connections in the connection pool.
[-step,--step <resizing-step>]
Number of DB connections obtained if the number of connections is insufficient and the number of connections in the connection pool is less than the maximum value.
[-period,--period <resizing-period>]
Period in which to adjust the connection pool size based on the minimum value. If the connection pool size is greater than the minimum value, unused connections are closed. If the size is less than the minimum value, new DB connections are obtained. (Unit: ms)
[-ew,--enableWait <true | false>]
Determines how to handle connection requests when no connections are available in the pool and additional connections cannot be added.
-
true: Wait until a connection is available.
-
false: Create a new (disposable) connection that does not enter the pool and is discarded after use.
[-wt,--waitTime <wait-time>]
Period in which to wait for a connection if --enable-wait is true. If a connection cannot be obtained within the period, JEUS generates a timeout exception. (Unit: ms)
[-dds,--delegationDataSource <delegation-data-source>]
If a request does not involve a transaction, it is better to get a connection from the connection pool data source instead of from the XA data source.
In this situation, a connection from the connection pool data source provides the same functionality as a connection from the XA data source, but with a smaller impact on system performance. Therefore, when using the XA data source, delegate connection requests unrelated to transactions to the connection pool data source.
When Oracle and DB2 use XA connections for both cases, with or without transactions, unexplained errors can occur; using this configuration can help avoid such situation.
[-muc,--maxUseCount <max-use-count>]
Maximum number of times a connection can be used. If the number of times a connection is used exceeds the specified number, the connection is replaced with a new connection.
The default value is 0: a connection is not replaced.
[-cq,--checkQuery <check-query>]
Query (query-check) that checks the connection status.
Simple selection queries are recommended when validating the connection to the DB.
[-cqt,--checkQueryTimeout <check-query-timeout>]
When a check-query is executed to check the connection status, a driver can be in the wait state indefinitely if the DB does not respond. Apply a timeout to the check-query to avoid this situation.
This can be set by using the java.sql.Statement#setQueryTimeout method defined in the JDBC API.
If the value is less than 1000ms, the value is set to 0. (Unit: ms)
[-nvi,--nonValidationInterval <non-validation-interval>]
Option to skip connection checks if the interval between the last check and the recent check is within the specified interval.
This option is useful for when overhead is created by frequent connection checks. (Unit: ms)
For example, if the option is set to 5000 ms, and 5 seconds has not passed since the last connection check, connections are sent to the applications without being checked.
[-cqp,--checkQueryPeriod <check-query-period>]
Checks the connections in the connection pool at the specified interval to delete faulty connections. (Unit: ms)
For data sources that belong to cluster data sources, this option must be set to be used for checking its own state.
[-cqrc,--checkQueryRetrialCount <check-query-retrial-count>]
If --destroyPolicyOnCheckQuery is set to FAILED_CONNECTION_ONLY, a connection check is performed only once.
If --destroyPolicyOnCheckQuery is set to ALL_CONNECTIONS and a problem is detected during the first connection check, all other connections are also checked, resulting in the connection check being performed twice.
The total connection check count is determined by adding this option value to the default connection check value.
[-dpocq,--destroyPolicyOnCheckQuery <destroy-policy-on-check-query>]
Policy for connections in the connection pool when invalid connections are found.
-
FAILED_CONNECTION_ONLY: Delete only invalid connections.
-
ALL_CONNECTIONS: Delete invalid connections and validate other connections in the connection pool. If another invalid connection is detected in the pool, delete all the connections from the connection pool.
[-scs,--stmtCachingSize <stmt-caching-size>]
JDBC driver parses SQL statements sent as parameters whenever applications request prepared statements. Parsing SQL statements can affect system performance, so JEUS offers a function that internally caches the prepared statements. This option sets the number of prepared statements that can be cached. If this option is used, connections are always open, so the clear job performed by the driver is not executed.
For example, when the Oracle JDBC driver sets auto-commit to false and closes the connection without executing commit or rollback, commit is executed unconditionally.
The use of the statement caching function is recommended if provided by the JDBC driver.
[-sfs,--stmtFetchSize <stmt-fetch-size>]
Fetch size of the JDBC driver statement.
[-ct,--connectionTrace <true | false>]
Option to offer additional information for connections.
-
false: --getConnectionTrace and --autoCommitTrace cannot be used.
[-gct,--getConnectionTrace <get-connection-trace>]
Displays the stack trace when the application calls java.sql.DataSource#getConnection.
[-act,--autoCommitTrace <auto-commit-trace>]
Records logs and the stack trace to server logs when java.sql.Connection#setAutoCommit is called. The log level of jeus.jdbc.connection-trace logger must be set to FINE.
[-ust,--useSqlTrace <use-sql-trace>]
Displays SQL queries used by connections.
If the jeus.jdbc.sql logger level is set to FINE, the SQL query history can be checked in server logs. If this function is used, the statement implementation class of the JDBC driver is wrapped by a JEUS class. Therefore, applications that cast and use statement objects of the JDBC driver cannot use this function.
[-kcho,--keepConnectionHandleOpen <keep-connection-handle-open>]
If this option is set to true and an XA connection is used and returned to the pool, the handle (or the logical connection) is kept open.
This function is required when using DB2 universal drivers. If this option is used, connections are always open, so the clear job performed by the driver is not executed.
For example, when the Oracle JDBC driver sets auto-commit to false and closes the connection without executing commit or rollback, commit is executed unconditionally.
[-en,--exportName <export-name>]
JNDI name of the data source.
If two data sources are guaranteed to be bound to different JNDIs on different servers, they can have the same JNDI name. Different data sources with the same JNDI names are not allowed on the same server.
If not specified, the data source ID is used as the JNDI name.
Multiple JNDI names can be specified by using comma (,) delimiter, and JNDI lookup can be used for any of these specified JNDI names.
[-dscn,--dataSourceClassName <data-source-class-name>]
JDBC driver data source class name. Enter the full name, including the package name.
[-dst,--dataSourceType <data-source-type>]
Data source type.
-
DATA_SOURCE: Connection pooling service is not provided.
-
CONNECTION_POOL_DATA_SOURCE: Connection pooling service is provided.
-
XA_DATA_SOURCE: XA interface and the connection pooling service are provided.
[-vendor,--vendor <vendor>]
JDBC driver vendor name.
[-desc,--description <description>]
Displays data source descriptions.
[-sn,--serverName <server-name>]
Host name or IP at which the database runs.
[-pn,--portNumber <port-number>]
Listener port number of the database.
[-dn,--databaseName <database-name>]
Database name.
Sets the database SID (for Oracle).
[-lt,--loginTimeout <login-timeout>]
Maximum time to wait for the login screen to connect to the database. (Unit: seconds)
[-il,--isolationLevel <isolation-level>]
Transaction isolation level defined in java.sql.Connection.
[-pdt,--poolDestroyTimeout <pool-destroy-timeout>]
Amount of time in wait for the connection pool destroy command to complete. (Unit: ms)
The connection pool is destroyed when applications that defined the data sources are undeployed or when the server goes down. During this process, if the connection is used for network communication with a DB, the destroy process can be blocked and left hanging indefinitely. This option is used to avoid this situation. If this option is set, connection pool destruction waits the specified time period and then performs undeployment or terminates the server.
[-prop,--property <property>]
This option provides a unified configuration method to accommodate all property configurations that can differ by JDBC driver.
For a single property, use the 'name:type=value' format.
To specify multiple properties, separate each property with a comma (,).
[-sxe,--supportXaEmulation <support-xa-emulation>]
This option only applies to the connection pool data source type. This option emulates the connection pool data source connection to participate in a global transaction (XA).
For JEUS 6 and earlier versions, this option is an alternative to LocalXADataSource. It is used in the ConnectionPoolDataSource type connection pools.
Note that only one connection pool data source can participate per transaction.
[-ddba,--delegationDba <delegation-dba>]
JNDI name of the data source (hereafter DBA delegation data source), which has permission to forcibly terminate database sessions (DBA permission). If there is a delay in handling a query through the connection received from the data source, a query that forcibly terminates the DB session is sent to the DB using the DBA delegation data source. After the application handles exceptions that occurred due to the disabled connection, it closes the connection. JEUS then deletes the connection and gets a new connection from the DB and assigns it to the connection pool.
Currently, this function is supported for Tibero, Oracle, and Sybase. It was created to suspend queries that take too long to perform for JDBC driver version 2.0 and earlier. For JDBC driver version 3.0 and later, it is recommended to use java.sql.Statement#setQueryTimeout instead of forcibly terminating DB sessions.
Especially for XA data sources, if DB sessions are terminated while XA operates normally, the XA operation can generate an error. Therefore, use the statement query timeout and the transaction timeout properties.
[-dbat,--dbaTimeout <dba-timeout>]
The delegation DBA data source waits the specified time period for queries on a connection to finish. If timeout occurs, a query is sent to the DB that forcibly terminates the DB session.
This option only applies when --delegationDba is set. (Unit: ms)
[-cqc,--checkQueryClass <check-query-class>]
Class name, which includes the package name, that implements the function for users or developers who want to customize the connection check function.
The class must implement the jeus.jdbc.connectionpool.JEUSConnectionChecker interface.
[-is,--initSql <init-sql>]
SQL query that is initially handled after a connection has been created.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays the detailed results of the configuration changes.
-
-
Example
[MASTER]domain1.adminServer>add-data-source -id ds1 -dst ConnectionPoolDataSource -dscn oracle.jdbc.pool.OracleConnectionPoolDataSource -sn 61.77.153.4 -pn 1521 -dn orcl -user scott -password tiger -property driverType;java.lang.String;thin Successfully performed the ADD operation for data source [ds1] to domain. Check the results using "add-data-source"
1.11.3. list-cluster-data-sources
Displays a list of all cluster data sources in the domain. If a data source ID is specified, its configuration is displayed in detail.
-
Alias
listcds, lscds
-
Usage
list-cluster-data-sources [-id,--dataSourceID <data-source-id>]
-
Parameters
Parameter Description [-id,--dataSourceID <data-source-id>]
Cluster data source ID.
-
Example
[MASTER]domain1.adminServer>list-cluster-data-sources The list of cluster data sources ================================================================================ +--------------------+-----------------------+---------------------------------+ | Data source ID | JNDI export name | Component data sources | +--------------------+-----------------------+---------------------------------+ | cds1 | cds1 | [ds1, ds2] | | cds2 | cds2 | [ds3, ds4] | +--------------------+-----------------------+---------------------------------+ ================================================================================ [MASTER]domain1.adminServer>list-cluster-data-sources -id cds1 The configuration of cluster data source [cds1] ================================================================================ +------------------------------------------+-----------------------------------+ | Configuration name | Configuration value | +------------------------------------------+-----------------------------------+ | id | cds1 | | export-name | cds1 | | load-balance | false | | is-pre-conn | false | | use-failback | true | | component-data-sources | [ds1, ds2] | +------------------------------------------+-----------------------------------+ ================================================================================
1.11.4. list-data-sources
Displays a list of all data sources in the domain. If a data source ID is specified, its configuration is displayed in detail.
-
Alias
listds, lsds
-
Usage
list-data-sources [-id,--dataSourceID <data-source-id>]
-
Parameters
Parameter Description [-id,--dataSourceID <data-source-id>]
Data source ID.
-
Example
[MASTER]domain1.adminServer>list-data-sources The list of data sources ================================================================================ +----------------+----------------------+--------------------------------------+ | Data source ID | JNDI export name | Data source type | +----------------+----------------------+--------------------------------------+ | ds1 | ds1 | ConnectionPoolDataSource | | ds2 | ds2 | ConnectionPoolDataSource | | ds3 | ds3 | ConnectionPoolDataSource | +----------------+----------------------+--------------------------------------+ ================================================================================ [MASTER]domain1.adminServer>list-data-sources -id ds1 The configuration of the data source [ds1] ================================================================================ +----------------------------+-------------------------------------------------+ | Configuration name | Configuration value | +----------------------------+-------------------------------------------------+ | id | ds1 | | export-name | ds1 | | data-source-class-name | oracle.jdbc.pool.OracleConnectionPoolDataSource | | data-source-type | ConnectionPoolDataSource | | vendor | oracle | | server-name | 61.77.153.4 | | port-number | 1521 | | database-name | orcl | | user | scott | | password | tiger | | login-timeout | 0 | | auto-commit | DRIVER | | stmt-query-timeout | 0 | | pool-destroy-timeout | 10000 | | property | [driverType;java.lang.String;thin] | | action-on-connection-leak | Warning | | support-xa-emulation | false | | min | 10 | | max | 50 | | step | 1 | | period | 3600000 | | enable-wait | false | | wait-time | 10000 | | max-use-count | 0 | | dbaTimeout | -1 | | stmt-caching-size | -1 | | stmt-fetch-size | -1 | | connection-trace | false | | get-connection-trace | true | | auto-commit-trace | false | | use-sql-trace | false | | keep-connection-handle-open| false | +----------------------------+-------------------------------------------------+ ================================================================================
1.11.5. modify-cluster-data-source
Changes the configuration of a cluster data source. Most configurations can be changed dynamically.
-
Alias
modifycds
-
Usage
modify-cluster-data-source -id,--dataSourceID <data-source-id> [-en,--exportName <export-name>] [-dss,--dataSourceSelector <data-source-selector>] [-lb,--loadBalance <true | false>] [-ipc,--isPreConn <is-pre-conn>] [-ufb,--useFailback <use-failback>] [-cds,--componentDataSources <component-data-sources>] [-oc,--onsConfig <ons-config>] [-dsa,--dataSourceAffinity <data-source-affinity>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -id,--dataSourceID <data-source-id>]
Cluster data source ID.
The cluster data source ID must be unique within a domain.
[-en,--exportName <export-name>]
JNDI name of the cluster data source.
If two data sources are guaranteed to be bound to different JNDIs on different servers, they can have the same JNDI name. Different data sources with the same JNDI names are not allowed on the same server.
If not specified, the cluster data source ID is used as the JNDI name. In order to undo this setting, enter "unset" as the option value.
Multiple JNDI names can be specified by using comma (,) delimiter, and JNDI lookup can be used for any of these specified JNDI names.
[-dss,--dataSourceSelector <data-source-selector>]
[Dynamic] When obtaining connections from cluster data sources, users or developers can customize policies for a specific component data source selection by inheriting and implementing the jeus.jdbc.helper.DataSourceSelector abstract class.
Next, the class name to include the implementation class package name must be set. After it is set, the Load Balance configuration is ignored, and failover and failback are performed unconditionally.
-
Failover is performed for one round, starting from the next index of the component data source that was initially selected.
-
Failback is performed in the same fashion as when Use Failback is set. The implementor must consider synchronization when defining the policy.
To undo this setting, enter 'unset' as the option value.
[-lb,--loadBalance <true | false>]
[Dynamic] Option to use load balancing.
-
true : the configuration --useFailback is ignored.
[-ipc,--isPreConn <is-pre-conn>]
[Dynamic] Option to create connection pools of component data sources that belong to the cluster data source, in advance. Although creating connection pools in advance can improve performance, it is not a good use of resources.
[-ufb,--useFailback <use-failback>]
[Dynamic] Option to perform failback using the main data source after performing failover using the assistant data source. By default, failback is performed.
This option provides compatibility with earlier versions of JEUS that only support failover.
To perform failback, --checkQuery and --checkQueryPeriod must be set for the main data source.
[-cds,--componentDataSources <component-data-sources>]
[Dynamic] Data source ID of the component data sources that belong to the cluster data source.
[-oc,--onsConfig <ons-config>]
Set to use a cluster data source associated with ONS. Specify an IP address and a port number used for each ONS RAC node to perform ONS communication. The cluster data source uses the information to make a socket connection and operates as an ONS client.
Use the following format.
nodes=host1:6200,host2:6200
[-dsa,--dataSourceAffinity <data-source-affinity>]
Option for data source affinity configuration for transactions. If this option is turned on, a transaction process is executed only for a single member data source instance. Therefore, global transaction performance is improved, and the performance is ensured even for local transactions with XA emulation configuration when using cluster data sources.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays the detailed results of the configuration changes.
-
-
Example
[MASTER]domain1.adminServer>modify-cluster-data-source -id cds1 -cds ds1 Successfully performed the MODIFY operation for configuration of the cluster data source [cds1]. Check the results using "modify-cluster-data-source -id cds1"
1.11.6. modify-data-source
Changes the configuration of a data source. Some configurations can be changed dynamically.
-
Alias
modifyds
-
Usage
modify-data-source -id,--dataSourceID <data-source-id> [-user,--user <user>] [-pw,--password <password>] [-algorithm,--algorithm <algorithm>] [-ac,--autoCommit <TRUE | FALSE | DRIVER> ] [-sqt,--stmtQueryTimeout <statement-query-timeout>] [-aocl,--actionOnConnectionLeak <action-on-connection-leak>] [-min,--min <minimum-size>] [-max,--max <maximum-size>] [-step,--step <resizing-step>] [-period,--period <resizing-period>] [-ew,--enableWait <true | false>] [-wt,--waitTime <wait-time>] [-dds,--delegationDataSource <delegation-data-source>] [-muc,--maxUseCount <max-use-count>] [-cq,--checkQuery <check-query>] [-cqt,--checkQueryTimeout <check-query-timeout>] [-nvi,--nonValidationInterval <non-validation-interval>] [-cqp,--checkQueryPeriod <check-query-period>] [-cqrc,--checkQueryRetrialCount <check-query-retrial-count>] [-dpocq,--destroyPolicyOnCheckQuery <destroy-policy-on-check-query>] [-scs,--stmtCachingSize <stmt-caching-size>] [-sfs,--stmtFetchSize <stmt-fetch-size>] [-ct,--connectionTrace <true | false>] [-gct,--getConnectionTrace <get-connection-trace>] [-act,--autoCommitTrace <auto-commit-trace>] [-ust,--useSqlTrace <use-sql-trace>] [-kcho,--keepConnectionHandleOpen <keep-connection-handle-open>] [-en,--exportName <export-name>] [-dscn,--dataSourceClassName <data-source-class-name>] [-dst,--dataSourceType <data-source-type>] [-vendor,--vendor <vendor>] [-desc,--description <description>] [-sn,--serverName <server-name>] [-pn,--portNumber <port-number>] [-dn,--databaseName <database-name>] [-lt,--loginTimeout <login-timeout>] [-il,--isolationLevel <isolation-level>] [-pdt,--poolDestroyTimeout <pool-destroy-timeout>] [-prop,--property <property>] [-sxe,--supportXaEmulation <support-xa-emulation>] [-ddba,--delegationDba <delegation-dba>] [-dbat,--dbaTimeout <dba-timeout>] [-cqc,--checkQueryClass <check-query-class>] [-is,--initSql <init-sql>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [-id,--dataSourceID <data-source-id>]
Data source ID. The data source ID must be unique within the domain.
[-user,--user <user>]
[Dynamic] Database user ID. The user must have the proper permissions to handle transactions.
In order to undo this setting, enter "unset" as the option value.
[-pw,--password <password>]
[Dynamic] Database user password.
To encrypt the password before storing, use the '{algorithm:keysize}ciphertext' format.
In order to undo this setting, enter "unset" as the option value.
[-algorithm,--algorithm <algorithm>]
[Dynamic] Encryption algorithm for the database user password. This option must be used with the -password option.
The following algorithm can be used:
-
base64
-
DES
-
DESede
-
AES
-
SEED
-
Blowfish
[-ac,--autoCommit <TRUE | FALSE | DRIVER>]
[Dynamic] Option to use the auto-commit configuration of the data source.
-
TRUE
-
FALSE
-
DRIVER: If DRIVER is selected, the auto-commit configuration of the JDBC driver is used.
The configuration value can only be set when the transaction is not linked to the connection pool data sources that use the XA emulation function or linked to XA data sources.
[-sqt,--stmtQueryTimeout <statement-query-timeout>]
[Dynamic] Query timeout used for java.sql.Statement objects created through the data source connection.
JEUS calls the query timeout configuration method (java.sql.Statement#setQueryTimeout) defined in the JDBC API and implemented by the JDBC driver vendor. The query timeout differs depending on the JDBC driver vendors. (Unit: ms)
[-aocl,--actionOnConnectionLeak <action-on-connection-leak>]
[Dynamic] Determines the action JEUS takes when it detects JDBC connections used by applications (stateless component - servlet/JSP, stateless session bean, MDB), but not yet returned.
Input options:
-
NO_ACTION: Take no actions.
-
WARNING: Log the information of the JDBC connections that are not returned.
-
AUTO_CLOSE: Log the information of the unreturned JDBC connections and collect them.
If not specified, the configuration of the server is used. To undo this setting, enter "unset" as the option value.
[-min,--min <minimum-size>]
[Dynamic] Minimum number of connections in the connection pool.
[-max,--max <maximum-size>]
[Dynamic] Maximum number of connections in the connection pool.
[-step,--step <resizing-step>]
[Dynamic] Number of DB connections to be obtained if the number of connections is insufficient and the number of connections in the connection pool is less than the maximum value.
[-period,--period <resizing-period>]
[Dynamic] Period in which to adjust the connection pool size based on the minimum value. If the connection pool size is greater than the minimum value, unused connections are closed. If the size is less than the minimum value, new DB connections are obtained. (Unit: ms)
[-ew,--enableWait <true | false>]
[Dynamic] Determines how to handle connection requests when no connections are available in the pool and additional connections cannot be added.
-
true: Wait until a connection is available.
-
false: Create a new (disposable) connection that does not enter the pool and is discarded after use.
[-wt,--waitTime <wait-time>]
[Dynamic] Period in which to wait for a connection if --enable-wait is true. If a connection cannot be obtained within the period, JEUS generates a timeout exception. (Unit: ms)
[-dds,--delegationDataSource <delegation-data-source>]
[Dynamic] If a request does not involve a transaction, it is better to get a connection from the connection pool data source instead of from the XA data source.
In this situation, a connection from the connection pool data source provides the same functionality as a connection from the XA data source, but with a smaller impact on system performance. Therefore, when using the XA data source, delegate connection requests unrelated to transactions to the connection pool data source.
When Oracle and DB2 use XA connections for both cases, with or without transactions, unexplained errors can occur; using this configuration can help avoid such situation.
In order to undo this setting, enter "unset" as the option value.
[-muc,--maxUseCount <max-use-count>]
[Dynamic] Maximum number of times a connection can be used. If the number of times a connection is used exceeds the specified number, the connection is replaced with a new connection. The default value is 0: a connection is not replaced.
[-cq,--checkQuery <check-query>]
[Dynamic] Query (query-check) that checks the connection status. Simple selection queries are recommended when validating the connection to the DB.
In order to undo this setting, enter "unset" as the option value.
[-cqt,--checkQueryTimeout <check-query-timeout>]
[Dynamic] When a check-query is executed to check the connection status, a driver can be in the wait state indefinitely if the DB does not respond. Apply a timeout to the check-query to avoid this situation. This can be set by using the java.sql.Statement#setQueryTimeout method defined in the JDBC API.
If the value is less than 1000ms, the value is set to 0. (Unit: ms)
[-nvi,--nonValidationInterval <non-validation-interval>]
[Dynamic] Option to skip connection checks if the interval between the last check and the recent check is within the specified time period. This option is useful for when overhead is created by frequent connection checks. (Unit: ms)
For example, if the option is set to 5000 ms, and 5 seconds has not passed since the last connection check, connections are sent to the applications without being checked.
[-cqp,--checkQueryPeriod <check-query-period>]
[Dynamic] Checks the connections in the connection pool at the specified interval to delete faulty connections. (Unit: ms)
For data sources that belong to cluster data sources, this option must be set to be used for checking its own state.
[-cqrc,--checkQueryRetrialCount <check-query-retrial-count>]
[Dynamic] If --destroyPolicyOnCheckQuery is set to FAILED_CONNECTION_ONLY, a connection check is performed only once.
If --destroyPolicyOnCheckQuery is set to ALL_CONNECTIONS and a problem is detected during the first connection check, all other connections are also checked, resulting in the connection check being performed twice.
The total connection check count is determined by adding this option value to the default connection check value.
[-dpocq,--destroyPolicyOnCheckQuery <destroy-policy-on-check-query>]
[Dynamic] Policy for connections in the connection pool when invalid connections are found.
-
FAILED_CONNECTION_ONLY: Delete only invalid connections.
-
ALL_CONNECTIONS: Delete invalid connections and validate other connections in the connection pool. If another invalid connection is detected in the pool, delete all the connections from the connection pool.
[-scs,--stmtCachingSize <stmt-caching-size>]
[Dynamic] JDBC driver parses SQL statements sent as parameters whenever applications request prepared statements. Parsing SQL statements can affect system performance, so JEUS offers a function that internally caches the prepared statements. This option sets the number of prepared statements that can be cached. If this option is used, connections are always open, so the clear job performed by the driver is not executed.
For example, when the Oracle JDBC driver sets auto-commit to false and closes the connection without executing commit or rollback, commit is executed unconditionally.
The use of the statement caching function is recommended if provided by the JDBC driver.
[-sfs,--stmtFetchSize <stmt-fetch-size>]
[Dynamic] Fetch size of JDBC driver statement.
[-ct,--connectionTrace <true | false>]
[Dynamic] Option to offer additional information for connections.
-
false: --getConnectionTrace and --autoCommitTrace cannot be used.
[-gct,--getConnectionTrace <get-connection-trace>]
[Dynamic] Displays the stack trace when the application calls java.sql.DataSource#getConnection.
[-act,--autoCommitTrace <auto-commit-trace>]
[Dynamic] Records logs and the stack trace to server logs when java.sql.Connection#setAutoCommit is called. The log level of jeus.jdbc.connection-trace logger must be set to FINE.
[-ust,--useSqlTrace <use-sql-trace>]
[Dynamic] Displays SQL queries used by connections. If the jeus.jdbc.sql logger level is set to FINE, the SQL query history can be checked in server logs. If this function is used, the statement implementation class of the JDBC driver is wrapped by a JEUS class. Therefore, applications that cast and use statement objects of the JDBC driver cannot use this function.
[-kcho,--keepConnectionHandleOpen <keep-connection-handle-open>]
[Dynamic] If this option is set to true and an XA connection is used and returned to the pool, the handle (or the logical connection) is kept open.
This function is required when using DB2 universal drivers. If this option is used, connections are always open, so the clear job performed by the driver is not executed.
For example, when the Oracle JDBC driver sets auto-commit to false and closes the connection without executing commit or rollback, commit is executed unconditionally.
[-en,--exportName <export-name>]
JNDI name of the data source. If two data sources are guaranteed to be bound to different JNDIs on different servers, they can have the same JNDI name. Different data sources with the same JNDI names are not allowed on the same server.
If not specified, the data source ID is used as the JNDI name. To undo this setting, enter "unset" as the option value.
Multiple JNDI names can be specified by using comma (,) delimiter, and JNDI lookup can be used for any of these specified JNDI names.
[-dscn,--dataSourceClassName <data-source-class-name>]
JDBC driver data source class name. Enter the full name, including the package name.
[-dst,--dataSourceType <data-source-type>]
Data source type.
-
DATA_SOURCE: Connection pooling service is not provided.
-
CONNECTION_POOL_DATA_SOURCE: Connection pooling service is provided.
-
XA_DATA_SOURCE: XA interface and the connection pooling service are provided.
[-vendor,--vendor <vendor>]
JDBC driver vendor name.
In order to undo this setting, enter "unset" as the option value.
[-desc,--description <description>]
Displays data source descriptions.
In order to undo this setting, enter "unset" as the option value.
[-sn,--serverName <server-name>]
Host name or IP at which the database runs.
In order to undo this setting, enter "unset" as the option value.
[-pn,--portNumber <port-number>]
Listener port number of the database. To undo this setting, enter "unset" as the option value.
[-dn,--databaseName <database-name>]
Database name. Sets the database SID (for Oracle). To undo this setting, enter "unset" as the option value.
[-lt,--loginTimeout <login-timeout>]
Maximum time to wait for the login screen to connect to the database. (Unit: seconds)
[-il,--isolationLevel <isolation-level>]
Transaction isolation level defined in java.sql.Connection. If not specified, the default configuration of the JDBC driver is used.
In order to undo this setting, enter "unset" as the option value.
[-pdt,--poolDestroyTimeout <pool-destroy-timeout>]
Amount of time in wait for the connection pool destroy command to complete. (Unit: ms)
The connection pool is destroyed when applications that defined the data sources are undeployed or when the server goes down. During this process, if the connection is used for network communication with the DB, the destroy process can be blocked and left hanging indefinitely. This option is used to avoid this situation. If this option is set, connection pool destruction waits the specified time period and then performs undeployment or server termination.
If this option is set, connection pool destruction waits the specified time period and then performs undeployment or server termination.
[-prop,--property <property>]
This option provides a unified configuration method to accommodate all property configurations that can differ by JDBC driver.
-
For a single property, use the 'name:type=value' format.
-
To specify multiple properties, separate each property with a comma (,).
[-sxe,--supportXaEmulation <support-xa-emulation>]
This option only applies to the connection pool data source type. This option emulates the connection pool data source connection to participate in a global transaction (XA).
For JEUS 6 and earlier versions, this option is an alternative to LocalXADataSource. It is used in the ConnectionPoolDataSource type of connection pools.
Note that only one connection pool data source can participate per transaction.
[-ddba,--delegationDba <delegation-dba>]
JNDI name of the data source (hereafter DBA delegation data source), which has permission to forcibly terminate database sessions (DBA permission). If there is a delay in handling a query through the connection received from the data source, a query that forcibly terminates the DB session is sent to the DB using the DBA delegation data source. After the application handles exceptions that occurred due to the disabled connection, it closes the connection. JEUS then deletes the connection and gets a new connection from the DB and assigns it to the connection pool.
Currently, this function is supported for Tibero, Oracle, and Sybase. It was created to suspend queries that take too long to perform for JDBC driver version 2.0 and earlier. For JDBC driver version 3.0 and later, it is recommended to use java.sql.Statement#setQueryTimeout instead of forcibly terminating DB sessions.
Especially for XA data sources, if DB sessions are terminated while XA operates normally, the XA operation can generate an error. Therefore, use the statement query timeout and the transaction timeout properties.
In order to undo this setting, enter "unset" as the option value.
[-dbat,--dbaTimeout <dba-timeout>]
The delegation DBA data source waits the specified time period for queries on a connection to finish. If timeout occurs, a query is sent to the DB that forcibly terminates the DB session.
This option only applies when --delegationDba is set. (Unit: ms)
[-cqc,--checkQueryClass <check-query-class>]
Class name, which includes the package name, that implements the function for users or developers who want to customize the connection check function.
The class must implement the jeus.jdbc.connectionpool.JEUSConnectionChecker interface.
In order to undo this setting, enter "unset" as the option value.
[-is,--initSql <init-sql>]
SQL query that is initially handled after a connection has been created.
In order to undo this setting, enter "unset" as the option value.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays the detailed results of the configuration changes.
-
-
Example
[MASTER]domain1.adminServer>modify-data-source -id ds1 -min 10 -max 50 Successfully performed the MODIFY operation for configuration of the data source [ds1]. Check the results using "modify-data-source -id ds1"
1.11.7. remove-cluster-data-source
Deletes a cluster data source from the domain.
-
Alias
rmcds
-
Usage
remove-cluster-data-source [-id,--dataSourceID <data-source-id>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [-id,--dataSourceID <data-source-id>]
Cluster data source ID.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays the detailed results of the configuration changes.
-
Example
[MASTER]domain1.adminServer>remove-cluster-data-source -id cds1 Successfully performed the REMOVE operation for cluster data source [cds1] from domain. Check the results using "remove-cluster-data-source"
1.11.8. remove-data-source
Deletes a data source from the domain.
-
Alias
rmds
-
Usage
remove-data-source [-id,--dataSourceID <data-source-id>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description [-id,--dataSourceID <data-source-id>]
Data source ID.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays the detailed results of the configuration changes.
-
Example
[MASTER]domain1.adminServer>remove-data-source -id ds1 Successfully performed the REMOVE operation for data source [ds1] from the domain. Check the results using "remove-data-source"
1.11.9. test-data-source-config
Checks if a data source configuration is correct.
-
Alias
testdsconf, testdsconfig, testdscfg
-
Usage
test-data-source-config -id <data-source-id> [-all] -
Parameters
Parameter Description -id <data-source-id>
Data source ID.
[-all]
Only available in jeusadmin of JEUS Master Server. Sends the command to running domain servers that set the data source as a target and displays the results.
-
Example
[MASTER]domain1.adminServer>test-data-source-config -id ds1 The data source [ds1] is properly configured and can be used.
1.12. Connection Pool Controlling and Monitoring Commands
The following is a list of commands that monitor and control JDBC/JCA Connection pools.
| Command | Description |
|---|---|
Monitors JDBC/JCA connection pools. If a connection pool ID is specified, its information is displayed in detail. |
|
Controls JDBC/JCA connection pools. This command can create, activate, deactivate, refresh, or shrink connection pools. |
|
Controls cluster data sources. Displays a list of component data sources of cluster data sources or performs failback. |
|
Creates a JDBC connection pool. This does not apply to JCA connection pools. |
|
Forcibly ends an active connection. |
|
Deactivates a JDBC connection pool. This does not apply to JCA connection pools. |
|
Activates a JDBC connection pool. This does not apply to JCA connection pools. |
|
Replaces connections in the JDBC connection pool with new connections. This does not apply to JCA connection pools. |
|
Returns an active connection to a connection pool. |
|
Reduces the number of connections in the JDBC connection pool to the minimum number. This does not apply to JCA connection pools. |
1.12.1. connection-pool-info
Monitors JDBC/JCA connection pools. If a connection pool ID is specified, its information is displayed in detail.
-
Alias
cpinfo
-
Usage
connection-pool-info -server <server-name> [-id <connection-pool-id>] [-jca | -jdbc] [-jndi] [-active] [-t] [-stmt] -
Parameters
Parameter Description -server <server-name>
Server name.
[-id <connection-pool-id>]
Connection pool ID.
[-jca]
Displays only JCA connection pool information.
[-jdbc]
Displays only JDBC connection pool information.
[-jndi]
Displays the JNDI name of the connection pool.
[-active]
Displays the created connection pools on the server.
[-t]
Displays the name of the thread that most recently used the connection.
This parameter requires the -id parameter to be used.
[-stmt]
Statement cache information by each connection.
-
Example
[MASTER]domain1.adminServer>connection-pool-info -server server1 -jndi -jdbc The connection pool information on the server [server1]. ================================================================================ +------------+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+ | Connection |JNDI | Min | Max | Act | Act | Act | Idle| Dis | Tot | Wait| Ena | | Pool ID |Expo | | | ive | ive | ive | |posa | al | |bled | | | rt | | | Max | |Aver | | ble | | | | | |Name | | | | | age | | | | | | +------------+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+ | ds1 | ds1 | 2 | 30 | 0 | 0 | 0.0 | 2 | 0 | 2 | fal | true| | | | | | | | | | | |se | | +------------+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+ | ds2 * | ds2 | 2 | 30 | 0 | 0 | 0.0 | 0 | 0 | 0 | fal | fal | | | | | | | | | | | |se |se | +------------+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+ * : has not been created, total = active + idle + disposable ================================================================================ [MASTER]domain1.adminServer>connection-pool-info -server server1 -id ds1 -t -jdbc Information about connections in the server [server1]'s connection pool [ds1]. ================================================================================ +---------------+-------+-------------------+-----------+--------+-------------+ | Connection ID | State | State time(sec.) | Use count | Type | Thread name | +---------------+-------+-------------------+-----------+--------+-------------+ | ds1-1 | active| 1105.954 | 1 | pooled | http-w1 | | ds1-2 | idle | 1105.923 | 0 | pooled | | +---------------+-------+-------------------+-----------+--------+-------------+ ================================================================================ [MASTER]domain1.adminServer>connection-pool-info -server server1 -id ds1 -stmt -jdbc Information about statement caches in the server [server1]'s connection pool [ds1]. ================================================================================ +--------------+-----------+--------+---------+--------+-----------+-----------+ | Connection ID| Access | Hit | Miss | Add | Remove | Current | | | Count | Count | Count | Count | Count | Size | +--------------+-----------+--------+---------+--------+-----------+-----------+ | ds1-1 | 5 | 0 | 5 | 5 | 0 | 5 | +--------------+-----------+--------+---------+--------+-----------+-----------+ | ds1-2 | 5 | 2 | 3 | 3 | 0 | 3 | +--------------+-----------+--------+---------+--------+-----------+-----------+ ================================================================================
1.12.2. control-connection-pool
Controls JDBC/JCA connection pools. This command can create, activate, deactivate, refresh, or shrink connection pools.
-
Alias
controlcp, ctrlcp
-
Usage
control-connection-pool -id <connection-pool-id> [-server <server-name>] [-enable | -shrink | -disable | -refresh | -create] -
Parameters
Parameter Description -id <connection-pool-id>
Connection pool ID.
[-server <server-name>]
Server name.
[-enable]
Activates a connection pool.
[-shrink]
Reduces the number connections of connection pool to the minimum number of connections.
[-disable]
Deactivates a connection pool.
[-refresh]
Replaces connections in the connection pool with new connections.
[-create]
Creates a connection pool.
-
Example
[MASTER]domain1.adminServer>control-connection-pool -id ds1 -server server1 -enable Servers that successfully enabled a connection pool : server1 Servers that failed to enable a connection pool : none. [MASTER]domain1.adminServer>control-connection-pool -id ds1 -server server1 -shrink Servers that successfully shrank a connection pool : server1 Servers that failed to shrink a connection pool : none. [MASTER]domain1.adminServer>control-connection-pool -id ds1 -server server1 -disable Servers that successfully disabled a connection pool : server1 Servers that failed to disable a connection pool : none. [MASTER]domain1.adminServer>control-connection-pool -id ds1 -server server1 -refresh Servers that successfully refreshed a connection pool : server1 Servers that failed to refresh a connection pool : none. [MASTER]domain1.adminServer>control-connection-pool -id ds1 -server server1 -create Servers that successfully created a connection pool : server1 Servers that failed to create a connection pool : none.
1.12.3. control-cluster-data-source
Controls cluster data sources. Performs failback or displays a list of component data sources of cluster data sources.
-
Alias
controlcds, ctrlcds
-
Usage
control-cluster-data-source -server <server-name> -id <data-source-id> [-failback] -
Parameters
Parameter Description -server <server-name>
Server name.
-id <data-source-id>
Cluster data source ID.
[-failback]
Performs failback for cluster data sources.
-
Example
[MASTER]domain1.adminServer>control-cluster-data-source -server server1 -id cds1 Component data sources of the cluster data source [cds1] : ds1, ds2 [MASTER]domain1.adminServer>control-cluster-data-source -server server1 -id cds1 -failback The failback for the cluster data source [cds1] succeeded.
1.12.4. create-connection-pool
Creates a JDBC connection pool. This does not apply to JCA connection pools.
-
Alias
createcp
-
Usage
create-connection-pool -id <connection-pool-id> [-server <server-name>] -
Parameters
Parameter Description -id <connection-pool-id>
JDBC connection pool ID.
[-server <server-name>]
Server name.
-
Example
[MASTER]domain1.adminServer>create-connection-pool -id ds1 -server server1 Servers that successfully created a connection pool : server1 Servers that failed to create a connection pool : none.
1.12.5. destroy-connection
Forcibly ends an active connection.
The command can be used to end an active connection with an issue when an application requests a connection. It is only available for active connections. Note that this command forcibly ends an actual physical connection.
-
Alias
destroyconnection
-
Usage
destroy-connection -server <server-name> [-cpid <connection-pool-id> | -cid <connection-id>] -
Parameters
Parameter Description -server <server-name>
Name of the server that has the connection pool with the connection to forcibly end.
[-cpid <connection-pool-id>]
Connection pool ID. All connections that belong to this pool are ended.
[-cid <connection-id>]
Connection ID. A specific connection in a connection pool is ended. You can specify multiple connection IDs by using a comma (,) as a delimiter. To check connection IDs, use the connection-pool-info command with the -id option.
-
Example
[MASTER]domain1.adminServer>destroy-connection -server server1 -cpid ds1 Successfully destroyed the connections from the connection pool. [MASTER]domain1.adminServer>return-connection -server server1 -cid ds1-1,ds1-2 Successfully destroyed the connections from the connection pool.
1.12.6. disable-connection-pool
Activates a JDBC connection pool. This does not apply to JCA connection pools.
-
Alias
disablecp
-
Usage
disable-connection-pool -id <connection-pool-id> [-server <server-name>] -
Parameters
Parameter Description -id <connection-pool-id>
JDBC connection pool ID.
[-server <server-name>]
Server name.
-
Example
[MASTER]domain1.adminServer>disable-connection-pool -id ds1 -server server1 Servers that successfully disabled a connection pool : server1 Servers that failed to disable a connection pool : none.
1.12.7. enable-connection-pool
Activates a JDBC connection pool. This does not apply to JCA connection pools.
-
Alias
enablecp
-
Usage
enable-connection-pool -id <connection-pool-id> [-server <server-name>] -
Parameters
Parameter Description -id <connection-pool-id>
JDBC connection pool ID.
[-server <server-name>]
Server name.
-
Example
[MASTER]domain1.adminServer>enable-connection-pool -id ds1 -server server1 Servers that successfully enabled a connection pool : server1 Servers that failed to enable a connection pool : none.
1.12.8. refresh-connection-pool
Replaces connections in the JDBC connection pool with new connections. This does not apply to JCA connection pools.
-
Alias
refreshcp
-
Usage
refresh-connection-pool -id <connection-pool-id > [-server <server-name>] -
Parameters
Parameter Description -id <connection-pool-id>
JDBC connection pool ID.
[-server <server-name>]
Server name.
-
Example
[MASTER]domain1.adminServer>refresh-connection-pool -id ds1 -server server1 Servers that successfully refreshed a connection pool : server1 Servers that failed to refresh a connection pool : none.
1.12.9. return-connection
Returns an active connection to a connection pool.
If an application does not close a connection and the data source setting, "Action On Connection Leak" is not set AutoClose, a leak occurs because the connection’s status remains active. The command can be used to avoid this issue. It is only available for active connections. However, if a connection to return is being used for the current transaction, it is not returned. If an error occurs while a connection is returned, the connection is destroyed.
-
Alias
returnconnection
-
Usage
return-connection -server <server-name> [-cpid <connection-pool-id> | -cid <connection-id>] -
Parameters
Parameter Description -server <server-name>
Name of the server that has the connection pool to which the connection is returned.
[-cpid <connection-pool-id>]
Connection pool ID. All connections that belong to this pool are returned.
[-cid <connection-id>]
Connection ID. A specific connection in a connection pool is returned. You can specify multiple connection IDs by using a comma (,) as a delimiter. To check connection IDs, use the connection-pool-info command with the -id option.
-
Example
[MASTER]domain1.adminServer>return-connection -server server1 -cpid ds1 Successfully returned the connections to the connection pool. [MASTER]domain1.adminServer>return-connection -server server1 -cid ds1-1,ds1-2 Successfully returned the connections to the connection pool.
1.12.10. shrink-connection-pool
Reduces the number of connections in the JDBC connection pool to the minimum number. This does not apply to JCA connection pools.
-
Alias
shrinkcp
-
Usage
shrink-connection-pool -id <connection-pool-id****> [-server <server-name>] -
Parameters
Parameter Description -id <connection-pool-id>
JDBC connection pool ID.
[-server <server-name>]
Server name.
-
Example
[MASTER]domain1.adminServer>shrink-connection-pool -id ds1 -server server1 Servers that successfully shrank a connection pool : server1 Servers that failed to shrink a connection pool : none.
1.13. Transaction Commands
The following is a list of transaction commands.
| Command | Description |
|---|---|
Changes the configuration of the transaction manager of a server. |
|
Recovers the resource manager of a server. Resources can be selectively recovered. |
|
Checks the configuration of the transaction manager of a server. |
|
Checks the transaction by its status on a server. |
1.13.1. modify-transaction-manager
Changes the configuration of the transaction manager of a server.
-
Alias
modify-tm, modifytm, tmconfig, tmconf
-
Usage
modify-transaction-manager <server-name> [-at,--activeTimeout <active-timeout>] [-pt,--prepareTimeout <prepare-timeout>] [-pdt,--preparedTimeout <prepared-timeout>] [-ct,--commitTimeout <commit-timeout>] [-rt,--recoveryTimeout <recovery-timeout>] [-it,--incompleteTimeout <incomplete-timeout>] [-d,--txLogDir <transaction-log-directory>] [-a,--automaticRecovery <automatic-recovery-enable/disable>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description <server-name>
Name of the server for which the transaction configuration is changed.
[-at,--activeTimeout <active-timeout>]
Period in which to commit when starting a transaction. If timeout occurs, the transaction is forcibly rolled back.
[-pt,--prepareTimeout <prepare-timeout>]
Period in which the root coordinator receives a response from a sub-coordinator after sending the prepare command.
[-pdt,--preparedTimeout <prepared-timeout>]
Period in which the sub-coordinator waits for global decisions from the root coordinator after sending the prepare response.
[-ct,--commitTimeout <commit-timeout>]
Period in which the root coordinator receives a response after sending the commit command to a sub-coordinator.
[-rt,--recoveryTimeout <recovery-timeout>]
Period in which to receive the recovery information. If timeout occurs, the recovery is delegated to the user.
[-it,--incompleteTimeout <incomplete-timeout>]
Period in which incomplete transactions recover. If timeout occurs, incomplete transactions are deleted.
[-d,--txLogDir <transaction-log-directory>]
Directory that stores transactions for recovery. For more information, refer to Recovery Related Log File in JEUS Server Guide.
[-a,--automaticRecovery <automatic-recovery-enable/disable>]
[Dynamic] Option to let another server recover incomplete transactions when an error occurs in the server. For more information, refer to Transaction Recovery in JEUS Server Guide.
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the configuration changes.
-
Example
-
Check the current configuration.
[MASTER]domain1.adminServer>modify-transaction-manager server1 Shows the current configuration. transaction of server (server1) ================================================================================ +---------------------+--------------------------------------------------------+ | Active Timeout | 600000 | | Prepare Timeout | 120000 | | Prepared Timeout | 60000 | | Commit Timeout | 240000 | | Recovery Timeout | 120000 | | Incomplete Timeout | 86400000 | | Tx Log Dir | ${SERVER_HOME}/.workspace/tmlog | | Automatic Recovery | false | +---------------------+--------------------------------------------------------+ ================================================================================ -
Dynamically turn on the transaction auto-recovery function.
[MASTER]domain1.adminServer>modify-transaction-manager server1 -automaticRecovery true Successfully performed the MODIFY operation for transaction of server (server1). Check the results using "show-transaction-manager server1 or modify-transaction-manager sever1"
-
Change the timeout configuration that applies when the server reboots.
[MASTER]domain1.adminServer>modify-transaction-manager server1 -activeTimeout 20000 Successfully performed the MODIFY operation for transaction of server (server1), but all changes were non-dynamic. They will be applied after restarting. Check the results using "show-transaction-manager server1 or modify-transaction-manager server1"
-
Change the configuration that allows dynamic changes and the configuration that applies when the server reboots.
[MASTER]domain1.adminServer>modify-transaction-manager server1 -automaticRecovery true -activeTimeout 20000 Successfully performed the MODIFY operation for transaction of server (server1), but some changes were non-dynamic. They will be applied after restarting. Check the results using "show-transaction-manager server1 or modify-transaction-manager server1"
-
1.13.2. recover-transactions
Recovers the resource manager of a server. Resources can be selectively recovered.
-
Alias
recovertx, tmresync
-
Usage
recover-transactions -server <server-name> <resource-type> <export-name> [<connector-module-name>] -
Parameters
Parameter Description -server <server-name>
Server name.
<resource-type>
Resource type to be recovered.
-
sql : JDBC XADataSource
-
jms : JMS Connection Factory
-
connector: Connector Resource Adapter
<export-name>
export-name of the resource.
[<connector-module-name>]
If the resource is a connector, sets the name of the connector module.
-
-
Example
[MASTER]domain1.adminServer>recover-transactions -server server1 sql jdbc/derby/XADataSource The recover-transactions command was executed on the server1 server.
1.13.3. show-transaction-manager
Checks the configuration of the transaction manager of a server.
-
Alias
show-tm, showtm
-
Usage
show-transaction-manager <server-name>
-
Parameters
Parameter Description [<server-name>]
Server name.
-
Example
[MASTER]domain1.adminServer>show-transaction-manager server1 Shows the current configuration. transaction of server (server1) ================================================================================ +---------------------+--------------------------------------------------------+ | Active Timeout | 600000 | | Prepare Timeout | 120000 | | Prepared Timeout | 60000 | | Commit Timeout | 240000 | | Recovery Timeout | 120000 | | Incomplete Timeout | 86400000 | | Tx Log Dir | ${SERVER_HOME}/.workspace/tmlog | | Automatic Recovery | false | +---------------------+--------------------------------------------------------+ ================================================================================
1.13.4. transaction-info
Checks the transaction by its status on a server.
-
Alias
transactioninfo, txinfo
-
Usage
transaction-info -server <server-name> [-i,--inflight] [-d,--indoubt] [-r,--retrying] -
Parameters
Parameter Description -server <server-name>
Server name.
[-i,--inflight]
Checks the running transactions, transactions in the memory that have not reached the commit or rollback step.
[-d,--indoubt]
Checks the incomplete transactions, transactions that require recovery or that have undetermined status.
[-r,--retrying]
Checks the transactions to be retried within JEUS because one-phase-commit or two-phase-commit was not successfully performed due to problems with the resource manager.
-
Example
[MASTER]domain1.adminServer>transaction-info -server server1 <transactions of server1> In-Flight Transaction Information ================================================================================ +------------------+---------+-------+--------+---------+---------+------------+ | XID | Coordina| Extern| Status | Timeout | Elapse | XAResources| | | tor |al XID | | | | | +------------------+---------+-------+--------+---------+---------+------------+ | 049FE5.00C0A80011| 192.168.| | STATUS | 5000(ms)| 7418(ms)| jdbc/derby/| |2608221CC3D6B40000|0.17:9736| |_MARKED_| | |XADataSource| |000000000011.00 | | |ROLLBACK| | | | +------------------+---------+-------+--------+---------+---------+------------+ ================================================================================ In-doubt Transaction Information ========================================================================== +----+----------------+--------------------+-------+------------+--------+ | XID| Coordinator | External XID | Status| Decision | Sub-XID| +----+----------------+--------------------+-------+------------+--------+ (No data available) ========================================================================== Retrying Transaction Information ============================================================= +----+-----+------------------------------+-------+---------+ | XID| Name| Failuere Count | Status| Decision| +----+-----+------------------------------+-------+---------+ (No data available) =============================================================
1.14. Security Commands
The following is a list of security commands for user, group, and policy.
-
User management commands
User management commands are used to add, change, and delete users.
Command Description Dynamically adds a new user to the security system.
Dynamically deletes a user from the current domain.
Displays a list of all users (user names) that logged onto the current domain and the lock and expiration states of each user.
Displays detailed user information.
Adds a new default password validator, or modify or delete the existing one.
Displays the settings for the default password validator.
Defines a new class to the custom password validator.
Removes a defined class from the custom password validator.
Displays the list of classes defined to the custom password validator.
Displays the information about the current settings for the subject validation service.
Dynamically sets the user password.
Dynamically sets a lock on a user.
Dynamically releases a lock on a user.
Sets an expiration time for a specific user.
Removes the expiration time set for a specific user.
-
Group management commands
Group management commands are used to add, update, or delete groups.
Command Description Dynamically adds a new group to the security system.
Dynamically adds a user to a group.
Dynamically deletes a user from a group.
Dynamically deletes a group.
Displays a list of groups of the security system.
Displays detailed group information.
Checks if the user is registered with a group.
-
Policy management commands
Policy commands are used to manage security system policies.
Command Description Displays policies that include a context ID.
Adds a new role.
Changes the configuration of a role.
Deletes a role.
Adds a new resource.
Changes the configuration of a resource.
Deletes a resource.
Assigns a principal to a role.
Deletes a principal from a role.
Assigns a role to a resource.
Deletes a role from a resource.
|
Due to the sensitive nature of the information processed by these commands, the user must have proper permissions. |
1.14.1. Shared Options
The following options are shared by all security commands.
-
[-domain <domain-name>] option
-
Specifies the security domain, which is the scope where JEUS applies security (default: SYSTEM_DOMAIN). For more information about the domain, refer to JEUS Security Guide.
-
The description of this option is omitted from each command option description.
-
1.14.2. add-custom-password-validator
Adds a new class to the custom password validator. For information about password validation, refer to Password security settings in JEUS Security Guide.
-
Alias
add-custom-validator
-
Usage
add-custom-password-validator [-class <class-name>]
-
Parameters
Parameter Description <class-name>
Name of the class that is placed under DOMAIN_HOME/lib/application as a JAR file to be added to the custom password validator. The class must implement the jeus.util.PasswordValidator interface.
-
Example
[MASTER]domain1.adminServer> add-custom-password-validator -class MyValidator Custom password validator [MyValidator] is added successfully. Check the results using show-custom-password-validator.
1.14.3. add-group
Dynamically adds a new group to the security system. The group name must be unique within the current domain. Domain names can be checked using the list-group-names command. The group name is used to refer to a specific group during the calling process, it corresponds to the ID of the group.
-
Alias
addgroup
-
Usage
add-group <group-name> [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <group-name>
Group name.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer> add-group group1 The group [group1] has been successfully added.
1.14.4. add-resource
Dynamically adds a new resource to the security system. The resource name and actions must be unique whithin the current domain and context. Resource names can be checked with the show-policy command.
-
Alias
addresource
-
Usage
add-resource <resource-name> <actions> [-contextid <context-id>] [-classname <class-name>] [-role <role-name>] [-excluded] [-unchecked] [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <resource-name>
Name of a resource to add.
<actions>
Actions that will be assigned to the resource.
A list of actions for a resource. Each action is separated by a blank space. For example, the jeus.server resource has "boot" and "down" as its actions.
If -actions is set, actions are the second parameter of the constructor of the class configured with -classname. The default class name is jeus.security.resource.ResourcePermission, and its constructor parameters are "resource" and "actions".
[-contextid <context-id>]
Context name that distinguishes policies. The contextid is used to specify a context other than the default context.
[-classname <class-name>]
Permission class name.
A class configured with -classname must be a Java class that extends the class java.security.Permission abstract. The class must have at least one constructor that receives a string type "resource" as an argument.
For more information about resource permissions, refer to the jeus.security.resource.ResourcePermission class. For more information about which resource permissions are checked in JEUS, refer to JEUS Server Permissions in JEUS Security Guide.
[-role <role-name>]
A list of roles to assign the resource.
[-excluded]
Prevents anyone from getting the permission.
[-unchecked]
Allows anyone to get the permission.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer> add-resource resource1 jeus.* The resource [name=resource1, actions=jeus.*] has been successfully added.
1.14.5. add-role
Dynamically adds a new role to the security system. The role name must be unique within the current domain. Role names can be checked with the show-policy command.
-
Alias
addrole
-
Usage
add-role <role-name> [-principal <principal>] [-classname <classname>] [-excluded] [-unchecked] [-actions <actions>] [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <role-name>
Name of a role to add.
[-principal <principal>]
Principal to which the role is assigned.
[-classname <classname>]
Permission class name.
A class configured with -classname must be a Java class that extends the class java.security.Permission abstract. The class must have at least one constructor that receives a string type "role" as an argument.
For more information about role permissions, refer to the jeus.security.resource.RolePermission class. For more information about which role permissions are checked in JEUS, refer to JEUS Server Permissions in JEUS Security Guide.
[-excluded]
Prevents anyone from getting the permission.
[-unchecked]
Allows anyone to get the permission.
[-actions <actions>]
A list of actions for the role.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer> add-role role1 The role [role1] has been successfully added.
1.14.6. add-user
Dynamically adds a new user to the security system. The user name must be unique within the current domain. User names can be checked with the list-user-names command. The user name is used to refer to a user during the calling process, it corresponds to the ID of the user.
-
Alias
adduser
-
Usage
add-user <user-name> [-domain <domain-name>] [-f,--forceLock] [<password>] -
Parameters
Parameter Description <user-name>
User name.
[-f,--forceLock]
Forcibly applies the configuration changes.
[<password>]
Password.
-
Example
[MASTER]domain1.adminServer> add-user user1 The user [user1] has been successfully added.
1.14.7. add-user-to-group
Dynamically adds a new member to a group registered with the security system.
-
Alias
addusertogroup
-
Usage
add-user-to-group <group-name> <user-name> [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <group-name>
Group name.
<user-name>
User name.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer> add-user-to-group group1 user1 The user [user1] has been successfully added to the group [group1].
1.14.8. assign-resource-to-role
Dynamically assigns a resource and action to a role.
-
Alias
assignresource, assignres
-
Usage
assign-resource-to-role <resource-name> <actions> <role-name> [-contextid <context-id>] [-classname <classname>] [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <resource-name>
[Dynamic] Resource name. Resource names are Java class names that represent the resource. E.g., jeus.server.
<actions>
[Dynamic] Actions assigned to the role.
A list of actions for a resource. Each action is separated by a blank space. For example, the jeus.server resource has "boot" and "down" as its actions.
If -actions is set, actions are the second parameter of the constructor of the class configured with -classname. The default class name is jeus.security.resource.ResourcePermission, and its constructor parameters are "resource" and "actions".
<role-name>
Role name.
[-contextid <context-id>]
Context name that distinguishes policies. The contextid is used to specify a context other than the default context.
[-classname <classname>]
[Dynamic] Permission class name.
A class configured with -classname must be a Java class that extends the class java.security.Permission abstract. The class must have at least one constructor that receives a string type "role" as an argument.
For more information about resource permissions, refer to the jeus.security.resource.ResourcePermission class. For more information about which resource permissions are checked in JEUS, refer to JEUS Server Permissions in JEUS Security Guide.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer> assign-resource-to-role jeus.* deploy-applications deployRole The resource [name=jeus.*, actions=deploy-applications] is assigned to the role [deployRole].
1.14.9. assign-role-to-principal
Dynamically assigns a role to a principal. A class configured with -classname must be a Java class that extends the class java.security.Permission abstract. The class must have at least one constructor that receives a string type "role" as an argument. The default class is jeus.security.resource.RolePermission. However, for an anonymous, a role can be allocated only when it has an unchecked permission.
-
Alias
assignrole, assign-role
-
Usage
assign-role-to-principal <role-name> <principal> [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <role-name>
[Dynamic] Role name.
<principal>
Principal name.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer> assign-role-to-principal AdministratorsRole user1 The role [AdministratorsRole] is assigned to the principal [user1].
1.14.10. check-group-member
Checks if the user is registered with a group.
-
Alias
checkgroupmember, ismember
-
Usage
check-group-member <group-name> <user-name> [-domain <domain-name>] -
Parameters
Parameter Description <group-name>
Group name.
<user-name>
User name.
-
Example
[MASTER]domain1.adminServer> check-group-member group1 user1 The user [user1] is a member of the group [group1].
1.14.11. expire-user
Sets an expiration time on a specific user. If SubjectExpirationtValidationService is set properly, the user is valid before the expiration time. The user’s login fails before calling unexpire-user. For information about subject validation, refer to SubjectValidationService SPI.
-
Alias
expireuser, exuser
-
Usage
expire-user <user-name> [-domain <domain-name>] [-year <year>] [-month <month>] [-day <day>] [-hour <hour>] [-minute <minute>] -
Parameters
Parameter Description <user-name>
User name.
[-year <year>]
Year of the expiration time in the format of yyyy. (Default value: current year)
[-month <month>]
Month of the expiration time in the format of MM. (Default value: current month)
[-day <day>]
Date of the expiration time in the format of dd. (Default value: current date)
[-hour <hour>]
Hour of the expiration time in the format of hh. (Default value: current hour)
[-minute <minute>]
Minute of the expiration time in the format of mm. (Default value: current minute)
-
Example
[MASTER]domain1.adminServer> expire-user user1 -year 2020 -month 12 -day 31 -hour 12 -minute 30 The user [user1] is valid only until [2020-12-31 12:30].
1.14.12. list-group-names
Displays the list of all groups in the current domain.
-
Alias
listgroupnames, getgroupnames
-
Usage
list-group-names [-domain <domain-name>]
-
Example
[MASTER]domain1.adminServer> list-group-names ================================================================================ +------------------------------------------------------------------------------+ | Group Name | +------------------------------------------------------------------------------+ | Administrators | +------------------------------------------------------------------------------+ | group1 | +------------------------------------------------------------------------------+ ================================================================================
1.14.13. list-user-names
Displays a list of all users (user names) that logged onto the current domain and the lock and expiration states of each user.
-
Alias
listusernames, getusernames
-
Usage
list-user-names [-domain <domain-name>]
-
Example
[MASTER]domain1.adminServer> list-user-names ============================================================ +-----------+------------+---------------------------------+ | User Name | Lock State | ExpiryTime State | +-----------+------------+---------------------------------+ | jeus | unlocked | Unexpired | | admin | locked | 2020-01-01 12:00 | +-----------+------------+---------------------------------+ ============================================================
1.14.14. lock-user
Dynamically sets a lock on a user. If "SubjectLockoutValidationService" is properly configured on the server, all login attempts by the user fail until the unlock-user command is called.
For more information about subject validation, refer to SubjectValidationService SPI in JEUS Security Guide.
-
Alias
lockuser
-
Usage
lock-user <user-name> [-domain <domain-name>] -
Parameters
Parameter Description <user-name>
User name.
-
Example
[MASTER]domain1.adminServer> lock-user user2 The user [user2] has been locked out.
1.14.15. modify-default-password-validator
Dynamically adds, changes, or deletes the configurations for the default password validator. For information about password validation, refer to Password security settings in JEUS Security Guide.
-
Alias
modify-password-validator
-
Usage
modify-default-password-validator [-disable] [-min <min-length>] [-max <max-length>] [-special <true | false>] [-digit <true | false>] [-capital <true | false>] [-small <true | false>] [-excludeID <true | false>] -
Parameters
Parameter Description [-disable]
[Dynamic] Disables the default password validator and discards the existing settings.
[-min <min-length>]
[Dynamic] Minimum number of digits for the password.
(Range: 1 - 255, default value: 1)
[-max <max-length>]
[Dynamic] Maximum number of digits for the password.
(Range: 1 - 255, default value: 1)
[-special <true | false>]
[Dynamic] Indicates whether a special character must be included in a password. (Default value: false)
[-digit <true | false>]
[Dynamic] Indicates whether a number must be included in a password.
(Default value: false)
[-capital <true | false>]
[Dynamic] Indicates whether an uppercase letter must be included in a password.
(Default value: false)
[-small <true | false>]
[Dynamic] Indicates whether a lowercase letter must be included in a password.
(Default value: false)
[-excludeID <true | false>]
[Dynamic] Indicates whether the user ID is prevented from being part of a password. (Default value: false)
-
Example
[MASTER]domain1.adminServer> modify-default-password-validator -min 4 -special true Default password validator is updated successfully. Check the results using "show-default-password-validator or modify-default-password-validator".
1.14.16. modify-resource
Dynamically changes the configuration of a resource. If you need to modify the configuration of a resource assigned to a role, use AssignResourceToRole or UnassignResourceFromRole command.
-
Alias
modifyresource
-
Usage
modify-resource <resource-name> <actions> [-contextid <context-id>] [-classname <classname>] [-excluded <true | false>] [-unchecked <true | false>] [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <resource-name>
Name of the resource to change the configuration.
<actions>
Action list of the resource to change the configuration.
[-contextid <context-id>]
Context name that distinguishes policies. The contextid is used to specify a context other than the default context.
[-classname <classname>]
Permission class name.
A class configured with -classname must be a Java class that extends the class java.security.Permission abstract. The class must have at least one constructor that receives a string type "resource" as an argument.
For more information about resource permissions, refer to the jeus.security.resource.ResourcePermission class. For more information about which resource permissions are checked in JEUS, refer to JEUS Server Permissions in JEUS Security Guide.
[-excluded <true | false>]
Prevents anyone from getting the permission. (true|false)
[-unchecked <true | false>]
Allows anyone to get the permission. (true|false)
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer> modify-resource resource1 jeus.* -excluded true -unchecked false The resource [name=resource1, actions=jeus.*] has been successfully modified.
1.14.17. modify-role
Dynamically changes the configuration of a role. To change a role assigned to the user, use AssignRoleToPrincipal or UnassignRoleFromPrincipal command.
-
Alias
modifyrole
-
Usage
modify-role <role-name> [-classname <classname>] [-excluded <true | false>] [-unchecked <true | false>] [-actions <actions>] [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <role-name>
Name of the role to change the configuration.
[-classname <classname>]
Permission class name.
A class configured with -classname must be a Java class that extends the class java.security.Permission abstract. The class must have at least one constructor that receives a string type "role" as an argument.
For more information about role permissions, refer to the jeus.security.resource.RolePermission class. For more information about which role permissions are checked in JEUS, refer to JEUS Server Permissions in JEUS Security Guide.
[-excluded <true | false>]
Prevents anyone from getting the permission. (true|false)
[-unchecked <true | false>]
Allows anyone to get the permission. (true|false)
[-actions <actions>]
A list of actions for the role.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer> modify-role role1 -excluded true -unchecked false The role [role1] has been successfully modified.
1.14.18. remove-custom-password-validator
Deletes the class registered in Custom Password Validator. For more information about password validation, refer to Password Security Settings in JEUS Security Guide.
-
Alias
remove-custom-validator
-
Usage
remove-custom-password-validator [-class <class-name>]
-
Parameters
Parameter Description -class <class-name>
Name of the class that has been placed under DOMAIN_HOME/lib/application as a JAR file and added to the custom password validator using the add-custom-password-validator command.
-
Example
[MASTER]domain1.adminServer> remove-custom-password-validator -class MyValidator Custom password validator [MyValidator] is removed successfully. Check the results using show-custom-password-validator.
1.14.19. remove-group
Dynamically deletes a group from the current domain. Only groups with no users can be deleted.
-
Alias
removegroup
-
Usage
remove-group <group-name> [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <group-name>
Group name.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer> remove-group group1 The group [group1] has been successfully removed.
1.14.20. remove-resource
Dynamically deletes a resource from the current domain.
-
Alias
rmresource
-
Usage
remove-resource <resource-name> <actions> [-contextid <context-id>] [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <resource-name>
Name of the resource to delete.
<actions>
Action list of the resource to delete.
[-contextid <context-id>]
Context name that distinguishes policies. The contextid is used to specify a context other than the default context.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer> remove-resource resource1 jeus.* The resource [name=resource1, actions=jeus.*] has been successfully removed.
1.14.21. remove-role
Dynamically deletes a role from the current domain.
-
Alias
rmrole
-
Usage
remove-role <role-name> [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <role-name>
Name of the role to delete.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer> remove-role role1 The role [role1] has been successfully removed.
1.14.22. remove-user
Dynamically deletes a user from the current domain.
-
Alias
removeuser
-
Usage
remove-user <user-name> [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <user-name>
User name.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer> remove-user user1 The user [user1] has been successfully removed.
1.14.23. remove-user-from-group
Dynamically deletes a user member from a group in the current domain.
-
Alias
removeuserfromgroup
-
Usage
remove-user-from-group <group-name> <user-name> [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <group-name>
Group name.
<user-name>
User name.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer> remove-user-from-group group1 user1 The user [user1] has been successfully removed from the group [group1].
1.14.24. set-password
Dynamically sets the user password. The password must be created using plain characters without any encryption or encoding. The password can be encrypted using the -algorithm option. The user must login again with a new password.
|
This command deletes all previous passwords set for the user. |
-
Alias
setpassword
-
Usage
set-password <user-name> <password> [-algorithm <algorithm>] [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <user-name>
User name.
<password>
[Dynamic] User password.
[-algorithm < algorithm>]
[Dynamic] Password encryption algorithms.
Input options:
-
AES
-
base64
-
DES
-
DESede
-
Blowfish
-
SEED
-
SHA
[-f,--forceLock]
Forcibly applies the configuration changes.
-
-
Example
[MASTER]domain1.adminServer> set-password user1 pass1 -algorithm AES The password is set for [user1].
1.14.25. show-custom-password-validator
Displays the current custom password validator settings. For more information about password validation, refer to Password Security Settings in JEUS Security Guide.
-
Alias
show-custom-validator
-
Usage
show-custom-password-validator
-
Example
[MASTER]domain1.adminServer> show-custom-password-validator ================================================================================ +------------------------------------------------------------------------------+ | custom password validator class names | +------------------------------------------------------------------------------+ | MyValidator | +------------------------------------------------------------------------------+ ================================================================================
1.14.26. show-default-password-validator
Displays the current default password validator settings. For more information about password validation, refer to Password Security Settings in JEUS Security Guide.
-
Alias
show-password-validator
-
Usage
show-default-password-validator
-
Example
[MASTER]domain1.adminServer> show-default-password-validator ================================================================================ +----------------------------------------------------------------------+-------+ | property | value | +----------------------------------------------------------------------+-------+ | min length | 4 | | max length | 255 | | include special characters | true | | include digit characters | false | | include capital characters | false | | include small characters | false | | exclude user id | false | +----------------------------------------------------------------------+-------+ ================================================================================
1.14.27. show-subject-validation
Displays the current subject validation service settings. For more information about subject validation, refer to [Subject Validation] menu in JEUS Security Guide.
-
Alias
ssv
-
Usage
show-subject-validation
-
Example
[MASTER]domain1.adminServer> show-subject-validation ================================================================================ +--------------------------+---------------------------------------------------+ | Type | Class name | +--------------------------+---------------------------------------------------+ | DefaultSubjectValidation | jeus.security.impl.expiration.SubjectExpirationVa | | |lidationService | +--------------------------+---------------------------------------------------+ | DefaultSubjectValidation | jeus.security.impl.lockout.SubjectLockoutValidati | | |onService | +--------------------------+---------------------------------------------------+ ================================================================================
1.14.28. show-group
Displays detailed group information.
-
Alias
showgroup, getgroup
-
Usage
show-group <group-name> [-domain <domain-name>] -
Parameters
Parameter Description <group-name>
Group name.
-
Example
[MASTER]domain1.adminServer> show-group Administrators Administrators(members:Principal admin,Principal user1)
1.14.29. show-policy
Displays policies that include a context ID. If a context-id is not specified, it is set to "default".
-
Alias
showpolicy, getpolicy
-
Usage
show-policy [-contextid <context-id>] [-domain <domain-name>] -
Parameters
Parameter Description [-contextid <context-id>]
Context name that distinguishes policies.
-
Example
[MASTER]domain1.adminServer> show-policy ______________POLICY_______________ ROLE PERMISSIONS: PERMISSION MAP -------------- Excluded permissions: (none) Unchecked permissions: (jeus.security.resource.RolePermission jndiUser) Checked permissions: Permission owner: Principal user1 Permissions of owner: (jeus.security.resource.RolePermission AdministratorsRole) Permission owner: Principal anonymous Permissions of owner: (jeus.security.resource.RolePermission jndiUser) Unassigned permissions: RESOURCE PERMISSIONS: Context id: default PERMISSION MAP -------------- Excluded permissions: (none) Unchecked permissions: (none) Checked permissions: Permission owner: Role jndiUser Permissions of owner: (jeus.security.resource.ResourcePermission jeus.jndi.* lookup) Permission owner: Role AdministratorsRole Permissions of owner: (jeus.security.resource.ResourcePermission jeus.* *) Unassigned permissions:
1.14.30. show-user
Displays detailed user information.
-
Alias
showuser, getuser
-
Usage
show-user <user-name> [-domain <domain-name>] -
Parameters
Parameter Description <user-name>
User name.
-
Example
[MASTER]domain1.adminServer> show-user user1 [SUBJECT] Description: No description Domain: SYSTEM_DOMAIN Main principal: Principal user1 Principals: [Principal user1,Administrators(members:Principal admin,Principal user1)] Public credentials: []
1.14.31. unassign-role-from-principal
Dynamically deletes a role from a principal.
-
Alias
unassignrole, unassign-role
-
Usage
unassign-role-from-principal <principal> <role-name> [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <principal>
Principal name.
<role-name>
[Dynamic] Role name.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer> unassign-role-from-principal jeus jndiuser The role [jndiuser] has been successfully unassigned from the principal [jeus].
1.14.32. unassign-resource-from-role
Dynamically deletes a resource from a role. The role cannot access the resource.
-
Alias
unassignresource, usassignres
-
Usage
unassign-resource-from-role <resource-name> <actions> <role-name> [-contextid <context-id>] [-domain <domain-name>] [-f,--forceLock] -
Parameters
Parameter Description <resource-name>
[Dynamic] Resource name.
<actions>
[Dynamic] List of actions for the resource.
<role-name>
Role name.
[-contextid <context-id>]
[Dynamic] Context name that distinguishes policies.
[-f,--forceLock]
Forcibly applies the configuration changes.
-
Example
[MASTER]domain1.adminServer> unassign-resource-from-role jeus.* -actions deploy-applications deployRole The resource [name=jeus.*, actions=deploy-applications] has been successfully unassigned from the role [deployRole].
1.14.33. unexpire-user
Removes an expiration time that has been specified with expire-user.
-
Alias
unexpireuser, unexuser
-
Usage
unexpire-user <user-name> [-domain <domain-name>] -
Parameters
Parameter Description <user-name>
User name.
-
Example
[MASTER]domain1.adminServer> unexpire-user user2 The expiry time for user [user2] is canceled.
1.14.34. unlock-user
Releases a lock that has been set using lock-user.
-
Alias
unlockuser
-
Usage
unlock-user <user-name> [-domain <domain-name>] -
Parameters
Parameter Description <user-name>
User name.
-
Example
[MASTER]domain1.adminServer> unlock-user user2 The user [user2] has been successfully unlocked.
1.15. Configuration Editing Commands
This section describes the commands that edit JEUS configurations. JEUS’s dynamic configuration modification tool can be used through the console by using these commands.
|
For detailed explanations on the dynamic configuration change feature, refer to Changing Domain Settings in JEUS Domain Guide. |
The following needs to be pointed out before describing the commands.
-
JEUS configurations edited by using the configuration editing commands
The configuration editing commands are used to edit Java objects which are used by the JEUS server to save configurations. These objects used JAXB to change the XML schema defined in domain.xml (which expresses JEUS configuration) to Java objects. As a result, the object structure and the names of each item are similar to those in domain.xml, but some parts may be expressed differently.
-
Simple Type
Does not contain child items.
-
Complex Type
Contains child items. A child can have simple types, or lists that contain complex types and simple types, or lists that contain complex types.
-
List
Also contains configuration items in the list format containing simple types or complex types as elements.
-
Path
Configuration editing commands indicate the location of each item as a path in JEUS configurations. A path consists of the name of a configuration item, the identifier of a complex type, or an index. Each item is separated by a slash (/).
-
A root is expressed as a single slash.
-
The current location is expressed as a single dot.
-
The parent item of the current location is expressed as two dots. For example, the path name for the parent of the '/servers' item is expressed as '/servers/..'.
-
The name of a configuration item is usually the path name of the configuration item. For example, the path of the servers item under 'root' are expressed as '/servers'. The servers item has child items, and if one of the item’s name is called 'server', then the path of the server item is '/servers/server'.
-
A list that contains a complex type as an element uses the value of the identifier of the complex type as the path name. An identifier is a child item with a unique value that identifies a specific complex type when multiple complex types in the same format exist. For example, '/servers/server' is a list that consists of multiple complex types that contains the configurations of each server in the domain configuration. An identifer is specified to use the server name in a complex type, which contains the server configuration. As a result, the path name of the configuration item for server1 can be expressed as '/servers/server/server1'.
-
A list that has a simple type (instead of a complex type) as an element cannot contain an identifier. As a result, an index, which identifies the element number in the list, is used as the path name. An index number with an integer greater than 0 is specified inside brackets. For example, if there is a list with a path named '/a/b' and 'b' as the simple type, then the first element of the list is expressed as '/a/b/[0]'.
The first element when expressing the path for a simple type list is expressed as [0], not [1].
-
Each configuration editing command may specify or modify the current path. The current path is stored in a server. As a result, if multiple jeusadmin are executed, and configuration changes are applied in multiple places, then the current path may be changed inadvertently. This may result in abnormal execution of the command. Therefore, when modifying a configuration, it is recommended that only one jeusadmin is executed.
-
The following table describes the list of commands used for editing configurations. All these commands can only be used when connected to a server.
| Command | Description |
|---|---|
Applies modified configurations to a server and displays the results. |
|
Disables the lock for dynamic configuration changes, and deletes the modified history stored in a server. This command can be used even when there is no lock. |
|
Checks or changes the current path. |
|
Creates an empty complex type in a specified item, or creates a new item in a list that has complex type as an element. |
|
Deletes an item located in a specified path. |
|
Changes the value of a specified simple type, or adds a new item to a list that has simple type as an element. |
|
Sends a request to a server to request a lock for dynamic configuration changes. |
|
Displays the information about an item that exists in a specified path. |
1.15.1. activate-configuration
Applies modified configurations to a server and displays the results.
-
Alias
activate
-
Usage
activate-configuration
-
Example
[MASTER]domain1.adminServer>cd / [MASTER]domain1.adminServer>ls description Not specified (string ) productionMode true id 982883233 securityManager complex type passwordValidator Not specified (complex type) adminServerName adminServer domainLogHome Not specified (string ) systemClusteringFramework complex type domainBackup complex type enableWebadmin true enableJsonCommand false enableToResynchronizeApplications false servers complex type sessionCluster complex type clusters Not specified (complex type) serverTemplates Not specified (complex type) lifecycleInvocation list of [lifecycleInvocation] applicationRepositories Not specified (complex type) deployedApplications Not specified (complex type) deployedLibraries Not specified (complex type) resources Not specified (complex type) [MASTER]domain1.adminServer>set description "Hello, world" The value Hello, world is set at the specified location /description. [MASTER]domain1.adminServer>ls description Hello, world productionMode true id 982883233 securityManager complex type passwordValidator Not specified (complex type) adminServerName adminServer domainLogHome Not specified (string ) systemClusteringFramework complex type domainBackup complex type enableWebadmin true enableJsonCommand false enableToResynchronizeApplications false servers complex type sessionCluster complex type clusters Not specified (complex type) serverTemplates Not specified (complex type) lifecycleInvocation list of [lifecycleInvocation] applicationRepositories Not specified (complex type) deployedApplications Not specified (complex type) deployedLibraries Not specified (complex type) resources Not specified (complex type) [MASTER]domain1.adminServer>activate The activation completed successfully. [Details] domain.xml : ACTIVATED domain : ACTIVATED domain.description : ACTIVATED
1.15.2. cancel
Deletes changes, and releases the lock for dynamic configuration changes. This can be used even when a user that executes commands does not acquire a lock. This is a command that can forcibly release the lock intended for dynamic configuration changes.
-
Usage
cancel
-
Example
[MASTER]domain1.adminServer>edit Successfully acquired a configuration lock from Domain Administration Server. [MASTER]domain1.adminServer>ls description Hello, world productionMode true id 982883233 securityManager complex type passwordValidator Not specified (complex type) adminServerName adminServer domainLogHome Not specified (string ) systemClusteringFramework complex type domainBackup complex type enableWebadmin true enableJsonCommand false enableToResynchronizeApplications false servers complex type sessionCluster complex type clusters Not specified (complex type) serverTemplates Not specified (complex type) lifecycleInvocation list of [lifecycleInvocation] applicationRepositories Not specified (complex type) deployedApplications Not specified (complex type) deployedLibraries Not specified (complex type) resources Not specified (complex type) [MASTER]domain1.adminServer>cancel Current configuration editing status is cleared, and the configuration lock is released. [MASTER]domain1.adminServer>ls Current user does not have the configuration lock.
1.15.3. change-current-path
Changes a specified path to the current path. If a path is not specified, then the current path will be displayed.
-
Alias
cd
-
Usage
change-current-path [<path>]
-
Parameters
Parameter Description [<path>]
Either an absolute path or a relative path to change.
-
Example
[MASTER]domain1.adminServer>change-current-path servers/server/adminServer Current path is changed to /servers/server/adminServer [MASTER]domain1.adminServer>change-current-path .. Current path is changed to /servers/server [MASTER]domain1.adminServer>change-current-path . Current path is changed to /servers/server [MASTER]domain1.adminServer>change-current-path / Current path is changed to / [MASTER]domain1.adminServer>change-current-path servers/server/server1/../.././server/adminServer Current path is changed to /servers/server/adminServer [MASTER]domain1.adminServer>cd /servers/server/adminServer
1.15.4. create-empty-element
Creates a new complex type in a specified location. The complex type will be empty, and it must be filled manually. If an element with a complex type uses an identifier value as an item name, it creates a type in which a specified value becomes an identifier value, and adds the type to the list.
-
Alias
create
-
Usage
create-empty-element <name> [<type>] -
Parameters
Parameter Description <name>
Name of the item to be created. When adding a new complex type in a list that has a complex type as an element, then this parameter creates a complex type which uses the value specified by using the item name as the identifier value.
[<type>]
Type of the item to be created. Typically they do not need to be specified. However, for a list with multiple types as the element, then the type to be created needs to be specified.
-
Example
-
The following is an example of creating an empty complex type.
[MASTER]domain1.adminServer>cd / [MASTER]domain1.adminServer>create-empty-element passwordValidator Created an empty complex type of passwordValidator at path /
-
The following is an example of adding a new complex type to a list that has a complex type as an element. A new server item that uses 'server2' as the server name (which is an identifier) is created and added to the list.
[MASTER]domain1.adminServer>cd /servers/server Current path is changed to /servers/server [MASTER]domain1.adminServer>ls adminServer server1 Current list can contain the following type of elements: [server] The name of the identifier element of [server] element is [name]. [MASTER]domain1.adminServer>create-empty-element server2 Added a new element of type server with id [name == server2] to the list at path /servers/server [MASTER]domain1.adminServer>ls adminServer server1 server2 Current list can contain the following type of elements: [server] The name of the identifier element of [server] element is [name].
-
The following is an example of specifying the complex type to be created by using the type option. The results of the show-element command shows multiple types of elements. If a type is not specified, then a help message will be displayed.
[MASTER]domain1.adminServer>cd /servers/server/adminServer/systemLogging/jeus/handler/ fileHandlerOrSmtpHandlerOrSocketHandler [MASTER]domain1.adminServer>ls fileHandler Current list can contain the following type of elements: [fileHandler, userHandler, smtpHandler, socketHandler] The name of the identifier element of [fileHandler, userHandler, smtpHandler, socketHandler] element is [name]. [MASTER]domain1.adminServer>create-empty-element handler1 Must specify an element type to create a new element. Available types are fileHandler, userHandler, smtpHandler, socketHandler. [MASTER]domain1.adminServer>create-empty-element handler1 userHandler Added a new element of type userHandler with id [name == handler1] to the list at path /servers/server/adminServer/systemLogging/jeus/handler/fileHandlerOrSmtpHandlerOrSocketHandler [MASTER]domain1.adminServer>ls fileHandler handler1 Current list can contain the following type of elements: [fileHandler, userHandler, smtpHandler, socketHandler] The name of the identifier element of [fileHandler, userHandler, smtpHandler, socketHandler] element is [name].
-
1.15.5. delete-element
Deletes an item located in a specified path.
-
Alias
delete, rm
-
Usage
delete-element <path>
-
Parameters
Parameter Description <path>
Path of the item whose value will be deleted.
-
Example
[MASTER]domain1.adminServer>cd / Current path is changed to / [MASTER]domain1.adminServer>ls description Hello,world productionMode true id 982883233 securityManager complex type passwordValidator Not specified (complex type) adminServerName adminServer domainLogHome Not specified (string ) systemClusteringFramework complex type domainBackup complex type enableWebadmin true enableJsonCommand false enableToResynchronizeApplications false servers complex type sessionCluster complex type clusters Not specified (complex type) serverTemplates Not specified (complex type) lifecycleInvocation list of [lifecycleInvocation] applicationRepositories Not specified (complex type) deployedApplications Not specified (complex type) deployedLibraries Not specified (complex type) resources Not specified (complex type) [MASTER]domain1.adminServer>delete-element description Successfully delete the target element at /description. [MASTER]domain1.adminServer>ls description Not specified (string ) productionMode true id 982883233 securityManager complex type passwordValidator Not specified (complex type) adminServerName adminServer domainLogHome Not specified (string ) systemClusteringFramework complex type domainBackup complex type enableWebadmin true enableJsonCommand false enableToResynchronizeApplications false servers complex type sessionCluster complex type clusters Not specified (complex type) serverTemplates Not specified (complex type) lifecycleInvocation list of [lifecycleInvocation] applicationRepositories Not specified (complex type) deployedApplications Not specified (complex type) deployedLibraries Not specified (complex type) resources Not specified (complex type)
1.15.6. start-configuration-editing
Acquires a lock for dynamic configuration changes by sending a request to a server. If a lock is acquired, then the server’s current path is initialized. When a lock is not acquired, commands (excluding the cancel command) are not executed. As a result, a lock must be acquired by first executing this command.
-
Alias
lock-and-edit, edit
-
Usage
start-configuration-editing [-f]
-
Parameters
Parameter Description [-f]
When another user has a lock for dynamic configuration changes, this parameter ignores this and attempts to forcibly acquire the lock.
-
Example
[MASTER]domain1.adminServer>start-configuration-editing Successfully acquired a configuration lock from Domain Administration Server.
1.15.7. set-element-value
This is used for modifying the value of a simple type item, or adding a value to a list that has simple type as an element.
-
Alias
set
-
Usage
set-element-value <path><value>
-
Parameters
Parameter Description <path>
Specifies the path of the item to modify.
<value>
Specifies the value to modify.
-
Example
-
This is an example of setting a value called "Hello,world!" in the description item by using the set-element-value command.
[MASTER]domain1.adminServer>cd / Current path is changed to / [MASTER]domain1.adminServer>ls description Not specified (string ) productionMode true id 982883233 securityManager complex type passwordValidator Not specified (complex type) adminServerName adminServer domainLogHome Not specified (string ) systemClusteringFramework complex type domainBackup complex type enableWebadmin true enableJsonCommand false enableToResynchronizeApplications false servers complex type sessionCluster complex type clusters Not specified (complex type) serverTemplates Not specified (complex type) lifecycleInvocation list of [lifecycleInvocation] applicationRepositories Not specified (complex type) deployedApplications Not specified (complex type) deployedLibraries Not specified (complex type) resources Not specified (complex type) [MASTER]domain1.adminServer>set-element-value description "Hello,world" The value Hello,world is set at the specified location /description. [MASTER]domain1.adminServer>ls description Hello,world productionMode true id 982883233 securityManager complex type passwordValidator Not specified (complex type) adminServerName adminServer domainLogHome Not specified (string ) systemClusteringFramework complex type domainBackup complex type enableWebadmin true enableJsonCommand false enableToResynchronizeApplications false servers complex type sessionCluster complex type clusters Not specified (complex type) serverTemplates Not specified (complex type) lifecycleInvocation list of [lifecycleInvocation] applicationRepositories Not specified (complex type) deployedApplications Not specified (complex type) deployedLibraries Not specified (complex type) resources Not specified (complex type)
-
This is an example of adding a value to a list that has simple type as an element. The path of the list in which a value will be added is used as an item name.
[MASTER]domain1.adminServer>start-configuration-editing Successfully acquired a configuration lock from Domain Administration Server. [MASTER]domain1.adminServer>cd lifecycleInvocation Current path is changed to /lifecycleInvocation [MASTER]domain1.adminServer>create-empty-element com.tmax.sample Added a new element of type lifecycleInvocation with id [className == com.tmax.sample] to the list at path /lifecycleInvocation [MASTER]domain1.adminServer>cd com.tmax.sample Current path is changed to /lifecycleInvocation/com.tmax.sample [MASTER]domain1.adminServer>cd invocation Current path is changed to /lifecycleInvocation/com.tmax.sample/invocation [MASTER]domain1.adminServer>create-empty-element invocation Added a new element of type invocation to the list at path /lifecycleInvocation/com.tmax.sample/invocation [MASTER]domain1.adminServer>cd [0] Current path is changed to /lifecycleInvocation/com.tmax.sample/invocation/[0] [MASTER]domain1.adminServer>ls invocationMethod Not specified (complex type) invocationArgument list of [string] invocationType Not specified (enum[BOOT, BEFORE_DEPLOY, AFTER_DEPLOY, READY, BEFORE_UNDEPLOY, AFTER_UNDEPLOY]) [MASTER]domain1.adminServer>set-element-value invocationArgument arg0 The value arg0 added to the list in the specified location: /lifecycleInvocation/com.tmax.sample/invocation/[0]/invocationArgument. [MASTER]domain1.adminServer>cd invocationArgument Current path is changed to /lifecycleInvocation/com.tmax.sample/invocation/[0]/invocationArgument [MASTER]domain1.adminServer>ls [0] arg0 Current list can contain the following type of elements: [string] [MASTER]domain1.adminServer>set-element-value . arg1 The value arg1 added to the list in the specified location: /lifecycleInvocation/com.tmax.sample/invocation/[0]/invocationArgument. [MASTER]domain1.adminServer>ls [0] arg0 [1] arg1 Current list can contain the following type of elements: [string]
-
1.15.8. show-element
Displays the information about the items located in a specified path. The information displayed includes name, value, and type. When a path is not specified, the path for the current location is displayed.
-
Alias
ls
-
Usage
show-element [<path>]
-
Parameters
Parameter Description [<path>]
Specifies the path of the item to be retrieved.
-
Example
-
This is an example of displaying the information about a complex type. The item name, value (if there is one), and the type of the value are displayed.
[MASTER]domain1.adminServer>show-element name adminServer nodeName node1 listeners complex type logHome Not specified (string ) group Not specified (string ) jvmConfig complex type userInterceptor Not specified (complex type) userLogging Not specified (complex type) systemLogging list of [systemLogging] logStdoutToRawFormat true actionOnResourceLeak WARNING (enum[NO_ACTION, WARNING, AUTO_CLOSE]) tmConfig complex type externalResource list of [externalResource] managedExecutorService list of [string] managedScheduledExecutorService list of [string] contextService list of [string] managedThreadFactory list of [string] scheduler Not specified (complex type) namingServer complex type jmxManager Not specified (complex type) systemThreadPool complex type dataSourceRemoteLookup false engineInitOnStartup true useWebEngine true useEjbEngine true useJmsEngine true webEngine complex type ejbEngine complex type jmsEngine complex type useMEJB false classFtp true enableInterop Not specified (complex type) lifecycleInvocation list of [lifecycleInvocation] resRef complex type jmsResource complex type dataSources Not specified (complex type) customResourceRefs Not specified (complex type) externalResourceRefs Not specified (complex type) autoGenerated Not specified (boolean )
-
This is an example of displaying the information about the list of the items that have complex type as an element. The name of each item is displayed as the value of the identifier. The identifer and the type of the value in the list are displayed.
[MASTER]domain1.adminServer>show-element /servers/server adminServer server1 Current list can contain the following type of elements: [server] The name of the identifier element of [server] element is [name].
-
1.16. OSGi Commands
The following is a list of OSGi commands.
| Command | Description |
|---|---|
Adds an OSGi framework configuration to the domain. |
|
Installs bundles in a specified location to a specified OSGi framework. |
|
Displays a list of OSGi frameworks configured in the domain. |
|
Modifies a OSGi framework configuration. |
|
Deletes a OSGi framework configuration. |
|
Displays information of the OSGi frameworks running in a specified server. |
|
Starts a specified bundle. |
|
Stops a specified bundle. |
|
Deletes a specified bundle. |
|
Updates a specified bundle. |
1.16.1. add-osgi-framework
Adds an OSGi framework configuration to the domain.
-
Alias
addfwk
-
Usage
add-osgi-framework -n,--name <framework-name> [-en,--exportName <jndi-export-name>] [-s,--servers <server-list>] [-iib <true | false>] [-ibd <path>] [-dsl <start-level>] [-foe <true | false>] [-bid <path-list>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -n,--name <framework-name>
Unique name of the OSGi framework.
[-en,--exportName <jndi-export-name>]
JNDI name of the OSGi framework.
[-s,--servers <server-list>]
A list of servers that uses the OSGi framework. To specify multiple servers, separate each server with a comma(,).
[-iib <true | false>]
Determines whether to install bundles in the initial bundles directory. (true | false)
[-ibd <path>]
Path of the initial bundles directory. If not specified, the default path is JEUS_HOME/lib/osgi/FRAMEWORK_NAME.
[-dsl <start-level>]
Start-level default value for the bundles located in the initial bundles directory.
[-foe <true | false>]
Determines whether to regard the failure to install initial bundles as an error. (true | false)
[-bid <path-list>]
Path of bundle installation descriptor XML files. To specify multiple files, separate each file with a comma(,).
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>list-osgi-frameworks No OSGi Frameworks exists. [MASTER]domain1.adminServer>add-osgi-framework -name framework-0 -servers server1 Successfully performed the ADD operation for OSGi Framework framework-0, but all changes were non-dynamic. They will be applied after restarting. Check the results using "list-osgi-frameworks". [MASTER]domain1.adminServer>list-osgi-frameworks List of OSGi Frameworks ================================================================================ +------------------------+----------------------------+------------------------+ | Framework Name | JNDI Export Name | Target Servers | +------------------------+----------------------------+------------------------+ | framework-0 | | server1 | +------------------------+----------------------------+------------------------+ ================================================================================ [MASTER]domain1.adminServer>
1.16.2. install-bundle
Installs bundles in a specified location to a specified OSGi framework.
-
Alias
installb
-
Usage
install-bundle -l,--location <location> -f,--framework <framework-name> -s,--server <server-name> -
Parameters
Parameter Description -l,--location <location>
URL of the bundle to be installed.
-f,--framework <framework-name>
Name of the OSGi framework to which the bundle will be installed.
-s,--server <server-name>
Server to which the bundle will be installed.
-
Example
[MASTER]domain1.adminServer>install-bundle -location https://repo.maven.apache.org/maven2/org/ops4j/pax/url/pax-url-mvn/1.3.7/pax-url-mvn-1.3.7.jar -framework framework-0 -server server1 Installation completed successfully. [MASTER]domain1.adminServer>
1.16.3. list-osgi-frameworks
Displays a list of OSGi frameworks configured in the domain.
-
Alias
lsfwks
-
Usage
list-osgi-frameworks [-f,--framework <framework-name>]
-
Parameters
Parameter Description [-f,--framework <framework-name>]
Displays detailed configuration of a specified OSGi framework.
-
Example
[MASTER]domain1.adminServer>list-osgi-frameworks List of OSGi Frameworks ================================================================================ +------------------------+----------------------------+------------------------+ | Framework Name | JNDI Export Name | Target Servers | +------------------------+----------------------------+------------------------+ | framework-0 | | server1 | +------------------------+----------------------------+------------------------+ ================================================================================ [MASTER]domain1.adminServer>list-osgi-frameworks -framework framework-0 OSGi Framework [framework-0] ================================================================================ +--------------------------------------------------------------+---------------+ | Attribute Name | Value | +--------------------------------------------------------------+---------------+ | Framework Name | framework-0 | | JNDI Export Name | Not Specified | | Target Servers | server1 | | Install Initial Bundles | true | | Initial Bundles Directory Location | Not Specified | | Default Start Level | 30 | | Fail On Error | true | +--------------------------------------------------------------+---------------+ ================================================================================ Framework Configuration Properties ==================================================== +-----+--------------------------------------------+ | Key | Value | +-----+--------------------------------------------+ (No data available) ==================================================== Bundle Installation Descriptors ================================================================================ +------------------------------------------------------------------------------+ | Location | +------------------------------------------------------------------------------+ (No data available) ================================================================================
1.16.4. modify-osgi-framework
Modifies an OSGi framework configuration.
-
Alias
modfwk
-
Usage
modify-osgi-framework -n,--name <framework-name> [-en,--exportName <jndi-export-name>] [-s,--servers <server-list>] [-iib <true | false>] [-ibd <path>] [-dsl <start-level>] [-foe <true | false>] [-bid <path-list>] [-f,--forceLock] [-detail] -
Parameters
Parameter Description -n,--name <framework-name>
Unique name of the OSGi framework.
[-en,--exportName <jndi-export-name>]
JNDI name of the OSGi framework.
[-s,--servers <server-list>]
A list of servers that uses the OSGi framework. To specify multiple servers, separate each server with a comma(,).
[-iib <true | false>]
Determines whether to install bundles in the initial bundles directory. (true | false)
[-ibd <path>]
Path of the initial bundles directory. If not specified, the default path is JEUS_HOME/lib/osgi/FRAMEWORK_NAME.
[-dsl <start-level>]
Start-level default value for the bundles located in the initial bundles directory.
[-foe <true | false>]
Determines whether to regard the failure to install initial bundles as an error. (true | false)
[-bid <path-list>]
Path of bundle installation descriptor XML files. To specify multiple files, separate each file with a comma(,).
[-f,--forceLock]
Forcibly applies the configuration changes.
[-detail]
Displays detailed results of the dynamic changes.
-
Example
[MASTER]domain1.adminServer>modify-osgi-framework -name framework-0 -dsl 45 Successfully performed the MODIFY operation for OSGi Framework framework-0, but some changes were non-dynamic. They will be applied after restarting. Check the results using "list-osgi-frameworks". [MASTER]domain1.adminServer>
1.16.5. remove-osgi-framework
Deletes a OSGi framework configuration.
-
Alias
rmfwk
-
Usage
remove-osgi-framework -n,--name <framework-name>
-
Parameters
Parameter Description -n,--name <framework-name>
Name of the OSGi framework to delete.
-
Example
[MASTER]domain1.adminServer>remove-osgi-framework -name framework-0 Successfully performed the REMOVE operation for OSGi Framework framework-0. Check the results using "list-osgi-frameworks". [MASTER]domain1.adminServer>
1.16.6. show-osgi-framework-info
Displays information of the OSGi frameworks running in a specified server.
-
Alias
osgiinfo, fwkinfo
-
Usage
show-osgi-framework-info -s,--server <server-name> [-f,--framework <framework-name>] [-lb] -
Parameters
Parameter Description -s,--server <server-name>
Server name.
[-f,--framework <framework-name>]
Name of the OSGi framework to display the information.
[-lb]
Determines whether to display the information of the installed bundles. This parameter must be used with the -f option.
-
Example
[MASTER]domain1.adminServer>show-osgi-framework-info -server server1 -framework framework-0 -lb OSGi Framework [framework-0] Information in the server[framework-0] Framework [framework-0] Overview ====================================================================== +----------------------------------------------------------+---------+ | System Bundle Name | Version | +----------------------------------------------------------+---------+ | org.apache.felix.framework | 5.4.0 | +----------------------------------------------------------+---------+ ====================================================================== Installed Bundles in the framework [framework-0]. ================================================================================ +----+-------------------+---------+--------------------+--------+-------------+ | Id | Symbolic Name | Version | Location | State | Start-level | +----+-------------------+---------+--------------------+--------+-------------+ | 0 | org.apache.felix. | 5.4.0 | System Bundle | ACTIVE | 0 | | |framework | | | | | +----+-------------------+---------+--------------------+--------+-------------+ | 2 | org.ops4j.pax.url | 1.3.7 | https://repo.maven | ACTIVE | 30 | | |.mvn | |.apache.org/maven2/ | | | | | | |org/ops4j/pax/url/p | | | | | | |ax-url-mvn/1.3.7/pa | | | | | | |x-url-mvn-1.3.7.jar | | | +----+-------------------+---------+--------------------+--------+-------------+ ================================================================================ [MASTER]domain1.adminServer>
1.16.7. start-bundle
Starts a specified bundle.
-
Alias
startb
-
Usage
start-bundle -name <bundle-symbolic-name> [-version <bundle-version>] -f,--framework <framework-name> -s,--server <server-name> -
Parameters
Parameter Description -name <bundle-symbolic-name>
Name of the bundle to start.
[-version <bundle-version>]
Version of the bundle to to start.
-f,--framework <framework-name>
Name of the OSGi framework.
-s,--server <server-name>
Server name.
-
Example
[MASTER]domain1.adminServer>start-bundle -name org.ops4j.pax.url.mvn -framework framework-0 -server server1 The bundle has been started successfully. [MASTER]domain1.adminServer>
1.16.8. stop-bundle
Stops a specified bundle.
-
Alias
stopb
-
Usage
stop-bundle -name <bundle-symbolic-name> [-version <bundle-version>] -f,--framework <framework-name> -s,--server <server-name> -
Parameters
Parameter Description -name <bundle-symbolic-name>
Name of the bundle to stop.
[-version <bundle-version>]
Version of the bundle to stop.
-f,--framework <framework-name>
Name of the OSGi framework.
-s,--server <server-name>
Server name.
-
Example
[MASTER]domain1.adminServer>stop-bundle -name org.ops4j.pax.url.mvn -framework framework-0 -server server1 The bundle has been stopped successfully. [MASTER]domain1.adminServer>
1.16.9. uninstall-bundle
Deletes a specified bundle.
-
Alias
uninstallb
-
Usage
uninstall-bundle -name <bundle-symbolic-name> [-version <bundle-version>] -f,--framework <framework-name> -s,--server <server-name> -
Parameters
Parameter Description -name <bundle-symbolic-name>
Name of the bundle to delete.
[-version <bundle-version>]
Version of the bundle to delete.
-f,--framework <framework-name>
Name of the OSGi framework.
-s,--server <server-name>
Server name.
-
Example
[MASTER]domain1.adminServer>uninstall-bundle -name org.ops4j.pax.url.mvn -framework framework-0 -server server1 The bundle has been uninstalled successfully. [MASTER]domain1.adminServer>
1.16.10. update-bundle
Updates a specified bundle.
-
Alias
updateb
-
Usage
update-bundle -name <bundle-symbolic-name> [-version <bundle-version>] -f,--framework <framework-name> -s,--server <server-name> [-l,--location <location>] -
Parameters
Parameter Description -name <bundle-symbolic-name>
Name of the bundle to update.
[-version <bundle-version>]
Version of the bundle to update.
-f,--framework <framework-name>
Name of the OSGi framework.
-s,--server <server-name>
Server name.
[-l,--location <location>]
URL of the bundle to use.
-
Example
[MASTER]domain1.adminServer>update-bundle -name org.ops4j.pax.url.mvn -framework framework-0 -server server1 The bundle has been updated successfully. [MASTER]domain1.adminServer>
1.17. Executing Commands Using JSON
If a JSON message, which requests command execution, is sent as a HTTP POST request to a server, the server handles the request and then sends a JSON message, which contains the result, as the HTTP response.
|
For more information about JSON, refer to www.json.org. |
1.17.1. Executing Regular Commands
The following is a command used as an example in this section.
serverinfo -server server1 -state
The following is the process of executing a command using JSON.
-
Create a JSON message that executes a command.
The following is a JSON message that executes the example command.
{ "jeusadmin": { "command": "server-info", "options":[ "-server server1", "-state" ], "argument": null } }Convention Description command
Name of the command to be executed.
options
Options and parameters of the command.
argument
Arguments of the command.
-
Send the JSON message to the server to request command execution. Set HTTP as the protocol and POST as the method.
The following is a URL that receives requests for executing JSON messages in JEUS.
http://${SERVER_HOST}:${SERVER_BASE_PORT}/jsonCommand/command.jsonTo execute a command on a JEUS server, user authentication is required. Use HTTP Basic Authentication for user authentication.
-
The server interprets and executes the JSON message. The JSON result message is then sent as a HTTP response. The execution result differs depending on the individual command.
The following is an example of a result that can be received as a server response. The result may change according to the JEUS domain configuration.
{ "jeusadmin-result": { "message":"", "data":[ { "title":"Information of Domain (domain1)", "header":null, "column-names":[ "Server","Status","Node Name","PID","Cluster", "Latest StartTime/ShutdownTime","Need to Restart", "Listen Ports","Running Engines" ], "rows":[ { "row-key":"0", "values":[ "server1(*)","RUNNING (284sec)","N/A","2151","N/A", ... (Omitted) ] } ], "footer":null } [, "post-message":"" } }The following comprise a JSON result message.
-
message
Message displayed at the top. If there are multiple messages, a list of messages is displayed. Depending on the command, a message may not exist.
-
data
Object that contains the execution result. Depending on the command, an object may not exist. A table is a regular data structure and comprised of the following.
Convention Description title
Table title.
header
Table header.
column-names
Table column names.
rows
Table rows.
A row is comprised of two elements.
-
row-key: Row name.
-
values: Row value.
footer
Table footer.
-
-
post-message
Message displayed at the bottom. If there are multiple post-messages, a list is displayed. Depending on the command, a message may not exist.
-
1.17.2. Application deploy
This section describes how to install and distribute an application using JSON. Unlike other commands, to install or distribute an application, the application must be sent along with the JSON message.
The following describes the process of installing or distributing an application using JSON.
-
Create a JSON message that requests command execution. The following is the command used to distribute the Hello.war application to 'server1'.
{ "jeusadmin": { "command": "deploy-application", "options":[ "-servers server1", "-path Hello.war" ], "argument": null } } -
Send the written JSON message and files as a multi-part type to the server to request command execution. Multi-part consists of a command part, which contains the JSON command written in the step 1, and a file part, which sets the application archive to be distributed.
The following is a URL that receives application deployment requests using a JSON message in the JEUS server.
http://${SERVER_HOST}:${SERVER_BASE_PORT}/jsonCommand/install.jsonTo execute a command on a JEUS server, user authentication is required. Use HTTP Basic Authentication for user authentication.
-
The server interprets and executes the JSON message. The JSON result message is then sent as a HTTP response. This part is same as executing regular commands. For more information, refer to Executing Regular Commands.
|
For more information about application installation and deployment, refer to install-application, deploy-application, and distribute-application. |
1.18. How to Use Script Mode and How to Write Scripts
This section describes how to use script mode and how to write scripts.
1.18.1. How to Use Script Mode
Run jeusadmin by using script mode.
-
Example
The following is an example of jeusadmin script mode which runs the test.py script with the assumption that the JEUS user name is 'administrator' and the password is 'jeus'.
JEUS_HOME/bin$jeusadmin -u administrator -p jeus -script "test.py" Attempting to connect to 127.0.0.1:9736. The connection has been established to JEUS Master Server [adminServer] in the domain [domain1]. JEUS 9 Administration Tool To view help, use the 'help' command.
When using the script mode, you can use an additional option that ignores JEUS command exceptions. The -i or -ignore option allows the script to continue running even if a JEUS command error occurs.
[-i, --ignore] option can be used only in the script mode.
JEUS_HOME/bin$jeusadmin -u administrator -p jeus -script "test.py" -i
JEUS_HOME/bin$jeusadmin -u administrator -p jeus -script "test.py" --ignore
Arguments can be given to a script as shown below.
JEUS_HOME/bin$jeusadmin -u administrator -p jeus -script "test.py arg1 arg2"
1.18.2. How to Write Scripts
jeusadmin provides the results data and methods for executing commands when it is executed in script mode.
-
Executing a command
Commands can be executed for each script language as shown below.
-
Python and Ruby
result = command("server-info") -
Ruby
result = command "server-info"
The verbose option can be executed with a JEUS command. By default, this option is deactivated (set to 'false'). If the verbose option is enabled (set to 'true') with a JEUS command, the result of the command execution is displayed in detail.
-
Python:
result = command("server-info", [True | False]) -
Ruby:
result = command "server-info", [true | false]
-
-
Results data
The JeusResult object is returned from executing a JEUS command. If the returned results include results in the table format, then the JeusTabularData object can be obtained from JeusResult.
-
JeusResult
Method Description isComplete()
Returns whether a JEUS command has been successfully executed.
getMessage()
Returns a results message.
getData()
Returns the list of JeusTabularData which is the table data of results.
-
JeusTabularData
Method Description getTitle()
Returns the title of a table.
getHeader()
Returns the header of a table.
getFooter()
Returns the footer of a table.
getColumnNames()
Returns only the title of each column in a table in list format.
getRows()
Returns the list of each column of table data.
-
-
Example
-
Searches and displays the servers in SHUTDOWN status.
result = command("server-info") tables = result.getData(); table = tables[0]; rows = table.getRows(); shutdown_servers = [] for row in rows: if "SHUTDOWN" in row[1]: shutdown_servers.append(row[0]) print("Server : %s, Node : %s" % (row[0], row[2])) -
Use the script argument to receive the application path and the list of servers to be deployed, and then install and deploy applications.
import time import sys import os path = sys.argv[0] servers = sys.argv[1] direc, app = os.path.split(path) apptype = os.path.splitext(app)[1][1:].upper() command("undeploy -f %s " % app) command("uninstall-application %s" % app) command("install-application %s -id %s" % (path, app)) command("deploy %s -servers %s -type %s" % (app, servers, apptype))
-
|
Currently, jeusadmin provides script mode only for two script languages, Python and Ruby, and they are separated with an extension. Only scripts with .py and .rb extensions are recognized and executed. |