Family rt-link netlink specification

Summary

Link configuration over rtnetlink.

Operations

newlink

Create a new link.

attribute-set:

link-attrs

fixed-header:

ifinfomsg

do:

request

attributes:

[ifi-index, ifname, net-ns-pid, net-ns-fd, target-netnsid, link-netnsid, linkinfo, group, num-tx-queues, num-rx-queues, address, broadcast, mtu, txqlen, operstate, linkmode, group, gso-max-size, gso-max-segs, gro-max-size, gso-ipv4-max-size, gro-ipv4-max-size, af-spec]

dellink

Delete an existing link.

attribute-set:

link-attrs

fixed-header:

ifinfomsg

do:

request

attributes:

[ifi-index, ifname]

getlink

Get / dump information about a link.

attribute-set:

link-attrs

fixed-header:

ifinfomsg

do:

request

attributes:

[ifi-index, ifname, alt-ifname, ext-mask, target-netnsid]

reply

attributes:

[ifi-family, ifi-type, ifi-index, ifi-flags, ifi-change, address, broadcast, ifname, mtu, link, qdisc, stats, cost, priority, master, wireless, protinfo, txqlen, map, weight, operstate, linkmode, linkinfo, net-ns-pid, ifalias, num-vf, vfinfo-list, stats64, vf-ports, port-self, af-spec, group, net-ns-fd, ext-mask, promiscuity, num-tx-queues, num-rx-queues, carrier, phys-port-id, carrier-changes, phys-switch-id, link-netnsid, phys-port-name, proto-down, gso-max-segs, gso-max-size, pad, xdp, event, new-netnsid, if-netnsid, target-netnsid, carrier-up-count, carrier-down-count, new-ifindex, min-mtu, max-mtu, prop-list, alt-ifname, perm-address, proto-down-reason, parent-dev-name, parent-dev-bus-name, gro-max-size, tso-max-size, tso-max-segs, allmulti, devlink-port, gso-ipv4-max-size, gro-ipv4-max-size]

dump:

request

attributes:

[target-netnsid, ext-mask, master, linkinfo]

reply

attributes:

[ifi-family, ifi-type, ifi-index, ifi-flags, ifi-change, address, broadcast, ifname, mtu, link, qdisc, stats, cost, priority, master, wireless, protinfo, txqlen, map, weight, operstate, linkmode, linkinfo, net-ns-pid, ifalias, num-vf, vfinfo-list, stats64, vf-ports, port-self, af-spec, group, net-ns-fd, ext-mask, promiscuity, num-tx-queues, num-rx-queues, carrier, phys-port-id, carrier-changes, phys-switch-id, link-netnsid, phys-port-name, proto-down, gso-max-segs, gso-max-size, pad, xdp, event, new-netnsid, if-netnsid, target-netnsid, carrier-up-count, carrier-down-count, new-ifindex, min-mtu, max-mtu, prop-list, alt-ifname, perm-address, proto-down-reason, parent-dev-name, parent-dev-bus-name, gro-max-size, tso-max-size, tso-max-segs, allmulti, devlink-port, gso-ipv4-max-size, gro-ipv4-max-size]

setlink

Set information about a link.

attribute-set:

link-attrs

fixed-header:

ifinfomsg

do:

request

attributes:

[ifi-family, ifi-type, ifi-index, ifi-flags, ifi-change, address, broadcast, ifname, mtu, link, qdisc, stats, cost, priority, master, wireless, protinfo, txqlen, map, weight, operstate, linkmode, linkinfo, net-ns-pid, ifalias, num-vf, vfinfo-list, stats64, vf-ports, port-self, af-spec, group, net-ns-fd, ext-mask, promiscuity, num-tx-queues, num-rx-queues, carrier, phys-port-id, carrier-changes, phys-switch-id, link-netnsid, phys-port-name, proto-down, gso-max-segs, gso-max-size, pad, xdp, event, new-netnsid, if-netnsid, target-netnsid, carrier-up-count, carrier-down-count, new-ifindex, min-mtu, max-mtu, prop-list, alt-ifname, perm-address, proto-down-reason, parent-dev-name, parent-dev-bus-name, gro-max-size, tso-max-size, tso-max-segs, allmulti, devlink-port, gso-ipv4-max-size, gro-ipv4-max-size]

