5.2.2 usrconf.bat (Option definition file for server management commands for Windows)

Organization of this subsection

(1) Format
(2) File storage location
(3) Functionality
(4) Specifiable keys
(5) Default values of the JavaVM invocation options that execute the server management commands (In usrconf.bat)
(6) Examples of coding
(7) Precautions

(1) Format

This option definition file is in the batch file format of Win32.

Specify the key as follows:

set key-name=value

To Page Top

(2) File storage location

Cosminexus-installation-directory\CC\admin\usrconf\

To Page Top

(3) Functionality

This file specifies the invocation options of the JavaVM that executes the server management commands. Note that this file is for Windows.

To Page Top

(4) Specifiable keys

The following table describes the specifiable keys and the default values:

Key name	Contents	Default
USRCONF_JVM_ARGS	This key invokes JavaVM by using the specified option. You can specify the following JavaVM options: `-Xmssize` `-Xmxsize` `-Xsssize` -Xdebug `-XrunlibraryName` -Dejbserver.log.directory -XX:MetaspaceSize -XX:MaxMetaspaceSize	For details about default values, see 5.2.2(5) Default values of the JavaVM invocation options that execute the server management commands (In usrconf.bat).
USRCONF_JVM_CLASSPATH	This key adds the set value to the class path. If you want to specify multiple values, demarcate the values with a semicolon (;).	None
USRCONF_JVM_LIBPATH	This key adds the set value to the environment variable of library search path. If you want to specify multiple values, demarcate the values with a semicolon (;).	None

Key name

Contents

Default

USRCONF_JVM_ARGS

This key invokes JavaVM by using the specified option. You can specify the following JavaVM options:

-Xmssize
-Xmxsize
-Xsssize
-Xdebug
-XrunlibraryName
-Dejbserver.log.directory
-XX:MetaspaceSize
-XX:MaxMetaspaceSize

For details about default values, see 5.2.2(5) Default values of the JavaVM invocation options that execute the server management commands (In usrconf.bat).

USRCONF_JVM_CLASSPATH

This key adds the set value to the class path. If you want to specify multiple values, demarcate the values with a semicolon (;).

None

USRCONF_JVM_LIBPATH

This key adds the set value to the environment variable of library search path. If you want to specify multiple values, demarcate the values with a semicolon (;).

None

To Page Top

(5) Default values of the JavaVM invocation options that execute the server management commands (In usrconf.bat)

The following table describes JavaVM options that you can specify in USRCONF_JVM_ARGS:

Key name	Contents	Specifiable value	Default	VR
-Xms	This key sets the initial size for the Java heap.	The input is not limited.	None	06-00
-Xmx	This key sets the maximum size for the Java heap. If a command cannot be executed normally because memory becomes insufficient during command execution, specify this option to increase the maximum size of the memory allocation pool. If a server management command is started when the operation-target file is large, the `java.lang.OutOfMemoryError` message might be displayed on the console from which the command was started. If this message is displayed, specify this option and the `-Xms` option to adequately tune the Java VM memory allocation size. Example: `set USRCONF_JVM_ARGS="-Xms64m -Xmx256m"`	The input is not limited.	512m	06-00
-Xss	This key sets the maximum size for one stack area.	The input is not limited.	None	06-00
-Xdebug	This key invokes JavaVM with the debugger in enable status.	The input is not limited.	None	06-00
-Xrun	This key loads the library.	The input is not limited.	None	06-00
-Dejbserver.log.directory	This key specifies the path of the directory where the log file is output. Use a forward slash (/) as the delimiter in the directory path.	The input is not limited.	None	06-00
-XX:MetaspaceSize	This key sets the minimum threshold value for Full GC in the metaspace area. This value is used in the calculation of changing the threshold value.	The input is not limited.	None	09-70
-XX:MaxMetaspaceSize	This key specifies the maximum size for the `Metaspace` area.	The input is not limited.	None	09-70

To Page Top

(6) Examples of coding

set USRCONF_JVM_ARGS=-Xms64m -Xmx512m
set USRCONF_JVM_CLASSPATH=C:\home\lib\mylib.jar
set USRCONF_JVM_LIBPATH=C:\home\bin

To Page Top

(7) Precautions

The CLASSPATH environment variable set at the command prompt is disabled in the server management commands, but the other environment variables (such as PATH) are enabled.
Do not use the following characters in the specified value:

Double quotation mark ("), ampersand (&), vertical bar (|), less-than sign (<) and greater-than sign (>)
When you use Eclipse Plug-ins using Management Server for performing operations, the specification of this file is invalid. When you use Eclipse Plug-ins using Management Server for performing operations, specify the values in the option definition file for the Administration Agent (adminagentuser.cfg).

To Page Top