PUT /events/notifications/subscriptions/<subscription_ID>/filters

Use the PUT method to modify an event filter.

Note: This API requires Lenovo XClarity Administrator v1.3.0 or later.

Authentication

Authentication with user name and password is required.

Request URL

PUT https://<management_server_IP>/events/notifications/subscriptions/<subscription_ID>/filters

Query parameters

None

Request body

Attributes Required / Optional Type Definition
action Required String Action to perform. This can be one of the following values.
  • edit. Modify an event filter.
filter Required Object List of event filters
  eventFilter Required Array of objects Information about the types of events to filter
    filter Required Object Information about each event filter
      categories Required Array of strings Event categories. This can be one of the following values.
  • GENERAL
  • STATUS_CHANGE
  • STATUS_UPDATE
  • WARRANTY
      componentIDs Optional Array of strings List of component IDs. If empty, all components are accepted.
      sourceIDs Optional Array of strings List of source IDs. If empty, all sources are accepted.
      typeSeverity Required Array of objects Event severity and type.

If both sourceIDs and componentsIDs are empty, all events that match the typeSeverity filter is forwarded.

        severity Optional String Event severity. 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.
        type Optional 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
  eventFilterDescription Optional String Event filter description
  eventFilterName Optional String Event filter name
matchEveryCoreEvent Optional Boolean Indicates whether this event filter accepts all core events.
matchEverySystem Optional Boolean Indicates whether this event filter must match every event from every managed device
matchEverything Optional Boolean Indicates whether this event filter matches all events
uid Required String Subscription ID

Request example

{
   "action": "edit",
   "filter": {
      "eventFilter": { 
         "filter": {
            "categories": ["WARRANTY", "GENERAL"],
            "componentIDs": [],
            "sourceIDs": ["FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"],
            "typeSeverity": [{
               "severity": "fatal",
               "type": "all"
            },
            ...,
            {
               "severity": "informational",
               "type": "audit"
            }]
         }
      },
      "eventFilterDescription": "sadfasdf", 
      "eventFilterName": "asdfasdf",
      "matchEveryCoreEvent": false,
      "matchEverySystem": false
   },
   "uid": "1"
}

Response codes

Code Description
200 OK
400 Bad request
401 Unauthorized.
500 Internal server error

Response body

None