7.3 Details of subcommands of the mngsvrutil command

This section describes the subcommands that can be specified as arguments of the mngsvrutil command.

Organization of this section
(1) list
(2) get
(3) set
(4) tracelevel
(5) start
(6) stop
(7) reload
(8) hold
(9) release
(10) collect
(11) change
(12) check
(13) dump
(14) add
(15) delete

(1) list

This subcommand displays a list of values, as specified in the argument. The following table lists and describes the arguments that can be specified for the list subcommand.

Table 7-2 Arguments that can be specified for the list subcommand

ArgumentExplanationTarget specification
Logical serverHost
StatusLists the logical servers in the management domain and shows their status.----
appStatusLists the J2EE applications that have been imported into the logical server specified by the -t option and shows their status.Y--
resStatusLists the J2EE resources that have been imported into the logical server specified by the -t option and shows their status.Y--
resJavaBeansStatusLists the JavaBeans resources that have been imported into the logical server specified by the -t option and shows their status.Y--
QueuesLists the queues belonging to the host specified by the -t option and shows their status.YY
Legend:
Y: Can be specified.
--: Cannot be specified.

You can use the list subcommand to display the following five types of information:

#
When operating in the V7 compatibility mode, if you specify appStatus in the argument, the registration date and import date are displayed. Also, if you specify resStatus or resJavaBeansStatus in the argument, the import date and time is displayed. To display the registration date and time and the import date and time in modes other than the V7 compatibility mode, you specify true in the header format compatibility option. The header is displayed and "0" is displayed in the item.

(2) get

This subcommand acquires the values specified by the argument for the logical server or host specified by the -t option. The arguments listed in Table 7-3 can be specified. Note that arguments other than domainName are referred to as metric category.

When a logical server is specified by the -t option, an error occurs if a logical server (Web server, Naming Service, or smart agent, for example) that is not a logical server that belongs to the metric category (J2EE server, SFO server, or CTM) is specified.

To monitor statistical information at a set interval, you can collect the statistical information on a regular basis by setting the sampling time to be equal to or greater than the interval.

If a J2EE application was started in the test mode, information is output in the format application-name_TEST.

The following table lists and describes the arguments that can be specified for the get subcommand. For details on the arguments that can be specified for the get subcommand, see Appendix A. Extended MIB Object Definition File in the uCosminexus Application Server Definition Reference Guide.

Table 7-3 Arguments that can be specified for the get subcommand

ArgumentExplanationTarget specification
Logical serverHost
domainNameAcquires the management domain.----
j2eeContainerAcquires J2EE container information.YY
webContainerAcquires Web container information.YY
jvmAcquires JavaVM information.YY
transactionAcquires transaction information.YY
httpServerAcquires Management Server (simple Web server) information.
We recommend that users need not acquire this information because it is management information that is used internally.
YY
httpSvrConnAcquires Web server and Web container connection information.YY
inprocHttpSvrAcquires in-process HTTP server information.YY
dataSourceAcquires data source (JDBC) information.YY
dataSrcFullAcquires data source (OTS 1.2-compatible JTA) information.YY
resAdapterAcquires resource adapter information.YY
j2eeAppsAcquires J2EE application information.YY
ejbAppsAcquires EJB application (EJB-JARs) information.YY
statelessBeanAcquires Stateless Session Bean information.YY
statelessBeanHomeAcquires Stateless Session Bean remote home interface information.YY
statelessBeanHomeMethodAcquires information on the Stateless Session Bean remote home interface method.YY
statelessBeanLocalHomeAcquires Stateless Session Bean local home interface information.YY
statelessBeanLocalHomeMethodAcquires information on the Stateless Session Bean local home interface method.YY
statelessBeanRemoteAcquires Stateless Session Bean remote component interface information.YY
statelessBeanRemoteMethodAcquires information on the Stateless Session Bean remote component interface method.YY
statelessBeanLocalComponentAcquires Stateless Session Bean local component interface information.YY
statelessBeanLocalComponentMethodAcquires information on the Stateless Session Bean local component interface method.YY
statefulBeanAcquires Stateful Session Bean information.YY
statefulBeanHomeAcquires Stateful Session Bean remote home interface information.YY
statefulBeanHomeMethodAcquires information on the Stateful Session Bean remote home interface method.YY
statefulBeanLocalHomeAcquires Stateful Session Bean local home interface information.YY
statefulBeanLocalHomeMethodAcquires information on the Stateful Session Bean local home interface method.YY
statefulBeanRemoteAcquires Stateful Session Bean remote component interface information.YY
statefulBeanRemoteMethodAcquires information on the Stateful Session Bean remote component interface method.YY
statefulBeanLocalComponentAcquires Stateful Session Bean local component interface information.YY
statefulBeanLocalComponentMethodAcquires information on the Stateful Session Bean local component interface method.YY
entityBeanAcquires Entity Bean information.YY
entityBeanHomeAcquires Entity Bean remote home interface information.YY
entityBeanLocalHomeAcquires Entity Bean local home interface information.YY
entityBeanRemoteAcquires Entity Bean remote component interface information.YY
entityBeanLocalComponentAcquires Entity Bean local component interface information.YY
msgDrivenBeanAcquires Message-driven Bean information.YY
webAppsAcquires Web application information.YY
servletsAcquires servlet information.YY
requestUrlAcquires information on each requested URL.YY
queuesAcquires information about the CTM schedule (queue state).YY
queueAppsAcquires information about the J2EE application connected to the CTM queue.YY
Legend:
Y: Can be specified.
--: Cannot be specified.

