Code Review / vpp.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
docs: better docs, mv doxygen to sphinx
[vpp.git] / docs / reference / cmdreference / show / show.rst
diff --git a/docs/reference/cmdreference/show/show.rst b/docs/reference/cmdreference/show/show.rst
deleted file mode 100644 (file)
index 61c5360..0000000
--- a/docs/reference/cmdreference/show/show.rst
+++ /dev/null
@@ -1,286 +0,0 @@
-.. _interface:\r
-\r
-.. toctree::\r
-\r
-.. 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
-\r
-Show Bridge-Domain\r
-===================\r
-\r
-`Show Bridge-Domain <../interface/hardware.html#show-bridge-domain>`_\r
-\r
-Show Interface\r
-================\r
-\r
-`Show Interface <../interface/basic.html#show-interface>`_\r
-\r
-Show IP Arp\r
-============\r
-\r
-Summary/Usage\r
----------------\r
-\r
-show ip arp\r
-\r
-Description\r
-------------\r
-\r
-Display all the IPv4 ARP entries.\r
-\r
-Example Usage\r
---------------\r
-Example of how to display the IPv4 ARP table:\r
-\r
-.. code-block:: console\r
-\r
-   vpp# **show ip arp**\r
-       Time      FIB        IP4       Flags      Ethernet              Interface\r
-       346.3028   0       6.1.1.3            de:ad:be:ef:ba:be   GigabitEthernet2/0/0\r
-      3077.4271   0       6.1.1.4       S    de:ad:be:ef:ff:ff   GigabitEthernet2/0/0\r
-      2998.6409   1       6.2.2.3            de:ad:be:ef:00:01   GigabitEthernet2/0/0\r
-    Proxy arps enabled for:\r
-    Fib_index 0   6.0.0.1 - 6.0.0.11\r
-\r
-       \r
-Declaration and Implementation\r
--------------------------------\r
-\r
-**Declaration:** show_ip4_arp_command (src/vnet/ethernet/arp.c line 1465)\r
-\r
-**Implementation:** show_ip4_arp\r
-\r
-Show IP Fib\r
-=============\r
-\r
-Summary/Usage\r
----------------\r
-\r
-show ip fib [summary] [table <*table-id*>] [index <*fib-id*>] [<*ip4-addr*>[/<*mask*>]] [mtrie] [detail]\r
-\r
-Description\r
-------------\r
-\r
-This command displays the IPv4 FIB Tables (VRF Tables) and the route entries for each table.\r
-\r
-.. note:: \r
-       This command will run for a long time when the FIB tables are comprised of\r
-       millions of entries. For those scenarios, consider displaying a single table or summary mode.\r
-\r
-Example Usage\r
---------------\r
-Example of how to display all the IPv4 FIB tables:\r
-\r
-.. code-block:: console\r
-\r
-    vpp# **show ip fib**\r
-\r
-    ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto\r
-    0.0.0.0/0\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:0 buckets:1 uRPF:0 to:[0:0]]\r
-      [0] [@0]: dpo-drop ip6\r
-    0.0.0.0/32\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:1 buckets:1 uRPF:1 to:[0:0]]\r
-      [0] [@0]: dpo-drop ip6\r
-    6.0.1.2/32\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:30 buckets:1 uRPF:29 to:[0:0]]\r
-      [0] [@3]: arp-ipv4: via 6.0.0.1 af_packet0\r
-    7.0.0.1/32\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:31 buckets:4 uRPF:30 to:[0:0]]\r
-      [0] [@3]: arp-ipv4: via 6.0.0.2 af_packet0\r
-      [1] [@3]: arp-ipv4: via 6.0.0.2 af_packet0\r
-      [2] [@3]: arp-ipv4: via 6.0.0.2 af_packet0\r
-      [3] [@3]: arp-ipv4: via 6.0.0.1 af_packet0\r
-    224.0.0.0/8\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:3 buckets:1 uRPF:3 to:[0:0]]\r
-      [0] [@0]: dpo-drop ip6\r
-    240.0.0.0/8\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:2 buckets:1 uRPF:2 to:[0:0]]\r
-      [0] [@0]: dpo-drop ip6\r
-    255.255.255.255/32\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:4 buckets:1 uRPF:4 to:[0:0]]\r
-      [0] [@0]: dpo-drop ip6\r
-    ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto\r
-    0.0.0.0/0\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]\r
-      [0] [@0]: dpo-drop ip6\r
-    0.0.0.0/32\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]\r
-      [0] [@0]: dpo-drop ip6\r
-    172.16.1.0/24\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]\r
-      [0] [@4]: ipv4-glean: af_packet0\r
-    172.16.1.1/32\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]\r
-      [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0\r
-    172.16.1.2/32\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]\r
-      [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -> 26:a5:f6:9c:3a:36\r
-    172.16.2.0/24\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]\r
-      [0] [@4]: ipv4-glean: af_packet1\r
-    172.16.2.1/32\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]\r
-      [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1\r
-    224.0.0.0/8\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]\r
-      [0] [@0]: dpo-drop ip6\r
-    240.0.0.0/8\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]\r
-      [0] [@0]: dpo-drop ip6\r
-    255.255.255.255/32\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]\r
-      [0] [@0]: dpo-drop ip6\r
-\r
-Example of how to display a single IPv4 FIB table:\r
-\r
-.. code-block:: console\r
-\r
-    vpp# **show ip fib table 7**\r
-\r
-    ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto\r
-    0.0.0.0/0\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:12 buckets:1 uRPF:11 to:[0:0]]\r
-      [0] [@0]: dpo-drop ip6\r
-    0.0.0.0/32\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:13 buckets:1 uRPF:12 to:[0:0]]\r
-      [0] [@0]: dpo-drop ip6\r
-    172.16.1.0/24\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:17 buckets:1 uRPF:16 to:[0:0]]\r
-      [0] [@4]: ipv4-glean: af_packet0\r
-    172.16.1.1/32\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:18 buckets:1 uRPF:17 to:[1:84]]\r
-      [0] [@2]: dpo-receive: 172.16.1.1 on af_packet0\r
-    172.16.1.2/32\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:21 buckets:1 uRPF:20 to:[0:0]]\r
-      [0] [@5]: ipv4 via 172.16.1.2 af_packet0: IP4: 02:fe:9e:70:7a:2b -*> 26:a5:f6:9c:3a:36\r
-    172.16.2.0/24\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:19 buckets:1 uRPF:18 to:[0:0]]\r
-      [0] [@4]: ipv4-glean: af_packet1\r
-    172.16.2.1/32\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:20 buckets:1 uRPF:19 to:[0:0]]\r
-      [0] [@2]: dpo-receive: 172.16.2.1 on af_packet1\r
-    224.0.0.0/8\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:15 buckets:1 uRPF:14 to:[0:0]]\r
-      [0] [@0]: dpo-drop ip6\r
-    240.0.0.0/8\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:14 buckets:1 uRPF:13 to:[0:0]]\r
-      [0] [@0]: dpo-drop ip6\r
-    255.255.255.255/32\r
-      unicast-ip4-chain\r
-      [@0]: dpo-load-balance: [index:16 buckets:1 uRPF:15 to:[0:0]]\r
-      [0] [@0]: dpo-drop ip6\r
-\r
-Example of how to display a summary of all IPv4 FIB tables:\r
-\r
-.. code-block:: console\r
-\r
-    vpp# **show ip fib summary**\r
-\r
-    ipv4-VRF:0, fib_index 0, flow hash: src dst sport dport proto\r
-        Prefix length         Count\r
-                       0               1\r
-                       8               2\r
-                      32               4\r
-    ipv4-VRF:7, fib_index 1, flow hash: src dst sport dport proto\r
-        Prefix length         Count\r
-                       0               1\r
-                       8               2\r
-                      24               2\r
-                      32               4\r
-\r
-Declaration and Implementation\r
--------------------------------\r
-\r
-**Declaration:** ip4_show_fib_command (src/vnet/fib/ip4_fib.c line 873)\r
-\r
-**Implementation:** ip4_show_fib\r
-\r
-Show L2fib  \r
-============\r
-\r
-Summary/Usage \r
-------------------\r
-\r
-show l2fib [all] | [bd_id <*nn*> | bd_index <*nn*>] [learn | add] | [raw]\r
-\r
-Description\r
-------------\r
-\r
-This command displays the MAC Address entries of the L2 FIB table. \r
-Output can be filtered to just get the number of MAC Addresses or display each \r
-MAC Address for all bridge domains or just a single bridge domain.\r
-\r
-Example Usage\r
---------------\r
-Example of how to display the number of MAC Address entries in the L2 FIB table:\r
-\r
-\r
-.. code-block:: console\r
-\r
-    vpp# **show l2fib**\r
-\r
-    3 l2fib entries\r
-\r
-    Example of how to display all the MAC Address entries in the L2 FIB table:\r
-\r
-    vpp# **show l2fib all**\r
-\r
-        Mac Address     BD Idx           Interface           Index  static  filter  bvi  refresh  timestamp\r
-     52:54:00:53:18:33    1      GigabitEthernet0/8/0.200      3       0       0     0      0         0\r
-     52:54:00:53:18:55    1      GigabitEthernet0/8/0.200      3       1       0     0      0         0\r
-     52:54:00:53:18:77    1                 N/A                -1      1       1     0      0         0\r
-    3 l2fib entries\r
-\r
-Declaration and Implementation\r
--------------------------------\r
-\r
-**Declaration:** show_l2fib_cli (src/vnet/l2/l2_fib.c line 311)\r
-\r
-**Implementation:** show_l2fib\r
-\r
-Show Trace\r
-===========\r
-\r
-Summary/Usage\r
---------------\r
-\r
-show trace buffer [max COUNT]\r
-\r
-Declaration and Implementation\r
-------------------------------\r
-\r
-**Declaration:** show_trace_cli (src/vlib/trace.c line 347)\r
-\r
-**Implementation:** cli_show_trace_buffer\r
-\r
-Show Vhost-User\r
-================\r
-\r
-`Show Vhost-User <../vhost/vhostuser.html#show-vhost-user>`_\r
-\r
Vector Packet Processing