GET /events?translations=<JSON_filter>

Use this GET method to retrieve translated events based on the criteria that is specified using encoded JSON format.

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

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/events?translations=<JSON_filter>

Query parameters

Parameters Required / Optional Description
translations=<JSON_filter> Required Returns translated events based on the criteria that is specified using encoded JSON format.
The following example returns translated events using specific criteria.
GET https://192.0.2.0/events?translations=%7B%22filters%22%3A%7B%22
excludedevents%22%3Afalse%2C%22eventclass%22%3A%5B%22SYSTEM%22%5D%2C%22
severity%22%3A%5B%22CRITICAL%22%2C%22WARNING%22%2C%22INFORMATIONAL%22%5D%2C%22
evsource%22%3A%22%2%2C%22uuids%22%3A%5B%5D%2C%22evdate%22%3A%7B%22
start%22%3A%222017-05-29T13%3A06%3A41.508Z%22%2C%22end%22%3A%22%22%7D%2C%22
customfilter%22%3A%7B%22searchfor%22%3A%22%22%2C%22applyon%22%3A%5B%5D%7D%7D%2C%22
pagination%22%3A%7B%22offset%22%3A0%2C%22limit%22%3A10%7D%2C%22sort%22%3A%7B%22
applyon%22%3A%22timeStamp%22%2C%22mode%22%3A%22DESC%22%7D%7D

Where {JSON_filter} contains the following attributes:

Attributes Required / Optional Type Description
filters Optional Object Filter information
  customfilter Optional Object Custom filter
    applyon Optional Array of strings Columns on which the text is checked against
    searchfor Optional String Search text
  eventclass Optional Array of strings List of event classes. This can be one or more of the following values.
  • SYSTEM

  • AUDIT

  evdate Optional Object Date interval
    end Optional String End date
    start Optional String Start date
  evsource Optional String Event source. This can be one of the following values.
  • MANAGEMENT

  • HARDWARE

  • IBM_SERVICEABLE

  • CUSTOMER_SERVICEABLE

  excludedevents Optional Boolean Indicates whether the server fetches only excluded events only. This can be one of the following values.
  • true. The server retrieves only excluded events

  • false. The server retrieves all events.

  groupName Optional Strings Resource-group name to which the source of the event belongs
  groupUUID Optional Strings Resource-group UUID to which the source of the event belongs
  severity Required Array of strings List of event severities. This can be one or more of the following values.
  • INFORMATIONAL

  • WARNING

  • CRITICAL

  uuids Optional Array of strings Event source and component UUIDs
pagination Optional Object Pagination information
  limit Optional Integer Number of events to be returned per page
  offset Optional Integer Start of the next page
sort Optional Object Sort information
  applyon Optional String Name of the column on which the filter is to be applied
  mode Optional String Sort mode. This can be one of the following values.
  • ASC. Ascending

  • DESC. Decending

sourceLink Optional String Link to the source of the event. This attribute is returned only when the translations query parameter is specified.
For example,
{
   "filters": {
      "customfilter" : {
         "applyon"    : [],
         "searchfor" : ""
      },
      "groupName" : "e-Commerce Servers",
      "evdate" : {
         "end"  :"",
         "start" :"2017-05-29T13:06:41.508Z"
      },
      "eventclass" : ["SYSTEM"],
      "evsource" : "",
      "excludedevents" : false,
      "severity" : ["CRITICAL","WARNING","INFORMATIONAL"],
      "uuids" : []
   },
   "pagination" : {
      "limit" : 10,
      "offset" : 0
   },
   "sort" : {
      "applyon"   : "timeStamp",
      "mode" : "DESC"
   }
}

Request body

None

Response codes

Code Description
200 OK
400 Bad request
403 Forbidden
404 Not found
409 Conflict
500 Internal server error

Response body

Attributes Type Description
action Integer Action category. This can be one of the following values.
  • 100. NONE
  • 200. TOPOLOGY
  • 300. IP
  • 400. INVENTORY

If not available, an empty string is returned.

