VPP CLI Commands
This page summarizes useful VPP CLI commands with documentation and example outputs.
- Show commands
- Create Commands
Start with show or shorter version sh.
All show commands
vpp# show help
abf show abf commands
acl-plugin show acl-plugin commands
adj show adj [<adj_index>] [interface] [summary]
api Show API information
app show app [server|client] [verbose]
arp-nd-event show arp-nd-event commands
bfd show bfd [keys|sessions|echo-source]
bier show bier commands
bond show bond [details]
bridge-domain show bridge-domain [bridge-domain-id [detail|int|arp|bd-tag]]
buffers Show packet buffer allocation
cdp Show cdp command
classify show classify commands
cli Show cli commands
cli-sessions Show current CLI sessions
cpu Show cpu information
dhcp6 show dhcp6 commands
dhcpv6 show dhcpv6 commands
dhcp show dhcp commands
dns show dns commands
dpo show dpo commands
dslite show dslite commands
errors Show error counts
event-logger Show event logger info
features show features
fib show fib commands
flow show flow commands
flowprobe show flowprobe commands
frame-queue show frame-queue trace
gbp show gbp commands
gdb Describe functions which can be called from gdb
geneve show geneve commands
gpe show gpe commands
gre show gre commands
gtpu show gtpu commands
hardware-interfaces show hardware-interfaces [brief|verbose|detail] [bond] [<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]]
igmp show igmp commands
ikev2 show ikev2 commands
ila show ila commands
inacl show inacl type [ip4|ip6|l2]
interface show interface [address|addr|features|feat] [<interface> [<interface> [..]]] [verbose]
ioam-trace show ioam-trace commands
ioam show ioam commands
ip4-reassembly show ip4-reassembly [details]
ip6-ll show ip6-ll [summary] [interface] [<ip6-addr>[/<width>]] [detail]
ip6-reassembly show ip6-reassembly [details]
ipip show ipip commands
ipsec show ipsec
ip Internet protocol (IP) show commands
ip6 Internet protocol version 6 (IPv6) show commands
l2fib show l2fib [all] | [bd_id <nn> | bd_index <nn>] [learn | add] | [raw]
l2patch Show l2 interface cross-connect entries
l2 show l2 commands
l2tpv3 show l2tpv3 [verbose]
l2xcrw show l2xcrw
lacp show lacp [<interface>] [details]
lb show lb
lisp show lisp commands
lldp show lldp [detail]
load-balance show load-balance [<index>]
load-balance-map show load-balance-map [<index>]
logging show logging
lookup-dpo show lookup-dpo [<index>]
mactime show mactime [verbose]
map show map commands
memif show memif [<interface>] [descriptors]
memory [verbose | api-segment] Show current memory usage
mfib show mfib commands
mode show mode [<if-name1> <if-name2> ...]
mpls show mpls commands
nat show nat commands
nat44 show nat44 commands
nat64 show nat64 commands
nat66 show nat66 commands
node show node [index] <node-name | node-index>
nsh show nsh commands
nsim Display network delay simulator configuration
oam show oam
one show one commands
outacl show outacl type [ip4|ip6|l2]
packet-generator Show packet generator streams
pci show pci [all]
physmem Show physical memory allocation
plugins show loaded plugins
pmc show pmc [verbose]
policer show policer [name]
pot show pot commands
pppoe show pppoe commands
qos show qos commands
replicate show replicate [<index>]
runtime Show packet processing runtime
segment-manager show segment-manager [segments][verbose]
session show session [verbose [nnn]]
sr show sr commands
statistics show statistics commands
stn show stn commands
svs Source VRF select show
tap show tap {<interface>] [descriptors]
tcp show tcp commands
terminal Show current session terminal settings
threads Show threads
trace Show trace buffer [max COUNT]
udp show udp commands
udp-ping show udp-ping commands
unix show unix commands
version show version [verbose] [cmdline]
vhost-user show vhost-user [<interface> [<interface> [..]]] [descriptors]
vlib show vlib commands
vmxnet3 show vmxnet3 [[<interface>] ([desc] | ([rx-comp] | [rx-desc-0] | [rx-desc-1] | [tx-comp] | [tx-desc]) [<slot>])]
vxlan show vxlan commands
vxlan-gbp show vxlan-gbp commands
vxlan-gpe show vxlan-gpe commands
show interfaces
This command will list all interfaces:
Name Idx State MTU (L3/IP4/IP6/MPLS) Counter Count
local0 0 down 0/0/0/0
show statistics segment
This command will dump statistics from the stats segment:
...
/net/mroute CMainPtr 307372
/net/route/to CMainPtr 306572
/net/route/via CMainPtr 306748
/sys/heartbeat ScalarPtr 75
/sys/input_rate ScalarPtr 0
/sys/last_stats_clear ScalarPtr 0
/sys/last_update ScalarPtr 740
...
show statistics segment verbose
This command will print extra info at the end of dump:
...
total: 31.99M, used: 850.19K, free: 31.17M, trimmable: 30.24M
no traced allocations
