GET /api/v1/sites/{site_id}/stats/ports/search
Operation ID: searchSiteSwOrGwPorts
Auth: unknown
Description
Search Switch / Gateway Ports
Parameters (35)
(string, query, optional)
if `up`==`true` && has Authenticator role
Constraints: {'enum': ['init', 'authenticated', 'authenticating', 'held']}
(string, query, optional, default: 1d)
For historical stats and/or logs where time range is needed, you can specify the time range in a few different ways: * ?start=1430000000&end=1430864000 specify the start / end * ?end=1430864000&duration=1d specify end time and duration * ?duration=1d specify duration, end will be now() in seconds
(integer, query, optional, default: 0)
Constraints: {'minimum': 0}
(boolean, query, optional)
indicates full or half duplex
(integer, query, optional, default: 100)
Constraints: {'minimum': 0}
(string, query, optional)
device identifier
(integer, query, optional)
Number of mac addresses in the forwarding table
(integer, query, optional)
Limit on number of dynamically learned macs
(string, query, optional)
Chassis identifier of the chassis type listed
(string, query, optional)
Description supplied by the system on the interface E.g. “GigabitEthernet2/0/39”
(string, query, optional)
Name supplied by the system on the interface E.g. neighbor system name E.g. “Kumar-Acc-SW.mist.local”
(boolean, query, optional)
is the POE configured not be disabled.
(string, query, optional)
poe mode depending on class E.g. “802.3at”
(boolean, query, optional)
is the device attached to POE
(string, query, optional)
interface name
(string, query, optional)
interface mac address
(number, query, optional)
Amount of power being used by the interface at the time the command is executed. Unit in watts.
(integer, query, optional)
Broadcast input packets
(integer, query, optional)
Input rate
(integer, query, optional)
Input bytes
(integer, query, optional)
Input errors
(integer, query, optional)
Multicast input packets
(integer, query, optional)
Input packets
(string, path, required)
(integer, query, optional)
port speed
(integer, query, optional, default: 0)
Constraints: {'minimum': 0}
(string, query, optional)
if `up`==`true`
Constraints: {'enum': ['designated', 'backup', 'alternate', 'root', 'root-prevented']}
(string, query, optional)
if `up`==`true`
Constraints: {'enum': ['forwarding', 'blocking', 'learning', 'listening', 'disabled']}
(integer, query, optional)
Broadcast output packets
(integer, query, optional)
Output rate
(integer, query, optional)
Output errors
(integer, query, optional)
Multicast output packets
(integer, query, optional)
Output packets
(boolean, query, optional)
indicates if interface is up
(string, query, optional)
Optic Slot Partnumber, Check for null/empty
No probe data for this endpoint yet.