dhcp: use new '.. cfgcmd::' syntax

1 files changed, 60 insertions, 49 deletions

diff --git a/docs/services/dhcp.rst b/docs/services/dhcp.rst
index 36162bbe..898784a0 100644
--- a/docs/services/dhcp.rst
+++ b/docs/services/dhcp.rst
@@ -1,31 +1,32 @@
+.. _dhcp:
 
-DHCP Server
------------
-
-Multiple DHCP Servers can be run from a single machine. Each DHCP service is
-identified by a `shared-network-name`.
+########
+DHCP(v6)
+########
 
-DHCP Server Example
-^^^^^^^^^^^^^^^^^^^
+VyOS uses ISC DHCPd for both IPv4 and IPv6 address assignment.
 
-In this example, we are offering address space in the 172.16.17.0/24 network,
-which is on eth1, and pppoe0 is our connection to the internet. We are using
-the network name `dhcpexample`.
+DHCP Server
+===========
 
-Prerequisites
-^^^^^^^^^^^^^
+Multiple DHCP Servers can be run from a single machine. Each DHCP service is
+identified by a ``shared-network-name``.
 
-Configuring the PPPoE interface is assumed to be done already, and appears
-on `pppoe0`
+Basic Example
+-------------
 
-Interface Configuration
-^^^^^^^^^^^^^^^^^^^^^^^
+We are offering address space in the 172.16.17.0/24 network, which is
+physically connected on eth1, and pppoe0 is our connection to the internet.
+We are using the network name `dhcpexample`.
 
-.. code-block:: sh
+Prerequisites:
 
- set interface ethernet eth1 address 172.16.17.1/24
+* Configuring PPPoE interface is assumed to be done already, and appears
+  on `pppoe0`
+* Interface ``eth1`` is configured to be connected to our DHCP subnet
+  172.16.17.0/24 by assigning e.g. address 172.16.17.1/24.
 
-Multiple ranges can be defined and can contain holes.
+Multiple DHCP ranges can be defined and may contain holes.
 
 .. code-block:: sh
 
@@ -40,21 +41,19 @@ Multiple ranges can be defined and can contain holes.
 Explanation
 ^^^^^^^^^^^
 
-* :code:`set service dhcp-server shared-network-name dhcpexample authoritative`
+.. cfgcmd:: set service dhcp-server shared-network-name dhcpexample authoritative
 
   This says that this device is the only DHCP server for this network. If other
   devices are trying to offer DHCP leases, this machine will send 'DHCPNAK' to
   any device trying to request an IP address that is
   not valid for this network.
 
-* :code:`set service dhcp-server shared-network-name dhcpexample subnet
-  172.16.17.0/24 default-router 172.16.17.1`
+.. cfgcmd:: set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 default-router 172.16.17.1
 
   This is a configuration parameter for the subnet, saying that as part of the
   response, tell the client that I am the default router for this network
 
-* :code:`set service dhcp-server shared-network-name dhcpexample subnet
-  172.16.17.0/24 dns-server 172.16.17.1`
+.. cfgcmd:: set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 dns-server 172.16.17.1
 
   This is a configuration parameter for the subnet, saying that as part of the
   response, tell the client that I am the DNS server for this network. If you
@@ -62,27 +61,23 @@ Explanation
   DNS servers, such as google's. You can add multiple entries by repeating the
   line.
 
-* :code:`set service dhcp-server shared-network-name dhcpexample subnet
-  172.16.17.0/24 lease 86400`
+.. cfgcmd:: set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 lease 86400
 
   Assign the IP address to this machine for 24 hours. It is unlikely you'd need
   to shorten this period, unless you are running a network with lots of devices
   appearing and disappearing.
 
-
-* :code:`set service dhcp-server shared-network-name dhcpexample subnet
-  172.16.17.0/24 range 0 start 172.16.17.100`
+.. cfgcmd:: set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 range 0 start 172.16.17.100
 
   Make a range of addresses available for clients starting from .100 [...]
 
-* :code:`set service dhcp-server shared-network-name dhcpexample subnet
-  172.16.17.0/24 range 0 stop 172.16.17.199`
+.. cfgcmd:: set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 range 0 stop 172.16.17.199
 
   [...] and ending at .199
 
 
 Failover
-^^^^^^^^
+--------
 
 VyOS provides support for DHCP failover:
 
@@ -111,28 +106,44 @@ or
    their lease tables in sync, they must be able to reach each other on TCP
    port 647. If you have firewall rules in effect, adjust them accordingly.
 
-Static mappings MAC/IP
-^^^^^^^^^^^^^^^^^^^^^^
+Static mappings
+---------------
 
-.. code-block:: sh
+You can specify a static DHCP assignment on a per host basis. You will need the
+MAC address of the station and your desired IP address. The address must be
+inside your subnet definition but can be outside of your range sttement.
+
+
+.. cfgcmd:: set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 static-mapping <host> ip-address 172.16.17.10
+
+Configure desired IPv4 address for your host referenced to as `host`.
+
+.. cfgcmd:: set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 static-mapping <hodt> mac-address ff:ff:ff:ff:ff:ff
+
+Configure MAC address for your host referenced by as `host` used in this static
+assignment.
+
+DHCP Options
+------------
+
+.. cfgcmd:: set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 default-router '<address>'
 
-  set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 static-mapping static-mapping-01 ip-address 172.16.17.10
-  set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 static-mapping static-mapping-01 mac-address ff:ff:ff:ff:ff:ff
+Specify the default routers IPv4 address which should be used in this subnet.
+This can - of course - be a VRRP address (DHCP option 003).
 
-DHCP server options
-^^^^^^^^^^^^^^^^^^^^^^^^^
+.. cfgcmd:: set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 dns-server '<address>'
 
-default-router (DHCP option 003)
-  :code:`set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 default-router <ROUTER-IP>`
+Specify the DNS nameservers used (Option 006). This option may be used mulltiple
+times to specify additional DNS nameservers.
 
-dns-server (DHCP option 006)
-  :code:`set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 dns-server <DNS-SERVER-IP>`
+.. cfgcmd:: set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 domain-name '<domain-name>'
 
-domain-name  Client domain name (DHCP option 015)
-  :code:`set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 domain-name "<DOMAIN-NAME>"`
+The domain-name parameter should be the domain name that will be appended to
+the client's hostname to form a fully-qualified domain-name (FQDN) (DHCP
+Option 015).
 
-domain-search (DHCP option 119)
-  This option can be given multiple times if you need multiple search domains
-  :code:`set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 domain-search "<DOMAIN_NAME_1>"`
-  :code:`set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 domain-search "<DOMAIN_NAME_2>"`
+.. cfgcmd:: set service dhcp-server shared-network-name dhcpexample subnet 172.16.17.0/24 domain-search '<domain-name>'
 
+The domain-name parameter should be the domain name used when completing DNS
+request where no full FQDN is passed. This option can be given multiple times
+if you need multiple search domains (DHCP Option 119).