Configure the JVM options used to run the Identity Broker 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 Identity Broker installation. No modifications will be made to your environment variables.
Memory and other settings for the tool JVMs including the start-broker tool can be tuned 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 Tune the Identity Broker to be aggressive
in the amount of memory it consumes
SEMI_AGGRESSIVE Tune the Identity Broker to be somewhat
aggressive (about half as much as
AGGRESSIVE) in the amount of memory it
consumes
VERBOSE_GC Enable verbose garbage collection output to
the server.out log file
INCREASE_PERM_SPACE Increase the amount of memory devoted to
the JVM's permanent generation. This may be
necessary when the server hosts web
applications
DISABLE_LARGE_PAGE_SUPPORT Disable large-page support even if it is
supported by the JVM
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.
dsjavaproperties
dsjavaproperties --update
dsjavaproperties --initialize --jvmTuningParameter AGGRESSIVE \ --jvmTuningParameter VERBOSE_GC --maxHeapSize 16g
-V
--version
Description | Display Identity Broker 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 the java.properties file. If the file currently exists it will be renamed with the suffix '.old' |
-u
--update
Description | Update the java.properties file with JVM options for any tool that is missing in the current 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, VERBOSE_GC, INCREASE_PERM_SPACE, DISABLE_LARGE_PAGE_SUPPORT |
Required | No |
Multi-Valued | Yes |
--maxHeapSize {memory}
Description | The maximum amount of memory to be configured for this system. 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 |