(3) set

This subcommand specifies two arguments and sets the value specified in the second argument for the variable specified for the first argument.

If the target logical J2EE server, logical SFO server, or J2EE application is restarted or redeployed after the value is setup , reset the value. If a logical server other than a logical J2EE server, logical SFO server, or logical performance tracer is specified in the -t option, an error occurs.

The following table lists and describes the arguments that can be specified for the set subcommand.

Table 7-4 Arguments that can be specified for the set subcommand

ArgumentExplanationTarget specification
Logical serverHost
jvmSamplingTime nSets the JavaVM sampling time to n seconds.#1Y--
webContainerSamplingTime nSets the Web container sampling time to n seconds.#1Y--
tranSamplingTime nSets the transaction sampling time to n seconds.#1, #2Y--
httpSvrSamplingTime nSets Management Server (simple Web server) sampling time to n seconds.#1
We recommend that users need not acquire this information because it is Management Server information that is used internally.
Y--
httpSvrConnSamplingTime nSets the HTTP server connector sampling time to n seconds.#1Y--
inprocHttpSvrSamplingTime nSets the in-process HTTP server sampling time to n seconds.#1Y--
dataSrcFullSamplingTime nSets the data source (OTS 1.2-compatible JTA) sampling time to n seconds.#1, #3Y--
resAdapterSamplingTime nSets the resource adapter sampling time to n seconds.#1, #3Y--
ejbSamplingTime nSets the EJB sampling time to n seconds.#1, #3Y--
webAppSamplingTime nSets the Web application sampling time to n seconds.#1, #3Y--
servletSamplingTime nSets the servlet sampling time to n seconds. #1, #3Y--
reqUrlSamplingTime nSets the sampling time for each URL requested after setting to n seconds.#1, #3Y--
allPrfTraceLevel STANDARD|DETAIL | tracelevelSets a PRF trace collection level for all performance tracers within a management domain.#4----
prfTraceLevel STANDARD|DETAIL | tracelevelSets a PRF trace collection level for the specified performance tracer or the performance tracer within the specified host.#4YY
Legend:
Y: Can be specified.
--: Cannot be specified.

#1
Specify an integer in the range -2147483647 to 3600 (seconds) for n. If a value outside this range is specified, an error occurs. If n is 0 or smaller, the statistical value collection switch is turned off. If 0 < n < 10, n = 10 is used. Various specification values and the corresponding operations are described below.
If a value that is 0 or smaller is specified, statistical information collection is stopped.
If a value in the range 1 to 9 is specified, the sampling time is set to the default (10 seconds) and statistical information collection begins.
If a value of 10 or greater is specified, the sampling time is set to the specified value and statistical information collection begins.
#2
This argument must be specified after the first transaction has started.
#3
If a J2EE application is deployed after this variable has been set, the variable value must be reset.
#4
A PRF trace collection level is set only for active performance tracers.
STANDARD
Sets the PRF trace collection level to STANDARD.
DETAIL
Sets the PRF trace collection level to DETAIL.

