sci configuration message

*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.
*/
option java_package = "com.ruckuswireless.scg.protobuf.sci";

message ConfigurationMessage { 
    required uint32 version = 1;
    optional ClusterMessage clusterInfo = 2; 
    optional uint64 timestamp = 3;
}

message ClusterMessage {
    /* Cluster Informations */ 
    optional string clusterUuid = 1; 
    optional string clusterName = 2;
    optional string controlBlades = 3; // (/wsg/api/scg/planes/control 
and /wsg/api/sci/cbs)
    optional string controllerUtilizations = 4; // 
(/wsg/api/sci/cbutils)
    optional string systemSummary = 5; // 
(/wsg/api/scg/planes/systemSummary)
    /* Raw Data [Compression]*/ 
    optional string domains = 100; //
(/wsg/api/scg/session/currentUser/domainList) 
    optional string zones = 101; //
(/wsg/api/scg/zones/byDomain/$domain) 
    optional string apGroups = 102; //
(/wsg/api/scg/apgroup/byZone/$zone) 
    optional string wlanGroups = 103; //
(/wsg/api/scg/wlangroup/byZone/$zone)
    optional string wlans = 104; // (/wsg/api/scg/wlans/byZone/$zone) 
    optional string aps = 105; // (/wsg/api/sci/aps)
    /* System Hierarchy [Group Tree]*/ 
    repeated TenantMessage tenantInfos = 200;
}

message TenantMessage {
    optional string tenantId = 1; 
    optional string tenantName = 2;
    optional DomainMessage adminDomain = 3;
}
 
message DomainMessage {
    optional string domainId = 1; 
    optional string domainName = 2; 
    repeated ZoneMessage zoneInfos = 3;
    repeated DomainMessage subDomainInfos = 4;
}

message ZoneMessage {
    optional string zoneId = 1; 
    optional string zoneName = 2;
    repeated ApGroupMessage apGroupInfos = 3; 
    repeated WlanGroupMessage wlanGroupInfos = 4;
}

message ApGroupMessage {
    optional string apGroupId = 1; 
    optional string apGroupName = 2;
}

message WlanGroupMessage {
    optional string wlanGroupId = 1; 
    optional string wlanGroupName = 2;
}

Field Description

Configuration Message Information

Attribute Name

ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL)

Description

version uint32 snapshot NULL GPB version
clusterInfo .ClusterMessage snapshot NULL Cluster information
timestamp uint64 snapshot NULL Time and date of cluster message

Cluster Message Information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Description
clusterUuid string snapshot NULL Cluster UUID
clusterName string snapshot NULL Cluster name
controlBlades string snapshot NULL JSON string of control node information.
controllerUtilizations string snapshot NULL JSON string of system resource utilization. Refer to JSON Schema for Control Nodes.
systemSummary string snapshot NULL JSON string of system summary. Refer to JSON Schema for System Resource Utilization
domains string snapshot NULL JSON string of domain list. Refer to JSON Schema for Domain List
zones string snapshot NULL JSON string of zone list. Refer to JSON Schema for Zone List
apGroups string snapshot NULL JSON string of AP group list. Refer to
wlans string snapshot NULL JSON string of WLAN list. Refer to JSON Schema for WLAN List
aps string snapshot NULL JSON string of AP list. Refer to JSON Schema for AP List
tenantInfos .TenantMessage snapshot NULL

Group Tree System Hierarchy

Tenant Message Information

Attribute Name

ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL)

Description

tenantId string snapshot NULL Tenant UUID
tenantName string snapshot NULL Tenant name
adminDomain .DomainMessage snapshot NULL Domain information

Domain Message Information

Attribute Name

ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL)

Description

domainId string snapshot NULL Domain UUID
domainName string snapshot NULL Domain name
zoneInfos .ZoneMessage snapshot NULL Zone information
subDomainInfos .DomainMessage snapshot NULL Sub Domain information

Zone Message Information

Attribute Name

ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL)

Description

zoneId string snapshot NULL Zone UUID
zoneName string snapshot NULL Zone name
apGroupInfos .ApGroupMessage snapshot NULL AP Group information
wlanGroupInfo .WlanGroupMessage snapshot NULL WLAN Group information

AP Group Message Information

Attribute Name

ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL)

Description

apGroupId string snapshot NULL AP Group UUID
apGroupName string snapshot NULL AP Group name

WLAN Group Message Information

Attribute Name

ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL)

Description

wlanGroupId string snapshot NULL WLAN Group UUID
wlanGroupName string snapshot NULL WLAN Group name