ap_client.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 APClientInfo {
    required string clientMac = 1; 
    optional string ipAddress = 2; 
    optional string ipv6Address = 3; 
    optional int32 wlanId = 4; 
    optional int32 rssi = 5;
    optional int32 receiveSignalStrength = 6; 
    optional int32 noiseFloor = 7;
    optional int32 vlan = 8; 
    optional uint64 rxFrames = 9; 
    optional uint64 rxBytes = 10; 
    optional uint64 txFrames = 11; 
    optional uint64 txBytes	= 12;
    optional uint64 txMgmtFrames = 13; 
    optional uint64 rxMgmtFrames = 14; 
    optional uint32 throughputEst = 15; 
    optional uint64 txDropDataFrames = 16; 
    optional uint64 txDropMgmtFrames = 17; 
    optional uint32 rxCRCErrFrames = 18; 
    optional uint32 txRetry = 19;
    optional string osType = 20; 
    optional APClientRadio radio = 21;
        message TCWithQuota {
                optional string tcName = 1;
                optional string tcMaxQuota = 2;
                optional string tcRemainingQuota =3;
        }
 repeated TCWithQuota tcWithQuota = 22;
	optional string cpeMac = 23;
	optional uint32 stickyWeak = 24;
	optional int32 deviceType = 25;
	optional int32 osVendorType = 26;
	optional string modelName = 27;
	optional string hostname = 28;
	optional uint32 medianTxMCSRate = 29;
	optional uint32 medianRxMCSRate = 30;
	optional string default_gateway = 31;
	optional string dhcp_server_ip = 32;
	optional string subnet_mask = 33;
	optional string dns_server_list = 34;
    optional string mlo_capability = 35;
    optional string mlo_links = 36;
    optional string mld_addr = 37;
    optional bool active_link = 38;


    /* jump to index 1000, for new requirement from SNMP and SCI */
    optional string ConnectMode = 1001; 
    optional string Username = 1002; 
    optional string SessionId = 1003;
    optional string MultipleSessionId = 1004; 
    optional string AuthMode = 1005;
    optional uint64 DiscTimestamp = 1006; 
    optional uint32 RxByteRate = 1007; 
    optional uint32 TxByteRate = 1008; 
    optional uint32 RxAvgByteRate = 1009; 
    optional uint32 TxAvgByteRate = 1010; 
    optional uint32 RxError = 1011; 
    optional uint32 TxError = 1012; 
    optional uint32 ReassocCount = 1013; 
    optional uint32 TxRetryBytes = 1014; 
    optional uint32 RxDropPkts = 1015;
    optional int32 vni = 1016;
    optional uint32 authStatus = 1017;
    optional string authMethod = 1018;
    optional string encryption = 1019;
    optional uint32 disconnectReason = 1020;
}

message APClientWlan { 
    required string ssid = 1;
    optional string bssid = 2; 
    optional int32 vlan = 3; 
    optional int32 wsgWlanId = 4; 
    optional int32 wlanId = 5;
    optional string wlangroup_id = 6; 
    optional string wlantenant_id = 7; 
    optional string wlangroup_name = 8; 
    optional string wlantenant_name = 9;
}
message APClientRadio {
    required int32 radioId = 1; 
    optional string mode = 2; 
    optional string radioMode = 3; 
    optional int32 channel = 4; 
    optional uint32 channelWidth = 5; 
    optional APClientWlan wlan = 6;
}
message APClientStats {
    required uint32 version = 1; 
    optional string ap = 2; 
    optional uint64 timestamp = 3; 
    optional uint64 seqNumber = 4; 
    optional string zone_id = 5;
    repeated APClientInfo clients = 6; 
    optional string apgroup_id = 7; 
    optional string cluster_id = 8; 
    optional string domain_id = 9; 
    optional string aptenant_id = 10; 
    optional string map_id = 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 deviceName = 18;
    optional string serialNumber = 19;
    optional string apRadioDeploy = 20;
}

Field Description

AP Client information

Attribute Name

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

Description

