sci-message.proto

*Copyright 2017 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";

option java_outer_classname = "SciProtocolMessage";
import "ap_status.proto";
import "ap_report.proto";
import "ap_client.proto";
import "ap_mesh.proto";
import "ap_rogue.proto";
import "sci-event.proto";
import "sci-configuration.proto";
import "ap_avc.proto";
import "ap_avc_all.proto";
import "sci-alarm.proto";
import "ap_wired_client.proto";
import "ap_hccd_report.proto";
import "sci-pci.proto";
import "switch_all.proto";
import "switches.proto";
import "sci-rogue.proto";
import "ap_peerlist.proto";
import "session_manager.proto";

message SciMessage {
	extensions 1001 to 3000;

	//protocol version
	optional string version = 1;
 optional bytes uuid = 3;
 optional int64 sentTimeMs = 4;
 optional string sciSystemId = 5;
 optional APStatus apStatus = 101;
 optional APReportStats apReport = 102;
 optional APClientStats apClient = 103;
 optional APMeshStats apMesh = 104;
 optional RogueAPStats apRogue = 105;
 optional EventMessage eventMessage = 106;
 optional ConfigurationMessage configurationMessage = 107;
 optional AlarmMessage alarmMessage = 108;
 optional APWiredClientStats apWiredClient = 109;
 optional PciReportMessage pciReportMessage = 110;
 optional ApHccdReportMessage apHccdReportMessage = 111;
 optional com.ruckuswireless.scg.protobuf.icx.SwitchMessage switchMessage = 112;
 optional SciRogueMessage sciRogueMessage = 113;
 optional SessionManagerClientData sessionManagerClientData = 114;
 repeated ArcMessage arcMessage = 206;
 optional APAVCStats apAvc = 207;
 optional com.ruckuswireless.scg.protobuf.icx.SwitchConfigurationMessage switchConfigurationMessage = 300;
 optional com.ruckuswireless.scg.protobuf.icx.RealtimeSwitchStatus realtimeSwitchStatus = 301;
 optional APPeerReport apPeer = 302;
 optional com.ruckuswireless.scg.protobuf.icx.SwitchDetailMessage switchDetailMessage = 303;

}

Field Description

SCI Message Information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Description
version string snapshot NULL protocol version.
uuid bytes snapshot NULL Message identifier for duplication detection.
sentTimeMs int64 snapshot NULL Sent time in milliseconds.
sciSystemId string snapshot NULL SCI System identifier.
apStatus .APStatus snapshot NULL APStatus from Routine AP Statistic Report.
apReport .APReportStats snapshot NULL APReportStats from Routine AP Statistic Report.
apClient .APClientStats snapshot NULL APClientStats from Routine AP Statistic Report.
apMesh .APMeshStats snapshot NULL APMeshStats from Routine AP Statistic Report.
apRogue .RogueAPStats snapshot NULL RogueAPStats from Routine AP Statistic Report.
eventMessage .EventMessage snapshot NULL Event message which has been applied to be sent to outer service.
configurationMessage .ConfigurationMessage snapshot NULL SZ overall configuration message sent out every 15 minutes.
alarmMessage .AlarmMessage snapshot NULL Alarm message will be sent out when the alarm happens.
apWiredClient .APWiredClientStats snapshot NULL APWiredClientStats from Routine AP Statistic Report.
pciReportMessage .PciReportMessage snapshot NULL PCI Compliance Report which will be sent out every 15 minutes.
apHccdReportMessage .ApHccdReportMessage snapshot NULL ApHccdReportMessage from Routine AP Statistic Report.
switchMessage .com.ruckuswireless.scg.protobuf.icx.SwitchMessage snapshot NULL SwitchMessage from ICX Statistic Report.
sciRogueMessage .SciRogueMessage snapshot NULL SciRogueMessage from AP rogue AP report which have been classified by rogue AP policy of SZ.
sessionManagerClientData SessionManagerClientData snapshot NULL SessionManagerClientData from Session Manager's client auth/deauth or connect/disconnect event.
arcMessage .ArcMessage snapshot NULL ArcMessage is from Routine AP Statistic Report which will be sent out every 5 minutes.
apAvc .APAVCStats snapshot NULL APAVCStats contains a series of ArcMessage.
switchConfigurationMessage .com.ruckuswireless.scg.protobuf.icx.SwitchConfigurationMessage snapshot NULL Switch overall configuration message sent out every 15 minutes.
realtimeSwitchStatus .com.ruckuswireless.scg.protobuf.icx.RealtimeSwitchStatus snapshot NULL Switch realtime status.
apPeer APPeerReport snapshot NULL APPeerReport for on-demand API.
switchDetailMessage com.ruckuswireless.scg.protobuf.icx.SwitchDetailMessage snapshot NULL The list of attached switch detail