VPP dataplane mini command reference

[DanPartelly]

INTERFACE
create interface af_xdp [name ifname] [rx-queue-size size] [tx-queue-size size] [num-rx-queues <num|all>] [prog pathname] [netns ns] [zero-copy|no-zero-copy] [no-syscall-lock]
create interface avf [rx-queue-size ] [tx-queue-size ] [num-rx-queues ]
create interface memif [id ] [socket-id ] [ring-size ] [buffer-size ] [hw-addr ] <master|slave> [rx-queues ] [tx-queues ] [mode ip] [secret ]
create interface rdma [name ] [rx-queue-size ] [tx-queue-size ] [num-rx-queues ] [mode <auto|ibv|dv>] [no-multi-seg] [no-striding] [max-pktlen ]
create interface virtio [feature-mask ] [tx-queue-size ] [gso-enabled] [csum-enabled] [rss-enabled] [buffering [size ]] [packed] [bind [force]]
create interface vmxnet3 [rx-queue-size ] [tx-queue-size ] [num-tx-queues ] [num-rx-queues ] [bind [force]] [gso]

create host-interface [v2] name [num-rx-queues ] [num-tx-queues ] [hw-addr ] [mode ip] [qdisc-bypass-disable] [cksum-gso-disable]

create loopback interface [mac ] [instance ]

create sub-interfaces { [default|untagged]} | {-} | { dot1q|dot1ad |any [inner-dot1q |any] [exact-match]}

set interface name

set interface ip address [del] / | [all]
set interface ip table
set interface unnumbered [ use | del ]

set interface feature <feature_name> arc <arc_name> [disable]
set interface promiscuous [on|off]
set interface state [up|down|punt|enable]
set interface mac address
set interface secondary-mac-address [(add|del)]

set interface proxy-arp [enable|disable]
set interface reassembly [on|off|ip4|ip6]
set interface mtu [packet|ip4|ip6|mpls]

set interface tcp-mss-clamp ip4 [enable|disable|rx|tx] ip4-mss ip6 [enable|disable|rx|tx] ip6-mss

set interface span [l2] {disable | destination [both|rx|tx]}

enable ip4 interface
enable ip6 interface
disable ip6 interface

show interface [address|addr|features|feat|vtr|tag] [ [ [..]]] [verbose]
show interface secondary-mac-address []
show interface rx-placement
show interface tx-hash [interface]

show interface span

L3 cross connect

l3xc [add|del] via ...

BRIDGING

create bridge-domain [learn <0|1>] [forward <0|1>] [uu-flood <0|1>] [flood <0|1>] [arp-term <0|1>] [arp-ufwd <0|1>] [mac-age ] [bd-tag ] [del]

bvi create [mac ] [instance ]

show bridge-domain
show l2fib [all] | [bd_id | bd_index ] [learn | add] | [raw]

set bridge-domain arp entry [ [del] | del-all]
set bridge-domain arp term [disable]

set bridge-domain arp-ufwd [disable]

set bridge-domain forward [disable]
set bridge-domain flood [disable]

set bridge-domain default-learn-limit
set bridge-domain learn [disable]
set bridge-domain learn-limit

set bridge-domain mac-age

set bridge-domain rewrite [disable]

set interface l2 bridge [bvi|uu-fwd] [shg]

set interface l2 efp-filter [disable]
set interface l2 tag-rewrite [disable | pop {1|2} | push {dot1q|dot1ad} ]
set interface l2 pbb-tag-rewrite [disable | pop | push | translate_pbb_stag <outer_tag> dmac

smac s_id [b_vlanid ]]
set interface l2 rewrite [table ] [miss-index ]

set interface l2 flood [disable]
set interface l2 forward [disable]
set interface l2 learn [disable]

set interface l2 xconnect

set interface l2 xcrw next
[del] [tx-fib-id ] [ipv6] rw

set interface l2 input classify intfc [ip4-table ]
[ip6-table ] [other-table ]

set interface l2 output classify intfc <> [ip4-table ]
[ip6-table ] [other-table ]

set interface l3

ACL
set interface input acl intfc [ip4-table ]
[ip6-table ] [l2-table ] [ip4-punt-table ]
[ip6-punt-table [del]

set interface output acl intfc [ip4-table ]
[ip6-table ] [l2-table ] [del]

TUNNELS

create teib peer nh [nh-table-id ]

create gre tunnel src dst [instance ] [outer-fib-id ] [teb | erspan ] [del] [multipoint]
show gre tunnel

PVTI
pvti interface create peer [ local-ip ][ underlay-mtu ][underlay-table ][inderlay-fib ]
pvti interface delete if-index

WIREGUARD

wireguard create listen-port private-key src [generate-key]
wireguard delete
wireguard peer add <wg_int> public-key <pub_key_other> endpoint <ip4_dst> allowed-ip dst-port [port_dst] persistent-keepalive [keepalive_interval]
wireguard peer remove

set wireguard async mode on|off

show wireguard interface show wireguard
show wireguard mode show wireguard mode
show wireguard peer show wireguard peer

TOOLS
arping [gratuitous] {addr} {interface} [interval {sec}] [repeat {cnt}]
ping { | ipv4 | ipv6 } [ipv4 | ipv6 ] [source ] [size pktsize:60] [interval sec:1] [repeat cnt:5] [table-id id:0] [burst count:1] [verbose]