Skip to main content

PUT /events/predefinedFilters

Use this method to modify the properties of a predefined event filter.

Authentication​

Authentication with username and password is required.

Request URL​

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

Query parameters​

None

Response body​

AttributesRequired / OptionalTypeDefinition
eventFilterRequiredArray of objectsList of predefined and custom event filters
 filterRequiredObjectInformation about the types of events to filter
  categoriesRequiredArray of stringsEvent 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.
  componentIDsOptionalArray of stringsList of component IDs. If empty, all components are accepted.
  sourceIDsOptionalArray of stringsList of source IDs. If empty, all sources are accepted.
  typeSeverityRequiredArray of objectsEvent severity and type.

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

   severityOptionalStringEvent 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.
   typeOptionalStringEvent 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
  • Other
  • Backplane
  • Chassis
  • Drive
  • ExtDrive. External drive
  • Fan
  • M2Adapter
  • M2Drive
  • OCP
  • PCIE
  • PSU
  • Retimer
  • Riser
  • 7MMDrive
  • Pump
eventFilterDescriptionRequiredStringEvent filter description
eventFilterNameRequiredStringEvent filter name
matchEveryCoreEventOptionalBooleanIndicates whether this event filter accepts all core events
matchEverySystemOptionalBooleanIndicates whether this event filter must match every event from every managed device
matchEverythingOptionalBooleanIndicates whether this event filter matches all events
The following example modifies a predefined event filter.
{
   "action": "edit",
   "eventFilter": {
      "filter": {
         "componentIDs": [],
         "sourceIDs": ["FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF"],
         "typeSeverity": [
            {
               "severity": "fatal",
               "type": "all"
            },
            ...,
            {
               "severity": "informational",
               "type": "audit"
            }
         ],
         "categories": [
            "WARRANTY",
            "GENERAL"
         ]
      }
   },
   "eventFilterDescription": "Fatal and informational events",
   "eventFilterName": "FatalInfoEvents ",
   "matchEveryCoreEvent": false,
   "matchEverySystem": false
}

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA 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.
401UnauthorizedThe user cannot be authenticated. Authentication has not been provided or has failed. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

None