(4) tracelevel

This subcommand specifies a different PRF trace collection level for each functionality layer. A maximum of sixteen hexadecimal numbers of no more than 4 bytes (8 digits) each can be specified, delimited by a comma (,). For details on the specification values, see the explanation of -PrfTraceLevel under cprfstart (start PRF daemon) or the explanation of -PrfTraceLevel under cprflevel (display or change the PRF trace collection level) in 4.2 Details of commands used for performance analysis trace.

(5) start

This subcommand starts the specified logical server, J2EE application, or J2EE resource.

The following table lists and describes the arguments that can be specified for the start subcommand.

Table 7-5 Arguments that can be specified for the start subcommand

ArgumentExplanationTarget specification
Logical serverHost
allServersStarts the logical servers defined in the management domain in the defined starting order.----
serverStarts the logical server specified by the -t option.YY
app displayNameStarts the J2EE application specified by displayName that has been imported into the logical server specified by the -t option.#Y--
resAdapter displayNameStarts the J2EE resource adapter specified by displayName that has been imported into the logical server specified by the -t option.#Y--
resJavaBeans displayNameStarts the JavaBeans resource specified by displayName that has been imported into the logical server specified by the -t option.#Y--
Legend:
Y: Can be specified.
--: Cannot be specified.
#
displayName indicates the display name of a J2EE application, J2EE resource, or JavaBeans resource.

You can use the start subcommand to execute the following two types of operations:

(6) stop

This subcommand stops the specified logical servers, J2EE application, or J2EE resources.

The following table shows the arguments that can be specified for the stop subcommand.

Table 7-6 Arguments that can be specified for the stop subcommand

ArgumentExplanationTarget specification
Logical serverHost
allServersStops the logical servers defined in the management domain in reverse order from the defined starting order.----
server [graceful[:waitTime]]Stops the logical server specified by the -t option.
When graceful is specified, planned termination is executed.
YY
app displayName [force]Stops the J2EE application specified by displayName that has been started on the logical server specified by the -t option.#
When force is specified, the application is stopped forcibly.
Y--
resAdapter displayNameStops the J2EE resource adapter specified by displayName that has been started on the logical server specified by the -t option.#Y--
resJavaBeans displayNameStops the JavaBeans resource specified by displayName that has been started on the logical server specified by the -t option.#Y--
Legend:
Y: Can be specified.
--: Cannot be specified.
#
displayName indicates the display name of a J2EE application, J2EE resource, or JavaBeans resource.

You can use the stop subcommand to execute the following two types of operations:

(7) reload

This subcommand reloads the configuration file for the component specified in the argument.

The following table lists and describes the argument that can be specified for the reload subcommand.

Table 7-7 Argument that can be specified for the reload subcommand

ArgumentExplanationTarget specification
Logical serverHost
userAdminReloads the configuration file to be used in integrated user management. If the logical server specified by the -t option does not use integrated user management, an error occurs.
If userAdmin is specified in the sub-command reload, or if you specify a logical server other than the logical J2EE server in the -t option, an error occurs.
Y--
Legend:
Y: Can be specified.
--: Cannot be specified.
#
You must take some precautions when you specify env in the reload subcommand. See the following locations for the precautions:
- 10.8.12 Reading the logical SFO server settings in the uCosminexus Application Server Management Portal Operation Guide
- 10.9.25 Reading the logical J2EE server settings in the uCosminexus Application Server Management Portal Operation Guide

(8) hold

This subcommand holds the services of the queue in the arguments.

The following table describes the arguments that can be specified for the subcommand hold:

Table 7-8 Arguments that can be specified for the hold subcommand

