HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In

Monitoring-Alerts Streaming Event

This section provides information on the Alerts based streaming events within the Monitoring topic. These are the Alerts as seen in the "Alerts & Events" page in Aruba Central's GUI.

Protocol Buffer messages for Alerts in Monitoring Topic

message Notification {
    enum Severity {
        Normal = 1;
        Warning = 2;
        Minor = 3;
        Major = 4;
        Critical = 5;
    }
    enum NotificationState {
        Open = 0;
        Close = 1;
    }
    optional string id = 1; //notification id for refering back when close event is published
    optional string type = 2; // It may be AP_DISCONNECTED, AP_CPU_OVER_UTILIZATION etc
    optional string setting_id = 3; //Reference to setting which caused this notification to be published
    optional string device_id = 4; //Serial number of the device
    optional Severity severity = 5;
    optional uint32 timestamp = 6; //Time of occurrence of the event
    optional NotificationState state = 7; // Used to send state of the alarm (Open or Close)
    optional string description = 8; // Description of alert condition in human readable text
    repeated KeyValueData extra = 9; // Extra information in form of key value pair
}

Parameters Descriptions

The following table lists the field, type, rule, and descriptions of the above mentioned protobuf messages

Field

Type

Rule

Description

id

String

Optional

Notification id for referring back when a close event is published.

device_id

String

Optional

Indicates the associated device serial number.

type

String

Optional

Indicates the notification type.

setting_id

String

Optional

Reference to setting which caused this notification to be published.

severity

Severity

Optional

Indicates the severity and may contain any one of the following:

  • Critical
  • Major
  • Minor
  • Warning

state

NotificationState

Optional

Used to send state of the alarm (Open or Close).

description

String

Optional

Describes the alert condition in a human readable text.

extra

KeyValueData

Repeated

Extra information in the form of key value pair.

timestamp

Uint32

Optional

Indicates the timestamp when interface stats received.

Examples for Alerts based Streaming Events within Monitoring Topic

id: "AXVPlUSbDfwMXe3jHovZ"
type: "User account edited"
setting_id: "55ef4ae129a24c2180e010708202b502-16"
device_id: ""
severity: Major
timestamp: 1603357983
state: Open
description: "User account setting updated for user: [email protected] with language:es_ES idle_timeout: 1800 and start group:All"
extra {
key: "group"
value: "-1"
}
extra {
key: "labels"
value: ""
}
extra {
key: "_rule_number"
value: "0"
}
extra {
key: "params"
value: "[]"
}
extra {
key: "serial"
value: "None"
}
extra {
key: "time"
value: "2020-10-22 09:13:03 UTC"
}

Did this page help you?