DOC ONLY: fix doc bugs
[vpp.git] / docs / reference / cmdreference / 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 Summary/Usage
22 -------------
23
24 .. code-block:: shell
25
26     show interface [address|addr|features|feat] [<interface> [<interface> [..]]]
27
28 Examples
29 --------
30
31 Example of how to show the interface counters:
32
33 .. code-block:: console
34
35     vpp# show int
36                   Name               Idx       State          Counter          Count
37     TenGigabitEthernet86/0/0          1         up       rx packets               6569213
38                                                          rx bytes              9928352943
39                                                          tx packets                 50384
40                                                          tx bytes                 3329279
41     TenGigabitEthernet86/0/1          2        down
42     VirtualEthernet0/0/0              3         up       rx packets                 50384
43                                                          rx bytes                 3329279
44                                                          tx packets               6569213
45                                                          tx bytes              9928352943
46                                                          drops                       1498
47     local0                            0        down
48
49 Example of how to display the interface placement:
50
51 .. code-block:: console
52
53     vpp# show interface rx-placement
54     Thread 1 (vpp_wk_0):
55       node dpdk-input:
56         GigabitEthernet7/0/0 queue 0 (polling)
57       node vhost-user-input:
58         VirtualEthernet0/0/12 queue 0 (polling)
59         VirtualEthernet0/0/12 queue 2 (polling)
60         VirtualEthernet0/0/13 queue 0 (polling)
61         VirtualEthernet0/0/13 queue 2 (polling)
62     Thread 2 (vpp_wk_1):
63       node dpdk-input:
64         GigabitEthernet7/0/1 queue 0 (polling)
65       node vhost-user-input:
66         VirtualEthernet0/0/12 queue 1 (polling)
67         VirtualEthernet0/0/12 queue 3 (polling)
68         VirtualEthernet0/0/13 queue 1 (polling)
69         VirtualEthernet0/0/13 queue 3 (polling)
70
71 Clear Interfaces
72 +++++++++++++++++
73 Clear the statistics for all interfaces (statistics associated with the
74 '*show interface*' command).
75
76 Summary/Usage
77 -------------
78
79 .. code-block:: shell
80
81     clear interfaces
82
83 Example
84 -------
85 Example of how to clear the statistics for all interfaces:
86
87 .. code-block:: console
88
89     vpp# clear interfaces