clientMac string snapshot NULL MAC address of the client
ipAddress string snapshot NULL IP address of the client
ipv6Address string snapshot NULL IPv6 address of the AP
wlanId int snapshot NULL WLAN interface ID
rssi int snapshot AVG Last recorded RSSI/SNR
receiveSignalStrength int snapshot AVG Last recorded signal strength received.
noiseFloor int snapshot AVG Last recorded noise floor
vlan uint64 snapshot NULL Client VLAN ID
rxFrames uint64 delta SUM Data frames received
rxBytes uint64 delta SUM Data count received (in bytes)
txFrames uint64 delta SUM Data frames transmitted
txBytes uint64 delta SUM Data count transmitted (in bytes)
txMgmtFrames uint64 snapshot SUM Accumulated number of transmitted packets
rxMgmtFrames uint64 snapshot SUM Accumulated number of received packets
throughputEst uint32 snapshot AVG Current throughput
txDropDataFrames 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. The AP transmit packets to clients according to the priority and scheduling. The MQ is Ruckus proprietary.
txDropMgmtFrames uint64 snapshot SUM Total transaction management frames dropped (or dropped by MQ)
rxCRCErrFrames uint32 snapshot SUM Number of Rx frames with CRC errors
txRetry uint32 snapshot SUM Number of retried frames
osType string snapshot NULL Client OS type,such as Windows7/Vista, Android.
radio .APClientRadio serialization NULL Radio information
tcWithQuota .APClientInfo.TCWithQuota serialization NULL Traffic class stats per client
cpeMac string snapshot NULL MAC address for the client connected behind CPE
stickyWeak unit32 snapshot NULL Client is sticky/weak client
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
hostname string snapshot NULL Client hostname
medianTxMCSRate unit32 snapshot NULL Client median TX MCS rate
medianRxMCSRate unit32 snapshot NULL Client median RX MCS rate
default_gateway string snapshot NULL Default gateway of the client
dhcp_server_ip string snapshot NULL DHCP server ip address of the client
subnet_mask string snapshot NULL Subnet mask of the client
dns_server_list string snapshot NULL DNS server list of the client
mlo_capability string snapshot NULL Client capabilities of Multi Link Operation like EMLSR or EMLMR
mlo_links string snapshot NULL Client link of Multi Link Operation
mld_addr string snapshot NULL Client MLD Mac address
active_link bool snapshot NULL MLO Client Active link
ConnectMode string snapshot NULL Client wireless connection mode.
Username string snapshot NULL Client authorization username.
SessionId string snapshot NULL Client accounting session ID.
MultipleSessionId string snapshot NULL Client accounting multiple session ID.
AuthMode string snapshot NULL Client authentication mode.
DiscTimestamp uint64 snapshot NULL Client disconnection timestamp.
RxAvgByteRate uint32 snapshot AVG Client average receive data rate
TxAvgByteRate uint32 snapshot AVG Client average transmission data rate
RxError uint32 snapshot Snapshot Client RX CRC error count.
TxRetryBytes uint32 snapshot Snapshot Client current TX retry count.
vni int32 snapshot Snapshot Client Network Segmentation (MDU) VNI
authStatus int32 snapshot Snapshot Wlan auth status
authMethod string snapshot Snapshot Wlan authentication method
encryption string snapshot Snapshot Encryption method used by the AP
disconnectReason int32 snapshot Snapshot Reason for disconnect from the controller.

AP Client Info .TCWithQuota

Attribute Name

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

Description

tcName string snapshot NULL Name of the traffic class.
tcMaxQuota string snapshot NULL Amount of quota assigned(x) in bytes, received during access accept.
tcRemainingQuota string snapshot NULL Bytes remaining for the client after consuming n bytes (x-n).

AP Client WLAN

Attribute Name

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

Description

ssid string snapshot NULL SSID of the WLAN
bssid string snapshot NULL BSSID of the WLAN
vlan uint64 snapshot NULL Client VLAN ID
wsgWlanId int snapshot NULL Unique WLAN ID assigned by the controller
wlanId int snapshot NULL WLAN interface ID
wlangroup_id string snapshot NULL WLAN Group identifier
wlantenant_id string snapshot NULL WLAN tenant identifier
wlangroup_name string snapshot NULL WALN Group name
wlantenant_name string snapshot NULL WLAN tenant name

AP Client Radio

Attribute Name

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

Description

radioId int32 snapshot NULL Radio ID number used by the AP
mode string snapshot NULL Radio mode used by the AP's wireless interface
80211RadioMode string snapshot NULL Radio mode used by the AP
channel int32 snapshot NULL Current radio channel used by the AP
channelWidth uint32 snapshot NULL Channel width used by the AP's radio
wlan .APClientWlan snapshot NULL WLAN information for this client

AP Client Stats

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 MAC address of the AP
timeStamp string snapshot NULL Date and time this report was generated
seqNumber uint64_t 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
clients .APClientInfo Serialization NULL AP current client list
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 this stats report generation
aggregationInterval uint32 snapshot NULL Interval time for data aggregation
deviceName string snapshot NULL AP device name
serialNumber string snapshot NULL The serial number in AP borad data
apRadioDeploy string snapshot NULL Indicate AP all radio band deploy