args Array of string List of dynamic arguments in the event message string. If not available, an empty string is returned.

If not available, an empty string is returned.

bayText String  
chassisText String  
cn String Event Sequence number. It is the order in which the events were processed.
commonEventID String Common event ID.
componentID Array of string Unique ID of the component on which the event occurred.

If not available, an empty string is returned.

componentIdentifierText String The component description. This can be one of the following values.
  • Canister/Appliance

  • Client Data Storage Device

  • Cooling

  • Device Driver

  • Display

  • Hypervisor

  • I/O connectivity

  • Interconnect (Fabric)

  • Interconnect (Interfaces)

  • Interconnect (Networking)

  • Interconnect (PCI Manager)

  • Interconnect (PIE)

  • Interconnect (Utilities / Infrastructure)

  • Memory

  • OS

  • OS/Hypervisor Interface

  • Power

  • Processing

  • Storage RAID

  • System board

  • Systems Management

  • Time Reference

  • Unknown

  • Vendor Events

  • VPD

decriptionArgs Array of strings List of dynamic arguments in the event message description.

If not available, an empty string is returned.

eventClass Integer The source of the event. This can be one of the following values.
  • 50. Unknown
  • 200. Audit
  • 300. Cooling
  • 400. Power
  • 500. Disks (storage)
  • 600. Memory
  • 700. Processor
  • 800. Rack or tower server
  • 900. Test
  • 1000. Adapter card
  • 1100. Expansion board
  • 1200. Flex System switch
  • 1300. Flex System server
  • 1400. switch

If not available, an empty string is returned.

eventDate String Time and date that the event was created on source system. This is the time and date from the managed system and might be quite different from timeStamp, which is when the event was processed by the Lenovo XClarity Administrator. The string is in ISO-8601 format:
yyyy-MM-dd'T'HH:mm:ss'Z'
eventID String Event ID is a unique identifier for each event supported by a product.
eventSourceText String  
failFRUNames Array of strings For hardware fault events, includes names of one or more FRUs that are associated with the fault.

If not available, an empty string is returned.

failFRUPartNumbers Array of strings For hardware fault events, includes part numbers for one or more FRUs that are associated with the fault.

If not available, an empty string is returned.

failFRUs Array of strings For hardware fault events, includes FRU numbers for one or more FRUs that are associated with the fault.

If not available, an empty string is returned.

failFRUUUIDs Array of strings For hardware fault events, includes UUIDs for one or more FRUs that are associated with the fault.

If not available, an empty string is returned.

failSNs Array of strings For hardware fault events, includes serial numbers for one or more FRUs that are associated with the fault.

If not available, an empty string is returned.

flags Array of strings Proprietary event flag definitions. This can be one of the following values.
  • Hidden. The event not to be displayed in normal log views. It is displayed only for diagnostic views.
  • Historical. The event occurred while the management server was down and can be ignored by EventActions.
  • Ignored. The event is ignored.
  • Recovered. The event was involved in the reliable event recovery process.
  • Unsequenced. Switch system traps are not sequenced. Reliable event recovery is skipped.
  • VM. VM Migration (Blade "Trust the Source Logging Model")

If not available, an empty string is returned.

fruSerialNumberText String  
groupName Array of strings List of resource-groups, by name, to which the source of the event belongs. If the source does not belong to a resource group, the value is "Not Available."
groupUUID Array of strings List of resource-groups, by UUID, to which the source of the event belongs.
localLogID String Log type. This can be one of the following values.
  • AUDIT. Audit events
  • EVENT. All other events.
localLogSequence Integer Log Sequence Number, which uniquely identifies this event on the audit or event log

If not available, an empty string is returned.

location String Location information for event association in the format of "Slot#01."
msg String Event message string.
msgID String Event message ID.
mtm String System machine type and model of the managed system on which the event occurred.
originatorUUID String The unique ID of the managed system on which the event occurred.
Attributes Object Reserved.

If not available, an empty string is returned.

