summaryrefslogtreecommitdiff
path: root/docs/services
diff options
context:
space:
mode:
authorJernej Jakob <jernej.jakob@gmail.com>2019-12-21 12:08:54 +0100
committerChristian Poessinger <christian@poessinger.com>2019-12-21 19:30:59 +0100
commit66c64bd3a30ea8ffbbaf9fa5c8d657d815bb0392 (patch)
treea2b7e0aca6dfeb3983369948a78ec761179eeb37 /docs/services
parent52f5d4f1d9400a28d5ab4f8f2e5e45d84d657357 (diff)
downloadvyos-documentation-66c64bd3a30ea8ffbbaf9fa5c8d657d815bb0392.tar.gz
vyos-documentation-66c64bd3a30ea8ffbbaf9fa5c8d657d815bb0392.zip
dhcp: T1806: explain how to use quote characters inside raw parameters
Diffstat (limited to 'docs/services')
-rw-r--r--docs/services/dhcp.rst14
1 files changed, 13 insertions, 1 deletions
diff --git a/docs/services/dhcp.rst b/docs/services/dhcp.rst
index ed5082d4..94efeaf1 100644
--- a/docs/services/dhcp.rst
+++ b/docs/services/dhcp.rst
@@ -317,12 +317,24 @@ Always verify that the parameters are correct before commiting the configuration
Refer to isc-dhcp's dhcpd.conf manual for more information:
https://kb.isc.org/docs/isc-dhcp-44-manual-pages-dhcpdconf
+Quotes can be used inside parameter values by replacing all quote characters
+with the string ``&quot;``. They will be replaced with literal quote characters
+when generating dhcpd.conf.
+
Example
^^^^^^^
.. opcmd:: set service dhcp-server shared-network-name dhcpexample subnet 192.0.2.0/24 static-mapping example static-mapping-parameters "option domain-name-servers 192.0.2.11, 192.0.2.12;"
- Override the static-mapping's dns-server with a custom one that will be sent only to this host.
+ Override the static-mapping's dns-server with a custom one that will be sent
+ only to this host.
+
+.. opcmd:: set service dhcp-server shared-network-name dhcpexample subnet 192.0.2.0/24 static-mapping example static-mapping-parameters "option pxelinux.configfile &quot;pxelinux.cfg/01-00-15-17-44-2d-aa&quot;;"
+
+ An option that takes a quoted string is set by replacing all quote characters
+ with the string ``&quot;`` inside the static-mapping-parameters value.
+ The resulting line in dhcpd.conf will be
+ ``option pxelinux.configfile "pxelinux.cfg/01-00-15-17-44-2d-aa";``.
Operation Mode
--------------