Gitiles
Code Review Sign In
gerrit.nordix.org / fdio / vpp / 7f6bd24f7217026131f6b8e1e55f92d2955c883b / . / docs / reference / cmdreference / index.rst
blob: c51dd367ae0cd5f079f02d02fda99122831b0e72 [file] [log] [blame]
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]1.. _cmdreference:
2
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]3
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]4Useful Debug CLI
5==================
6
7This 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
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]8`Source Code Documents <https://docs.fd.io/vpp/18.07/clicmd.html>`_.
9
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame]10The debug CLI can be executed from a su (superuser) shell using the vppctl command.
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]11
12.. code-block:: console
13
14 # sudo bash
15 # vppctl show interface
jdenisco390036e2018-10-31 14:24:31 -0400[diff] [blame]16
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]17 Name Idx State Counter Count
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]18 TenGigabitEthernet86/0/0 1 up rx packets 6569213
19 rx bytes 9928352943
20 tx packets 50384
21 tx bytes 3329279
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]22 TenGigabitEthernet86/0/1 2 down
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]23 VirtualEthernet0/0/0 3 up rx packets 50384
24 rx bytes 3329279
25 tx packets 6569213
26 tx bytes 9928352943
27 drops 1498
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]28 local0 0 down
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]29
30Commands can also be executed from the vppct shell.
31
32.. code-block:: console
33
34 # vppctl
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame]35
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]36 vpp# show interface
37 Name Idx State Counter Count
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]38 TenGigabitEthernet86/0/0 1 up rx packets 6569213
39 rx bytes 9928352943
40 tx packets 50384
41 tx bytes 3329279
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]42 TenGigabitEthernet86/0/1 2 down
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]43 VirtualEthernet0/0/0 3 up rx packets 50384
44 rx bytes 3329279
45 tx packets 6569213
46 tx bytes 9928352943
47 drops 1498
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]48 local0 0 down
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]49
50.. toctree::
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]51 :maxdepth: 3
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]52
53 interface/index.rst
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]54 ip/index.rst
55 show/index.rst
56 trace/index.rst
jdenisco390036e2018-10-31 14:24:31 -0400[diff] [blame]57 vhost/index.rst