ap_mesh.proto

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

message APMeshDownlink {
    required string downMac = 1;
    optional uint32 type = 2;
    optional int32 rssi = 3;
    optional uint64 txBytes = 4;
    optional uint64 txFrames = 5;
    optional uint64 rxBytes = 6;
    optional uint64 rxFrames = 7;
    
6.1.1 update
optional uint32 medianTxMCSRate = 8; optional uint32 medianRxMCSRate = 9; } message APMeshUplink { required string upMac = 1; optional uint32 type = 2; optional int32 rssi = 3; optional uint64 txBytes = 4; optional uint64 txFrames = 5; optional uint64 rxBytes = 6; optional uint64 rxFrames = 7;
6.1.1 update
optional uint32 medianTxMCSRate = 8; optional uint32 medianRxMCSRate = 9; } message APMeshNeighbor { required string mac = 1; optional int32 rssi = 2; } message APMeshStats { required uint32 version = 1; required string ap = 2; optional uint64 timestamp = 3; optional uint64 seqNumber = 4; optional string zone_id = 5; optional int32 meshRole = 6; optional string meshSSID = 7; optional string meshPassphraseMD5 = 8; optional int32 hops = 9; repeated APMeshNeighbor neighbor = 10; repeated APMeshUplink uplink = 11; repeated APMeshDownlink downlink = 12; optional string apgroup_id = 13; optional string cluster_id = 14; optional string domain_id = 15; optional string aptenant_id = 16; optional string map_id = 17; optional string aptenant_name = 18; optional string zone_name = 19; optional string apgroup_name = 20; optional string domain_name = 21; optional uint64 sampleTime = 22; optional uint32 aggregationInterval = 23; optional bool isMeshEnable = 24; optional string serialNumber = 25; }

Field Description

AP Mesh Downlink information

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) Description
downMac string snapshot NULL MAC address of the mesh downlink AP
type uint32 snapshot NULL Link status of the mesh downlink AP
rssi int32 snapshot AVG RSSI of the mesh downlink AP
txBytes uint64 snapshot SUM Total size of data and management packets transmitted since the last AP restart
txFrames uint64 snapshot SUM Total number of data and management packets transmitted since the last AP restart
rxBytes uint64 snapshot SUM Total size of data and management packets received since the last AP restart
rxFrames uint64 snapshot SUM Total number of data and management packets received since the last AP restart
6.1.1 update
medianTxMCSRate
UINT32 delta NULL Downlink median TX MCS rate in this bin
6.1.1 update
medianRxMCSRate
UINT32 delta NULL Downlink median RX MCS rate in this bin

AP Mesh Uplink Information

Attribute Name

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

Description

upMac string snapshot NULL MAC address of the mesh uplink AP
type uint32 snapshot NULL Link status of the mesh uplink AP
rssi int32 snapshot AVG RSSI of the mesh uplink AP
txBytes uint64 snapshot SUM Total size of data and management packets transmitted since the last AP restart
txFrames uint64 snapshot SUM Total number of data and management packets transmitted since the last AP restart
rxBytes uint64 snapshot SUM Total size of data and management packets received since the last AP restart
rxFrames uint64 snapshot SUM Total number of data and management packets received since the last AP restart
6.1.1 update
medianTxMCSRate
UINT32 delta NULL Uplink median TX MCS rate in this bin
6.1.1 update
medianRxMCSRate
UINT32 delta NULL Uplink median RX MCS rate in this bin

AP Mesh Neighbor Information

Attribute Name

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

Description

mac string snapshot NULL MAC address of the neighboring AP
rssi int32 snapshot NULL RSSI of the neighboring AP

AP Mesh Statistics Information

Attribute Name

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

Description

version uint32 snapshot NULL Mesh stats version
ap string snapshot NULL MAC address of the AP
timeStamp string snapshot NULL Date and time these statistics were generated
seqNumber uint64 snapshot NULL Counter for generating mesh statistics.The count increases by one whenever the AP generates mesh statistics.When the AP restarts,the counter also resets to zero(0).
zoneUUID string snapshot NULL Unique zone ID (for example, b381206b-2e5d-43dc-b249-e36ffae9855c) assigned by the controller
meshRole int snapshot NULL Role of the AP on the mesh network (if mesh networking is enabled). Possible values include:
  • 0: MESH_DISABLED
  • 1: MESH_RAP
  • 2: MESH_MAP
  • 3: MESH_EAP
  • 4: MESH_DOWN
  • 5: MESH_UNDEFINED
meshSSID int snapshot NULL SSID of the mesh network
meshPassphraseMD5 int snapshot NULL Passphrase required for the AP to join the mesh network
hops int snapshot NULL Depth or number of hops between this AP and its parent root AP
neighbor .APMeshNeighbor Serialization NULL Serialization neighbors data
uplink .APMeshUplink Serialization NULL Serialization mesh uplink data
downlink .APMeshDownlink Serialization NULL serialization mesh downlink data
apgroup_id string snapshot NULL AP group UUID
cluster_id string snapshot NULL Cluster UUID
domain_id string snapshot NULL Domain UUID
aptenant_id string snapshot NULL AP tenant UUID
map_id string snapshot NULL MAP UUID
aptenant_name string snapshot NULL AP tenant name
zone_name string snapshot NULL Zone name
apgroup_name string snapshot NULL AP group name
domain_name string snapshot NULL Domain name
sampleTime uint64 snapshot NULL Timestamp for generating this stats report
aggregationInterval uint32 snapshot NULL Interval time to aggregate data
isMeshEnable boolean snapshot NULL An indicate for mesh status
serialNumber string snapshot NULL The serial number in AP board data