Family rt-nexthop netlink specification

Summary

Nexthop object management over rtnetlink.

Operations

newnexthop

Add new nexthop entry

attribute-set:

nexthop-attrs

do:

request

attributes:

[id, group, group-type, blackhole, oif, gateway, encap-type, encap, fdb, res-group, hw-stats-enable, dst-port]

delnexthop

Delete nexthop with given id.

attribute-set:

nexthop-attrs

do:

request

attributes:

[id]

getnexthop

Get or dump nexthop entries

attribute-set:

nexthop-attrs

do:

request

attributes:

[id, op-flags]

reply

attributes:

[id, group, group-type, blackhole, oif, gateway, encap-type, encap, fdb, res-group, op-flags, group-stats, hw-stats-enable, hw-stats-used, dst-port]

dump:

request

attributes:

[oif, groups, master, fdb, op-flags]

reply

attributes:

[id, group, group-type, blackhole, oif, gateway, encap-type, encap, fdb, res-group, op-flags, group-stats, hw-stats-enable, hw-stats-used, dst-port]

newnexthop-ntf

Notification about a created nexthop.

value:

104

notify:

getnexthop

delnexthop-ntf

Notification about a deleted nexthop.

value:

105

notify:

getnexthop

getnexthopbucket

Get or dump nexthop buckets

attribute-set:

nexthop-attrs

do:

request

attributes:

[id, res-bucket]

reply

attributes:

[id, res-bucket]

dump:

request

attributes:

[id, oif, master, res-bucket]

reply

attributes:

[id, res-bucket]

newnexthopbucket-ntf

Notification about a created nexthop bucket.

value:

116

notify:

getnexthopbucket

Multicast groups

• rtnlgrp-nexthop

Definitions

nhmsg

type:

struct

members:

nh-family (u8):

nh-scope (u8):

nh-protocol (u8):

resvd (pad):

nh-flags (u32):

rtnh-f

type:

flags

name-prefix:

rtnh-f-

enum-name:

None

entries:

• dead

• pervasive

• onlink

• offload

• linkdown

• unresolved

• trap

nexthop-grp

type:

struct

members:

id (u32):

weight (u8):

weight-high (u8):

resvd2 (pad):

nexthop-grp-type

type:

enum

name-prefix:

nexthop-grp-type-

enum-name:

None

entries:

• mpath

• res

encap-type

type:

enum

name-prefix:

lwtunnel-encap-

enum-name:

None

entries:

• none

• mpls

• ip

• ila

• ip6

• seg6

• bpf

• seg6-local

• rpl

• ioam6

• xfrm

seg6-local-actions

type:

enum

name-prefix:

seg6-local-action-

enum-name:

None

entries:

• unspec

• end

• end-x

• end-t

• end-dx2

• end-dx6

• end-dx4

• end-dt6

• end-dt4

• end-b6

• end-b6-encap

• end-bm

• end-s

• end-as

• end-am

• end-bpf

• end-dt46

seg6-local-flv-ops

type:

enum

name-prefix:

seg6-local-flv-op-

enum-name:

None

entries:

unspec:

psp:

usp:

usd:

next-csid:

nha-op-flag

type:

flags

name-prefix:

nha-op-flag-

enum-name:

None

entries:

• dump-stats

• dump-hw-stats

nha-op-flag-resp-grp-resvd-0

type:

const

value:

2147483648

Attribute sets

nexthop-attrs

id (u32)

group (binary)

group-type (u16)

enum:

nexthop-grp-type

blackhole (flag)

oif (u32)

gateway (binary)

display-hint:

ipv4-or-v6

encap-type (u16)

enum:

encap-type

encap (sub-message)

sub-message:

encap-data

selector:

encap-type

groups (flag)

master (u32)

fdb (flag)

res-group (nest)

nested-attributes:

res-group-attrs

res-bucket (nest)

nested-attributes:

res-bucket-attrs

op-flags (u32)

group-stats (nest)

nested-attributes:

group-stats-attrs

hw-stats-enable (u32)

hw-stats-used (u32)

dst-port (u16)

byte-order:

