/**
* 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 APWiredClientInfo {
optional string clientMac = 1;
optional string ipAddress = 2;
optional string ipv6Address = 3;
optional int32 vlan = 4;
optional uint64 rxFrames = 5;
optional uint64 rxBytes = 6;
optional uint64 rxUcast = 7;
optional uint64 rxMcast = 8;
optional uint64 rxBcast = 9;
optional uint64 rxDrop = 10;
optional uint64 rxEapol = 11;
optional uint64 rxMcastLegacy = 12;
optional uint64 txFrames = 13;
optional uint64 txBytes = 14;
optional uint64 txUcast = 15;
optional uint64 txMcast = 16;
optional uint64 txBcast = 17;
optional uint64 txDrop = 18;
optional uint64 txEapol = 19;
enum AUTH_STATUS
{
UNAUTH = 0;
AUTHENTICATED = 1;
}
optional AUTH_STATUS authStatus = 20;
optional string ethIF = 21;
optional string hostname = 22;
optional int32 deviceType = 23;
optional int32 osVendorType = 24;
optional string modelName = 25;
optional uint64 rxBytes_r = 26;
optional uint64 txBytes_r = 27;
optional int32 vni = 28;
}
message APWiredClientStats {
optional uint32 version = 1;
repeated APWiredClientInfo clients = 2;
optional uint64 timestamp = 3;
optional uint64 sampleTime = 4;
optional uint32 aggregationInterval = 5;
optional string zone_id = 6;
optional string domain_id = 7;
optional string deviceName = 8;
optional string apgroup_id = 9;
optional string aptenant_id = 10;
optional string map_id = 11;
optional string cluster_id = 12;
optional string apmac = 13;
}
Field Description
AP Wired Client Information
Attribute Name
|
ValueType (size) |
Property(Snapshot/Delta/Serialization) |
ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) |
Description
|
| clientMac
|
string
|
Snapshot
|
NULL
|
Wired Client MAC address
|
| ipAddress
|
string
|
Snapshot
|
NULL
|
Wired Client IPv4 address
|
| ipv6Address
|
string
|
Snapshot
|
NULL
|
Wired Client IPv6 address
|
| vlan
|
int32
|
Snapshot
|
NULL
|
Wired Client VLAN
|
| rxFrames
|
uint64
|
Snapshot
|
NULL
|
Receive packet frames
|
| rxBytes
|
uint64
|
Snapshot
|
NULL
|
Receive packet bytes
|
| rxUcast
|
uint64
|
Snapshot
|
NULL
|
Receive unicast packets
|
| rxMcast
|
uint64
|
Snapshot
|
NULL
|
Receive multicast packets
|
| rxBcast
|
uint64
|
Snapshot
|
NULL
|
Receive Broadcast packets
|
| rxDrop
|
uint64
|
Snapshot
|
NULL
|
Drop packets on receive side
|
| rxEapol
|
uint64
|
Snapshot
|
NULL
|
Receive EAPOL packets
|
| rxMcastLegacy
|
uint64
|
Snapshot
|
NULL
|
Receive legacy multicast packets
|
| txFrames
|
uint64
|
Snapshot
|
NULL
|
Transmit packet frames
|
| txBytes
|
uint64
|
Snapshot
|
NULL
|
Transmit packet bytes
|
| txUcast
|
uint64
|
Snapshot
|
NULL
|
Transmit unicast packets
|
| txMcast
|
uint64
|
Snapshot
|
NULL
|
Transmit multicast packets
|
| txBcast
|
uint64
|
Snapshot
|
NULL
|
Transmit Broadcast packets
|
| txEapol
|
uint64
|
Snapshot
|
NULL
|
Transmit EAPOL packets
|
| authStatus
|
.APWiredClientInfo.AUTH_STATUS
|
Snapshot
|
NULL
|
Wired client authentication status(UNAUTH or AUTHENTICATED)
|
| ethIF
|
string
|
Snapshot
|
NULL
|
Interface name which wired client associated
|
| hostname
|
string
|
Snapshot
|
NULL
|
Client hostname
|
| 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.
|
| rxBytes_r |
unit64 |
Delta |
Sum |
Total bytes received |
| txBytes_r |
unit64 |
Delta |
Sum |
Total bytes sent |
|
vni |
INT32 |
snapshot |
NULL |
Wired Client VNI |
AP Wired Client Stats Information
| Attribute Name
|
ValueType (size)
|
Property(Snapshot/Delta/Serialization)
|
ValueAggregation Type(SUM,MAX,MIN,AVG,NULL)
|
Description
|
| version
|
uint32
|
Snapshot
|
NULL
|
GPB version
|
| clients
|
.APWiredClientInfo
|
Serialization
|
NULL
|
Serialization data for all of wired client information
|
| timestamp
|
uint64
|
Snapshot
|
NULL
|
time for this report
|
| sampleTime
|
uint64
|
Snapshot
|
NULL
|
sample time for these stats
|
| aggregationInterval
|
uint32
|
Snapshot
|
NULL
|
aggregation interval for report
|
| zone_id
|
string
|
Snapshot
|
NULL
|
zone UUID
|
| domain_id
|
string
|
Snapshot
|
NULL
|
domain UUID
|
| deviceName
|
string
|
Snapshot
|
NULL
|
AP device name
|
| apgroup_id
|
string
|
Snapshot
|
NULL
|
ap group UUID
|
| aptenant_id
|
string
|
Snapshot
|
NULL
|
ap tenant UUID
|
| map_id
|
string
|
Snapshot
|
NULL
|
map UUID
|
| cluster_id
|
string
|
Snapshot
|
NULL
|
cluster UUID
|
| apmac |
string |
Snapshot |
NULL |
MAC address of the AP |