countOrgSwOrGwPorts

GET https://{{host}}/api/v1/orgs/:org_id/stats/ports/count

Request

In addition to the filters

NameTypeDescription
distinctstringportid, portmac, fullduplex, mac, neighbormac, neighborportdesc, neighborsystemname, poedisabled, poemode, poe_on, speed, up

Supported FiltersName

NameTypeDescription
full_duplexbooleanindicates full or half duplex
macstringdevice identifier
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_disabledbooleanis the POE configured not be disabled.
poe_modestringpoe mode depending on class E.g. “802.3at”
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
auth_statestringif up == true && has Authenticator role, init / authenticated / authenticating / held

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

RESPONSES

status: OK

{"start":1511967600,"end":1513177200,"limit":100,"distinct":"mac","total":20,"results":[{"count":217,"mac":"112233445566"},{"count":35,"mac":"001122334455"}]}