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                   Name               Idx       State          Counter          Count
  17     TenGigabitEthernet86/0/0          1         up       rx packets               6569213
  18                                                          rx bytes              9928352943
  19                                                          tx packets                 50384
  20                                                          tx bytes                 3329279
  21     TenGigabitEthernet86/0/1          2        down
  22     VirtualEthernet0/0/0              3         up       rx packets                 50384
  23                                                          rx bytes                 3329279
  24                                                          tx packets               6569213
  25                                                          tx bytes              9928352943
  26                                                          drops                       1498
  27     local0                            0        down
  28
  29 Commands can also be executed from the vppct shell.
  30
  31 .. code-block:: console
  32
  33     # vppctl
  34
  35      __/ __/ _ \  (_)__    | | / / _ \/ _ \
  36      _/ _// // / / / _ \   | |/ / ___/ ___/
  37      /_/ /____(_)_/\___/   |___/_/  /_/
  38
  39     vpp# show interface
  40                   Name               Idx       State          Counter          Count
  41     TenGigabitEthernet86/0/0          1         up       rx packets               6569213
  42                                                          rx bytes              9928352943
  43                                                          tx packets                 50384
  44                                                          tx bytes                 3329279
  45     TenGigabitEthernet86/0/1          2        down
  46     VirtualEthernet0/0/0              3         up       rx packets                 50384
  47                                                          rx bytes                 3329279
  48                                                          tx packets               6569213
  49                                                          tx bytes              9928352943
  50                                                          drops                       1498
  51     local0                            0        down
  52
  53 .. toctree::
  54    :maxdepth: 3
  55
  56    interface/index.rst
  57    ip/index.rst
  58    show/index.rst
  59    trace/index.rst
  60    vhost/index.rst