Qodex.ai

getSiteDevicesStats

GET https://{{host}}/api/v1/sites/:site_id/stats/devices

Device Stat Definition

Also see Device Config

NameTypeDescription
macstringdevice mac
modelstringdevice model
typestringdevice type, ap / ble
serialstringserial
versionstringfirmware version
last_seenlonglast seen timestamp
namestringdevice name if configured
hostnamestringhostname reported by the device
ipstringIP address
ext_ipstringExternal / Public IP
statusstringconnected / disconnected / restarting / upgrading
uptimelonghow long, in seconds, has the device been up (or rebooted)
num_clientsinthow many wireless clients are currently connected
tx_bpsfloatrate of transmitting traffic to the clients, bits/seconds, last known
rx_bpsfloatrate of receiving traffic from the clients, bits/seconds, last known
tx_bytesfloatamount of transmitting traffic to the clients, since reboot
rx_bytesfloatamount of receiving traffic from the clients, since reboot
tx_pktsfloatamount of transmitting traffic to the clients, since reboot
rx_pktsfloatamount of receiving traffic from the clients, since reboot
locatingbooleanwhether the device is in locating mode (LED blinking)
ip_configobjectIP config, see Device Config
ip_statobjectcurrent IP information, see Device Config
module_statarraydevice chassis stats, member index == array index (e.g. member 0 is at index 0)
if_statobjecta map of interface stats
memory_statobjectmemory usage stat (for virtual chassis, memory usage of master RE)
cpu_statobjecta map of CPU usage stat
module_stat.vc_rolestringdevice chassis stack role (e.g. master/backup)
ipsobjectall IPs the devices has, internal interface name -> CIDR mapping
radio_configobjecta map of radio config, see Device Config
ledobjectdevice LED control, see Device Config
env_statobjectdevice environment, including CPU temperature, Ambient temperature, Humidity, Attitude, Pressure, Accelerometers, Magnetometers and vCore Voltage
lockedbooleanwhether this AP is considered locked (placement / orientation has been vetted)
last_troubleobjectlast trouble code of switch
auto_placementobjectauto placement stats
has_pcapbooleanwhether the switch supports packet capture

Radio Config / Status

NameTypeDescription
radio_statobjecta map of radio stats, key can be band24 / band5
band_24objectradio stat of 2.4G radio
band_5objectradio stat of 5G radio
band_6objectradio stat of 6G radio
macstringradio (base) mac, it can have 16 bssids (e.g. 5c5b350001a0-5c5b350001af)
channelintcurrent channel the radio is running on
bandwidthintcurrent channel bandwidth, 20 / 40 / 80 / 160
powerinttransmit power (in dBm)
util_allintall utilization in percentage
util_txinttransmission utilization in percentage
util_rx_in_bssintreception of “In BSS” utilization in percentage, only frames that are received from AP/STAs within the BSS
util_rx_other_bssintreception of “Other BSS” utilization in percentage, all frames received from AP/STAs that are outside the BSS
util_unknown_wifiintreception of “No Category” utilization in percentage, all 802.11 frames that are corrupted at the receiver
util_non_wifiintreception of “No Packets” utilization in percentage, received frames with invalid PLCPs and CRC glitches as noise
util_undecodable_wifiintreception of “UnDecodable Wifi” utilization in percentage, only Preamble, PLCP header is decoded, Rest is undecodable in this radio
dynamic_chaining_enabledbooleanUse dynamic chaining for downlink
tx_chainintnumber of chains to use for tx. This is only used when dynamic chaining is not enabled
rx_chainintnumber of chains to use for rx. This is only used when dynamic chaining is not enabled

Port Status

NameTypeDescription
port_statobjectsports status
eth0objectport status of eth0 (eth0+PoE)
eth1objectport status of eth1
eth2objectport status of eth2
eth3objectport status of eth3
moduleobjectport status of module port
upbooleanwhether the port is up, default is false (down)
speedint10 / 100 / 1000 / 2500, Mbps (mega bits per second)
full_duplexbooleantrue / false
  • port_stat: different type/model of devices may have different number of ports

