ap_avc.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 FlowMessage { 
    required string app = 1;
    required uint32 port = 2;
    required string client_mac = 3;
    required string ap_mac = 4;
    required string ssid = 5; 
    required uint64 uplink = 6; 
    required uint64 downlink = 7; 
    required uint64 total = 8;
    optional string category = 9;
    optional string wlangroup_id = 10;
    optional uint32 wsgwlan_id = 11; 
    optional string wlantenant_id = 12; 
    optional uint32 apradiotype_id = 13; 
    optional string wlangroup_name = 14; 
    optional string wlantenant_name = 15;
    optional uint32 radio_id = 16;
    optional string client_ipv4 = 17;
    optional string client_ipv6 = 18;
    optional string client_hostname = 19;
    required uint32 app_id = 20;
    optional string mld_mac = 21;

}

message UrlFilteringMsg {
    enum Action {
        Allow = 1;
        Block = 2;
    }
    optional string url = 1;
    optional uint32 cat_id = 2;
    optional string cat_name = 3;
    optional uint32 num_hits = 4;
    optional string client_mac = 5;
    optional string ap_mac = 6;
    optional string ssid = 7;
    optional uint64 uplink = 8;
    optional uint64 downlink = 9;
    optional uint64 total = 10;
    optional string wlangroup_id = 11;
    optional uint32 wsgwlan_id = 12;
    optional string wlantenant_id = 13;
    optional uint32 apradiotype_id = 14;
    optional string wlangroup_name = 15;
    optional string wlantenant_name = 16;
    optional uint32 radio_id = 17;
    optional string client_ipv4 = 18;
    optional string client_ipv6 = 19;
    optional string client_hostname = 20;
    optional uint64 session_start = 21;
    optional uint64 session_stop = 22;
    optional uint32 web_reputation_score = 23;
    optional Action web_reputation_action = 24;
    optional string mld_mac = 25;
}

message WFCCallQualityMsg {
    optional uint64 timestamp = 1;
    optional uint32 score = 2;
}

message WifiCallingMsg {
    optional string operator_name = 1;
    optional uint32 priority = 2;
    optional uint64 timestamp_start = 3;
    optional uint64 timestamp_end = 4;
    optional string client_mac = 5;
    optional string ap_mac = 6;
    optional string ssid = 7;
    optional uint64 uplink = 8;
    optional uint64 downlink = 9;
    optional uint64 total = 10;
    optional string wlangroup_id = 11;
    optional uint32 wsgwlan_id = 12;
    optional string wlantenant_id = 13;
    optional uint32 apradiotype_id = 14;
    optional string wlangroup_name = 15;
    optional string wlantenant_name = 16;
    optional uint32 radio_id = 17;
    optional string client_ipv4 = 18;
    optional string client_ipv6 = 19;
    optional string client_hostname = 20;
    optional string epdg_fqdn = 21;
    repeated WFCCallQualityMsg wfc_score_dir1 = 22;
    repeated WFCCallQualityMsg wfc_score_dir2 = 23;
    repeated WFCCallQualityMsg wfc_score_dir2 = 23;
    optional string mld_mac = 24;
}

message ServerInfo {
    required string server_ip = 1;
    optional float lan_latency = 2;
    optional float wan_latency = 3;
    optional float page_download_time = 4;
}

message ApplicationData {
    required uint32 app_id = 1;
    repeated ServerInfo server_info = 2 [(nanopb).type = FT_POINTER];
}

message ClientInfo {
    required string client_ip = 1;
    optional string client_mac = 2;
    repeated ApplicationData app_data = 3 [(nanopb).type = FT_POINTER];
}

message ApplicationMetrics {
    repeated ClientInfo client_info = 1 [(nanopb).type = FT_POINTER];
}

message ArcMessage { 
    optional string ver = 1;
    optional string zone_id = 2; 
    optional string apgroup_id = 3; 
    repeated FlowMessage rep_flow = 4; 
    optional uint64 timestamp = 5; 
    optional string cluster_id = 6; 
    optional string domain_id = 7; 
    optional string aptenant_id = 8; 
    optional string map_id = 9; 
    optional string aptenant_name = 10; 
    optional string zone_name = 11; 
    optional string apgroup_name = 12; 
    optional string domain_name = 13; 
    optional uint64 sampleTime = 14;
    optional uint32 aggregationInterval = 15; 
    optional string apMac = 16
    repeated UrlFilteringMsg url_info = 17;
    repeated WifiCallingMsg wfc_info = 18;
    optional string apRadioDeploy = 19;
    optional ApplicationMetrics app_metrics = 20;

}

Field Description

FlowMessage descriptions

Attribute Name

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

Description

app string snapshot NULL Application name
port uint32 snapshot NULL Application destination port number
client_mac string snapshot NULL Destination MAC address
ap_mac string snapshot NULL AP MAC address
ssid string snapshot NULL WLAN SSID
uplink uint64 snapshot SUM Rx bytes for this application
downlink uint64 snapshot SUM Tx bytes for this application
total uint64 snapshot SUM Tx + Rx bytes for the application
category string snapshot NULL Application category
wlangroup_id string snapshot NULL WLAN group identifier
wsgwlan_id uint32 snapshot NULL WSG WLAN identifier
apradiotype_id uint32 snapshot NULL Radio mode for the radio interface
wlangroup_name string snapshot NULL WLAN group name
wlantenant_name string snapshot NULL WLAN tenant name
radio_id uint32 snapshot NULL WLAN radio ID
client_ipv4 string snapshot NULL Client's IPv4 address
client_ipv6 string snapshot NULL Client's IPv6 address
client_hostname string snapshot NULL Client host name
app_id uint32 snapshot NULL App_Id

