Starting and stopping the protocol plug-in server process

System administrators can start, restart, and stop the protocol plug-in server process by using the Eclipse Amlen REST API POST method.

You can start, restart, and stop the protocol plug-in server process by using the Eclipse Amlen REST API POST method. The protocol plug-in server process is a Java™ process that loads all installed protocol plug-ins. The protocol plug-in server ensures that messages are processed by the appropriate protocol plug-in. After you create, update, or delete protocol plug-ins, you must restart the protocol plug-in server.
  • To start the protocol plug-in server process, use the Eclipse Amlen REST API POST method with the following Eclipse Amlen configuration URI:

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

  • To stop and then restart the protocol plug-in server process, use the Eclipse Amlen REST API POST method with the following Eclipse Amlen configuration URI:

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

  • To stop the protocol plug-in server process, use the Eclipse Amlen REST API POST method with the following Eclipse Amlen configuration URI:

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

  • Provide plug-in 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.
    
    {    
      "Service": "Plugin"
    }
The following example shows a POST method to restart the protocol plug-in server process:
  
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 a POST method to stop the protocol plug-in server process:
  
curl -X POST \
   -H 'Content-Type: application/json'  \
   -d  '{ 
           "Service": "Plugin"
        }
 '  \
http://127.0.0.1:9089/ima/v1/service/stop
The following shows an example response to the POST methods for starting or stopping the protocol plug-in server process:

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