Configure the JVM options used to run the Directory Server and associated tools.
The options managed by this tool are stored in config/java.properties. Typically you should not edit that file directly but rather run this tool specifying --jvmTuningParameter arguments to customize JVM options appropriate for this system. It is necessary however that this tool be run in the event that config/java.properties must be edited by hand. Note that the changes will only apply to this Directory Server installation. No modifications will be made to your environment variables.
Memory and other settings for the tool JVMs including the start-server tool can be tuned during initialization by specifying one or more instances of the --jvmTuningParameter option when invoking this tool. Supported values are as follows:
-----------------------------------------------------------------------------------------------------------------------------------------
NONE Explicitly specify no parameters
AGGRESSIVE This system is dedicated to running only this server. The amount of memory allocated to this server will be computed
accordingly
SEMI_AGGRESSIVE This system is shared by multiple server processes. The amount of memory allocated to this server will be computed
accordingly
If no parameters are specified the parameters specified by the previous invocation of this tool or setup will be used. Use the NONE option to explicitly specify no parameters.
Configure the server and tools to use the options specified in config/java.properties:
dsjavaproperties
Reconfigure the existing server and tool JVM options from their initial setup values, changing the total amount of system memory allocated for the server and tools. The old config/java.properties file is saved as config/java.properties.old and the server and tools are configured to use the newly generated config/java.properties:
dsjavaproperties --initialize --jvmTuningParameter AGGRESSIVE --maxHeapSize 16g
-V
--version
| Description | Display Directory Server version information |
-H
--help
| Description | Display general usage information |
--help-debug
| Description | Display help for using debug options |
| Advanced | Yes |
-Q
--quiet
| Description | Run the tool in quiet mode. Quiet mode will not output progress information to standard output |
-i
--initialize
| Description | Generate the java.properties file. If the file currently exists it will be renamed with the suffix '.old' and its tool-independent properties will carry over into the new java.properties file |
--jvmTuningParameter {parameter}
| Description | JVM tuning parameters to use when updating or generating the java.properties file. Must be one of NONE, AGGRESSIVE, SEMI_AGGRESSIVE |
| Required | No |
| Multi-Valued | Yes |
--maxHeapSize {memory}
| Description | Explicitly specify the maximum amount of memory to be configured for this system. If omitted the value will be computed based on the presence of either the AGGRESSIVE or SEMI_AGGRESSIVE parameter specified by the --jvmTuningParameter option. Providing a value that is below a tool's minimum heap size requirement will have no effect, i.e. the tool's minimum required heap size will be used instead. The format for this value is the same as the -Xmx JVM option which is a number followed by a unit m or g |
| Required | No |
| Multi-Valued | No |
--gcType {gc-type}
| Description | The type of garbage collection to use. Acceptable values are the different garbage collection types that are supported by the server, which are currently g1, cms, zgc, and generational-zgc. These can also be found in the java.properties file under 'gc-type' and 'gc-args'. For a change of garbage collection type to take effect, this argument must be used in conjunction with the --initialize argument and the server must be restarted. Note that depending on the platform and Java version, some garbage collection types may not be supported or recommended, so the decision to use a different garbage collection type in production should be made in conjunction with support/engineering |
| Required | No |
| Multi-Valued | No |