Gitiles
Code Review Sign In
gerrit.nordix.org / fdio / vpp / 6c892301e24a9904841b0969330d6d220b5f83b2 / . / docs / reference / cmdreference / interface / hardware.rst
blob: 2c28d655c4ac3a43c1bfdad8c364bf5a1c6407cb [file] [log] [blame]
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]1.. _interface:
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]2
3.. toctree::
4
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]5Hardware-Interfaces Commands
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]6============================
7This section contains those interface commands that are related to hardware-interfaces:
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]8
9
10* `Show Bridge-Domain`_
11* `Show Hardware-Interfaces`_
12* `Clear Hardware-Interfaces`_
13
14.. 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>`_ .
15
16Show Bridge-Domain
17+++++++++++++++++++
18
19Summary/Usage
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]20-------------
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]21
22show bridge-domain [*bridge-domain-id* [detail|int|arp| *bd-tag* ]]
23
24Description
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]25-----------
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]26
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]27Show a summary of all the bridge-domain instances or detailed view of a single bridge-domain.
28Bridge-domains are created by adding an interface to a bridge using the **set interface l2 bridge** command.
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]29
30Example Usage
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]31-------------
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]32.. code-block:: console
33
34 Example of displaying all bridge-domains:
35
36 vpp# show bridge-domain
37
38 ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
39 0 0 off off off off off local0
40 200 1 on on on on off N/A
41
42 Example of displaying details of a single bridge-domains:
43
44 vpp# show bridge-domain 200 detail
45
46 ID Index Learning U-Forwrd UU-Flood Flooding ARP-Term BVI-Intf
47 200 1 on on on on off N/A
48
49 Interface Index SHG BVI VLAN-Tag-Rewrite
50 GigabitEthernet0/8/0.200 3 0 - none
51 GigabitEthernet0/9/0.200 4 0 - none
52
53Declaration and Implementation
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]54------------------------------
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]55
56**Declaration:** bd_show_cli (src/vnet/l2/l2_bd.c line 1151)
57
58**Implementation:** bd_show
59
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]60Show Hardware-Interfaces
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]61+++++++++++++++++++++++++
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]62Display more detailed information about all or a list of given
63interfaces. The verboseness of the output can be controlled by the
64following optional parameters:
65
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]66- **brief**: Only show name, index and state (default for bonded
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]67 interfaces).
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]68- **verbose**: Also display additional attributes (default for all other
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]69 interfaces).
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]70- **detail**: Also display all remaining attributes and extended
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]71 statistics.
72
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]73.. note::
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]74 To limit the output of the command to bonded interfaces and their
75 slave interfaces, use the '*bond*' optional parameter.
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]76
77Summary/Usage
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]78-------------
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]79
80.. code-block:: shell
81
82 show hardware-interfaces [brief|verbose|detail] [bond] [<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]].
83
84Examples
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]85--------
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]86Example of how to display default data for all interfaces:
87
88.. code-block:: console
89
90 vpp# show hardware-interfaces
91 Name Idx Link Hardware
92 GigabitEthernet7/0/0 1 up GigabitEthernet7/0/0
93 Ethernet address ec:f4:bb:c0:bc:fc
94 Intel e1000
95 carrier up full duplex speed 1000 mtu 9216
96 rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
97 cpu socket 0
98 GigabitEthernet7/0/1 2 up GigabitEthernet7/0/1
99 Ethernet address ec:f4:bb:c0:bc:fd
100 Intel e1000
101 carrier up full duplex speed 1000 mtu 9216
102 rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
103 cpu socket 0
104 VirtualEthernet0/0/0 3 up VirtualEthernet0/0/0
105 Ethernet address 02:fe:a5:a9:8b:8e
106 VirtualEthernet0/0/1 4 up VirtualEthernet0/0/1
107 Ethernet address 02:fe:c0:4e:3b:b0
108 VirtualEthernet0/0/2 5 up VirtualEthernet0/0/2
109 Ethernet address 02:fe:1f:73:92:81
110 VirtualEthernet0/0/3 6 up VirtualEthernet0/0/3
111 Ethernet address 02:fe:f2:25:c4:68
112 local0 0 down local0
113 local
114
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]115Example of how to display *verbose* data for an interface by name and software index
116(where 2 is the software index):
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]117
118.. code-block:: console
119
120 vpp# show hardware-interfaces GigabitEthernet7/0/0 2 verbose
121 Name Idx Link Hardware
122 GigabitEthernet7/0/0 1 up GigabitEthernet7/0/0
123 Ethernet address ec:f4:bb:c0:bc:fc
124 Intel e1000
125 carrier up full duplex speed 1000 mtu 9216
126 rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
127 cpu socket 0
128 GigabitEthernet7/0/1 2 down GigabitEthernet7/0/1
129 Ethernet address ec:f4:bb:c0:bc:fd
130 Intel e1000
131 carrier up full duplex speed 1000 mtu 9216
132 rx queues 1, rx desc 1024, tx queues 3, tx desc 1024
133 cpu socket 0
134
135Clear Hardware-Interfaces
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]136+++++++++++++++++++++++++
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]137
138Clear the extended statistics for all or a list of given interfaces
Scott Keeler70f28fc2018-10-23 15:16:46 -0400[diff] [blame]139(statistics associated with the **show hardware-interfaces** command).
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]140
141
142Summary/Usage
143-------------
144
145.. code-block:: shell
146
147 clear hardware-interfaces [<interface> [<interface> [..]]] [<sw_idx> [<sw_idx> [..]]].
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]148
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]149
150Examples
151--------
152
153Example of how to clear the extended statistics for all interfaces:
154
155
156.. code-block:: console
157
158 vpp# clear hardware-interfaces
159
Scott Keeler6c892302018-10-26 09:12:15 -0400[diff] [blame^]160Example of how to clear the extended statistics for an interface by name and software index
161(where 2 is the software index):
John DeNisco06dcd452018-07-26 12:45:10 -0400[diff] [blame]162
163.. code-block:: console
164
165 vpp# clear hardware-interfaces GigabitEthernet7/0/0 2
166
167