Set the port number of the JVM remote debugger of the plug-in server

Purpose

Sets the port number of the JVM remote debugger of the plug-in server.

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 PluginDebugPort object configuration data in the payload of the POST method by using the following schema. Content-type is set to application/json:


{    
  "PluginDebugPort": integer
}

Where:

PluginDebugPort: Specifies the port number of the JVM remote debugger of the plug-in server. The value must be the same as the port number that Eclipse is using for remote debugging.; Specify a value in the range 0 - 65535.; The default value is 0 which means that no port number is specified.

Usage Notes®

Capitalization and double quotation marks must be used as shown.
Specify a valid IP address if the debug plug-in server is running in Eclipse.
Specify a valid port number if the debug plug-in server is running on your Eclipse Amlen server.
If the debug plug-in server is running on Eclipse, ensure that a value is not set for PluginDebugPort by specifying a null value or a value of 0.
You must restart the protocol plug-in server for the update to take effect.

Related REST Administration APIs

Example

Sets a value for the port number of the JVM remote debugger of the plug-in server by using cURL:

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

An example response to the POST method:


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