getstats

Get / dump link stats.

attribute-set:

stats-attrs

fixed-header:

if_stats_msg

do:

request

attributes:

[ifindex]

reply

attributes:

[family, ifindex, filter-mask, link-64, link-xstats, link-xstats-slave, link-offload-xstats, af-spec]

dump:

request

reply

attributes:

[family, ifindex, filter-mask, link-64, link-xstats, link-xstats-slave, link-offload-xstats, af-spec]

Multicast groups

• rtnlgrp-link

• rtnlgrp-stats

Definitions

ifinfo-flags

type:

flags

entries:

up:

broadcast:

debug:

loopback:

point-to-point:

no-trailers:

running:

no-arp:

promisc:

all-multi:

master:

slave:

multicast:

portsel:

auto-media:

dynamic:

lower-up:

dormant:

echo:

rtgenmsg

type:

struct

members:

family:

ifinfomsg

type:

struct

members:

ifi-family:

pad:

ifi-type:

ifi-index:

ifi-flags:

ifi-change:

ifla-bridge-id

type:

struct

members:

prio:

addr:

ifla-cacheinfo

type:

struct

members:

max-reasm-len:

tstamp:

reachable-time:

retrans-time:

rtnl-link-stats

type:

struct

members:

rx-packets:

tx-packets:

rx-bytes:

tx-bytes:

rx-errors:

tx-errors:

rx-dropped:

tx-dropped:

multicast:

collisions:

rx-length-errors:

rx-over-errors:

rx-crc-errors:

rx-frame-errors:

rx-fifo-errors:

rx-missed-errors:

tx-aborted-errors:

tx-carrier-errors:

tx-fifo-errors:

tx-heartbeat-errors:

tx-window-errors:

rx-compressed:

tx-compressed:

rx-nohandler:

rtnl-link-stats64

type:

struct

members:

rx-packets:

tx-packets:

rx-bytes:

tx-bytes:

rx-errors:

tx-errors:

rx-dropped:

tx-dropped:

multicast:

collisions:

rx-length-errors:

rx-over-errors:

rx-crc-errors:

rx-frame-errors:

rx-fifo-errors:

rx-missed-errors:

tx-aborted-errors:

tx-carrier-errors:

tx-fifo-errors:

tx-heartbeat-errors:

tx-window-errors:

rx-compressed:

tx-compressed:

rx-nohandler:

rx-otherhost-dropped:

rtnl-link-ifmap

type:

struct

members:

mem-start:

mem-end:

base-addr:

irq:

dma:

port:

ipv4-devconf

type:

struct

members:

forwarding:

mc-forwarding:

proxy-arp:

accept-redirects:

secure-redirects:

send-redirects:

shared-media:

rp-filter:

accept-source-route:

bootp-relay:

log-martians:

tag:

arpfilter:

medium-id:

noxfrm:

nopolicy:

force-igmp-version:

arp-announce:

arp-ignore:

promote-secondaries:

arp-accept:

arp-notify:

accept-local:

src-vmark:

proxy-arp-pvlan:

route-localnet:

igmpv2-unsolicited-report-interval:

igmpv3-unsolicited-report-interval:

ignore-routes-with-linkdown:

drop-unicast-in-l2-multicast:

drop-gratuitous-arp:

bc-forwarding:

arp-evict-nocarrier:

ipv6-devconf

type:

struct

members:

forwarding:

hoplimit:

mtu6:

accept-ra:

accept-redirects:

autoconf:

dad-transmits:

rtr-solicits:

rtr-solicit-interval:

rtr-solicit-delay:

use-tempaddr:

