2018-07-26 12:45:10 -04:00
.. _cmdreference:
2018-10-23 15:16:46 -04:00
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
2018-07-26 12:45:10 -04:00
`Source Code Documents <https://docs.fd.io/vpp/18.07/clicmd.html> `_ .
2018-10-26 09:12:15 -04:00
The debug CLI can be executed from a su (superuser) shell using the vppctl command.
2018-07-26 12:45:10 -04:00
.. code-block :: console
# sudo bash
# vppctl show interface
2018-10-31 14:24:31 -04:00
2018-10-23 15:16:46 -04:00
Name Idx State Counter Count
2018-07-26 12:45:10 -04:00
TenGigabitEthernet86/0/0 1 up rx packets 6569213
rx bytes 9928352943
tx packets 50384
tx bytes 3329279
2018-10-23 15:16:46 -04:00
TenGigabitEthernet86/0/1 2 down
2018-07-26 12:45:10 -04:00
VirtualEthernet0/0/0 3 up rx packets 50384
rx bytes 3329279
tx packets 6569213
tx bytes 9928352943
drops 1498
2018-10-23 15:16:46 -04:00
local0 0 down
2018-07-26 12:45:10 -04:00
Commands can also be executed from the vppct shell.
.. code-block :: console
# vppctl
2018-10-26 09:12:15 -04:00
2018-10-23 15:16:46 -04:00
vpp# show interface
Name Idx State Counter Count
2018-07-26 12:45:10 -04:00
TenGigabitEthernet86/0/0 1 up rx packets 6569213
rx bytes 9928352943
tx packets 50384
tx bytes 3329279
2018-10-23 15:16:46 -04:00
TenGigabitEthernet86/0/1 2 down
2018-07-26 12:45:10 -04:00
VirtualEthernet0/0/0 3 up rx packets 50384
rx bytes 3329279
tx packets 6569213
tx bytes 9928352943
drops 1498
2018-10-23 15:16:46 -04:00
local0 0 down
2018-07-26 12:45:10 -04:00
.. toctree ::
2018-10-23 15:16:46 -04:00
:maxdepth: 3
2018-07-26 12:45:10 -04:00
interface/index.rst
2018-10-23 15:16:46 -04:00
ip/index.rst
show/index.rst
trace/index.rst
2018-10-31 14:24:31 -04:00
vhost/index.rst
