Setting the port number of the plug-in server

System administrators can set the port number of the plug-in server by using the Eclipse Amlen REST API POST method.

  1. To set the port number of the plug-in server, use the Eclipse Amlen REST API POST method.
    1. Use the following Eclipse Amlen configuration URI:

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

    2. Provide PluginPort 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.
      
      {    
        "PluginPort": integer
      }
      Where:
      PluginPort
      Specifies the port number of the plug-in server.
      Specify a value in the range 1 - 65535.
      The default value is 9103.
  2. Restart the protocol plug-in server for the update to take effect. Use the Eclipse Amlen REST API POST method with the following URI:
    http://<admin-endpoint-IP:Port>/ima/v1/service/restart

    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"
    }
The following example shows a POST method to set the port number of the plug-in server by using cURL:
  
curl -X POST \
   -H 'Content-Type: application/json'  \
   -d  '{ 
           "PluginPort": 9100
        }
 '  \
http://127.0.0.1:9089/ima/v1/configuration/
The following shows an example response to the POST method.

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

The following example shows restarting the protocol plug-in server:

  
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 an example response to the POST method to restart the protocol plug-in server:


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