blob: f4d334fd935c5808d7d98cae5bed186322b042d7 [file] [log] [blame]
John DeNisco06dcd452018-07-26 12:45:10 -04001.. _hardwarecommands:
2
3.. toctree::
4
5Show Hardware-Interfaces
6========================
7Display more detailed information about all or a list of given
8interfaces. The verboseness of the output can be controlled by the
9following optional parameters:
10
11- brief: Only show name, index and state (default for bonded
12 interfaces).
13- verbose: Also display additional attributes (default for all other
14 interfaces).
15- detail: Also display all remaining attributes and extended
16 statistics.
17
18**To limit the output of the command to bonded interfaces and their
19slave interfaces, use the '*bond*' optional parameter.**
20
21Summary/Usage
22-------------
23
24.. code-block:: shell
25
26 show hardware-interfaces [brief|verbose|detail] [bond] [<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]].
27
28Examples
29--------
30Example of how to display default data for all interfaces:
31
32.. code-block:: console
33
34 vpp# show hardware-interfaces
35 Name Idx Link Hardware
36 GigabitEthernet7/0/0 1 up GigabitEthernet7/0/0
37 Ethernet address ec:f4:bb:c0:bc:fc
38 Intel e1000
39 carrier up full duplex speed 1000 mtu 9216
40 rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
41 cpu socket 0
42 GigabitEthernet7/0/1 2 up GigabitEthernet7/0/1
43 Ethernet address ec:f4:bb:c0:bc:fd
44 Intel e1000
45 carrier up full duplex speed 1000 mtu 9216
46 rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
47 cpu socket 0
48 VirtualEthernet0/0/0 3 up VirtualEthernet0/0/0
49 Ethernet address 02:fe:a5:a9:8b:8e
50 VirtualEthernet0/0/1 4 up VirtualEthernet0/0/1
51 Ethernet address 02:fe:c0:4e:3b:b0
52 VirtualEthernet0/0/2 5 up VirtualEthernet0/0/2
53 Ethernet address 02:fe:1f:73:92:81
54 VirtualEthernet0/0/3 6 up VirtualEthernet0/0/3
55 Ethernet address 02:fe:f2:25:c4:68
56 local0 0 down local0
57 local
58
59Example of how to display '*verbose*' data for an interface by name and software index (where 2 is the software index):
60
61.. code-block:: console
62
63 vpp# show hardware-interfaces GigabitEthernet7/0/0 2 verbose
64 Name Idx Link Hardware
65 GigabitEthernet7/0/0 1 up GigabitEthernet7/0/0
66 Ethernet address ec:f4:bb:c0:bc:fc
67 Intel e1000
68 carrier up full duplex speed 1000 mtu 9216
69 rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
70 cpu socket 0
71 GigabitEthernet7/0/1 2 down GigabitEthernet7/0/1
72 Ethernet address ec:f4:bb:c0:bc:fd
73 Intel e1000
74 carrier up full duplex speed 1000 mtu 9216
75 rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
76 cpu socket 0
77
78Clear Hardware-Interfaces
79=========================
80
81Clear the extended statistics for all or a list of given interfaces
82(statistics associated with the '*show hardware-interfaces*' command).
83
84
85Summary/Usage
86-------------
87
88.. code-block:: shell
89
90 clear hardware-interfaces [<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]].
91
92
93Examples
94--------
95
96Example of how to clear the extended statistics for all interfaces:
97
98
99.. code-block:: console
100
101 vpp# clear hardware-interfaces
102
103Example of how to clear the extended statistics for an interface by name and software index (where 2 is the software index):
104
105.. code-block:: console
106
107 vpp# clear hardware-interfaces GigabitEthernet7/0/0 2
108
109