GET /events/notifications/<pusher_type>/subscriptions/<subscription_ID>/filters/<filter_name>

Use the GET method to retrieve information about a specific event filter that is associated with 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

GET https://<management_server_IP>/events/notifications/<pusher_type>/subscriptions/<subscription_ID>/filters/<filter_name>
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.

  • <filter_name> is the name of the event filter to be retrieved. To obtain the event filter name, use the GET /events/notifications/subscriptions/<subscription_ID>/filters method.

Query parameters

None

Request body

None

Response codes

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

Response body

Attributes Type Definition
eventFilter Array of objects Information about the types of events to filter
  filter Object Information about each event filter
    categories Array of strings Event categories. This can be one of the following values.
  • GENERAL
  • STATUS_CHANGE
  • STATUS_UPDATE
  • WARRANTY
    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.

Response example

[{
   eventFilter: {
      filter: {
         typeSeverity: [{
            severity: "MAJOR",
            type: "UNKNOWN"
         },
         ................{
            severity: "FATAL",
            type: "SWITCH"
         }],
         sourceIDs: ["FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
         "500C0FF286F98000"],
         categories: ["WARRANTY",
         "GENERAL"],
         componentIDs: ["FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF",
         "500C0FF286F98000"]
      }
   },
   eventFilterDescription: "",
   eventFilterName: "example2",
   isDeletable: true,
   isEditable: true,
   isUsed: true,
   matchEveryCoreEvent: false,
   matchEverySystem: false,
   matchEverything: false,
}]
Parent topic: /events/notifications/<pusher_type>/subscriptions/<subscription_ID>/filters/<filter_name>