The Linux Kernel Logo
  • Development process
  • Submitting patches
  • Code of conduct
  • Maintainer handbook
  • All development-process docs
  • Core API
  • Driver APIs
  • Subsystems
    • Core subsystems
    • Human interfaces
    • Networking interfaces
      • Networking
        • AF_XDP
        • Bare UDP Tunnelling Module Documentation
        • batman-adv
        • SocketCAN - Controller Area Network
        • The UCAN Protocol
        • Hardware Device Drivers
        • Networking Diagnostics
        • Distributed Switch Architecture
        • Linux Devlink Documentation
        • CAIF
        • Netlink interface for ethtool
        • IEEE 802.15.4 Developer’s Guide
        • ISO 15765-2 (ISO-TP)
        • J1939 Documentation
        • Linux Networking and Network Devices APIs
        • MSG_ZEROCOPY
        • FAILOVER
        • Net DIM - Generic Network Dynamic Interrupt Moderation
        • NET_FAILOVER
        • Page Pool API
        • PHY Abstraction Layer
        • phylink
        • IP-Aliasing
        • Ethernet Bridging
        • SNMP counter
        • Checksum Offloads
        • Segmentation Offloads
        • Scaling in the Linux Networking Stack
        • Kernel TLS
        • Kernel TLS offload
        • In-Kernel TLS Handshake
        • Linux NFC subsystem
        • Netdev private dataroom for 6lowpan interfaces
        • 6pack Protocol
        • ARCnet Hardware
        • ARCnet
        • ATM
        • AX.25
        • Linux Ethernet Bonding Driver HOWTO
        • cdc_mbim - Driver for CDC MBIM Mobile Broadband modems
        • DCCP protocol
        • DCTCP (DataCenter TCP)
        • Device Memory TCP
        • DNS Resolver Module
        • Softnet Driver Issues
        • EQL Driver: Serial IP Load Balancing HOWTO
        • LC-trie implementation notes
        • Linux Socket Filtering aka Berkeley Packet Filter (BPF)
        • Generic HDLC layer
        • Generic Netlink
        • Netlink Family Specifications
          • Family conntrack netlink specification
          • Family devlink netlink specification
          • Family dpll netlink specification
          • Family ethtool netlink specification
          • Family fou netlink specification
          • Family handshake netlink specification
          • Family lockd netlink specification
          • Family mptcp_pm netlink specification
          • Family net-shaper netlink specification
          • Family netdev netlink specification
          • Family nfsd netlink specification
          • Family nftables netlink specification
          • Family nl80211 netlink specification
          • Family nlctrl netlink specification
          • Family ovs_datapath netlink specification
          • Family ovs_flow netlink specification
          • Family ovs_vport netlink specification
          • Family rt-addr netlink specification
          • Family rt-link netlink specification
          • Family rt-neigh netlink specification
            • Summary
            • Operations
              • newneigh
              • delneigh
              • delneigh-ntf
              • getneigh
              • newneigh-ntf
              • getneightbl
              • setneightbl
            • Multicast groups
            • Definitions
              • ndmsg
              • ndtmsg
              • nud-state
              • ntf-flags
              • ntf-ext-flags
              • rtm-type
              • nda-cacheinfo
              • ndt-config
              • ndt-stats
            • Attribute sets
              • neighbour-attrs
                • unspec (binary)
                • dst (binary)
                • lladdr (binary)
                • cacheinfo (binary)
                • probes (u32)
                • vlan (u16)
                • port (u16)
                • vni (u32)
                • ifindex (u32)
                • master (u32)
                • link-netnsid (s32)
                • src-vni (u32)
                • protocol (u8)
                • nh-id (u32)
                • fdb-ext-attrs (binary)
                • flags-ext (u32)
                • ndm-state-mask (u16)
                • ndm-flags-mask (u8)
              • ndt-attrs
                • name (string)
                • thresh1 (u32)
                • thresh2 (u32)
                • thresh3 (u32)
                • config (binary)
                • parms (nest)
                • stats (binary)
                • gc-interval (u64)
                • pad (pad)
              • ndtpa-attrs
                • ifindex (u32)
                • refcnt (u32)
                • reachable-time (u64)
                • base-reachable-time (u64)
                • retrans-time (u64)
                • gc-staletime (u64)
                • delay-probe-time (u64)
                • queue-len (u32)
                • app-probes (u32)
                • ucast-probes (u32)
                • mcast-probes (u32)
                • anycast-delay (u64)
                • proxy-delay (u64)
                • proxy-qlen (u32)
                • locktime (u64)
                • queue-lenbytes (u32)
                • mcast-reprobes (u32)
                • pad (pad)
                • interval-probe-time-ms (u64)
          • Family rt-route netlink specification
          • Family rt-rule netlink specification
          • Family tc netlink specification
          • Family tcp_metrics netlink specification
          • Family team netlink specification
        • Generic networking statistics for netlink users
        • The Linux kernel GTP tunneling module
        • Identifier Locator Addressing (ILA)
        • IOAM6 Sysfs variables
        • io_uring zero copy Rx
        • IP dynamic address hack-port v0.03
        • IPsec
        • IP Sysctl
        • IPv6
        • IPVLAN Driver HOWTO
        • IPvs-sysctl
        • Kernel Connection Multiplexor
        • L2TP
        • The Linux LAPB Module Interface
        • How to use packet injection with mac80211
        • Management Component Transport Protocol (MCTP)
        • MPLS Sysfs variables
        • Multipath TCP (MPTCP)
        • MPTCP Sysfs variables
        • HOWTO for multiqueue network device support
        • Multi-PF Netdev
        • NAPI
        • Common Networking Struct Cachelines
        • Netconsole
        • Netdev features mess and how to get out from it alive
        • Network Devices, the Kernel, and You!
        • Netfilter Sysfs variables
        • NETIF Msg Level
        • Netmem Support for Network Drivers
        • Resilient Next-hop Groups
        • Netfilter Conntrack Sysfs variables
        • Netfilter’s flowtable infrastructure
        • OPEN Alliance 10BASE-T1x MAC-PHY Serial Interface (TC6) Framework Support
        • Open vSwitch datapath developer documentation
        • Operational States
        • Packet MMAP
        • Linux Phonet protocol family
        • PHY link topology
        • HOWTO for the linux packet generator
        • PLIP: The Parallel Line Internet Protocol Device
        • PPP Generic Driver and Channel Interface
        • The proc/net/tcp and proc/net/tcp6 variables
        • Power Sourcing Equipment (PSE) Documentation
        • How to use radiotap headers
        • RDS
        • Linux wireless regulatory documentation
        • Network Function Representors
        • RxRPC Network Protocol
        • SOCKET OPTIONS
        • SECURITY
        • EXAMPLE CLIENT USAGE
        • Linux Kernel SCTP
        • LSM/SeLinux secid
        • Seg6 Sysfs variables
        • struct sk_buff
        • SMC Sysctl
        • NIC SR-IOV APIs
        • Interface statistics
        • Stream Parser (strparser)
        • Ethernet switch device driver model (switchdev)
        • Sysfs tagging
        • TC Actions - Environmental Rules
        • TC queue based filtering
        • TCP Authentication Option Linux implementation (RFC5925)
        • Thin-streams and TCP
        • Team
        • Timestamping
        • Linux Kernel TIPC
        • Transparent proxy support
        • Universal TUN/TAP device driver
        • The UDP-Lite protocol (RFC 3828)
        • Virtual Routing and Forwarding (VRF)
        • Virtual eXtensible Local Area Networking documentation
        • Linux X.25 Project
        • X.25 Device Driver Interface
        • XFRM device - offloading the IPsec computations
        • XFRM proc - /proc/net/xfrm_* files
        • XFRM
        • XFRM Syscall
        • XDP RX Metadata
        • AF_XDP TX Metadata
      • NetLabel
      • InfiniBand
      • ISDN
      • MHI
    • Storage interfaces
    • Other subsystems
  • Locking
  • Licensing rules
  • Writing documentation
  • Development tools
  • Testing guide
  • Hacking guide
  • Tracing
  • Fault injection
  • Livepatching
  • Rust
  • Administration
  • Build system
  • Reporting issues
  • Userspace tools
  • Userspace API
  • Firmware
  • Firmware and Devicetree
  • CPU architectures
  • Unsorted documentation
  • Translations
