docs/reference/cmdreference/index.rst

   1 .. _cmdreference:
   2
   3 Command Line Reference
   4 ======================
   5
   6 This is a reference guide for the vpp debug commands that are referenced in the within these documents. This is **NOT** a complete list. For a complete list refer to the Debug CLI section of the
   7 `Source Code Documents <https://docs.fd.io/vpp/18.07/clicmd.html>`_.
   8
   9 The debug CLI can be executed from a su shell using the vppctl command.
  10
  11 .. code-block:: console
  12
  13     # sudo bash
  14     # vppctl show interface
  15                   Name               Idx       State          Counter          Count
  16     TenGigabitEthernet86/0/0          1         up       rx packets               6569213
  17                                                          rx bytes              9928352943
  18                                                          tx packets                 50384
  19                                                          tx bytes                 3329279
  20     TenGigabitEthernet86/0/1          2        down
  21     VirtualEthernet0/0/0              3         up       rx packets                 50384
  22                                                          rx bytes                 3329279
  23                                                          tx packets               6569213
  24                                                          tx bytes              9928352943
  25                                                          drops                       1498
  26     local0                            0        down
  27
  28 Commands can also be executed from the vppct shell.
  29
  30 .. code-block:: console
  31
  32     # vppctl
  33         _______    _        _   _____  ___
  34      __/ __/ _ \  (_)__    | | / / _ \/ _ \
  35      _/ _// // / / / _ \   | |/ / ___/ ___/
  36      /_/ /____(_)_/\___/   |___/_/  /_/
  37
  38     vpp# show interface
  39                   Name               Idx       State          Counter          Count
  40     TenGigabitEthernet86/0/0          1         up       rx packets               6569213
  41                                                          rx bytes              9928352943
  42                                                          tx packets                 50384
  43                                                          tx bytes                 3329279
  44     TenGigabitEthernet86/0/1          2        down
  45     VirtualEthernet0/0/0              3         up       rx packets                 50384
  46                                                          rx bytes                 3329279
  47                                                          tx packets               6569213
  48                                                          tx bytes              9928352943
  49                                                          drops                       1498
  50     local0                            0        down
  51
  52 .. toctree::
  53
  54    interface/index.rst
  55    vhost/index.rst