GET /events/predefinedFilters

Use this method to return information about the predefined event filters.

Authentication

Authentication with user name and password is required.

Request URL

GET https://{management_server_IP}/events/predefinedFilters

Query parameters

None

Response codes

Code Description Comments
200 OK The request completed successfully.
400 Bad Request A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body.
401 Unauthorized The user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
500 Internal Server Error An internal error occurred. A descriptive error message is returned in the response body.

Response body

Attributes Type Definition
eventFilter Array of objects List of predefined and custom event filters
  filter Object Information about the types of events to filter
    categories Array of strings Event categories. This can be one of the following values.
  • BULLETIN. Sends notification about new bulletins.
  • GENERAL. Sends notifications about audit events, based on the selected event classes and severities
  • STATUS_CHANGE. Sends notifications about changes in status.
  • STATUS_UPDATE
  • WARRANTY. Send notifications about warranties.
    componentIDs Array of strings List of component IDs. If empty, all components are accepted.
    sourceIDs Array of strings List of source IDs. If empty, all sources are accepted.
    typeSeverity Array of objects Event severity and type

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

      severity 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 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 String Event filter description
eventFilterName String Event filter name
isDeletable Boolean Indicates whether the event filter can be deleted
isEditable Boolean Indicates whether this event filter can be modified
isUsed Boolean Indicates whether this event filter is used by at least one subscription
lockedPredefinedFilter Boolean Indicates whether this is a predefined event filter that is provided by default by XClarity Administrator
matchEveryCoreEvent Boolean Indicates whether this event filter accepts all core events
matchEverySystem Boolean Indicates whether this event filter must match every event from every managed device
matchEverything Boolean Indicates whether this event filter matches all events
name String User-defined name of the event filter. This must be unique for all filters.
The following example is returned if the request is successful.
[{
   "eventFilter": {
       "filter": {
          "categories": ["GENERAL"],
          "componentIDs": [],
          "sourceIDs": [],
          "typeSeverity": [{
            "severity": "MAJOR",
            "type": "UNKNOWN"
          },
          ..,
          {
            "severity": "FATAL",
            "type": "BLADE"
          }] 
      }        
   }      
   "eventFilterDescription": "This filter matches all critical events that are generated
                             in managed device or the management server itself."
   "eventFilterName": "Match All Critical",
   "isDeletable": false,
   "isEditable": false,
   "isUsed": true,
   "lockedPredefinedFilter": true,
   "matchEveryCoreEvent": false,
   "matchEverySystem": true,
   "matchEverything": false,   
},
...,
{
   "eventFilter": {
      "filter": {
         "categories": ["WARRANTY", "GENERAL"],
         "componentIDs": [],
         "sourceIDs": ["FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"],
         "typeSeverity": [{
            "severity": "INFORMATIONAL",
            "type": "UNKNOWN"
         },
         ..,
         {
            "severity": "FATAL",
            "type": "BLADE"
         }]         
      }      
   }     
   "eventFilterDescription": "",
   "eventFilterName": "sadfasdf",
   "isDeletable": true,
   "isEditable": true,
   "isUsed": false,
   "lockedPredefinedFilter": false,
   "matchEveryCoreEvent": false,
   "matchEverySystem": false,
   "matchEverything": false
}]