docs: add useful debug CLI Review Updates
[vpp.git] / docs / reference / cmdreference / show / show.rst
1 .. _interface:\r
2 \r
3 .. toctree::\r
4 \r
5 .. 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>`_ .\r
6 \r
7 Show Bridge-Domain\r
8 ===================\r
9 \r
10 `Show Bridge-Domain <../interface/hardware.html#show-bridge-domain>`_\r
11 \r
12 Show Interface\r
13 ================\r
14 \r
15 `Show Interface <../interface/basic.html#show-interface>`_\r
16 \r
17 Show IP Arp\r
18 ============\r
19 \r
20 Summary/Usage\r
21 ---------------\r
22 \r
23 show ip arp\r
24 \r
25 Description\r
26 ------------\r
27 \r
28 Display all the IPv4 ARP entries.\r
29 \r
30 Example Usage\r
31 --------------\r
32 Example of how to display the IPv4 ARP table:\r
33 \r
34 .. code-block:: console\r
35 \r
36    vpp# **show ip arp**\r
37        Time      FIB        IP4       Flags      Ethernet              Interface\r
38        346.3028   0       6.1.1.3            de:ad:be:ef:ba:be   GigabitEthernet2/0/0\r
39       3077.4271   0       6.1.1.4       S    de:ad:be:ef:ff:ff   GigabitEthernet2/0/0\r
40       2998.6409   1       6.2.2.3            de:ad:be:ef:00:01   GigabitEthernet2/0/0\r
41     Proxy arps enabled for:\r
42     Fib_index 0   6.0.0.1 - 6.0.0.11\r
43 \r
44         \r
45 Declaration and Implementation\r
46 -------------------------------\r
47 \r
48 **Declaration:** show_ip4_arp_command (src/vnet/ethernet/arp.c line 1465)\r
49 \r
50 **Implementation:** show_ip4_arp\r
51 \r
52 Show IP Fib\r
53 =============\r
54 \r
55 Summary/Usage\r
56 ---------------\r
57 \r
58 show ip fib [summary] [table <*table-id*>] [index <*fib-id*>] [<*ip4-addr*>[/<*mask*>]] [mtrie] [detail]\r
59 \r
60 Description\r
61 ------------\r
62 \r
63 This command displays the IPv4 FIB Tables (VRF Tables) and the route entries for each table.\r
64 \r
65 .. note:: \r
66         This command will run for a long time when the FIB tables are comprised of\r
67         millions of entries. For those senarios, consider displaying a single table or summary mode.\r
68 \r
69 Example Usage\r
70 --------------\r
71 Example of how to display all the IPv4 FIB tables:\r
72 \r
73 .. code-block:: console\r
74 \r
75     vpp# **show ip fib**\r
76 \r
77     ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto\r
78     0.0.0.0/0\r
79       unicast-ip4-chain\r
80       [@0]: dpo-load-balance: [index:0 buckets:1 uRPF:0 to:[0:0]]\r
81       [0] [@0]: dpo-drop ip6\r
82     0.0.0.0/32\r
83       unicast-ip4-chain\r
84       [@0]: dpo-load-balance: [index:1 buckets:1 uRPF:1 to:[0:0]]\r
85       [0] [@0]: dpo-drop ip6\r
86     6.0.1.2/32\r
87       unicast-ip4-chain\r
88       [@0]: dpo-load-balance: [index:30 buckets:1 uRPF:29 to:[0:0]]\r
89       [0] [@3]: arp-ipv4: via 6.0.0.1 af_packet0\r
90     7.0.0.1/32\r
91       unicast-ip4-chain\r
92       [@0]: dpo-load-balance: [index:31 buckets:4 uRPF:30 to:[0:0]]\r
93       [0] [@3]: arp-ipv4: via 6.0.0.2 af_packet0\r
94       [1] [@3]: arp-ipv4: via 6.0.0.2 af_packet0\r
95       [2] [@3]: arp-ipv4: via 6.0.0.2 af_packet0\r
96       [3] [@3]: arp-ipv4: via 6.0.0.1 af_packet0\r
97     224.0.0.0/8\r
98       unicast-ip4-chain\r
99       [@0]: dpo-load-balance: [index:3 buckets:1 uRPF:3 to:[0:0]]\r
100       [0] [@0]: dpo-drop ip6\r
101     240.0.0.0/8\r
102       unicast-ip4-chain\r
103       [@0]: dpo-load-balance: [index:2 buckets:1 uRPF:2 to:[0:0]]\r
104       [0] [@0]: dpo-drop ip6\r
105     255.255.255.255/32\r
106       unicast-ip4-chain\r
107       [@0]: dpo-load-balance: [index:4 buckets:1 uRPF:4 to:[0:0]]\r
108       [0] [@0]: dpo-drop ip6\r
109     ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto\r
110     0.0.0.0/0\r
111       unicast-ip4-chain\r
112       [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]\r
113       [0] [@0]: dpo-drop ip6\r
114     0.0.0.0/32\r
115       unicast-ip4-chain\r
116       [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]\r
117       [0] [@0]: dpo-drop ip6\r
118     172.16.1.0/24\r
119       unicast-ip4-chain\r
120       [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]\r
121       [0] [@4]: ipv4-glean: af_packet0\r
122     172.16.1.1/32\r
123       unicast-ip4-chain\r
124       [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]\r
125       [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0\r
126     172.16.1.2/32\r
127       unicast-ip4-chain\r
128       [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]\r
129       [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36\r
130     172.16.2.0/24\r
131       unicast-ip4-chain\r
132       [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]\r
133       [0] [@4]: ipv4-glean: af_packet1\r
134     172.16.2.1/32\r
135       unicast-ip4-chain\r
136       [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]\r
137       [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1\r
138     224.0.0.0/8\r
139       unicast-ip4-chain\r
140       [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]\r
141       [0] [@0]: dpo-drop ip6\r
142     240.0.0.0/8\r
143       unicast-ip4-chain\r
144       [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]\r
145       [0] [@0]: dpo-drop ip6\r
146     255.255.255.255/32\r
147       unicast-ip4-chain\r
148       [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]\r
149       [0] [@0]: dpo-drop ip6\r
150 \r
151 Example of how to display a single IPv4 FIB table:\r
152 \r
153 .. code-block:: console\r
154 \r
155     vpp# **show ip fib table 7**\r
156 \r
157     ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto\r
158     0.0.0.0/0\r
159       unicast-ip4-chain\r
160       [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]\r
161       [0] [@0]: dpo-drop ip6\r
162     0.0.0.0/32\r
163       unicast-ip4-chain\r
164       [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]\r
165       [0] [@0]: dpo-drop ip6\r
166     172.16.1.0/24\r
167       unicast-ip4-chain\r
168       [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]\r
169       [0] [@4]: ipv4-glean: af_packet0\r
170     172.16.1.1/32\r
171       unicast-ip4-chain\r
172       [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]\r
173       [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0\r
174     172.16.1.2/32\r
175       unicast-ip4-chain\r
176       [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]\r
177       [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -*> 26:a5:f6:9c:3a:36\r
178     172.16.2.0/24\r
179       unicast-ip4-chain\r
180       [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]\r
181       [0] [@4]: ipv4-glean: af_packet1\r
182     172.16.2.1/32\r
183       unicast-ip4-chain\r
184       [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]\r
185       [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1\r
186     224.0.0.0/8\r
187       unicast-ip4-chain\r
188       [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]\r
189       [0] [@0]: dpo-drop ip6\r
190     240.0.0.0/8\r
191       unicast-ip4-chain\r
192       [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]\r
193       [0] [@0]: dpo-drop ip6\r
194     255.255.255.255/32\r
195       unicast-ip4-chain\r
196       [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]\r
197       [0] [@0]: dpo-drop ip6\r
198 \r
199 Example of how to display a summary of all IPv4 FIB tables:\r
200 \r
201 .. code-block:: console\r
202 \r
203     vpp# **show ip fib summary**\r
204 \r
205     ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto\r
206         Prefix length         Count\r
207                        0               1\r
208                        8               2\r
209                       32               4\r
210     ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto\r
211         Prefix length         Count\r
212                        0               1\r
213                        8               2\r
214                       24               2\r
215                       32               4\r
216 \r
217 Declaration and Implementation\r
218 -------------------------------\r
219 \r
220 **Declaration:** ip4_show_fib_command (src/vnet/fib/ip4_fib.c line 873)\r
221 \r
222 **Implementation:** ip4_show_fib\r
223 \r
224 Show L2fib  \r
225 ============\r
226 \r
227 Summary/Usage \r
228 ------------------\r
229 \r
230 show l2fib [all] | [bd_id <*nn*> | bd_index <*nn*>] [learn | add] | [raw]\r
231 \r
232 Description\r
233 ------------\r
234 \r
235 This command displays the MAC Address entries of the L2 FIB table. \r
236 Output can be filtered to just get the number of MAC Addresses or display each \r
237 MAC Address for all bridge domains or just a single bridge domain.\r
238 \r
239 Example Usage\r
240 --------------\r
241 Example of how to display the number of MAC Address entries in the L2 FIB table:\r
242 \r
243 \r
244 .. code-block:: console\r
245 \r
246     vpp# **show l2fib**\r
247 \r
248     3 l2fib entries\r
249 \r
250     Example of how to display all the MAC Address entries in the L2 FIB table:\r
251 \r
252     vpp# **show l2fib all**\r
253 \r
254         Mac Address     BD Idx           Interface           Index  static  filter  bvi  refresh  timestamp\r
255      52:54:00:53:18:33    1      GigabitEthernet0/8/0.200      3       0       0     0      0         0\r
256      52:54:00:53:18:55    1      GigabitEthernet0/8/0.200      3       1       0     0      0         0\r
257      52:54:00:53:18:77    1                 N/A                -1      1       1     0      0         0\r
258     3 l2fib entries\r
259 \r
260 Declaration and Implementation\r
261 -------------------------------\r
262 \r
263 **Declaration:** show_l2fib_cli (src/vnet/l2/l2_fib.c line 311)\r
264 \r
265 **Implementation:** show_l2fib\r
266 \r
267 Show Trace\r
268 ===========\r
269 \r
270 Summary/Usage\r
271 --------------\r
272 \r
273 show trace buffer [max COUNT]\r
274 \r
275 Declaration and Implementation\r
276 ------------------------------\r
277 \r
278 **Declaration:** show_trace_cli (src/vlib/trace.c line 347)\r
279 \r
280 **Implementation:** cli_show_trace_buffer\r
281 \r
282 Show Vhost-User\r
283 ================\r
284 \r
285 `Show Vhost-User <../vhost/vhostuser.html#show-vhost-user>`_\r
286 \r