The Linux Kernel
  • Kernel subsystem documentation
  • Networking
  • Netlink Family Specifications
  • Family rt-neigh netlink specification
  • View page source

Family rt-neigh netlink specification¶

Contents

  • Family rt-neigh netlink specification

    • Summary

    • Operations

      • newneigh

      • delneigh

      • delneigh-ntf

      • getneigh

      • newneigh-ntf

      • getneightbl

      • setneightbl

    • Multicast groups

    • Definitions

      • ndmsg

      • ndtmsg

      • nud-state

      • ntf-flags

      • ntf-ext-flags

      • rtm-type

      • nda-cacheinfo

      • ndt-config

      • ndt-stats

    • Attribute sets

      • neighbour-attrs

      • ndt-attrs

      • ndtpa-attrs

Summary¶

IP neighbour management over rtnetlink.

Operations¶

newneigh¶

Add new neighbour entry

fixed-header:

ndmsg

attribute-set:

neighbour-attrs

do:
request
attributes:

[dst, lladdr, probes, vlan, port, vni, ifindex, master, protocol, nh-id, flags-ext, fdb-ext-attrs]

delneigh¶

Remove an existing neighbour entry

fixed-header:

ndmsg

attribute-set:

neighbour-attrs

do:
request
attributes:

[dst, ifindex]

