How to Increase Management Client Heap Size

If recommended by Forcepoint support for certain situations, the Java heap size of the Management Client may need to be increased. In all the below cases, if there is need to increase the heap, we suggest doubling the value. Too high of a value may prevent client from starting.

Note With SMC 6.8 and later, the memory requirements have increased as described in the SMC Memory Management article.
 

SMC Web Access

With Web Access administrators can use Management Client on a web browser. The Management Client processing is done on the SMC server where the Web Access is enabled (Management Server or Web Portal Server). For instructions how to define memory allocation for Web Access clients, see SMC Web Access performance.
 

SMC 6.8.3 and later versions (all platforms)

1. Browse to the <user home>/.stonegate folder.
2. Edit the client_starter.xml file.
3. Change the value of the MAX_MEMORY_IN_MB parameter to the value desired.
   • By default 1GB will be assigned
   • After upgrade to SMC 6.8.3 or higher set same value as previously set as MAX_HEAP_SIZE
   • For all clients on same computer setting can be centralized by updating <client installation directory>/data/client_starter.xml.

 

SMC 6.8.2 and older versions

Linux

1. Edit <client installation directory>/bin/sgClient.sh

2. Change MAX_HEAP_SIZE value. Default values are 800 (MB) for 64-bit, and 400 (MB) for 32-bit Linux.

Windows
When starting locally installed Management Client with sgClient.bat file:

1. Edit <client installation directory>\bin\sgClient.bat
2. Change MAX_HEAP_SIZE value. Default value is 800 (MB) on 64-bit Windows (no support for 32-bit Windows).

When starting locally installed Management Client using Windows Start menu:

1. Edit <client installation directory>\bin\install\sgClient.lax
2. Change lax.nl.java.option.java.heap.size.max value. Default value is 838860800 (bytes) for 64-bit (not available in 32 bit Windows)

Web Start
Note SMC 6.7 is the last major version that will support using Java Web Start to access the Management Client. From SMC 6.6 onwards can be used Web Access. See SMC Web Access performance for configuring memory for Web Access client session.

1. Edit smcclient.jnlp that was downloaded from Management Server
2. Change max-heap-size value. Defaults are 800 (MB) for 64-bit, and 400 MB for 32-bit Java.

Alternatively, you can globally define Web Start management client heap allocation in SGConfiguration.txt file:

1. Connect to SMC server, and open <installation directory>/data/SGConfiguration.txt file for editing.
2. Add CLIENT_MAX_MEMORY=<MB> parameter, e.g. CLIENT_MAX_MEMORY=1200, and save the file.
3. (SMC HA only) Do the same change on secondary Management Server(s).
4. Restart Management Server(s).

If the Web Start client heap allocation is increased to about 1500 MB or higher, the client may fail to start if 32-bit Java is installed on the user's machine. In such case it would show the splash screen with Forcepoint SMC logo, and then nothing would happen.

If 64-bit Java does not exist on a user's machine, to resolve the issue install the 64-bit version and uninstall the 32-bit version. This issue may also happen if both 32-bit and 64-bit Java Runtime Environments are already installed on the same machine and the 32-bit JRE is used by default. Which JRE is used by default would depend on the PATH and JAVA_HOME environment variables and .jnlp file associations. If 32-bit Java is not required for some other purposes, solution in this case would be to uninstall it thus leaving only the 64-bit Java installed.



Keywords: Security Management Center; NGFW SMC; Management Client, Web Start, configuration file; memory; java

Web Start
Note SMC 6.7 is the last major version that will support using Java Web Start to access the Management Client. From SMC 6.6 onwards can be used Web Access. See SMC Web Access performance for configuring memory for Web Access client session.

1. Edit smcclient.jnlp that was downloaded from Management Server
2. Change max-heap-size value. Defaults are 800 (MB) for 64-bit, and 400 MB for 32-bit Java.

Alternatively, you can globally define Web Start management client heap allocation in SGConfiguration.txt file:

1. Connect to SMC server, and open <installation directory>/data/SGConfiguration.txt file for editing.
2. Add CLIENT_MAX_MEMORY=<MB> parameter, e.g. CLIENT_MAX_MEMORY=1200, and save the file.
3. (SMC HA only) Do the same change on secondary Management Server(s).
4. Restart Management Server(s).

If the Web Start client heap allocation is increased to about 1500 MB or higher, the client may fail to start if 32-bit Java is installed on the user's machine. In such case it would show the splash screen with Forcepoint SMC logo, and then nothing would happen.

If 64-bit Java does not exist on a user's machine, to resolve the issue install the 64-bit version and uninstall the 32-bit version. This issue may also happen if both 32-bit and 64-bit Java Runtime Environments are already installed on the same machine and the 32-bit JRE is used by default. Which JRE is used by default would depend on the PATH and JAVA_HOME environment variables and .jnlp file associations. If 32-bit Java is not required for some other purposes, solution in this case would be to uninstall it thus leaving only the 64-bit Java installed.