GET /inventory/activeAlerts

Use this GET method to retrieve information about inventory-related alerts for all devices.

Deprecated: This API will be deprecated in a future release. Use GET /events/activeAlerts instead.
Note: This API requires Lenovo XClarity Administrator v2.1.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

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

Query parameters

None

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.
500 Internal server error. An internal error has occurred

Response body

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.

commonEventID String Common event ID
componentID String ID of the component associated with the active alert.
componentIdentifier 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

descriptionArgs String List of dynamic arguments in the event message description.

If not available, an empty string is returned.

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 XClarity Administrator. The string is in ISO-8601 format (for example, yyyy-MM-dd'T'HH:mm:ss'Z')

eventID String Event ID is a unique identifier for each event supported by a product
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.

failFRUNumbers 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.

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.

failFRUSNs 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.

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.

groupUUID Array of strings List of resource-groups, by UUID, to which the source of the alert belongs
helpURL String Link to the help system for more information, if available
location String Location information for event association in the format of Slot#01
management Boolean  
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  
owningEntity String  
raisedDate String Date/time active alert was raised by REST user in ISO-8601 format (for example, 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 values.
  • 100 . Not serviceable.
  • 200. Serviceable by Lenovo (called home).
  • 300. Serviceable by the customer.
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.
sourceID String UUID for the system or device that is/was the event source (raiser/owner).
userActionArgs String List of dynamic arguments in the alert message action

If not available, an empty string is returned.

uri String URI of the device associated with the alert
uuid String UUID of the device associated with the alert

Response example

[{
   "alertID": "IBM:CMM02:Y010BG44F0BR:01:241012:2",
   "args": ["zone04"],
   "commonEventID": "FQXCMVD0700F",
   "componentID": "9EF6C71331FC4C02A75259B09D4D7ED0",
   "componentIdentifier": null,
   "descriptionArgs": null,
   "eventClass": 50,
   "eventDate": 1518196945000,
   "eventID": "00038104",
   "failFRUNames": null,
   "failFRUNumbers": null,
   "failFRUPartNumbers": null,
   "failFRUSNs": null,
   "failFRUUUIDs": null,
   "groupUUID": null,
   "helpURL": null,
   "location": "0101",
   "management": false,
   "msg": "Cooling zone zone04 might not have adequate cooling.",
   "msgID": "CMM0009",
   "owningEntity": "IBM",
   "raisedDate": 1518196945000,
   "relatedAlerts": "",
   "severity": 300,
   "service": 100,
   "sourceID": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
   "userActionArgs": null,
   "uri": "chassis/9EF6C71331FC4C02A75259B09D4D7ED0",
   "uuid": "9EF6C71331FC4C02A75259B09D4D7ED0"
},
...,
{
   "alertID": "IBM:CMM02:Y010BG44F0BR:01:241022:6",
   "args": null,
   "commonEventID": "FQXCMCR0781F",
   "componentID": "DUMMY-9EF6C71331FC4C02-CHASSIS[1]-MM[1]",
   "componentIdentifier": null,
   "descriptionArgs": null,
   "eventClass": 50,
   "eventDate": 1518197236000,
   "eventID": "0002201E",
   "failFRUNames": null,
   "failFRUNumbers": null,
   "failFRUPartNumbers": null,
   "failFRUSNs": null,
   "failFRUUUIDs": null,
   "groupUUID": null,
   "helpURL": null,
   "location": "01010201",
   "management": false,
   "msg": "Standby Chassis Management Module communication is offline.",
   "msgID": "CMM0812",
   "owningEntity": "IBM",
   "raisedDate": 1518197236000,
   "relatedAlerts": "",
   "service": 100,
   "severity": 300,
   "sourceID": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
   "userActionArgs": null,
   "uri": "chassis/9EF6C71331FC4C02A75259B09D4D7ED0",
   "uuid": "9EF6C71331FC4C02A75259B09D4D7ED0"
}]