Skip to content

Commit a50a478

Browse files
committed
dhcp-server: ddns: T6773: reflect final config language changes
1 parent 317a44f commit a50a478

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

docs/configuration/service/dhcp-server.rst

+25-25
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,15 @@ Configuration
4949
Inform client that the DNS server can be found at `<address>`.
5050

5151
This is the configuration parameter for the entire shared network definition.
52-
All subnets will inherit this configuration item if not specified locally.
52+
All subnets will inherit this configuration item if not specified locally.
5353
Multiple DNS servers can be defined.
5454

55-
.. cfgcmd:: set service dhcp-server shared-network-name <name> option
55+
.. cfgcmd:: set service dhcp-server shared-network-name <name> option
5656
vendor-option <option-name>
5757

58-
This configuration parameter lets you specify a vendor-option for the
59-
entire shared network definition. All subnets will inherit this
60-
configuration item if not specified locally. An example for Ubiquiti is
58+
This configuration parameter lets you specify a vendor-option for the
59+
entire shared network definition. All subnets will inherit this
60+
configuration item if not specified locally. An example for Ubiquiti is
6161
shown below:
6262

6363
**Example:**
@@ -66,14 +66,14 @@ Pass address of Unifi controller at ``172.16.100.1`` to all clients of ``NET1``
6666

6767
.. code-block:: none
6868
69-
set service dhcp-server shared-network-name 'NET1' option vendor-option
69+
set service dhcp-server shared-network-name 'NET1' option vendor-option
7070
ubiquiti '172.16.100.1'
7171
7272
.. cfgcmd:: set service dhcp-server listen-address <address>
7373

74-
This configuration parameter lets the DHCP server to listen for DHCP
75-
requests sent to the specified address, it is only realistically useful for
76-
a server whose only clients are reached via unicasts, such as via DHCP relay
74+
This configuration parameter lets the DHCP server to listen for DHCP
75+
requests sent to the specified address, it is only realistically useful for
76+
a server whose only clients are reached via unicasts, such as via DHCP relay
7777
agents.
7878

7979
Individual Client Subnet
@@ -148,21 +148,21 @@ Individual Client Subnet
148148
request where no full FQDN is passed. This option can be given multiple times
149149
if you need multiple search domains (DHCP Option 119).
150150

151-
.. cfgcmd:: set service dhcp-server shared-network-name <name> subnet <subnet>
151+
.. cfgcmd:: set service dhcp-server shared-network-name <name> subnet <subnet>
152152
option vendor-option <option-name>
153153

154154
This configuration parameter lets you specify a vendor-option for the
155-
subnet specified within the shared network definition. An example for
155+
subnet specified within the shared network definition. An example for
156156
Ubiquiti is shown below:
157157

158158
**Example:**
159159

160-
Create ``172.18.201.0/24`` as a subnet within ``NET1`` and pass address of
160+
Create ``172.18.201.0/24`` as a subnet within ``NET1`` and pass address of
161161
Unifi controller at ``172.16.100.1`` to clients of that subnet.
162162

163163
.. code-block:: none
164164
165-
set service dhcp-server shared-network-name 'NET1' subnet
165+
set service dhcp-server shared-network-name 'NET1' subnet
166166
'172.18.201.0/24' option vendor-option ubiquiti '172.16.100.1'
167167
168168
@@ -179,7 +179,7 @@ server with RFC-2136 DDNS support.
179179

180180
.. cfgcmd:: set service dhcp-server dynamic-dns-update
181181

182-
Enables DDNS globally.
182+
Enables DDNS globally.
183183

184184
**Behavioral settings**
185185

@@ -191,20 +191,20 @@ level, i.e. for individual shared networks or subnets. See examples below.
191191
192192
If set to ``enable`` on global level, updates for all scopes will be enabled,
193193
except if explicitly set to ``disable`` on the scope level. If set to ``disable``,
194-
updates will only be sent for scopes, where ``send-updates`` is explicity
194+
updates will only be sent for scopes, where ``send-updates`` is explicity
195195
set to ``enable``.
196196

197-
This model is followed for a few behavioral settings below: if the option is
197+
This model is followed for a few behavioral settings below: if the option is
198198
not set, the setting is inherited from the parent scope. You can override the
199199
parent scope setting by setting the option explicitly.
200200

201-
.. cfgcmd:: set service dhcp-server dynamic-dns-update force-update [ enable
201+
.. cfgcmd:: set service dhcp-server dynamic-dns-update override-no-update [ enable
202202
| disable ]
203203
204204
VyOS will ignore client request not to update DNS records and send DDNS
205205
update requests regardless.
206206

207-
.. cfgcmd:: set service dhcp-server dynamic-dns-update force-update-both [ enable
207+
.. cfgcmd:: set service dhcp-server dynamic-dns-update override-client-update [ enable
208208
| disable ]
209209
210210
VyOS will override client DDNS request settings and always update both
@@ -228,15 +228,15 @@ level, i.e. for individual shared networks or subnets. See examples below.
228228
229229
* **never**: use the name sent by the client. If the client didn't provide any,
230230
do not generate one. This is the default behavior
231-
231+
232232
* **always**: always generate a name for the client
233233

234234
* **when-present**: replace the name the client sent with a generated one, if
235235
the client didn't send any, do not generate one
236-
236+
237237
* **when-not-present**: use the name sent by the client. If the client didn't
238238
send any, generate one for the client
239-
239+
240240
The names are generated using ``generated-prefix``, ``qualifying-suffix`` and the
241241
client's IP address string.
242242

@@ -281,7 +281,7 @@ the name in the DNS domain definitions.
281281

282282
**DNS domains definition**
283283

284-
This is global configuration of DNS servers for the updatable forward and reverse
284+
This is global configuration of DNS servers for the updatable forward and reverse
285285
DNS domains. For every domain multiple DNS servers can be specified.
286286

287287
.. cfgcmd:: set service dhcp-server dynamic-dns-update [forward|reverse]-domain
@@ -325,7 +325,7 @@ And in a subnet within the same shared network:
325325
Configure TSIG keys:
326326

327327
.. code-block:: none
328-
328+
329329
set service dhcp-server dynamic-dns-update tsig-key mydomain-net algorithm hmac-sha256
330330
set service dhcp-server dynamic-dns-update tsig-key mydomain-net secret eWF5YW15bGl0dGxla2V5IQ==
331331
set service dhcp-server dynamic-dns-update tsig-key reverse-172-18-201 algorithm hmac-sha256
@@ -334,7 +334,7 @@ Configure TSIG keys:
334334
Configure DDNS domains:
335335

336336
.. code-block:: none
337-
337+
338338
set service dhcp-server dynamic-dns-update forward-domain mydomain.net key-name mydomain-net
339339
set service dhcp-server dynamic-dns-update forward-domain mydomain.net dns-server 1 address '172.18.0.254'
340340
set service dhcp-server dynamic-dns-update forward-domain mydomain.net dns-server 1 port 1053
@@ -826,7 +826,7 @@ used:
826826

827827

828828
.. cfgcmd:: set service dhcpv6-server shared-network-name <name> subnet
829-
<prefix> prefix-delegation prefix <pd-prefix> excluded-prefix-length <length>
829+
<prefix> prefix-delegation prefix <pd-prefix> excluded-prefix-length <length>
830830

831831
Define lenght of exclude prefix in `<pd-prefix>`.
832832

0 commit comments

Comments
 (0)