From 2484e2f7c4044cca1694929d9ca2e2f413b3ae3c Mon Sep 17 00:00:00 2001
From: Christian Poessinger <christian@poessinger.com>
Date: Fri, 20 Dec 2019 18:09:45 +0100
Subject: default-route: use dedicated chapter

---
 docs/system/basic-index.rst      |  3 ++-
 docs/system/default-route.rst    | 40 ++++++++++++++++++++++++++++++++++++++++
 docs/system/host-information.rst | 28 ----------------------------
 3 files changed, 42 insertions(+), 29 deletions(-)
 create mode 100644 docs/system/default-route.rst

(limited to 'docs/system')

diff --git a/docs/system/basic-index.rst b/docs/system/basic-index.rst
index 9e559dba..928c895a 100644
--- a/docs/system/basic-index.rst
+++ b/docs/system/basic-index.rst
@@ -7,6 +7,7 @@ System Configuration
 .. toctree::
    :maxdepth: 2
 
-   host-information
    user-management
+   host-information
+   default-route
    time-zone
diff --git a/docs/system/default-route.rst b/docs/system/default-route.rst
new file mode 100644
index 00000000..567a41c8
--- /dev/null
+++ b/docs/system/default-route.rst
@@ -0,0 +1,40 @@
+.. _default_gateway:
+
+#####################
+Default Gateway/Route
+#####################
+
+In the past (VyOS 1.1) used a gateway-address configured under the system tree
+(:cfgcmd:`set system gateway-address '<address>'`), this is no longer supported
+and existing configurations are migrated to the new CLI command.
+
+Configuration
+=============
+
+.. cfgcmd:: set protocols static route 0.0.0.0/0 next-hop '<address>'
+
+   Specify static route into the routing table sending all non local traffic
+   to the nexthop address `<address>`.
+
+
+.. cfgcmd:: delete protocols static route 0.0.0.0/0
+
+   Delete default route from the system.
+
+Operation
+=========
+
+.. opcmd:: show ip route 0.0.0.0
+
+   Show routing table entry for the default route.
+
+   .. code-block:: none
+
+      vyos@vyos:~$ show ip route 0.0.0.0
+      Routing entry for 0.0.0.0/0
+        Known via "static", distance 10, metric 0, best
+        Last update 09:46:30 ago
+        * 172.18.201.254, via eth0.201
+
+.. seealso:: Configuration of :ref:`routing-static`
+
diff --git a/docs/system/host-information.rst b/docs/system/host-information.rst
index b60faa86..1f2f6918 100644
--- a/docs/system/host-information.rst
+++ b/docs/system/host-information.rst
@@ -146,31 +146,3 @@ Example: Set alias `router1` for system with hostname `RT01`:
         inet 10.20.30.41
     }
 
-Default Gateway/Route
-=====================
-
-In the past (VyOS 1.1.8) used a gateway-address configured in the system tree
-(`set system gateway-address <IP address>`) this is no longer supported and
-existing configurations are migrated to the new CLI commands.
-
-It is replaced by inserting a static route into the routing table using:
-
-.. code-block:: none
-
-  set protocols static route 0.0.0.0/0 next-hop <gateway ip>
-
-Delete the default route from the system
-
-.. code-block:: none
-
-  delete protocols static route 0.0.0.0/0
-
-Show default route:
-
-.. code-block:: none
-
-  vyos@vyos$ show ip route 0.0.0.0
-  Routing entry for 0.0.0.0/0
-    Known via "static", distance 1, metric 0, best
-    Last update 3d00h23m ago
-    * 172.16.34.6, via eth1
-- 
cgit v1.2.3