Setting the runtime parameters of the plug-in server JVM

System administrators can set the runtime parameters of the plug-in server JVM by using REST Administration APIs.

  1. To set the runtime parameters of the plug-in server JVM, use the Eclipse Amlen REST API POST method.
    1. Use the following Eclipse Amlen configuration URI:

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

    2. Provide PluginVMArgs object configuration data in the payload of the POST method by using the following schema. Content-type is set to application/json. Ensure that capitalization and double quotation marks are used as shown.
      
      {    
        "PluginVMArgs": "string"
      }
      Where:
      PluginVMArgs
      Specifies the runtime parameters of the plug-in server JVM.
  2. Restart the protocol plug-in server. The update does not take effect until you restart the protocol plug-in server process.
    http://<admin-endpoint-IP:Port>/ima/v1/service/restart

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

    
    {    
      "Service": "Plugin"
    }
The following example shows a POST method to set the runtime parameters JVM of the plug-in server by using cURL:
  
curl -X POST \
   -H 'Content-Type: application/json'  \
   -d  '{ 
           "PluginVMArgs": "-Xms2G -Xmx4G"
        }
 '  \
http://127.0.0.1:9089/ima/v1/configuration/
The following shows an example response to the POST method.

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

The following example shows restarting the protocol plug-in server:

  
curl -X POST \
   -H 'Content-Type: application/json'  \
   -d  '{ 
           "Service": "Plugin"
        }
 '  \
http://127.0.0.1:9089/ima/v1/service/restart

The following example shows an example response to the POST method to restart the protocol plug-in server:


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