searchSiteJunosPorts
GET https://{{host}}/api/v1/sites/:site_id/stats/ports/search
Filter Options
| Name | Type | Description |
|---|
full_duplex | boolean | indicates full or half duplex |
mac | string | device identifier |
neighbor_mac | string | Chassis identifier of the chassis type listed |
neighbor_port_desc | string | Description supplied by the system on the interface E.g. “GigabitEthernet2/0/39” |
neighbor_system_name | string | Name supplied by the system on the interface E.g. neighbor system name E.g. “Kumar-Acc-SW.mist.local” |
poe_disabled | boolean | whether PoE capabilities are disabled for a port, default is false |
poe_mode | string | PoE mode depending on class. 802.3af / 802.3at / 802.3bt |
poe_on | boolean | is the device attached to POE |
port_id | string | interface name |
port_mac | string | interface mac address |
power_draw | float | Amount of power being used by the interface at the time the command is executed. Unit in watts. |
tx_pkts | int | Output packets |
rx_pkts | int | Input packets |
tx_bytes | int | Output bytes |
rx_bytes | int | Input bytes |
tx_bps | int | Output rate |
rx_bps | int | Input rate |
tx_errors | int | Output errors |
rx_errors | int | Input errors |
tx_mcast_pkts | int | Multicast output packets |
tx_bcast_pkts | int | Broadcast output packets |
rx_mcast_pkts | int | Multicast input packets |
rx_bcast_pkts | int | Broadcast input packets |
speed | int | port speed |
mac_limit | int | Limit on number of dynamically learned macs |
mac_count | int | Number of mac addresses in the forwarding table |
up | boolean | indicates if interface is up |
stp_state | string | if up == true, forwarding / blocking / learning / listening / disabled |
stp_role | string | if up == true, designated / backup / alternate / root / root-prevented |
xcvr_part_number | string | Optic Slot Partnumber, Check for null/empty |
auth_state | string | if up == true && has Authenticator role, init / authenticated / authenticating / held |
Request Params
| Key | Datatype | Required | Description |
|---|
full_duplex | null | | boolean:indicates full or half duplex |
mac | null | | string:device identifier |
neighbor_mac | null | | string:Chassis identifier of the chassis type listed |
neighbor_port_desc | null | | string:Description supplied by the system on the interface E.g. “GigabitEthernet2/0/39” |
neighbor_system_name | null | | string:Name supplied by the system on the interface E.g. neighbor system name E.g. “Kumar-Acc-SW.mist.local” |
poe_disabled | null | | boolean:is the POE configured not be disabled. |
poe_mode | null | | string:poe mode depending on class E.g. “802.3at” |
poe_on | null | | boolean:is the device attached to POE |
port_id | null | | string:interface name |
port_mac | null | | string:interface mac address |
power_draw | null | | float:Amount of power being used by the interface at the time the command is executed. Unit in watts. |
tx_pkts | null | | int:Output packets |
rx_pkts | null | | int:Input packets |
tx_bytes | null | | int:Output bytes |
rx_bytes | null | | int:Input bytes |
tx_bps | null | | int:Output rate |
rx_bps | null | | int:Input rate |
tx_errors | null | | int:Output errors |
rx_errors | null | | int:Input errors |
tx_mcast_pkts | null | | int:Multicast output packets |
tx_bcast_pkts | null | | int:Broadcast output packets |
rx_mcast_pkts | null | | int:Multicast input packets |
rx_bcast_pkts | null | | int:Broadcast input packets |
speed | null | | int:port speed |
up | null | | boolean:indicates if interface is up |
stp_state | null | | string:if up == true, forwarding / blocking / learning / listening / disabled |
stp_role | null | | string:if up == true, designated / backup / alternate / root / root-prevented |
xcvr_part_number | null | | string, Optic Slot Partnumber, Check for null/empty |
auth_state | null | | string:if up == true && has Authenticator role, init / authenticated / authenticating / held |