Update a protocol plug-in properties file

Purpose

Updates a protocol plug-in properties file.

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


{    
  "Plugin": {
    "<NameOfPlugin>": {
      "PropertiesFile": "string",
      "Overwrite": true|false
      }
   }
}

Where:

NameOfPlugin: Required.; Specifies the name of the protocol plug-in that is associated with the properties file. This can be found in the plugin.json configuration file if it exists.; The maximum length of the name is 256 characters.
PropertiesFile: Required.; Specifies the protocol plug-in properties file name that you want to update. You can develop a properties file in JSON format and the properties that it contains override any properties in the plug-in configuration file.; The maximum length of the protocol plug-in properties file name is 255 characters.
Overwrite: true|false: Required if the protocol plug-in is already installed.; Specifies whether any existing protocol properties file with the same name is overwritten.; The default value is false.

Usage Notes®

Capitalization and double quotation marks must be used as shown.
The plug-in can be updated at any time.
You must specify "Overwrite":true to update an existing plug-in.
The update is not effective until the plug-in server is restarted.

Related REST Administration APIs

Example

Updates the plug-in properties file called pluginprops.json:

  
curl -X POST \
   -H 'Content-Type: application/json'  \
   -d  '{ 
           "Plugin": {
            "json_msg": {
             "PropertiesFile": "pluginprops.json",
             "Overwrite": true
            }
         }
       }
 '  \
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."
}