Gitiles
Code Review Sign In
gerrit.nordix.org / fdio / vpp / 6c892301e24a9904841b0969330d6d220b5f83b2 / . / docs / reference / cmdreference / index.rst
blob: 802dc8bd948d3ab740162b4b9b77a8faab7533a6 [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
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]16 Name Idx State Counter Count
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]17 TenGigabitEthernet86/0/0 1 up rx packets 6569213
18 rx bytes 9928352943
19 tx packets 50384
20 tx bytes 3329279
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]21 TenGigabitEthernet86/0/1 2 down
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]22 VirtualEthernet0/0/0 3 up rx packets 50384
23 rx bytes 3329279
24 tx packets 6569213
25 tx bytes 9928352943
26 drops 1498
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]27 local0 0 down
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]28
29Commands can also be executed from the vppct shell.
30
31.. code-block:: console
32
33 # vppctl
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]34
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]35 __/ __/ _ \ (_)__ | | / / _ \/ _ \
36 _/ _// // / / / _ \ | |/ / ___/ ___/
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]37 /_/ /____(_)_/\___/ |___/_/ /_/
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]38
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]39 vpp# show interface
40 Name Idx State Counter Count
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]41 TenGigabitEthernet86/0/0 1 up rx packets 6569213
42 rx bytes 9928352943
43 tx packets 50384
44 tx bytes 3329279
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]45 TenGigabitEthernet86/0/1 2 down
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]46 VirtualEthernet0/0/0 3 up rx packets 50384
47 rx bytes 3329279
48 tx packets 6569213
49 tx bytes 9928352943
50 drops 1498
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]51 local0 0 down
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]52
53.. toctree::
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]54 :maxdepth: 3
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]55
56 interface/index.rst
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]57 ip/index.rst
58 show/index.rst
59 trace/index.rst
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]60 vhost/index.rst