summaryrefslogtreecommitdiff
path: root/interface-definitions/dhcpv6-server.xml.in
blob: 16d0f9b014af838386ad7dcdfc5a63bd1c3f8378 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="service">
    <children>
      <node name="dhcpv6-server" owner="${vyos_conf_scripts_dir}/dhcpv6_server.py">
        <properties>
          <help>DHCP for IPv6 (DHCPv6) server</help>
          <priority>900</priority>
        </properties>
        <children>
          #include <include/generic-disable-node.xml.i>
          <node name="global-parameters">
            <properties>
              <help>Additional global parameters for DHCPv6 server</help>
            </properties>
            <children>
              #include <include/name-server-ipv6.xml.i>
            </children>
          </node>
          <leafNode name="preference">
            <properties>
              <help>Preference of this DHCPv6 server compared with others</help>
              <valueHelp>
                <format>u32:0-255</format>
                <description>DHCPv6 server preference (0-255)</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 0-255"/>
              </constraint>
              <constraintErrorMessage>Preference must be between 0 and 255</constraintErrorMessage>
            </properties>
          </leafNode>
          <tagNode name="shared-network-name">
            <properties>
              <help>DHCPv6 shared network name</help>
              <constraint>
                <regex>[-_a-zA-Z0-9.]+</regex>
              </constraint>
              <constraintErrorMessage>Invalid DHCPv6 shared network name. May only contain letters, numbers and .-_</constraintErrorMessage>
            </properties>
            <children>
              #include <include/generic-disable-node.xml.i>
              #include <include/generic-description.xml.i>
              <leafNode name="interface">
                <properties>
                  <help>Optional interface for this shared network to accept requests from</help>
                  <completionHelp>
                    <script>${vyos_completion_dir}/list_interfaces</script>
                  </completionHelp>
                  <valueHelp>
                    <format>txt</format>
                    <description>Interface name</description>
                  </valueHelp>
                  <constraint>
                    #include <include/constraint/interface-name.xml.i>
                  </constraint>
                </properties>
              </leafNode>
              <node name="common-options">
                <properties>
                  <help>Common options to distribute to all clients, including stateless clients</help>
                </properties>
                <children>
                  <leafNode name="info-refresh-time">
                    <properties>
                      <help>Time (in seconds) that stateless clients should wait between refreshing the information they were given</help>
                      <valueHelp>
                        <format>u32:1-4294967295</format>
                        <description>DHCPv6 information refresh time</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-4294967295"/>
                      </constraint>
                    </properties>
                  </leafNode>
                  #include <include/dhcp/domain-search.xml.i>
                  #include <include/name-server-ipv6.xml.i>
                </children>
              </node>
              <tagNode name="subnet">
                <properties>
                  <help>IPv6 DHCP subnet for this shared network</help>
                  <valueHelp>
                    <format>ipv6net</format>
                    <description>IPv6 address and prefix length</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv6-prefix"/>
                  </constraint>
                </properties>
                <children>
                  <node name="address-range">
                    <properties>
                      <help>Parameters setting ranges for assigning IPv6 addresses</help>
                    </properties>
                    <children>
                      <leafNode name="prefix">
                        <properties>
                          <help>IPv6 prefix defining range of addresses to assign</help>
                          <valueHelp>
                            <format>ipv6net</format>
                            <description>IPv6 address and prefix length</description>
                          </valueHelp>
                          <constraint>
                            <validator name="ipv6-prefix"/>
                          </constraint>
                          <multi/>
                        </properties>
                      </leafNode>
                      <tagNode name="start">
                        <properties>
                          <help>First in range of consecutive IPv6 addresses to assign</help>
                          <valueHelp>
                            <format>ipv6</format>
                            <description>IPv6 address</description>
                          </valueHelp>
                          <constraint>
                            <validator name="ipv6-address"/>
                          </constraint>
                        </properties>
                        <children>
                          <leafNode name="stop">
                            <properties>
                              <help>Last in range of consecutive IPv6 addresses</help>
                              <valueHelp>
                                <format>ipv6</format>
                                <description>IPv6 address</description>
                              </valueHelp>
                              <constraint>
                                <validator name="ipv6-address"/>
                              </constraint>
                            </properties>
                          </leafNode>
                        </children>
                      </tagNode>
                    </children>
                  </node>
                  #include <include/dhcp/domain-search.xml.i>
                  <node name="lease-time">
                    <properties>
                      <help>Parameters relating to the lease time</help>
                    </properties>
                    <children>
                      <leafNode name="default">
                        <properties>
                          <help>Default time (in seconds) that will be assigned to a lease</help>
                          <valueHelp>
                            <format>u32:1-4294967295</format>
                            <description>DHCPv6 valid lifetime</description>
                          </valueHelp>
                          <constraint>
                            <validator name="numeric" argument="--range 1-4294967295"/>
                          </constraint>
                        </properties>
                      </leafNode>
                      <leafNode name="maximum">
                        <properties>
                          <help>Maximum time (in seconds) that will be assigned to a lease</help>
                          <valueHelp>
                            <format>u32:1-4294967295</format>
                            <description>Maximum lease time in seconds</description>
                          </valueHelp>
                          <constraint>
                            <validator name="numeric" argument="--range 1-4294967295"/>
                          </constraint>
                        </properties>
                      </leafNode>
                      <leafNode name="minimum">
                        <properties>
                          <help>Minimum time (in seconds) that will be assigned to a lease</help>
                          <valueHelp>
                            <format>u32:1-4294967295</format>
                            <description>Minimum lease time in seconds</description>
                          </valueHelp>
                          <constraint>
                            <validator name="numeric" argument="--range 1-4294967295"/>
                          </constraint>
                        </properties>
                      </leafNode>
                    </children>
                  </node>
                  #include <include/name-server-ipv6.xml.i>
                  <leafNode name="nis-domain">
                    <properties>
                      <help>NIS domain name for client to use</help>
                      <constraint>
                        <regex>[-_a-zA-Z0-9.]+</regex>
                      </constraint>
                      <constraintErrorMessage>Invalid NIS domain name</constraintErrorMessage>
                    </properties>
                  </leafNode>
                  <leafNode name="nis-server">
                    <properties>
                      <help>IPv6 address of a NIS Server</help>
                      <valueHelp>
                        <format>ipv6</format>
                        <description>IPv6 address of NIS server</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv6-address"/>
                      </constraint>
                      <multi/>
                    </properties>
                  </leafNode>
                  <leafNode name="nisplus-domain">
                    <properties>
                      <help>NIS+ domain name for client to use</help>
                      <constraint>
                        <regex>[-_a-zA-Z0-9.]+</regex>
                      </constraint>
                      <constraintErrorMessage>Invalid NIS+ domain name. May only contain letters, numbers and .-_</constraintErrorMessage>
                    </properties>
                  </leafNode>
                  <leafNode name="nisplus-server">
                    <properties>
                      <help>IPv6 address of a NIS+ Server</help>
                      <valueHelp>
                        <format>ipv6</format>
                        <description>IPv6 address of NIS+ server</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv6-address"/>
                      </constraint>
                      <multi/>
                    </properties>
                  </leafNode>
                  <node name="prefix-delegation">
                    <properties>
                      <help>Parameters relating to IPv6 prefix delegation</help>
                    </properties>
                    <children>
                      <tagNode name="prefix">
                        <properties>
                          <help>IPv6 prefix to be used in prefix delegation</help>
                          <valueHelp>
                            <format>ipv6</format>
                            <description>IPv6 prefix used in prefix delegation</description>
                          </valueHelp>
                          <constraint>
                            <validator name="ipv6-address"/>
                          </constraint>
                        </properties>
                        <children>
                          <leafNode name="prefix-length">
                            <properties>
                              <help>Length in bits of prefix</help>
                              <valueHelp>
                                <format>u32:32-64</format>
                                <description>Prefix length (32-64)</description>
                              </valueHelp>
                              <constraint>
                                <validator name="numeric" argument="--range 32-64"/>
                              </constraint>
                              <constraintErrorMessage>Prefix length must be between 32 and 64</constraintErrorMessage>
                            </properties>
                          </leafNode>
                          <leafNode name="delegated-length">
                            <properties>
                              <help>Length in bits of prefixes to be delegated</help>
                              <valueHelp>
                                <format>u32:32-64</format>
                                <description>Delegated prefix length (32-64)</description>
                              </valueHelp>
                              <constraint>
                                <validator name="numeric" argument="--range 32-96"/>
                              </constraint>
                              <constraintErrorMessage>Delegated prefix length must be between 32 and 96</constraintErrorMessage>
                            </properties>
                          </leafNode>
                        </children>
                      </tagNode>
                    </children>
                  </node>
                  <leafNode name="sip-server">
                    <properties>
                      <help>IPv6 address of SIP server</help>
                      <valueHelp>
                        <format>ipv6</format>
                        <description>IPv6 address of SIP server</description>
                      </valueHelp>
                      <valueHelp>
                        <format>hostname</format>
                        <description>FQDN of SIP server</description>
                      </valueHelp>
                      <constraint>
                        <validator name="ipv6-address"/>
                        <validator name="fqdn"/>
                      </constraint>
                      <multi/>
                    </properties>
                  </leafNode>
                  <leafNode name="sntp-server">
                    <properties>
                      <help>IPv6 address of an SNTP server for client to use</help>
                      <constraint>
                        <validator name="ipv6-address"/>
                      </constraint>
                      <multi/>
                    </properties>
                  </leafNode>
                  <tagNode name="static-mapping">
                    <properties>
                      <help>Name of static mapping</help>
                      <constraint>
                        <regex>[-_a-zA-Z0-9.]+</regex>
                      </constraint>
                      <constraintErrorMessage>Invalid static mapping name. May only contain letters, numbers and .-_</constraintErrorMessage>
                    </properties>
                    <children>
                      #include <include/generic-disable-node.xml.i>
                      <leafNode name="identifier">
                        <properties>
                          <help>Client identifier (DUID) for this static mapping</help>
                          <valueHelp>
                            <format>h[[:h]...]</format>
                            <description>DUID: colon-separated hex list (as used by isc-dhcp option dhcpv6.client-id)</description>
                          </valueHelp>
                          <constraint>
                            <regex>([0-9A-Fa-f]{1,2}[:])*([0-9A-Fa-f]{1,2})</regex>
                          </constraint>
                          <constraintErrorMessage>Invalid DUID, must be in the format h[[:h]...]</constraintErrorMessage>
                        </properties>
                      </leafNode>
                      <leafNode name="ipv6-address">
                        <properties>
                          <help>Client IPv6 address for this static mapping</help>
                          <valueHelp>
                            <format>ipv6</format>
                            <description>IPv6 address for this static mapping</description>
                          </valueHelp>
                          <constraint>
                            <validator name="ipv6-address"/>
                          </constraint>
                        </properties>
                      </leafNode>
                      <leafNode name="ipv6-prefix">
                        <properties>
                          <help>Client IPv6 prefix for this static mapping</help>
                          <valueHelp>
                            <format>ipv6net</format>
                            <description>IPv6 prefix for this static mapping</description>
                          </valueHelp>
                          <constraint>
                            <validator name="ipv6-prefix"/>
                          </constraint>
                        </properties>
                      </leafNode>
                    </children>
                  </tagNode>
                  <node name="vendor-option">
                    <properties>
                      <help>Vendor Specific Options</help>
                    </properties>
                    <children>
                      <node name="cisco">
                        <properties>
                          <help>Cisco specific parameters</help>
                        </properties>
                        <children>
                          <leafNode name="tftp-server">
                            <properties>
                              <help>TFTP server name</help>
                              <valueHelp>
                                <format>ipv6</format>
                                <description>TFTP server IPv6 address</description>
                              </valueHelp>
                              <constraint>
                                <validator name="ipv6-address"/>
                              </constraint>
                              <multi/>
                            </properties>
                          </leafNode>
                        </children>
                      </node>
                    </children>
                  </node>
                </children>
              </tagNode>
            </children>
          </tagNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>