temp-valid-lft:

temp-prefered-lft:

regen-max-retry:

max-desync-factor:

max-addresses:

force-mld-version:

accept-ra-defrtr:

accept-ra-pinfo:

accept-ra-rtr-pref:

rtr-probe-interval:

accept-ra-rt-info-max-plen:

proxy-ndp:

optimistic-dad:

accept-source-route:

mc-forwarding:

disable-ipv6:

accept-dad:

force-tllao:

ndisc-notify:

mldv1-unsolicited-report-interval:

mldv2-unsolicited-report-interval:

suppress-frag-ndisc:

accept-ra-from-local:

use-optimistic:

accept-ra-mtu:

stable-secret:

use-oif-addrs-only:

accept-ra-min-hop-limit:

ignore-routes-with-linkdown:

drop-unicast-in-l2-multicast:

drop-unsolicited-na:

keep-addr-on-down:

rtr-solicit-max-interval:

seg6-enabled:

seg6-require-hmac:

enhanced-dad:

addr-gen-mode:

disable-policy:

accept-ra-rt-info-min-plen:

ndisc-tclass:

rpl-seg-enabled:

ra-defrtr-metric:

ioam6-enabled:

ioam6-id:

ioam6-id-wide:

ndisc-evict-nocarrier:

accept-untracked-na:

ifla-icmp6-stats

type:

struct

members:

inmsgs:

inerrors:

outmsgs:

outerrors:

csumerrors:

ratelimithost:

ifla-inet6-stats

type:

struct

members:

inpkts:

inoctets:

indelivers:

outforwdatagrams:

outpkts:

outoctets:

inhdrerrors:

intoobigerrors:

innoroutes:

inaddrerrors:

inunknownprotos:

intruncatedpkts:

indiscards:

outdiscards:

outnoroutes:

reasmtimeout:

reasmreqds:

reasmoks:

reasmfails:

fragoks:

fragfails:

fragcreates:

inmcastpkts:

outmcastpkts:

inbcastpkts:

outbcastpkts:

inmcastoctets:

outmcastoctets:

inbcastoctets:

outbcastoctets:

csumerrors:

noectpkts:

ect1-pkts:

ect0-pkts:

cepkts:

reasm-overlaps:

br-boolopt-multi

type:

struct

members:

optval:

optmask:

if_stats_msg

type:

struct

members:

family:

pad:

ifindex:

filter-mask:

Attribute sets

link-attrs

address (binary)

display-hint:

mac

broadcast (binary)

display-hint:

mac

ifname (string)

mtu (u32)

link (u32)

qdisc (string)

stats (binary)

struct:

rtnl-link-stats

cost (string)

priority (string)

master (u32)

wireless (string)

protinfo (string)

txqlen (u32)

map (binary)

struct:

rtnl-link-ifmap

weight (u32)

operstate (u8)

linkmode (u8)

linkinfo (nest)

nested-attributes:

linkinfo-attrs

net-ns-pid (u32)

ifalias (string)

num-vf (u32)

vfinfo-list (nest)

nested-attributes:

vfinfo-attrs

stats64 (binary)

struct:

rtnl-link-stats64

vf-ports (nest)

nested-attributes:

vf-ports-attrs

port-self (nest)

nested-attributes:

port-self-attrs

af-spec (nest)

nested-attributes:

af-spec-attrs

group (u32)

net-ns-fd (u32)

ext-mask (u32)

promiscuity (u32)

num-tx-queues (u32)

num-rx-queues (u32)

carrier (u8)

phys-port-id (binary)

carrier-changes (u32)

phys-switch-id (binary)

link-netnsid (s32)

phys-port-name (string)

proto-down (u8)

gso-max-segs (u32)

gso-max-size (u32)

pad (pad)

xdp (nest)

nested-attributes:

xdp-attrs

event (u32)

new-netnsid (s32)

target-netnsid (s32)

carrier-up-count (u32)

carrier-down-count (u32)

