ap_report.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 APReportPerDnsServer {
    required string ipAddress = 1;
    optional uint64 req_cnt = 2;
    optional uint64 resp_cnt = 3;
}

message APReportDnsStats {
    required int32 server_cnt = 1;
    optional .APReportPerDnsServer perDnsServer = 2;
}

message APReportBinWlan {
    optional string ap_mac = 1;
    optional uint64 time = 2;
    optional uint64 binStartTime = 3;
    optional string radioMode = 4;
    optional string mode = 5;
    optional int32 channel = 6;
    optional string ssid = 7;
    optional string bssid = 8;
    optional int32 wsgWlanId = 9;
    optional int32 wlanId = 10;
    optional uint32 maxNumClients = 11;
    optional uint32 minNumClients = 12;
    optional int32 avgNumClients = 13;
    optional uint64 rxBytes_r = 14;
    optional uint64 txBytes_r = 15;
    optional uint64 rxFrames_r = 16;
    optional uint64 txFrames_r = 17;
    optional uint64 txFail_r = 18;
    optional uint64 rxRateKbps = 19;
    optional uint64 txRateKbps = 20;
    optional uint32 newAssoc = 21;
    optional uint32 failedAssoc = 22;
    optional uint32 rxFail_r = 23;
    optional uint64 peakRx_r = 24;
    optional uint64 peakTx_r = 25;
    optional uint64 rxDataFrames_r = 26;
    optional uint64 rxDataBytes_r = 27;
    optional uint64 rxMgmtFrames_r = 28;
    optional uint64 rxMgmtBytes_r = 29;
    optional uint64 txDataFrames_r = 30;
    optional uint64 txDataBytes_r = 31;
    optional uint64 txMgmtFrames_r = 32;
    optional uint64 txMgmtBytes_r = 33;
    optional uint64 rxBcastFrames_r = 34;
    optional uint64 rxMcastFrames_r = 35;
    optional uint64 rxUcastFrames_r = 36;
    optional uint64 txBcastFrames_r = 37;
    optional uint64 txMcastFrames_r = 38;
    optional uint64 txUcastFrames_r = 39;
    optional uint64 txDropDataFrames_r = 40;
    optional string wlangroup_id = 42;
    optional string wlantenant_id = 43;
    optional string wlangroup_name = 44;
    optional string wlantenant_name = 45;
    optional string wlanName = 46;
    optional uint32 authFailureCount = 47;
    optional uint32 authSuccessCount = 48;
    optional uint32 assocFailureCount = 49;
    optional uint32 assocSuccessCount = 50;
    optional uint32 eapFailureCount = 51;
    optional uint32 eapSuccessCount = 52;
    optional uint32 radiusFailureCount = 53;
    optional uint32 radiusSuccessCount = 54;
    optional uint32 dhcpFailureCount = 55;
    optional uint32 dhcpSuccessCount = 56;
    optional uint64 txDropMgmtFrames_r = 57;
    optional uint32 staSmartRoamDisconCnt = 58;
    optional uint32 staIdleDisconCnt = 59;
    optional uint32 staLeaveDisconCnt = 60;
    optional uint32 staInvalidDisconCnt = 61;
    optional uint32 staRadioFailDisconCnt = 62;
    optional uint32 staAPKickDisconCnt = 63;
    optional uint64 rxDataBytesSplitTunnel = 64;
    optional uint64 txDataBytesSplitTunnel = 65;
    optional uint64 rxDataFramesSplitTunnel = 66;
    optional uint64 txDataFramesSplitTunnel = 67;
    optional .APReportDnsStats dnsStats = 68;
    optional uint32 roamingFailureCount = 69;
    optional uint32 L3authFailureCount = 70;
    optional uint32 L3authSuccessCount = 71;
    optional uint32 roamingSuccessCount = 72;
    optional uint32 arpPktCount = 73;
    optional AttributeMapWlan ideal_stats_wlan_required = 74;
    optional uint32 probe_dropped = 75;
    optional uint32 auth_dropped = 76;
    optional uint32 btm_requests = 77;
    optional uint32 sta_kickouts = 78;
    optional uint32 rx_num_probe_filt = 79;
    optional uint32 rx_num_auth_filt = 80;
}

message APReportBinRadio {
    optional uint32 radioId = 1;
    optional uint32 airtime = 2;
    optional uint32 airtimeB = 3;
    optional uint32 airtimeRx = 4;
    optional uint32 airtimeTx = 5;
    optional uint32 phyError = 6;
    optional uint64 rxBytes_r = 7;
    optional uint64 txBytes_r = 8;
    optional uint64 rxFrames_r = 9;
    optional uint64 txFrames_r = 10;
    optional int32  noiseFloor = 11;
    optional uint64 retry = 12;
    repeated APReportBinWlan binWlan = 13;
    optional uint32 latency = 14;
    optional uint32 capacity = 15;
    optional float connectionFailure = 16;
    optional uint32 connectionAuthFailureCount = 17;
    optional uint32 connectionAssocFailureCount = 18;
    optional uint32 connectionTotalCount = 19;
    optional uint32 connectionAuthSuccessCount = 20;
    optional uint32 connectionAssocSuccessCount = 21;
    optional uint32 connectionEAPFailureCount = 22;
    optional uint32 connectionEAPSuccessCount = 23;
    optional uint32 connectionRadiusFailureCount = 24;
    optional uint32 connectionRadiusSuccessCount = 25;
    optional uint32 connectionDHCPFailureCount = 26;
    optional uint32 connectionDHCPSuccessCount = 27;
    optional uint32 connectionTotalSuccess = 28;
    optional uint32 connectionTotalFailure = 29;
    optional uint64 txRatebps = 30;
    optional uint64 histogramClientTTC = 31;
    optional uint32 medianTxRadioMCSRate = 32;
    optional uint32 connectionL3AuthFailureCount = 34;
    optional uint32 connectionL3AuthSuccessCount = 35;
    optional uint32 TxPER = 36;
    optional float txRetryRate = 37
}

