summaryrefslogtreecommitdiff
path: root/docs/routing
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-11-23 19:25:34 +0100
committerChristian Poessinger <christian@poessinger.com>2019-11-23 19:25:34 +0100
commit44ef614dea9f3d1ff69e5855dd8343dec6521c8e (patch)
treeb19332c9165b9b2eb34fb26974216fe81bf14636 /docs/routing
parent2bdc13ab4805eb674900d1d5a16dbcb648be6667 (diff)
downloadvyos-documentation-44ef614dea9f3d1ff69e5855dd8343dec6521c8e.tar.gz
vyos-documentation-44ef614dea9f3d1ff69e5855dd8343dec6521c8e.zip
toc: on the way to a better structured toc
Diffstat (limited to 'docs/routing')
-rw-r--r--docs/routing/arp.rst16
-rw-r--r--docs/routing/index.rst7
-rw-r--r--docs/routing/static.rst5
3 files changed, 15 insertions, 13 deletions
diff --git a/docs/routing/arp.rst b/docs/routing/arp.rst
index 11371d49..a1a8c430 100644
--- a/docs/routing/arp.rst
+++ b/docs/routing/arp.rst
@@ -1,7 +1,8 @@
.. _routing-arp:
+###
ARP
----
+###
:abbr:`ARP (Address Resolution Protocol)` is a communication protocol used for
discovering the link layer address, such as a MAC address, associated with a
@@ -15,13 +16,16 @@ provided by the Neighbor Discovery Protocol (NDP).
To manipulate or display ARP_ table entries, the following commands are
implemented.
-Add static ARP entry
-^^^^^^^^^^^^^^^^^^^^
+Configure
+=========
-.. cfcmd:: set protocols static arp 10.1.1.100 hwaddr 08:00:27:de:23:aa
+.. cfcmd:: set protocols static arp 192.0.2.100 hwaddr 00:53:27:de:23:aa
-Display ARP entries
-^^^^^^^^^^^^^^^^^^^
+This will configure a static ARP entry always resolving `192.0.2.100` to
+`00:53:27:de:23:aa`
+
+Operation
+=========
.. opcmd:: show protocols static arp
diff --git a/docs/routing/index.rst b/docs/routing/index.rst
index 1a1db43f..b49120f7 100644
--- a/docs/routing/index.rst
+++ b/docs/routing/index.rst
@@ -1,11 +1,8 @@
.. _routing:
+#######
Routing
-=======
-
-VyOS is a "router first" network operating system. It supports static routing,
-policy routing, and dynamic routing using standard protocols (RIP, OSPF, and
-BGP).
+#######
.. toctree::
:maxdepth: 1
diff --git a/docs/routing/static.rst b/docs/routing/static.rst
index b2c7833a..3c042844 100644
--- a/docs/routing/static.rst
+++ b/docs/routing/static.rst
@@ -1,7 +1,8 @@
.. _routing-static:
-Static
-------
+#############
+Static Routes
+#############
Static routes are manually configured network routes.