Set the port number of the plug-in server

Purpose

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


{    
  "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.

Usage Notes®

Capitalization and double quotation marks must be used as shown.
You must restart the protocol plug-in server for the update to take effect.

Related REST Administration APIs

Example

Sets a value for the plug-in server port by using cURL:

  
curl -X POST \
   -H 'Content-Type: application/json'  \
   -d  '{ 
           "PluginPort": 9100
        }
 '  \
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."
}