GET /notificationsLicense

Use this GET method to retrieve information about warnings regarding non-compliance of installed licenses.

Note: This API requires Lenovo XClarity Administrator v2.7.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/notificationsLicense

Query parameters

None

Request body

None

Response codes

Code Description
200 OK
400 Bad request
403 Forbidden
404 Not found
409 Conflict
413 Request Entity Too Large
500 Internal server error

Response body

Parameters Type Description
response Array of objects Information about non-compliance for each license
  compliant Integer Indicates whether XClarity Administrator is compliant with installed licenses. This can be one of the following values.
  • 0. XClarity Administrator is not compliant with installed licenses. The number of devices exceeds the permissible limit.
  • 1. XClarity Administrator is compliant with installed licenses. The number of devices does not exceed the license limit.
  • 2. XClarity Administrator is compliant with installed licenses. The number of devices exceeds the license limit but does not exceed the permissible limit.
  enable_functions Integer Indicates whether licensed functions are enabled. This can be one of the following values.
  • 0. Licensed functions are disabled.
  • 1. Licensed functions are enabled.
  notifications Array of objects Information about license notifications
    contact String Contact details
    description String Message description
    type String Type of the message. This can be one of the following values.
  • error

  • warning

  remaining_days Integer Number of days remaining before licensed function is disabled
result String Results of the request. This can be one of the following values.
  • success. The request completed successfully.
  • failed. The request failed. A descriptive error message was returned.
  • warning. The request completed with a warning. A descriptive error message was returned.
messages Array of objects Information about one or more messages
  id String Message identifier of a returned message
  text String Message text associated with the message identifier
  explanation String Additional information to clarify the reason for the message
  recovery Array of objects Recovery information
    text String User actions that can be taken to recover from the event
    URL String Link to the help system for more information, if available

Response example

{
   "response": [{
      "compliant": "0",
      "enable_functions": "1",
      "notifications": [{
         "contact": "Please contact your sales representative to acquire additional license. 
                    If you think that the non-compliance assessment is incorrect, you may 
                    contact licensing support.",
         "description": "You have installed valid keys for 20 but are currently managing 100 
                         devices required entitlement. You have 86 days remaining to resolve 
                         this before functions will be disabled.",
         "type": "warning"
      }],
      "remaining_days": "86"
   }],
   "result": "success",
   "messages": [{
      "id": "FQXHMSE0001I",
      "text": "The request completed successfully.",
      "recovery": {
         "text": "Information only. No action is required.",
         "URL": ""
      },
      "explanation": ""
   }]
}