delneigh-ntf¶

Notify a neighbour deletion

value:

29

notify:

delneigh

fixed-header:

ndmsg

getneigh¶

Get or dump neighbour entries

fixed-header:

ndmsg

attribute-set:

neighbour-attrs

do:
request
attributes:

[dst]

reply
attributes:

[dst, lladdr, probes, vlan, port, vni, ifindex, master, protocol, nh-id, flags-ext, fdb-ext-attrs]

dump:
request
attributes:

[ifindex, master]

reply
attributes:

[dst, lladdr, probes, vlan, port, vni, ifindex, master, protocol, nh-id, flags-ext, fdb-ext-attrs]

newneigh-ntf¶

Notify a neighbour creation

value:

28

notify:

getneigh

fixed-header:

ndmsg

getneightbl¶

Get or dump neighbour tables

fixed-header:

ndtmsg

attribute-set:

ndt-attrs

dump:

request

reply
attributes:

[name, thresh1, thresh2, thresh3, config, parms, stats, gc-interval]

setneightbl¶

Set neighbour tables

fixed-header:

ndtmsg

attribute-set:

ndt-attrs

do:
request
attributes:

[name, thresh1, thresh2, thresh3, parms, gc-interval]

Multicast groups¶

  • rtnlgrp-neigh

Definitions¶

ndmsg¶

type:

struct

members:
ndm-family (u8):

ndm-pad (pad):

ndm-ifindex (s32):

ndm-state (u16):

ndm-flags (u8):

ndm-type (u8):

ndtmsg¶

type:

struct

members:
family (u8):

nud-state¶

type:

flags

entries:
  • incomplete

  • reachable

  • stale

  • delay

  • probe

  • failed

  • noarp

  • permanent

ntf-flags¶

type:

flags

entries:
  • use

  • self

  • master

  • proxy

  • ext-learned

  • offloaded

  • sticky

  • router

ntf-ext-flags¶

type:

flags

entries:
  • managed

  • locked

rtm-type¶

type:

enum

entries:
  • unspec

  • unicast

  • local

  • broadcast

  • anycast

  • multicast

  • blackhole

  • unreachable

  • prohibit

  • throw

  • nat

  • xresolve

nda-cacheinfo¶

type:

struct

members:
confirmed (u32):

used (u32):

updated (u32):

refcnt (u32):

ndt-config¶

type:

struct

members:
key-len (u16):

entry-size (u16):

entries (u32):

last-flush (u32):

last-rand (u32):

hash-rnd (u32):

hash-mask (u32):

hash-chain-gc (u32):

proxy-qlen (u32):

ndt-stats¶

type:

struct

members:
allocs (u64):

destroys (u64):

hash-grows (u64):

res-failed (u64):

lookups (u64):

hits (u64):

rcv-probes-mcast (u64):

rcv-probes-ucast (u64):

periodic-gc-runs (u64):

forced-gc-runs (u64):

table-fulls (u64):

Attribute sets¶

neighbour-attrs¶

unspec (binary)¶

value:

0

dst (binary)¶

display-hint:

ipv4

lladdr (binary)¶

display-hint:

mac

cacheinfo (binary)¶

struct:

nda-cacheinfo

probes (u32)¶

vlan (u16)¶

port (u16)¶

vni (u32)¶

ifindex (u32)¶

master (u32)¶

link-netnsid (s32)¶

src-vni (u32)¶

protocol (u8)¶

nh-id (u32)¶

fdb-ext-attrs (binary)¶

flags-ext (u32)¶

enum:

ntf-ext-flags

ndm-state-mask (u16)¶

ndm-flags-mask (u8)¶

ndt-attrs¶

name (string)¶

thresh1 (u32)¶

thresh2 (u32)¶

thresh3 (u32)¶

config (binary)¶

struct:

ndt-config

parms (nest)¶

nested-attributes:

ndtpa-attrs

stats (binary)¶

struct:

ndt-stats

gc-interval (u64)¶

pad (pad)¶

ndtpa-attrs¶

ifindex (u32)¶

refcnt (u32)¶

reachable-time (u64)¶

base-reachable-time (u64)¶

retrans-time (u64)¶

gc-staletime (u64)¶

delay-probe-time (u64)¶

queue-len (u32)¶

app-probes (u32)¶

ucast-probes (u32)¶

mcast-probes (u32)¶

anycast-delay (u64)¶

proxy-delay (u64)¶

proxy-qlen (u32)¶

locktime (u64)¶

queue-lenbytes (u32)¶

mcast-reprobes (u32)¶

pad (pad)¶

interval-probe-time-ms (u64)¶

Previous Next

© Copyright The kernel development community.

Built with Sphinx using a theme provided by Read the Docs.