docs/reference/cmdreference/index.rst

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