docs: add useful debug CLI

[vpp.git] / docs / reference / cmdreference / interface / basic.rst

diff --git a/docs/reference/cmdreference/interface/interface.rst b/docs/reference/cmdreference/interface/basic.rst
similarity index 52%
rename from docs/reference/cmdreference/interface/interface.rst
rename to docs/reference/cmdreference/interface/basic.rst
index a342903..9848005 100644 (file)
--- a/docs/reference/cmdreference/interface/interface.rst
+++ b/docs/reference/cmdreference/interface/basic.rst
@@ -1,15 +1,22 @@
-.. _intcommands:
-
-Interface Commands
-==================
+.. _interface:
 
 .. toctree::
 
+Basic Interface Commands
+=========================
+
+There are several commands that are associated to Basic Interface:
+
+* `Show Interface`_
+* `Clear Interfaces`_
+
+.. note:: For a complete list of CLI Debug commands refer to the Debug CLI section of the `Source Code Documents <https://docs.fd.io/vpp/18.07/clicmd.html>`_ .
+
 .. _showintcommand:
 
 Show Interface
-==============
-Shows software interface information including counters and features
+++++++++++++++++
+Shows software interface information including counters and features.
 
 Summary/Usage
 -------------
@@ -26,18 +33,18 @@ Example of how to show the interface counters:
 .. code-block:: console
 
     vpp# show int
-                  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
 
 Example of how to display the interface placement:
 
@@ -62,7 +69,7 @@ Example of how to display the interface placement:
         VirtualEthernet0/0/13 queue 3 (polling)
 
 Clear Interfaces
-================
++++++++++++++++++
 Clear the statistics for all interfaces (statistics associated with the
 '*show interface*' command).
 
@@ -80,86 +87,3 @@ Example of how to clear the statistics for all interfaces:
 .. code-block:: console
 
     vpp# clear interfaces
-
-Set Interface Mac Address
-=========================
-The '*set interface mac address* ' command allows to set MAC address of
-given interface. In case of NIC interfaces the one has to support MAC
-address change. A side effect of MAC address change are changes of MAC
-addresses in FIB tables (ipv4 and ipv6).
-
-
-Summary/Usage
--------------
-
-.. code-block:: shell
-
-    set interface mac address <interface> <mac-address>.
-
-Examples
---------
-
-Examples of how to change MAC Address of interface:
-
-.. code-block:: console
-
-    vpp# set interface mac address GigabitEthernet0/8/0 aa:bb:cc:dd:ee:01
-    vpp# set interface mac address host-vpp0 aa:bb:cc:dd:ee:02
-    vpp# set interface mac address tap-0 aa:bb:cc:dd:ee:03
-    vpp# set interface mac address pg0 aa:bb:cc:dd:ee:04
-
-Set Interface Mtu
-=================
-
-.. toctree::
-
-Summary/Usage
--------------
-
-.. code-block:: shell
-
-    set interface mtu [packet|ip4|ip6|mpls] <value> <interface>.
-
-Set Interface Promiscuous
-=========================
-
-Summary/Usage
--------------
-
-.. code-block:: shell
-
-    set interface promiscuous [on|off] <interface>.
-
-.. _setintstate:
-
-Set Interface State
-===================
-This command is used to change the admin state (up/down) of an
-interface.
-
-If an interface is down, the optional '*punt*' flag can also be set. The
-'*punt*' flag implies the interface is disabled for forwarding but punt
-all traffic to slow-path. Use the '*enable*' flag to clear '*punt*' flag
-(interface is still down).
-
-Summary/Usage
--------------
-
-.. code-block:: shell
-
-    set interface state <interface> [up|down|punt|enable].
-
-Examples
---------
-
-Example of how to configure the admin state of an interface to **up**:
-
-.. code-block:: console
-
-    vpp# set interface state GigabitEthernet2/0/0 up
-
-Example of how to configure the admin state of an interface to **down**:
-
-.. code-block:: console
-
-    vpp# set interface state GigabitEthernet2/0/0 down