Ethernet (IEEE802.3)
After 2026-10-R1, the Kismet IEEE802.3 phy tracks wired Ethernet devices, from the wired data source and from pcap and kismetdb replays of Ethernet captures. Ethernet devices are listed in the phy-IEEE802.3 device view, and carry an ethernet.device record:
| Field | Contents |
|---|---|
ethernet.device.vlans | VLANs the device sent on, each with ethernet.device.vlan.tags (1 for 802.1Q, where VLAN 0 is priority tagged; 2 or more for QinQ), .vid (outer tag), .inner_vid (second tag, 0 with one tag), .first_time, .last_time, and .packets |
ethernet.device.ipv4, ethernet.device.ipv6 | Addresses, each with ethernet.device.ip.address, .source (arp, dhcp, dhcpv6, or traffic), .first_time, and .last_time |
ethernet.device.names | Names the device announced, each with ethernet.device.name.name (unprintable bytes escaped), .source (dhcp_hostname, dhcp_fqdn, dhcpv6_fqdn), .first_time, and .last_time |
ethernet.device.dhcp_prl, .dhcp_vendor, .dhcp_client_id | DHCP parameter request list (option 55), vendor class (option 60), and client ID (option 61, hex) |
ethernet.device.dhcpv6_duid, .dhcpv6_vendor, .dhcpv6_oro | DHCPv6 client DUID (hex), vendor class, and option request list |
ethernet.device.tx_bytes, ethernet.device.rx_bytes | Bytes sent, and received as a unicast destination |
ethernet.device.tx_unicast, .tx_multicast, .tx_broadcast | Frames sent, by kind of destination |
ethernet.device.protocols | Protocols sent, a bitfield: 1 ARP, 2 IPv4, 4 IPv6, 8 TCP, 16 UDP, 32 ICMP, 64 ICMPv6, 128 DHCP, 256 DHCPv6, 512 LLC, 1024 VLAN tagged, 2048 QinQ, 4096 other |
ethernet.device.roles | Roles seen, a bitfield: 1 DHCP server, 2 DHCPv6 server, 4 gateway (named in a DHCP router option), 8 DNS server (named in a DHCP DNS option) |
The field list of a running server gives every field, with its description.
Ethernet flows
wired_max_flows on the
wired source page), newest packet
first. Parameters may be sent as GET variables or in a POST JSON body; a malformed parameter is
an error rather than a default. Flows are never written to a log.readonly/phy/ethernet/flows/flows.json/phy/ethernet/flows/flows.ekjson/phy/ethernet/flows/flows.prettyjsonGET
POSTPARAMETERS
mac
string
OPTIONALOnly flows to or from this MAC address.
ip
string
OPTIONALOnly flows to or from this IPv4 or IPv6 address.
vlan
number
OPTIONALOnly flows on this VLAN ID, 0 to 4095.
start
number
OPTIONALIndex of the first flow to return; default 0.
length
number
OPTIONALNumber of flows to return, 1 to 1000; default 100.
PARAMETERS
This endpoint takes additional parameters by using a `POST` request and supplying a
JSON document or json form variable.
You can find more information about API parameters here.
fields
field simplification
OPTIONALKismet can reduce the amount of information being processed and returned by an API by simplifying the fields to only return the data needed by the caller.
You can read more about the field simplification API and how to use it here.
JSON object with the matching flows in ethernet.flows.flows, the number of flows matching in
ethernet.flows.total, and the index of the first one returned in ethernet.flows.start.
Each flow has:
| Field | Contents |
|---|---|
ethernet.flow.family | Address family, 4 or 6 |
ethernet.flow.proto | IP protocol |
ethernet.flow.addr_a, ethernet.flow.port_a | Address and port of side a |
ethernet.flow.addr_b, ethernet.flow.port_b | Address and port of side b |
ethernet.flow.mac_a, ethernet.flow.mac_b | MAC address of each side |
ethernet.flow.vlan_tags | VLAN tags, 0 untagged |
ethernet.flow.vid, ethernet.flow.inner_vid | Outer and second VLAN ID |
ethernet.flow.initiator | Side which sent the first packet seen, a or b |
ethernet.flow.bytes_ab, ethernet.flow.bytes_ba | Bytes each way |
ethernet.flow.packets_ab, ethernet.flow.packets_ba | Packets each way |
ethernet.flow.first_time, ethernet.flow.last_time | Times of the first and last packet |
ethernet.flow.tcp_flags_ab, ethernet.flow.tcp_flags_ba | TCP flags seen from each side, ORed |
Ethernet VLANs
readonly/phy/ethernet/vlans/vlans.json/phy/ethernet/vlans/vlans.ekjson/phy/ethernet/vlans/vlans.prettyjsonGET
POSTPARAMETERS
This endpoint takes additional parameters by using a `POST` request and supplying a
JSON document or json form variable.
You can find more information about API parameters here.
fields
field simplification
OPTIONALKismet can reduce the amount of information being processed and returned by an API by simplifying the fields to only return the data needed by the caller.
You can read more about the field simplification API and how to use it here.
JSON list of VLANs:
| Field | Contents |
|---|---|
ethernet.vlan.tags | VLAN tags, 0 untagged |
ethernet.vlan.vid | Outer VLAN ID |
ethernet.vlan.inner_vid | Second VLAN ID |
ethernet.vlan.first_time, ethernet.vlan.last_time | Times of the first and last frame |
ethernet.vlan.packets | Frames |
ethernet.vlan.bytes | Bytes, as on the wire |
ethernet.vlan.devices | Devices which sent on the VLAN |
Ethernet devices by IP
readonly/phy/ethernet/by-ip/{IP}/devices.json/phy/ethernet/by-ip/{IP}/devices.ekjson/phy/ethernet/by-ip/{IP}/devices.prettyjsonGET
POSTPARAMETERS
IP
string
REQUIREDIPv4 or IPv6 address; an IPv6 address is URL encoded, as 2001%3Adb8%3A%3A1
PARAMETERS
This endpoint takes additional parameters by using a `POST` request and supplying a
JSON document or json form variable.
You can find more information about API parameters here.
fields
field simplification
OPTIONALKismet can reduce the amount of information being processed and returned by an API by simplifying the fields to only return the data needed by the caller.
You can read more about the field simplification API and how to use it here.
Ethernet status
readonly/phy/ethernet/status/status.json/phy/ethernet/status/status.ekjson/phy/ethernet/status/status.prettyjsonGET
POSTPARAMETERS
This endpoint takes additional parameters by using a `POST` request and supplying a
JSON document or json form variable.
You can find more information about API parameters here.
fields
field simplification
OPTIONALKismet can reduce the amount of information being processed and returned by an API by simplifying the fields to only return the data needed by the caller.
You can read more about the field simplification API and how to use it here.
| Field | Contents |
|---|---|
ethernet.status.frames | Ethernet frames processed |
ethernet.status.malformed | Malformed frames |
ethernet.status.devices | Ethernet devices tracked |
ethernet.status.max_devices | wired_max_devices, 0 for no limit |
ethernet.status.devices_capped | New source MACs not tracked because wired_max_devices was reached |
ethernet.status.new_device_rate | wired_new_device_rate, 0 for no limit |
ethernet.status.devices_rate_limited | New source MACs not tracked because of wired_new_device_rate |
ethernet.status.devices_evicted | Devices which sent only a frame or two, forgotten at wired_max_devices to make room |
ethernet.status.flows | Flows tracked |
ethernet.status.max_flows | wired_max_flows, 0 when flows are off |
ethernet.status.flows_created, ethernet.status.flows_expired | Flows created and expired |
ethernet.status.flows_dropped | New flows dropped with the table full |
ethernet.status.flows_deferred | New flows held for a second packet with the table nearly full |
ethernet.status.ip_bindings | IP to MAC bindings |
ethernet.status.ip_bindings_dropped | Bindings dropped with the table full |
ethernet.status.vlans_dropped | VLANs not added to the inventory because it was full |
ethernet.status.future_timestamps | Frames dated more than a minute past the server clock |