X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=docs%2Freference%2Fcmdreference%2Findex.rst;h=c51dd367ae0cd5f079f02d02fda99122831b0e72;hb=390036e0d075c632491beeb37aba4e5d07132e06;hp=5c8effa3310d740f17787132101be81b00f2e6e7;hpb=06dcd45ff81e06bc8cf40ed487c0b2652d346a5a;p=vpp.git diff --git a/docs/reference/cmdreference/index.rst b/docs/reference/cmdreference/index.rst index 5c8effa3310..c51dd367ae0 100644 --- a/docs/reference/cmdreference/index.rst +++ b/docs/reference/cmdreference/index.rst @@ -1,55 +1,57 @@ .. _cmdreference: -Command Line Reference -====================== -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 +Useful Debug CLI +================== + +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 `Source Code Documents `_. -The debug CLI can be executed from a su shell using the vppctl command. +The debug CLI can be executed from a su (superuser) shell using the vppctl command. .. code-block:: console # sudo bash # vppctl show interface - Name Idx State Counter Count + + Name Idx State Counter Count TenGigabitEthernet86/0/0 1 up rx packets 6569213 rx bytes 9928352943 tx packets 50384 tx bytes 3329279 - TenGigabitEthernet86/0/1 2 down + TenGigabitEthernet86/0/1 2 down VirtualEthernet0/0/0 3 up rx packets 50384 rx bytes 3329279 tx packets 6569213 tx bytes 9928352943 drops 1498 - local0 0 down + local0 0 down Commands can also be executed from the vppct shell. .. code-block:: console # vppctl - _______ _ _ _____ ___ - __/ __/ _ \ (_)__ | | / / _ \/ _ \ - _/ _// // / / / _ \ | |/ / ___/ ___/ - /_/ /____(_)_/\___/ |___/_/ /_/ - - vpp# show interface - Name Idx State Counter Count + + vpp# show interface + Name Idx State Counter Count TenGigabitEthernet86/0/0 1 up rx packets 6569213 rx bytes 9928352943 tx packets 50384 tx bytes 3329279 - TenGigabitEthernet86/0/1 2 down + TenGigabitEthernet86/0/1 2 down VirtualEthernet0/0/0 3 up rx packets 50384 rx bytes 3329279 tx packets 6569213 tx bytes 9928352943 drops 1498 - local0 0 down + local0 0 down .. toctree:: + :maxdepth: 3 interface/index.rst + ip/index.rst + show/index.rst + trace/index.rst vhost/index.rst