L2TP Status

NameTypeDescription
l2tp_statobjectsl2tp tunnel status (key is the wxtunnel_id)
wxtunnel_idstringWxlanTunnel ID
statestringidle / wait-ctrl-reply / wait-ctrl-conn / established / establishedwithsessions
uptimeintuptime
sessionslistlist of sessions
remote_idstringWxlanTunnel Remote ID (user-configured)
remote_sidintremote sessions id (dynamically unless Tunnel is said to be static)
local_sidintremote sessions id (dynamically unless Tunnel is said to be static)

LLDP Status

NameTypeDescription
lldp_statobjectsLLDP Stat (neighbor information, power negotiations)
system_namestringname of the switch, e.g. “TC2-OWL-Stack-01”
system_descstringdescription provided by switch, e.g. “HP J9729A 2920-48G-POE+ Switch”
port_descstringport description, e.g. “2/20”, “Port 2 on Switch0”
mgmt_addressstringswitch’s management address (if advertised), can be IPv4, IPv6, or MAC
lldp_med_supportedbooleanwhether it support LLDP-MED
power_request_countintnumber of negotiations, if it keeps increasing, we don’t have a stable power
power_allocatedintin mW, provided/allocated by PSE
power_requestedintin mW, the current power requested by PD
power_drawintin mW, total power needed by PD
power_srcstringDC Input / PoE 802.3at / PoE 802.3af / LLDP / ? (unknown)
power_budgetintin mW, surplus if positie or deficit if negative
power_constrainedbooleanwhether insufficient power
power_opmodestringconstrained mode

BLE Stat

NameTypeDescription
ble_statobjectsBLE stats
tx_pktsfloatTxBytes
tx_bytesfloatTxCommands
tx_resetsfloatresets due to tx hung
rx_pktsfloatRxEvents
rx_bytesfloatRxBytes
ibeacon_enabledbooleanWhether iBeacon is Enabled
ibeacon_uuidstringUUID value for iBeacon
ibeacon_majorintMajor number for iBeacon
ibeacon_minorintMinor number for iBeacon
eddystone_uid_enabledbooleanWhether Eddystone-UID beacon is enabled
eddystone_uid_namespacestringEddystone-UID namespace
eddystone_uid_instancestringEddystone-UID instance for the device
eddystone_uid_freq_msecintFrequency (msec) of data emmit by Eddystone-UID beacon
eddystone_url_enabledbooleanWhether Eddystone-URL beacon is enabled
eddystone_url_urlstringURL pointed by Eddystone-URL beacon
eddystone_url_freq_msecintFrequency (msec) of data emmit by Eddystone-UID beacon

Firmware Upgrade Status

NameTypeDescription
fwupdateobjectlast firmware update status
timestampfloattimestamp
statusstringstarting / inprogress / success / error
status_idintthe internal status id
progressintprogress of upgrading expressed in percentage

Interface Stat

NameTypeDescription
port_idstringinterface name
tx_pktsintOutput packets
rx_pktsintInput packets
tx_bytesintOutput bytes
rx_bytesintInput bytes
upbooleanwhether the port is up, default is false (down)

CPU Stat

NameTypeDescription
systemintPercentage of CPU time being used by system processes
idleintPercentage of CPU time that is idle
interruptintPercentage of CPU time being used by interrupts
userintPercentage of CPU time being used by user processes
load_avgarrayLoad averages for the last 1, 5, and 15 minutes

Last Trouble

NameTypeDescription
codeenumlast trouble code of the switch reported by lldp neighbors
timestamplongtimestamp of last trouble code reported
Trouble Code Possible Values
CodeDescription
102No DHCP lease received on any interface
103No default gateway
104Gateway unreachable
105No DNS server
106DNS lookup failed
108Agent cannot connect to controller
109Authentication failed
110Underlying service (i.e. Netconf/SSH/HTTPS) is down
113DNS failure with Mist cloud
114Empty DNS response with Mist cloud