UrlFilteringMsg descriptions

Attribute Name

ValueType (size)

Description

Allow 1 Web Reputation action value Allow
Block 2 Web Reputation action value Block

Attribute Name

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

Description

url string snapshot NULL Client access URL
cat_id uint32 snapshot NULL Category identifier of the URL
cat_name string snapshot NULL Category name of the URL
num_hits uint32 snapshot SUM Number of client counts that access the URL
client_mac string snapshot NULL Client's MAC address
ap_mac string snapshot NULL AP MAC address
ssid string snapshot NULL WLAN SSID where client is connected
uplink uint64 snapshot SUM Uplink bytes sent from client
downlink uint64 snapshot SUM Downlink bytes received by client
total uint64 snapshot SUM Total of sent and received bytes by the client
wlangroup_id string snapshot NULL WLAN group identifier
wsgwlan_id uint32 snapshot NULL WSG WLAN identifier
wlantenant_id uint32 snapshot NULL WLAN tenant identifier
apradiotype_id uint32 snapshot NULL Radio mode for the radio interface
wlangroup_name string snapshot NULL WLAN group name
wlantenant_name string snapshot NULL WLAN tenant name
radio_id uint32 snapshot NULL Radio interface identifier
client_ipv4 string snapshot NULL Client's IPv4 address
client_ipv6 string snapshot NULL Client's IPv6 address
client_hostname string snapshot NULL Client host name
session_start uint64 snapshot NULL URL Filtering session start timestamp
session_stop uint64 snapshot NULL URL Filtering session start timestamp
web_reputation_score unit32 snapshot NULL URL's web reputation score
web_reputation_action .UrlFilteringMsg.Action snapshot NULL Web reputation Action of the URL
mld_mac string snapshot NULL MLD MAC address for MLO clients

WFCCallQualityMsg descriptions

Attribute Name

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

Description

timestamp uint64 None None None
score uint32 None None None

WifiCallingMsg descriptions

Attribute Name

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

Description

operator_name string snapshot NULL Operator name
priority uint32 snapshot NULL Call priority
timestamp_start uint64 snapshot NULL Date and time at the start of the WiFi call
timestamp_end uint64 snapshot NULL Date and time at the end of the WiFi call
client_mac string snapshot NULL Client's MAC address
ap_mac string snapshot NULL AP MAC address
ssid string snapshot NULL WLAN SSID where client is connected
uplink uint64 snapshot SUM Uplink bytes sent from client
downlink uint64 snapshot SUM Downlink bytes received by client
total uint64 snapshot SUM Total of sent and received bytes by the client
wlangroup_id string snapshot NULL WLAN group identifier
wsgwlan_id uint32 snapshot NULL WSG WLAN identifier
wlantenant_id uint32 snapshot NULL WLAN tenant identifier
apradiotype_id uint32 snapshot NULL AP Radio mode
wlangroup_name string snapshot NULL WLAN group name
wlantenant_name string snapshot NULL WLAN tenant name
radio_id uint32 snapshot NULL Radio interface identifier
client_ipv4 string snapshot NULL Client's IPv4 address
client_ipv6 string snapshot NULL Client's IPv6 address
client_hostname string snapshot NULL Client host name
epdg_fqdn string snapshot NULL FQDN of operator epdg gateway
wfc_score_dir1 WFCCallQualityMsg snapshot NULL Call Quality Score
wfc_score_dir2 WFCCallQualityMsg None None None
MLD MAC address for MLO clients

mld_mac

snapshot NULL MLD MAC address for MLO clients

6.1.1 update
ServerInfo descriptions

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type (SUM,MAX,MIN,AVG,NULL) Description
server_ip STRING snapshot NULL Server IP address
lan_latency FLOAT snapshot NULL LAN latency
wan_latency FLOAT snapshot NULL WAN latency
page_download_time FLOAT snapshot NULL Page Download Time

6.1.1 update
ApplicationData descriptions

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type (SUM,MAX,MIN,AVG,NULL) Description
app_id UINT32 snapshot NULL Application identifier
server_info .ServerInfo snapshot NULL Server Information

6.1.1 update
ClientInfo descriptions

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type (SUM,MAX,MIN,AVG,NULL) Description
client_ip STRING snapshot NULL Client IP address
client_mac STRING snapshot NULL Client Mac address
app_data .ApplicationData   snapshot Application Data information

6.1.1 update
ApplicationMetrics description

Attribute Name ValueType (size) Property(Snapshot/Delta/Serialization) ValueAggregation Type (SUM,MAX,MIN,AVG,NULL) Description
client_info .ClientInfo snapshot NULL Client information contains App data

ArcMessage descriptions

Attribute Name

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

Description

version string snapshot NULL Arc data version number
zone_ID string snapshot NULL Zone UUID
apgroup_ID string snapshot NULL AP group UUID
rep_flow .FlowMessage snapshot NULL ARC stats message type
timestamp uint64 snapshot NULL Timestamp for the message reported
cluster_id string snapshot NULL Cluster identifier
domain_id string snapshot NULL Domain identifier
aptenant_id string snapshot NULL AP tenant identifier
map_id string snapshot NULL MAP identifier
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 AVC data sampling timestamp
aggregationInterval uint32 snapshot NULL Stats aggregation interval
apMac string snapshot NULL AP MAC address
url_info .UrlFilteringMsg snapshot NULL URL Filtering Stats message type
wfc_info .WifiCallingMsg snapshot NULL WiFi Calling stats message type
apRadioDeploy string snapshot NULL Indicate AP all radio band deploy
app_metrics .ApplicationMetrics NULL NULL Application QOE score