Start the protocol plug-in server process

Purpose

Starts the protocol plug-in server process.

URI

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

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

Object configuration data

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"
}

Usage Notes®

  • Capitalization and double quotation marks must be used as shown.

Related REST Administration APIs

Example

Start 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/start
An example response to the POST method:

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