docs: better docs, mv doxygen to sphinx
[vpp.git] / docs / reference / cmdreference / ip / ip.rst
diff --git a/docs/reference/cmdreference/ip/ip.rst b/docs/reference/cmdreference/ip/ip.rst
deleted file mode 100644 (file)
index a709215..0000000
+++ /dev/null
@@ -1,151 +0,0 @@
-.. _ip1:\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
-IP Route\r
-==========\r
-\r
-Summary/Usage\r
---------------\r
-\r
-`ip route [add|del] [count <*n*>] <*dst-ip-addr*>/<*width*> [table <*table-id*>] via [next-hop-address[next-hop-interface] [next-hop-table <*value*>] [weight <*value*>] [preference <*value*>] [udp-encap-id <*value*>] [ip4-lookup-in-table <*value*>] [ip6-lookup-in-table <*value*>] [mpls-lookup-in-table <*value*>] [resolve-via-host] [resolve-via-connected] [rx-ip4 <*interface*>] [out-labels <*value value value*>]`\r
-\r
-Description\r
-------------\r
-\r
-This command is used to add or delete IPv4 or IPv6 routes. All IP Addresses\r
-('<*dst-ip-addr*>/<*width*>', '<*next-hop-ip-addr*>' and '<*adj-hop-ip-addr*>') can be IPv4 or IPv6,\r
-but all must be of the same form in a single command. To display the current set of routes,\r
-use the commands 'show ip fib' and 'show ip6 fib'.\r
-\r
-Example Usage\r
---------------\r
-\r
-Example of how to add a straight forward static route:\r
-\r
-.. code-block:: console\r
-\r
-    vpp# ip route add 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0\r
-\r
-Example of how to delete a straight forward static route:\r
-\r
-.. code-block:: console\r
-\r
-    vpp# ip route del 6.0.1.2/32 via 6.0.0.1 GigabitEthernet2/0/0\r
-\r
-Mainly for route add/del performance testing, one can add or delete multiple routes by adding\r
-'count N' to the previous item:\r
-\r
-.. code-block:: console\r
-\r
-    vpp# ip route add count 10 7.0.0.0/24 via 6.0.0.1 GigabitEthernet2/0/0\r
-\r
-Add multiple routes for the same destination to create equal-cost multipath:\r
-\r
-.. code-block:: console\r
-\r
-    vpp# ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0\r
-\r
-    vpp# ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0\r
-\r
-For unequal-cost multipath, specify the desired weights. This combination of weights\r
-results in 3/4 of the traffic following the second path, 1/4 following the first path:\r
-\r
-.. code-block:: console\r
-\r
-    vpp# ip route add 7.0.0.1/32 via 6.0.0.1 GigabitEthernet2/0/0 weight 1\r
-\r
-    vpp# ip route add 7.0.0.1/32 via 6.0.0.2 GigabitEthernet2/0/0 weight 3\r
-\r
-To add a route to a particular FIB table (VRF), use:\r
-\r
-.. code-block:: console\r
-\r
-    vpp# ip route add 172.16.24.0/24 table 7 via GigabitEthernet2/0/0\r
-\r
-Declaration and Implementation\r
----------------------------------\r
-\r
-**Declaration:** ip_route_command (src/vnet/ip/lookup.c line 641)\r
-\r
-**Implementation:** vnet_ip_route_cmd\r
-\r
-Ping\r
-=====\r
-\r
-Summary/Usage\r
---------------\r
-\r
-ping {<*ip-addr*> | ipv4 <*ip4-addr*> | ipv6 <*ip6-addr*>} [ipv4 <*ip4-addr*> | ipv6 <*ip6-addr*>] [source <*interface*>] [size <*pktsize*>] [interval <*sec*>] [repeat <*cnt*>] [table-id <*id*>] [verbose]\r
-\r
-Description\r
-------------\r
-\r
-This command sends an ICMP ECHO_REQUEST to network hosts. The address can be an IPv4 or IPv6\r
-address (or both at the same time).\r
-\r
-Example Usage\r
---------------\r
-\r
-Example of how ping an IPv4 address:\r
-\r
-.. code-block:: console\r
-\r
-    vpp# ping 172.16.1.2 source GigabitEthernet2/0/0 repeat 2\r
-\r
-    64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1090 ms\r
-    64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0914 ms\r
-\r
-    Statistics: 2 sent, 2 received, 0% packet loss\r
-\r
-    Example of how ping both an IPv4 address and IPv6 address at the same time:\r
-\r
-    vpp# ping 172.16.1.2 ipv6 fe80::24a5:f6ff:fe9c:3a36 source GigabitEthernet2/0/0 repeat 2 verbose\r
-\r
-    Adjacency index: 10, sw_if_index: 1\r
-    Adj: ip6-discover-neighbor\r
-    Adj Interface: 0\r
-    Forced set interface: 1\r
-    Adjacency index: 0, sw_if_index: 4294967295\r
-    Adj: ip4-miss\r
-    Adj Interface: 0\r
-    Forced set interface: 1\r
-    Source address: 172.16.1.1\r
-    64 bytes from 172.16.1.2: icmp_seq=1 ttl=64 time=.1899 ms\r
-    Adjacency index: 10, sw_if_index: 1\r
-    Adj: ip6-discover-neighbor\r
-    Adj Interface: 0\r
-    Forced set interface: 1\r
-    Adjacency index: 0, sw_if_index: 4294967295\r
-    Adj: ip4-miss\r
-    Adj Interface: 0\r
-    Forced set interface: 1\r
-    Source address: 172.16.1.1\r
-    64 bytes from 172.16.1.2: icmp_seq=2 ttl=64 time=.0910 ms\r
-\r
-    Statistics: 4 sent, 2 received, 50% packet loss\r
-\r
-Declaration and Implementation\r
--------------------------------\r
-\r
-Declaration: ping_command (src/vnet/ip/ping.c line 899)\r
-\r
-Implementation: ping_ip_address\r
-\r
-Set Interface IP Address\r
-=========================\r
-\r
-`Set Interface IP Address <../interface/setinterface.html#set-interface-ip-address>`_\r
-\r
-Show IP Arp\r
-=============\r
-\r
-`Show IP-Arp <../show/show.html#show-ip-arp>`_\r
-\r
-\r
-Show IP Fib\r
-============\r
-\r
-`Show IP-Fib <../show/show.html#show-ip-fib>`_\r