new-ifindex (s32)

min-mtu (u32)

max-mtu (u32)

prop-list (nest)

nested-attributes:

link-attrs

alt-ifname (string)

multi-attr:

True

perm-address (binary)

display-hint:

mac

proto-down-reason (string)

parent-dev-name (string)

parent-dev-bus-name (string)

gro-max-size (u32)

tso-max-size (u32)

tso-max-segs (u32)

allmulti (u32)

devlink-port (binary)

gso-ipv4-max-size (u32)

gro-ipv4-max-size (u32)

af-spec-attrs

inet (nest)

value:

2

nested-attributes:

ifla-attrs

inet6 (nest)

value:

10

nested-attributes:

ifla6-attrs

mctp (nest)

value:

45

nested-attributes:

mctp-attrs

vfinfo-attrs

vf-ports-attrs

port-self-attrs

linkinfo-attrs

kind (string)

data (sub-message)

sub-message:

linkinfo-data-msg

selector:

kind

xstats (binary)

slave-kind (string)

slave-data (sub-message)

sub-message:

linkinfo-member-data-msg

selector:

slave-kind

linkinfo-bridge-attrs

forward-delay (u32)

hello-time (u32)

max-age (u32)

ageing-time (u32)

stp-state (u32)

priority (u16)

vlan-filtering (u8)

vlan-protocol (u16)

group-fwd-mask (u16)

root-id (binary)

struct:

ifla-bridge-id

bridge-id (binary)

struct:

ifla-bridge-id

root-port (u16)

root-path-cost (u32)

topology-change (u8)

topology-change-detected (u8)

hello-timer (u64)

tcn-timer (u64)

topology-change-timer (u64)

gc-timer (u64)

group-addr (binary)

display-hint:

mac

fdb-flush (binary)

mcast-router (u8)

mcast-snooping (u8)

mcast-query-use-ifaddr (u8)

mcast-querier (u8)

mcast-hash-elasticity (u32)

mcast-hash-max (u32)

mcast-last-member-cnt (u32)

mcast-startup-query-cnt (u32)

mcast-last-member-intvl (u64)

mcast-membership-intvl (u64)

mcast-querier-intvl (u64)

mcast-query-intvl (u64)

mcast-query-response-intvl (u64)

mcast-startup-query-intvl (u64)

nf-call-iptables (u8)

nf-call-ip6-tables (u8)

nf-call-arptables (u8)

vlan-default-pvid (u16)

pad (pad)

vlan-stats-enabled (u8)

mcast-stats-enabled (u8)

mcast-igmp-version (u8)

mcast-mld-version (u8)

vlan-stats-per-port (u8)

multi-boolopt (binary)

struct:

br-boolopt-multi

mcast-querier-state (binary)

linkinfo-brport-attrs

state (u8)

priority (u16)

cost (u32)

mode (flag)

guard (flag)

protect (flag)

fast-leave (flag)

learning (flag)

unicast-flood (flag)

proxyarp (flag)

learning-sync (flag)

proxyarp-wifi (flag)

root-id (binary)

struct:

ifla-bridge-id

bridge-id (binary)

struct:

ifla-bridge-id

designated-port (u16)

designated-cost (u16)

id (u16)

no (u16)

topology-change-ack (u8)

config-pending (u8)

message-age-timer (u64)

forward-delay-timer (u64)

hold-timer (u64)

flush (flag)

multicast-router (u8)

pad (pad)

mcast-flood (flag)

mcast-to-ucast (flag)

vlan-tunnel (flag)

bcast-flood (flag)

group-fwd-mask (u16)

neigh-suppress (flag)

isolated (flag)

backup-port (u32)

mrp-ring-open (flag)

mrp-in-open (flag)

mcast-eht-hosts-limit (u32)

mcast-eht-hosts-cnt (u32)

locked (flag)

mab (flag)

mcast-n-groups (u32)

mcast-max-groups (u32)

neigh-vlan-suppress (flag)

