Update the admin endpoint

Purpose

Updates the admin endpoint. The admin endpoint allows you to administer and monitor Eclipse Amlen.

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


{    
  "AdminEndpoint": {
    "Description": "string",
    "SecurityProfile": "string",
    "Port": integer,
    "Interface": "string",
    "ConfigurationPolicies": "string"            
   }
}

Where:

Description: Optional.; Specifies a descrption for the admin endpoint.; If you do not want a description, omit "Description":"description".
SecurityProfile: Optional.; The security profile that the admin endpoint uses.; Ensure that the security profile already exists.
Port: Optional.; The port number that the admin endpoint listens on.; The value must be in the range 2-65535.; The default value is 9089.
Note: If you change the port number and continue to use the default server name, check the value that is specified for ServerName. If the default server name is still being used, you can see that part of the default server name is the default port number of 9089. In order to simplify administration, consider changing the server name so that it no longer contains the default port number of 9089. Use the Eclipse Amlen REST API GET method to view the server name and an Eclipse Amlen REST API POST method to change it. For information about viewing and setting the server name, see Configuring the server name by using REST Administration APIs.
Interface: Optional.; The IPv4 or IPv6 address that the admin endpoint listens on.; The default value is All.
ConfigurationPolicies: Optional.; The configuration policies that are applied to the admin endpoint.; Ensure that the configuration policies already exist.; Specify the configuration policies in a comma-separated list.; The admin endpoint can have a maximum of 100 configuration policies.

Usage Notes®

Capitalization and double quotation marks must be used as shown.

Related REST Administration APIs

Create or update a configuration policy

Example

Updates the admin endpoint by using cURL:


curl -X POST  \
   -H 'Content-Type: application/json'  \
   -d  '{    
            "AdminEndpoint": {                  
            "SecurityProfile": "AdminDefaultSecProfile", 
            "Port": 9089,                  
            "Interface": "10.10.2.149",  
            "ConfigurationPolicies": "AdminDefaultConfigProfile"
          }
     }
  '  \
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."
       }