big-endian

mpls-iptunnel

dst (binary)

ttl (u8)

lwtunnel-ip

id (u64)

byte-order:

big-endian

dst (u32)

byte-order:

big-endian

display-hint:

ipv4

src (u32)

byte-order:

big-endian

display-hint:

ipv4

ttl (u8)

tos (u8)

flags (u16)

byte-order:

big-endian

pad (pad)

opts (nest)

nested-attributes:

lwtunnel-ip-opts

ila-attrs

locator (u64)

byte-order:

big-endian

identifier (u64)

locator-match (u64)

byte-order:

big-endian

ifindex (s32)

dir (u32)

pad (pad)

csum-mode (u8)

ident-type (u8)

hook-type (u8)

lwtunnel-ip6

id (u64)

byte-order:

big-endian

dst (binary)

display-hint:

ipv6

src (binary)

display-hint:

ipv6

hoplimit (u8)

tc (u8)

flags (u16)

byte-order:

big-endian

pad (pad)

opts (nest)

nested-attributes:

lwtunnel-ip-opts

seg6-iptunnel

srh (binary)

src (binary)

display-hint:

ipv6

table (u32)

lwt-bpf

in (nest)

nested-attributes:

lwt-bpf-prog

out (nest)

nested-attributes:

lwt-bpf-prog

xmit (nest)

nested-attributes:

lwt-bpf-prog

xmit-headroom (u32)

seg6-local

action (u32)

enum:

seg6-local-actions

srh (binary)

table (u32)

nh4 (u32)

byte-order:

big-endian

display-hint:

ipv4

nh6 (binary)

display-hint:

ipv6

iif (u32)

oif (u32)

bpf (nest)

nested-attributes:

seg6-local-bpf

vrftable (u32)

counters (nest)

nested-attributes:

seg6-local-cnt

flavors (nest)

nested-attributes:

seg6-local-flv

rpl-iptunnel

srh (binary)

ioam6-iptunnel

mode (u8)

dst (binary)

display-hint:

ipv6

trace (binary)

freq-k (u32)

freq-n (u32)

src (binary)

display-hint:

ipv6

lwt-xfrm

if-id (u32)

link (u32)

lwtunnel-ip-opts

geneve (binary)

vxlan (nest)

nested-attributes:

lwtunnel-ip-opt-vxlan

erspan (nest)

nested-attributes:

lwtunnel-ip-opt-erspan

lwtunnel-ip-opt-vxlan

gbp (u32)

lwtunnel-ip-opt-erspan

ver (u8)

index (u32)

byte-order:

big-endian

dir (u8)

hwid (u8)

lwt-bpf-prog

fd (u32)

name (string)

seg6-local-bpf

prog (u32)

prog-name (string)

seg6-local-cnt

pad (pad)

packets (u64)

bytes (u64)

errors (u64)

seg6-local-flv

operation (u32)

enum:

seg6-local-flv-ops

enum-as-flags:

True

lcblock-bits (u8)

lcnode-fn-bits (u8)

res-group-attrs

pad (pad)

value:

0

buckets (u16)

idle-timer (u32)

unbalanced-timer (u32)

unbalanced-time (u64)

res-bucket-attrs

pad (pad)

value:

0

index (u16)

idle-time (u64)

nh-id (u32)

group-stats-attrs

entry (nest)

nested-attributes:

group-stats-entry-attrs

multi-attr:

True

group-stats-entry-attrs

id (u32)

packets (uint)

packets-hw (uint)

Sub-messages

encap-data

• mpls

  attribute-set:

  mpls-iptunnel

• ip

  attribute-set:

  lwtunnel-ip

• ila

  attribute-set:

  ila-attrs

• ip6

  attribute-set:

  lwtunnel-ip6

• seg6

  attribute-set:

  seg6-iptunnel

• bpf

  attribute-set:

  lwt-bpf

• seg6-local

  attribute-set:

  seg6-local

• rpl

  attribute-set:

  rpl-iptunnel

• ioam6

  attribute-set:

  ioam6-iptunnel

• xfrm

  attribute-set:

  lwt-xfrm