Qodex.ai

searchSiteSwOrGwPorts

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

Supported FiltersName

NameTypeDescription
full_duplexbooleanindicates full or half duplex
macstringdevice identifier
device_typestringdevice type, ap / ble / switch / gateway / mxedge / nac
port_usagestringgateway port usage, wan / lan
neighbor_macstringChassis identifier of the chassis type listed
neighbor_port_descstringDescription supplied by the system on the interface E.g. “GigabitEthernet2/0/39”
neighbor_system_namestringName supplied by the system on the interface E.g. neighbor system name E.g. “Kumar-Acc-SW.mist.local”
poe_disabledbooleanwhether PoE capabilities are disabled for a port, default is false
poe_modestringPoE mode depending on class. 802.3af / 802.3at / 802.3bt
poe_onbooleanis the device attached to POE
port_idstringinterface name
port_macstringinterface mac address
power_drawfloatAmount of power being used by the interface at the time the command is executed. Unit in watts.
tx_pktsintOutput packets
rx_pktsintInput packets
tx_bytesintOutput bytes
rx_bytesintInput bytes
tx_bpsintOutput rate
rx_bpsintInput rate
tx_errorsintOutput errors
rx_errorsintInput errors
tx_mcast_pktsintMulticast output packets
tx_bcast_pktsintBroadcast output packets
rx_mcast_pktsintMulticast input packets
rx_bcast_pktsintBroadcast input packets
speedintport speed
mac_limitintLimit on number of dynamically learned macs
mac_countintNumber of mac addresses in the forwarding table
upbooleanindicates if interface is up
stp_statestringif up == true, forwarding / blocking / learning / listening / disabled
stp_rolestringif up == true, designated / backup / alternate / root / root-prevented
xcvr_part_numberstringOptic Slot Partnumber, Check for null/empty
xcvr_serialstringOptic Slot SerialNumber, Check for null/empty
xcvr_modelstringOptic Slot ModelName, Check for null/empty
auth_statestringif up == true && has Authenticator role, init / authenticated / authenticating / held
lte_imsistringLTE IMSI value, Check for null/empty
lte_iccidstringLTE ICCID value, Check for null/empty
lte_imeistringLTE IMEI value, Check for null/empty
activebooleanIndicates if interface is active/inactive
jitterfloatLast sampled jitter of the interface
lossfloatLast sampled loss of the interface
latencyfloatLast sampled latency of the interface
unconfiguredbooleanindicates if interface is unconfigured

E.g. /api/v1/sites/:siteid/stats/switchports/search?mac=001122334455

RESPONSES

status: OK

"{\n    \"start\": 1511967600,\n    \"end\": 1513177200,\n    \"limit\": 10,\n    \"total\": 100,\n    \"results\": [\n         {\n            \"rx_bytes\": 4563443626,\n            \"rx_pkts\": 30360265,\n            \"xcvr_part_number\":\"740-021487\",\n            \"xcvr_serial\":\"N6AA9HT\",\n            \"xcvr_model\":\"SFP+-10G-SR\",\n            \"site_id\": \"c1698122-c14c-11e5-8e81-1258369c38a9\",\n            \"neighbor_system_name\": \"CORP-D-SW-2\",\n            \"org_id\": \"c168ddee-c14c-11e5-8e81-1258369c38a9\",\n            \"up\": true,\n            \"port_mac\": \"5c4527a96580\",\n            \"neighbor_port_desc\": \"GigabitEthernet1/0/21\",\n            \"tx_pkts\": 14610886,\n            \"mac\": \"5c4527a96580\",\n            \"tx_bytes\": 11299516780,\n            \"neighbor_mac\": \"64d814353400\",\n            \"poe_disabled\": true,\n            \"speed\": 1000,\n            \"port_id\": \"me0\"\n        },\n        {\n            \"rx_bps\": 1176,\n            \"rx_bytes\": 2628451,\n            \"rx_pkts\": 11829,\n            \"org_id\": \"c168ddee-c14c-11e5-8e81-1258369c38a9\",\n            \"full_duplex\": true,\n            \"site_id\": \"c1698122-c14c-11e5-8e81-1258369c38a9\",\n            \"up\": true,\n            \"poe_mode\": \"802.3at\",\n            \"port_mac\": \"0c8126c6ff6f\",\n            \"mac\": \"0c8126c6ff6c\",\n            \"tx_pkts\": 492176,\n            \"neighbor_port_desc\": \"ETH0\",\n            \"tx_bps\": 14264,\n            \"port_id\": \"ge-0/0/0\",\n            \"tx_bytes\": 96810192,\n            \"neighbor_mac\": \"5c5b350eb361\",\n            \"neighbor_system_name\": \"kevinsap\",\n            \"speed\": 1000,\n            \"poe_on\": true,\n            \"power_draw\": 5.4\n        },\n        ...\n    ]\n}"