Family rt-neigh netlink specification

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)