*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 EventMessage {
required uint32 version = 1;
optional uint32 eventCode = 2;
optional string eventType = 3;
optional string mainCategory = 4;
optional string subCategory = 5;
optional string domainId = 6;
optional string zoneId = 7;
optional string apGroupId = 8;
optional string apMac = 9;
optional string clientMac = 10;
optional uint64 timestamp = 11;
repeated MessageEntry attributes = 12;
optional string severity = 13;
optional string reason = 14;
optional string domainName = 15;
optional string zoneName = 16;
optional string apGroupName = 17;
optional string apIpAddress = 18;
optional string apIpv6Address = 19;
optional string description = 20;
optional string disconnectReason = 21;
optional string tenantId = 22;
optional string switchId = 23;
optional string switchUnitId = 24;
optional string switchGroupId = 25;
optional string switchGroupLevelOneId = 26;
optional string switchGroupLevelTwoId = 27;
optional string radio = 28;
optional string rssi = 29;
optional string band = 30;
optional string channel = 31;
optional string rfband = 32;
}
message MessageEntry {
optional string key = 1;
optional string value = 2;
}
Field Description
Event Message Information
| Attribute Name
|
ValueType (size)
|
Property(Snapshot/Delta/Serialization)
|
ValueAggregation Type(SUM,MAX,MIN,AVG,NULL)
|
Description
|
| version
|
uint32
|
snapshot
|
NULL
|
GPB version
|
| eventCode
|
uint32
|
snapshot
|
NULL
|
Event code
|
| eventType
|
string
|
snapshot
|
NULL
|
Event type
|
| mainCategory
|
string
|
snapshot
|
NULL
|
Event main category
|
| subCategory
|
string
|
snapshot
|
NULL
|
Event sub category
|
| domainId
|
string
|
snapshot
|
NULL
|
Domain UUID
|
| zoneId
|
string
|
snapshot
|
NULL
|
Zone UUID. Unique zone ID (for example, b381206b-2e5d-43dc-b249-e36ffae9855c) assigned
by the 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 the client
|
| timestamp
|
uint64
|
snapshot
|
NULL
|
Event timestamp (UTC time)
|
| attributes
|
.MessageEntry
|
snapshot
|
NULL
|
Additional event attributes.
|
| severity
|
string
|
snapshot
|
NULL
|
Event severity
|
| reason
|
string
|
snapshot
|
NULL
|
Reason for the event to occur.
|
| domainName
|
string
|
snapshot
|
NULL
|
Domain name.
|
| zoneName
|
string
|
snapshot
|
NULL
|
Zone name. Zone name assigned by the controller. The admin configures the Zone name
via the controller's user interface. The controller passes it to the AP. AP retains
the zone name.
|
| 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 event
|
| disconnectReason |
string |
snapshot |
NULL |
Disconnect reason of the event |
| tenantId |
string |
snapshot |
NULL |
The tenant id of switch |
| switchId |
string |
snapshot |
NULL |
Switch ID |
| switchUnitId |
string |
snapshot |
NULL |
Switch unit ID |
| switchGroupId |
string |
snapshot |
NULL |
Group identifier of switch. |
| switchGroupLevelOneId |
string |
snapshot |
NULL |
Level 1 identifier of switch group. |
| switchGroupLevelTwoId |
string |
snapshot |
NULL |
Level 2 identifier of switch group. |
| radio |
string |
snapshot |
NULL |
Radio |
| rssi |
string |
snapshot |
NULL |
Rssi |
| band |
string |
snapshot |
NULL |
Band |
| channel |
string |
snapshot |
NULL |
Channel |
| rfband |
string |
snapshot |
NULL |
rfband |
Message Entry Information
Attribute Name
|
ValueType (size) |
Property(Snapshot/Delta/Serialization) |
ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) |
Description
|
| key
|
string
|
snapshot
|
NULL
|
Message key
|
| value
|
string
|
snapshot
|
NULL
|
Message content
|