POST /events/notifications/<pusher_type>/subscriptions/<subscription_ID>/filters

Use the POST method to create an event filter for a specific subscription.

If you are logged in as a user with one of the following roles, information that is associated with all subscriptions is returned; otherwise, information associated with subscriptions for only the logged-in user is returned.
  • lxc-admin

  • lxc-supervisor

  • lxc-security-admin

  • lxc-sysmgr

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

Authentication

Authentication with user name and password is required.

Request URL

POST https://<management_server_IP>/events/notifications/<pusher_type>/subscriptions/<subscription_ID>/filters
where
  • <pusher_type> is the type of push notification service. This can be one of the following values.

    • AndroidPusher. Google device push service

    • iOSPusher. Apple device push service

    • WebSocketPusher. WebSocket service

    Tip: Because the subscription ID is unique, specifying the type of push notification service is optional
  • <subscription_ID> is the UID of the subscription to be retrieved. To obtain the subscription UID, use the GET /events/notifications/subscriptions method.

Query parameters

None

Request body

Attributes Required / Optional Type Definition
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 Required Array of strings List of component IDs. If empty, all components are accepted.
    sourceIDs Required 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 Required 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 Required 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 Required String Event filter description
eventFilterName Required 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

Request example

{
   "eventFilterName": "example2",
   "eventFilterDescription": "Description",
   "eventFilter": {
      "filter": {
         "componentIDs": ["FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
         "500C0FF286F98000"],
         "sourceIDs": ["FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
         "500C0FF286F98000"],
         "typeSeverity": [{
            "severity": "fatal",
            "type": "all"
         },
         ...,
         {
            "severity": "informational",
            "type": "audit"
         }],
         "categories": ["WARRANTY",
         "GENERAL"]
      }
   },
   "matchEverySystem": false,
   "matchEveryCoreEvent": false
}

Response codes

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

Response body

None