docs: better docs, mv doxygen to sphinx
[vpp.git] / docs / cli-reference / interface / basic.rst
1 .. _interface:
2
3 .. toctree::
4
5 Basic Interface Commands
6 =========================
7
8 There are several commands that are associated to Basic Interface:
9
10 * `Show Interface`_
11 * `Clear Interfaces`_
12
13 .. 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>`_ .
14
15 .. _showintcommand:
16
17 Show Interface
18 ++++++++++++++++
19 Shows software interface information including counters and features.
20
21 .. code-block:: shell
22
23     show interface [address|addr|features|feat] [<interface> [<interface> [..]]]
24
25 Examples
26 --------
27
28 Example of how to show the interface counters:
29
30 .. code-block:: console
31
32     vpp# show int
33                   Name               Idx       State          Counter          Count
34     TenGigabitEthernet86/0/0          1         up       rx packets               6569213
35                                                          rx bytes              9928352943
36                                                          tx packets                 50384
37                                                          tx bytes                 3329279
38     TenGigabitEthernet86/0/1          2        down
39     VirtualEthernet0/0/0              3         up       rx packets                 50384
40                                                          rx bytes                 3329279
41                                                          tx packets               6569213
42                                                          tx bytes              9928352943
43                                                          drops                       1498
44     local0                            0        down
45
46 Example of how to display the interface placement:
47
48 .. code-block:: console
49
50     vpp# show interface rx-placement
51     Thread 1 (vpp_wk_0):
52       node dpdk-input:
53         GigabitEthernet7/0/0 queue 0 (polling)
54       node vhost-user-input:
55         VirtualEthernet0/0/12 queue 0 (polling)
56         VirtualEthernet0/0/12 queue 2 (polling)
57         VirtualEthernet0/0/13 queue 0 (polling)
58         VirtualEthernet0/0/13 queue 2 (polling)
59     Thread 2 (vpp_wk_1):
60       node dpdk-input:
61         GigabitEthernet7/0/1 queue 0 (polling)
62       node vhost-user-input:
63         VirtualEthernet0/0/12 queue 1 (polling)
64         VirtualEthernet0/0/12 queue 3 (polling)
65         VirtualEthernet0/0/13 queue 1 (polling)
66         VirtualEthernet0/0/13 queue 3 (polling)
67
68 Clear Interfaces
69 +++++++++++++++++
70 Clear the statistics for all interfaces (statistics associated with the
71 '*show interface*' command).
72
73 .. code-block:: shell
74
75     clear interfaces
76
77 Example
78 -------
79 Example of how to clear the statistics for all interfaces:
80
81 .. code-block:: console
82
83     vpp# clear interfaces