ap_hccd_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";
import "nanopb.proto";

message ApHccdClientReportConnection {
    optional string client_mac = 1;
    optional uint64 timestamp = 2;
    optional int32 connection_status = 3;
    optional int32 failed_msg_id = 4;
    repeated int32 message_ids = 5;
    optional uint32 wlan_id = 6;
    optional uint32 radio_id = 7;
    optional string ssid = 8;
    optional string wlanType = 9;
    optional float snr = 10;
    optional int32 failure_type = 11;
    optional int32 vlan = 12;
    optional int32 reason_code = 13;
    optional string info = 14;
    optional uint64 TT = 15;
    optional int32 isRoaming = 16;
    optional string pktCapName = 17;
    optional string mld_addr = 18;
    optional int32 terminated_reason = 19;
    optional string wlan_encryption = 20;

}

message ApHccdReportMessage {
    optional uint32 version = 1;
    optional string ap_mac = 2;
    optional uint64 timestamp = 3;
    optional uint64 seqNumber = 4;
    optional string zone_id = 5;
    optional string apgroup_id = 6;
    optional string cluster_id = 7;
    optional string domain_id = 8;
    optional string aptenant_id = 9;
    optional string map_id = 10;
    optional string deviceName = 11;
    optional string aptenant_name = 12;
    optional string zone_name = 13;
    optional string apgroup_name = 14;
    optional string domain_name = 15;
    optional uint64 sampleTime = 16;
    optional uint32 aggregationInterval = 17;
    optional string apIpAddress = 18;
    optional string apIpv6Address = 19;
    repeated ApHccdClientReportConnection apHccdClients = 20 [(nanopb).type = FT_POINTER];
    optional string apRadioDeploy = 21;
}

Field Description

AP HCCD Client Report Connection information

Attribute Name

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

Description

client_mac string snapshot NULL Client MAC address
timestamp uint64 snapshot NULL Timestamp for starting to record this client session
connection_status int32 snapshot NULL Client session connection status (success or failure)
failed_msg_id int32 snapshot NULL Message ID to indicate what failures step in whole connection
message_ids int32 Serialization NULL A sequence of message ID are recorded for this client session
wlan_id uint32 snapshot NULL WLAN Id that is connected by client
radio_id uint32 snapshot NULL Radio Id that is connected by client
ssid string snapshot NULL SSID that is connected by client
failure_type uint32 snapshot NULL Classify this failure client session belong to which failure case (auth, assoc, eap, radio, dhcp)
vlan uint32 snapshot NULL Vlan ID is used by client
reason_code uint32 snapshot NULL Reason code for deauth/disassoc frame
info string snapshot NULL Client session disconnection description
TTF uint64 snapshot NULL Time spent for this failure connection
isRoaming int32 snapshot NULL Flag to indicate this connection session is roaming or new join
pktCapName string snapshot NULL CCD packet capture file name
mld_addr string snapshot NULL mld mac address of the MLO client
terminated_reason int32 snapshot NULL add terminated reason for RAI

wlan_encryption

string snapshot NULL wlan encryption type

AP HCCD Report information

Attribute Name

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

Description

version uint32 snapshot NULL AP HCCD version
ap_mac string snapshot NULL AP MAC address
timestamp uint64 snapshot NULL Timestamp to generate this stats report
seqNumber uint64 snapshot NULL Sequence number to identify this stats report
zone_id string snapshot NULL Zone UUID
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
deviceName string snapshot NULL AP device name
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 report
aggregationInterval uint32 snapshot NULL Interval time for aggregating stats data
apIpAddress string snapshot NULL AP IPv4 address
apIpv6Address string snapshot NULL AP IPv6 address
apHccdClients .ApHccdClientReportConnection Serialization NULL Serialization data for failure client session record
apRadioDeploy string snapshot NULL Indicate AP all radio band deploy