GET /api/v1/sites/{site_id}/stats/ports/count

mist.com

Summary: countSiteByDisctinctAttributesOfSwitchPorts
Operation ID: countSiteByDisctinctAttributesOPorts
Auth: unknown
Description

Count by Distinct Attributes of Switch/Gateway Ports

Parameters (32)

auth_state (string, query, optional)

if `up`==`true` && has Authenticator role

Constraints: {'enum': ['init', 'authenticated', 'authenticating', 'held']}

distinct (string, query, optional, default: mac)

port_id, port_mac, full_duplex, mac, neighbor_macneighbor_port_desc, neighbor_system_name, poe_disabled, poe_mode, poe_on, speed, up

Constraints: {'enum': ['port_id', 'port_mac', 'full_duplex', 'mac', 'neighbor_mac', 'neighbor_port_desc', 'neighbor_system_name', 'poe_disabled', 'poe_mode', 'poe_on', 'speed', 'up']}

duration (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

end (integer, query, optional, default: 0)

Constraints: {'minimum': 0}

full_duplex (boolean, query, optional)

indicates full or half duplex

limit (integer, query, optional, default: 100)

Constraints: {'minimum': 0}

mac (string, query, optional)

device identifier

neighbor_mac (string, query, optional)

Chassis identifier of the chassis type listed

neighbor_port_desc (string, query, optional)

Description supplied by the system on the interface E.g. “GigabitEthernet2/0/39”

neighbor_system_name (string, query, optional)

Name supplied by the system on the interface E.g. neighbor system name E.g. “Kumar-Acc-SW.mist.local”

page (integer, query, optional, default: 1)

Constraints: {'minimum': 1}

poe_disabled (boolean, query, optional)

is the POE configured not be disabled.

poe_mode (string, query, optional)

poe mode depending on class E.g. “802.3at”

poe_on (boolean, query, optional)

is the device attached to POE

port_id (string, query, optional)

interface name

port_mac (string, query, optional)

interface mac address

power_draw (number, query, optional)

Amount of power being used by the interface at the time the command is executed. Unit in watts.

rx_bcast_pkts (integer, query, optional)

Broadcast input packets

rx_bps (integer, query, optional)

Input rate

rx_bytes (integer, query, optional)

Input bytes

rx_mcast_pkts (integer, query, optional)

Multicast input packets

rx_pkts (integer, query, optional)

Input packets

site_id (string, path, required)
speed (integer, query, optional)

port speed

start (integer, query, optional, default: 0)

Constraints: {'minimum': 0}

stp_role (string, query, optional)

if `up`==`true`

Constraints: {'enum': ['designated', 'backup', 'alternate', 'root', 'root-prevented']}

stp_state (string, query, optional)

if `up`==`true`

Constraints: {'enum': ['forwarding', 'blocking', 'learning', 'listening', 'disabled']}

tx_bcast_pkts (integer, query, optional)

Broadcast output packets

tx_bps (integer, query, optional)

Output rate

tx_mcast_pkts (integer, query, optional)

Multicast output packets

tx_pkts (integer, query, optional)

Output packets

up (boolean, query, optional)

indicates if interface is up

No probe data for this endpoint yet.