Set the host IP address or host name of the remote JVM debugger of the debug plug-in server
Purpose
Sets the host IP address or host name of the remote JVM debugger of the debug 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 PluginDebugServer object configuration data in the payload of the POST method by using the following schema. Content-type is set to application/json:
{
"PluginDebugServer": "string"
}
Where:- PluginDebugServer
- Specifies the IPv4 or IPv6 address or host name to use to access the debug plug-in server.
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.
- You must restart the protocol plug-in server for the update to take effect.
- If you are debugging remotely, ensure that a value is not set for PluginDebugServer by specifying a null value and restart the Eclipse Amlen server.
Related REST Administration APIs
- Restart the protocol plug-in server process
- 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
- Set the JVM maximum heap size of the plug-in server
- Show the JVM maximum heap size of the plug-in server
Example
Sets a value for the debug plug-in server host IP address by using cURL:
curl -X POST \
-H 'Content-Type: application/json' \
-d '{
"PluginDebugServer": "10.10.2.149"
}
' \
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."
}