dhcp4.spec 14.2 KB
Newer Older
1
2
{
  "module_spec": {
3
    "module_name": "Dhcp4",
4
    "module_description": "DHCPv4 server daemon",
5
    "config_data": [
6
7
8
9
10
11
12
13
14
      {
        "item_name": "hooks-libraries",
        "item_type": "list",
        "item_optional": true,
        "item_default": [],
        "list_item_spec":
        {
          "item_name": "hooks-library",
          "item_type": "string",
15
16
          "item_optional": false,
          "item_default": ""
17
18
        }
      },
19

20
      { "item_name": "interfaces",
21
        "item_type": "list",
22
        "item_optional": false,
23
        "item_default": [ "*" ],
24
25
26
27
28
        "list_item_spec":
        {
          "item_name": "interface_name",
          "item_type": "string",
          "item_optional": false,
29
          "item_default": "*"
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
        }
      } ,

      { "item_name": "renew-timer",
        "item_type": "integer",
        "item_optional": false,
        "item_default": 1000
      },

      { "item_name": "rebind-timer",
        "item_type": "integer",
        "item_optional": false,
        "item_default": 2000
      },

      { "item_name": "valid-lifetime",
        "item_type": "integer",
        "item_optional": false,
        "item_default": 4000
      },

51
52
53
      { "item_name": "next-server",
        "item_type": "string",
        "item_optional": true,
Tomek Mrugalski's avatar
Tomek Mrugalski committed
54
        "item_default": ""
55
56
      },

57
58
59
60
61
62
      { "item_name": "echo-client-id",
        "item_type": "boolean",
        "item_optional": true,
        "item_default": true
      },

63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
      { "item_name": "option-def",
        "item_type": "list",
        "item_optional": false,
        "item_default": [],
        "list_item_spec":
        {
          "item_name": "single-option-def",
          "item_type": "map",
          "item_optional": false,
          "item_default": {},
          "map_item_spec": [
          {
            "item_name": "name",
            "item_type": "string",
            "item_optional": false,
            "item_default": ""
          },

          { "item_name": "code",
            "item_type": "integer",
            "item_optional": false,
84
            "item_default": 0
85
86
87
88
89
          },

          { "item_name": "type",
            "item_type": "string",
            "item_optional": false,
90
            "item_default": ""
91
92
93
94
95
96
97
98
          },

          { "item_name": "array",
            "item_type": "boolean",
            "item_optional": false,
            "item_default": False
          },

99
          { "item_name": "record-types",
100
            "item_type": "string",
101
            "item_optional": false,
102
            "item_default": ""
103
104
105
106
107
108
          },

          { "item_name": "space",
            "item_type": "string",
            "item_optional": false,
            "item_default": ""
109
110
111
112
113
114
          },

          { "item_name": "encapsulate",
            "item_type": "string",
            "item_optional": false,
            "item_default": ""
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
      { "item_name": "option-data",
        "item_type": "list",
        "item_optional": false,
        "item_default": [],
        "list_item_spec":
        {
          "item_name": "single-option-data",
          "item_type": "map",
          "item_optional": false,
          "item_default": {},
          "map_item_spec": [
          {
            "item_name": "name",
            "item_type": "string",
            "item_optional": false,
            "item_default": ""
          },

          { "item_name": "code",
            "item_type": "integer",
            "item_optional": false,
            "item_default": 0
          },
          { "item_name": "data",
            "item_type": "string",
            "item_optional": false,
            "item_default": ""
146
147
148
149
150
          },
          { "item_name": "csv-format",
            "item_type": "boolean",
            "item_optional": false,
            "item_default": False
151
152
153
154
155
          },
          { "item_name": "space",
            "item_type": "string",
            "item_optional": false,
            "item_default": "dhcp4"
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
      { "item_name": "lease-database",
        "item_type": "map",
        "item_optional": false,
        "item_default": {"type": "memfile"},
        "map_item_spec": [
            {
                "item_name": "type",
                "item_type": "string",
                "item_optional": false,
                "item_default": ""
            },
            {
                "item_name": "name",
                "item_type": "string",
                "item_optional": true,
                "item_default": ""
            },
            {
                "item_name": "user",
                "item_type": "string",
                "item_optional": true,
                "item_default": ""
            },
            {
                "item_name": "host",
                "item_type": "string",
                "item_optional": true,
                "item_default": ""
            },
            {
                "item_name": "password",
                "item_type": "string",
                "item_optional": true,
                "item_default": ""
194
195
196
197
198
199
            },
            {
                "item_name": "persist",
                "item_type": "boolean",
                "item_optional": true,
                "item_default": true
200
201
202
203
            }
        ]
      },

204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
      { "item_name": "subnet4",
        "item_type": "list",
        "item_optional": false,
        "item_default": [],
        "list_item_spec":
        {
            "item_name": "single-subnet4",
            "item_type": "map",
            "item_optional": false,
            "item_default": {},
            "map_item_spec": [

                { "item_name": "subnet",
                  "item_type": "string",
                  "item_optional": false,
                  "item_default": ""
                },

222
223
224
225
226
227
                { "item_name": "id",
                  "item_type": "integer",
                  "item_optional": false,
                  "item_default": 0
                },

228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
                { "item_name": "renew-timer",
                  "item_type": "integer",
                  "item_optional": false,
                  "item_default": 1000
                },

                { "item_name": "rebind-timer",
                  "item_type": "integer",
                  "item_optional": false,
                  "item_default": 2000
                },

                { "item_name": "valid-lifetime",
                  "item_type": "integer",
                  "item_optional": false,
                  "item_default": 7200
                },
245
246

                { "item_name": "next-server",
Tomek Mrugalski's avatar
Tomek Mrugalski committed
247
248
249
                  "item_type": "string",
                  "item_optional": true,
                  "item_default": "0.0.0.0"
250
251
                },

252
253
254
255
256
257
258
259
260
261
262
                { "item_name": "pool",
                  "item_type": "list",
                  "item_optional": false,
                  "item_default": [],
                    "list_item_spec":
                    {
                        "item_name": "type",
                        "item_type": "string",
                        "item_optional": false,
                        "item_default": ""
                    }
263
264
                },

265
266
267
268
269
270
271
                { "item_name": "client-class",
                  "item_type": "string",
                  "item_optional": false,
                  "item_default": "",
                  "item_description" : "Restricts access to this subnet to specified client class (if defined)"
                },

272
273
274
275
                { "item_name": "relay",
                  "item_type": "map",
                  "item_optional": false,
                  "item_default": {},
Tomek Mrugalski's avatar
Tomek Mrugalski committed
276
                  "item_description" : "Structure holding relay information.",
277
278
279
280
281
                  "map_item_spec": [
                      {
                          "item_name": "ip-address",
                          "item_type": "string",
                          "item_optional": false,
282
                          "item_default": "0.0.0.0",
Tomek Mrugalski's avatar
Tomek Mrugalski committed
283
                          "item_description" : "IPv4 address of the relay (defaults to 0.0.0.0 if not specified)."
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
                { "item_name": "option-data",
                  "item_type": "list",
                  "item_optional": false,
                  "item_default": [],
                  "list_item_spec":
                  {
                    "item_name": "single-option-data",
                    "item_type": "map",
                    "item_optional": false,
                    "item_default": {},
                    "map_item_spec": [
                    {
                      "item_name": "name",
                      "item_type": "string",
                      "item_optional": false,
                      "item_default": ""
                    },
                    {
                      "item_name": "code",
                      "item_type": "integer",
                      "item_optional": false,
                      "item_default": 0
                    },
                    {
                      "item_name": "data",
                      "item_type": "string",
                      "item_optional": false,
                      "item_default": ""
315
316
                    },
                    { "item_name": "csv-format",
317
                      "item_type": "boolean",
318
319
                      "item_optional": false,
                      "item_default": False
320
321
322
323
324
                      },
                    { "item_name": "space",
                      "item_type": "string",
                      "item_optional": false,
                      "item_default": "dhcp4"
325
326
327
328
                    } ]
                  }
                } ]
         }
329
330
331
332
333
334
      },

      { "item_name": "dhcp-ddns",
        "item_type": "map",
        "item_optional": false,
        "item_default": {"enable-updates": false},
335
        "item_description" : "Contains parameters pertaining DHCP-driven DDNS updates",
336
337
338
339
340
        "map_item_spec": [
            {
                "item_name": "enable-updates",
                "item_type": "boolean",
                "item_optional": false,
341
                "item_default": false,
342
343
344
                "item_description" : "Enables DDNS update processing"
            },
            {
345
                "item_name": "server-ip",
346
347
348
                "item_type": "string",
                "item_optional": true,
                "item_default": "127.0.0.1",
349
                "item_description" : "IP address of b10-dhcp-ddns (IPv4 or IPv6)"
350
351
            },
            {
352
                "item_name": "server-port",
353
354
                "item_type": "integer",
                "item_optional": true,
355
                "item_default": 53001,
356
357
                "item_description" : "port number of b10-dhcp-ddns"
            },
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
            {
                "item_name": "sender-ip",
                "item_type": "string",
                "item_optional": true,
                "item_default": "",
                "item_description" : "IP address from which to send to b10-dhcp-ddns (IPv4 or IPv6)"
            },
            {
                "item_name": "sender-port",
                "item_type": "integer",
                "item_optional": true,
                "item_default": 0,
                "item_description" : "port number from which to send to b10-dhcp-ddns"
            },
            {
                "item_name": "max-queue-size",
                "item_type": "integer",
                "item_optional": true,
                "item_default": 1024,
                "item_description" : "maximum number of requests allowed in the send queue"
            },
379
            {
380
                "item_name": "ncr-protocol",
381
382
383
384
385
386
                "item_type": "string",
                "item_optional": true,
                "item_default": "UDP",
                "item_description" : "Socket protocol to use with b10-dhcp-ddns"
            },
            {
387
                "item_name": "ncr-format",
388
389
390
391
392
393
394
395
396
397
                "item_type": "string",
                "item_optional": true,
                "item_default": "JSON",
                "item_description" : "Format of the update request packet"
            },
            {

                "item_name": "always-include-fqdn",
                "item_type": "boolean",
                "item_optional": true,
398
399
                "item_default": false,
                "item_description": "Enable always including the FQDN option in its response"
400
401
402
403
404
405
406
407
408
409
410
411
            },
            {
                "item_name": "override-no-update",
                "item_type": "boolean",
                "item_optional": true,
                "item_default": false,
                "item_description": "Do update, even if client requested no updates with N flag"
            },
            {
                "item_name": "override-client-update",
                "item_type": "boolean",
                "item_optional": true,
412
                "item_default": false,
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
                "item_description": "Server performs an update even if client requested delegation"
            },
            {
                "item_name": "replace-client-name",
                "item_type": "boolean",
                "item_optional": true,
                "item_default": false,
                "item_description": "Should server replace the domain-name supplied by the client"
            },
            {
                "item_name": "generated-prefix",
                "item_type": "string",
                "item_optional": true,
                "item_default": "myhost",
                "item_description": "Prefix to use when generating the client's name"
            },

            {
                "item_name": "qualifying-suffix",
                "item_type": "string",
                "item_optional": true,
                "item_default": "example.com",
                "item_description": "Fully qualified domain-name suffix if partial name provided by client"
            },
        ]
      },

440
    ],
441
442
443
    "commands": [
        {
            "command_name": "shutdown",
444
445
446
447
448
449
450
451
            "command_description": "Shuts down DHCPv4 server.",
            "command_args": [
                {
                    "item_name": "pid",
                    "item_type": "integer",
                    "item_optional": true
                }
            ]
452
453
454
455
        },

        {
            "command_name": "libreload",
456
            "command_description": "Reloads the current hooks libraries.",
457
            "command_args": []
458
        }
459

460
    ]
461
462
  }
}