Autoplacement Stats

NameTypeDescription
xfloatX Autoplaced Position in pixels
yfloatY Autoplaced Position in pixels
x_mfloatX Autoplaced Position in meters
y_mfloatY Autoplaced Position in meters
statusstringBasic Placement Status
status_detailstringAdditional info about placement status
use_auto_placementbooleanFlag to represent if auto_placement values are currently utilized
recommended_anchorbooleanFlag to represent if AP is recommended as an anchor by auto placement service
infoobjectAdditional information about auto placements AP data
Auto Placement Info
NameTypeDescription
cluster_numberintAll APs sharing a given cluster number can be placed relative to each other
orientation_stateintThe orientation of an AP
probability_surfaceobjectCoordinates representing a circle where the AP is most likely exists in the event of an inaccurate placement result
Auto Placement Probability Surface
NameTypeDescription
radiusfloatThe radius representing placement uncertainty, measured in pixels
radius_mfloatThe radius representing placement uncertainty, measured in meters
xfloatX-coordinate of the potential placement’s center, measured in pixels
yfloatY-coordinate of the potential placement’s center, measured in pixels

RESPONSES

status: OK

{"mac":"dc38e1dbf3cd","model":"SRX320","type":"gateway","serial":"TC3714190003","last_seen":1553203563,"name":"sj1","hostname":"sj1","status":"connected","version":"18.4R1.8","ip":"10.2.11.137","uptime":13500,"ip_stat":{"ip":"10.2.11.137","netmask":"255.255.192.0","gateway":"10.2.1.1","ip6":"2607:f8b0:4005:808::2004","netmask6":"/32","gateway6":"2607:f8b0:4005:808::1","dns":["8.8.8.8","4.4.4.4"],"dns_suffix":[".mist.local",".mist.com"],"ips":{"vlan1":"10.2.1.1/24,2607:f8b0:4005:808::1/32","vlan193":"10.73.1.31/16","vlan3157":"10.72.11.14/24"}},"cpu_stat":{"interrupt":8,"idle":28,"user":23,"system":41,"load_avg":[0.9700000286102295,1.0499999523162842,1.0199999809265137]},"memory_stat":{"usage":35},"spu_stat":{"cpu":15,"memory":32,"sessions":{"current":41,"valid":15,"pending":12,"max":65535}},"module_stat":[{"vc_role":"master","model":"EX4300-48P","serial":"PX8716230021","fans":[{"name":"Fan 0","status":"absent"},{"name":"Fan 1","airflow":"out","status":"ok"}],"temperatures":[{"name":"CPU","status":"ok","celsius":45.0}],"psus":[{"name":"Power Supply 0","status":"ok"},{"name":"Power Supply 1","status":"failed"}],"poe":{"max_power":250.0,"power_draw":120.3},"vc_links":[{"port_id":"vcp-255/1/0","neighbor_module_idx":1,"neighbor_port_id":"vcp-255/1/0"}],"errors":[{"type":"FW_UPGRADE_REQUIRED_BY_FEATURE","since":1657497600,"feature":"Mist-Management","minimum_version":"128T-6.0.0-1"},{"type":"INACTIVE","since":1657497600},{"type":"HA_FW_MISMATCH","since":1658244424},{"type":"HA_FORMATION_FAILED","since":1658277429,"reason":"config invalid"},{"type":"CONFIG_OUT_OF_SYNC","since":1684825000.123456},{"type":"UNABLE_TO_CONNECT_TO_LOG_SERVER","since":1709203262}]}],"ip2_stat":{},"dhcpd2_stat":{},"cpu2_stat":{},"memory2_stat":{},"spu2_stat":{},"module2_stat":{},"cluster_stat":{"node0":{"status":""},"node1":{"status":""}},"ap_redundancy":{"num_aps":15,"num_aps_with_switch_redundancy":8,"modules":{"1":{"num_aps":15,"num_aps_with_switch_redundancy":8}}}}