Export Eclipse Amlen server configuration

Purpose

Exports Eclipse Amlen server configuration data to a password-protected compressed file. 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/export

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"
}

Where:

FileName: Required.; Specifies the name of the file that is to hold the backup configuration data.
Password: Required.; Specifies a password for the compressed file that contains the backup configuration data.; You must have access to the password when you import the backup configuration data.; The password cannot contain leading or trailing spaces.

Usage Notes®

Capitalization and double quotation marks must be used as shown.

Related REST Administration APIs

Import Eclipse Amlen server configuration

Example

Exports Eclipse Amlen server configuration by using cURL:

  
curl -X POST \
   -H 'Content-Type: application/json'  \
   -d  ' {    
           "FileName": "TestServerConfigBackup",
           "Password": "examplePW"  
         }
 '  \
http://127.0.0.1:9089/ima/v1/service/export

An example response to the POST method:


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