Debug CLI

The VPP network stack comes equipped with a set of commands that are useful for debugging.

The easiest way to access the CLI (with proper permissions) is to use the vppctl command:

sudo vppctl <cli-command>

The CLI parser matches static keyword strings, eventually invoking an action function. Unambiguous partial keyword matching always occurs. The action functions consume input until satisfied or until they fail. This model makes for easy coding, but does not guarantee useful "help" output. It's up to the CLI command writer to add useful help strings.

You can find the source code of CLI commands by searching for instances of the VLIB_CLI_COMMAND macro in the code source files.

Please help maintain and improve this document to make and keep these commands clear and useful!

Todo:

Document where to modify this CLI intro text.

Debug and Telnet CLI

The debug CLI is enabled with the unix interactive parameter or startup configuration option. This causes VPP to start without daemonizing and presents a command line interface on the terminal where it is run.

The Telnet CLI is enabled with the cli-listen localhost:5002 option which will cause VPP to listen for TCP connections on the localhost address port 5002. A Telnet client can then connect to this port (for example, telnet localhost 5002) and will receive a command line prompt.

This configuration will enable both mechanisms:

unix {
  interactive
  cli-listen localhost:5002
}

The debug CLI can operate in line mode, which may be useful when running inside an IDE like Emacs. This is enabled with the option unix cli-line-mode. Several other options exist that alter how this CLI works, see the Startup Configuration section for details.

The CLI starts with a banner graphic (which can be disabled) and a prompt. The prompt will typically read vpp for a release version of VPP and DBGvpp# for a development version with debugging enabled, for example:

    _______    _        _   _____  ___ 
 __/ __/ _ \  (_)__    | | / / _ \/ _ \
 _/ _// // / / / _ \   | |/ / ___/ ___/
 /_/ /____(_)_/\___/   |___/_/  /_/    

vpp# 

versus:

    _______    _        _   _____  ___ 
 __/ __/ _ \  (_)__    | | / / _ \/ _ \
 _/ _// // / / / _ \   | |/ / ___/ ___/
 /_/ /____(_)_/\___/   |___/_/  /_/    

DBGvpp# 

This prompt can be configured with the unix cli-prompt setting and the banner is disabled with unix cli-no-banner.

CLI features

The CLI has several editing features that make it easy to use.

• Cursor keys left/right will move the cursor within a command line; typing will insert at the cursor; erase will erase at the cursor.
• Ctrl-left/right will search for the start of the next word to the left or right.
• Home/end will jump the cursor to the start and end of the line.
• Cursor keys up/down and ^P/^N iterate through the command history buffer. Lines from the history buffer may be edited. New commands are added to the end of the buffer when executed; though duplicates of the previous command are not added.
• ^U erases the line contents from the left of the cursor to the start.
• ^K erases the contents from the cursor to the end.
• ^S/^R will search the command history forwards or in reverse for a command; start typing for matches to auto complete.
• ^L will clear the screen (if supported by the terminal) and repaint the prompt and any current line. The cursor position is also retained.
• The CLI can be closed with the quit command. Alternatively, ^D on an empty input line will also close the session. Closing the debug session will also shutdown VPP.

Output that exceeds the length of a terminal page will be buffered, up to a limit.

• Space or page-down displays the next page.
• Enter or down-arrow displays the next line.
• Page-up goes back a page.
• Up-arrow goes up a line.
• Home/end jump to the start/end of the buffered output.
• The key q quits the pager. Space and enter will also quit the pager if the end of the buffer has been reached.

Index of CLI commands

ARP and Loopback CLI

• create loopback interface
• delete loopback interface
• delete sub-interface
• loopback create-interface
• loopback delete-interface
• set interface proxy-arp
• set ip arp
• show ip arp

Circular Journal

• cj

Command line session

• exec
• history
• quit
• set terminal ansi
• set terminal history
• set terminal pager
• show terminal
• show unix-errors

Layer 2 CLI

• clear l2fib
• l2 rewrite entry
• l2fib add
• l2fib del
• set bridge-domain arp entry
• set bridge-domain arp term
• set bridge-domain flood
• set bridge-domain forward
• set bridge-domain learn
• set bridge-domain mac-age
• set bridge-domain rewrite
• set bridge-domain uu-flood
• set interface acl output
• set interface l2 bridge
• set interface l2 efp-filter
• set interface l2 flood
• set interface l2 forward
• set interface l2 input classify
• set interface l2 learn
• set interface l2 output classify
• set interface l2 pbb-tag-rewrite
• set interface l2 rewrite
• set interface l2 tag-rewrite
• set interface l2 xconnect
• set interface l2 xcrw
• show bridge-domain
• show l2 rewrite entries
• show l2 rewrite interfaces
• show l2fib
• show l2patch
• show l2xcrw
• show mode
• test l2fib
• test l2patch