message APReportBinTunnel {
    required string gw = 1;
    optional int32 index = 2;
    optional int32 isActive = 3;
    optional uint64 cICMP = 4;
    optional uint64 cNonICMP = 5;
    optional uint64 cDisconnect = 6;
    optional uint64 rxBytes = 7;
    optional uint64 rxPkts = 8;
    optional uint64 rxDropPkts = 9;
    optional uint64 rxErrPkts = 10;
    optional uint64 txBytes = 11;
    optional uint64 txPkts = 12;
    optional uint64 txDropPkts = 13;
    optional uint64 txErrPkts = 14;
    optional uint64 txFragPkts = 15;
    optional int32 type = 16;
    optional string apIpAddress = 17;
}
message APReportBinIPSec {
      enum IPsecTunnelType {
		RUCKUSGRE = 0;
		SOFTGRE = 1;
    }
    required uint64 ipsecSessionTime = 1;
    optional uint64 ipsecTxPkts = 2;
    optional uint64 ipsecRxPkts = 3;
    optional uint64 ipsecTxBytes = 4;
    optional uint64 ipsecRxBytes = 5;
    optional uint64 ipsecTxDropPkts = 6;
    optional uint64 ipsecRxDropPkts    = 7;
    optional uint64 ipsecTxIdleTime    = 8;
    optional uint64 ipsecRxIdleTime    = 9;
    optional string apIpAddress = 10;
    optional string gw = 11;
    optional IPsecTunnelType ipsecTunnelType = 12;
}
message ttcData {
	optional string sessionId = 1;
	optional string multiSessionId = 2;
	optional bool isRoaming = 3;
	optional uint64 clientAuthTTC = 4;
	optional uint64 clientAssocTTC = 5;
	optional uint64 clientEapTTC = 6;
	optional uint64 clientRadiusTTC = 7;
	optional uint64 clientDhcpTTC = 8;
	optional bool isDHCPrenewSess = 9;

}

message sessDeauthData {
	optional string sessionId = 1;
	optional string multiSessionId = 2;
	optional uint64 disconnectTime = 3;
}

message APReportBinClient {
    required string ap = 1;
    optional uint64 time = 2;
    optional uint64 binStartTime = 3;
    optional string radioMode = 4;
    optional string ap80211RadioMode = 5;
    optional string auth = 6;
    optional string encryption = 7;
    optional string clientMac = 8;
    optional string bssid = 9;
    optional string ssid = 10;
    optional string username = 11;
    optional string clientIP = 12;
    optional uint64 clientVlan = 13;
    optional string osType = 14;
    optional string hostname = 15;
    optional int32 channel = 16;
    optional uint32 channelWidth = 17;
    optional int32 rssi = 18;
    optional int32 maxRssi = 19;
    optional int32 minRssi = 20;
    optional int32 firstRssi = 21;
    optional int32 receiveSignalStrength = 22;
    optional int32 firstReceiveSignalStrength = 23;
    optional int32 maxReceiveSignalStrength = 24;
    optional int32 minReceiveSignalStrength = 25;
    optional int32 noiseFloor = 26;
    optional string location = 27;
    optional uint64 rxBytes_r = 28;
    optional uint64 txBytes_r = 29;
    optional uint64 rxFrames_r = 30;
    optional uint64 txFrames_r = 31;
    optional uint32 throughputEst = 32;
    optional uint64 firstSampleTime = 33;
    optional uint64 txDropDataFrames_r = 35;
    optional uint64 rxCRCErrFrames_r = 36;
    optional string sessionId = 37;
    optional string multiSessionId = 38;
    optional uint64 firstConnection    = 39;
    optional uint64 firstAuth = 40;
    optional uint64 ipAssignTime = 41;
    optional uint64 disconnectTime = 42;
    optional uint64 sessionTime = 43;
    optional uint32 radioId = 44;
    optional int32 wsgWlanId = 45;
    optional string wlangroup_id = 46;
    optional string wlangroup_name = 47;
    optional uint32 disconnectReason = 48;
    optional string wlanName = 49;
    optional string wlantenant_id = 50;
    optional string wlantenant_name = 51;
    optional uint64 rxBytes = 52;
    optional uint64 txBytes = 53;
    optional uint64 rxRatebps = 54;
    optional uint64 txRatebps = 55;
    optional int32 bandCap = 56;
    optional int32 vHTCap = 57;
    optional int32 streamCap = 58;
    optional int32 BTMCap = 59;
    optional uint32 medianTxMCSRate = 60;
    optional uint32 medianRxMCSRate = 61;
    optional uint64 clientAuthTTC = 62;
    optional uint64 clientAssocTTC = 63;
    optional uint64 clientEapTTC = 64;
    optional uint64 clientRadiusTTC = 65;
    optional uint64 clientDhcpTTC = 66;
    optional uint32 roamingFailureCount = 67;
    optional uint32 roamingSuccessCount = 68;
    optional int32 deviceType = 69;
    optional int32 osVendorType = 70;
    optional string modelName = 71;
    optional uint32 TxPER = 72;
    optional string authMethod = 73;
    repeated ttcData clientTTC = 74;
    repeated sessDeauthData sessDeauthTime = 75;
    optional int32 WiFi6Cap = 76;
}

