Useful Debug CLI

This is a reference guide for the vpp debug commands that are referenced within these documents. This is NOT a complete list. For a complete list refer to the Debug CLI section of the Source Code Documents.

The debug CLI can be executed from a su (superuser) shell using the vppctl command.

# sudo bash
# vppctl show interface

              Name               Idx       State          Counter          Count
TenGigabitEthernet86/0/0          1         up       rx packets               6569213
                                                     rx bytes              9928352943
                                                     tx packets                 50384
                                                     tx bytes                 3329279
TenGigabitEthernet86/0/1          2        down
VirtualEthernet0/0/0              3         up       rx packets                 50384
                                                     rx bytes                 3329279
                                                     tx packets               6569213
                                                     tx bytes              9928352943
                                                     drops                       1498
local0                            0        down

Commands can also be executed from the vppctl shell.

# vppctl

vpp# show interface
              Name               Idx       State          Counter          Count
TenGigabitEthernet86/0/0          1         up       rx packets               6569213
                                                     rx bytes              9928352943
                                                     tx packets                 50384
                                                     tx bytes                 3329279
TenGigabitEthernet86/0/1          2        down
VirtualEthernet0/0/0              3         up       rx packets                 50384
                                                     rx bytes                 3329279
                                                     tx packets               6569213
                                                     tx bytes              9928352943
                                                     drops                       1498
local0                            0        down

• Interface Commands
  • Basic Interface Commands
    • Show Interface
    • Clear Interfaces
  • Hardware-Interfaces Commands
    • Show Bridge-Domain
    • Show Hardware-Interfaces
    • Clear Hardware-Interfaces
  • Create Interfaces Commands
    • Create Host-Interface
    • Create Interface Memif
    • Create Loopback Interface
    • Create Sub-Interfaces
  • Set Interface Commands
    • Set Interface
    • Set Interface IP Address
    • Set Interface L2 Bridge
    • Set Interface MTU
    • Set Interface Promiscuous
    • Set Interface State
• IP Commands
  • IP Route
    • Summary/Usage
    • Description
    • Example Usage
    • Declaration and Implementation
  • Ping
    • Summary/Usage
    • Description
    • Example Usage
    • Declaration and Implementation
  • Set Interface IP Address
  • Show IP Arp
  • Show IP Fib
• Show Commands
  • Show Bridge-Domain
  • Show Interface
  • Show IP Arp
    • Summary/Usage
    • Description
    • Example Usage
    • Declaration and Implementation
  • Show IP Fib
    • Summary/Usage
    • Description
    • Example Usage
    • Declaration and Implementation
  • Show L2fib
    • Summary/Usage
    • Description
    • Example Usage
    • Declaration and Implementation
  • Show Trace
    • Summary/Usage
    • Declaration and Implementation
  • Show Vhost-User
• Trace Commands
  • API Trace
    • Summary/Usage
    • Description
    • Declaration and Implementation
  • Clear Trace
    • Summary/Usage
  • Show Trace
  • Trace Add
    • Summary/Usage
    • Declaration and Implementation
• Vhost User Commands
  • Create Vhost-User
    • Summary/Usage
    • Examples
  • Show Vhost-User
    • Summary/Usage
    • Examples
  • Debug Vhost-User
    • Summary/Usage
  • Delete Vhost-User
    • Summary/Usage
    • Examples