*Copyright 2013 Ruckus Wireless, Inc. All rights reserved.
*
* RUCKUS WIRELESS, INC. CONFIDENTIAL -
* This is an unpublished, proprietary work of Ruckus Wireless, Inc., and is fully protected under copyright and trade secret laws. You may not view, use, disclose, copy, or distribute this file or any information contained herein except pursuant to a valid license from Ruckus.
*
* JsonMessage GPB format is used to transfer the JSON messages across
* applications which includes the version, message content and message
* content type attributes.
*/
option java_package = "com.ruckuswireless.scg.protobuf.sci";
message AlarmMessage {
enum AlarmState {
OUTSTANDING = 0;
CLEARED = 1;
}
optional uint32 version = 1;
optional string alarmUuid = 2;
optional uint32 alarmCode = 3;
optional string alarmSeverity = 4;
optional string mainCategory = 5;
optional string alarmType = 6;
optional uint32 initEventCode = 7;
optional uint64 timestamp = 8;
optional AlarmState alarmState = 9;
repeated AlarmMessageEntry attributes = 10;
optional string domainId = 11;
optional string zoneId = 12;
optional string apGroupId = 13;
optional string apMac = 14;
optional string clientMac = 15;
optional string reason = 16;
optional string domainName = 17;
optional string zoneName = 18;
optional string apGroupName = 19;
optional string apIpAddress = 20;
optional string apIpv6Address = 21;
optional string description = 22;
optional string subCategory = 23;
optional string bladeId = 24;
}
message AlarmMessageEntry {
optional string key = 1;
optional string value = 2;
}
Field Description
Enum Alarm Message Alarm State
| Name
|
Value
|
Description
|
| OUTSTANDING
|
0
|
OUTSTANDING
|
| CLEARED
|
1
|
CLEARED
|
Alarm Message Information
| Attribute Name
|
ValueType (size)
|
Property(Snapshot/Delta/Serialization)
|
ValueAggregation Type(SUM,MAX,MIN,AVG,NULL)
|
Description
|
| version
|
uint32
|
snapshot
|
NULL
|
GPB version
|
| alarmUuid
|
string
|
snapshot
|
NULL
|
Alarm UUID
|
| alarmCode
|
uint32
|
snapshot
|
NULL
|
Alarm Code defined by AlarmEnum
|
| alarmSeverity
|
string
|
snapshot
|
NULL
|
Alarm severity defined by AlarmEnum
|
| mainCategory
|
string
|
snapshot
|
NULL
|
Alarm main category defined by AlarmCategory |
| alarmType
|
string
|
snapshot
|
NULL
|
Alarm type description defined by AlarmEnum represented with String.
|
| initEventCode
|
uint32
|
snapshot
|
NULL
|
The triggering event code number for this alarm. |
| timestamp
|
uint64
|
snapshot
|
NULL
|
The timestamp of this alarm's creation.
|
| alarmState
|
.AlarmMessage.AlarmState
|
snapshot
|
NULL
|
The AlarmState of current triggering alarm which contains (OUTSTANDING/CLEARED).
|
| attributes
|
.AlarmMessageEntry
|
snapshot
|
NULL
|
The AlarmMessageEntry contains additional attribute values required by outer service.
|
| domainId
|
string
|
snapshot
|
NULL
|
Domain UUID.
|
| zoneId
|
string
|
snapshot
|
NULL
|
Zone UUID. Unique zone ID assigned by SZ controller.
|
| apGroupId
|
string
|
snapshot
|
NULL
|
AP Group identifier.
|
| apMac
|
string
|
snapshot
|
NULL
|
Access Point MAC address.
|
| clientMac
|
string
|
snapshot
|
NULL
|
UE/Client MAC address if the events are related to client.
|
| reason
|
string
|
snapshot
|
NULL
|
Reason for the alarm to occur.
|
| domainName
|
string
|
snapshot
|
NULL
|
Domain name.
|
| zoneName
|
string
|
snapshot
|
NULL
|
Zone name assigned by the controller. The admin configures
the Zone name via the controller's user interface. |
| apGroupName
|
string
|
snapshot
|
NULL
|
AP Group name.
|
| apIpAddress
|
string
|
snapshot
|
NULL
|
IPv4 address of the AP.
|
| apIpv6Address
|
string
|
snapshot
|
NULL
|
IPv6 address of the AP.
|
| description
|
string
|
snapshot
|
NULL
|
Description of the alarm represented by string.
|
| subCategory
|
string
|
snapshot
|
NULL
|
Sub category of the alarm.
|
| bladeId
|
string
|
snapshot
|
NULL
|
Blade ID information from which node alarm created.
|
Alarm Message Entry Information
Attribute Name
|
ValueType (size) |
Property(Snapshot/Delta/Serialization) |
ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) |
Description
|
| key
|
string
|
snapshot
|
NULL
|
Alarm message entry key.
|
| value
|
string
|
snapshot
|
NULL
|
Alarm message entry value.
|