Layer 3 IP CLI

• clear ioam rewrite
• disable ip6 interface
• enable ip6 interface
• ip
• ip probe-neighbor
• ip route
• ip urpf-accept
• ip6
• ip6 nd
• ping
• set interface ip
• set interface ip address
• set interface ip source-and-port-range-check
• set interface ip source-check
• set interface ip table
• set interface ip6 table
• set ioam rewrite
• set ip classify
• set ip flow-hash
• set ip source-and-port-range-check
• set ip6 classify
• set ip6 flow-hash
• set ip6 link-local address
• set ip6 neighbor
• set punt udp
• show ioam summary
• show ip
• show ip local
• show ip source-and-port-range-check
• show ip6
• show ip6 interface
• show ip6 local
• show ip6 neighbors
• test ip6 link
• test lookup
• test route

Unix Interface

• set affinity
• show affinity
• show physmem
• show plugins

VLIB application library

• clear
• clear errors
• clear node counters
• clear runtime
• clear trace
• event-logger clear
• event-logger resize
• event-logger restart
• event-logger save
• event-logger stop
• memory-trace
• set
• show
• show cpu
• show errors
• show event-logger
• show frame-queue
• show frame-queue histogram
• show memory
• show node counters
• show runtime
• show threads
• show trace
• show vlib frame-allocation
• show vlib graph
• test
• test elog sample
• test frame-queue nelts
• test frame-queue threshold
• test heap-validate
• test sleep
• trace
• trace add
• trace filter
• trace frame-queue

VXLAN CLI

• create vxlan tunnel
• set interface ip vxlan-bypass
• show vxlan tunnel

plugins/acl-plugin/acl

• show l2sess
• show l2sess count

plugins/flowperpkt-plugin/flowperpkt

• flowperpkt feature add-del

plugins/ila-plugin/ila

• ila entry
• ila interface
• show ila entries

plugins/ioam-plugin/ioam/encap

• show ioam e2e
• show ioam pot
• show ioam trace

plugins/ioam-plugin/ioam/export

• set ioam export ipfix

plugins/ioam-plugin/ioam/export-vxlan-gpe

• set vxlan-gpe-ioam export ipfix

plugins/ioam-plugin/ioam/lib-pot

• clear pot profile
• set pot profile
• set pot profile-active
• show pot profile

plugins/ioam-plugin/ioam/lib-trace

• clear ioam-trace profile
• set ioam-trace profile
• show ioam-trace profile

plugins/ioam-plugin/ioam/lib-vxlan-gpe

• clear vxlan-gpe-ioam rewrite
• set vxlan-gpe-ioam
• set vxlan-gpe-ioam rewrite
• set vxlan-gpe-ioam-transit
• show ioam vxlan-gpe trace

plugins/lb-plugin/lb

• lb as
• lb conf
• lb vip
• show lb
• show lb vips

plugins/sixrd-plugin/sixrd

• show sixrd domain
• show sixrd stats
• sixrd add domain
• sixrd del domain

plugins/snat-plugin/snat

• set interface snat
• set snat workers
• show snat
• snat add address
• snat add static mapping

plugins/vcgn-plugin/vcgn

• set vcgn default timeout
• set vcgn dynamic port start
• set vcgn icmp timeout
• set vcgn inside
• set vcgn map
• set vcgn nfv9
• set vcgn port limit
• set vcgn tcp timeout
• set vcgn udp timeout
• show vcgn config
• show vcgn inside-translation
• show vcgn outside-translation
• show vcgn statistics

vHost User

• create vhost-user
• delete vhost-user
• show vhost-user
• vhost thread

vlib-api/vlibapi

• api trace
• test node serialize

vlib-api/vlibmemory

• clear api histogram
• set api-trace
• show api
• show api clients
• show api histogram
• show api message-table
• show api plugin
• show api ring-stats
• show api status

vlib/vlib/pci

• show pci

vnet/vnet

• clear hardware-interfaces
• clear interface tag
• clear interfaces
• create sub-interfaces
• interface
• pcap drop trace
• renumber interface
• set interface
• set interface handoff
• set interface hw-class
• set interface mac address
• set interface mtu
• set interface promiscuous
• set interface state
• set interface tag
• set interface unnumbered
• show hardware-interfaces
• show interfaces

vnet/vnet/adj

• show adj
• show adj nbr

vnet/vnet/cdp

• show cdp

vnet/vnet/classify

• classify session
• classify table
• set flow classify
• set policer classify
• show classify flow
• show classify policer
• show classify tables
• show inacl
• test classify

vnet/vnet/cop

• cop interface
• cop whitelist

vnet/vnet/devices/af_packet

• create host-interface
• delete host-interface

vnet/vnet/devices/dpdk