message HccdConnMessage {
    optional uint64 timestamp = 1;
    optional int32 message_id = 2;
    optional int32 source = 3;
    optional int32 destination = 4;
    optional int32 status_code = 5;
}

message HccdClientConnection {
    optional string client_mac = 1;
    optional uint64 timestamp = 2;
    optional int32 connection_status = 3;
    /* remove client_sm_map */
    optional int32 failed_msg_id = 5;
    repeated HccdConnMessage hccdConnMessages = 6;
    optional uint32 wlan_id = 7;
    optional uint32 radio_id = 8;
        optional string ssid = 9;
        optional string wlanType = 10;
        optional float snr = 11;
        optional int32 failure_type = 12;
    optional int32 vlan = 13;
        optional int32 reason_code = 14;
        optional string info = 15;
}

message APReportBin {
    required int32 bin = 1;
    optional int32 uptime_r = 2;
}

message APFirewallProfileStats {
    optional string firewallProfileId = 1;
    optional string firewallProfileName = 2;
    optional uint64 firewallProfileHitCount = 3;
    optional string l2AclPolicyId = 4;
    optional uint64 l2AclPolicyHitCount = 5;
    optional string l3AclPolicyId = 6;
    optional uint64 l3AclPolicyHitCount = 7;
    optional string devicePolicyId = 8;
    optional uint64 devicePolicyHitCount = 9;
    optional string avcPolicyId = 10;
    optional uint64 avcPolicyHitCount = 11;
    optional string urlFilteringId = 12;
    optional uint64 urlFilteringHitCount = 13;
}

message APReportStats {
    required uint32 version = 1;
    optional string ap = 2;
    optional uint64 timestamp = 3;
    optional uint64 seqNumber = 4;
    optional string zone_id = 5;
    repeated APReportBin binCount = 6;
    repeated APReportBinClient binClient = 7;
    repeated APReportBinIPSec binIPSec = 8;
    repeated APReportBinTunnel binTunnel = 9;
    repeated APReportBinRadio binRadio = 10;
    optional string deviceName = 11;
    optional string apgroup_id = 12;
    optional string cluster_id = 13;
    optional string domain_id = 14;
    optional string aptenant_id = 15;
    optional string map_id = 16;
    optional string aptenant_name = 17;
    optional string zone_name = 18;
    optional string apgroup_name = 19;
    optional string domain_name = 20;
    optional uint64 sampleTime = 21;
    optional uint32 aggregationInterval = 22;
    optional string apIpAddress = 23;
    optional string apIpv6Address = 24;
    repeated HccdClientConnection hccdClientConnections = 25;
				optional bool isMonitoringEnabled = 29;
    repeated APFirewallProfileStats firewallProfileStats = 30;  
    optional string apRadioDeploy = 31;
    optional AttributeMap ideal_stats_required = 32;
    optional uint64 rflowMaxCount = 33;
    optional uint32 ap2apConnAttempt = 34;
    optional uint32 ap2apConnFailed = 35;    
    optional uint32 ap2apConnSuccess = 36;
    optional uint32 ap2apConnDisconnet = 37;
    optional uint32 ap2apConnRxMsgs = 38;
    optional uint32 ap2apConnRxBytes = 39;
    optional uint32 ap2apConnTxMsgs = 40;
    optional uint32 ap2apConnTxBytes = 41;

}

Field Description

AP Report Per Dns Server Information

Attribute Name

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

Description

ipAddress string snapshot NULL DNS IP address
req_cnt uint64 snapshot NULL DNS Request Counter
resp_cnt uint64 snapshot NULL DNS Response Counter

AP Report Dns Stats Information

Attribute Name

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

Description

ipsecSessionTime uint32 snapshot NULL DNS Server Count per wlan
ipsecTxPkts .APReportPerDnsServer snapshot MAXNULL Per DNS Server Statistics

AP Report Bin WLAN Information

Attribute Name

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

Description

