summaryrefslogtreecommitdiff
path: root/docs/_include/interface-dhcp-options.txt
diff options
context:
space:
mode:
Diffstat (limited to 'docs/_include/interface-dhcp-options.txt')
-rw-r--r--docs/_include/interface-dhcp-options.txt50
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/_include/interface-dhcp-options.txt b/docs/_include/interface-dhcp-options.txt
new file mode 100644
index 00000000..1a0ce260
--- /dev/null
+++ b/docs/_include/interface-dhcp-options.txt
@@ -0,0 +1,50 @@
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+ {{ var5 }} {{ var6 }} 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 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options client-id 'foo-bar'
+
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+ {{ var5 }} {{ var6 }} 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 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options host-name 'VyOS'
+
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+ {{ var5 }} {{ var6 }} 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 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options vendor-class-id 'VyOS'
+
+.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
+ {{ var5 }} {{ var6 }} 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 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options no-default-route