ArgumentExplanationTarget specification
Logical serverHost
queue <queueName> { in[:waitTime] | out | force[:waitTime]}Locks the queue with the name specified in <queueName> that belong to the CTM specified by the -t option.Y--
queues { in[:waitTime] | out | force[:waitTime] }Locks the queues belonging to the CTM or host specified by the -t option.YY
allQueues { in[:waitTime] | out | force[:waitTime] }Locks all CTM queues in the management domain.----
Legend:
Y: Can be specified.
--: Cannot be specified.

You can use the hold subcommand to lock queues with the following three types of methods:

(9) release

This subcommand releases the services of the queue specified in the arguments.

The following table describes the arguments that can be specified for the subcommand release:

Table 7-9 Argument that can be specified for the release subcommand

ArgumentExplanationTarget specification
Logical serverHost
queue <queueName>Unlocks the queue with the name specified in <queueName> belonging to the CTM specified by the -t option.Y--
QueuesUnlocks the queues belonging to the CTM or host specified by the -t option.YY
allQueuesUnlocks all CTM queues in the management domain.----
Legend:
Y: Can be specified.
--: Cannot be specified.

You can use the release subcommand to unlock queues with the following three types of methods:

(10) collect

This subcommand collects the files and other items specified in the argument. If a logical server other than a performance tracer or CTM is specified by the -t option, an error occurs.

The following table lists and describes the argument that can be specified for the collect subcommand.

Table 7-10 Argument that can be specified for the collect subcommand

ArgumentExplanationTarget specification
Logical serverHost
allPrfTracesCollects performance analysis traces for all performance tracers in the management domain.----
prfTraceCollects a performance analysis trace for the specified performance tracer or for the performance tracer at the specified host.YY
allCtmStatisticsCollects the statistics of all CTMs in the management domain.----
ctmStatisticsCollects the statistics of the specified CTM, or a CTM in the specified host.YY
snapshot [n]#Collects a snapshot log at the specified host.--Y
Legend:
Y: Can be specified.
--: Cannot be specified.
#
[n] specifies one of the following:
1: Collects a snapshot log that becomes the primary data to be sent.
2: Collects a snapshot log that becomes the secondary data to be sent and a performance analysis trace file.
Omitted: Collects snapshot logs and performance analysis trace files for all targets.

You can use the collect subcommand to execute the following three types of operations:

(11) change

This subcommand changes the value set for the number of concurrently executable threads, as specified by the arguments. A J2EE server must be specified by the -t option.

The following table lists and describes the argument that can be specified for the change subcommand.

Table 7-11 Argument that can be specified for the change subcommand

ArgumentExplanationTarget specification
Logical serverHost
webAppThreadCtrl webApplicationContextRoot,maxThreads,exclusiveThreads,queueSizeManages dynamically the number of threads that can be executed concurrently by the Web applications specified in the J2EE server specified by the -t option.
This argument cannot be omitted.
Y--
Legend:
Y: Can be specified.
--: Cannot be specified.

When webAppThreadCtrl is specified for the argument, the subcommand manages dynamically the number of threads that can be executed concurrently by the Web applications belonging to the J2EE server specified by the -t option.

For the argument webApplicationContextRoot, specify a Web application (J2EE application WAR) context root and the number of concurrently executable threads. You can use the get webApps subcommand to obtain the Web application context root value. If no context root has been set, specify a slash (/).

For the number of concurrently executing threads, specify the maximum number of threads, the number of dedicated threads, and the size of the pending queue for Web applications, in that order, delimited by a comma (,).

If any of the values for the arguments maxThreads (maximum number of threads), exclusiveThreads (number of dedicated threads), and queueSize (size of the pending queue for Web applications) is not to be changed, its specification might be omitted. However, you cannot omit all three items.

Example: To change only the number of dedicated threads: ,20,

Specify the various concurrent thread values within the ranges described below.

#: Maximum number of threads [Figure] Number of dedicated threads
Note that a number of concurrently executable threads that has been set dynamically is valid only during execution of that J2EE application.

(12) check

This subcommand checks whether Management Server and Administration Agent are active.

The following table lists and describes the arguments that can be specified for the check subcommand.

Table 7-12 Arguments that can be specified for the check subcommand