backup-nhid (u32)

linkinfo-gre-attrs

link (u32)

iflags (u16)

oflags (u16)

ikey (u32)

okey (u32)

local (binary)

display-hint:

ipv4

remote (binary)

display-hint:

ipv4

ttl (u8)

tos (u8)

pmtudisc (u8)

encap-limit (u32)

flowinfo (u32)

flags (u32)

encap-type (u16)

encap-flags (u16)

encap-sport (u16)

encap-dport (u16)

collect-metadata (flag)

ignore-df (u8)

fwmark (u32)

erspan-index (u32)

erspan-ver (u8)

erspan-dir (u8)

erspan-hwid (u16)

linkinfo-geneve-attrs

id (u32)

remote (binary)

display-hint:

ipv4

ttl (u8)

tos (u8)

port (u16)

collect-metadata (flag)

remote6 (binary)

display-hint:

ipv6

udp-csum (u8)

udp-zero-csum6-tx (u8)

udp-zero-csum6-rx (u8)

label (u32)

ttl-inherit (u8)

df (u8)

inner-proto-inherit (flag)

linkinfo-iptun-attrs

link (u32)

local (binary)

display-hint:

ipv4

remote (binary)

display-hint:

ipv4

ttl (u8)

tos (u8)

encap-limit (u8)

flowinfo (u32)

flags (u16)

proto (u8)

pmtudisc (u8)

6rd-prefix (binary)

display-hint:

ipv6

6rd-relay-prefix (binary)

display-hint:

ipv4

6rd-prefixlen (u16)

6rd-relay-prefixlen (u16)

encap-type (u16)

encap-flags (u16)

encap-sport (u16)

encap-dport (u16)

collect-metadata (flag)

fwmark (u32)

linkinfo-tun-attrs

owner (u32)

group (u32)

type (u8)

pi (u8)

vnet-hdr (u8)

persist (u8)

multi-queue (u8)

num-queues (u32)

num-disabled-queues (u32)

linkinfo-vrf-attrs

table (u32)

xdp-attrs

fd (s32)

attached (u8)

flags (u32)

prog-id (u32)

drv-prog-id (u32)

skb-prog-id (u32)

hw-prog-id (u32)

expected-fd (s32)

ifla-attrs

conf (binary)

struct:

ipv4-devconf

ifla6-attrs

flags (u32)

conf (binary)

struct:

ipv6-devconf

stats (binary)

struct:

ifla-inet6-stats

mcast (binary)

cacheinfo (binary)

struct:

ifla-cacheinfo

icmp6-stats (binary)

struct:

ifla-icmp6-stats

token (binary)

addr-gen-mode (u8)

ra-mtu (u32)

mctp-attrs

mctp-net (u32)

stats-attrs

link-64 (binary)

struct:

rtnl-link-stats64

link-xstats (binary)

link-xstats-slave (binary)

link-offload-xstats (nest)

nested-attributes:

link-offload-xstats

af-spec (binary)

link-offload-xstats

cpu-hit (binary)

hw-s-info (array-nest)

nested-attributes:

hw-s-info-one

l3-stats (binary)

hw-s-info-one

request (u8)

used (u8)

Sub-messages

linkinfo-data-msg

• bridge

  attribute-set:

  linkinfo-bridge-attrs

• erspan

  attribute-set:

  linkinfo-gre-attrs

• gre

  attribute-set:

  linkinfo-gre-attrs

• gretap

  attribute-set:

  linkinfo-gre-attrs

• geneve

  attribute-set:

  linkinfo-geneve-attrs

• ipip

  attribute-set:

  linkinfo-iptun-attrs

• sit

  attribute-set:

  linkinfo-iptun-attrs

• tun

  attribute-set:

  linkinfo-tun-attrs

• vrf

  attribute-set:

  linkinfo-vrf-attrs

linkinfo-member-data-msg

• bridge

  attribute-set:

  linkinfo-brport-attrs

• bond