Set licensed usage and accept the license

Purpose

Sets the licensed usage of Eclipse Amlen and accepts the license.

URI

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

curl -X POST http://<admin-endpoint-IP:Port>:<port>/ima/v1/configuration

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.


{       
 "LicensedUsage": "LicenseType",  
 "Accept": true|false                
}

where

LicenseType

Specifies the type of licensed usage for Eclipse Amlen .

This value can be set to one of the following values:

Developers: For use in a development and test environment.
Non-Production: For use in a development and test environment.
Production: For use in a production environment.
IdleStandby: For use in a high availability environment.

Accept

Specifies the acceptance of the licensed usage.

To accept the license, set Accept to true.

Once the license is accepted, it cannot be unaccepted by setting the value to false.

Usage Notes®

When server is started for the first time, the LicensedUsage is set to Developers. The server will start in maintenance mode.

You can view the server status by using the following REST API GET method:

curl -X GET http://127.0.0.1:9089/ima/v1/service/status/Server

The server status shows:

 
"Server": {
    "Name": "RDDockDev1:9089",
    "UID": "poHdWvCE",
    "Status": "Running",
    "State": 9,
    "StateDescription": "Running (maintenance)",
    "ServerTime": "2016-04-12T19:01:23.512Z",
    "UpTimeSeconds": 27,
    "UpTimeDescription": "0 days 0 hours 0 minutes 27 seconds",
    "Version": "2.0 20160412-1415",
    "ErrorCode": 387,
    "ErrorMessage": "Eclipse Amlen is not fully functional until you accept the license agreement using Eclipse Amlen REST API."
  }

For more information about viewing server status, see Show the status of an Eclipse Amlen server and services

After you accept the license that you require by using the REST API POST method, the server automatically restarts. On restart the server runs using the specified license type. This type can be Developers, Non-Production, Production or IdleStandby.
The Eclipse Amlen server remains in maintenance mode until the license is accepted.
The command must be capitalized as shown.
The licensed usage of Eclipse Amlen is Developers, Non-Production, Production, or IdleStandby.

Related Commands

Show LicensedUsage

Example

Set the licensed usage of Eclipse Amlen to Production and accept the license:


curl -X POST \
   -H  'Content-Type: application/json'  \
   -d  '{
          "Version": "v1",
           "LicensedUsage": "Production",
           "Accept": true
        }
  '   \
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."
}

Check the server status to verify that the Eclipse Amlen server has successfully restarted. It might take a few seconds for the server to stop and restart. You can view the server status by using the following REST API GET method:

curl -X GET http://127.0.0.1:9089/ima/v1/service/status/Server

The server status shows:


{
  "Version":"v1",
  "Server": {
    "Name": "RDDockDev1:9089",
    "UID": "poHdWvCE",
    "Status": "Running",
    "State": 1,
    "StateDescription": "Running (production)",
    "ServerTime": "2016-04-27T15:59:51.491-05:00",
    "UpTimeSeconds": 27,
    "UpTimeDescription": "0 days 0 hours 0 minutes 27 seconds",
    "Version": "2.0 20160610-0700",
    "ErrorCode": 0,
    "ErrorMessage": ""
  }
}

Show the new licensed usage:

curl -X GET http://127.0.0.1:9089/ima/v1/configuration/LicensedUsage

An example response to the GET method:


{
  "Version": "v1",
  "LicensedUsage": "Production"
  "Accept": true
}