ArgumentExplanationTarget specification
Logical serverHost
MngsvrChecks whether or not Management Server is active.
If a target is specified by the -t option, it is ignored.
----
adminAgentChecks whether or not the Administration Agent is active at the host specified by the -t option.
An error occurs when a value other than host is specified by the -k option, a value other than a host name is specified by the -t option, or the -t option is not specified.
--Y
Legend:
Y: Can be specified.
--: Cannot be specified.

The check subcommand returns one of the following values:

0:
Active.
1:
Command execution error occurred.
2:
Command syntax error occurred.
103:
Not active.

(13) dump

This subcommand outputs the javacore of an active logical server.

The following table lists and describes the argument that can be specified for the dump subcommand.

Table 7-13 Argument that can be specified for the dump subcommand

ArgumentExplanationTarget specification
Logical serverHost
server [addition]#Outputs the javacore (active time information) for the logical server specified by the -t option. Only a J2EE server (including a J2EE cluster member), a J2EE server cluster, an SFO server, CTM, or the naming service can be specified as the logical server.
When addition is specified, a core or memory dump is collected for the logical server specified by the -t option.
Y--
Legend:
Y: Can be specified.
--: Cannot be specified.
#
When server addition is specified, the method of monitoring the activity of the specified logical server switches to process existence checking only.

The commands that are executed to output the javacore and the javacore file output destinations are described for each OS type.

(a) In Windows

The table below shows the commands that are executed to output the javacore and the javacore file output destinations for each logical server type in Windows.

Logical serveraddition specifiedCommand to be executedOutput informationjavacore file output destination directory
J2EE server (including server cluster) or SFO serverSpecifiedcjdumpsv, userdump#1javacore, memory dumpj2ee-server-work-directory\ejb\executing-server-name\
Not specifiedcjdumpsvjavacorej2ee-server-work-directory\ejb\real-server-name\
CTMSpecified or not specified#2hdumpnsjavacore#3cosminexus-installation-directory\TPB\logj\
Naming serviceSpecified or not specified#2hdumpnsjavacorecosminexus-installation-directory\TPB\logj\
#1
The userdump command must be installed.
#2
The addition specification is ignored and the activity monitoring method is not changed.
#3
The javacore that is output when CTM is specified in the logical server, is not the information about the CTM daemon, but is the information about the Naming Service started for the CTM.

(b) In UNIX

The table below shows the commands that are executed to output the javacore and the javacore file output destinations for each logical server type in UNIX.

Logical serveraddition specifiedCommand to be executedOutput informationjavacore file output destination directory
J2EE server (including cluster) or SFO serverSpecifiedjavacore -f -p#1javacore, corej2ee-server-work-directory/ejb/real-server-name/
Not specifiedcjdumpsvjavacorej2ee-server-work-directory/ejb/real-server-name/
CTMSpecified or not specified#2kill -3javacore#3/opt/Cosminexus/TPB/logj/
Naming serviceSpecified or not specified#2kill -3javacore/opt/Cosminexus/TPB/logj/
#1
The gdb package must be installed.
#2
The addition specification is ignored and the activity monitoring method is not changed.
#3
The javacore that is output when CTM is specified in the logical server, is not the information about the CTM daemon, but is the information about the Naming Service started for the CTM.

(14) add

This subcommand adds logical user servers.

The following table lists and describes the arguments that can be specified for the add subcommand.

Table 7-14 Arguments that can be specified for the add subcommand

ArgumentExplanationTarget specification
Logical serverHost
userserver userServiceDefinitionFileAdds logical user servers based on the content of the logical user server definition file specified in userServiceDefinitionFile. To change the logical user server definition file contents, first delete the logical user servers and then add the new set of logical user servers.----
Legend:
--: Cannot be specified.

If multiple logical user servers are specified, they are added in the order they are defined. The addition processing continues even if an error occurs midway. In such case, the return value is 1 (execution error). An error is caused by one of the following reasons:

(15) delete

This subcommand deletes a logical user server.

The following table lists and describes the arguments that can be specified for the delete subcommand.

Table 7-15 Arguments that can be specified for the delete subcommand

ArgumentExplanationTarget specification
Logical serverHost
userserver logicalServerNameDeletes the logical user server whose name is specified in logicalServerName.----
Legend:
--: Cannot be specified.