Import Eclipse Amlen server configuration

Purpose

Import Eclipse Amlen server configuration data from a password-protected compressed file that was created by using the export REST API in Eclipse Amlen version 5.

Configuration data includes certificates, message hubs, endpoints, policies, queues, topic monitors, high availability, cluster membership, queue manager connections, and destination mapping rules. The data can be used to copy data from one server to another. Configuration data does not include subscriptions or message data, such as messages that are on queues, or messages that are buffered for subscription.

URI

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

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

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: 


{    
  "FileName": "string",
  "Password": "string",
  "DisableObjects": true|false,
  "ApplyConfig": true|false
}
Where:
FileName
Required.
Specifies the name of the file that contains the backup configuration data.
Password
Required.
Specifies a password for the compressed file that contains the backup configuration data.
The password cannot contain leading or trailing spaces.
DisableObjects: true|false
Optional.
Specifies whether the imported objects that have a configuration item associated with an IP address such as Endpoint, HighAvailability, ClusterMembership are disabled after importing into the server.
The default is true.
ApplyConfig: true|false
Optional.
Specifies whether the imported configuration is to be applied to the server. By default, the imported configuration is returned as a response to the REST call for users to verify an imported configuration.
The default is false.

Usage Notes®

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

Related REST Administration APIs

Example

Imports Eclipse Amlen server configuration by using cURL:
  
curl -X POST \
   -H 'Content-Type: application/json'  \
   -d  ' {    
           "FileName": "TestServerConfigBackup",
           "Password": "examplePW",  
           "DisableObjects": true,
           "ApplyConfig": true 
         }
 '  \
http://127.0.0.1:9089/ima/v1/service/import
An example response to the POST method:

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