From 861225aba395884eb91f61117b7a1bcf91d60798 Mon Sep 17 00:00:00 2001
From: Christian Poessinger <christian@poessinger.com>
Date: Tue, 10 Nov 2020 20:58:07 +0100
Subject: interfaces: document dhcp-options

---
 docs/_include/interface-common-with-dhcp.txt |  4 +++
 docs/_include/interface-dhcp-options.txt     | 46 ++++++++++++++++++++++++++++
 2 files changed, 50 insertions(+)
 create mode 100644 docs/_include/interface-dhcp-options.txt

(limited to 'docs/_include')

diff --git a/docs/_include/interface-common-with-dhcp.txt b/docs/_include/interface-common-with-dhcp.txt
index 34eef941..585951b3 100644
--- a/docs/_include/interface-common-with-dhcp.txt
+++ b/docs/_include/interface-common-with-dhcp.txt
@@ -2,6 +2,10 @@
    :var0: {{ var0 }}
    :var1: {{ var1 }}
 
+.. cmdinclude:: ../_include/interface-dhcp-options.txt
+   :var0: {{ var0 }}
+   :var1: {{ var1 }}
+
 .. cmdinclude:: ../_include/interface-common.txt
    :var0: {{ var0 }}
    :var1: {{ var1 }}
diff --git a/docs/_include/interface-dhcp-options.txt b/docs/_include/interface-dhcp-options.txt
new file mode 100644
index 00000000..da1975fc
--- /dev/null
+++ b/docs/_include/interface-dhcp-options.txt
@@ -0,0 +1,46 @@
+.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcp-options client-id <description>
+
+  :rfc:`2131` states: The client MAY choose to explicitly provide the identifier
+  through the 'client identifier' option. If the client supplies a 'client
+  identifier', the client MUST use the same 'client identifier' in all
+  subsequent messages, and the server MUST use that identifier to identify the
+  client.
+
+  Example:
+
+  .. code-block:: none
+
+    set interfaces {{ var0 }} {{ var1 }} dhcp-options client-id 'foo-bar'
+
+.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcp-options host-name <hostname>
+
+  Instead of sending the real system hostname to the DHCP server, overwrite the
+  host-name with this given-value.
+
+  Example:
+
+  .. code-block:: none
+
+    set interfaces {{ var0 }} {{ var1 }} dhcp-options host-name 'VyOS'
+
+.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcp-options vendor-class-id <vendor-id>
+
+  The vendor-class-id option can be used to request a specific class of vendor
+  options from the server.
+
+  Example
+
+  .. code-block:: none
+
+    set interfaces {{ var0 }} {{ var1 }} dhcp-options vendor-class-id 'VyOS'
+
+.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcp-options no-default-route
+
+  Only request an address from the DHCP server but do not request a default
+  gateway.
+
+  Example:
+
+  .. code-block:: none
+
+    set interfaces {{ var0 }} {{ var1 }} dhcp-options no-default-route
-- 
cgit v1.2.3