ap_status.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 APStatusTunnel {
optional string gw = 1;
optional int32 index = 2;
optional int32 type = 3;
optional int32 isActive = 4;
optional uint64 cICMP = 5;
optional uint64 cNonICMP = 6;
optional uint64 cDisconnect = 7;
optional uint64 rxBytes = 8;
optional uint64 rxPkts = 9;
optional uint64 rxDropPkts = 10;
optional uint64 rxErrPkts = 11;
optional uint64 txBytes = 12;
optional uint64 txPkts = 13;
optional uint64 txDropPkts = 14;
optional uint64 txErrPkts = 15;
optional uint64 txFragPkts = 16;
optional string uptime = 17;
optional uint64 reEstablishment = 18;
optional uint64 kaRetryCnt = 19;
optional uint64 kaSentCnt = 20;
optional uint64 kaLostCnt = 21;
optional string reason = 22;
optional string suggest = 23;
optional string dpKey = 24;
}
message APStatusIPSecStats {
enum IPsecTunnelType {
RUCKUSGRE = 0;
SOFTGRE = 1;
}
optional 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 IPsecTunnelType ipsecTunnelType = 10;
}
message APStatusWlan {
optional string ssid = 1;
optional string bssid = 2;
optional string ap = 3;
optional string radioMode = 4;
optional string ap80211RadioMode = 5;
optional int32 channel = 6;
optional uint64 rxBytes = 7;
optional uint64 txBytes = 8;
optional uint64 rxFrames = 9;
optional uint64 txFrames = 10;
optional uint64 txBcastFrames = 11;
optional uint64 txMcastFrames = 12;
optional uint64 txDataFrames = 13;
optional uint64 txDataBytes = 14;
optional uint64 txMgmtFrames = 15;
optional uint64 txMgmtBytes = 16;
optional uint64 txDropDataFrames = 17;
optional uint64 txDropMgmtFrames = 18;
optional uint64 rxBcastFrames = 19;
optional uint64 rxMcastFrames = 20;
optional uint64 rxDataFrames = 21;
optional uint64 rxDataBytes = 22;
optional uint64 rxMgmtFrames = 23;
optional uint64 rxMgmtBytes = 24;
optional int32 totalNumClients = 25;
optional int32 vlan = 26;
optional int32 wsgWlanId = 27;
optional int32 wlanId = 28;
optional string wlangroup_name = 29;
optional string wlangroup_id = 30;
optional string wlantenant_id = 31;
optional string wlantenant_name = 32;
optional uint32 ftassoc_success = 33;
optional uint32 ftassoc_failure = 34;
optional uint32 is_probe_withheld = 35;
optional uint32 is_auth_withheld = 36;
optional uint32 beacon_queued = 37;
optional uint32 beacon_reaped = 38;
/* jump to index 1000, for new requirement from SNMP and SCI */
optional string WlanName = 1001;
optional string AuthMethod = 1002;
optional string EncryptMethod = 1003;
optional uint32 IsGuest = 1004;
optional uint32 IsBcastDisable = 1005;
optional uint32 UpRateLimit = 1006;
optional uint32 DownRateLimit = 1007;
optional uint32 IsTunnel = 1008;
optional uint32 RxByteRate = 1009;
optional uint32 TxByteRate = 1010;
optional uint64 RxDropDataBytes = 1011;
optional uint64 TxDropDataBytes = 1012;
optional uint64 RxDropDataPkts = 1013;
optional uint64 TxDropDataPkts = 1014;
optional uint64 TxRetryBytes = 1015;
optional uint64 TxRetryPkts = 1016;
optional uint64 RxErrorPkts = 1017;
optional uint64 TxErrorPkts = 1018;
optional uint32 RxPktErrorRate = 1019;
optional uint32 TxPktErrorRate = 1020;
optional uint32 NumAuthClients = 1021;
optional uint32 NumAssocReq = 1022;
optional uint32 NumAssocResp = 1023;
optional uint32 NumReassocReq = 1024;
optional uint32 NumReassocResp = 1025;
optional uint32 NumAssocFail = 1026;
optional uint32 NumAssocDeny = 1027;
optional uint32 DisssocAbnormal = 1028;
optional uint32 NumDisssocCapacity = 1029;
optional uint32 MumDisssocLeave = 1030;
optional uint32 NumDisssocMisc = 1031;
optional uint32 AssocSuccessRate = 1032;
optional uint32 AssocFailRate = 1033;
optional uint32 NumAuthReq = 1034;
optional uint32 NumAuthResp = 1035;
optional uint32 NumAuthSuccess = 1036;
optional uint32 NumAuthFail = 1037;
optional uint32 AuthFailRate = 1038;
optional uint32 RtsThreshold = 1039;
optional uint32 lookup_success_fst = 1040;
optional uint32 lookup_success_sessmgr = 1041;
optional uint32 roaming_success = 1042;
optional uint32 connection_attempts = 1043;
optional uint32 pmkid_success = 1044;
optional uint32 pmkid_mismatch = 1045;
optional uint32 pmkid_missing = 1046;
optional uint32 ft_auth_success = 1047;
optional uint32 ftie_mismatch = 1048;
optional uint32 ftie_missing = 1049;
repeated uint32 fst_lookup_time = 1050;
repeated uint32 sessmgr_lookup_time = 1051;
optional uint32 ft_anonce_retry = 1052;
optional uint32 ft_pmkr0_pmkr1_mismatch = 1053;
}
message APStatusRadio {
optional int32 radioId = 1;
optional int32 channel = 2;
optional string mode = 3;
optional string band = 4;
optional string radioMode = 5;
optional string txPower = 6;
optional uint32 phyError = 7;
optional string channelBlacklist = 8;
optional int32 noiseFloor = 9;
optional uint64 rxBytes = 10;
optional uint64 rxFrames = 11;
optional uint64 rxRadioBytes = 12;
optional uint64 rxRadioFrames = 13;
optional uint64 txBytes = 14;
optional uint64 txFrames = 15;
optional uint64 txRadioBytes = 16;
optional uint64 txRadioFrames = 17;
optional uint64 retry = 18;
optional uint32 drop = 19;
optional uint64 rxMulticast = 20;
optional uint64 txMulticast = 21;
optional uint32 total = 22;
optional uint32 busy = 23;
optional uint32 rx = 24;
optional uint32 tx = 25;
optional uint32 channelWidth = 26;
repeated APStatusWlan wlans = 27;
optional string ap = 28;
optional uint32 latency = 29;
optional uint32 capacity = 30;
optional float connectionFailure = 31;
optional uint32 connectionAuthFailureCount = 32;
optional uint32 connectionAssocFailureCount = 33;
optional uint32 connectionTotalCount = 34;
optional uint32 numOfChannelChange = 35;
optional bool isLatencyFlagged = 36;
optional bool isCapacityFlagged = 37;
optional bool isConnectionFailureFlagged = 38;
optional bool isAirtimeFlagged = 39;
optional bool isRadioEnabled = 40;
optional uint32 secondaryChannel = 41;
optional int32 eirp = 42;
optional uint32 connectionTotalFailureCount = 43;
optional uint32 tx_rts_cnt = 44;
optional uint32 totalFailureClientCount = 45;
optional uint32 totalClientCnts = 46;
optional string chainmask = 47;
optional uint64 rxMcastBytes = 48;
optional uint64 txMcastBytes = 49;
optional uint64 rxMcastDataBytes = 50;
optional uint64 txMcastDataBytes = 51;
optional int32 channelWidthGroup = 52;
optional int32 actualTxPower = 53;
optional int32 calibrationTxPower = 54;
optional int32 maxTxPower = 55;
optional string hdTxPower = 56;
optional int32 hdActualTxPower = 57;
/* jump to index 1000, for new requirement from SNMP and SCI */
optional int32 PowerMgmtEnable = 1001;
optional int32 MeshEnable = 1002;
optional uint64 RxErrorPkts = 1003;
optional uint64 TxErrorPkts = 1004;
optional uint32 RxPktErrorRate = 1005;
optional uint32 TxPktErrorRate = 1006;
optional uint32 TxPktRetryRate = 1007;
optional uint64 TxRetryBytes = 1008;
optional uint64 RxDropBytes = 1009;
optional uint64 TxDropBytes = 1010;
optional uint64 RxDropPkts = 1011;
optional uint64 TotalAssocTime = 1012;
optional uint32 NumAuthClients = 1013;
optional uint32 NumMaxClients = 1014;
optional uint32 NumAuthReqs = 1015;
optional uint32 NumAuthResps = 1016;
optional uint32 NumAuthSuccess = 1017;
optional uint32 NumAuthFail = 1018;
optional uint32 AuthFailRate = 1019;
optional uint32 NumAssocReq = 1020;
optional uint32 NumAssocResp = 1021;
optional uint32 NumReassocReq = 1022;
optional uint32 NumReassocResp = 1023;
optional uint32 NumAssocSuccess = 1024;
optional uint32 NumAssocFail = 1025;
optional uint32 NumAssocDeny = 1026;
optional uint32 AssocSuccessRate = 1027;
optional uint32 AssocFailRate = 1028;
optional uint32 ResourceUtil = 1029;
optional uint64 RxSignalPkts = 1030;
optional uint64 TxSignalPkts = 1031;
optional uint64 TotalSignalPkts = 1032;
optional uint32 AntennaGain = 1033;
optional uint32 BeaconPeriod = 1034;
optional uint32 RtsThreshold = 1035;
optional uint32 FragThreshold = 1036;
optional uint32 RxWepFail = 1037;
optional uint32 RxDecryptCrcError = 1038;
optional uint32 RxMicError = 1039;
optional uint32 Rssi = 1040;
optional uint32 TxPowerOffset = 1041;
optional uint32 RxDesense = 1042;
}
message APStatusBrownout {
optional uint64 timestamp = 1;
optional int32 events = 2;
optional int32 pwrType = 3;
}
message APStatusIPSec {
optional string ipsecActiveServerIP = 1;
optional string ipsecVirtualIPv4 = 2;
optional string ipsecVirtualIPv6 = 3;
optional string ipsecEffectiveIKESA = 4;
optional string ipsecEffectiveESPSA = 5;
}
message APStatusSystem {
enum APState {
Online = 1;
Flagged = 2;
PowerSaveMode = 3;
PowerSavePlusMode = 4;
}
optional string ap = 1;
optional string usbDeviceVersion = 2;
optional string usbDeviceVID = 3;
optional string usbDevicePID = 4;
optional string gpsInfo = 5;
optional string countryCode = 6;
optional uint64 timestamp = 7;
optional uint64 seqNumber = 8;
optional string zone_id = 9;
optional string zoneName = 10;
optional string timeZone = 11;
optional string gatewayIp = 12;
optional string lastRebootReason = 13;
optional uint32 totalBootCount = 14;
optional uint32 mtuSize = 15;
optional uint32 rejoinCount = 16;
optional string rejoinReason = 17;
optional string oops = 18;
optional uint32 lossConnectBootCnt = 19;
optional string deviceName = 20;
optional string location = 21;
optional string fwVersion = 22;
optional int32 devSupportUsb = 23;
optional int32 deviceIpMode = 24;
optional string ip = 25;
optional string ipv6 = 26;
optional string ipsecIp = 27;
optional string apConnectedIp = 28;
optional int32 uptime = 29;
optional string mountState = 30;
optional int32 currentTemperature = 31;
optional int32 lifeMaxTemperature = 32;
optional int32 lifeMinTemperature = 33;
optional string dnatInfo = 34;
optional string rksDpIp = 35;
optional string rksDpIpOnly = 36;
optional string ipType = 37;
optional uint32 isIpTypeChanged = 38;
optional uint32 managementVlan = 39;
optional APState apState = 40;
optional bool isConnectionTotalCountFlagged = 41;
optional uint32 totalConnectedClient = 42;
optional uint32 crashDump = 43;
optional string altitudeUnit = 44;
optional uint32 altitudeValue = 45;
optional uint32 poeMode = 46;
optional uint32 poeModeSetting = 47;
optional string ipv6Type = 48;
optional double freeMemoryPercentage = 49;
optional double freeStoragePercentage = 50;
optional uint32 poeUnderPowered = 51;
optional string chainmask5G = 52;
optional string chainmask24G = 53;
optional bool isIoTEnable = 54;
optional bool isUSBEnable = 55;
optional bool isPoEOutEnable = 56;
optional bool isSecEthEnable = 57;
optional string config_id = 58;
optional string upd_config_id = 59;
optional ConfigFwStatus config_status = 60;
optional string fw_upd_version = 61;
optional ConfigFwStatus fw_upd_status = 62;
optional string fw_upd_failed_reason = 63;
optional string fw_request_id = 64;
optional string config_failed_feature_name = 65;
optional string config_failed_feature_attribute = 66;
optional string config_failed_err_message = 67;
optional string config_failed_feature_attr_value = 68;
optional string config_request_id = 69;
optional int32 is_secure_boot_enable = 70;
optional string powerProfile = 71;
/* jump to index 1000, for new requirement from SNMP and SCI */
optional double cpuPercentage = 1001;
optional uint64 totalMemory = 1002;
optional uint64 freeMemory = 1003;
optional string model = 1004;
optional string serialNumber = 1005;
optional string desc = 1006;
optional int32 numRadio = 1007;
optional string szConnCpIp = 1008;
optional string szConnCpIpv6 = 1009;
optional string szConnDpIp = 1010;
optional string szConnDpIpv6 = 1011;
optional string netmask = 1012;
optional string IpDnsSvr1 = 1013;
optional string IpDnsSvr2 = 1014;
optional string Ipv6DnsSvr1 = 1015;
optional string Ipv6DnsSvr2 = 1016;
optional int32 ApStatus = 1017;
optional uint64 firstJoinTime = 1018;
optional uint64 lastBootTime = 1019;
optional uint64 lastConfSyncTime = 1020;
optional uint64 freeStorage = 1021;
optional int32 ethPortStatus = 1022;
optional int32 ethStateChange = 1023;
optional uint32 numRogues = 1024;
optional uint32 numAuthClients = 1025;
optional uint32 rxByteRate = 1026;
optional uint32 txByteRate = 1027;
optional uint64 rxErrorPkts = 1028;
optional uint64 txErrorPkts = 1029;
optional uint64 RxDropPkts = 1030;
optional uint64 LanStatsRxBytes = 1031;
optional uint64 LanStatsTxBytes = 1032;
optional uint64 LanStatsRxPkts = 1033;
optional uint64 LanStatsTxPkts = 1034;
optional uint64 LanStatsRxErrorPkts = 1035;
optional uint64 LanStatsTxErrorPkts = 1036;
optional uint64 LanStatsRxBcastPkts = 1037;
optional uint64 LanStatsTxBcastPkts = 1038;
optional uint64 LanStatsRxMcastPkts = 1039;
optional uint64 LanStatsTxMcastPkts = 1040;
optional uint64 LanStatsRxUcastPkts = 1041;
optional uint64 LanStatsTxUcastPkts = 1042;
optional uint64 LanStatsRxDroppedPkts = 1043;
optional uint64 LanStatsTxDroppedPkts = 1044;
optional uint64 LanStatsRxByteRate = 1045;
optional uint64 LanStatsTxByteRate = 1046;
optional uint64 TxDropPkts = 1047;
optional string chainmask6G = 1048;
}
message LanPortStatus {
optional uint32 port = 1;
optional string interface = 2;
optional string dot1x = 3;
optional string logicLink = 4;
optional string phyLink = 5;
optional string sfpInfo = 6;
optional string wanConnectivity = 7;
optional string phyCapability = 8;
}
message CableModemInfo {
optional string cmMac = 1;
optional string cmIp = 2;
optional string cmFwVersion = 3;
optional uint64 cmUptime = 4;
optional string cmSerialNumber = 5;
optional string cmIpv6 = 6;
optional string cmCapabilities = 7;
optional uint32 cmRangingTimeout = 8;
optional uint32 cmStatusValue = 9;
optional string cmStatusCode = 10;
optional string cmStatusTxPower = 11;
optional uint32 cmStatusResets = 12;
optional uint32 cmStatusLostSyncs = 13;
optional uint32 cmStatusInvalidMaps = 14;
optional uint32 cmStatusInvalidUcds = 15;
optional uint32 cmStatusInvalidRangingResponses = 16;
optional uint32 cmStatusInvalidRegistrationResponses = 17;
optional uint32 cmStatusT1Timeouts = 18;
optional uint32 cmStatusT2Timeouts = 19;
optional uint32 cmStatusT3Timeouts = 20;
optional uint32 cmStatusT4Timeouts = 21;
optional uint32 cmStatusRangingAborteds = 22;
optional uint32 cmStatusDocsisOperMode = 23;
optional uint32 cmStatusModulationType = 24;
optional string cmStatusEqualizationData =25;
}
message APStatusLBS {
optional bool isLBSEnable = 1;
optional bool isLBSConnected = 2;
optional bool isSupportLBS = 3;
}
message CellularInfo {
optional string cellularWanInterface = 1; // "wwan0"
optional string cellularConnectionStatus = 2; // "2G" / "3G" / "4G" / "Not Connected"
optional string cellularIMSISIM0 = 3;
optional string cellularIMSISIM1 = 4;
optional string cellularICCIDSIM0 = 5;
optional string cellularICCIDSIM1 = 6;
optional string cellularIsSIM0Present = 7; // YES or NO
optional string cellularIsSIM1Present = 8; // YES or NO
optional uint64 cellularTxBytesSIM0 = 9;
optional uint64 cellularTxBytesSIM1 = 10;
optional uint64 cellularRxBytesSIM0 = 11;
optional uint64 cellularRxBytesSIM1 = 12;
optional string cellularActiveSim = 13; // "SIM0" / "SIM1"
optional string cellularIPaddress = 14;
optional string cellularSubnetMask = 15;
optional string cellularDefaultGateway = 16;
optional string cellularOperator = 17;
optional int32 cellular3G4GChannel = 18;
optional string cellularSignalStrength = 19;
optional string cellularCountry = 20;
optional int32 cellularRadioUptime = 21;
optional string cellularLTEFirmware = 22;
optional int64 cellularSwitchCountSIM0 = 23;
optional int64 cellularSwitchCountSIM1 = 24;
optional int64 cellularNWLostCountSIM0 = 25;
optional int64 cellularNWLostCountSIM1 = 26;
optional int64 cellularCardRemovalCountSIM0 = 27;
optional int64 cellularCardRemovalCountSIM1 = 28;
optional int64 cellularDHCPTimeoutCountSIM0 = 29;
optional int64 cellularDHCPTimeoutCountSIM1 = 30;
optional string cellularRoamingStatus = 31;
optional string cellularIMEI = 32;
optional int32 cellularRSRP = 33;
optional int32 cellularRSRQ = 34;
optional int32 cellularSINR = 35;
optional int32 cellularRSCP = 36;
optional int32 cellularECIO = 37;
optional string cellularBand = 38;
optional string cellularUplinkBandwidth = 39;
optional string cellularDownlinkBandwidth = 40;
repeated GpsHistoryData gpsHistory = 41;
}
message GpsHistoryData {
optional uint64 timestamp = 1;
optional string latitude = 2;
optional string longitude = 3;
}
message APStatusVxLAN {
optional uint32 vxlanMtu = 1;
optional VxLANTunnelStatus tunStatus = 2;
optional VxLANRemoteVtepInfo primaryRvtepInfo = 3;
optional VxLANRemoteVtepInfo activeRvtepInfo = 4;
}
message APStatusData {
optional APStatusSystem APSystem = 1;
optional APStatusIPSec APIPSec = 2;
repeated APStatusBrownout APBrownout = 3;
repeated APStatusRadio APRadio = 4;
optional APStatusIPSecStats APIPSecStats = 5;
repeated APStatusTunnel APTunnel = 6;
repeated LanPortStatus lanPortStatus = 7;
optional CableModemInfo cableModemInfo = 9;
optional APStatusLBS APStatusLBS = 10;
optional CellularInfo cellularInfo = 11;
optional DeviceSessionCacheStats deviceSessionCacheStats = 12;
optional AFCInfo afcInfo = 13;
optional APStatusVxLAN vxlanStatus = 14;
}
message APStatus {
required uint32 version = 1;
optional APStatusData ap_status_data = 2;
optional string zone_id = 3;
optional string apgroup_id = 4;
optional string cluster_id = 5;
optional string domain_id = 6;
optional string aptenant_id = 7;
optional string map_id = 8;
optional string aptenant_name = 9;
optional string zone_name = 10;
optional string apgroup_name = 11;
optional string domain_name = 12;
optional string wlangroup24G_id = 13;
optional string wlangroup24G_name = 14;
optional string wlangroup5G_id = 15;
optional string wlangroup5G_name = 16;
optional uint64 sampleTime = 17;
optional uint32 aggregationInterval = 18;
optional string map_name = 19;
optional string apMac = 20;
optional int32 lacp_state = 21;
repeated ApStatusWlanGroup wlan_groups = 22;
optional string apRadioDeploy = 23;
optional AttributeMap ideal_stats_required = 24;
}
Field Description
AP Status Tunnel Information
| Name | Value | Description |
|---|---|---|
| Online | 1 | AP state possible value |
| Flagged | 2 | AP state possible value |
Enum GeoLocation.GeoocationSource
| Name | Value | Since | Description |
|---|---|---|---|
| NO_LOCATION | 0 | ||
| MOBILE_APP | 1 | ||
| GPS | 2 | ||
| GEO_LOCATOR | 3 |
Enum AFCInfo.AFCStatus
| Name | Value | Since | Description |
|---|---|---|---|
| AFC_NOT_REQUIRED | 0 | ||
| WAIT_FOR_LOCATION | 1 | ||
| WAIT_FOR_RESPONSE | 2 | ||
| AFC_SERVER_FAILURE | 3 | ||
| REJECTED | 4 | ||
| PASSED | 5 |
AP Status Tunnel Information
| Attribute Name | ValueType (size) | Property(Snapshot/Delta/Serialization) | ValueAggregation Type(SUM,MAX,MIN,AVG,NULL) | Description |
|---|---|---|---|---|
| gw | string | snapshot | NULL | Application name |
| index | int32 | snapshot | NULL | Current tunnel index |
| type | int32 | snapshot | NULL | Tunnel type |
| isActive | int32 | 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. The AP received a frame completely, and AP has to allocate a memory for this frame. Then pass to next handler who interested to this frame. The AP drop the frame if it has no enough memory. The counter 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 no enough memory. Then the counter 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 plus one. |
| txFragPkts | uint64 | snapshot | SUM | Total fragmented Tx packets |
| uptime | string | snapshot | NULL | Tunnel uptime |
| reEstablishment | uint64 | snapshot | NULL | Number of tunnel reestablishment |
| kaRetryCnt | uint64 | snapshot | NULL | Keep alive retry count |
| kaSentCnt | uint64 | snapshot | NULL | Number of keep alive sent |
| kaLostCnt | uint64 | snapshot | NULL | Number of keep alive lost |
| reason | string | snapshot | NULL | Reason for last re-connection |
| suggest | string | snapshot | NULL | Reason for last re-connection |
| dpKey | string | snapshot | NULL | DP key |
AP Status IPSec Statistics
| Name | Value | Description |
|---|---|---|
| RUCKUSGRE | 0 | Tunnel type possible value |
| SOFTGRE | 1 | Tunnel type possible value |
AP Status IPSec Statistics
AP Status WLAN Information
AP Status Radio Information
AP Status Brownout Information
AP Status IPSec Information
AP Status System 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 |
| usbDeviceVersion | string | snapshot | NULL | USB device version |
| usbDeviceVID | string | snapshot | NULL | USB device VLAN ID |
| usbDevicePID | string | snapshot | NULL | USB device product ID (PID) |
| gpsInfo | string | snapshot | NULL | GPS information |
| countryCode | string | snapshot | NULL | Country code |
| seqNumber | uint64 | 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 |
| zoneName | string | snapshot | NULL | Zone name assigned by the controller. The admin configures the Zone name via controller's user interface. The controller passes it to the AP, which the zone name. |
| timeZone | string | snapshot | NULL | Time zone. The admin configure the time zone via SCG UI. Then SCG pass the time zone to APs. |
| gatewayIp | string | snapshot | NULL | Default gateway IP address of the AP |
| lastRebootReason | string | snapshot | NULL | Reason the AP was last rebooted |
| totalBootCount | uint32 | snapshot | NULL | Total number of reboots since the AP was last power cycled |
| mtuSize | uint32 | snapshot | NULL | AP br0 mtu setting. MTU stands for Maximum transmission unit. The admin could configure the size of MTU via SCG UI. Then SCG pass configuration to APs. So the max pake size is 1400 bytes if admin configure the MTU to 1400. The more details, see https://en.wikipedia.org/wiki/Maximum_transmission_unit. |
| rejoinCount | uint32 | snapshot | NULL | Number of times the AP rejoined the controller |
| rejoinReason | string | snapshot | NULL | Reason the AP rejoined the controller |
| oops | string | snapshot | NULL | Kernel oops if there is kernel panic. The AP logs crash point when AP's kernel panic happened. Then AP report the crash point to SCG after AP boots up again. |
| lossConnectBootCnt | uint32 | snapshot | NULL | Number of times the AP lost connection with the controller |
| deviceName | string | snapshot | NULL | Name of the AP |
| location | string | snapshot | NULL | Location of the AP |
| fwVersion | string | snapshot | NULL | Version of firmware installed on the AP |
| devSupportUsb | int | snapshot | NULL | Indicator for USB support on the AP . It could be 0 and 1. 0: not support, 1: support |
| deviceIpMode | int | snapshot | NULL | Current IP mode of the AP (IPv4 or IPv6) |
| ip | string | snapshot | NULL | IPv4 address of the AP |
| ipv6 | string | snapshot | NULL | IPv6 address of the AP |
| ipsecIp | string | snapshot | NULL | IPsec virtual IP address of the AP (only populated when IPsec is enabled) |
| apConnectedIp | string | snapshot | NULL | IP address the AP uses to connect to the controller. |
| uptime | long | snapshot | NULL | Duration since the AP was last rebooted . The unit is second. |
| mountState | string | snapshot | NULL | AP mount state |
| currentTemperature | int | snapshot | NULL | Current temperature inside the AP |
| lifeMaxTemperature | int | snapshot | NULL | Highest AP temperature ever recorded |
| lifeMinTemperature | int | snapshot | NULL | Lowest AP temperature ever recorded |
| dnatInfo | string | snapshot | NULL | rks_gre tunnel gateway IP address |
| rksDpIp | string | snapshot | NULL | Data blade IP address and port number |
| rksDpIpOnly | string | snapshot | NULL | Data blade IP address |
| ipType | string | snapshot | NULL | IPv4 or IPv6 |
| isIpTypeChanged | uint32 | snapshot | NULL | Fake data; should be removed |
| managementVlan | uint32 | snapshot | NULL | AP management VLAN ID |
| apState | string | snapshot | NULL | AP KPI status |
| isConnectionTotalCountFlagged | boolean | snapshot | NULL | AP KPI attribute "client total connection" flagging status |
| totalConnectedClient | uint32 | snapshot | NULL | AP KPI attribute "client total connection" number |
| crashDump | uint32 | snapshot | NULL | Indicator if there is crash dump is generated on AP or not |
| altitudeUnit | string | snapshot | NULL | GPS attribute : floor or meters |
| altitudeValue | uint32 | snapshot | NULL | GPS attribute: floor value |
| poeMode | uint32 | snapshot | NULL | 8023af PoE power source |
| poeModeSetting | uint32 | snapshot | NULL | 8023af PoE mode |
| ipv6Type | string | snapshot | NULL | AP IPv6 mode (static, pope, auto) |
| freeMemoryPercentage | double | snapshot | NULL | The percentage of AP free memory |
| freeStoragePercentage | double | snapshot | NULL | The percentage of AP free storage |
| poeUnderPowered | uint32 | snapshot | NULL | AP power level |
| chainmask5G | string | snapshot | NULL | AP 5 G Radio Chainmask |
| chainmask24G | string | snapshot | NULL | AP 2.4 G Radio Chainmask |
| isIoTEnable | bool | snapshot | NULL | AP - IoT Enabled or Not |
| isUSBEnable | bool | snapshot | NULL | AP - USB Enabled or Not |
| isPoEOutEnable | bool | snapshot | NULL | AP - PoE Out Enabled or Not |
| isSecEthEnable | bool | snapshot | NULL | AP - Secondary Ethernet Enabled or Not |
| config_id | string | snapshot | NULL | Device config ID |
| upd_config_id | string | snapshot | NULL | Device update config ID |
| config_status | .APStatusSystem.ConfigFwStatus | snapshot | NULL | Device config status |
| fw_upd_version | string | snapshot | NULL | Device firmware update version |
| fw_upd_status | .APStatusSystem.ConfigFwStatus | snapshot | NULL | Device update status |
| fw_upd_failed_reason | string | snapshot | NULL | Device firmware update failed reason |
| fw_request_id | string | snapshot | NULL | Device firmware request ID |
| config_failed_feature_name | string | snapshot | NULL | Device config failed feature name |
| config_failed_feature_attribute | string | snapshot | NULL | Device config failed feature attribute |
| config_failed_err_message | string | snapshot | NULL | Device config failed err message |
| config_failed_feature_attr_value | string | snapshot | NULL | Device config failed feature attr value |
| config_request_id | string | snapshot | NULL | Device config request ID |
| is_secure_boot_enable | int32 | snapshot | NULL | secure boot status (0: disabled 1: enabled) |
| powerProfile | string | snapshot | NULL | AP - Power profile in use |
| cpuPercentage | double | snapshot | NULL | The percentage of AP CPU using rate |
| totalMemory | uint64 | snapshot | NULL | AP totoal memory size |
| freeMemory | uint64 | snapshot | NULL | AP current free memory size |
| model | string | snapshot | NULL | AP model name |
| serialNumber | string | snapshot | NULL | The serial number in AP board data |
| desc | string | snapshot | NULL | AP model display string |
| numRadio | int32 | snapshot | NULL | Number of radio on AP |
| szConnCpIp | string | snapshot | NULL | SZ CP IPv4 address that is used by this AP connection. |
| szConnCpIpv6 | string | snapshot | NULL | SZ CP IPv6 address that is used by this AP connection. |
| szConnDpIp | string | snapshot | NULL | SZ DP IPv4 address that is used by this AP connection for tunnel traffic. |
| szConnDpIpv6 | string | snapshot | NULL | SZ DP IPv6 address that is used by this AP connection for tunnel traffic. |
| netmask | string | snapshot | NULL | The netmask is used by this AP network. |
| IpDnsSvr1 | string | snapshot | NULL | DNS server 1 IPv4 address that is used by this AP. |
| IpDnsSvr2 | string | snapshot | NULL | DNS server 2 IPv4 address that is used by this AP |
| Ipv6DnsSvr1 | string | snapshot | NULL | DNS server 1 IPv6 address that is used by this AP. |
| Ipv6DnsSvr2 | string | snapshot | NULL | DNS server 2 IPv6 address that is used by this AP. |
| ApStatus | int32 | snapshot | NULL | The status for AP connect to SZ |
| lastConfSyncTime | uint64 | snapshot | NULL | The timestamp for last configuration sync up. |
| freeStorage | uint64 | snapshot | NULL | AP free storage size |
| ethPortStatus | int32 | snapshot | NULL | AP Ethernet port status (up/down) |
| rxErrorPkts | uint64 | snapshot | NULL | RX error packet count on radio |
| txErrorPkts | uint64 | snapshot | NULL | TX error packet count on radio |
| RxDropPkts | uint64 | snapshot | NULL | RX packet drop count on radio |
| LanStatsRxBytes | uint64 | snapshot | NULL | AP ethernet port RX data bytes |
| LanStatsTxBytes | uint64 | snapshot | NULL | AP ethernet port TX data bytes |
| LanStatsRxPkts | uint64 | snapshot | NULL | AP ethernet port RX data packets |
| LanStatsTxPkts | uint64 | snapshot | NULL | AP ethernet port TX data packets |
| LanStatsRxErrorPkts | uint64 | snapshot | NULL | AP ethernet port RX error packet count |
| LanStatsTxErrorPkts | uint64 | snapshot | NULL | AP ethernet port TX error packet count |
| LanStatsRxDroppedPkts | uint64 | snapshot | NULL | AP ethernet port RX drop packet count |
| LanStatsTxDroppedPkts | uint64 | snapshot | NULL | AP ethernet port TX drop packet count |
| TxDropPkts | uint64 | snapshot | NULL | AP total TX drop packet count on wifi |
| chainmask6G | string | snapshot | NULL | AP 6G Radio Chainmask |