senderUUID String  
serialnum String Serial number of system generating the event (event source). Not set for internal events.
service Integer Identifer that specifies how service is performed. It can be one of the following.
  • 100. Not Serviceable.
  • 200. Serviceable by Lenovo (called home)
  • 300. Serviceable by the customer

If not available, an empty string is returned.

serviceabilityText String  
severity Integer Severity. This can be one of the following values.
  • 100. Unknown. The severity is unknown.
  • 200. Informational. Informational
  • 300. Warning. User can decide if action is needed.
  • 400. Minor. Action is needed, but the situation is not serious at this time.
  • 500. Major. Action is needed now.
  • 600. Critical. Action is needed now and the scope is broad (perhaps an imminent outage to a critical resource will result).
  • 700. Fatal. A non-recoverable error has occurred.

If not available, an empty string is returned.

severityText String Severity text. This can be one of the following values.
  • Unknown. The severity is unknown.
  • Informational. Informational
  • Warning. User can decide if action is needed.
  • Minor. Action is needed, but the situation is not serious at this time.
  • Major. Action is needed now.
  • Critical. Action is needed now and the scope is broad (perhaps an imminent outage to a critical resource will result).
  • Fatal. A non-recoverable error has occurred.

If not available, an empty string is returned.

sourceID String System UUID for the system or device that is/was the event source (raiser/owner)
sourceLogID String Identifier of log of event source system. System may have multiple logs for events and this identifier is used with the System Log Sequence Number for reliable event support.
sourceLogSequence Integer Source Log Sequence Number, uniquely identifies this event in source Log ID
systemFruNumberText String  
systemName String System identifier. It correlates to the display name used for the device on the CMM.
systemSerialNumberText String  
systemText String  
systemTypeModelText String  
systemTypeText String  
timeStamp String Time and date of when the log entry was created for the Lenovo XClarity Administrator log. The string is in ISO-8601 format (for example, yyyy-MM-dd'T'HH:mm:ss'Z').
typeText String  
userActionArgs Array of strings List of dynamic arguments in the event message action

If not available, an empty string is returned.

userid String For internal audit events, this is the associated user ID. This is not available for external events.
userIDIndex Integer  

Response example

[{
   "action": 100,
   "args": ["nist800-131a", "Demo - 00404X5462", "nistcomp"],
   "chassisText": "Not Available",
   "bayText": "Not Available",
   "commonEventID": "FQXHMSE0006G",
   "componentID": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
   "cn": "6",
   "componentIdentifierText": "Systems Management",
   "decriptionArgs": "",
   "eventClass": 800,
   "eventDate": "2017-07-24T19:32:35Z",
   "eventID": "FQXHMSE0006G",
   "eventSourceText": "Management",
   "failFRUNames": [],
   "failFRUPartNumbers": [],
   "failFRUs": [],
   "failFRUUUIDs": [],
   "failSNs": [],
   "flags": "",
   "fruSerialNumberText": "Not Available",
   "groupName": ["e-Commerce Servers","Lenovo Solutions"],
   "groupUUID": ["599D9BF18DBB37078155E985","59AFBFCF8DBB376A25D68A0A"],
   "localLogID": "",
   "localLogSequence": "",
   "location": "",
   "msg": "Cryptographic mode nist800-131a on Demo - 00404X5462 does not match cryptographic mode 
                nistcomp on the management server.",
   "msgID": "",
   "mtm": "",
   "originatorUUID": "",
   "parameters": {},
   "senderUUID": "",
   "serialnum": "",
   "service": 100,
   "serviceabilityText": "Not Required",
   "severity": 300,
   "severityText": "Warning",
   "sourceID": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
   "sourceLogID": "",
   "sourceLogSequence": 0,
   "systemFruNumberText": "Not Available",
   "systemName": "Management Server",
   "systemSerialNumberText": "Not Available",
   "systemText": "Management Server",
   "systemTypeModelText": "Not Available",
   "systemTypeText": "Management",
   "timeStamp": "2017-07-24T19:32:35Z",
   "typeText": "System",
   "userActionArgs": "",
   "userid": "",
   "userIDIndex": 0
}]