Set the JVM maximum heap size of the plug-in server

Purpose

URI

Use the Eclipse Amlen REST API POST method with the following Eclipse Amlen configuration URI:

http://<admin-endpoint-IP:Port>/ima/v1/configuration/

Object configuration data

Provide PluginMaxHeapSize object configuration data in the payload of the POST method by using the following schema. Content-type is set to application/json:

{    
  "PluginMaxHeapSize": integer
}

PluginMaxHeapSize

Specifies the JVM maximum heap size, in megabytes, of the plug-in server.

Specify a value in the range 64 - 65536.

The default value is 512.

Usage Notes®

• Capitalization and double quotation marks must be used as shown.
• Specify "PluginMaxHeapSize": null to reset the value so that the value of the default JVM maximum heap size is used.
• You must restart the protocol plug-in server for the update to take effect.

Related REST Administration APIs

• Restart the protocol plug-in server process
• Show the JVM maximum heap size of the plug-in server
• Set the host IP address or host name of the remote JVM debugger of the debug plug-in server
• Show the host IP address or host name of the JVM remote debugger of the plug-in server
• Set the port number of the JVM remote debugger of the plug-in server
• Show the port number of the JVM remote debugger of the plug-in server

Example

  
curl -X POST \
   -H 'Content-Type: application/json'  \
   -d  '{ 
           "PluginMaxHeapSize": 1024
        }
 '  \
http://127.0.0.1:9089/ima/v1/configuration/

{        
  "Version": "v1",
  "Code": "CWLNA6011",
  "Message": "The requested configuration change has completed successfully."
}