• pcap tx trace
• set dpdk interface descriptors
• set dpdk interface hqos pipe
• set dpdk interface hqos pktfield
• set dpdk interface hqos placement
• set dpdk interface hqos subport
• set dpdk interface hqos tctbl
• set dpdk interface placement
• show dpdk buffer
• show dpdk hqos queue
• show dpdk interface hqos
• show dpdk interface hqos placement
• show dpdk interface placement
• test dpdk buffer

vnet/vnet/devices/dpdk/ipsec

• show crypto device mapping

vnet/vnet/devices/netmap

• create netmap
• delete netmap

vnet/vnet/dhcp

• set dhcp client
• set dhcp option-82 vss
• set dhcp proxy
• show dhcp client
• show dhcp option-82-address interface
• show dhcp proxy
• show dhcp vss

vnet/vnet/dhcpv6

• set dhcpv6 proxy
• set dhcpv6 vss
• show dhcpv6 link-address interface
• show dhcpv6 proxy
• show dhcpv6 vss

vnet/vnet/dpo

• show dpo memory
• show load-balance
• show load-balance-map

vnet/vnet/feature

• set interface feature
• show features

vnet/vnet/fib

• clear fib walk
• set fib walk histogram elements size
• set fib walk quota
• show fib entry
• show fib memory
• show fib path-lists
• show fib paths
• show fib uRPF
• show fib walk
• show ip fib
• show ip6 fib
• show mpls fib
• test fib

vnet/vnet/flow

• ipfix classify table
• set ipfix classify stream
• set ipfix exporter

vnet/vnet/gre

• create gre tunnel
• show gre tunnel

vnet/vnet/ipsec

• clear ipsec counters
• create ipsec tunnel
• ikev2 profile
• ipsec policy
• ipsec sa
• ipsec spd
• set ikev2 local key
• set interface ipsec key
• set interface ipsec spd
• set ipsec sa
• show ikev2 profile
• show ikev2 sa
• show ipsec

vnet/vnet/ipsec-gre

• create ipsec gre tunnel
• show ipsec gre tunnel

vnet/vnet/l2tp

• clear counters
• create l2tpv3 tunnel
• set interface ip6 l2tpv3
• set l2tpv3 tunnel cookie
• show l2tpv3
• test counters

vnet/vnet/lawful-intercept

• set li

vnet/vnet/lisp-cp

• lisp
• lisp adjacency
• lisp eid-table
• lisp eid-table map
• lisp locator
• lisp locator-set
• lisp map-register
• lisp map-request itr-rlocs
• lisp map-request mode
• lisp map-resolver
• lisp map-server
• lisp pitr
• lisp remote-mapping
• lisp rloc-probe
• show lisp adjacencies
• show lisp eid-table
• show lisp eid-table map
• show lisp locator-set
• show lisp map-request itr-rlocs
• show lisp map-request mode
• show lisp map-resolvers
• show lisp pitr
• show lisp status

vnet/vnet/lisp-gpe

• lisp gpe
• lisp gpe entry
• lisp gpe iface
• show lisp gpe adjacency
• show lisp gpe entry
• show lisp gpe interface
• show lisp gpe sub-interface
• show lisp gpe tenant

vnet/vnet/lldp

• set interface lldp
• set lldp
• show lldp

vnet/vnet/map

• map add domain
• map add rule
• map del domain
• map params fragment
• map params fragment ignore-df
• map params icmp source-address
• map params icmp6 unreachables
• map params pre-resolve
• map params reassembly
• map params security-check
• map params security-check fragments
• map params traffic-class
• show map domain
• show map fragments
• show map stats

vnet/vnet/mpls

• mpls local-label
• mpls tunnel
• set interface mpls
• show mpls tunnel

vnet/vnet/pg

• create packet-generator
• packet-generator
• packet-generator capture
• packet-generator configure
• packet-generator delete
• packet-generator disable-stream
• packet-generator enable-stream
• packet-generator new
• show packet-generator

vnet/vnet/policer

• configure policer
• show policer
• test policer

vnet/vnet/span

• set interface span
• show interfaces span

vnet/vnet/sr

• set ip6 sr rewrite
• show sr hmac
• show sr multicast-map
• show sr policy
• show sr tunnel
• sr hmac
• sr multicast-map
• sr policy
• sr tunnel
• test sr debug
• test sr hmac

vnet/vnet/unix

• show gdb
• tap connect
• tap delete
• tap modify

vnet/vnet/vxlan-gpe

• create vxlan-gpe tunnel
• show vxlan-gpe

vpp/app

• ip sticky classify
• ip virtual
• show sticky classify
• show version

vpp/oam

• oam
• show oam

vpp/vnet

• test crash

vpp/vpp-api

• set significant error
• show arp-nd-event registrations