ap_mac string snapshot NULL MAC address of the AP
time uint64_t snapshot NULL First sample time in this bin. The AP samples stats every 90 seconds internally, when AP boots up. So if AP boots up at 10:08:00, then AP gets stats at 10:09:30, 10:11:00, 10:12:30, 10:14:00, 10:15:30. So the time is 10:09:30 in Bin (10:00~10:15), and the time is 10:15:30 in Bin (10:15~10:30)
binStartTime uint64 snapshot NULL Bin start time. The start timestamp of each Bin. For example it is 00:00:00 in Bin1 (00:00~00:15), and it is 00:15:00 in Bin2(00:15~00:30)...
80211RadioMode string snapshot NULL Radio mode used by the AP
mode string snapshot NULL Radio mode used by the AP
channel int snapshot NULL Radio channel used by the AP
ssid string snapshot NULL SSID of the WLAN
bssid string snapshot NULL BSSID of the WLAN
wsgWlanId int snapshot NULL WLAN ID assigned by the controller
wlanId int snapshot NULL WLAN interface ID
maxNumClients uint32 snapshot MAX Highest number of clients during this sampling period
minNumClients uint32 snapshot MIN Lowest number of clients during this sampling period
avgNumClients int snapshot AVG Average number of clients during this sampling period
rxBytes_r uint64 delta SUM Total size of data and management packets received
rxFrames_r uint64 delta SUM Total size of data and management frames received
txFrames_r uint64 delta SUM Total size of data and management frames transmitted
txFail_r uint64 snapshot SUM Total number of Tx errors
rxRateKbps uint64 delta SUM Rx rate
txRateKbps uint64 delta SUM Tx rate
newAssoc uint32 Delta AVG Number of new client associations during this sampling period
failedAssoc uint32 Delta SUM Failed associate number in bin period
rxFail_r uint32 snapshot SUM No space in Linux buffers
peakRx_r uint64 Delta SUM Total delta bytes in one din period for RX data and mgmt. frame
peakTx_r uint64 Delta SUM Total delta bytes in one din period for TX data and mgmt.frame
rxDataFrames_r uint64 snapshot SUM Accumulate Rx packet number
rxDataBytes_r uint64 snapshot SUM Accumulate Rx data bytes
rxMgmtFrames_r uint64 snapshot SUM Accumulate Rx packet number
rxMgmtBytes_r uint64 snapshot SUM Accumulate Rx mgmt. bytes
txDataFrames_r uint64 snapshot SUM Accumulate Tx packet number
txDataBytes_r uint64 snapshot SUM Accumulate Tx data bytes
txMgmtFrames_r uint64 snapshot SUM Accumulate Tx packet number
txMgmtBytes_r uint64 snapshot SUM Accumulate Tx mgmt. bytes
rxBcastFrames_r uint64 snapshot SUM Broadcast packets received
rxMcastFrames_r uint64 snapshot SUM Multicast packets received
rxUcastFrames_r uint64 snapshot SUM Received data packets that does not include bcast and multicast
txBcastFrames_r uint64 snapshot SUM Broadcast packets transmitted
txMcastFrames_r uint64 snapshot SUM Multicast packets transmitted
txUcastFrames_r uint64 snapshot SUM Transmit data packets that does not include bcast and multicast
txDropDataFrames_r uint64 snapshot SUM Tx data frames that are dropped or dropped by MQ
txDropMgmtFrames_r uint64 snapshot SUM Total Tx data frames dropped (or dropped by MQ. In AP internal design, it has a messages queue (MQ)to queue all packets that AP plans to forward to clients. Then AP transmit packets to clients as per the priority scheduling. The MQ is Ruckus proprietary internal design.
wlangroup_id string snapshot NULL WLAN Group identifier.
wlantenant_id string snapshot NULL WLAN tenant identifier.
wlangroup_name string snapshot NULL WLAN Group name.
wlantenant_name string snapshot NULL WLAN tenant name.
wlaneName string snapshot NULL WLAN name.
authFailureCount uint32 Delta SUM 802.11 authentication failure count on WLAN (delta value)
authSuccessCount uint32 Delta SUM 802.11 authentication success count on WLAN (delta value)
assocFailureCount uint32   SUM 802.11 association failure count on WLAN (delta value)
assocSuccessCount uint32 Delta SUM 802.11 association success count on WLAN (delta value)
eapFailureCount uint32 Delta SUM EAP authentication failure count on WLAN (delta value)
eapSuccessCount uint32 Delta SUM EAP authentication success count on WLAN (delta value)
radiusFailureCount uint32 Delta SUM Radio failure count on WLAN (delta value)
radiusSuccessCount uint32 Delta SUM Radio success count on WLAN (delta value)
dhcpFailureCount uint32 Delta SUM DHCP failure count on WLAN (delta value)
dhcpSuccessCount uint32 Delta SUM DHCP success count on WLAN (delta value)
staSmartRoamDisconCnt uint32 Delta SUM Client disconnect count with smart-roaming reason
staIdleDisconCnt uint32 Delta SUM Client disconnect count with idle reason
staLeaveDisconCnt uint32 Delta SUM Client disconnect count with client active leave bss reason
staInvalidDisconCnt uint32 Delta SUM Client disconnect count with client's invalid frame contents reason
staRadioFailDisconCnt uint32 Delta SUM Client disconnect count with AP radio related reason
staAPKickDisconCnt uint32 Delta SUM Client disconnect count with AP active kick out reason
rxDataBytesSplitTunnel uint64 snapshot SUM Split-tunnel total data Bytes received
txDataBytesSplitTunnel uint64 snapshot SUM Split-tunnel total data Bytes transmitted
rxDataFramesSplitTunnel uint64 snapshot SUM Split-tunnel total data-frames received
txDataFramesSplitTunnel uint64 snapshot SUM Split-tunnel total data-frames transmitted
dnsStats .APReportDnsStats snapshot NULL DNS statistics
roamingFailureCount uint32 Delta SUM roaming faliure count on wlan(delta value)
L3authFailureCount uint32 Delta SUM L3 auth faliure count on wlan(delta value)
L3authSuccessCount uint32 Delta SUM L3 auth success count on wlan(delta value)
roamingSuccessCount uint32 Delta SUM Roaming Success count on wlan(delta value)
arpPktCount uint32 Delta SUM Roaming Success count on wlan(delta value)
ideal_stats_wlan_required AttributeMapWlan snapshot NULL Ideal stats wlan required for ACX APs
probe_dropped uint32 Delta SUM Probes dropped due to RSSI/SNR/PPS/ATD/TCM Threshold features
auth_dropped uint32 Delta SUM duth reqs dropped due to RSSI/SNR/PPS/ATD/TCM Threshold features
btm_requests uint32 Delta SUM 11v BTM requests sent by AP for 11v Steering features (CLB, BB, SROAM)
sta_kickouts uint32 Delta SUM STA Kicked due to Smart Roam Algorithm
rx_num_probe_filt uint32 Delta SUM Probes dropped due to Smart Roam Algorithm
rx_num_auth_filt uint32 Delta SUM Auth requests dropped due to Smart Roam Algorithm
connectionANQPSuccessCount uint32 Snapshot NULL ANQP response success count
connectionANQPFailureCount uint32 Snapshot NULL ANQP request success count - ANQP response success count

AP Report Bin Radio Information

Attribute Name

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

Description

airtime uint32 snapshot AVG Exponential average of total channel utilization
airtimeB uint32 snapshot AVG Exponential average percentage of channel busy time
airtimeRx uint32 snapshot AVG Exponential average of channel availability for receiving
airtimeTx uint32 snapshot AVG Exponential average of channel availability for transmitting
phyError uint32 snapshot SUM Accumulated number of Rx physical errors
rxBytes_r uint64 Delta SUM Total data bytes received on radio
txBytes_r uint64 Delta SUM Total data bytes transmitted on radio
rxFrames_r uint64 Delta SUM Total number of data frames received
txFrames_r uint64 Delta SUM Total number of data frames transmitted
noiseFloor int snapshot AVG Last recorded noise floor
radioId uint32 snapshot snapshot Radio ID (0: 2.4G 1: 5G)
binWlan .APReportBinWlan Serialization snapshot Serialization data for all of wlan information
txRatebps uint64 Delta AVG Radio average transmission rate
retry uint64 SUM NULL Number of transmission retries
latency uint32 snapshot SUM The time taken by a packet from Ethernet ingress to Radio egress or Tx complete
capacity uint32 snapshot SUM The saturated throughput estimate of a link
connectionFailure float snapshot SUM The rate of client connection failure
connectionAuthFailureCount uint32 Delta SUM 802.11 authentication failure count on radio (delta value)
connectionAssocFailureCount uint32 Delta SUM 802.11 association failure count on radio (delta value)
connectionTotalCount uint32 Delta SUM total client connection on radio, include success and failure counts(delta value)
connectionAuthSuccessCount uint32 Delta SUM 802.11 authentication success count on radio (delta value)
connectionAssocSuccessCount uint32 Delta SUM 802.11 association success count on radio (delta value)
connectionEAPFailureCount uint32 Delta SUM EAP authentication failure count on radio (delta value)
connectionEAPSuccessCount uint32 Delta SUM EAP authentication success count on radio (delta value)
connectionRadiusFailureCount uint32 Delta SUM Radio failure count on radio (delta value)
connectionRadiusSuccessCount uint32 Delta SUM Radio success count on radio (delta value)
connectionDHCPFailureCount uint32 Delta SUM DHCP failure count on radio (delta value)
connectionDHCPSuccessCount uint32 Delta SUM DHCP success count on radio (delta value)
connectionTotalSuccess uint32 Delta SUM Total count for success connection (delta value)
connectionTotalFailure uint32 Delta SUM Total count for failure connection (delta value)
txRatebps uint64 Delta AVG Radio average transmission rate
histogramClientTTC uint64 Delta NULL Client TTC histogram data count on radio
medianTxRadioMCSRate uint32 Delta NULL Radio median TX MCS rate in this bin
connectionL3AuthFailureCount uint32 Delta SUM L3 auth failure count on radio (delta value)
connectionL3AuthSuccessCount uint32 Delta SUM L3 auth success count on radio (delta value)
TxPER uint32 Delta NULL Radio Tx Packet Error Rate in this bin
txRetryRate Float Delta NULL Radio Tx retry Rate in this bin

AP Report Bin Tunnel Information

Attribute Name

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

Description

gw string snapshot NULL Tunnel gateway address list
index int snapshot NULL Current tunnel index
isActive int snapshot NULL Current tunnel state (active or inactive)
cICMP uint64 snapshot MAX Number of keepalive packets sent
cNonICMP uint64 snapshot MAX Number of keepalive packets lost
cDisconnect uint64 snapshot MAX Number of SoftGRE sessions terminated
rxBytes uint64 snapshot SUM Total bytes received
rxPkts uint64 snapshot SUM Total packets received
rxDropPkts uint64 snapshot SUM No space in Linux buffers (frame equal to packet). The AP received a frame completely, and AP has to allocate a memory for this frame. Then pass to next handler who is interested in this frame. The AP drops the frame if it has not enough memory. The counter is plus one if this case happen.
rxErrPkts uint64 snapshot SUM Number of bad packets received
txBytes uint64 snapshot SUM Total bytes transmitted
txPkts uint64 snapshot SUM Total packets transmitted
txDropPkts uint64 snapshot SUM No space available in Linux. AP has to allocate a memory to store the packet that AP plans to transmit to client. The AP may drop it if AP has not enough memory.Then the counter is plus one.
txErrPkts uint64 snapshot SUM Packet transmit problems. The AP plans to transmit packet to client. But somehow AP can't transmit to client successfully, and AP drops the packets at the end. Then the counter is plus one.
txFragPkts uint64 snapshot SUM Total fragmented Tx packets
type int snapshot NULL Tunnel type:

0: rks_gre

1: soft_gre

apIPAddress string snapshot NULL AP IP address

AP Report Bin IPSec Information

Name Value Description
RUCKUSGRE 0 Tunnel type possible value
SOFTGRE 1 Tunnel type possible value

AP Report Bin IPSec Information

Attribute Name

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

Description

ipsecSessionTime uint64 snapshot MAX Session time
ipsecTxPkts uint64 snapshot MAX Total packets transmitted
ipsecRxPkts uint64 snapshot MAX Total packets received
ipsecTxBytes uint64 snapshot MAX Total bytes transmitted
ipsecRxBytes uint64 snapshot MAX Total bytes received
ipsecTxDropPkts uint64 snapshot MAX Total Tx packets dropped
ipsecRxDropPkts uint64 snapshot MAX Total Rx packets dropped
ipsecTxIdleTime uint64 snapshot MAX Tx idle time
ipsecRxIdleTime uint64 snapshot MAX Rx idle time
apIPAddress string snapshot NULL AP IP address
gw string snapshot NULL Tunnel gateway address list
ipsecTunnelType .APReportBinIPSec.IPsecTunnelType snapshot NULL Tunnel type: (0: rks_gre 1: soft_gre)

ttcData Information

Attribute Name

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

Description

sessionId string snapshot NULL Session ID string
multiSessionId string snapshot NULL Multi-session ID string
isRoaming bool snapshot NULL Roaming session or not
clientAuthTTC unti64 snapshot NULL Client auth TTC latest value in this bin.
clientAssocTTC unti64 snapshot NULL Client assoc TTC latest value in this bin.
clientEapTTC unti64 snapshot NULL Client EAP TTC latest value in this bin.
clientRadiusTTC unti64 snapshot NULL Client Radius TTC latest value in this bin.
clientDhcpTTC unti64 snapshot NULL Client DHCP TTC latest value in this bin.
isDHCPrenewSess BOOL snapshot NULL Is dhcp renew session

Sess Deauth Data Information

Attribute Name

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

Description

sessionId string snapshot NULL Session ID string.
multiSessionId string snapshot NULL Multi-sesson ID string.
disconnectTime unti64 snapshot NULL Date and time client was disconnected.

AP Report Bin Client Information

Attribute Name

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

Description

ap string snapshot NULL MAC address of the AP
time uint64 snapshot NULL Timestamp for data sampling time
binStartTime uint64 snapshot NULL Bin start time The start timestamp of each Bin. For example it is 00:00:00 in Bin1 (00:00~00:15), and it is 00:15:00in Bin2 (00:15~00:30)...
radioMode string snapshot NULL Radio mode that is used by this client connection
ap80211RadioMode string snapshot NULL Radio mode used by the AP. Possible values are "b", "b/g", "b/g/n", "g", "g/n", "a", "a/n", "a/n/ac", "n", "n/ac" , "ac"
auth string snapshot NULL Authorization mode used by the AP xxx what are the possible values?
encryption string snapshot NULL Encryption method used by the AP
clientMac string snapshot NULL MAC address of the client
bssid string snapshot NULL BSSID
ssid string snapshot NULL SSID
username string snapshot NULL User name
clientIP string snapshot NULL IP address assigned to the client
clientVlan uint64 snapshot NULL VLAN ID used by the client
osType string snapshot NULL Operating system used by the client
hostname string snapshot NULL Host name of the client
channel int snapshot NULL Current radio channel
channelWidth uint32 snapshot NULL Channel width used by the WLAN
rssi int snapshot AVG Last recorded RSSI/SNR
maxRssi int snapshot MAX Highest RSSI ever recorded
minRssi int snapshot MIN Lowest RSSI ever recorded
firstRssi int snapshot AVG Initial RSSI recorded
receiveSignalStrength int snapshot AVG Last received signal strength
firstReceiveSignalStrength int snapshot MAX Initial received signal strength
maxReceiveSignalStrength int snapshot MIN Highest received signal strength
minReceiveSignalStrength int snapshot AVG Lowest received signal strength
noiseFloor int snapshot AVG Last recorded noise floor
location int snapshot NULL Location of the AP
rxBytes_r uint64 delta SUM Total bytes received
txBytes_r uint64 delta SUM Total bytes transmitted
rxFrames_r uint64 delta SUM Data frames received
txFrames_r uint64 delta SUM Data frames transmitted
throughputEst uint64 delta SUM Average of non-zero throughput estimate avg_throughput_estimate = sum__throughput_estimate/count_non_zero_throughput_estimate For example AP has client's throughput estimation of 10Mbps, 9Mbps, 9Mbps, 10Mbps, 0, 0, 0, 0, 0, 0 . Then AP come out (10+9+9+10)/4 = 9.5Mbps for throughput Est.
firstSampleTime uint64 snapshot NULL First sample time in this bin. The AP samples stats every 90 seconds internally, when AP boots up. So if AP boots up at 10:08:00. Then AP gets stats at 10:09:30, 10:11:00, 10:12:30, 10:14:00, 10:15:30. So the time is 10:09:30in Bin(10:00~10:15), and the time is10:15:30 in Bin(10:15~10:30)
txDropMgmtFrames_r uint64 snapshot SUM Total Tx data frames dropped (or dropped by MQ. In AP internal design,it has a messages queue (MQ) to queue all packets that AP plans to forward to clients. Then AP transmit packets to clients as per the priority/scheduling/… The MQ is Ruckus proprietary internal design.
txDropDataFrames_r uint64 snapshot SUM Total Tx management frames dropped (or dropped by MQ. In AP internal design, it has a messages queue (MQ)to queue all packets that AP plans to forward to clients. Then AP transmit packets to clients as per the priority/scheduling/… The MQ is Ruckus proprietary internal design.
rxCRCErrFrames_r uint64 snapshot SUM CRC error for Rx data frame. Each 802.11 frame has 4 bytes FCS at tail. The AP recalculate the value when it received a frame completely. Then compare to the FCS in the frame. AP drops the frame if they are different. Then counter plus 1.
sessionId sting snapshot NULL Session ID string
multiSessionId sting snapshot NULL Multi-session ID string
firstConnection uint64 snapshot NULL Date and time of initial connection
firstAuth uint64 snapshot NULL Date and time of initial authorization
ipAssignTime uint64 snapshot NULL Date and time client IP address was assigned
disconnectTime uint64 snapshot NULL Date and time client was disconnected
sessionTime uint64 snapshot NULL Duration of client session
radioId uint32 snapshot NULL Radio interface identifier (0: 2.4G, 1 5G)
wsgWlanId int snapshot NULL WLAN ID assigned by the controller
wlangroup_id string snapshot NULL WLAN Group identifier
wlangroup_name string snapshot NULL WLAN Group name
disconnectReason uint64 snapshot NULL Reason for disconnect from the controller.
wlanName string snapshot NULL WLAN name
wlantenant_id string snapshot NULL WLAN tenant identifier
wlantenant_name string snapshot NULL WLAN tenant name
rxBytes uint64 snapshot SUM Total data bytes received for this client
txBytes uint64 snapshot SUM Total data bytes transmitted by this client
rxRatebps uint64 snapshot AVG Client receiving data rate in bin period
txRatebps uint64 snapshot AVG Client transmitted data rate in bin period
bandCap int32 snapshot NULL Client radio band support capability (2.4G/5G/both)
vHTCap int32 snapshot NULL Client HT/VHT capability (non-HT/HT/VHT)
streamCap int32 snapshot NULL Client STBC capability
BTMCap int32 snapshot NULL Client BTM capability
medianTxMCSRate uint32 delta NULL Client median TX MCS rate in this bin
medianRxMCSRate uint32 delta NULL Client median RX MCS rate in this bin
clientAuthTTC uint64 snapshot NULL Client auth TTC latest value in this bin
clientAssocTTC uint64 snapshot NULL Client assoc TTC latest value in this bin
clientEapTTC uint64 snapshot NULL Client EAP TTC latest value in this bin
clientRadiusTTC uint64 snapshot NULL Client Radius TTC latest value in this bin
clientDhcpTTC uint64 snapshot NULL Client DHCP TTC latest value in this bin
roamingFailureCount uint32 delta SUM Roaming faliure count for client(delta value)
roamingSuccessCount uint32 delta SUM Roaming success count on client(delta value)
deviceType int32 snapshot NULL Client device type, such as Laptop, Smartphones, Tablets etc.
osVendorType int32 snapshot NULL Client OSVendor type, such as Windows, Android, Apple etc.
modelName string snapshot NULL Client's device model name, such as Windows 7, Mac OS X etc.
TxPER string delta NULL Client TX Packet Error Rate in this bin
authMethod string None None None
clientTTC ttcData snapshot NULL Multiple client sesssion TTC data
sessDeauthTime sessDeauthData snapshot NULL Multiple client sesssion deauth time
WiFi6Cap int32 snapshot NULL Client WiFi6 Capability
STACap int32 snapshot NULL WiFi Client Capability

Hccd Connection Message Information

Attribute Name

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

Description

timestamp uint64 snapshot NULL The time for each message(packet) observed
message_id int32 snapshot NULL Message identity for each packet
source int32 snapshot NULL Message(packet) source module (like as client, AP, Cblade,...etc)
destination int32 snapshot NULL Message(packet) destination module
status_code int32 snapshot NULL Message status (success or failure)

Hccd Client Connection Message Information

Attribute Name

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

Description

client_mac string snapshot NULL Client mac for each connection
timestamp uint64 snapshot NULL The time that each connection started
connection_status int32 snapshot NULL This connection session status - success or failure
failed_msg_id int32 snapshot NULL The failure message identifier for this connection
hccdConnMessages .HccdConnMessage Serialization NULL Serialization data for all of message ID in this client session
wlan_id uint32 snapshot NULL WLAN identifier for this client association
radio_id uint32 snapshot NULL Radio identifier for this client association
ssid string snapshot NULL SSID for this client association
wlanType string snapshot NULL WLAN type used
failure_type int32 snapshot NULL Category for the connection failure (auth/assoc/eap/radius/dhcp failure)
vlan int32 snapshot NULL VLAN identifier value for this client
reason_code int32 snapshot NULL Reason code for disconnection
info string snapshot NULL Reason for disconnect

AP Report Bin Information

Attribute Name

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

Description

bin int snapshot NULL Bin data number xxx AP divides 24 hours into 96 bins, - 1 bin is 15 minutes.Bin1 time period is 00:00~00:15, Bin2 time period is 00:15~00:30 and so on. It is a number from 1 to 96.Then one can see the stats time period according to this value.
uptime_r int snapshot NULL Uptime in one report duration Example: AP boots up at 10:08, so the uptime_r is 420 seconds(10:15 - 10:08) in Bin (10:00~10:15). If AP keeps work well, and now is 11:02, then uptime_r is 900 seconds in Bin (10:45~11:00)

AP Firewall Profile Stats Information

Attribute Name

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

Description

firewallProfileId string snapshot NULL Firewall profile identifier
firewallProfileName string snapshot NULL Firewall profile name
firewallProfileHitCount uint64 delta SUM Firewall profile hit count
l2AclPolicyId string snapshot NULL L2 ACL policy identifier
l2AclPolicyHitCount uint64 delta SUM L2 ACL policy hit count
l3AclPolicyId string snapshot NULL L3 ACL policy identifier
l3AclPolicyHitCount uint64 delta SUM L3 ACL policy hit count
devicePolicyId string snapshot NULL Device policy identifier
devicePolicyHitCount uint64 delta SUM Device policy hit count
avcPolicyId string snapshot NULL AVC policy identifier
avcPolicyHitCount uint64 delta SUM AVC policy hit count
urlFilteringId string snapshot NULL Url filtering policy identifier
urlFilteringHitCount uint64 delta SUM Url filtering policy hit count

AP Report Stats Information

Attribute Name

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

Description

version uint32 snapshot NULL GPB version
ap string snapshot NULL AP MAC address
timestamp uint64 snapshot NULL Timestamp for this report
seqNumber uint64 snapshot NULL Sequence record number for AP report.
zone_id string snapshot NULL Zone UUID
binCount Struct APReportBin Serialization NULL Total number of bin data.
binClient Struct APReportBinClient Serialization NULL Total number of Client bin data.
binIPSec Struct APReportBinIPSec Serialization NULL The number of IPSec tunnel.
binTunnel Struct APReportBinTunnel Serialization NULL The number of tunnel data.
binRadio Struct APReportBinRadio Serialization NULL The number of radio data.
deviceName string snapshot NULL AP devices configured by the administrator.
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 The timestamp for sampling stats data
aggregationInterval uint32 snapshot NULL The interval time to aggregate stats together
apIpAddress string snapshot NULL IP address of the AP
apIpv6Address string snapshot NULL IPv6 address of the AP
hccdClientConnections .HccdClientConnection Serialization NULL Serialization data for HCCD connection data
HeartbeatLatency float snapshot AVG Average latency that is measured by heartbeat lost
PingLatency float snapshot AVG Average latency that is measured by ping
PingLossCount uint32 snapshot NULL Count for ping lost
isMonitoringEnabled BOOL snapshot NULL Is a monitoring AP or not
firewallProfileStats APFirewallProfileStats snapshot NULL Firewall Profile Stats.
apRadioDeploy string snapshot NULL Indicate AP all radio band deploy
ideal_stats_required AttributeMap      
rflowMaxCount TYPE_UINT64 snapshot NULL Report max-rflow count
ap2apConnAttempt uint32 snapshot NULL Report matrix on the number of connection attempts
ap2apConnFailed uint32 snapshot NULL Report matrix on the number of failed connections.
ap2apConnSuccess uint32 snapshot NULL Report matrix on the number of successful connections.
ap2apConnDisconnet uint32 snapshot NULL Report matrix on the number of disconnected connections.
ap2apConnRxMsgs uint32 snapshot NULL Report matrix on the number of recieved messages.
ap2apConnRxBytes uint32 snapshot NULL Report matrix on the number of recieved bytes.
ap2apConnTxMsgs uint32 snapshot NULL Report matrix on the number of transmitted messages.
ap2apConnTxBytes uint32 snapshot NULL Report matrix on the number of transmitted bytes.