GET /events/activeAlerts

Use this GET method to retrieve information about active alerts or the number of active alerts per resource group. If no query parameters are specified, information about all active alerts is returned.

Authentication

Authentication with user name and password is required.

Request URL

GET https://<management_server_IP>/events/activeAlerts

Query parameters

Parameters Required / Optional Description
escapeHTML=<Boolean> Optional Indicates whether to replace escape characters in the message with special characters (for example, &quot;). This can be one of the following values.
  • true. Replaces escape characters with special characters in the returned message.

  • false. Does not replaces escape characters in the returned message.

Note: Escape characters must be included in arguments when there is HTML in messages.
filterWith=<filter> Optional Returns only the active alerts that apply to the specified filters (see Filtering events).
groupUIDs=<UUID> Optional If outputFormat=summary is specified, returns the number of active alerts for one or more resource groups, specified by UUID. Separate multiple UUIDs by a comma.
outputFormat=<type> Optional Returns information for the specified type. This can be one of the following values.
  • default. Information about all active alerts

  • summary. Number of active alerts (critical and warning) per resource group

type=excluded Optional Returns only exclude active alerts.
uids=<UUID_list> Optional If outputFormat=default is specified, returns alert information only for one or more specific groups and devices.

To obtain the group or device UUIDs, use GET /resourceGroups, GET /chassis, GET /cmms, GET /nodes, GET /storage, and GET /switches.

The following example returns a list of all excluded active alerts and replaces escape characters in the message with special characters.
GET https://192.0.2.0/events/activeAlerts?type=excluded&escapeHTML=true
The following example returns a list of all excluded active alerts for a two specific devices.
GET https://192.0.2.0/events/activeAlerts?
uids=["AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA","BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB"]
The following example returns the number of active alerts for two specific resource groups.
GET https://192.0.2.0/events/activeAlerts?outputFormat=summary&
groupUIDs=["11111","22222"]

Request body

None

Response codes

Code Description
200 OK.
400 Bad request. The request was syntactically incorrect.
401 Unauthorized. The user could not be authenticated.
404 Not found. The specified component ID could not be found.
500 Internal server error. An internal error has occurred.

Response body

Table 1. Number of active alerts per resource group.
Attributes Type Description
<group_UID> Object Active alerts for the specified resource group
  critical Integer Number of critical alerts
  warning Integer Number of warning alerts
Table 2. Default information about all active alerts
Attributes Type Description
alertID String Alert identifier
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  
commonEventID String Common event ID
componentID String ID of the component associated with the active alert
componentIdentifierText String 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

eventClass String 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
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 String  
fruSerialNumberText String  
groupName Array of strings List of resource-groups, by name, to which the source of the alert 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 alert belongs.
isManagement Boolean  
location String Location information for event association in the format of Slot#01
msg String Event message string. This is provided in the language requested if translation is supported. If translation is not supported, the message as received in the event will be provided, in whatever language the product provided at time of event (typically this is English).
msgID String  
raisedDate String Date/time active alert was raised by REST user in the ISO-8601 format.
yyyy-MM-dd'T'HH:mm:ss'Z
relatedAlerts String Other alerts related to this alert, if applicable.
service String Indicates how service is performed. This can be one of the following value.
  • 100 . Not serviceable.
  • 200. Serviceable by Lenovo (called home).
  • 300. Serviceable by the customer.
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.
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)
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  
typeText String Event type. This can be one of the following values.
  • Unknown
  • Audit
  • Cooling
  • Power
  • Disks. Storage
  • Memory
  • Processor
  • System. Rack or tower server
  • Test
  • Adaptor. Adapter card
  • Expansion. Expansion board
  • IOModule. Flex System switch
  • Blade. Flex System server
  • Switch. switch

Response example

The following example is returned when outputFormat=summary is specified.
[{
   "11111": {
      "critical": 0,
      "warning": 1
   },
   "22222": {
      "critical": 0,
      "warning ": 0
   },
   "333333333333333333333333": {
      "critical": 0,
      "warning ": 0
   },
   "444444444444444444444444": {
      "critical": 0,
      "warning ": 0
   }
}]
The following example is returned when outputFormat=default is specified.
[{
   "alertID": "IAL:1:FFB657408BEB4161950704AB0ED3A84A",
   "args": ["FFB657408BEB4161950704AB0ED3A84A",""],
   "bayText": "Not Available",
   "chassisText": "Not Available",
   "commonEventID": "",
   "componentID": "FFB657408BEB4161950704AB0ED3A84A",
   "componentIdentifierText": "Unknown",
   "eventClass": 800,
   "eventDate": "2019-07-08T16:19:10Z",
   "eventID": "FQXHMDM0163J",
   "eventSourceText": "Hardware",
   "failFRUNames": [],
   "failFRUPartNumbers": [],
   "failFRUs": [],
   "failFRUUUIDs": [],
   "failSNs": [],
   "flags": "",
   "fruSerialNumberText": "Not Available",
   "groupName": ["Not Available"],
   "groupUUID": [],
   "isManagement": true,
   "location": "",
   "msg": "The connection between the management server and the management controller 
           FFB657408BEB4161950704AB0ED3A84A is offline.",
   "msgID": "FQXHMDM0163J",
   "raisedDate": "2019-07-08T16:19:10Z",
   "relatedAlerts": "",
   "service": 100,
   "serviceabilityText": "Not Required",
   "severity": 300,
   "severityText": "Warning",
   "sourceID": "FFB657408BEB4161950704AB0ED3A84A",
   "systemFruNumberText": "Not Available",
   "systemName": "",
   "systemSerialNumberText": "Not Available",
   "systemText": "Not Available",
   "systemTypeModelText": "Not Available",
   "systemTypeText": "Not Available",
   "typeText": "System"
}
...
]