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
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
|
.. _dhcp6:
*****************
The DHCPv6 Server
*****************
.. _dhcp6-start-stop:
Starting and Stopping the DHCPv6 Server
=======================================
It is recommended that the Kea DHCPv6 server be started and stopped
using :iscman:`keactrl` (described in :ref:`keactrl`); however, it is also
possible to run the server directly via the :iscman:`kea-dhcp6` command, which accepts
the following command-line switches:
- ``-c file`` - specifies the configuration file. This is the only
mandatory switch.
- ``-d`` - specifies whether the server logging should be switched to
debug/verbose mode. In verbose mode, the logging severity and debuglevel
specified in the configuration file are ignored; "debug" severity
and the maximum debuglevel (99) are assumed. The flag is convenient
for temporarily switching the server into maximum verbosity, e.g.
when debugging.
- ``-p server-port`` - specifies the local UDP port on which the server
listens. This is only useful during testing, as a DHCPv6 server
listening on ports other than the standard ones is not able to
handle regular DHCPv6 queries.
- ``-P client-port`` - specifies the remote UDP port to which the
server sends all responses. This is only useful during testing,
as a DHCPv6 server sending responses to ports other than the standard
ones is not able to handle regular DHCPv6 queries.
- ``-t file`` - specifies a configuration file to be tested. :iscman:`kea-dhcp6`
loads it, checks it, and exits. During the test, log messages are
printed to standard output and error messages to standard error. The
result of the test is reported through the exit code (0 =
configuration looks OK, 1 = error encountered). The check is not
comprehensive; certain checks are possible only when running the
server.
- ``-T file`` - specifies a configuration file to be tested. :iscman:`kea-dhcp6`
loads it, checks it, and exits. It performs extra checks beyond what ``-t``
offers, such as establishing database connections (for the lease backend,
host reservations backend, configuration backend, and forensic logging
backend), loading hook libraries, parsing hook-library configurations, etc.
It does not open UNIX or TCP/UDP sockets, nor does it open or rotate
files, as any of these actions could interfere with a running process on the
same machine.
- ``-v`` - displays the Kea version and exits.
- ``-V`` - displays the Kea extended version with additional parameters
and exits. The listing includes the versions of the libraries
dynamically linked to Kea.
- ``-W`` - displays the Kea configuration report and exits. The report
is a copy of the ``config.report`` file produced by ``./configure``;
it is embedded in the executable binary.
The contents of the ``config.report`` file may also be accessed by examining
certain libraries in the installation tree or in the source tree.
.. code-block:: shell
# from installation using libkea-process.so
$ strings ${prefix}/lib/libkea-process.so | sed -n 's/;;;; //p'
# from sources using libkea-process.so
$ strings src/lib/process/.libs/libkea-process.so | sed -n 's/;;;; //p'
# from sources using libkea-process.a
$ strings src/lib/process/.libs/libkea-process.a | sed -n 's/;;;; //p'
# from sources using libcfgrpt.a
$ strings src/lib/process/cfgrpt/.libs/libcfgrpt.a | sed -n 's/;;;; //p'
On startup, the server detects available network interfaces and
attempts to open UDP sockets on all interfaces listed in the
configuration file. Since the DHCPv6 server opens privileged ports, it
requires root access; this daemon must be run as root.
During startup, the server attempts to create a PID file of the
form: ``[runstatedir]/kea/[conf name].kea-dhcp6.pid``, where:
- ``runstatedir``: The value as passed into the build configure
script; it defaults to ``/usr/local/var/run``. Note that this value may be
overridden at runtime by setting the environment variable
``KEA_PIDFILE_DIR``, although this is intended primarily for testing
purposes.
- ``conf name``: The configuration file name used to start the server,
minus all preceding paths and the file extension. For example, given
a pathname of ``/usr/local/etc/kea/myconf.txt``, the portion used would
be ``myconf``.
If the file already exists and contains the PID of a live process, the
server issues a ``DHCP6_ALREADY_RUNNING`` log message and exits. It is
possible, though unlikely, that the file is a remnant of a system crash
and the process to which the PID belongs is unrelated to Kea. In such a
case, it would be necessary to manually delete the PID file.
The server can be stopped using the ``kill`` command. When running in a
console, the server can also be shut down by pressing Ctrl-c. Kea detects
the key combination and shuts down gracefully.
The reconfiguration of each Kea server is triggered by the SIGHUP signal.
When a server receives the SIGHUP signal it rereads its configuration file and,
if the new configuration is valid, uses the new configuration.
If the new configuration proves to be invalid, the server retains its
current configuration; however, in some cases a fatal error message is logged
indicating that the server is no longer providing any service: a working
configuration must be loaded as soon as possible.
.. _dhcp6-configuration:
DHCPv6 Server Configuration
===========================
Introduction
------------
This section explains how to configure the Kea DHCPv6 server using a
configuration file.
Before DHCPv6 is started, its configuration file must
be created. The basic configuration is as follows:
::
{
# DHCPv6 configuration starts on the next line
"Dhcp6": {
# First we set up global values
"valid-lifetime": 4000,
"renew-timer": 1000,
"rebind-timer": 2000,
"preferred-lifetime": 3000,
# Next we set up the interfaces to be used by the server.
"interfaces-config": {
"interfaces": [ "eth0" ]
},
# And we specify the type of lease database
"lease-database": {
"type": "memfile",
"persist": true,
"name": "/var/lib/kea/dhcp6.leases"
},
# Finally, we list the subnets from which we will be leasing addresses.
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/64",
"pools": [
{
"pool": "2001:db8:1::1-2001:db8:1::ffff"
}
]
}
]
# DHCPv6 configuration ends with the next line
}
}
The following paragraphs provide a brief overview of the parameters in
the above example, along with their format. Subsequent sections of this
chapter go into much greater detail for these and other parameters.
The lines starting with a hash (#) are comments and are ignored by the
server; they do not impact its operation in any way.
The configuration starts in the first line with the initial opening
curly bracket (or brace). Each configuration must contain an object
specifying the configuration of the Kea module using it. In the example
above, this object is called ``Dhcp6``.
The ``Dhcp6`` configuration starts with the ``"Dhcp6": {`` line and ends
with the corresponding closing brace (in the above example, the brace
after the last comment). Everything defined between those lines is
considered to be the ``Dhcp6`` configuration.
In general, the order in which those parameters appear does not
matter, but there are two caveats. The first one is that the
configuration file must be well-formed JSON, meaning that the
parameters for any given scope must be separated by a comma, and there
must not be a comma after the last parameter. When reordering a
configuration file, moving a parameter to or from the
last position in a given scope may also require moving the comma. The
second caveat is that it is uncommon — although legal JSON — to repeat
the same parameter multiple times. If that happens, the last occurrence
of a given parameter in a given scope is used, while all previous
instances are ignored. This is unlikely to cause any confusion as there
are no real-life reasons to keep multiple copies of the same parameter
in the configuration file.
The first few DHCPv6 configuration elements
define some global parameters. ``valid-lifetime`` defines how long the
addresses (leases) given out by the server are valid; the default
is for a client to be allowed to use a given address for 4000
seconds. (Note that integer numbers are specified as is, without any
quotes around them.) The address will become deprecated in 3000 seconds,
i.e. clients are allowed to keep old connections, but cannot use this
address to create new connections. ``renew-timer`` and
``rebind-timer`` are values (also in seconds) that define T1 and T2 timers, which govern
when the client begins the renewal and rebind procedures.
The ``interfaces-config`` map specifies the network interfaces on which the
server should listen to DHCP messages. The ``interfaces`` parameter specifies
a list of network interfaces on which the server should listen. Lists are
opened and closed with square brackets, with elements separated by commas. To
listen on two interfaces, the ``interfaces-config`` element should look like
this:
::
{
"interfaces-config": {
"interfaces": [ "eth0", "eth1" ]
},
...
}
The next lines define the lease database, the place where the
server stores its lease information. This particular example tells the
server to use memfile, which is the simplest and fastest database
backend. It uses an in-memory database and stores leases on disk in a
CSV (comma-separated values) file. This is a very simple configuration example;
usually the lease database configuration is more extensive and contains
additional parameters. Note that ``lease-database`` is an object and opens up a
new scope, using an opening brace. Its parameters (just one in this example:
``type``) follow. If there were more than one, they would be separated
by commas. This scope is closed with a closing brace. As more parameters
for the ``Dhcp6`` definition follow, a trailing comma is present.
Finally, we need to define a list of IPv6 subnets. This is the most
important DHCPv6 configuration structure, as the server uses that
information to process clients' requests. It defines all subnets from
which the server is expected to receive DHCP requests. The subnets are
specified with the ``subnet6`` parameter. It is a list, so it starts and
ends with square brackets. Each subnet definition in the list has
several attributes associated with it, so it is a structure and is
opened and closed with braces. At a minimum, a subnet definition must
have at least two parameters: ``subnet``, which defines the whole
subnet; and ``pools``, which is a list of dynamically allocated pools
that are governed by the DHCP server.
The example contains a single subnet. If more than one were defined,
additional elements in the ``subnet6`` parameter would be specified and
separated by commas. For example, to define two subnets, the following
syntax would be used:
::
{
"subnet6": [
{
"id": 1,
"pools": [ { "pool": "2001:db8:1::/112" } ],
"subnet": "2001:db8:1::/64"
},
{
"id": 2,
"pools": [ { "pool": "2001:db8:2::1-2001:db8:2::ffff" } ],
"subnet": "2001:db8:2::/64"
}
],
...
}
Note that indentation is optional and is used for aesthetic purposes
only. In some cases it may be preferable to use more compact notation.
After all the parameters have been specified, there are two contexts open:
``global`` and ``Dhcp6``; thus, two closing curly brackets must be used to close
them.
Lease Storage
-------------
All leases issued by the server are stored in the lease database.
There are three database backends available: memfile
(the default), MySQL, PostgreSQL.
Memfile - Basic Storage for Leases
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The server is able to store lease data in different repositories. Larger
deployments may elect to store leases in a database;
:ref:`database-configuration6` describes this option. In
typical smaller deployments, though, the server stores lease
information in a CSV file rather than a database. As well as requiring
less administration, an advantage of using a file for storage is that it
eliminates a dependency on third-party database software.
The configuration of the memfile backend is controlled through
the ``Dhcp6``/``lease-database`` parameters. The ``type`` parameter is mandatory
and specifies which storage for leases the server should use, through
the ``"memfile"`` value. The following list gives additional optional parameters
that can be used to configure the memfile backend.
- ``persist``: controls whether the new leases and updates to existing
leases are written to the file. It is strongly recommended that the
value of this parameter be set to ``true`` at all times during the
server's normal operation. Not writing leases to disk means that if a
server is restarted (e.g. after a power failure), it will not know
which addresses have been assigned. As a result, it may assign new clients
addresses that are already in use. The value of
``false`` is mostly useful for performance-testing purposes. The
default value of the ``persist`` parameter is ``true``, which enables
writing lease updates to the lease file.
- ``name``: specifies an absolute location of the lease file in which
new leases and lease updates are recorded. The default value for
this parameter is ``"[kea-install-dir]/var/lib/kea/kea-leases6.csv"``.
- ``lfc-interval``: specifies the interval, in seconds, at which the
server will perform a lease file cleanup (LFC). This removes
redundant (historical) information from the lease file and
effectively reduces the lease file size. The cleanup process is
described in more detail later in this section. The default
value of the ``lfc-interval`` is ``3600``. A value of ``0`` disables the LFC.
- ``max-row-errors``: specifies the number of row errors before the server
stops attempting to load a lease file. When the server loads a lease file, it is processed
row by row, each row containing a single lease. If a row is flawed and
cannot be processed correctly the server logs it, discards the row,
and goes on to the next row. This parameter can be used to set a limit on
the number of such discards that can occur, after which the server
abandons the effort and exits. The default value of ``0`` disables the limit
and allows the server to process the entire file, regardless of how many
rows are discarded.
An example configuration of the memfile backend is presented below:
::
"Dhcp6": {
"lease-database": {
"type": "memfile",
"persist": true,
"name": "/tmp/kea-leases6.csv",
"lfc-interval": 1800,
"max-row-errors": 100
}
}
This configuration selects ``/tmp/kea-leases6.csv`` as the storage file
for lease information and enables persistence (writing lease updates to
this file). It also configures the backend to perform a periodic cleanup
of the lease file every 1800 seconds (30 minutes) and sets the maximum number of
row errors to 100.
Why Is Lease File Cleanup Necessary?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
It is important to know how the lease file contents are organized to
understand why the periodic lease file cleanup is needed. Every time the
server updates a lease or creates a new lease for a client, the new
lease information must be recorded in the lease file. For performance
reasons, the server does not update the existing client's lease in the
file, as this would potentially require rewriting the entire file.
Instead, it simply appends the new lease information to the end of the
file; the previous lease entries for the client are not removed. When
the server loads leases from the lease file, e.g. at server startup,
it assumes that the latest lease entry for the client is the valid one.
Previous entries are discarded, meaning that the server can
reconstruct accurate information about the leases even though there
may be many lease entries for each client. However, storing many entries
for each client results in a bloated lease file and impairs the
performance of the server's startup and reconfiguration, as it needs to
process a larger number of lease entries.
Lease file cleanup (LFC) removes all previous entries for each client
and leaves only the latest ones. The interval at which the cleanup is
performed is configurable, and it should be selected according to the
frequency of lease renewals initiated by the clients. The more frequent
the renewals, the smaller the value of ``lfc-interval`` should be. Note,
however, that the LFC takes time and thus it is possible (although
unlikely) that, if the ``lfc-interval`` is too short, a new cleanup may
be started while the previous one is still running. The server would
recover from this by skipping the new cleanup when it detected that the
previous cleanup was still in progress, but it implies that the actual
cleanups will be triggered more rarely than the configured interval. Moreover,
triggering a new cleanup adds overhead to the server, which is not
able to respond to new requests for a short period of time when the new
cleanup process is spawned. Therefore, it is recommended that the
``lfc-interval`` value be selected in a way that allows the LFC
to complete the cleanup before a new cleanup is triggered.
Lease file cleanup is performed by a separate process (in the
background) to avoid a performance impact on the server process. To
avoid conflicts between two processes using the same lease
files, the LFC process starts with Kea opening a new lease file; the
actual LFC process operates on the lease file that is no longer used by
the server. There are also other files created as a side effect of the
lease file cleanup. The detailed description of the LFC process is located later
in this Kea Administrator's Reference Manual: :ref:`kea-lfc`.
.. _database-configuration6:
Lease Database Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. note::
Lease database access information must be configured for the DHCPv6
server, even if it has already been configured for the DHCPv4 server.
The servers store their information independently, so each server can
use a separate database or both servers can use the same database.
.. note::
Kea requires the database timezone to match the system timezone.
For more details, see :ref:`mysql-database-create` and
:ref:`pgsql-database-create`.
Lease database configuration is controlled through the
``Dhcp6``/``lease-database`` parameters. The database type must be set to
``memfile``, ``mysql`` or ``postgresql``, e.g.:
::
"Dhcp6": { "lease-database": { "type": "mysql", ... }, ... }
Next, the name of the database to hold the leases must be set; this is
the name used when the database was created (see
:ref:`mysql-database-create` or :ref:`pgsql-database-create`).
For MySQL or PostgreSQL:
::
"Dhcp6": { "lease-database": { "name": "database-name" , ... }, ... }
If the database is located on a different system from the DHCPv6 server,
the database host name must also be specified:
::
"Dhcp6": { "lease-database": { "host": "remote-host-name", ... }, ... }
Normally, the database is on the same machine as the DHCPv6 server.
In this case, set the value to the empty string:
::
"Dhcp6": { "lease-database": { "host" : "", ... }, ... }
Should the database use a port other than the default, it may be
specified as well:
::
"Dhcp6": { "lease-database": { "port" : 12345, ... }, ... }
Should the database be located on a different system, the administrator may need to
specify a longer interval for the connection timeout:
::
"Dhcp6": { "lease-database": { "connect-timeout" : timeout-in-seconds, ... }, ... }
The default value of five seconds should be more than adequate for local
connections. If a timeout is given, though, it should be an integer
greater than zero.
The maximum number of times the server automatically attempts to
reconnect to the lease database after connectivity has been lost may be
specified:
::
"Dhcp6": { "lease-database": { "max-reconnect-tries" : number-of-tries, ... }, ... }
If the server is unable to reconnect to the database after making the
maximum number of attempts, the server will exit. A value of 0 (the
default) disables automatic recovery and the server will exit
immediately upon detecting a loss of connectivity (MySQL and PostgreSQL
only).
The number of milliseconds the server waits between attempts to
reconnect to the lease database after connectivity has been lost may
also be specified:
::
"Dhcp6": { "lease-database": { "reconnect-wait-time" : number-of-milliseconds, ... }, ... }
The default value for MySQL and PostgreSQL is 0, which disables automatic
recovery and causes the server to exit immediately upon detecting the
loss of connectivity.
::
"Dhcp6": { "lease-database": { "on-fail" : "stop-retry-exit", ... }, ... }
The possible values are:
- ``stop-retry-exit`` - disables the DHCP service while trying to automatically
recover lost connections. Shuts down the server on failure after exhausting
``max-reconnect-tries``. This is the default value for MySQL and PostgreSQL.
- ``serve-retry-exit`` - continues the DHCP service while trying to automatically
recover lost connections. Shuts down the server on failure after exhausting
``max-reconnect-tries``.
- ``serve-retry-continue`` - continues the DHCP service and does not shut down the
server even if the recovery fails.
.. note::
Automatic reconnection to database backends is configured individually per
backend; this allows users to tailor the recovery parameters to each backend
they use. We suggest that users enable it either for all backends or none,
so behavior is consistent.
Losing connectivity to a backend for which reconnection is disabled results
(if configured) in the server shutting itself down. This includes cases when
the lease database backend and the hosts database backend are connected to
the same database instance.
It is highly recommended not to change the ``stop-retry-exit`` default
setting for the lease manager, as it is critical for the connection to be
active while processing DHCP traffic. Change this only if the server is used
exclusively as a configuration tool.
The host parameter is used by the MySQL and PostgreSQL backends.
Finally, the credentials of the account under which the server will
access the database should be set:
::
"Dhcp6": {
"lease-database": {
"user": "user-name",
"password": "password",
...
},
...
}
If there is no password to the account, set the password to the empty
string ``""``. (This is the default.)
.. _tuning-database-timeouts6:
Tuning Database Timeouts
~~~~~~~~~~~~~~~~~~~~~~~~
In rare cases, reading or writing to the database may hang. This can be
caused by a temporary network issue, or by misconfiguration of the proxy
server switching the connection between different database instances.
These situations are rare, but users have reported
that Kea sometimes hangs while performing database IO operations.
Setting appropriate timeout values can mitigate such issues.
MySQL exposes two distinct connection options to configure the read and
write timeouts. Kea's corresponding ``read-timeout`` and ``write-timeout``
configuration parameters specify the timeouts in seconds. For example:
::
"Dhcp6": { "lease-database": { "read-timeout" : 10, "write-timeout": 20, ... }, ... }
Setting these parameters to 0 is equivalent to not specifying them, and
causes the Kea server to establish a connection to the database with the
MySQL defaults. In this case, Kea waits indefinitely for the completion of
the read and write operations.
MySQL versions earlier than 5.6 do not support setting timeouts for
read and write operations. Moreover, the ``read-timeout`` and ``write-timeout``
parameters can only be specified for the MySQL backend; setting them for
any other backend database type causes a configuration error.
To set a timeout in seconds for PostgreSQL, use the ``tcp-user-timeout``
parameter. For example:
::
"Dhcp6": { "lease-database": { "tcp-user-timeout" : 10, ... }, ... }
Specifying this parameter for other backend types causes a configuration
error.
.. note::
The timeouts described here are only effective for TCP connections.
Please note that the MySQL client library used by the Kea servers
typically connects to the database via a UNIX domain socket when the
``host`` parameter is ``localhost``, but establishes a TCP connection
for ``127.0.0.1``.
.. _hosts6-storage:
Hosts Storage
-------------
Kea is also able to store information about host reservations in the
database. The hosts database configuration uses the same syntax as the
lease database. In fact, the Kea server opens independent connections for
each purpose, be it lease or hosts information, which gives
the most flexibility. Kea can keep leases and host reservations
separately, but can also point to the same database. Currently the
supported hosts database types are MySQL and PostgreSQL.
The following configuration can be used to configure a
connection to MySQL:
::
"Dhcp6": {
"hosts-database": {
"type": "mysql",
"name": "kea",
"user": "kea",
"password": "secret123",
"host": "localhost",
"port": 3306
}
}
Depending on the database configuration, many of the
parameters may be optional.
Please note that usage of hosts storage is optional. A user can define
all host reservations in the configuration file, and that is the
recommended way if the number of reservations is small. However, when
the number of reservations grows, it is more convenient to use host
storage. Please note that both storage methods (the configuration file and
one of the supported databases) can be used together. If hosts are
defined in both places, the definitions from the configuration file are
checked first and external storage is checked later, if necessary.
Host information can be placed in multiple stores. Operations
are performed on the stores in the order they are defined in the
configuration file, although this leads to a restriction in ordering
in the case of a host reservation addition; read-only stores must be
configured after a (required) read-write store, or the addition will
fail.
.. note::
Kea requires the database timezone to match the system timezone.
For more details, see :ref:`mysql-database-create` and
:ref:`pgsql-database-create`.
.. _hosts-databases-configuration6:
DHCPv6 Hosts Database Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Hosts database configuration is controlled through the
``Dhcp6``/``hosts-database`` parameters. If enabled, the type of database must
be set to ``mysql`` or ``postgresql``.
::
"Dhcp6": { "hosts-database": { "type": "mysql", ... }, ... }
Next, the name of the database to hold the reservations must be set;
this is the name used when the lease database was created (see
:ref:`supported-databases` for instructions on how to set up the
desired database type):
::
"Dhcp6": { "hosts-database": { "name": "database-name" , ... }, ... }
If the database is located on a different system than the DHCPv6 server,
the database host name must also be specified:
::
"Dhcp6": { "hosts-database": { "host": remote-host-name, ... }, ... }
Normally, the database is on the same machine as the DHCPv6 server.
In this case, set the value to the empty string:
::
"Dhcp6": { "hosts-database": { "host" : "", ... }, ... }
Should the database use a port different than the default, it may be
specified as well:
::
"Dhcp6": { "hosts-database": { "port" : 12345, ... }, ... }
The maximum number of times the server automatically attempts to
reconnect to the host database after connectivity has been lost may be
specified:
::
"Dhcp6": { "hosts-database": { "max-reconnect-tries" : number-of-tries, ... }, ... }
If the server is unable to reconnect to the database after making the
maximum number of attempts, the server will exit. A value of 0 (the
default) disables automatic recovery and the server will exit
immediately upon detecting a loss of connectivity (MySQL and PostgreSQL
only).
The number of milliseconds the server waits between attempts to
reconnect to the host database after connectivity has been lost may also
be specified:
::
"Dhcp6": { "hosts-database": { "reconnect-wait-time" : number-of-milliseconds, ... }, ... }
The default value for MySQL and PostgreSQL is 0, which disables automatic
recovery and causes the server to exit immediately upon detecting the
loss of connectivity.
::
"Dhcp6": { "hosts-database": { "on-fail" : "stop-retry-exit", ... }, ... }
The possible values are:
- ``stop-retry-exit`` - disables the DHCP service while trying to automatically
recover lost connections. Shuts down the server on failure after exhausting
``max-reconnect-tries``. This is the default value for MySQL and PostgreSQL.
- ``serve-retry-exit`` - continues the DHCP service while trying to automatically
recover lost connections. Shuts down the server on failure after exhausting
``max-reconnect-tries``.
- ``serve-retry-continue`` - continues the DHCP service and does not shut down the
server even if the recovery fails.
.. note::
Automatic reconnection to database backends is configured individually per
backend. This allows users to tailor the recovery parameters to each backend
they use. We suggest that users enable it either for all backends or none,
so behavior is consistent.
Losing connectivity to a backend for which reconnection is disabled results
(if configured) in the server shutting itself down. This includes cases when
the lease database backend and the hosts database backend are connected to
the same database instance.
Finally, the credentials of the account under which the server will
access the database should be set:
::
"Dhcp6": {
"hosts-database": {
"user": "user-name",
"password": "password",
...
},
...
}
If there is no password to the account, set the password to the empty
string ``""``. (This is the default.)
The multiple-storage extension uses a similar syntax; a configuration is
placed into a ``hosts-databases`` list instead of into a ``hosts-database``
entry, as in:
::
"Dhcp6": { "hosts-databases": [ { "type": "mysql", ... }, ... ], ... }
If the same host is configured both in-file and in-database, Kea does not issue a warning,
as it would if both were specified in the same data source.
Instead, the host configured in-file has priority over the one configured
in-database.
.. _read-only-database-configuration6:
Using Read-Only Databases for Host Reservations with DHCPv6
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
In some deployments, the user whose name is specified in the
database backend configuration may not have write privileges to the
database. This is often required by the policy within a given network to
secure the data from being unintentionally modified. In many cases
administrators have deployed inventory databases, which contain
substantially more information about the hosts than just the static
reservations assigned to them. The inventory database can be used to
create a view of a Kea hosts database and such a view is often
read-only.
Kea host-database backends operate with an implicit configuration to
both read from and write to the database. If the user does not
have write access to the host database, the backend will fail to start
and the server will refuse to start (or reconfigure). However, if access
to a read-only host database is required for retrieving reservations
for clients and/or assigning specific addresses and options, it is
possible to explicitly configure Kea to start in "read-only" mode. This
is controlled by the ``readonly`` boolean parameter as follows:
::
"Dhcp6": { "hosts-database": { "readonly": true, ... }, ... }
Setting this parameter to ``false`` configures the database backend to
operate in "read-write" mode, which is also the default configuration if
the parameter is not specified.
.. note::
The ``readonly`` parameter is only supported for MySQL and
PostgreSQL databases.
Tuning Database Timeouts for Hosts Storage
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
See :ref:`tuning-database-timeouts6`.
.. _dhcp6-interface-configuration:
Interface Configuration
-----------------------
The DHCPv6 server must be configured to listen on specific network
interfaces. The simplest network interface configuration tells the
server to listen on all available interfaces:
::
"Dhcp6": {
"interfaces-config": {
"interfaces": [ "*" ]
},
...
}
The asterisk plays the role of a wildcard and means "listen on all
interfaces." However, it is usually a good idea to explicitly specify
interface names:
::
"Dhcp6": {
"interfaces-config": {
"interfaces": [ "eth1", "eth3" ]
},
...
}
It is possible to use an interface wildcard (*) concurrently
with explicit interface names:
::
"Dhcp6": {
"interfaces-config": {
"interfaces": [ "eth1", "eth3", "*" ]
},
...
}
This format should only be used when it is
desired to temporarily override a list of interface names and listen on
all interfaces.
As with the DHCPv4 server, binding to specific addresses and disabling
re-detection of interfaces are supported. But ``dhcp-socket-type`` is
not supported, because DHCPv6 uses only UDP/IPv6 sockets. The following example
shows how to disable interface detection:
::
"Dhcp6": {
"interfaces-config": {
"interfaces": [ "eth1", "eth3" ],
"re-detect": false
},
...
}
The loopback interfaces (i.e. the ``lo`` or ``lo0`` interface) are not
configured by default, unless explicitly mentioned in the
configuration. Note that Kea requires a link-local address (which does
not exist on all systems) or a specified unicast address, as in:
::
"Dhcp6": {
"interfaces-config": {
"interfaces": [ "enp0s2/2001:db8::1234:abcd" ]
},
...
}
Kea binds the service sockets for each interface on startup. If another
process is already using a port, then Kea logs the message and suppresses an
error. DHCP service runs, but it is unavailable on some interfaces.
The "service-sockets-require-all" option makes Kea require all sockets to
be successfully bound. If any opening fails, Kea interrupts the
initialization and exits with a non-zero status. (Default is false).
::
"Dhcp6": {
"interfaces-config": {
"interfaces": [ "eth1", "eth3" ],
"service-sockets-require-all": true
},
...
}
Sometimes, immediate interruption isn't a good choice. The port can be
unavailable only temporary. In this case, retrying the opening may resolve
the problem. Kea provides two options to specify the retrying:
``service-sockets-max-retries`` and ``service-sockets-retry-wait-time``.
The first defines a maximal number of retries that Kea makes to open a socket.
The zero value (default) means that the Kea doesn't retry the process.
The second defines a wait time (in milliseconds) between attempts. The default
value is 5000 (5 seconds).
::
"Dhcp6": {
"interfaces-config": {
"interfaces": [ "eth1", "eth3" ],
"service-sockets-max-retries": 5,
"service-sockets-retry-wait-time": 5000
},
...
}
If "service-sockets-max-retries" is non-zero and "service-sockets-require-all"
is false, then Kea retries the opening (if needed) but does not fail if any
socket is still not opened.
.. _ipv6-subnet-id:
IPv6 Subnet Identifier
----------------------
The subnet identifier (subnet ID) is a unique number associated with a particular
subnet. In principle, it is used to associate clients' leases with their
respective subnets. When a subnet identifier is not specified for a
subnet being configured, it is automatically assigned by the
configuration mechanism. The identifiers are assigned starting at 1 and are
monotonically increased for each subsequent subnet: 1, 2, 3, ....
If there are multiple subnets configured with auto-generated identifiers
and one of them is removed, the subnet identifiers may be renumbered.
For example: if there are four subnets and the third is removed, the
last subnet will be assigned the identifier that the third subnet had
before removal. As a result, the leases stored in the lease database for
subnet 3 are now associated with subnet 4, something that may have
unexpected consequences. The only remedy for this issue at present is to
manually specify a unique identifier for each subnet.
.. note::
Subnet IDs must be greater than zero and less than 4294967295.
The following configuration assigns the specified subnet identifier
to a newly configured subnet:
::
"Dhcp6": {
"subnet6": [
{
"subnet": "2001:db8:1::/64",
"id": 1024,
...
}
]
}
This identifier will not change for this subnet unless the ``id``
parameter is removed or set to 0. The value of 0 forces auto-generation
of the subnet identifier.
.. _ipv6-subnet-prefix:
IPv6 Subnet Prefix
------------------
The subnet prefix is the second way to identify a subnet. Kea can
accept non-canonical subnet addresses; for instance,
this configuration is accepted:
::
"Dhcp6": {
"subnet6": [
{
"subnet": "2001:db8:1::1/64",
...
}
]
}
This works even if there is another subnet with the "2001:db8:1::/64" prefix;
only the textual form of subnets are compared to avoid duplicates.
.. note::
Abuse of this feature can lead to incorrect subnet selection
(see :ref:`dhcp6-config-subnets`).
.. _dhcp6-unicast:
Unicast Traffic Support
-----------------------
When the DHCPv6 server starts, by default it listens to the DHCP traffic
sent to multicast address ff02::1:2 on each interface that it is
configured to listen on (see :ref:`dhcp6-interface-configuration`). In some cases it is
useful to configure a server to handle incoming traffic sent to global
unicast addresses as well; the most common reason for this is to have
relays send their traffic to the server directly. To configure the
server to listen on a specific unicast address, add a slash (/) after the interface name,
followed by the global unicast
address on which the server should listen. The server will listen to this
address in addition to normal link-local binding and listening on the
ff02::1:2 address. The sample configuration below shows how to listen on
2001:db8::1 (a global address) configured on the ``eth1`` interface.
::
"Dhcp6": {
"interfaces-config": {
"interfaces": [ "eth1/2001:db8::1" ]
},
"option-data": [
{
"name": "unicast",
"data": "2001:db8::1"
} ],
...
}
This configuration will cause the server to listen on ``eth1`` on the
link-local address, the multicast group (ff02::1:2), and 2001:db8::1.
Usually, unicast support is associated with a server unicast option which
allows clients to send unicast messages to the server. The example above
includes a server unicast option specification which causes the
client to send messages to the specified unicast address.
It is possible to mix interface names, wildcards, and interface
names/addresses in the list of interfaces. It is not possible, however,
to specify more than one unicast address on a given interface.
Care should be taken to specify proper unicast addresses, as the server
will attempt to bind to the addresses specified without any additional
checks. This approach was selected intentionally, to allow the software to
communicate over uncommon addresses if so desired.
.. _dhcp6-address-config:
Configuration of IPv6 Address Pools
-----------------------------------
The main role of a DHCPv6 server is address assignment. For this, the
server must be configured with at least one subnet and one pool of
dynamic addresses to be managed. For example, assume that the server is
connected to a network segment that uses the 2001:db8:1::/64 prefix. The
administrator of that network decides that addresses from the range
2001:db8:1::1 to 2001:db8:1::ffff are going to be managed by the DHCPv6
server. Such a configuration can be achieved in the following way:
::
"Dhcp6": {
"subnet6": [
{
"subnet": "2001:db8:1::/64",
"pools": [
{
"pool": "2001:db8:1::1-2001:db8:1::ffff"
}
],
...
}
]
}
Note that ``subnet`` is defined as a simple string, but the ``pools``
parameter is actually a list of pools; for this reason, the pool
definition is enclosed in square brackets, even though only one range of
addresses is specified.
Each ``pool`` is a structure that contains the parameters that describe
a single pool. Currently there is only one parameter, ``pool``, which
gives the range of addresses in the pool.
It is possible to define more than one pool in a subnet; continuing the
previous example, further assume that 2001:db8:1:0:5::/80 should also be
managed by the server. It could be written as 2001:db8:1:0:5:: to
2001:db8:1::5:ffff:ffff:ffff, but typing so many ``f`` characters is cumbersome.
The pool can be expressed more simply as 2001:db8:1:0:5::/80. Both formats are
supported by ``Dhcp6`` and they can be mixed in the pool list. For example,
the following pools could be defined:
::
"Dhcp6": {
"subnet6": [
{
"subnet": "2001:db8:1::/64",
"pools": [
{ "pool": "2001:db8:1::1-2001:db8:1::ffff" },
{ "pool": "2001:db8:1:05::/80" }
],
...
}
]
}
White space in pool definitions is ignored, so spaces before and after
the hyphen are optional. They can be used to improve readability.
The number of pools is not limited, but for performance reasons it is
recommended to use as few as possible.
The server may be configured to serve more than one subnet. To add a
second subnet, use a command similar to the following:
::
"Dhcp6": {
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/64",
"pools": [
{ "pool": "2001:db8:1::1-2001:db8:1::ffff" }
]
},
{
"id": 2,
"subnet": "2001:db8:2::/64",
"pools": [
{ "pool": "2001:db8:2::/64" }
]
},
...
]
}
In this example, we allow the server to dynamically assign all addresses
available in the whole subnet. Although rather wasteful, it is certainly
a valid configuration to dedicate the whole /64 subnet for that purpose.
Note that the Kea server does not preallocate the leases, so there is no
danger in using gigantic address pools.
When configuring a DHCPv6 server using prefix/length notation, please
pay attention to the boundary values. When specifying that the server
can use a given pool, it is also able to allocate the first
(typically a network address) address from that pool. For example, for
pool 2001:db8:2::/64, the 2001:db8:2:: address may be assigned as well.
To avoid this, use the ``min-max`` notation.
.. _dhcp6-prefix-config:
Subnet and Prefix Delegation Pools
----------------------------------
Subnets may also be configured to delegate prefixes, as defined in `RFC
8415 <https://tools.ietf.org/html/rfc8415>`__, section 6.3. A subnet may
have one or more prefix delegation pools. Each pool has a prefixed
address, which is specified as a prefix (``prefix``) and a prefix length
(``prefix-len``), as well as a delegated prefix length
(``delegated-len``). The delegated length must not be shorter than
(i.e. it must be numerically greater than or equal to) the prefix length.
If both the delegated and prefix lengths are equal, the server will be
able to delegate only one prefix. The delegated prefix does not have to
match the subnet prefix.
Below is a sample subnet configuration which enables prefix delegation
for the subnet:
::
"Dhcp6": {
"subnet6": [
{
"id": 1,
"subnet": "2001:d8b:1::/64",
"pd-pools": [
{
"prefix": "3000:1::",
"prefix-len": 64,
"delegated-len": 96
}
]
}
],
...
}
.. _pd-exclude-option:
Prefix Exclude Option
---------------------
For each delegated prefix, the delegating router may choose to exclude a
single prefix out of the delegated prefix as specified in `RFC
6603 <https://tools.ietf.org/html/rfc6603>`__. The requesting router must
not assign the excluded prefix to any of its downstream interfaces.
The excluded prefix is intended to be used on a link through which the delegating router
exchanges DHCPv6 messages with the requesting router. The configuration
example below demonstrates how to specify an excluded prefix within a
prefix pool definition. The excluded prefix
``2001:db8:1:8000:cafe:80::/72`` will be sent to a requesting router which
includes the Prefix Exclude option in the Option Request option (ORO),
and which is delegated a prefix from this pool.
::
"Dhcp6": {
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/48",
"pd-pools": [
{
"prefix": "2001:db8:1:8000::",
"prefix-len": 56,
"delegated-len": 64,
"excluded-prefix": "2001:db8:1:8000:cafe:80::",
"excluded-prefix-len": 72
}
]
}
]
}
.. note::
Here are some liberties and limits to the values that subnets and pools can
take in Kea configurations that are out of the ordinary:
+-------------------------------------------------------------------------------+---------+------------------------------------------------------------------------------------+
| Kea configuration case | Allowed | Comment |
+===============================================================================+=========+====================================================================================+
| Overlapping subnets | Yes | Administrator consideration needs to be given to how clients are matched to |
| | | these subnets. |
+-------------------------------------------------------------------------------+---------+------------------------------------------------------------------------------------+
| Overlapping address pools in one subnet | No | Startup error: DHCP6_PARSER_FAIL |
+-------------------------------------------------------------------------------+---------+------------------------------------------------------------------------------------+
| Overlapping address pools in different subnets | Yes | Specifying the same address pool in different subnets can be used as an equivalent |
| | | of the global address pool. In that case, the server can assign addresses from the |
| | | same range regardless of the client's subnet. If an address from such a pool is |
| | | assigned to a client in one subnet, the same address will be renewed for this |
| | | client if it moves to another subnet. Another client in a different subnet will |
| | | not be assigned an address already assigned to the client in any of the subnets. |
+-------------------------------------------------------------------------------+---------+------------------------------------------------------------------------------------+
| Address pools that are outside the subnet they are configured under | No | Startup error: DHCP6_PARSER_FAIL |
+-------------------------------------------------------------------------------+---------+------------------------------------------------------------------------------------+
| Overlapping prefix delegation pools in one subnet | No | Startup error: DHCP6_PARSER_FAIL |
+-------------------------------------------------------------------------------+---------+------------------------------------------------------------------------------------+
| Overlapping prefix delegation pools in different subnets | Yes | Specifying the same prefix delegation pool in different subnets can be used as an |
| | | equivalent of the global pool. In that case, the server can delegate the same |
| | | prefixes regardless of the client's subnet. If a prefix from such a pool is |
| | | delegated to a client in one subnet, the same prefix will be renewed for this |
| | | client if it moves to another subnet. Another client in a different subnet will |
| | | not be delegated a prefix already delegated to the client in any of the subnets. |
+-------------------------------------------------------------------------------+---------+------------------------------------------------------------------------------------+
| Prefix delegation pools not matching the subnet prefix | Yes | It is common in many deployments to configure the prefix delegation pools not |
| | | matching the subnet prefix, e.g. a prefix pool of 3000::/96 within the |
| | | 2001:db8:1::/64 subnet. Such use cases are supported by the Kea DHCPv6 server. |
+-------------------------------------------------------------------------------+---------+------------------------------------------------------------------------------------+
.. _dhcp6-std-options:
Standard DHCPv6 Options
-----------------------
One of the major features of the DHCPv6 server is the ability to provide
configuration options to clients. Although there are several options
that require special behavior, most options are sent by the server only
if the client explicitly requests them. The following example shows how
to configure the addresses of DNS servers, one of the most frequently used options.
Options specified in this way are considered global and apply to all configured subnets.
::
"Dhcp6": {
"option-data": [
{
"name": "dns-servers",
"code": 23,
"space": "dhcp6",
"csv-format": true,
"data": "2001:db8::cafe, 2001:db8::babe"
},
...
]
}
The ``option-data`` line creates a new entry in the option-data table.
This table contains information on all global options that the server is
supposed to configure in all subnets. The ``name`` line specifies the
option name. (For a complete list of currently supported names, see
:ref:`dhcp6-std-options-list`.) The next line specifies the
option code, which must match one of the values from that list. The line
beginning with ``space`` specifies the option space, which must always
be set to ``dhcp6`` as these are standard DHCPv6 options. For other name
spaces, including custom option spaces, see :ref:`dhcp6-option-spaces`. The following line
specifies the format in which the data will be entered; use of CSV
(comma-separated values) is recommended. Finally, the ``data`` line
gives the actual value to be sent to clients. The data parameter is specified as
normal text, with values separated by commas if more than one value is
allowed.
Options can also be configured as hexadecimal values. If ``csv-format`` is
set to ``false``, the option data must be specified as a hexadecimal string.
The following commands configure the ``dns-servers`` option for all subnets
with the addresses 2001:db8:1::cafe and 2001:db8:1::babe.
::
"Dhcp6": {
"option-data": [
{
"name": "dns-servers",
"code": 23,
"space": "dhcp6",
"csv-format": false,
"data": "20 01 0D B8 00 01 00 00 00 00 00 00 00 00 CA FE \
20 01 0D B8 00 01 00 00 00 00 00 00 00 00 BA BE"
},
...
]
}
.. note::
The value for the setting of the ``data`` element is split across two
lines in this example for clarity; when entering the command, the
whole string should be entered on the same line.
Kea supports the following formats when specifying hexadecimal data:
- ``Delimited octets`` - one or more octets separated by either colons or
spaces (":" or " "). While each octet may contain one or two digits,
we strongly recommend always using two digits. Valid examples are
"ab:cd:ef" and "ab cd ef".
- ``String of digits`` - a continuous string of hexadecimal digits with
or without a "0x" prefix. Valid examples are "0xabcdef" and "abcdef".
Care should be taken to use proper encoding when using hexadecimal
format; Kea's ability to validate data correctness in hexadecimal is
limited.
It is also possible to specify data for binary options as
a single-quoted text string within double quotes, as shown (note that
``csv-format`` must be set to ``false``):
::
"Dhcp6": {
"option-data": [
{
"name": "subscriber-id",
"code": 38,
"space": "dhcp6",
"csv-format": false,
"data": "'convert this text to binary'"
},
...
],
...
}
Most of the parameters in the ``option-data`` structure are optional and
can be omitted in some circumstances, as discussed in :ref:`dhcp6-option-data-defaults`.
Only one of ``name`` or ``code``
is required; it is not necessary to specify both. Space has a default value
of ``dhcp6``, so this can be skipped as well if a regular (not
encapsulated) DHCPv6 option is defined. Finally, ``csv-format`` defaults to ``true``, so it
too can be skipped, unless the option value is specified as
hexstring. Therefore, the above example can be simplified to:
::
"Dhcp6": {
"option-data": [
{
"name": "dns-servers",
"data": "2001:db8::cafe, 2001:db8::babe"
},
...
]
}
Defined options are added to the response when the client requests them,
as well as any options required by a protocol. An administrator can also
specify that an option is always sent, even if a client did not
specifically request it. To enforce the addition of a particular option,
set the ``always-send`` flag to ``true``, as in:
::
"Dhcp6": {
"option-data": [
{
"name": "dns-servers",
"data": "2001:db8::cafe, 2001:db8::babe",
"always-send": true
},
...
]
}
The effect is the same as if the client added the option code in the
Option Request Option (or its equivalent for vendor options), as in:
::
"Dhcp6": {
"option-data": [
{
"name": "dns-servers",
"data": "2001:db8::cafe, 2001:db8::babe",
"always-send": true
},
...
],
"subnet6": [
{
"subnet": "2001:db8:1::/64",
"option-data": [
{
"name": "dns-servers",
"data": "2001:db8:1::cafe, 2001:db8:1::babe"
},
...
],
...
},
...
],
...
}
In the example above, the ``dns-servers`` option respects the global
``always-send`` flag and is always added to responses, but for subnet
``2001:db8:1::/64``, the value is taken from the subnet-level option data
specification.
Contrary to ``always-send``, if the ``never-send`` flag is set to
``true`` for a particular option, the server does not add it to the response.
The effect is the same as if the client removed the option code in the
Option Request Option (or its equivalent for vendor options):
::
"Dhcp6": {
"option-data": [
{
"name": "dns-servers",
"data": "2001:db8::cafe, 2001:db8::babe"
},
...
],
"subnet6": [
{
"subnet": "2001:db8:1::/64",
"option-data": [
{
"name": "dns-servers",
"never-send": true
},
...
],
...
},
...
],
...
}
In the example above, the ``dns-server`` option is never added to responses
on subnet ``2001:db8:1::/64``. ``never-send`` has precedence over
``always-send``, so if both are ``true`` the option is not added.
.. note::
The ``always-send`` and ``never-send`` flags are sticky, meaning
they do not follow the usual configuration inheritance rules.
Instead, if they are enabled at least once along the configuration
inheritance chain, they are applied - even if they are
disabled in other places which would normally receive a higher priority.
For instance, if one of the flags is enabled in the global scope,
but disabled at the subnet level, it is enabled,
disregarding the subnet-level setting.
.. note::
The ``never-send`` flag is less powerful than :ischooklib:`libdhcp_flex_option.so`;
for instance, it has no effect on options managed by the server itself.
Both ``always-send`` and ``never-send`` have no effect on options
which cannot be requested, for instance from a custom space.
It is possible to override options on a per-subnet basis. If clients
connected to most subnets are expected to get the same values of
a given option, administrators should use global options; it is possible to override
specific values for a small number of subnets. On the other hand, if
different values are used in each subnet, it does not make sense to specify
global option values; rather, only subnet-specific ones should be set.
The following commands override the global ``dns-servers`` option for a
particular subnet, setting a single DNS server with address
2001:db8:1::3.
::
"Dhcp6": {
"subnet6": [
{
"option-data": [
{
"name": "dns-servers",
"code": 23,
"space": "dhcp6",
"csv-format": true,
"data": "2001:db8:1::3"
},
...
],
...
},
...
],
...
}
In some cases it is useful to associate some options with an address or
prefix pool from which a client is assigned a lease. Pool-specific
option values override subnet-specific and global option values. If the
client is assigned multiple leases from different pools, the server
assigns options from all pools from which the leases have been obtained.
However, if the particular option is specified in multiple pools from
which the client obtains the leases, only one instance of this option
is handed out to the client. The server's administrator must not
try to prioritize assignment of pool-specific options by trying to order
pool declarations in the server configuration.
The following configuration snippet demonstrates how to specify the
``dns-servers`` option, which will be assigned to a client only if the client
obtains an address from the given pool:
::
"Dhcp6": {
"subnet6": [
{
"pools": [
{
"pool": "2001:db8:1::100-2001:db8:1::300",
"option-data": [
{
"name": "dns-servers",
"data": "2001:db8:1::10"
}
]
}
]
},
...
],
...
}
Options can also be specified in class or host-reservation scope. The
current Kea options precedence order is (from most important to least): host
reservation, pool, subnet, shared network, class, global.
When a data field is a string and that string contains the comma (``,``;
U+002C) character, the comma must be escaped with two backslashes (``\\,``;
U+005C). This double escape is required because both the routine
splitting of CSV data into fields and JSON use the same escape character; a
single escape (``\,``) would make the JSON invalid. For example, the string
"EST5EDT4,M3.2.0/02:00,M11.1.0/02:00" must be represented as:
::
"Dhcp6": {
"subnet6": [
{
"pools": [
{
"option-data": [
{
"name": "new-posix-timezone",
"data": "EST5EDT4\\,M3.2.0/02:00\\,M11.1.0/02:00"
}
]
},
...
],
...
},
...
],
...
}
Some options are designated as arrays, which means that more than one
value is allowed. For example, the option ``dns-servers``
allows the specification of more than one IPv6 address, enabling clients
to obtain the addresses of multiple DNS servers.
:ref:`dhcp6-custom-options` describes the
configuration syntax to create custom option definitions (formats).
Creation of custom definitions for standard options is generally not
permitted, even if the definition being created matches the actual
option format defined in the RFCs. However, there is an exception to this rule
for standard options for which Kea currently does not provide a
definition. To use such options, a server administrator must
create a definition as described in :ref:`dhcp6-custom-options` in the ``dhcp6`` option space. This
definition should match the option format described in the relevant RFC,
but the configuration mechanism allows any option format as there is
currently no way to validate it.
The currently supported standard DHCPv6 options are listed in
the table below. "Name" and "Code" are the
values that should be used as a name/code in the option-data structures.
"Type" designates the format of the data; the meanings of the various
types are given in :ref:`dhcp-types`.
.. _dhcp6-std-options-list:
.. table:: List of standard DHCPv6 options configurable by an administrator
+--------------------------+-----------------+-----------------+-----------------+
| Name | Code | Type | Array? |
+==========================+=================+=================+=================+
| preference | 7 | uint8 | false |
+--------------------------+-----------------+-----------------+-----------------+
| unicast | 12 | ipv6-address | false |
+--------------------------+-----------------+-----------------+-----------------+
| sip-server-dns | 21 | fqdn | true |
+--------------------------+-----------------+-----------------+-----------------+
| sip-server-addr | 22 | ipv6-address | true |
+--------------------------+-----------------+-----------------+-----------------+
| dns-servers | 23 | ipv6-address | true |
+--------------------------+-----------------+-----------------+-----------------+
| domain-search | 24 | fqdn | true |
+--------------------------+-----------------+-----------------+-----------------+
| nis-servers | 27 | ipv6-address | true |
+--------------------------+-----------------+-----------------+-----------------+
| nisp-servers | 28 | ipv6-address | true |
+--------------------------+-----------------+-----------------+-----------------+
| nis-domain-name | 29 | fqdn | true |
+--------------------------+-----------------+-----------------+-----------------+
| nisp-domain-name | 30 | fqdn | true |
+--------------------------+-----------------+-----------------+-----------------+
| sntp-servers | 31 | ipv6-address | true |
+--------------------------+-----------------+-----------------+-----------------+
| information-refresh-time | 32 | uint32 | false |
+--------------------------+-----------------+-----------------+-----------------+
| bcmcs-server-dns | 33 | fqdn | true |
+--------------------------+-----------------+-----------------+-----------------+
| bcmcs-server-addr | 34 | ipv6-address | true |
+--------------------------+-----------------+-----------------+-----------------+
| geoconf-civic | 36 | record (uint8, | false |
| | | uint16, binary) | |
+--------------------------+-----------------+-----------------+-----------------+
| remote-id | 37 | record (uint32, | false |
| | | binary) | |
+--------------------------+-----------------+-----------------+-----------------+
| subscriber-id | 38 | binary | false |
+--------------------------+-----------------+-----------------+-----------------+
| client-fqdn | 39 | record (uint8, | false |
| | | fqdn) | |
+--------------------------+-----------------+-----------------+-----------------+
| pana-agent | 40 | ipv6-address | true |
+--------------------------+-----------------+-----------------+-----------------+
| new-posix-timezone | 41 | string | false |
+--------------------------+-----------------+-----------------+-----------------+
| new-tzdb-timezone | 42 | string | false |
+--------------------------+-----------------+-----------------+-----------------+
| ero | 43 | uint16 | true |
+--------------------------+-----------------+-----------------+-----------------+
| lq-query (1) | 44 | record (uint8, | false |
| | | ipv6-address) | |
+--------------------------+-----------------+-----------------+-----------------+
| client-data (1) | 45 | empty | false |
+--------------------------+-----------------+-----------------+-----------------+
| clt-time (1) | 46 | uint32 | false |
+--------------------------+-----------------+-----------------+-----------------+
| lq-relay-data (1) | 47 | record | false |
| | | (ipv6-address, | |
| | | binary) | |
+--------------------------+-----------------+-----------------+-----------------+
| lq-client-link (1) | 48 | ipv6-address | true |
+--------------------------+-----------------+-----------------+-----------------+
| v6-lost | 51 | fqdn | false |
+--------------------------+-----------------+-----------------+-----------------+
| capwap-ac-v6 | 52 | ipv6-address | true |
+--------------------------+-----------------+-----------------+-----------------+
| relay-id | 53 | binary | false |
+--------------------------+-----------------+-----------------+-----------------+
| v6-access-domain | 57 | fqdn | false |
+--------------------------+-----------------+-----------------+-----------------+
| sip-ua-cs-list | 58 | fqdn | true |
+--------------------------+-----------------+-----------------+-----------------+
| bootfile-url | 59 | string | false |
+--------------------------+-----------------+-----------------+-----------------+
| bootfile-param | 60 | tuple | true |
+--------------------------+-----------------+-----------------+-----------------+
| client-arch-type | 61 | uint16 | true |
+--------------------------+-----------------+-----------------+-----------------+
| nii | 62 | record (uint8, | false |
| | | uint8, uint8) | |
+--------------------------+-----------------+-----------------+-----------------+
| aftr-name | 64 | fqdn | false |
+--------------------------+-----------------+-----------------+-----------------+
| erp-local-domain-name | 65 | fqdn | false |
+--------------------------+-----------------+-----------------+-----------------+
| rsoo | 66 | empty | false |
+--------------------------+-----------------+-----------------+-----------------+
| pd-exclude | 67 | binary | false |
+--------------------------+-----------------+-----------------+-----------------+
| rdnss-selection | 74 | record | true |
| | | (ipv6-address, | |
| | | uint8, fqdn) | |
+--------------------------+-----------------+-----------------+-----------------+
| client-linklayer-addr | 79 | binary | false |
+--------------------------+-----------------+-----------------+-----------------+
| link-address | 80 | ipv6-address | false |
+--------------------------+-----------------+-----------------+-----------------+
| solmax-rt | 82 | uint32 | false |
+--------------------------+-----------------+-----------------+-----------------+
| inf-max-rt | 83 | uint32 | false |
+--------------------------+-----------------+-----------------+-----------------+
| dhcp4o6-server-addr | 88 | ipv6-address | true |
+--------------------------+-----------------+-----------------+-----------------+
| s46-rule | 89 | record (uint8, | false |
| | | uint8, uint8, | |
| | | ipv4-address, | |
| | | ipv6-prefix) | |
+--------------------------+-----------------+-----------------+-----------------+
| s46-br | 90 | ipv6-address | false |
+--------------------------+-----------------+-----------------+-----------------+
| s46-dmr | 91 | ipv6-prefix | false |
+--------------------------+-----------------+-----------------+-----------------+
| s46-v4v6bind | 92 | record | false |
| | | (ipv4-address, | |
| | | ipv6-prefix) | |
+--------------------------+-----------------+-----------------+-----------------+
| s46-portparams | 93 | record(uint8, | false |
| | | psid) | |
+--------------------------+-----------------+-----------------+-----------------+
| s46-cont-mape | 94 | empty | false |
+--------------------------+-----------------+-----------------+-----------------+
| s46-cont-mapt | 95 | empty | false |
+--------------------------+-----------------+-----------------+-----------------+
| s46-cont-lw | 96 | empty | false |
+--------------------------+-----------------+-----------------+-----------------+
| v6-captive-portal | 103 | string | false |
+--------------------------+-----------------+-----------------+-----------------+
| v6-sztp-redirect | 136 | tuple | true |
+--------------------------+-----------------+-----------------+-----------------+
| ipv6-address-andsf | 143 | ipv6-address | true |
+--------------------------+-----------------+-----------------+-----------------+
| v6-dnr | 144 | record (uint16, | false |
| | | uint16, fqdn, | |
| | | binary) | |
+--------------------------+-----------------+-----------------+-----------------+
Options marked with (1) have option definitions, but the logic behind
them is not implemented. That means that, technically, Kea knows how to
parse them in incoming messages or how to send them if configured to do
so, but not what to do with them. Since the related RFCs require certain
processing, the support for those options is non-functional. However, it
may be useful in some limited lab testing; hence the definition formats
are listed here.
Kea supports more options than those listed above. The following list is mostly useful for readers who
want to understand whether Kea is able to support certain options. The following options are
returned by the Kea engine itself and in general should not be configured manually.
.. table:: List of standard DHCPv6 options managed by Kea on its own and not directly configurable by an administrator
+--------------+------+------------------------------------------------------------------------+
| Name | Code | Description |
+==============+======+========================================================================+
| client-id | 1 | Sent by the client; Kea uses it to distinguish between clients. |
+--------------+------+------------------------------------------------------------------------+
| server-id | 2 | Sent by clients to request action from a specific server and by the |
| | | server to identify itself. See :ref:`dhcp6-serverid` for details. |
+--------------+------+------------------------------------------------------------------------+
| ia-na | 3 | A container option that conveys IPv6 addresses (``iaddr`` options). Kea|
| | | receives and sends those options using its allocation engine. |
+--------------+------+------------------------------------------------------------------------+
| ia-ta | 4 | Conveys temporary addresses. Deprecated feature, not supported. |
+--------------+------+------------------------------------------------------------------------+
| iaaddr | 5 | Conveys addresses with lifetimes in ``ia-na`` and ``ia-ta`` options. |
+--------------+------+------------------------------------------------------------------------+
| oro | 6 | ORO (or Option Request Option) is used by clients to request a list |
| | | of options they are interested in. Kea supports it and sends the |
| | | requested options back if configured with required options. |
+--------------+------+------------------------------------------------------------------------+
| elapsed-time | 8 | Sent by clients to identify how long they have been trying to obtain a |
| | | configuration. Kea uses high values sent by clients as an indicator |
| | | that something is wrong; this is one of the aspects used in HA to |
| | | determine if the partner is healthy or not. |
+--------------+------+------------------------------------------------------------------------+
| relay-msg | 9 | Used by relays to encapsulate the original client message. Kea uses it |
| | | when sending back relayed responses to the relay agent. |
+--------------+------+------------------------------------------------------------------------+
| auth | 11 | Used to pass authentication information between clients and server. The|
| | | support for this option is very limited. |
+--------------+------+------------------------------------------------------------------------+
| status-code | 13 | An option that the server can attach in case of various failures, such |
| | | as running out of addresses or not being configured to assign prefixes.|
+--------------+------+------------------------------------------------------------------------+
| rapid-commit | 14 | Used to signal the client's willingness to support ``rapid-commit`` and|
| | | the server's acceptance for this configuration. See |
| | | :ref:`dhcp6-rapid-commit` for details. |
+--------------+------+------------------------------------------------------------------------+
| user-class | 15 | Sent by the client to self-identify the device type. Kea |
| | | can use this for client classification. |
+--------------+------+------------------------------------------------------------------------+
| vendor-class | 16 | Similar to ``user-class``, but vendor-specific. |
+--------------+------+------------------------------------------------------------------------+
| vendor-opts | 17 | A vendor-specific container that is used by both the client and the |
| | | server to exchange vendor-specific options. The logic behind those |
| | | options varies between vendors. Vendor options are explained in |
| | | :ref:`dhcp6-vendor-opts`. |
+--------------+------+------------------------------------------------------------------------+
| interface-id | 18 | May be inserted by the relay agent to identify the interface that the |
| | | original client message was received on. Kea may be told to use this |
| | | information to select specific subnets. Also, if specified, Kea |
| | | echoes this option back, so the relay will know which interface to use |
| | | to reach the client. |
+--------------+------+------------------------------------------------------------------------+
| ia-pd | 25 | A container for conveying Prefix Delegations (PDs)) that are being |
| | | delegated to clients. See :ref:`dhcp6-prefix-config` for details. |
+--------------+------+------------------------------------------------------------------------+
| iaprefix | 26 | Conveys the IPv6 prefix in the ``ia-pd`` option. See |
| | | :ref:`dhcp6-prefix-config` for details. |
+--------------+------+------------------------------------------------------------------------+
.. _s46-options:
Common Softwire46 Options
-------------------------
Softwire46 options are involved in IPv4-over-IPv6 provisioning by means
of tunneling or translation, as specified in `RFC
7598 <https://tools.ietf.org/html/rfc7598>`__. The following sections
provide configuration examples of these options.
.. _s46-containers:
Softwire46 Container Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Softwire46 (S46) container options group rules and optional port parameters for a
specified domain. There are three container options specified in the
"dhcp6" (top-level) option space: the MAP-E Container option, the MAP-T
Container option, and the S46 Lightweight 4over6 Container option. These
options only contain the encapsulated options specified below; they do not
include any data fields.
To configure the server to send a specific container option along with
all encapsulated options, the container option must be included in the
server configuration as shown below:
::
"Dhcp6": {
"option-data": [
{
"name": "s46-cont-mape"
} ],
...
}
This configuration will cause the server to include the MAP-E Container
option to the client. Use ``s46-cont-mapt`` or ``s46-cont-lw`` for the MAP-T
Container and S46 Lightweight 4over6 Container options, respectively.
All remaining Softwire46 options described below are included in one of
the container options. Thus, they must be included in appropriate
option spaces by selecting a ``space`` name, which specifies the
option where they are supposed to be included.
S46 Rule Option
~~~~~~~~~~~~~~~
The S46 Rule option is used to convey the Basic Mapping Rule (BMR)
and Forwarding Mapping Rule (FMR).
::
{
"space": "s46-cont-mape-options",
"name": "s46-rule",
"data": "128, 0, 24, 192.0.2.0, 2001:db8:1::/64"
}
Another possible ``space`` value is ``s46-cont-mapt-options``.
The S46 Rule option conveys a number of parameters:
- ``flags`` - an unsigned 8-bit integer, with currently only the
most-significant bit specified. It denotes whether the rule can be
used for forwarding (128) or not (0).
- ``ea-len`` - an 8-bit-long Embedded Address length. Allowed values
range from 0 to 48.
- ``IPv4 prefix length`` - an 8-bit-long expression of the prefix length of
the Rule IPv4 prefix specified in the ``ipv4-prefix`` field. Allowed
values range from 0 to 32.
- ``IPv4 prefix`` - a fixed-length 32-bit field that specifies the IPv4
prefix for the S46 rule. The bits in the prefix after
a specific number of bits (defined in ``prefix4-len``) are reserved, and MUST
be initialized to zero by the sender and ignored by the receiver.
- ``IPv6 prefix`` - a field in prefix/length notation that specifies the IPv6
domain prefix for the S46 rule. The field is padded on the right with
zero bits up to the nearest octet boundary, when ``prefix6-len`` is not
evenly divisible by 8.
S46 BR Option
~~~~~~~~~~~~~
The S46 BR option is used to convey the IPv6 address of the Border
Relay. This option is mandatory in the MAP-E Container option and is not
permitted in the MAP-T and S46 Lightweight 4over6 Container options.
.. code-block:: json
{
"space": "s46-cont-mape-options",
"name": "s46-br",
"data": "2001:db8:cafe::1"
}
Another possible ``space`` value is ``s46-cont-lw-options``.
S46 DMR Option
~~~~~~~~~~~~~~
The S46 DMR option is used to convey values for the Default Mapping Rule
(DMR). This option is mandatory in the MAP-T container option and is not
permitted in the MAP-E and S46 Lightweight 4over6 Container options.
.. code-block:: json
{
"space": "s46-cont-mapt-options",
"name": "s46-dmr",
"data": "2001:db8:cafe::/64"
}
This option must not be included in other containers.
S46 IPv4/IPv6 Address Binding Option
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The S46 IPv4/IPv6 Address Binding option may be used to specify the full
or shared IPv4 address of the Customer Edge (CE). The IPv6 prefix field
is used by the CE to identify the correct prefix to use for the tunnel
source.
::
{
"space": "s46-cont-lw",
"name": "s46-v4v6bind",
"data": "192.0.2.3, 2001:db8:1:cafe::/64"
}
This option must not be included in other containers.
S46 Port Parameters
~~~~~~~~~~~~~~~~~~~
The S46 Port Parameters option specifies optional port-set information
that may be provided to CEs.
.. code-block:: json
{
"space": "s46-rule-options",
"name": "s46-portparams",
"data": "2, 3/4"
}
Another possible ``space`` value is ``s46-v4v6bind``, to include this option
in the S46 IPv4/IPv6 Address Binding option.
Note that the second value in the example above specifies the PSID and
PSID-length fields in the format of PSID/PSID length. This is equivalent
to the values of ``PSID-len=4`` and ``PSID=12288`` conveyed in the S46 Port
Parameters option.
.. _dhcp6-custom-options:
Custom DHCPv6 Options
---------------------
Kea supports custom (non-standard) DHCPv6 options.
Let's say that we want to define a new DHCPv6 option called ``foo``, which
will have code 100 and will convey a single, unsigned, 32-bit
integer value. Such an option can be defined by putting the following entry
in the configuration file:
::
"Dhcp6": {
"option-def": [
{
"name": "foo",
"code": 100,
"type": "uint32",
"array": false,
"record-types": "",
"space": "dhcp6",
"encapsulate": ""
},
...
],
...
}
The ``false`` value of the ``array`` parameter determines that the option
does NOT comprise an array of ``uint32`` values but is, instead, a single
value. Two other parameters have been left blank: ``record-types`` and
``encapsulate``. The former specifies the comma-separated list of option
data fields, if the option comprises a record of data fields. The
``record-types`` value should be non-empty if ``type`` is set to
``record``; otherwise it must be left blank. The latter parameter
specifies the name of the option space being encapsulated by the
particular option. If the particular option does not encapsulate any
option space, the parameter should be left blank. Note that the ``option-def``
configuration statement only defines the format of an option and does
not set its value(s).
The ``name``, ``code``, and ``type`` parameters are required; all others
are optional. The ``array`` parameter default value is ``false``. The
``record-types`` and ``encapsulate`` parameters default values are blank
(``""``). The default ``space`` is ``dhcp6``.
Once the new option format is defined, its value is set in the same way
as for a standard option. For example, the following commands set a
global value that applies to all subnets.
::
"Dhcp6": {
"option-data": [
{
"name": "foo",
"code": 100,
"space": "dhcp6",
"csv-format": true,
"data": "12345"
},
...
],
...
}
New options can take more complex forms than the simple use of primitives
(uint8, string, ipv6-address, etc.); it is possible to define an option
comprising a number of existing primitives.
For example, say we want to define a new option that will consist of
an IPv6 address, followed by an unsigned 16-bit integer, followed by a
boolean value, followed by a text string. Such an option could be
defined in the following way:
::
"Dhcp6": {
"option-def": [
{
"name": "bar",
"code": 101,
"space": "dhcp6",
"type": "record",
"array": false,
"record-types": "ipv6-address, uint16, boolean, string",
"encapsulate": ""
},
...
],
...
}
The ``type`` parameter is set to ``"record"`` to indicate that the option
contains multiple values of different types. These types are given as a
comma-separated list in the ``record-types`` field and should be ones
from those listed in :ref:`dhcp-types`.
The values of the options are set in an ``option-data`` statement as
follows:
::
"Dhcp6": {
"option-data": [
{
"name": "bar",
"space": "dhcp6",
"code": 101,
"csv-format": true,
"data": "2001:db8:1::10, 123, false, Hello World"
}
],
...
}
The ``csv-format`` parameter is set to ``true`` to indicate that the ``data``
field comprises a comma-separated list of values. The values in ``data`` must
correspond to the types set in the ``record-types`` field of the option
definition.
When ``array`` is set to ``true`` and ``type`` is set to ``"record"``, the
last field is an array, i.e. it can contain more than one value, as in:
::
"Dhcp6": {
"option-def": [
{
"name": "bar",
"code": 101,
"space": "dhcp6",
"type": "record",
"array": true,
"record-types": "ipv6-address, uint16",
"encapsulate": ""
},
...
],
...
}
The new option content is one IPv6 address followed by one or more 16-bit
unsigned integers.
.. note::
In general, boolean values are specified as ``true`` or ``false``,
without quotes. Some specific boolean parameters may also accept
``"true"``, ``"false"``, ``0``, ``1``, ``"0"``, and ``"1"``.
.. _dhcp6-vendor-opts:
DHCPv6 Vendor-Specific Options
------------------------------
Vendor options in DHCPv6 are carried in the Vendor-Specific
Information option (code 17). The idea behind option 17
is that each vendor has its own unique set of options with their own custom
formats. The vendor is identified by a 32-bit unsigned integer called
``enterprise-number`` or ``vendor-id``.
The standard spaces defined in Kea and their options are:
- ``vendor-2495``: Internet Systems Consortium, Inc. for 4o6 options:
+-------------+--------------------+------------------------------------------------------------------------+
| option code | option name | option description |
+=============+====================+========================================================================+
| 60000 | 4o6-interface | the name of the 4o6 server's client-facing interface |
+-------------+--------------------+------------------------------------------------------------------------+
| 60001 | 4o6-source-address | the address that the 4o6 server uses to send packets to the client |
+-------------+--------------------+------------------------------------------------------------------------+
| 60002 | 4o6-source-port | the port that the 4o6 server opens to send packets to the client |
+-------------+--------------------+------------------------------------------------------------------------+
- ``vendor-4491``: Cable Television Laboratories, Inc. for DOCSIS3 options:
+-------------+--------------------+------------------------------------------------------------------------+
| option code | option name | option description |
+=============+====================+========================================================================+
| 1 | oro | ORO (or Option Request Option) is used by clients to request a list of |
| | | options they are interested in. |
+-------------+--------------------+------------------------------------------------------------------------+
| 2 | tftp-servers | a list of IPv4 addresses of TFTP servers to be used by the cable modem |
+-------------+--------------------+------------------------------------------------------------------------+
The following examples show how to
define an option ``"foo"`` with code 1 that consists of an IPv6 address,
an unsigned 16-bit integer, and a string. The ``"foo"`` option is
conveyed in a Vendor-Specific Information option, which comprises a
single uint32 value that is set to ``12345``. The sub-option ``"foo"``
follows the data field holding this value.
The first step is to define the format of the option:
::
"Dhcp6": {
"option-def": [
{
"name": "foo",
"code": 1,
"space": "vendor-12345",
"type": "record",
"array": false,
"record-types": "ipv6-address, uint16, string",
"encapsulate": ""
}
],
...
}
Note that the option space is set to ``"vendor-12345"``.
Once the option format is defined, the next step is to define actual values
for that option:
::
"Dhcp6": {
"option-data": [
{
"name": "foo",
"space": "vendor-12345",
"data": "2001:db8:1::10, 123, Hello World"
},
...
],
...
}
We should also define a value (``"enterprise-number"``) for the
Vendor-Specific Information option, to convey the option ``foo``.
::
"Dhcp6": {
"option-data": [
{
"name": "vendor-opts",
"data": "12345"
},
...
],
...
}
Alternatively, the option can be specified using its code.
::
"Dhcp6": {
"option-data": [
{
"code": 17,
"data": "12345"
},
...
],
...
}
A common configuration is to set the ``always-send`` flag to ``true``, so the
vendor option is sent even when the client did not specify it in the query.
This is also how :iscman:`kea-dhcp6` can be configured to send multiple vendor options
from different vendors, along with each of their specific enterprise number.
If these options need to be sent by the server regardless of whether the client
specified any enterprise number, ``"always-send": true`` must be configured
for the suboptions that will be included in the Vendor-Specific Information option (code 17).
.. code-block:: json
{
"Dhcp6": {
"option-data": [
{
"always-send": true,
"data": "tagged",
"name": "tag",
"space": "vendor-2234"
},
{
"always-send": true,
"data": "https://example.com:1234/path",
"name": "url",
"space": "vendor-3561"
}
],
"option-def": [
{
"code": 22,
"name": "tag",
"space": "vendor-2234",
"type": "string"
},
{
"code": 11,
"name": "url",
"space": "vendor-3561",
"type": "string"
}
]
}
}
.. note::
The :iscman:`kea-dhcp6` server is able to recognize multiple Vendor Class
options (code 16) with different enterprise numbers in the client requests
and to send multiple Vendor-Specific Information options (code 17) in the
responses, one for each vendor.
.. _dhcp6-option-spaces:
Nested DHCPv6 Options (Custom Option Spaces)
--------------------------------------------
It is sometimes useful to define a completely new option space, such as
when a user creates a new option to convey sub-options that
use a separate numbering scheme, such as sub-options with codes 1
and 2. Those option codes conflict with standard DHCPv6 options, so a
separate option space must be defined.
Note that the creation of a new option space is not required when
defining sub-options for a standard option, because one is created by
default if the standard option is meant to convey any sub-options (see
:ref:`dhcp6-vendor-opts`).
If we want a DHCPv6 option called ``container`` with code 102,
that conveys two sub-options with codes 1 and 2, we first need to
define the new sub-options:
::
"Dhcp6": {
"option-def": [
{
"name": "subopt1",
"code": 1,
"space": "isc",
"type": "ipv6-address",
"record-types": "",
"array": false,
"encapsulate": ""
},
{
"name": "subopt2",
"code": 2,
"space": "isc",
"type": "string",
"record-types": "",
"array": false,
"encapsulate": ""
}
],
...
}
Note that we have defined the options to belong to a new option space
(in this case, ``"isc"``).
The next step is to define a regular DHCPv6 option with the desired code
and specify that it should include options from the new option space:
::
"Dhcp6": {
"option-def": [
{
"name": "container",
"code": 102,
"space": "dhcp6",
"type": "empty",
"array": false,
"record-types": "",
"encapsulate": "isc"
},
...
],
...
}
The name of the option space in which the sub-options are defined is set
in the ``encapsulate`` field. The ``type`` field is set to ``"empty"``, to
indicate that this option does not carry any data other than
sub-options.
Finally, we can set values for the new options:
.. code-block:: json
{
"Dhcp6": {
"option-data": [
{
"name": "subopt1",
"code": 1,
"space": "isc",
"data": "2001:db8::abcd"
},
{
"name": "subopt2",
"code": 2,
"space": "isc",
"data": "Hello world"
},
{
"name": "container",
"code": 102,
"space": "dhcp6"
}
]
}
}
It is possible to create an option which carries some data in
addition to the sub-options defined in the encapsulated option space.
For example, if the ``container`` option from the previous example were
required to carry a uint16 value as well as the sub-options, the
``type`` value would have to be set to ``"uint16"`` in the option
definition. (Such an option would then have the following data
structure: DHCP header, uint16 value, sub-options.) The value specified
with the ``data`` parameter — which should be a valid integer enclosed
in quotes, e.g. ``"123"`` — would then be assigned to the ``uint16`` field in
the ``container`` option.
.. _dhcp6-option-data-defaults:
Unspecified Parameters for DHCPv6 Option Configuration
------------------------------------------------------
In many cases it is not required to specify all parameters for an option
configuration, and the default values can be used. However, it is
important to understand the implications of not specifying some of them,
as it may result in configuration errors. The list below explains the
behavior of the server when a particular parameter is not explicitly
specified:
- ``name`` - the server requires either an option name or an option code to
identify an option. If this parameter is unspecified, the option code
must be specified.
- ``code`` - the server requires either an option name or an option code to
identify an option; this parameter may be left unspecified if the
``name`` parameter is specified. However, this also requires that the
particular option have a definition (either as a standard option or
an administrator-created definition for the option using an
``option-def`` structure), as the option definition associates an
option with a particular name. It is possible to configure an option
for which there is no definition (unspecified option format).
Configuration of such options requires the use of the option code.
- ``space`` - if the option space is unspecified it defaults to
``dhcp6``, which is an option space holding standard DHCPv6 options.
- ``data`` - if the option data is unspecified it defaults to an empty
value. The empty value is mostly used for the options which have no
payload (boolean options), but it is legal to specify empty values
for some options which carry variable-length data and for which the
specification allows a length of 0. For such options, the data
parameter may be omitted in the configuration.
- ``csv-format`` - if this value is not specified, the server
assumes that the option data is specified as a list of comma-separated
values to be assigned to individual fields of the DHCP option.
.. _dhcp6-t1-t2-times:
Controlling the Values Sent for T1 and T2 Times
-----------------------------------------------
According to RFC 8415, section 21.4, the recommended T1 and T2 values
are 50% and 80% of the preferred
lease time, respectively. Kea can be configured to send values that are
specified explicitly or that are calculated as percentages of the
preferred lease time. The server's behavior is determined by a combination
of configuration parameters, of which T1 and T2 are only two.
The lease's preferred and valid lifetimes are expressed as triplets with
minimum, default, and maximum values using configuration entries:
- ``min-preferred-lifetime`` - specifies the minimum preferred lifetime (optional).
- ``preferred-lifetime`` - specifies the default preferred lifetime.
- ``max-preferred-lifetime`` - specifies the maximum preferred lifetime (optional).
- ``min-valid-lifetime`` - specifies the minimum valid lifetime (optional).
- ``valid-lifetime`` - specifies the default valid lifetime.
- ``max-valid-lifetime`` - specifies the maximum valid lifetime (optional).
Since Kea 1.9.11, these values may be specified within client classes.
When the client does not specify lifetimes, the default is used.
A specified lifetime - using the IAADDR or IAPREFIX sub-option with
non-zero values - uses these values when they are between the configured
minimum and maximum bounds. Values outside the bounds are rounded up or down as
needed.
.. note::
As of Kea 2.3.8, if the preferred-lifetime has not been explicitly specified
or the specified value is larger than the value of valid-lifetime, the server
will use the value given by 0.625 * valid-lifetime.
To send specific fixed values, use the following two parameters:
- ``renew-timer`` - specifies the value of T1 in seconds.
- ``rebind-timer`` - specifies the value of T2 in seconds.
Any value greater than or equal to zero may be specified for T2.
T1, if specified, must be less than T2. This flexibility allows
a use case where administrators want to suppress client renewals and
rebinds by deferring them beyond the lifespan of the lease. This should
cause the lease to expire, rather than get renewed by clients. If T1 is
specified as larger than T2, T1 is silently set to zero in the outbound IA.
In the great majority of cases, the values should follow this rule: T1 < T2 <
preferred lifetime < valid lifetime. Alternatively, both T1 and T2
values can be configured to 0, which is a signal to DHCPv6 clients that
they may renew at their own discretion. However, there are known broken
client implementations in use that will start renewing immediately.
Administrators who plan to use T1=T2=0 values should test first and make sure
their clients behave rationally.
In some rare cases there may be a need to disable a client's ability to
renew addresses. This is undesired from a protocol perspective and should
be avoided if possible. However, if necessary, administrators can
configure the T1 and T2 values to be equal or greater to the valid
lifetime. Be advised that this will cause clients to occasionally
lose their addresses, which is generally perceived as poor service.
However, there may be some rare business cases when this is desired
(e.g. when it is desirable to intentionally break long-lasting connections).
Calculation of the values is controlled by the following three parameters:
- ``calculate-tee-times`` - when ``true``, T1 and T2 are calculated as
percentages of the valid lease time. It defaults to ``true``.
- ``t1-percent`` - the percentage of the valid lease time to use for
T1. It is expressed as a real number between 0.0 and 1.0 and must be
less than ``t2-percent``. The default value is 0.5, per RFC 8415.
- ``t2-percent`` - the percentage of the valid lease time to use for
T2. It is expressed as a real number between 0.0 and 1.0 and must be
greater than ``t1-percent``. The default value is 0.8 per RFC 8415.
.. note::
If both explicit values are specified and
``calculate-tee-times`` is ``true``, the server will use the explicit values.
Administrators with a setup where some subnets or shared-networks
use explicit values and some use calculated values must
not define the explicit values at any level higher than where they
will be used. Inheriting them from too high a scope, such as
global, will cause them to have values at every level underneath
(both shared-networks and subnets), effectively disabling calculated
values.
.. _dhcp6-config-subnets:
IPv6 Subnet Selection
---------------------
The DHCPv6 server may receive requests from local (connected to the same
subnet as the server) and remote (connected via relays) clients. As the
server may have many subnet configurations defined, it must select an
appropriate subnet for a given request.
In IPv4, the server can determine which of the configured subnets are
local, as there is a reasonable expectation that the server will have a
(global) IPv4 address configured on the interface. That assumption is not
true in IPv6; the DHCPv6 server must be able to operate while only using
link-local addresses. Therefore, an optional ``interface`` parameter is
available within a subnet definition to designate that a given subnet is
local, i.e. reachable directly over the specified interface. For
example, a server that is intended to serve a local subnet over eth0
may be configured as follows:
::
"Dhcp6": {
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:beef::/48",
"pools": [
{
"pool": "2001:db8:beef::/48"
}
],
"interface": "eth0"
}
],
...
}
.. _dhcp6-rapid-commit:
Rapid Commit
------------
The Rapid Commit option, described in `RFC
8415 <https://tools.ietf.org/html/rfc8415>`__, is supported by the Kea
DHCPv6 server. However, support is disabled by default. It can be
enabled on a per-subnet basis using the ``rapid-commit`` parameter as
shown below:
.. code-block:: json
{
"Dhcp6": {
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:beef::/48",
"rapid-commit": true,
"pools": [
{
"pool": "2001:db8:beef::1-2001:db8:beef::10"
}
]
}
]
}
}
This setting only affects the subnet for which ``rapid-commit`` is
set to ``true``. For clients connected to other subnets, the server
ignores the Rapid Commit option sent by the client and follows the
4-way exchange procedure, i.e. responds with an Advertise for a Solicit
containing a Rapid Commit option.
.. _dhcp6-relays:
DHCPv6 Relays
-------------
A DHCPv6 server with multiple subnets defined must select the
appropriate subnet when it receives a request from a client. For clients
connected via relays, two mechanisms are used:
The first uses the ``linkaddr`` field in the ``RELAY_FORW`` message. The name of
this field is somewhat misleading in that it does not contain a
link-layer address; instead, it holds an address (typically a global
address) that is used to identify a link. The DHCPv6 server checks to
see whether the address belongs to a defined subnet and, if it does,
that subnet is selected for the client's request.
The second mechanism is based on ``interface-id`` options. While forwarding
a client's message, relays may insert an ``interface-id`` option into the
message that identifies the interface on the relay that received the
message. (Some relays allow configuration of that parameter, but it is
sometimes hard-coded and may range from the very simple [e.g. "vlan100"]
to the very cryptic; one example seen on real hardware was
"ISAM144|299|ipv6|nt:vp:1:110".) The server can use this information to
select the appropriate subnet. The information is also returned to the
relay, which then knows the interface to use to transmit the response to
the client. For this to work successfully, the relay interface IDs must
be unique within the network and the server configuration must match
those values.
When configuring the DHCPv6 server, two
similarly named parameters can be configured for a subnet:
- ``interface`` - defines which local network interface can be used to
access a given subnet.
- ``interface-id`` - specifies the content of the ``interface-id`` option
used by relays to identify the interface on the relay to which the
response packet is sent.
The two are mutually exclusive; a subnet cannot be reachable both
locally (direct traffic) and via relays (remote traffic). Specifying
both is a configuration error and the DHCPv6 server will refuse such a
configuration.
The following example configuration shows how to specify an ``interface-id``
with a value of "vlan123":
::
"Dhcp6": {
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:beef::/48",
"pools": [
{
"pool": "2001:db8:beef::/48"
}
],
"interface-id": "vlan123"
}
],
...
}
.. _dhcp6-rsoo:
Relay-Supplied Options
----------------------
`RFC 6422 <https://tools.ietf.org/html/rfc6422>`__ defines a mechanism
called Relay-Supplied DHCP Options. In certain cases relay agents are
the only entities that may have specific information, and they can
insert options when relaying messages from the client to the server. The
server then does certain checks and copies those options to the
response sent to the client.
There are certain conditions that must be met for the option to be
included. First, the server must not provide the option itself; in other
words, if both relay and server provide an option, the server always
takes precedence. Second, the option must be RSOO-enabled. (RSOO is the
"Relay Supplied Options option.") IANA maintains a list of RSOO-enabled
options
`here <https://www.iana.org/assignments/dhcpv6-parameters/dhcpv6-parameters.xhtml#options-relay-supplied>`__.
However, there may be cases when system administrators want to echo
other options. Kea can be instructed to treat other options as
RSOO-enabled; for example, to mark options 110, 120, and 130 as
RSOO-enabled, the following syntax should be used:
::
"Dhcp6": {
"relay-supplied-options": [ "110", "120", "130" ],
...
}
At this time, only option 65 is RSOO-enabled by IANA. This option
will always be treated as RSOO-enabled, so there is no need to explicitly mark
it. When enabling standard options, it is also possible to use their
names rather than their option code, e.g. use ``dns-servers`` instead of
``23``. See ref:`dhcp6-std-options-list` for the names. In
certain cases this may also work for custom options, but due to the
nature of the parser code this may be unreliable and should be avoided.
.. _dhcp6-client-classifier:
Client Classification in DHCPv6
-------------------------------
The DHCPv6 server includes support for client classification. For a
deeper discussion of the classification process, see :ref:`classify`.
In certain cases it is useful to configure the server to differentiate
between DHCP client types and treat them accordingly. Client
classification can be used to modify the behavior of almost any part of
DHCP message processing. Kea currently offers
three mechanisms that take advantage of client classification in DHCPv6:
subnet selection, address pool selection, and DHCP options assignment.
Kea can be instructed to limit access to given subnets based on class
information. This is particularly useful for cases where two types of
devices share the same link and are expected to be served from two
different subnets. The primary use case for such a scenario is cable
networks, where there are two classes of devices: the cable modem
itself, which should be handed a lease from subnet A; and all other
devices behind the modem, which should get leases from subnet B. That
segregation is essential to prevent overly curious end-users from playing
with their cable modems. For details on how to set up class restrictions
on subnets, see :ref:`classification-subnets`.
When subnets belong to a shared network, the classification applies to
subnet selection but not to pools; that is, a pool in a subnet limited to a
particular class can still be used by clients which do not belong to the
class, if the pool they are expected to use is exhausted. The limit
on access based on class information is also available at the
address/prefix pool level within a subnet: see :ref:`classification-pools`.
This is useful when segregating clients belonging to the same
subnet into different address ranges.
In a similar way, a pool can be constrained to serve only known clients,
i.e. clients which have a reservation, using the built-in ``KNOWN`` or
``UNKNOWN`` classes. Addresses can be assigned to registered clients
without giving a different address per reservation: for instance, when
there are not enough available addresses. The determination whether
there is a reservation for a given client is made after a subnet is
selected, so it is not possible to use ``KNOWN``/``UNKNOWN`` classes to select a
shared network or a subnet.
The process of classification is conducted in five steps. The first step
is to assess an incoming packet and assign it to zero or more classes.
The second step is to choose a subnet, possibly based on the class
information. When the incoming packet is in the special class ``DROP``,
it is dropped and a debug message logged.
The next step is to evaluate class expressions depending on the built-in
``KNOWN``/``UNKNOWN`` classes after host reservation lookup, using them for
pool/pd-pool selection and assigning classes from host reservations. The
list of required classes is then built and each class of the list has
its expression evaluated; when it returns ``true``, the packet is added as
a member of the class. The last step is to assign options, again possibly
based on the class information. More complete and detailed information
is available in :ref:`classify`.
There are two main methods of classification. The first is automatic and
relies on examining the values in the vendor class options or the
existence of a host reservation. Information from these options is
extracted, and a class name is constructed from it and added to the
class list for the packet. The second method specifies an expression that is
evaluated for each packet. If the result is ``true``, the packet is a
member of the class.
.. note::
The new ``early-global-reservations-lookup`` global parameter flag
enables a lookup for global reservations before the subnet selection
phase. This lookup is similar to the general lookup described above
with two differences:
- the lookup is limited to global host reservations
- the ``UNKNOWN`` class is never set
.. note::
Care should be taken with client classification, as it is easy for
clients that do not meet class criteria to be denied all service.
Defining and Using Custom Classes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following example shows how to configure a class using an expression
and a subnet using that class. This configuration defines the class
named ``Client_enterprise``. It is comprised of all clients whose client
identifiers start with the given hex string (which would indicate a DUID
based on an enterprise id of 0xAABBCCDD). Members of this class will be given an address
from 2001:db8:1::0 to 2001:db8:1::FFFF and the addresses of their DNS
servers set to 2001:db8:0::1 and 2001:db8:2::1.
::
"Dhcp6": {
"client-classes": [
{
"name": "Client_enterprise",
"test": "substring(option[1].hex,0,6) == 0x0002AABBCCDD",
"option-data": [
{
"name": "dns-servers",
"code": 23,
"space": "dhcp6",
"csv-format": true,
"data": "2001:db8:0::1, 2001:db8:2::1"
}
]
},
...
],
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/64",
"pools": [ { "pool": "2001:db8:1::-2001:db8:1::ffff" } ],
"client-class": "Client_enterprise"
}
],
...
}
This example shows a configuration using an automatically generated
``VENDOR_CLASS_`` class. The administrator of the network has decided that
addresses in the range 2001:db8:1::1 to 2001:db8:1::ffff are to be
managed by the DHCPv6 server and that only clients belonging to the
eRouter1.0 client class are allowed to use that pool.
::
"Dhcp6": {
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/64",
"pools": [
{
"pool": "2001:db8:1::-2001:db8:1::ffff"
}
],
"client-class": "VENDOR_CLASS_eRouter1.0"
}
],
...
}
.. _dhcp6-required-class:
Required Classification
~~~~~~~~~~~~~~~~~~~~~~~
In some cases it is useful to limit the scope of a class to a
shared network, subnet, or pool. There are two parameters which are used
to limit the scope of the class by instructing the server to evaluate test
expressions when required.
The first one is the per-class ``only-if-required`` flag, which is ``false``
by default. When it is set to ``true``, the test expression of the class
is not evaluated at the reception of the incoming packet but later, and
only if the class evaluation is required.
The second is ``require-client-classes``, which takes a list of class
names and is valid in shared-network, subnet, and pool scope. Classes in
these lists are marked as required and evaluated after selection of this
specific shared network/subnet/pool and before output-option processing.
In this example, a class is assigned to the incoming packet when the
specified subnet is used:
::
"Dhcp6": {
"client-classes": [
{
"name": "Client_foo",
"test": "member('ALL')",
"only-if-required": true
},
...
],
"subnet6": [
{
"subnet": "2001:db8:1::/64",
"pools": [
{
"pool": "2001:db8:1::-2001:db8:1::ffff"
}
],
"require-client-classes": [ "Client_foo" ],
...
},
...
],
...
}
Required evaluation can be used to express complex dependencies like
subnet membership. It can also be used to reverse the
precedence; if ``option-data`` is set in a subnet, it takes precedence
over ``option-data`` in a class. If ``option-data`` is moved to a
required class and required in the subnet, a class evaluated earlier
may take precedence.
Required evaluation is also available at shared-network and pool/pd-pool
levels. The order in which required classes are considered is:
shared-network, subnet, and (pd-)pool, i.e. in the reverse order from the
way in which ``option-data`` is processed.
.. _dhcp6-ddns-config:
DDNS for DHCPv6
---------------
As mentioned earlier, :iscman:`kea-dhcp6` can be configured to generate requests
to the DHCP-DDNS server, :iscman:`kea-dhcp-ddns`, (referred to herein as "D2") to
update DNS entries. These requests are known as NameChangeRequests or
NCRs. Each NCR contains the following information:
1. Whether it is a request to add (update) or remove DNS entries.
2. Whether the change requests forward DNS updates (AAAA records),
reverse DNS updates (PTR records), or both.
3. The Fully Qualified Domain Name (FQDN), lease address, and DHCID
(information identifying the client associated with the FQDN).
DDNS-related parameters are split into two groups:
1. Connectivity Parameters
These are parameters which specify where and how :iscman:`kea-dhcp6` connects to
and communicates with D2. These parameters can only be specified
within the top-level ``dhcp-ddns`` section in the :iscman:`kea-dhcp6`
configuration. The connectivity parameters are listed below:
- ``enable-updates``
- ``server-ip``
- ``server-port``
- ``sender-ip``
- ``sender-port``
- ``max-queue-size``
- ``ncr-protocol``
- ``ncr-format"``
2. Behavioral Parameters
These parameters influence behavior such as how client host names and
FQDN options are handled. They have been moved out of the ``dhcp-ddns``
section so that they may be specified at the global, shared-network,
and/or subnet levels. Furthermore, they are inherited downward from global to
shared-network to subnet. In other words, if a parameter is not specified at
a given level, the value for that level comes from the level above it.
The behavioral parameters are as follows:
- ``ddns-send-updates``
- ``ddns-override-no-update``
- ``ddns-override-client-update``
- ``ddns-replace-client-name"``
- ``ddns-generated-prefix``
- ``ddns-qualifying-suffix``
- ``ddns-update-on-renew``
- ``ddns-use-conflict-resolution``
- ``ddns-ttl-percent``
- ``hostname-char-set``
- ``hostname-char-replacement``
.. note::
For backward compatibility, configuration parsing still recognizes
the original behavioral parameters specified in ``dhcp-ddns``,
by translating the parameter into its global equivalent. If a
parameter is specified both globally and in ``dhcp-ddns``, the latter
value is ignored. In either case, a log is emitted explaining
what has occurred. Specifying these values within ``dhcp-ddns`` is
deprecated and support for it will be removed.
The default configuration and values would appear as follows:
::
"Dhcp6": {
"dhcp-ddns": {
// Connectivity parameters
"enable-updates": false,
"server-ip": "127.0.0.1",
"server-port":53001,
"sender-ip":"",
"sender-port":0,
"max-queue-size":1024,
"ncr-protocol":"UDP",
"ncr-format":"JSON"
},
// Behavioral parameters (global)
"ddns-send-updates": true,
"ddns-override-no-update": false,
"ddns-override-client-update": false,
"ddns-replace-client-name": "never",
"ddns-generated-prefix": "myhost",
"ddns-qualifying-suffix": "",
"ddns-update-on-renew": false,
"ddns-use-conflict-resolution": true,
"hostname-char-set": "",
"hostname-char-replacement": "",
...
}
There are two parameters which determine if :iscman:`kea-dhcp6`
can generate DDNS requests to D2: the existing ``dhcp-ddns:enable-updates``
parameter, which now only controls whether :iscman:`kea-dhcp6` connects to D2;
and the new behavioral parameter, ``ddns-send-updates``, which determines
whether DDNS updates are enabled at a given level (i.e. global, shared-network,
or subnet). The following table shows how the two parameters function
together:
.. table:: Enabling and disabling DDNS updates
+-----------------+--------------------+-------------------------------------+
| dhcp-ddns: | Global | Outcome |
| enable-updates | ddns-send-updates | |
+=================+====================+=====================================+
| false (default) | false | no updates at any scope |
+-----------------+--------------------+-------------------------------------+
| false | true (default) | no updates at any scope |
+-----------------+--------------------+-------------------------------------+
| true | false | updates only at scopes with |
| | | a local value of ``true`` for |
| | | ``ddns-enable-updates`` |
+-----------------+--------------------+-------------------------------------+
| true | true | updates at all scopes except those |
| | | with a local value of ``false`` |
| | | for ``ddns-enable-updates`` |
+-----------------+--------------------+-------------------------------------+
Kea 1.9.1 added two new parameters; the first is ``ddns-update-on-renew``.
Normally, when leases are renewed, the server only updates DNS if the DNS
information for the lease (e.g. FQDN, DNS update direction flags) has changed.
Setting ``ddns-update-on-renew`` to ``true`` instructs the server to always update
the DNS information when a lease is renewed, even if its DNS information has not
changed. This allows Kea to "self-heal" if it was previously unable
to add DNS entries or they were somehow lost by the DNS server.
.. note::
Setting ``ddns-update-on-renew`` to ``true`` may impact performance, especially
for servers with numerous clients that renew often.
The second parameter added in Kea 1.9.1 is ``ddns-use-conflict-resolution``.
The value of this parameter is passed by :iscman:`kea-dhcp6` to D2 with each DNS update
request. When ``true`` (the default value), D2 employs conflict resolution,
as described in `RFC 4703 <https://tools.ietf.org/html/rfc4703>`__, when
attempting to fulfill the update request. When ``false``, D2 simply attempts
to update the DNS entries per the request, regardless of whether they
conflict with existing entries owned by other DHCPv6 clients.
.. note::
Setting ``ddns-use-conflict-resolution`` to ``false`` disables the overwrite
safeguards that the rules of conflict resolution (from
`RFC 4703 <https://tools.ietf.org/html/rfc4703>`__) are intended to
prevent. This means that existing entries for an FQDN or an
IP address made for Client-A can be deleted or replaced by entries
for Client-B. Furthermore, there are two scenarios by which entries
for multiple clients for the same key (e.g. FQDN or IP) can be created.
1. Client-B uses the same FQDN as Client-A but a different IP address.
In this case, the forward DNS entries (AAAA and DHCID RRs) for
Client-A will be deleted as they match the FQDN and new entries for
Client-B will be added. The reverse DNS entries (PTR and DHCID RRs)
for Client-A, however, will not be deleted as they belong to a different
IP address, while new entries for Client-B will still be added.
2. Client-B uses the same IP address as Client-A but a different FQDN.
In this case the reverse DNS entries (PTR and DHCID RRs) for Client-A
will be deleted as they match the IP address, and new entries for
Client-B will be added. The forward DNS entries (AAAA and DHCID RRs)
for Client-A, however, will not be deleted, as they belong to a different
FQDN, while new entries for Client-B will still be added.
Disabling conflict resolution should be done only after careful review of
specific use cases. The best way to avoid unwanted DNS entries is to
always ensure lease changes are processed through Kea, whether they are
released, expire, or are deleted via the :isccmd:`lease6-del` command, prior to
reassigning either FQDNs or IP addresses. Doing so causes :iscman:`kea-dhcp6`
to generate DNS removal requests to D2.
The DNS entries Kea creates contain a value for TTL (time to live).
:iscman:`kea-dhcp6` calculates that value based on
`RFC 4702, Section 5 <https://tools.ietf.org/html/rfc4702#section-5>`__,
which suggests that the TTL value be 1/3 of the lease's lifetime, with
a minimum value of 10 minutes.
The parameter ``ddns-ttl-percent``, when specified,
causes the TTL to be calculated as a simple percentage of the lease's
lifetime, using the parameter's value as the percentage. It is specified
as a decimal percent (e.g. .25, .75, 1.00) and may be specified at the
global, shared-network, and subnet levels. By default it is unspecified.
.. _dhcpv6-d2-io-config:
DHCP-DDNS Server Connectivity
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For NCRs to reach the D2 server, :iscman:`kea-dhcp6` must be able to communicate
with it. :iscman:`kea-dhcp6` uses the following configuration parameters to
control this communication:
- ``enable-updates`` - Enables connectivity to :iscman:`kea-dhcp-ddns` such that DDNS
updates can be constructed and sent.
It must be ``true`` for NCRs to be generated and sent to D2.
It defaults to ``false``.
- ``server-ip`` - This is the IP address on which D2 listens for requests. The
default is the local loopback interface at address 127.0.0.1.
Either an IPv4 or IPv6 address may be specified.
- ``server-port`` - This is the port on which D2 listens for requests. The default
value is ``53001``.
- ``sender-ip`` - This is the IP address which :iscman:`kea-dhcp6` uses to send requests to
D2. The default value is blank, which instructs :iscman:`kea-dhcp6` to select a
suitable address.
- ``sender-port`` - This is the port which :iscman:`kea-dhcp6` uses to send requests to D2.
The default value of ``0`` instructs :iscman:`kea-dhcp6` to select a suitable port.
- ``max-queue-size`` - This is the maximum number of requests allowed to queue
while waiting to be sent to D2. This value guards against requests
accumulating uncontrollably if they are being generated faster than
they can be delivered. If the number of requests queued for
transmission reaches this value, DDNS updating is turned off
until the queue backlog has been sufficiently reduced. The intent is
to allow the :iscman:`kea-dhcp4` server to continue lease operations without
running the risk that its memory usage grows without limit. The
default value is ``1024``.
- ``ncr-protocol`` - This specifies the socket protocol to use when sending requests to
D2. Currently only UDP is supported.
- ``ncr-format`` - This specifies the packet format to use when sending requests to D2.
Currently only JSON format is supported.
By default, :iscman:`kea-dhcp-ddns` is assumed to be running on the same machine
as :iscman:`kea-dhcp6`, and all of the default values mentioned above should be
sufficient. If, however, D2 has been configured to listen on a different
address or port, these values must be altered accordingly. For example, if
D2 has been configured to listen on 2001:db8::5 port 900, the following
configuration is required:
::
"Dhcp6": {
"dhcp-ddns": {
"server-ip": "2001:db8::5",
"server-port": 900,
...
},
...
}
.. _dhcpv6-d2-rules-config:
When Does the :iscman:`kea-dhcp6` Server Generate a DDNS Request?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The :iscman:`kea-dhcp6` server follows the behavior prescribed for DHCP servers in
`RFC 4704 <https://tools.ietf.org/html/rfc4704>`__. It is important to keep
in mind that :iscman:`kea-dhcp6` makes the initial decision of when and what to
update and forwards that information to D2 in the form of NCRs. Carrying
out the actual DNS updates and dealing with such things as conflict
resolution are within the purview of D2 itself
(see :ref:`dhcp-ddns-server`). This section describes when :iscman:`kea-dhcp6`
generates NCRs and the configuration parameters that can be used to
influence this decision. It assumes that the ``enable-updates``
parameter is ``true``.
.. note::
Currently the interface between :iscman:`kea-dhcp6` and D2 only supports
requests which update DNS entries for a single IP address. If a lease
grants more than one address, :iscman:`kea-dhcp6` creates the DDNS update
request for only the first of these addresses.
In general, :iscman:`kea-dhcp6` generates DDNS update requests when:
1. A new lease is granted in response to a DHCPREQUEST;
2. An existing lease is renewed but the FQDN associated with it has
changed; or
3. An existing lease is released in response to a DHCPRELEASE.
In the second case, lease renewal, two DDNS requests are issued: one
request to remove entries for the previous FQDN, and a second request to
add entries for the new FQDN. In the third case, a lease release - a
single DDNS request - to remove its entries will be made.
As for the first case, the decisions involved when granting a new lease are
more complex. When a new lease is granted, :iscman:`kea-dhcp6` generates a
DDNS update request only if the DHCPREQUEST contains the FQDN option
(code 39). By default, :iscman:`kea-dhcp6` respects the FQDN N and S flags
specified by the client as shown in the following table:
.. table:: Default FQDN flag behavior
+-----------------+-----------------+-----------------+-----------------+
| Client | Client Intent | Server Response | Server |
| Flags:N-S | | | Flags:N-S-O |
+=================+=================+=================+=================+
| 0-0 | Client wants to | Server | 1-0-0 |
| | do forward | generates | |
| | updates, server | reverse-only | |
| | should do | request | |
| | reverse updates | | |
+-----------------+-----------------+-----------------+-----------------+
| 0-1 | Server should | Server | 0-1-0 |
| | do both forward | generates | |
| | and reverse | request to | |
| | updates | update both | |
| | | directions | |
+-----------------+-----------------+-----------------+-----------------+
| 1-0 | Client wants no | Server does not | 1-0-0 |
| | updates done | generate a | |
| | | request | |
+-----------------+-----------------+-----------------+-----------------+
The first row in the table above represents "client delegation." Here
the DHCP client states that it intends to do the forward DNS updates and
the server should do the reverse updates. By default, :iscman:`kea-dhcp6`
honors the client's wishes and generates a DDNS request to D2 to update
only reverse DNS data. The parameter ``ddns-override-client-update`` can be
used to instruct the server to override client delegation requests. When
this parameter is ``true``, :iscman:`kea-dhcp6` disregards requests for client
delegation and generates a DDNS request to update both forward and
reverse DNS data. In this case, the N-S-O flags in the server's response
to the client will be 0-1-1 respectively.
(Note that the flag combination N=1, S=1 is prohibited according to `RFC
4702 <https://tools.ietf.org/html/rfc4702>`__. If such a combination is
received from the client, the packet will be dropped by :iscman:`kea-dhcp6`.)
To override client delegation, set the following values in the
configuration file:
::
"Dhcp6": {
"ddns-override-client-update": true,
...
}
The third row in the table above describes the case in which the client
requests that no DNS updates be done. The parameter
``ddns-override-no-update`` can be used to instruct the server to disregard
the client's wishes. When this parameter is ``true``, :iscman:`kea-dhcp6`
generates DDNS update requests to :iscman:`kea-dhcp-ddns` even if the client
requests that no updates be done. The N-S-O flags in the server's response to
the client will be 0-1-1.
To override client delegation, issue the following commands:
::
"Dhcp6": {
"ddns-override-no-update": true,
...
}
The :iscman:`kea-dhcp6` server always generates DDNS update requests if the
client request only contains the Host Name option. In addition, it includes
an FQDN option in the response to the client with the FQDN N-S-O flags
set to 0-1-0, respectively. The domain name portion of the FQDN option
is the name submitted to D2 in the DDNS update request.
.. _dhcpv6-fqdn-name-generation:
:iscman:`kea-dhcp6` Name Generation for DDNS Update Requests
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Each NameChangeRequest must of course include the fully qualified
domain name whose DNS entries are to be affected. :iscman:`kea-dhcp6` can be
configured to supply a portion or all of that name, based upon what it
receives from the client in the DHCPREQUEST.
The default rules for constructing the FQDN that will be used for DNS
entries are:
1. If the DHCPREQUEST contains the client FQDN option, take the
candidate name from there.
2. If the candidate name is a partial (i.e. unqualified) name, then add
a configurable suffix to the name and use the result as the FQDN.
3. If the candidate name provided is empty, generate an FQDN using a
configurable prefix and suffix.
4. If the client provides neither option, then take no DNS action.
These rules can be amended by setting the ``ddns-replace-client-name``
parameter, which provides the following modes of behavior:
- ``never`` - use the name the client sent. If the client sent no name,
do not generate one. This is the default mode.
- ``always`` - replace the name the client sent. If the client sent no
name, generate one for the client.
- ``when-present`` - replace the name the client sent. If the client
sent no name, do not generate one.
- ``when-not-present`` - use the name the client sent. If the client
sent no name, generate one for the client.
.. note::
In early versions of Kea, this parameter was a boolean and
permitted only values of ``true`` and ``false``.
Boolean values have been deprecated and are no longer accepted.
Administrators currently using booleans must replace them with the
desired mode name. A value of ``true`` maps to ``when-present``, while
``false`` maps to ``never``.
For example, to instruct :iscman:`kea-dhcp6` to always generate the FQDN for a
client, set the parameter ``ddns-replace-client-name`` to ``always`` as
follows:
::
"Dhcp6": {
"ddns-replace-client-name": "always",
...
}
The prefix used in the generation of an FQDN is specified by the
``ddns-generated-prefix`` parameter. The default value is "myhost". To alter
its value, simply set it to the desired string:
::
"Dhcp6": {
"ddns-generated-prefix": "another.host",
...
}
The suffix used when generating an FQDN, or when qualifying a partial
name, is specified by the ``ddns-qualifying-suffix`` parameter. This
parameter has no default value; thus, it is mandatory when DDNS updates
are enabled. To set its value simply set it to the desired string:
::
"Dhcp6": {
"ddns-qualifying-suffix": "foo.example.org",
...
}
When qualifying a partial name, :iscman:`kea-dhcp6` constructs the name in the
format:
``[candidate-name].[ddns-qualifying-suffix].``
where ``candidate-name`` is the partial name supplied in the DHCPREQUEST.
For example, if the FQDN domain name value is "some-computer" and the
``ddns-qualifying-suffix`` is "example.com", the generated FQDN is:
``some-computer.example.com.``
When generating the entire name, :iscman:`kea-dhcp6` constructs the name in
the format:
``[ddns-generated-prefix]-[address-text].[ddns-qualifying-suffix].``
where ``address-text`` is simply the lease IP address converted to a
hyphenated string. For example, if the lease address is 3001:1::70E, the
qualifying suffix is "example.com", and the default value is used for
``ddns-generated-prefix``, the generated FQDN is:
``myhost-3001-1--70E.example.com.``
.. _dhcp6-host-name-sanitization:
Sanitizing Client FQDN Names
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Some DHCP clients may provide values in the name
component of the FQDN option (option code 39) that contain undesirable
characters. It is possible to configure :iscman:`kea-dhcp6` to sanitize these
values. The most typical use case is ensuring that only characters that
are permitted by RFC 1035 be included: A-Z, a-z, 0-9, and "-". This may be
accomplished with the following two parameters:
- ``hostname-char-set`` - a regular expression describing the invalid
character set. This can be any valid, regular expression using POSIX
extended expression syntax. Embedded nulls (0x00) are always
considered an invalid character to be replaced (or omitted).
The default is ``"[^A-Za-z0-9.-]"``. This matches any character that is not
a letter, digit, dot, hyphen, or null.
- ``hostname-char-replacement`` - a string of zero or more characters
with which to replace each invalid character in the host name. An empty
string causes invalid characters to be OMITTED rather than replaced.
The default is ``""``.
The following configuration replaces anything other than a letter,
digit, dot, or hyphen with the letter "x":
::
"Dhcp6": {
"hostname-char-set": "[^A-Za-z0-9.-]",
"hostname-char-replacement": "x",
...
}
Thus, a client-supplied value of "myhost-$[123.org" would become
"myhost-xx123.org". Sanitizing is performed only on the portion of the
name supplied by the client, and it is performed before applying a
qualifying suffix (if one is defined and needed).
.. note::
Name sanitizing is meant to catch the more common cases of invalid
characters through a relatively simple character-replacement scheme.
It is difficult to devise a scheme that works well in all cases.
Administrators who find they have clients with odd corner cases of
character combinations that cannot be readily handled with this
mechanism should consider writing a hook that can carry out
sufficiently complex logic to address their needs.
Do not include dots in the ``hostname-char-set`` expression. When
scrubbing FQDNs, dots are treated as delimiters and used to separate
the option value into individual domain labels that are scrubbed and
then re-assembled.
If clients are sending values that differ only by characters
considered as invalid by the ``hostname-char-set``, be aware that
scrubbing them will yield identical values. In such cases, DDNS
conflict rules will permit only one of them to register the name.
Finally, given the latitude clients have in the values they send, it
is virtually impossible to guarantee that a combination of these two
parameters will always yield a name that is valid for use in DNS. For
example, using an empty value for ``hostname-char-replacement`` could
yield an empty domain label within a name, if that label consists
only of invalid characters.
.. note::
It is possible to specify ``hostname-char-set``
and/or ``hostname-char-replacement`` at the global scope. This allows
host names to be sanitized without requiring a ``dhcp-ddns`` entry. When
a ``hostname-char`` parameter is defined at both the global scope and
in a ``dhcp-ddns`` entry, the second (local) value is used.
.. _dhcp6-dhcp4o6-config:
DHCPv4-over-DHCPv6: DHCPv6 Side
-------------------------------
The support of DHCPv4-over-DHCPv6 transport is described in `RFC
7341 <https://tools.ietf.org/html/rfc7341>`__ and is implemented using
cooperating DHCPv4 and DHCPv6 servers. This section is about the
configuration of the DHCPv6 side (the DHCPv4 side is described in
:ref:`dhcp4-dhcp4o6-config`).
.. note::
DHCPv4-over-DHCPv6 support is experimental and the details of the
inter-process communication may change; for instance, the
support of port relay (RFC 8357) introduced an incompatible change.
Both the DHCPv4 and DHCPv6 sides should be running the same version of Kea.
There is only one specific parameter for the DHCPv6 side:
``dhcp4o6-port``, which specifies the first of the two consecutive ports
of the UDP sockets used for the communication between the DHCPv6 and
DHCPv4 servers. The DHCPv6 server is bound to ::1 on ``port`` and
connected to ::1 on ``port`` + 1.
Two other configuration entries are generally required: unicast traffic
support (see :ref:`dhcp6-unicast`) and the DHCP 4o6
server address option (name "dhcp4o6-server-addr", code 88).
ISC tested the following configuration:
::
{
# DHCPv6 conf
"Dhcp6": {
"interfaces-config": {
"interfaces": [ "eno33554984/2001:db8:1:1::1" ]
},
"lease-database": {
"type": "memfile",
"name": "leases6"
},
"preferred-lifetime": 3000,
"valid-lifetime": 4000,
"renew-timer": 1000,
"rebind-timer": 2000,
"subnet6": [ {
"id": 1,
"subnet": "2001:db8:1:1::/64",
"interface": "eno33554984",
"pools": [ { "pool": "2001:db8:1:1::1:0/112" } ]
} ],
"dhcp4o6-port": 6767,
"option-data": [ {
"name": "dhcp4o6-server-addr",
"code": 88,
"space": "dhcp6",
"csv-format": true,
"data": "2001:db8:1:1::1"
} ],
"loggers": [ {
"name": "kea-dhcp6",
"output_options": [ {
"output": "/tmp/kea-dhcp6.log"
} ],
"severity": "DEBUG",
"debuglevel": 0
} ]
}
}
.. note::
Relayed DHCPv4-QUERY DHCPv6 messages are not supported.
.. _sanity-checks6:
Sanity Checks in DHCPv6
-----------------------
An important aspect of a well-running DHCP system is an assurance that
the data remains consistent; however, in some cases it may be convenient
to tolerate certain inconsistent data. For example, a network
administrator who temporarily removes a subnet from a configuration
would not want all the leases associated with it to disappear from the
lease database. Kea has a mechanism to implement sanity checks for situations
like this.
Kea supports a configuration scope called ``sanity-checks``.
A parameter, called ``lease-checks``,
governs the verification carried out when a new lease is loaded from a
lease file. This mechanism permits Kea to attempt to correct inconsistent data.
Every subnet has a ``subnet-id`` value; this is how Kea internally
identifies subnets. Each lease has a ``subnet-id`` parameter as well, which
identifies the subnet it belongs to. However, if the configuration has
changed, it is possible that a lease could exist with a ``subnet-id`` but
without any subnet that matches it. Also, it is possible that the
subnet's configuration has changed and the ``subnet-id`` now belongs to a
subnet that does not match the lease.
Kea's corrective algorithm first
checks to see if there is a subnet with the ``subnet-id`` specified by the
lease. If there is, it verifies whether the lease belongs to that
subnet. If not, depending on the ``lease-checks`` setting, the lease is
discarded, a warning is displayed, or a new subnet is selected for the
lease that matches it topologically.
Since delegated prefixes do not have to belong to a subnet in which
they are offered, there is no way to implement such a mechanism for IPv6
prefixes. As such, the mechanism works for IPv6 addresses only.
There are five levels which are supported:
- ``none`` - do no special checks; accept the lease as is.
- ``warn`` - if problems are detected display a warning, but
accept the lease data anyway. This is the default value.
- ``fix`` - if a data inconsistency is discovered, try to
correct it. If the correction is not successful, insert the incorrect data
anyway.
- ``fix-del`` - if a data inconsistency is discovered, try to
correct it. If the correction is not successful, reject the lease.
This setting ensures the data's correctness, but some
incorrect data may be lost. Use with care.
- ``del`` - if any inconsistency is
detected, reject the lease. This is the strictest mode; use with care.
This feature is currently implemented for the memfile backend. The
sanity check applies to the lease database in memory, not to the lease file,
i.e. inconsistent leases will stay in the lease file.
An example configuration that sets this parameter looks as follows:
::
"Dhcp6": {
"sanity-checks": {
"lease-checks": "fix-del"
},
...
}
.. _store-extended-info-v6:
Storing Extended Lease Information
----------------------------------
To support such features as DHCPv6 Reconfigure
(`RFC 3315 <https://tools.ietf.org/html/rfc3315>`__) and Leasequery
(`RFC 5007 <https://tools.ietf.org/html/rfc5007>`__),
additional information must be stored with each lease. Because the amount
of information stored for each lease has ramifications in terms of
performance and system resource consumption, storage of this additional
information is configurable through the ``store-extended-info`` parameter.
It defaults to ``false`` and may be set at the global, shared-network, and
subnet levels.
::
"Dhcp6": {
"store-extended-info": true,
...
}
When set to ``true``, information relevant to the DHCPv6 query (e.g. REQUEST, RENEW,
or REBIND) asking for the lease is added into the lease's ``user-context`` as a
map element labeled "ISC". Currently, the information contained in the map
is a list of relays, one for each relay message layer that encloses the
client query. The lease's
``user-context`` for a two-hop query might look something like this (shown
pretty-printed for clarity):
::
{
"ISC": {
"relay-info": [
{
"hop": 3,
"link": "2001:db8::1",
"peer": "2001:db8::2"
},
{
"hop": 2,
"link": "2001:db8::3",
"options": "0x00C800080102030405060708",
"peer": "2001:db8::4"
},
{
"hop": 1,
"link": "2001:db8::5",
"options": "0x00250006010203040506003500086464646464646464",
"remote-id": "010203040506",
"relay-id": "6464646464646464"
}
]
}
}
.. note::
Prior to Kea version 2.3.2, this entry was named ``relays``; remote and relay
identifier options were not decoded.
.. note::
It is possible that other hook libraries are already using
``user-context``. Enabling ``store-extended-info`` should not interfere with
any other ``user-context`` content, as long as it does not also use an element
labeled "ISC". In other words, ``user-context`` is intended to be a flexible
container serving multiple purposes. As long as no other purpose also
writes an "ISC" element to ``user-context`` there should not be a conflict.
Extended lease information is also subject to configurable sanity checking.
The parameter in the ``sanity-checks`` scope is named ``extended-info-checks``
and supports these levels:
- ``none`` - do no check nor upgrade. This level should be used only when
extended info is not used at all or when no badly formatted extended
info, including using the old format, is expected.
- ``fix`` - fix some common inconsistencies and upgrade extended info
using the old format to the new one. It is the default level and is
convenient when the Leasequery hook library is not loaded.
- ``strict`` - fix all inconsistencies which have an impact on the (Bulk)
Leasequery hook library.
- ``pedantic`` - enforce full conformance to the format produced by the
Kea code; for instance, no extra entries are allowed with the exception
of ``comment``.
.. note::
This feature is currently implemented only for the memfile
backend. The sanity check applies to the lease database in memory,
not to the lease file, i.e. inconsistent leases stay in the lease
file.
.. _dhcp6-multi-threading-settings:
Multi-Threading Settings
------------------------
The Kea server can be configured to process packets in parallel using multiple
threads. These settings can be found under the ``multi-threading`` structure and are
represented by:
- ``enable-multi-threading`` - use multiple threads to process packets in
parallel. The default is ``true``.
- ``thread-pool-size`` - specify the number of threads to process packets in
parallel. It may be set to ``0`` (auto-detect), or any positive number that
explicitly sets the thread count. The default is ``0``.
- ``packet-queue-size`` - specify the size of the queue used by the thread
pool to process packets. It may be set to ``0`` (unlimited), or any positive
number that explicitly sets the queue size. The default is ``64``.
An example configuration that sets these parameters looks as follows:
::
"Dhcp6": {
"multi-threading": {
"enable-multi-threading": true,
"thread-pool-size": 4,
"packet-queue-size": 16
},
...
}
Multi-Threading Settings With Different Database Backends
---------------------------------------------------------
The Kea DHCPv6 server is benchmarked by ISC to determine which settings
give the best performance. Although this section describes our results, they are merely
recommendations and are very dependent on the particular hardware used
for benchmarking. We strongly advise that administrators run their own performance benchmarks.
A full report of performance results for the latest stable Kea version can be found
`here <https://reports.kea.isc.org/>`_.
This includes hardware and benchmark scenario descriptions, as well as
current results.
After enabling multi-threading, the number of threads is set by the ``thread-pool-size``
parameter. Results from our experiments show that the best settings for
:iscman:`kea-dhcp6` are:
- ``thread-pool-size``: 4 when using ``memfile`` for storing leases.
- ``thread-pool-size``: 12 or more when using ``mysql`` for storing leases.
- ``thread-pool-size``: 6 when using ``postgresql``.
Another very important parameter is ``packet-queue-size``; in our benchmarks we
used it as a multiplier of ``thread-pool-size``. The actual setting strongly depends
on ``thread-pool-size``.
We saw the best results in our benchmarks with the following settings:
- ``packet-queue-size``: 150 * ``thread-pool-size`` when using ``memfile`` for
storing leases; in our case it was 150 * 4 = 600. This means that at any given
time, up to 600 packets could be queued.
- ``packet-queue-size``: 200 * ``thread-pool-size`` when using ``mysql`` for
storing leases; in our case it was 200 * 12 = 2400. This means that up to
2400 packets could be queued.
- ``packet-queue-size``: 11 * ``thread-pool-size`` when using ``postgresql`` for
storing leases; in our case it was 11 * 6 = 66.
Lease Caching
-------------
Clients that attempt multiple renewals in a short period can cause the server to update
and write to the database frequently, resulting in a performance impact
on the server. The cache parameters instruct the DHCP server to avoid
updating leases too frequently, thus avoiding this behavior. Instead,
the server assigns the same lease (i.e. reuses it) with no
modifications except for CLTT (Client Last Transmission Time), which
does not require disk operations.
The two parameters are the ``cache-threshold`` double and the
``cache-max-age`` integer; they have no default setting, i.e. the lease caching
feature must be explicitly enabled. These parameters can be configured
at the global, shared-network, and subnet levels. The subnet level has
the precedence over the shared-network level, while the global level is used
as a last resort. For example:
::
{
"subnet6": [
{
"subnet": "2001:db8:1:1::/64",
"pools": [ { "pool": "2001:db8:1:1::1:0/112" } ],
"cache-threshold": .25,
"cache-max-age": 600,
"valid-lifetime": 2000,
...
}
],
...
}
When an already-assigned lease can fulfill a client query:
- any important change, e.g. for DDNS parameter, hostname, or
preferred or valid lifetime reduction, makes the lease not reusable.
- lease age, i.e. the difference between the creation or last modification
time and the current time, is computed (elapsed duration).
- if ``cache-max-age`` is explicitly configured, it is compared with the lease age;
leases that are too old are not reusable. This means that the value 0
for ``cache-max-age`` disables the lease cache feature.
- if ``cache-threshold`` is explicitly configured and is between 0.0 and 1.0,
it expresses the percentage of the lease valid lifetime which is
allowed for the lease age. Values below and including 0.0 and
values greater than 1.0 disable the lease cache feature.
In our example, a lease with a valid lifetime of 2000 seconds can be
reused if it was committed less than 500 seconds ago. With a lifetime
of 3000 seconds, a maximum age of 600 seconds applies.
In outbound client responses (e.g. DHCPV6_REPLY messages), the used
preferred and valid lifetimes are the reusable values, i.e. the
expiration dates do not change.
.. _host-reservation-v6:
Host Reservations in DHCPv6
===========================
There are many cases where it is useful to provide a configuration on a
per-host basis. The most obvious one is to reserve a specific, static
IPv6 address or/and prefix for exclusive use by a given client (host);
the returning client receives the same address and/or prefix every time,
and other clients will never get that address. Host
reservations are also convenient when a host has specific requirements,
e.g. a printer that needs additional DHCP options or a cable modem that
needs specific parameters. Yet another possible use case is to define
unique names for hosts.
There may be cases when a new reservation has been made for a
client for an address or prefix currently in use by another client. We
call this situation a "conflict." These conflicts get resolved
automatically over time, as described in subsequent sections. Once a
conflict is resolved, the correct client will receive the reserved
configuration when it renews.
Host reservations are defined as parameters for each subnet. Each host
must be identified by either DUID or its hardware/MAC address; see
:ref:`mac-in-dhcpv6` for details. There
is an optional ``reservations`` array in the ``subnet6`` structure; each
element in that array is a structure that holds information about reservations for a
single host. In particular, the structure has an identifier that
uniquely identifies a host. In the DHCPv6 context, the identifier is
usually a DUID, but it can also be a hardware or MAC address. One or more
addresses or prefixes may also be specified, and it is possible to
specify a hostname and DHCPv6 options for a given host.
.. note::
The reserved address must be within the subnet.
This does not apply to reserved prefixes.
The following example shows how to reserve addresses and prefixes for
specific hosts:
::
{
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/48",
"pools": [ { "pool": "2001:db8:1::/80" } ],
"pd-pools": [
{
"prefix": "2001:db8:1:8000::",
"prefix-len": 56,
"delegated-len": 64
}
],
"reservations": [
{
"duid": "01:02:03:04:05:0A:0B:0C:0D:0E",
"ip-addresses": [ "2001:db8:1::100" ]
},
{
"hw-address": "00:01:02:03:04:05",
"ip-addresses": [ "2001:db8:1::101", "2001:db8:1::102" ]
},
{
"duid": "01:02:03:04:05:06:07:08:09:0A",
"ip-addresses": [ "2001:db8:1::103" ],
"prefixes": [ "2001:db8:2:abcd::/64" ],
"hostname": "foo.example.com"
}
]
}
],
...
}
This example includes reservations for three different clients. The
first reservation is for the address 2001:db8:1::100, for a client using
DUID 01:02:03:04:05:0A:0B:0C:0D:0E. The second reservation is for two
addresses, 2001:db8:1::101 and 2001:db8:1::102, for a client using MAC
address 00:01:02:03:04:05. Lastly, address 2001:db8:1::103 and prefix
2001:db8:2:abcd::/64 are reserved for a client using DUID
01:02:03:04:05:06:07:08:09:0A. The last reservation also assigns a
hostname to this client.
DHCPv6 allows a single client to lease multiple addresses and
multiple prefixes at the same time. Therefore ``ip-addresses`` and
``prefixes`` are plural and are actually arrays. When the client sends
multiple IA options (IA_NA or IA_PD), each reserved address or prefix is
assigned to an individual IA of the appropriate type. If the number of
IAs of a specific type is lower than the number of reservations of that
type, the number of reserved addresses or prefixes assigned to the
client is equal to the number of IA_NAs or IA_PDs sent by the client;
that is, some reserved addresses or prefixes are not assigned. However,
they still remain reserved for this client and the server will not
assign them to any other client. If the number of IAs of a specific type
sent by the client is greater than the number of reserved addresses or
prefixes, the server will try to assign all reserved addresses or
prefixes to the individual IAs and dynamically allocate addresses or
prefixes to the remaining IAs. If the server cannot assign a reserved
address or prefix because it is in use, the server will select the next
reserved address or prefix and try to assign it to the client. If the
server subsequently finds that there are no more reservations that can
be assigned to the client at that moment, the server will try to assign
leases dynamically.
Making a reservation for a mobile host that may visit multiple subnets
requires a separate host definition in each subnet that host is expected to
visit. It is not possible to define multiple host definitions with the
same hardware address in a single subnet. Multiple host definitions with
the same hardware address are valid if each is in a different subnet.
The reservation for a given host should include only one identifier,
either DUID or hardware address; defining both for the same host is
considered a configuration error.
Adding host reservations incurs a performance penalty. In principle,
when a server that does not support host reservation responds to a
query, it needs to check whether there is a lease for a given address
being considered for allocation or renewal. The server that does
support host reservation has to perform additional checks: not only
whether the address is currently used (i.e., if there is a lease for
it), but also whether the address could be used by someone else (i.e.,
if there is a reservation for it). That additional check incurs extra
overhead.
.. _reservation6-types:
Address/Prefix Reservation Types
--------------------------------
In a typical Kea scenario there is an IPv6 subnet defined, with a certain
part of it dedicated for dynamic address allocation by the DHCPv6
server. There may be an additional address space defined for prefix
delegation. Those dynamic parts are referred to as dynamic pools,
address and prefix pools, or simply pools. In principle, a host
reservation can reserve any address or prefix that belongs to the
subnet. The reservations that specify addresses that belong to
configured pools are called "in-pool reservations." In contrast, those
that do not belong to dynamic pools are called "out-of-pool
reservations." There is no formal difference in the reservation syntax
and both reservation types are handled uniformly.
Kea supports global host reservations. These are reservations that are
specified at the global level within the configuration and that do not
belong to any specific subnet. Kea still matches inbound client
packets to a subnet as before, but when the subnet's reservation mode is
set to "global", Kea looks for host reservations only among the
global reservations defined. Typically, such reservations would be used
to reserve hostnames for clients which may move from one subnet to
another.
.. note::
Global reservations, while useful in certain circumstances, have aspects
that must be given due consideration when using them. Please see
:ref:`reservation6-conflict` for more details.
.. note::
Since Kea 1.9.1, reservation mode has been replaced by three
boolean flags, ``reservations-global``, ``reservations-in-subnet``
and ``reservations-out-of-pool``, which allow the configuration of
host reservations both globally and in a subnet. In such cases a subnet
host reservation has preference over a global reservation
when both exist for the same client.
.. _reservation6-conflict:
Conflicts in DHCPv6 Reservations
--------------------------------
As reservations and lease information are stored separately, conflicts
may arise. Consider the following series of events: the server has
configured the dynamic pool of addresses from the range of 2001:db8::10
to 2001:db8::20. Host A requests an address and gets 2001:db8::10. Now
the system administrator decides to reserve address 2001:db8::10 for
Host B. In general, reserving an address that is currently assigned to
someone else is not recommended, but there are valid use cases where
such an operation is warranted.
The server now has a conflict to resolve. If Host B boots up and
requests an address, the server cannot immediately assign the reserved
address 2001:db8::10. A naive approach would to be immediately remove
the lease for Host A and create a new one for Host B. That would not
solve the problem, though, because as soon as Host B gets the address,
it will detect that the address is already in use (by Host
A) and will send a DHCPDECLINE message. Therefore, in this situation,
the server has to temporarily assign a different address from the
dynamic pool (not matching what has been reserved) to Host B.
When Host A renews its address, the server will discover that the
address being renewed is now reserved for someone else - Host B.
The server will remove the lease for 2001:db8::10, select a
new address, and create a new lease for it. It will send two addresses
in its response: the old address, with the lifetime set to 0 to explicitly
indicate that it is no longer valid; and the new address, with a
non-zero lifetime. When Host B tries to renew its temporarily assigned address,
the server will detect that the existing lease does not match the
reservation, so it will release the current address Host B has and will
create a new lease matching the reservation. As before, the server will
send two addresses: the temporarily assigned one with a zero lifetime,
and the new one that matches the reservation with the proper lifetime set.
This recovery will succeed, even if other hosts attempt to get the
reserved address. If Host C requests the address 2001:db8::10 after the
reservation is made, the server will propose a different address.
This recovery mechanism allows the server to fully recover from a case
where reservations conflict with existing leases; however, this procedure
takes roughly as long as the value set for ``renew-timer``. The
best way to avoid such a recovery is not to define new reservations that
conflict with existing leases. Another recommendation is to use
out-of-pool reservations; if the reserved address does not belong to a
pool, there is no way that other clients can get it.
.. note::
The conflict-resolution mechanism does not work for global
reservations. Although the global address reservations feature may be useful
in certain settings, it is generally recommended not to use
global reservations for addresses. Administrators who do choose
to use global reservations must manually ensure that the reserved
addresses are not in dynamic pools.
.. _reservation6-hostname:
Reserving a Hostname
--------------------
When the reservation for a client includes the ``hostname``, the server
assigns this hostname to the client and sends it back in the Client
FQDN option, if the client included the Client FQDN option in its message
to the server. The reserved hostname always takes precedence over the
hostname supplied by the client (via the FQDN option) or the autogenerated
(from the IPv6 address) hostname.
The server qualifies the reserved hostname with the value of the
``ddns-qualifying-suffix`` parameter. For example, the following subnet
configuration:
::
{
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/48",
"pools": [ { "pool": "2001:db8:1::/80" } ],
"ddns-qualifying-suffix": "example.isc.org.",
"reservations": [
{
"duid": "01:02:03:04:05:0A:0B:0C:0D:0E",
"ip-addresses": [ "2001:db8:1::100" ],
"hostname": "alice-laptop"
}
]
}
],
"dhcp-ddns": {
"enable-updates": true
},
...
}
will result the "alice-laptop.example.isc.org." hostname being assigned to
the client using the DUID "01:02:03:04:05:0A:0B:0C:0D:0E". If the
``ddns-qualifying-suffix`` is not specified, the default (empty) value will
be used, and in this case the value specified as a ``hostname`` will be
treated as a fully qualified name. Thus, by leaving the
``ddns-qualifying-suffix`` empty it is possible to qualify hostnames for
different clients with different domain names:
.. code-block:: json
{
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/48",
"pools": [ { "pool": "2001:db8:1::/80" } ],
"reservations": [
{
"duid": "01:02:03:04:05:0A:0B:0C:0D:0E",
"ip-addresses": [ "2001:db8:1::100" ],
"hostname": "mark-desktop.example.org."
}
]
}
],
"dhcp-ddns": {
"enable-updates": true
}
}
The above example results in the assignment of the
"mark-desktop.example.org." hostname to the client using the DUID
"01:02:03:04:05:0A:0B:0C:0D:0E".
.. _reservation6-options:
Including Specific DHCPv6 Options in Reservations
-------------------------------------------------
Kea offers the ability to specify options on a per-host basis. These
options follow the same rules as any other options. These can be
standard options (see :ref:`dhcp6-std-options`),
custom options (see :ref:`dhcp6-custom-options`),
or vendor-specific options (see :ref:`dhcp6-vendor-opts`). The following
example demonstrates how standard options can be defined.
::
{
"reservations": [
{
"duid": "01:02:03:05:06:07:08",
"ip-addresses": [ "2001:db8:1::2" ],
"option-data": [
{
"name": "dns-servers",
"data": "3000:1::234"
},
{
"name": "nis-servers",
"data": "3000:1::234"
},
...
],
...
},
...
],
...
}
Vendor-specific options can be reserved in a similar manner:
::
{
"reservations": [
{
"duid": "aa:bb:cc:dd:ee:ff",
"ip-addresses": [ "2001:db8::1" ],
"option-data": [
{
"name": "vendor-opts",
"data": 4491
},
{
"name": "tftp-servers",
"space": "vendor-4491",
"data": "3000:1::234"
},
...
],
...
},
...
],
...
}
Options defined at the host level have the highest priority. In other words,
if there are options defined with the same type on global, subnet,
class, and host levels, the host-specific values are used.
.. _reservation6-client-classes:
Reserving Client Classes in DHCPv6
----------------------------------
:ref:`classification-using-expressions` explains how to configure
the server to assign classes to a client, based on the content of the
options that this client sends to the server. Host reservation
mechanisms also allow for the static assignment of classes to clients.
The definitions of these classes are placed in the Kea configuration file or
a database. The following configuration snippet shows how to specify that
a client belongs to the classes ``reserved-class1`` and ``reserved-class2``. Those
classes are associated with specific options sent to the clients which belong
to them.
::
{
"client-classes": [
{
"name": "reserved-class1",
"option-data": [
{
"name": "dns-servers",
"data": "2001:db8:1::50"
}
]
},
{
"name": "reserved-class2",
"option-data": [
{
"name": "nis-servers",
"data": "2001:db8:1::100"
}
]
}
],
"subnet6": [
{
"id": 1,
"pools": [ { "pool": "2001:db8:1::/64" } ],
"subnet": "2001:db8:1::/48",
"reservations": [
{
"duid": "01:02:03:04:05:06:07:08",
"client-classes": [ "reserved-class1", "reserved-class2" ]
}
]
} ]
}
In some cases the host reservations can be used in conjunction with client
classes specified within the Kea configuration. In particular, when a
host reservation exists for a client within a given subnet, the "KNOWN"
built-in class is assigned to the client. Conversely, when there is no
static assignment for the client, the "UNKNOWN" class is assigned to the
client. Class expressions within the Kea configuration file can
refer to "KNOWN" or "UNKNOWN" classes using the "member" operator.
For example:
::
{
"client-classes": [
{
"name": "dependent-class",
"test": "member('KNOWN')",
"only-if-required": true
}
]
}
The ``only-if-required`` parameter is needed here to force
evaluation of the class after the lease has been allocated and thus the
reserved class has been also assigned.
.. note::
The classes specified in non-global host reservations
are assigned to the processed packet after all classes with the
``only-if-required`` parameter set to ``false`` have been evaluated.
This means that these classes must not depend on the
statically assigned classes from the host reservations. If
such a dependency is needed, the ``only-if-required`` must
be set to ``true`` for the dependent classes. Such classes are
evaluated after the static classes have been assigned to the packet.
This, however, imposes additional configuration overhead, because
all classes marked as ``only-if-required`` must be listed in the
``require-client-classes`` list for every subnet where they are used.
.. note::
Client classes specified within the Kea configuration file may
depend on the classes specified within the global host reservations.
In such a case the ``only-if-required`` parameter is not needed.
Refer to the :ref:`pool-selection-with-class-reservations6` and
:ref:`subnet-selection-with-class-reservations6`
for specific use cases.
.. _reservations6-mysql-pgsql:
Storing Host Reservations in MySQL or PostgreSQL
------------------------------------------------
Kea can store host reservations in MySQL or PostgreSQL.
See :ref:`hosts6-storage` for information on how to
configure Kea to use reservations stored in MySQL or PostgreSQL.
Kea provides a dedicated hook for managing reservations in a
database; section :ref:`hooks-host-cmds` provides detailed information.
The `Kea wiki
<https://gitlab.isc.org/isc-projects/kea/wikis/designs/commands#23-host-reservations-hr-management>`__
provides some examples of how to conduct common host reservation
operations.
.. note::
In Kea, the maximum length of an option specified per-host is
arbitrarily set to 4096 bytes.
.. _reservations6-tuning:
Fine-Tuning DHCPv6 Host Reservation
-----------------------------------
The host reservation capability introduces additional restrictions for
the allocation engine (the component of Kea that selects an address for
a client) during lease selection and renewal. In particular, three major
checks are necessary. First, when selecting a new lease, it is not
sufficient for a candidate lease to simply not be in use by another DHCP
client; it also must not be reserved for another client. Similarly, when
renewing a lease, an additional check must be performed to see whether
the address being renewed is reserved for another client. Finally, when
a host renews an address or a prefix, the server must check whether
there is a reservation for this host, which would mean the existing (dynamically
allocated) address should be revoked and the reserved one be used
instead.
Some of those checks may be unnecessary in certain deployments, and not
performing them may improve performance. The Kea server provides the
``reservation-mode`` configuration parameter to select the types of
reservations allowed for a particular subnet. Each reservation type has
different constraints for the checks to be performed by the server when
allocating or renewing a lease for the client. Allowed values are:
- ``all`` - enables both in-pool and out-of-pool host reservation
types. This setting is the default value, and is the safest and most
flexible. However, as all checks are conducted, it is also the slowest.
It does not check against global reservations.
- ``out-of-pool`` - allows only out-of-pool host reservations. With
this setting in place, the server assumes that all host
reservations are for addresses that do not belong to the dynamic
pool. Therefore, it can skip the reservation checks when dealing with
in-pool addresses, thus improving performance. Do not use this mode
if any reservations use in-pool addresses. Caution is advised
when using this setting; Kea does not sanity-check the reservations
against ``reservation-mode`` and misconfiguration may cause problems.
- ``global`` - allows only global host reservations. With this setting
in place, the server searches for reservations for a client only
among the defined global reservations. If an address is specified,
the server skips the reservation checks carried out in
other modes, thus improving performance. Caution is advised when
using this setting; Kea does not sanity-check the reservations when
``global`` is set, and misconfiguration may cause problems.
- ``disabled`` - host reservation support is disabled. As there are no
reservations, the server skips all checks. Any reservations
defined are completely ignored. As checks are skipped, the
server may operate faster in this mode.
Since Kea 1.9.1, the ``reservation-mode`` parameter is replaced by the
``reservations-global``, ``reservations-in-subnet`` and
``reservations-out-of-pool`` flags.
The flags can be activated independently and can produce various combinations,
some of them being unsupported by the deprecated ``reservation-mode``.
The ``reservation-mode`` parameter can be specified at:
- global level: ``.Dhcp6["reservation-mode"]`` (lowest priority: gets overridden
by all others)
- subnet level: ``.Dhcp6.subnet6[]["reservation-mode"]`` (low priority)
- shared-network level: ``.Dhcp6["shared-networks"][]["reservation-mode"]``
(high priority)
- shared-network subnet-level:
``.Dhcp6["shared-networks"][].subnet6[]["reservation-mode"]`` (highest
priority: overrides all others)
To decide which ``"reservation-mode"`` to choose, the
following decision diagram may be useful:
::
O
|
v
+-----------------------------+------------------------------+
| Is per-host configuration needed, such as |
| reserving specific addresses, |
| assigning specific options or |
| assigning packets to specific classes on per-device basis? |
+-+-----------------+----------------------------------------+
| |
no| yes|
| | +--------------------------------------+
| | | For all given hosts, |
+--> "disabled" +-->+ can the reserved resources |
| be used in all configured subnets? |
+--------+---------------------------+-+
| |
+----------------------------+ |no |yes
| Is | | |
| at least one reservation +<--+ "global" <--+
| used to reserve addresses |
| or prefixes? |
+-+------------------------+-+
| |
no| yes| +---------------------------+
| | | Is high leases-per-second |
+--> "out-of-pool" +-->+ performance or efficient |
^ | resource usage |
| | (CPU ticks, RAM usage, |
| | database roundtrips) |
| | important to your setup? |
| +-+----------------+--------+
| | |
| yes| no|
| | |
| +-------------+ |
| | |
| | +----------------------+ |
| | | Can it be guaranteed | |
| +-->+ that the reserved | |
| | addresses/prefixes | |
| | aren't part of the | |
| | pools configured | |
| | in the respective | |
| | subnet? | |
| +-+------------------+-+ |
| | | |
| yes| no| |
| | | V
+----------------+ +--> "all"
An example configuration that disables reservations looks as follows:
.. code-block:: json
{
"Dhcp6": {
"subnet6": [
{
"id": 1,
"pools": [
{
"pool": "2001:db8:1::-2001:db8:1::100"
}
],
"reservation-mode": "disabled",
"subnet": "2001:db8:1::/64"
}
]
}
}
An example configuration using global reservations is shown below:
.. code-block:: json
{
"Dhcp6": {
"reservation-mode": "global",
"reservations": [
{
"duid": "00:03:00:01:11:22:33:44:55:66",
"hostname": "host-one"
},
{
"duid": "00:03:00:01:99:88:77:66:55:44",
"hostname": "host-two"
}
],
"subnet6": [
{
"id": 1,
"pools": [
{
"pool": "2001:db8:1::-2001:db8:1::100"
}
],
"subnet": "2001:db8:1::/64"
}
]
}
}
The meaning of the reservation flags are:
- ``reservations-global``: fetch global reservations.
- ``reservations-in-subnet``: fetch subnet reservations. For a shared network
this includes all subnet members of the shared network.
- ``reservations-out-of-pool``: this makes sense only when the
``reservations-in-subnet`` flag is ``true``. When ``reservations-out-of-pool``
is ``true``, the server assumes that all host reservations are for addresses
that do not belong to the dynamic pool. Therefore, it can skip the reservation
checks when dealing with in-pool addresses, thus improving performance.
The server will not assign reserved addresses that are inside the dynamic
pools to the respective clients. This also means that the addresses matching
the respective reservations from inside the dynamic pools (if any) can be
dynamically assigned to any client.
The ``disabled`` value from the deprecated ``reservation-mode`` corresponds to:
.. code-block:: json
{
"Dhcp6": {
"reservations-global": false,
"reservations-in-subnet": false
}
}
The ``global`` value from the deprecated ``reservation-mode`` corresponds to:
.. code-block:: json
{
"Dhcp6": {
"reservations-global": true,
"reservations-in-subnet": false
}
}
The ``out-of-pool`` value from the deprecated ``reservation-mode`` corresponds to:
.. code-block:: json
{
"Dhcp6": {
"reservations-global": false,
"reservations-in-subnet": true,
"reservations-out-of-pool": true
}
}
And the ``all`` value from the deprecated ``reservation-mode`` corresponds to:
.. code-block:: json
{
"Dhcp6": {
"reservations-global": false,
"reservations-in-subnet": true,
"reservations-out-of-pool": false
}
}
To activate both ``global`` and ``all``, the following combination can be used:
.. code-block:: json
{
"Dhcp6": {
"reservations-global": true,
"reservations-in-subnet": true,
"reservations-out-of-pool": false
}
}
To activate both ``global`` and ``out-of-pool``, the following combination can
be used:
.. code-block:: json
{
"Dhcp6": {
"reservations-global": true,
"reservations-in-subnet": true,
"reservations-out-of-pool": true
}
}
Enabling ``out-of-pool`` and disabling ``in-subnet`` at the same time
is not recommended because ``out-of-pool`` applies to host reservations in a
subnet, which are fetched only when the ``in-subnet`` flag is ``true``.
The parameter can be specified at the global, subnet, and shared-network
levels.
An example configuration that disables reservations looks as follows:
.. code-block:: json
{
"Dhcp6": {
"subnet6": [
{
"reservations-global": false,
"reservations-in-subnet": false,
"subnet": "2001:db8:1::/64",
"id": 1
}
]
}
}
An example configuration using global reservations is shown below:
.. code-block:: json
{
"Dhcp6": {
"reservations": [
{
"duid": "00:03:00:01:11:22:33:44:55:66",
"hostname": "host-one"
},
{
"duid": "00:03:00:01:99:88:77:66:55:44",
"hostname": "host-two"
}
],
"reservations-global": true,
"reservations-in-subnet": false,
"subnet6": [
{
"pools": [
{
"pool": "2001:db8:1::-2001:db8:1::100"
}
],
"subnet": "2001:db8:1::/64",
"id": 1
}
]
}
}
For more details regarding global reservations, see :ref:`global-reservations6`.
Another aspect of host reservations is the different types of
identifiers. Kea currently supports two types of identifiers in DHCPv6:
hardware address and DUID. This is beneficial from a usability
perspective; however, there is one drawback. For each incoming packet
Kea has to extract each identifier type and then query the database
to see if there is a reservation by this particular identifier. If
nothing is found, the next identifier is extracted and the next query is
issued. This process continues until either a reservation is found or
all identifier types have been checked. Over time, with an increasing
number of supported identifier types, Kea would become slower and
slower.
To address this problem, a parameter called
``host-reservation-identifiers`` is available. It takes a list of
identifier types as a parameter. Kea checks only those identifier
types enumerated in ``host-reservation-identifiers``. From a performance
perspective, the number of identifier types should be kept to a minimum,
ideally one. If the deployment uses several reservation types, please
enumerate them from most- to least-frequently used, as this increases
the chances of Kea finding the reservation using the fewest queries. An
example of a ``host-reservation-identifiers`` configuration looks as follows:
::
{
"host-reservation-identifiers": [ "duid", "hw-address" ],
"subnet6": [
{
"subnet": "2001:db8:1::/64",
...
}
],
...
}
If not specified, the default value is:
::
"host-reservation-identifiers": [ "hw-address", "duid" ]
.. _global-reservations6:
Global Reservations in DHCPv6
-----------------------------
In some deployments, such as mobile, clients can roam within the network
and certain parameters must be specified regardless of the client's
current location. To meet such a need, Kea offers a global reservation
mechanism. The idea behind it is that regular host
reservations are tied to specific subnets, by using a specific
subnet ID. Kea can specify a global reservation that can be used in
every subnet that has global reservations enabled.
This feature can be used to assign certain parameters, such as hostname
or other dedicated, host-specific options. It can also be used to assign
addresses or prefixes.
An address assigned via global host reservation must be feasible for the
subnet the server selects for the client. In other words, the address must
lie within the subnet; otherwise, it is ignored and the server will
attempt to dynamically allocate an address. If the selected subnet
belongs to a shared network, the server checks for feasibility against
the subnet's siblings, selecting the first in-range subnet. If no such
subnet exists, the server falls back to dynamically allocating the address.
This does not apply to globally reserved prefixes.
.. note::
Prior to release 2.3.5, the server did not perform feasibility checks on
globally reserved addresses, which allowed the server to be configured to
hand out nonsensical leases for arbitrary address values. Later versions
of Kea perform these checks.
To use global host reservations, a configuration similar to the
following can be used:
::
"Dhcp6": {
# This specifies global reservations.
# They will apply to all subnets that
# have global reservations enabled.
"reservations": [
{
"hw-address": "aa:bb:cc:dd:ee:ff",
"hostname": "hw-host-dynamic"
},
{
"hw-address": "01:02:03:04:05:06",
"hostname": "hw-host-fixed",
# Use of IP addresses in global reservations is risky.
# If used outside of matching subnet, such as 3001::/64,
# it will result in a broken configuration being handed
# to the client.
"ip-address": "2001:db8:ff::77"
},
{
"duid": "01:02:03:04:05",
"hostname": "duid-host"
}
],
"valid-lifetime": 600,
"subnet4": [ {
"subnet": "2001:db8:1::/64",
# It is replaced by the "reservations-global",
# "reservations-in-subnet", and "reservations-out-of-pool"
# parameters.
# "reservation-mode": "global",
# Specify if the server should look up global reservations.
"reservations-global": true,
# Specify if the server should look up in-subnet reservations.
"reservations-in-subnet": false,
# Specify if the server can assume that all reserved addresses
# are out-of-pool. It can be ignored because "reservations-in-subnet"
# is false.
# "reservations-out-of-pool": false,
"pools": [ { "pool": "2001:db8:1::-2001:db8:1::100" } ]
} ]
}
When using database backends, the global host reservations are
distinguished from regular reservations by using a ``subnet-id`` value of
0.
.. _pool-selection-with-class-reservations6:
Pool Selection with Client Class Reservations
---------------------------------------------
Client classes can be specified both in the Kea configuration file and/or
via host reservations. The classes specified in the Kea configuration file are
evaluated immediately after receiving the DHCP packet and therefore can be
used to influence subnet selection using the ``client-class`` parameter
specified in the subnet scope. The classes specified within the host
reservations are fetched and assigned to the packet after the server has
already selected a subnet for the client. This means that the client
class specified within a host reservation cannot be used to influence
subnet assignment for this client, unless the subnet belongs to a
shared network. If the subnet belongs to a shared network, the server may
dynamically change the subnet assignment while trying to allocate a lease.
If the subnet does not belong to a shared network, once selected, the subnet
is not changed once selected.
If the subnet does not belong to a shared network, it is possible to
use host reservation-based client classification to select an address pool
within the subnet as follows:
::
"Dhcp6": {
"client-classes": [
{
"name": "reserved_class"
},
{
"name": "unreserved_class",
"test": "not member('reserved_class')"
}
],
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/64",
"reservations": [
{
"hw-address": "aa:bb:cc:dd:ee:fe",
"client-classes": [ "reserved_class" ]
}
],
"pools": [
{
"pool": "2001:db8:1::10-2001:db8:1::20",
"client-class": "reserved_class"
},
{
"pool": "2001:db8:1::30-2001:db8:1::40",
"client-class": "unreserved_class"
}
]
}
]
}
The ``reserved_class`` is declared without the ``test`` parameter because
it may be only assigned to the client via host reservation mechanism. The
second class, ``unreserved_class``, is assigned to clients which do not
belong to the ``reserved_class``. The first pool within the subnet is only
used for clients having a reservation for the ``reserved_class``. The
second pool is used for clients not having such a reservation. The
configuration snippet includes one host reservation which causes the client
with the MAC address aa:bb:cc:dd:ee:fe to be assigned to the
``reserved_class``. Thus, this client will be given an IP address from the
first address pool.
.. _subnet-selection-with-class-reservations6:
Subnet Selection with Client Class Reservations
-----------------------------------------------
There is one specific use case when subnet selection may be influenced by
client classes specified within host reservations: when the
client belongs to a shared network. In such a case it is possible to use
classification to select a subnet within this shared network. Consider the
following example:
::
"Dhcp6": {
"client-classes": [
{
"name": "reserved_class"
},
{
"name": "unreserved_class",
"test": "not member('reserved_class')"
}
],
"reservations": [
{
"hw-address": "aa:bb:cc:dd:ee:fe",
"client-classes": [ "reserved_class" ]
}
],
# It is replaced by the "reservations-global",
# "reservations-in-subnet", and "reservations-out-of-pool" parameters.
# Specify if the server should look up global reservations.
"reservations-global": true,
# Specify if the server should look up in-subnet reservations.
"reservations-in-subnet": false,
# Specify if the server can assume that all reserved addresses
# are out-of-pool. It can be ignored because "reservations-in-subnet"
# is false, but if specified, it is inherited by "shared-networks"
# and "subnet6" levels.
# "reservations-out-of-pool": false,
"shared-networks": [
{
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/64",
"pools": [
{
"pool": "2001:db8:1::10-2001:db8:1::20",
"client-class": "reserved_class"
}
]
},
{
"id": 2,
"subnet": "2001:db8:2::/64",
"pools": [
{
"pool": "2001:db8:2::10-2001:db8:2::20",
"client-class": "unreserved_class"
}
]
}
]
}
]
}
This is similar to the example described in the
:ref:`pool-selection-with-class-reservations6`. This time, however, there
are two subnets, each of which has a pool associated with a different
class. The clients that do not have a reservation for the ``reserved_class``
are assigned an address from the subnet 2001:db8:2::/64. Clients with
a reservation for the ``reserved_class`` are assigned an address from
the subnet 2001:db8:1::/64. The subnets must belong to the same shared network.
In addition, the reservation for the client class must be specified at the
global scope (global reservation) and ``reservations-global`` must be
set to ``true``.
In the example above, the ``client-class`` could also be specified at the
subnet level rather than the pool level, and would yield the same effect.
.. _multiple-reservations-same-ip6:
Multiple Reservations for the Same IP
-------------------------------------
Host reservations were designed to preclude the creation of multiple
reservations for the same IP address or delegated prefix within a
particular subnet, to avoid having two different clients
compete for the same lease. When using the default settings, the server
returns a configuration error when it finds two or more reservations for
the same lease within a subnet in the Kea configuration file.
:ischooklib:`libdhcp_host_cmds.so` returns an error in response to the
:isccmd:`reservation-add` command when it detects that the reservation exists
in the database for the lease for which the new reservation is being added.
Similar to DHCPv4 (see :ref:`multiple-reservations-same-ip4`), the DHCPv6
server can also be configured to allow the creation of multiple reservations
for the same IPv6 address and/or delegated prefix in a given subnet. This
is supported since Kea release 1.9.1 as an optional mode of operation
enabled with the ``ip-reservations-unique`` global parameter.
The ``ip-reservations-unique`` is a boolean parameter that defaults to
``true``, which forbids the specification of more than one reservation
for the same lease in a given subnet. Setting this parameter to ``false``
allows such reservations to be created both in the Kea configuration
file and in the host database backend, via :ischooklib:`libdhcp_host_cmds.so`.
Setting ``ip-reservations-unique`` to ``false`` when using memfile, MySQL or PostgreSQL is supported.
This setting is not supported when using Host Cache (see :ref:`hooks-host-cache`), and the RADIUS backend
(see :ref:`hooks-radius`). These reservation backends simply do not support multiple reservations for the
same IP. If either of these hooks are loaded and ``ip-reservations-unique`` is set to ``false``, then a
configuration error will be emitted and the server will fail to start.
.. note::
When ``ip-reservations-unique`` is set to ``true`` (the default value),
the server ensures that IP reservations are unique for a subnet within
a single host backend and/or Kea configuration file. It does not
guarantee that the reservations are unique across multiple backends.
The following is an example configuration with two reservations for
the same IPv6 address but different MAC addresses:
::
"Dhcp6": {
"ip-reservations-unique": false,
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/64",
"reservations": [
{
"hw-address": "1a:1b:1c:1d:1e:1f",
"ip-address": "2001:db8:1::11"
},
{
"hw-address": "2a:2b:2c:2d:2e:2f",
"ip-address": "2001:db8:1::11"
}
]
}
]
}
It is possible to control the ``ip-reservations-unique`` parameter via the
:ref:`dhcp6-cb`. If the new setting of this parameter conflicts with
the currently used backends (i.e. backends do not support the new setting),
the new setting is ignored and a warning log message is generated.
The backends continue to use the default setting, expecting that
IP reservations are unique within each subnet. To allow the
creation of non-unique IP reservations, the administrator must remove
the backends which lack support for them from the configuration file.
Administrators must be careful when they have been using multiple
reservations for the same IP address and/or delegated prefix and later
decide to return to the default mode in which this is no longer allowed.
They must make sure that at most one reservation for
a given IP address or delegated prefix exists within a subnet, prior
to switching back to the default mode. If such duplicates are left in
the configuration file, the server reports a configuration error.
Leaving such reservations in the host databases does not cause
configuration errors but may lead to lease allocation errors during
the server's operation, when it unexpectedly finds multiple reservations
for the same IP address or delegated prefix.
.. note::
Currently the Kea server does not verify whether multiple reservations for
the same IP address and/or delegated prefix exist in
MySQL and/or PostgreSQL) host databases when ``ip-reservations-unique``
is updated from ``true`` to ``false``. This may cause issues with
lease allocations. The administrator must ensure that there is at
most one reservation for each IP address and/or delegated prefix
within each subnet, prior to the configuration update.
The ``reservations-lookup-first`` is a boolean parameter which controls whether
host reservations lookup should be performed before lease lookup. This parameter
has effect only when multi-threading is disabled. When multi-threading is
enabled, host reservations lookup is always performed first to avoid lease-lookup
resource locking. The ``reservations-lookup-first`` parameter defaults to ``false``
when multi-threading is disabled.
.. _host_reservations_as_basic_access_control6:
Host Reservations as Basic Access Control
-----------------------------------------
Starting with Kea 2.3.5, it is possible to define a host reservation that
contains just an identifier, without any address, options, or values. In some
deployments this is useful, as the hosts that have a reservation belong to
the KNOWN class while others do not. This can be used as a basic access control
mechanism.
The following example demonstrates this concept. It indicates a single IPv6 subnet
and all clients will get an address from it. However, only known clients (those that
have reservations) will get their default DNS server configured.
::
"Dhcp6": {
"client-classes": [
{
"name": "KNOWN",
"option-data": [
{
"name": "dns-servers",
"data": "2001:db8::1"
}
]
}
],
"reservations": [
// Clients on this list will be added to the KNOWN class.
{ "duid": "01:02:03:04:05:0A:0B:0C:0D:0E" },
{ "duid": "02:03:04:05:0A:0B:0C:0D:0E:0F" }
],
"reservations-in-subnet": true,
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/48",
"pools": [
{
"pool": "2001:db8:1:1::/64"
}
]
}
]
}
This concept can be extended further. A good real-life scenario might be a
situation where some customers of an ISP have not paid their bills. A new class can be
defined to use an alternative default DNS server that, instead of giving access
to the Internet, redirects those customers to a captive portal urging them to bring
their accounts up to date.
::
"Dhcp6": {
"client-classes": [
{
"name": "blocked",
"option-data": [
{
"name": "dns-servers",
"data": "2001:db8::2"
}
]
}
],
"reservations": [
// Clients on this list will be added to the KNOWN class. Some
// will also be added to the blocked class.
{ "duid": "01:02:03:04:05:0A:0B:0C:0D:0E",
"client-classes": [ "blocked" ] },
{ "duid": "02:03:04:05:0A:0B:0C:0D:0E:0F" }
],
"reservations-in-subnet": true,
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/48",
"pools": [
{
"pool": "2001:db8:1:1::/64"
}
],
"option-data": [
{
"name": "dns-servers",
"data": "2001:db8::1"
}
]
}
]
}
.. _shared-network6:
Shared Networks in DHCPv6
=========================
DHCP servers use subnet information in two ways. It is used to
both determine the point of attachment, i.e. where the client is
connected to the network, and to
group information pertaining to a specific location in the network.
Sometimes it is useful to have more than one
logical IP subnet being deployed on the same physical link.
Understanding that two or more subnets are used on the same link requires
additional logic in the DHCP server. This capability is called "shared
networks" in Kea, and sometimes also
"shared subnets"; in Microsoft's nomenclature it is called
"multinet."
There are many cases where the shared networks feature is useful; here we explain
just a handful of the most common ones. The first and by far most common
use case is an existing IPv4 network that has grown and
is running out of available
address space. This is less common in IPv6, but shared networks
are still useful: for example, with the exhaustion of IPv6-
delegated prefixes within a subnet, or the desire to
experiment with an addressing scheme. With the advent of IPv6 deployment
and a vast address space, many organizations split the address space
into subnets, deploy it, and then after a while discover that they want
to split it differently. In the transition period, they want both the old
and new addressing to be available: thus the need for more than one
subnet on the same physical link.
Finally, the case of cable networks is directly applicable in IPv6.
There are two types of devices in cable networks: cable modems and the
end-user devices behind them. It is a common practice to use different
subnets for cable modems to prevent users from tinkering with them. In
this case, the distinction is based on the type of device, rather than
on address-space exhaustion.
A client connected to a shared network may be assigned a lease (address
or prefix) from any of the pools defined within the subnets belonging to
the shared network. Internally, the server selects one of the subnets
belonging to a shared network and tries to allocate a lease from this
subnet. If the server is unable to allocate a lease from the selected
subnet (e.g., due to pool exhaustion), it uses another subnet from
the same shared network and tries to allocate a lease from this subnet.
The server typically allocates all leases
available in a given subnet before it starts allocating leases from
other subnets belonging to the same shared network. However, in certain
situations the client can be allocated a lease from another subnet
before the pools in the first subnet get exhausted; this sometimes occurs
when the client provides a hint that belongs to another subnet, or the client has
reservations in a subnet other than the default.
.. note::
Deployments should not assume that Kea waits until it has allocated
all the addresses from the first subnet in a shared network before
allocating addresses from other subnets.
To define a shared network, an additional configuration scope is
introduced:
::
{
"Dhcp6": {
"shared-networks": [
{
# Name of the shared network. It may be an arbitrary string
# and it must be unique among all shared networks.
"name": "ipv6-lab-1",
# The subnet selector can be specified on the shared network
# level. Subnets from this shared network will be selected
# for clients communicating via relay agent having
# the specified IP address.
"relay": {
"ip-addresses": [ "2001:db8:2:34::1" ]
},
# This starts a list of subnets in this shared network.
# There are two subnets in this example.
"subnet6": [
{
"id": 1,
"subnet": "2001:db8::/48",
"pools": [ { "pool": "2001:db8::1 - 2001:db8::ffff" } ]
},
{
"id": 2,
"subnet": "3ffe:ffe::/64",
"pools": [ { "pool": "3ffe:ffe::/64" } ]
}
]
}
],
# end of shared-networks
# It is likely that in the network there will be a mix of regular,
# "plain" subnets and shared networks. It is perfectly valid
# to mix them in the same configuration file.
#
# This is a regular subnet. It is not part of any shared-network.
"subnet6": [
{
"id": 3,
"subnet": "2001:db9::/48",
"pools": [ { "pool": "2001:db9::/64" } ],
"relay": {
"ip-addresses": [ "2001:db8:1:2::1" ]
}
}
]
}
}
As demonstrated in the example, it is possible to mix shared and regular
("plain") subnets. Each shared network must have a unique name. This is
similar to the ID for subnets, but gives administrators more
flexibility. It is used for logging, but also internally for
identifying shared networks.
In principle it makes sense to define only shared networks that consist
of two or more subnets. However, for testing purposes, an empty subnet
or a network with just a single subnet is allowed. This
is not a recommended practice in production networks, as the shared
network logic requires additional processing and thus lowers the
server's performance. To avoid unnecessary performance degradation,
shared subnets should only be defined when required by the deployment.
Shared networks provide an ability to specify many parameters in the
shared network scope that apply to all subnets within it. If
necessary, it is possible to specify a parameter in the shared-network scope and
then override its value in the subnet scope. For example:
::
{
"shared-networks": [
{
"name": "lab-network3",
"relay": {
"ip-addresses": [ "2001:db8:2:34::1" ]
},
# This applies to all subnets in this shared network, unless
# values are overridden on subnet scope.
"valid-lifetime": 600,
# This option is made available to all subnets in this shared
# network.
"option-data": [ {
"name": "dns-servers",
"data": "2001:db8::8888"
} ],
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/48",
"pools": [ { "pool": "2001:db8:1::1 - 2001:db8:1::ffff" } ],
# This particular subnet uses different values.
"valid-lifetime": 1200,
"option-data": [
{
"name": "dns-servers",
"data": "2001:db8::1:2"
},
{
"name": "unicast",
"data": "2001:abcd::1"
} ]
},
{
"id": 2,
"subnet": "2001:db8:2::/48",
"pools": [ { "pool": "2001:db8:2::1 - 2001:db8:2::ffff" } ],
# This subnet does not specify its own valid-lifetime value,
# so it is inherited from shared network scope.
"option-data": [
{
"name": "dns-servers",
"data": "2001:db8:cafe::1"
} ]
}
]
}
],
...
}
In this example, there is a ``dns-servers`` option defined that is available
to clients in both subnets in this shared network. Also, the valid
lifetime is set to 10 minutes (600s). However, the first subnet
overrides some of the values (the valid lifetime is 20 minutes, there is a different IP
address for ``dns-servers``), but also adds its own option (the unicast
address). Assuming a client asking for server unicast and ``dns-servers``
options is assigned a lease from this subnet, it will get a lease for 20
minutes and ``dns-servers``, and be allowed to use server unicast at address
2001:abcd::1. If the same client is assigned to the second subnet, it
will get a 10-minute lease, a ``dns-servers`` value of 2001:db8:cafe::1, and
no server unicast.
Some parameters must be the same in all subnets in the same shared
network. This restriction applies to the ``interface`` and
``rapid-commit`` settings. The most convenient way is to define them on
the shared-network scope, but they can be specified for each subnet.
However, each subnet must have the same value.
.. note::
There is an inherent ambiguity when using clients that send multiple IA
options in a single request, and shared-networks whose subnets have
different values for options and configuration parameters. The server
sequentially processes IA options in the order that they occur in the
client's query; if the leases requested in the IA options end up being
fulfilled from different subnets, which parameters and options should
apply? Currently, the code uses the values from the last subnet of
the last IA option fulfilled.
We view this largely as a site configuration issue. A shared network
generally means the same physical link, so services configured by options
from subnet A should be as easily reachable from subnet B and vice versa.
There are a number of ways to avoid this situation:
- Use the same values for options and parameters for subnets within the shared network.
- Use subnet selectors or client class guards that ensure that for a single client's query, the same subnet is used for all IA options in that query.
- Avoid using shared networks with clients that send multiple IA options per query.
Local and Relayed Traffic in Shared Networks
--------------------------------------------
It is possible to specify an interface name at the shared-network level,
to tell the server that this specific shared network is reachable
directly (not via relays) using the local network interface. As all
subnets in a shared network are expected to be used on the same physical
link, it is a configuration error to attempt to define a shared network
using subnets that are reachable over different interfaces. In other
words, all subnets within the shared network must have the same value
for the ``interface`` parameter. The following configuration is an example
of what **NOT** to do:
::
{
"shared-networks": [
{
"name": "office-floor-2",
"subnet6": [
{
"id": 1,
"subnet": "2001:db8::/64",
"pools": [ { "pool": "2001:db8::1 - 2001:db8::ffff" } ],
"interface": "eth0"
},
{
"id": 2,
"subnet": "3ffe:abcd::/64",
"pools": [ { "pool": "3ffe:abcd::1 - 3ffe:abcd::ffff" } ],
...
# Specifying a different interface name is a configuration
# error. This value should rather be "eth0" or the interface
# name in the other subnet should be "eth1".
# "interface": "eth1"
}
]
}
],
...
}
To minimize the chance of configuration errors, it is often more convenient
to simply specify the interface name once, at the shared-network level, as
shown in the example below.
::
{
"shared-networks": [
{
"name": "office-floor-2",
# This tells Kea that the whole shared network is reachable over a
# local interface. This applies to all subnets in this network.
"interface": "eth0",
"subnet6": [
{
"id": 1,
"subnet": "2001:db8::/64",
"pools": [ { "pool": "2001:db8::1 - 2001:db8::ffff" } ]
},
{
"id": 2,
"subnet": "3ffe:abcd::/64",
"pools": [ { "pool": "3ffe:abcd::1 - 3ffe:abcd::ffff" } ]
}
]
}
],
...
}
With relayed traffic, subnets are typically selected using
the relay agents' addresses. If the subnets are used independently (not
grouped within a shared network), a different relay
address can be specified for each of these subnets. When multiple subnets belong to a
shared network they must be selected via the same relay address and,
similarly to the case of the local traffic described above, it is a
configuration error to specify different relay addresses for the respective
subnets in the shared network. The following configuration is another example
of what **NOT** to do:
::
{
"shared-networks": [
{
"name": "kakapo",
"subnet6": [
{
"id": 1,
"subnet": "2001:db8::/64",
"relay": {
"ip-addresses": [ "2001:db8::1234" ]
},
"pools": [ { "pool": "2001:db8::1 - 2001:db8::ffff" } ]
},
{
"id": 2,
"subnet": "3ffe:abcd::/64",
"pools": [ { "pool": "3ffe:abcd::1 - 3ffe:abcd::ffff" } ],
"relay": {
# Specifying a different relay address for this
# subnet is a configuration error. In this case
# it should be 2001:db8::1234 or the relay address
# in the previous subnet should be 3ffe:abcd::cafe.
"ip-addresses": [ "3ffe:abcd::cafe" ]
}
}
]
}
],
...
}
Again, it is better to specify the relay address at the shared-network
level; this value will be inherited by all subnets belonging to the
shared network.
::
{
"shared-networks": [
{
"name": "kakapo",
"relay": {
# This relay address is inherited by both subnets.
"ip-addresses": [ "2001:db8::1234" ]
},
"subnet6": [
{
"id": 1,
"subnet": "2001:db8::/64",
"pools": [ { "pool": "2001:db8::1 - 2001:db8::ffff" } ]
},
{
"id": 2,
"subnet": "3ffe:abcd::/64",
"pools": [ { "pool": "3ffe:abcd::1 - 3ffe:abcd::ffff" } ]
}
]
}
],
...
}
Even though it is technically possible to configure two (or more) subnets
within the shared network to use different relay addresses, this will almost
always lead to a different behavior than what the user would expect. In this
case, the Kea server will initially select one of the subnets by matching
the relay address in the client's packet with the subnet's configuration.
However, it MAY end up using the other subnet (even though it does not match
the relay address) if the client already has a lease in this subnet or has a
host reservation in this subnet, or simply if the initially selected subnet has no
more addresses available. Therefore, it is strongly recommended to always
specify subnet selectors (interface or relay address) at the shared-network
level if the subnets belong to a shared network, as it is rarely useful to
specify them at the subnet level and may lead to the configuration errors
described above.
Client Classification in Shared Networks
----------------------------------------
Sometimes it is desirable to segregate clients into specific subnets
based on certain properties. This mechanism is called client
classification and is described in :ref:`classify`. Client
classification can be applied to subnets belonging to shared networks in
the same way as it is used for subnets specified outside of shared
networks. It is important to understand how the server selects subnets
for clients when client classification is in use, to ensure that the
appropriate subnet is selected for a given client type.
If a subnet is associated with a class, only the clients belonging to
this class can use this subnet. If there are no classes specified for a
subnet, any client connected to a given shared network can use this
subnet. A common mistake is to assume that the subnet that includes a client
class is preferred over subnets without client classes. Consider the
following example:
.. code-block:: json
{
"client-classes": [
{
"name": "b-devices",
"test": "option[1234].hex == 0x0002"
}
],
"shared-networks": [
{
"name": "galah",
"relay": {
"ip-address": [ "2001:db8:2:34::1" ]
},
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/64",
"pools": [ { "pool": "2001:db8:1::20 - 2001:db8:1::ff" } ]
},
{
"id": 2,
"subnet": "2001:db8:3::/64",
"pools": [ { "pool": "2001:db8:3::20 - 2001:db8:3::ff" } ],
"client-class": "b-devices"
}
]
}
]
}
If the client belongs to the "b-devices" class (because it includes
option 1234 with a value of 0x0002), that does not guarantee that the
subnet 2001:db8:3::/64 will be used (or preferred) for this client. The
server can use either of the two subnets, because the subnet
2001:db8:1::/64 is also allowed for this client. The client
classification used in this case should be perceived as a way to
restrict access to certain subnets, rather than as a way to express subnet
preference. For example, if the client does not belong to the "b-devices"
class, it may only use the subnet 2001:db8:1::/64 and will never use the
subnet 2001:db8:3::/64.
A typical use case for client classification is in a cable network,
where cable modems should use one subnet and other devices should use
another subnet within the same shared network. In this case it is
necessary to apply classification on all subnets. The following example
defines two classes of devices, and the subnet selection is made based
on option 1234 values.
::
{
"client-classes": [
{
"name": "a-devices",
"test": "option[1234].hex == 0x0001"
},
{
"name": "b-devices",
"test": "option[1234].hex == 0x0002"
}
],
"shared-networks": [
{
"name": "galah",
"relay": {
"ip-addresses": [ "2001:db8:2:34::1" ]
},
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/64",
"pools": [ { "pool": "2001:db8:1::20 - 2001:db8:1::ff" } ],
"client-class": "a-devices"
},
{
"id": 2,
"subnet": "2001:db8:3::/64",
"pools": [ { "pool": "2001:db8:3::20 - 2001:db8:3::ff" } ],
"client-class": "b-devices"
}
]
}
]
}
In this example each class has its own restriction. Only clients that
belong to class "a-devices" are able to use subnet 2001:db8:1::/64
and only clients belonging to "b-devices" are able to use subnet
2001:db8:3::/64. Care should be taken not to define too-restrictive
classification rules, as clients that are unable to use any subnets will
be refused service. However, this may be a desired outcome if one wishes
to provide service only to clients with known properties (e.g. only VoIP
phones allowed on a given link).
It is possible to achieve an effect similar to the one
presented in this section without the use of shared networks. If the
subnets are placed in the global subnets scope, rather than in the
shared network, the server will still use classification rules to pick
the right subnet for a given class of devices. The major benefit of
placing subnets within the shared network is that common parameters for
the logically grouped subnets can be specified once, in the shared
network scope, e.g. the ``interface`` or ``relay`` parameter. All subnets
belonging to this shared network will inherit those parameters.
Host Reservations in Shared Networks
------------------------------------
Subnets that are part of a shared network allow host reservations,
similar to regular subnets:
::
{
"shared-networks": [
{
"name": "frog",
"relay": {
"ip-addresses": [ "2001:db8:2:34::1" ]
},
"subnet6": [
{
"subnet": "2001:db8:1::/64",
"id": 100,
"pools": [ { "pool": "2001:db8:1::1 - 2001:db8:1::64" } ],
"reservations": [
{
"duid": "00:03:00:01:11:22:33:44:55:66",
"ip-addresses": [ "2001:db8:1::28" ]
}
]
},
{
"subnet": "2001:db8:3::/64",
"id": 101,
"pools": [ { "pool": "2001:db8:3::1 - 2001:db8:3::64" } ],
"reservations": [
{
"duid": "00:03:00:01:aa:bb:cc:dd:ee:ff",
"ip-addresses": [ "2001:db8:2::28" ]
}
]
}
]
}
]
}
It is worth noting that Kea conducts additional checks when processing a
packet if shared networks are defined. First, instead of simply checking
whether there is a reservation for a given client in its initially
selected subnet, Kea looks through all subnets in a shared network for a
reservation. This is one of the reasons why defining a shared network
may impact performance. If there is a reservation for a client in any
subnet, that particular subnet is picked for the client. Although
it is technically not an error, it is considered bad practice to define
reservations for the same host in multiple subnets belonging to the same
shared network.
While not strictly mandatory, it is strongly recommended to use explicit
"id" values for subnets if database storage will be used for host
reservations. If an ID is not specified, the values for it are
auto generated, i.e. Kea assigns increasing integer values starting from
1. Thus, the auto-generated IDs are not stable across configuration
changes.
.. _dhcp6-serverid:
Server Identifier in DHCPv6
===========================
The DHCPv6 protocol uses a "server identifier" (also known as a DUID) to
allow clients to discriminate between several servers present on the
same link. `RFC 8415 <https://tools.ietf.org/html/rfc8415>`__ currently
defines four DUID types: DUID-LLT, DUID-EN, DUID-LL, and DUID-UUID.
The Kea DHCPv6 server generates a server identifier once, upon the first
startup, and stores it in a file. This identifier is not modified across
restarts of the server and so is a stable identifier.
Kea follows the recommendation from `RFC
8415 <https://tools.ietf.org/html/rfc8415>`__ to use DUID-LLT as the
default server identifier. However, ISC has received reports that some
deployments require different DUID types, and that there is a need to
administratively select both the DUID type and/or its contents.
The server identifier can be configured using parameters within the
``server-id`` map element in the global scope of the Kea configuration
file. The following example demonstrates how to select DUID-EN as a
server identifier:
::
"Dhcp6": {
"server-id": {
"type": "EN"
},
...
}
Currently supported values for the ``type`` parameter are: "LLT", "EN", and
"LL", for DUID-LLT, DUID-EN, and DUID-LL respectively.
When a new DUID type is selected, the server generates its value and
replaces any existing DUID in the file. The server then uses the new
server identifier in all future interactions with clients.
.. note::
If the new server identifier is created after some clients have
obtained their leases, the clients using the old identifier are not
able to renew their leases; the server will ignore messages containing
the old server identifier. Clients will continue sending RENEW until
they transition to the rebinding state. In this state, they will
start sending REBIND messages to the multicast address without a
server identifier. The server will respond to the REBIND messages
with a new server identifier, and the clients will associate the new
server identifier with their leases. Although the clients will be
able to keep their leases and will eventually learn the new server
identifier, this will be at the cost of an increased number of
renewals and multicast traffic due to a need to rebind. Therefore, it
is recommended that modification of the server-identifier type and
value be avoided if the server has already assigned leases and these
leases are still valid.
There are cases when an administrator needs to explicitly specify a DUID
value rather than allow the server to generate it. The following example
demonstrates how to explicitly set all components of a DUID-LLT.
::
"Dhcp6": {
"server-id": {
"type": "LLT",
"htype": 8,
"identifier": "A65DC7410F05",
"time": 2518920166
},
...
}
where:
- ``htype`` is a 16-bit unsigned value specifying hardware type,
- ``identifier`` is a link-layer address, specified as a string of
hexadecimal digits, and
- ``time`` is a 32-bit unsigned time value.
The hexadecimal representation of the DUID generated as a result of the
configuration specified above is:
::
00:01:00:08:96:23:AB:E6:A6:5D:C7:41:0F:05
|type |htype| time | identifier |
A special value of "0" for ``htype`` and ``time`` is allowed, which indicates
that the server should use ANY value for these components. If the server
already uses a DUID-LLT, it will use the values from this DUID; if the
server uses a DUID of a different type or does not yet use any DUID, it
will generate these values. Similarly, if the ``identifier`` is assigned
an empty string, the value of the ``identifier`` will be generated. Omitting
any of these parameters is equivalent to setting them to those special
values.
For example, the following configuration:
::
"Dhcp6": {
"server-id": {
"type": "LLT",
"htype": 0,
"identifier": "",
"time": 2518920166
},
...
}
indicates that the server should use ANY link-layer address and hardware
type. If the server is already using DUID-LLT, it will use the
link-layer address and hardware type from the existing DUID. If the
server is not yet using any DUID, it will use the link-layer address and
hardware type from one of the available network interfaces. The server
will use an explicit value of time; if it is different than a time value
present in the currently used DUID, that value will be replaced,
effectively modifying the current server identifier.
The following example demonstrates an explicit configuration of a
DUID-EN:
::
"Dhcp6": {
"server-id": {
"type": "EN",
"enterprise-id": 2495,
"identifier": "87ABEF7A5BB545"
},
...
}
where:
- ``enterprise-id`` is a 32-bit unsigned value holding an enterprise
number, and
- ``identifier`` is a variable- length identifier within DUID-EN.
The hexadecimal representation of the DUID-EN created according to the
configuration above is:
::
00:02:00:00:09:BF:87:AB:EF:7A:5B:B5:45
|type | ent-id | identifier |
As in the case of the DUID-LLT, special values can be used for the
configuration of the DUID-EN. If the ``enterprise-id`` is "0", the server
will use a value from the existing DUID-EN. If the server is not using
any DUID or the existing DUID has a different type, the ISC enterprise
ID will be used. When an empty string is entered for ``identifier``, the
identifier from the existing DUID-EN will be used. If the server is not
using any DUID-EN, a new 6-byte-long ``identifier`` will be generated.
DUID-LL is configured in the same way as DUID-LLT except that the
``time`` parameter has no effect for DUID-LL, because this DUID type
only comprises a hardware type and link-layer address. The following
example demonstrates how to configure DUID-LL:
::
"Dhcp6": {
"server-id": {
"type": "LL",
"htype": 8,
"identifier": "A65DC7410F05"
},
...
}
which will result in the following server identifier:
::
00:03:00:08:A6:5D:C7:41:0F:05
|type |htype| identifier |
The server stores the generated server identifier in the following
location: ``[kea-install-dir]/var/lib/kea/kea-dhcp6-serverid``.
In some uncommon deployments where no stable storage is available, the
server should be configured not to try to store the server identifier.
This choice is controlled by the value of the ``persist`` boolean
parameter:
::
"Dhcp6": {
"server-id": {
"type": "EN",
"enterprise-id": 2495,
"identifier": "87ABEF7A5BB545",
"persist": false
},
...
}
The default value of the ``persist`` parameter is ``true``, which
configures the server to store the server identifier on a disk.
In the example above, the server is configured not to store the
generated server identifier on a disk. But if the server identifier is
not modified in the configuration, the same value is used after
server restart, because the entire server identifier is explicitly
specified in the configuration.
.. _data-directory:
DHCPv6 Data Directory
=====================
The Kea DHCPv6 server puts the server identifier file and the default
memory lease file into its data directory. By default this directory is
``prefix/var/lib/kea`` but this location can be changed using the
``data-directory`` global parameter, as in:
::
"Dhcp6": {
"data-directory": "/var/tmp/kea-server6",
...
}
.. _stateless-dhcp6:
Stateless DHCPv6 (INFORMATION-REQUEST Message)
==============================================
Typically DHCPv6 is used to assign both addresses and options. These
assignments (leases) have a state that changes over time, hence their
description as "stateful." DHCPv6 also supports a "stateless" mode, where clients
request only configuration options. This mode is considered lightweight
from the server perspective, as it does not require any state tracking.
The Kea server supports stateless mode. When clients send
INFORMATION-REQUEST messages, the server sends back answers with the
requested options, if they are available in the server
configuration. The server attempts to use per-subnet options first; if
that fails, it then tries to provide options
defined in the global scope.
Stateless and stateful mode can be used together. No special
configuration directives are required to handle this; simply use the
configuration for stateful clients and the stateless clients will get
only the options they requested.
It is possible to run a server that provides only options and no addresses or
prefixes. If the options have the same value in each subnet, the
configuration can define the required options in the global scope and skip
subnet definitions altogether. Here's a simple example of such a
configuration:
::
"Dhcp6": {
"interfaces-config": {
"interfaces": [ "ethX" ]
},
"option-data": [ {
"name": "dns-servers",
"data": "2001:db8::1, 2001:db8::2"
} ],
"lease-database": {
"type": "memfile"
}
}
This very simple configuration provides DNS server information to
all clients in the network, regardless of their location. The
memfile lease database must be specified, as Kea
requires a lease database to be specified even if it is not used.
.. _dhcp6-rfc7550:
Support for RFC 7550 (now part of RFC 8415)
===========================================
`RFC 7550 <https://tools.ietf.org/html/rfc7550>`__ introduced some
changes to the previous DHCPv6 specifications, `RFC
3315 <https://tools.ietf.org/html/rfc3315>`__ and `RFC
3633 <https://tools.ietf.org/html/rfc3633>`__, to resolve issues
with the coexistence of multiple stateful options in the messages sent
between clients and servers. Those changes were later included in
the most recent DHCPv6 protocol specification, `RFC
8415 <https://tools.ietf.org/html/rfc8415>`__, which obsoleted `RFC
7550 <https://tools.ietf.org/html/rfc7550>`__. Kea supports `RFC
8415 <https://tools.ietf.org/html/rfc8415>`__ along with these protocol
changes, which are briefly described below.
When a client, such as a requesting router, requests an allocation of
both addresses and prefixes during the 4-way (SARR) exchange with the
server, and the server is not configured to allocate any prefixes but
can allocate some addresses, it will respond with the IA_NA(s)
containing allocated addresses and the IA_PD(s) containing the
NoPrefixAvail status code. According to the updated specifications, if
the client can operate without prefixes it should accept allocated
addresses and transition to the "bound" state. When the client
subsequently sends RENEW/REBIND messages to the server to extend the
lifetimes of the allocated addresses, according to the T1 and T2 times, and
if the client is still interested in obtaining prefixes from the server,
it may also include an IA_PD in the RENEW/REBIND to request allocation
of the prefixes. If the server still cannot allocate the prefixes, it
will respond with the IA_PD(s) containing the NoPrefixAvail status code.
However, if the server can allocate the prefixes, it allocates and
sends them in the IA_PD(s) to the client. A similar situation occurs when
the server is unable to allocate addresses for the client but can
delegate prefixes: the client may request allocation of the addresses
while renewing the delegated prefixes. Allocating leases for other IA
types while renewing existing leases is by default supported by the Kea
DHCPv6 server, and the server provides no configuration mechanisms to
disable this behavior.
The following are the other behaviors first introduced in `RFC
7550 <https://tools.ietf.org/html/rfc7550>`__ (now part of `RFC
8415 <https://tools.ietf.org/html/rfc8415>`__) and supported by the Kea
DHCPv6 server:
- Set T1/T2 timers to the same value for all stateful (IA_NA and IA_PD)
options to facilitate renewal of all of a client's leases at the same
time (in a single message exchange).
- Place NoAddrsAvail and NoPrefixAvail status codes in the IA_NA and
IA_PD options in the ADVERTISE message, rather than as the top-level
options.
.. _dhcp6-relay-override:
Using a Specific Relay Agent for a Subnet
=========================================
The DHCPv6 server follows the same principles as the DHCPv4 server to
select a subnet for the client, with noticeable differences mainly for
relays.
.. note::
When the selected subnet is a member of a shared network, the
whole shared network is selected.
A relay must have an interface connected to the link on which the
clients are being configured. Typically the relay has a global IPv6
address configured on that interface, which belongs to the subnet from
which the server assigns addresses. Normally, the server is able to
use the IPv6 address inserted by the relay (in the ``link-addr`` field in
the RELAY-FORW message) to select the appropriate subnet.
However, that is not always the case; the relay address may not match
the subnet in certain deployments. This usually means that there is more
than one subnet allocated for a given link. The two most common examples
of this are long-lasting network renumbering (where both the
old and new address spaces are still being used) and a cable network. In a
cable network, both cable modems and the devices behind them are
physically connected to the same link, yet they use distinct addressing.
In such a case, the DHCPv6 server needs additional information (the
value of the ``interface-id`` option or the IPv6 address inserted in the
``link-addr`` field in the RELAY-FORW message) to properly select an
appropriate subnet.
The following example assumes that there is a subnet 2001:db8:1::/64
that is accessible via a relay that uses 3000::1 as its IPv6 address.
The server is able to select this subnet for any incoming packets that
come from a relay that has an address in the 2001:db8:1::/64 subnet. It also
selects that subnet for a relay with address 3000::1.
::
"Dhcp6": {
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/64",
"pools": [
{
"pool": "2001:db8:1::1-2001:db8:1::ffff"
}
],
"relay": {
"ip-addresses": [ "3000::1" ]
}
}
]
}
If ``relay`` is specified, the ``ip-addresses`` parameter within it is
mandatory. The ``ip-addresses`` parameter supports specifying a list of addresses.
.. _dhcp6-client-class-relay:
Segregating IPv6 Clients in a Cable Network
===========================================
In certain cases, it is useful to mix relay address information
(introduced in :ref:`dhcp6-relay-override`) with client classification (explained
in :ref:`classify`). One specific example is in a cable network,
where modems typically get addresses from a different subnet than all
the devices connected behind them.
Let us assume that there is one Cable Modem Termination System (CMTS)
with one CM MAC (a physical link that modems are connected to). We want
the modems to get addresses from the 3000::/64 subnet, while everything
connected behind the modems should get addresses from the 2001:db8:1::/64
subnet. The CMTS that acts as a relay uses address 3000::1.
The following configuration can serve that situation:
::
"Dhcp6": {
"subnet6": [
{
"id": 1,
"subnet": "3000::/64",
"pools": [
{ "pool": "3000::2 - 3000::ffff" }
],
"client-class": "VENDOR_CLASS_docsis3.0",
"relay": {
"ip-addresses": [ "3000::1" ]
}
},
{
"id": 2,
"subnet": "2001:db8:1::/64",
"pools": [
{
"pool": "2001:db8:1::1-2001:db8:1::ffff"
}
],
"relay": {
"ip-addresses": [ "3000::1" ]
}
}
]
}
.. _mac-in-dhcpv6:
MAC/Hardware Addresses in DHCPv6
================================
MAC/hardware addresses are available in DHCPv4 messages from
clients, and administrators frequently use that information to perform
certain tasks like per-host configuration and address reservation for
specific MAC addresses. Unfortunately, the DHCPv6 protocol does not
provide any completely reliable way to retrieve that information. To
mitigate that issue, a number of mechanisms have been implemented in
Kea. Each of these mechanisms works in certain cases, but may not in
others. Whether the mechanism works in a particular deployment is
somewhat dependent on the network topology and the technologies used.
Kea allows specification of which of the supported methods should be
used and in what order, via the ``mac-sources`` parameter. This configuration
may be considered a fine
tuning of the DHCP deployment.
Here is an example:
::
"Dhcp6": {
"mac-sources": [
"method1",
"method2",
"method3",
...
],
"subnet6": [
{
...
},
...
],
...
}
When not specified, a value of "any" is used, which instructs
the server to attempt to try all the methods in sequence and use the
value returned by the first one that succeeds. In a typical deployment the default value
of "any" is sufficient and there is no need to select specific
methods. Changing the value of this parameter is most useful in
cases when an administrator wants to disable certain methods; for
example, if the administrator trusts the network infrastructure more
than the information provided by the clients themselves, they may prefer
information provided by the relays over that provided by clients.
If specified, ``mac-sources`` must have at least one value.
Supported methods are:
- ``any`` - this is not an actual method, just a keyword that instructs Kea to
try all other methods and use the first one that succeeds. This is
the default operation if no ``mac-sources`` are defined.
- ``raw`` - in principle, a DHCPv6 server could use raw sockets to
receive incoming traffic and extract MAC/hardware address
information. This is currently not implemented for DHCPv6 and this
value has no effect.
- ``duid`` - DHCPv6 uses DUID identifiers instead of MAC addresses.
There are currently four DUID types defined, and two of them
(DUID-LLT, which is the default, and DUID-LL) convey MAC address
information. Although `RFC 8415 <https://tools.ietf.org/html/rfc8415>`__
forbids it, it is possible to
parse those DUIDs and extract necessary information from them. This
method is not completely reliable, as clients may use other DUID
types, namely DUID-EN or DUID-UUID.
- ``ipv6-link-local`` - another possible acquisition method comes from
the source IPv6 address. In typical usage, clients are sending their
packets from IPv6 link-local addresses. There is a good chance that
those addresses are based on EUI-64, which contains a MAC address.
This method is not completely reliable, as clients may use other
link-local address types. In particular, privacy extensions, defined
in `RFC 4941 <https://tools.ietf.org/html/rfc4941>`__, do not use MAC
addresses. Also note that successful extraction requires that the
address's u-bit must be set to "1" and its g-bit set to "0", indicating
that it is an interface identifier as per `RFC 2373, section
2.5.1 <https://tools.ietf.org/html/rfc2373#section-2.5.1>`__.
- ``client-link-addr-option`` - one extension defined to alleviate
missing MAC issues is the client link-layer address option, defined
in `RFC 6939 <https://tools.ietf.org/html/rfc6939>`__. This is an
option that is inserted by a relay and contains information about a
client's MAC address. This method requires a relay agent that
supports the option and is configured to insert it. This method is
useless for directly connected clients. The value ``rfc6939`` is an alias for
``client-link-addr-option``.
- ``remote-id`` - `RFC 4649 <https://tools.ietf.org/html/rfc4649>`__
defines a ``remote-id`` option that is inserted by a relay agent.
Depending on the relay agent configuration, the inserted option may
convey the client's MAC address information. The value ``rfc4649``
is an alias for ``remote-id``.
- ``subscriber-id`` - Defined in `RFC 4580 <https://tools.ietf.org/html/rfc4580>`__,
``subscriber-id`` is somewhat similar to ``remote-id``; it is also inserted
by a relay agent. The value ``rfc4580`` is an alias for
``subscriber-id``. This method is currently not implemented.
- ``docsis-cmts`` - Yet another possible source of MAC address
information are the DOCSIS options inserted by a CMTS that acts as a
DHCPv6 relay agent in cable networks. This method attempts to extract
MAC address information from sub-option 1026 (cm mac) of the
vendor-specific option with ``vendor-id=4491``. This vendor option is
extracted from the Relay-forward message, not the original client's
message.
- ``docsis-modem`` - The final possible source of MAC address
information are the DOCSIS options inserted by the cable modem
itself. This method attempts to extract MAC address information from
sub-option 36 (``device-id``) of the vendor-specific option with
``vendor-id=4491``. This vendor option is extracted from the original
client's message, not from any relay options.
An empty ``mac-sources`` parameter is not allowed. Administrators who do not want to specify it
should either simply omit the ``mac-sources`` definition or specify it with the
"any" value, which is the default.
.. _dhcp6-decline:
Duplicate Addresses (DHCPDECLINE Support)
=========================================
The DHCPv6 server is configured with a certain pool of addresses that it
is expected to hand out to DHCPv6 clients. It is assumed that the server
is authoritative and has complete jurisdiction over those addresses.
However, for various reasons such as misconfiguration or a faulty
client implementation that retains its address beyond the valid
lifetime, there may be devices connected that use those addresses
without the server's approval or knowledge.
Such an unwelcome event can be detected by legitimate clients (using
Duplicate Address Detection) and reported to the DHCPv6 server using a
DHCPDECLINE message. The server does a sanity check (to see whether
the client declining an address really was supposed to use it), then
conducts a clean-up operation, and confirms the DHCPDECLINE by sending back a REPLY
message. Any DNS entries related to that address are removed, the
event is logged, and hooks are triggered. After that is
complete, the address is marked as declined (which indicates that
it is used by an unknown entity and thus not available for assignment)
and a probation time is set on it. Unless otherwise configured, the
probation period lasts 24 hours; after that time, the server will
recover the lease (i.e. put it back into the available state) and the
address will be available for assignment again. It should be noted that
if the underlying issue of a misconfigured device is not resolved, the
duplicate-address scenario will repeat. If reconfigured correctly, this
mechanism provides an opportunity to recover from such an event
automatically, without any system administrator intervention.
To configure the decline probation period to a value other than the
default, the following syntax can be used:
::
"Dhcp6": {
"decline-probation-period": 3600,
"subnet6": [
{
...
},
...
],
...
}
The parameter is expressed in seconds, so the example above
instructs the server to recycle declined leases after one hour.
There are several statistics and hook points associated with the decline
handling procedure. The ``lease6_decline`` hook point is triggered after the
incoming DHCPDECLINE message has been sanitized and the server is about
to decline the lease. The ``declined-addresses`` statistic is increased
after the hook returns (both the global and subnet-specific variants). (See
:ref:`dhcp6-stats` and :ref:`hooks-libraries`
for more details on DHCPv6 statistics and Kea hook points.)
Once the probation time elapses, the declined lease is recovered using
the standard expired-lease reclamation procedure, with several
additional steps. In particular, both ``declined-addresses`` statistics
(global and subnet-specific) are decreased. At the same time,
``reclaimed-declined-addresses`` statistics (again in two variants, global
and subnet-specific) are increased.
A note about statistics: The Kea server does not decrease the
``assigned-nas`` statistics when a DHCPDECLINE message is received and
processed successfully. While technically a declined address is no
longer assigned, the primary usage of the ``assigned-nas`` statistic
is to monitor pool utilization. Most people would forget to include
``declined-addresses`` in the calculation, and would simply use
``assigned-nas``/``total-nas``. This would cause a bias towards
under-representing pool utilization. As this has a potential to cause serious
confusion, ISC decided not to decrease ``assigned-nas`` immediately after
receiving DHCPDECLINE, but to do it later when Kea recovers the address
back to the available pool.
.. _dhcp6-stats:
Statistics in the DHCPv6 Server
===============================
The DHCPv6 server supports the following statistics:
.. tabularcolumns:: |p{0.2\linewidth}|p{0.1\linewidth}|p{0.7\linewidth}|
.. table:: DHCPv6 statistics
:class: longtable
:widths: 20 10 70
+---------------------------------------------------+----------------+------------------------------------+
| Statistic | Data Type | Description |
+===================================================+================+====================================+
| pkt6-received | integer | Number of DHCPv6 packets received. |
| | | This includes all packets: valid, |
| | | bogus, corrupted, rejected, etc. |
| | | This statistic is expected to grow |
| | | rapidly. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-receive-drop | integer | Number of incoming packets that |
| | | were dropped. The exact reason for |
| | | dropping packets is logged, but |
| | | the most common reasons may be: an |
| | | unacceptable or not supported |
| | | packet type is received, direct |
| | | responses are forbidden, the |
| | | server-id sent by the client does |
| | | not match the server's server-id, |
| | | or the packet is malformed. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-parse-failed | integer | Number of incoming packets that |
| | | could not be parsed. A non-zero |
| | | value of this statistic indicates |
| | | that the server received a |
| | | malformed or truncated packet. |
| | | This may indicate problems in the |
| | | network, faulty clients, faulty |
| | | relay agents, or a bug in the |
| | | server. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-solicit-received | integer | Number of SOLICIT packets |
| | | received. This statistic is |
| | | expected to grow; its increase |
| | | means that clients that just |
| | | booted started their configuration |
| | | process and their initial packets |
| | | reached the Kea server. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-advertise-received | integer | Number of ADVERTISE packets |
| | | received. ADVERTISE packets are |
| | | sent by the server and the server |
| | | is never expected to receive them. |
| | | A non-zero value of this statistic |
| | | indicates an error occurring in |
| | | the network. One likely cause |
| | | would be a misbehaving relay |
| | | agent that incorrectly forwards |
| | | ADVERTISE messages towards the |
| | | server, rather than back to the |
| | | clients. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-request-received | integer | Number of DHCPREQUEST packets |
| | | received. This statistic is |
| | | expected to grow. Its increase |
| | | means that clients that just |
| | | booted received the server's |
| | | response (DHCPADVERTISE) and |
| | | accepted it, and are now |
| | | requesting an address |
| | | (DHCPREQUEST). |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-reply-received | integer | Number of REPLY packets received. |
| | | This statistic is expected to |
| | | remain zero at all times, as REPLY |
| | | packets are sent by the server and |
| | | the server is never expected to |
| | | receive them. A non-zero value |
| | | indicates an error. One likely |
| | | cause would be a misbehaving relay |
| | | agent that incorrectly forwards |
| | | REPLY messages towards the server, |
| | | rather than back to the clients. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-renew-received | integer | Number of RENEW packets received. |
| | | This statistic is expected to |
| | | grow; its increase means that |
| | | clients received their addresses |
| | | and prefixes and are trying to |
| | | renew them. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-rebind-received | integer | Number of REBIND packets received. |
| | | A non-zero value indicates that |
| | | clients did not receive responses |
| | | to their RENEW messages (through |
| | | the regular lease-renewal |
| | | mechanism) and are attempting to |
| | | find any server that is able to |
| | | take over their leases. It may |
| | | mean that some servers' REPLY |
| | | messages never reached the |
| | | clients. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-release-received | integer | Number of RELEASE packets |
| | | received. This statistic is |
| | | expected to grow when a device is |
| | | being shut down in the network; it |
| | | indicates that the address or |
| | | prefix assigned is reported as no |
| | | longer needed. Note that many |
| | | devices, especially wireless, do |
| | | not send RELEASE packets either |
| | | because of design choice or due to |
| | | the client moving out of range. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-decline-received | integer | Number of DECLINE packets |
| | | received. This statistic is |
| | | expected to remain close to zero. |
| | | Its increase means that a client |
| | | leased an address, but discovered |
| | | that the address is currently used |
| | | by an unknown device in the |
| | | network. If this statistic is |
| | | growing, it may indicate a |
| | | misconfigured server or devices |
| | | that have statically assigned |
| | | conflicting addresses. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-infrequest-received | integer | Number of INFORMATION-REQUEST |
| | | packets received. This statistic |
| | | is expected to grow if there are |
| | | devices that are using stateless |
| | | DHCPv6. INFORMATION-REQUEST |
| | | messages are used by clients that |
| | | request stateless configuration, |
| | | i.e. options and parameters other |
| | | than addresses or prefixes. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-dhcpv4-query-received | integer | Number of DHCPv4-QUERY packets |
| | | received. This statistic is |
| | | expected to grow if there are |
| | | devices that are using |
| | | DHCPv4-over-DHCPv6. DHCPv4-QUERY |
| | | messages are used by DHCPv4 |
| | | clients on an IPv6-only line which |
| | | encapsulates the requests over |
| | | DHCPv6. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-dhcpv4-response-received | integer | Number of DHCPv4-RESPONSE packets |
| | | received. This statistic is |
| | | expected to remain zero at all |
| | | times, as DHCPv4-RESPONSE packets |
| | | are sent by the server and the |
| | | server is never expected to |
| | | receive them. A non-zero value |
| | | indicates an error. One likely |
| | | cause would be a misbehaving relay |
| | | agent that incorrectly forwards |
| | | DHCPv4-RESPONSE message towards |
| | | the server rather than back to the |
| | | clients. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-unknown-received | integer | Number of packets received of an |
| | | unknown type. A non-zero value of |
| | | this statistic indicates that the |
| | | server received a packet that it |
| | | was unable to recognize; either it |
| | | had an unsupported type or was |
| | | possibly malformed. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-sent | integer | Number of DHCPv6 packets sent. |
| | | This statistic is expected to grow |
| | | every time the server transmits a |
| | | packet. In general, it should |
| | | roughly match pkt6-received, as |
| | | most incoming packets cause the |
| | | server to respond. There are |
| | | exceptions (e.g. server receiving |
| | | a REQUEST with server-id matching |
| | | another server), so do not worry |
| | | if it is less than pkt6-received. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-advertise-sent | integer | Number of ADVERTISE packets sent. |
| | | This statistic is expected to grow |
| | | in most cases after a SOLICIT is |
| | | processed. There are certain |
| | | uncommon, but valid, cases where |
| | | incoming SOLICIT packets are |
| | | dropped, but in general this |
| | | statistic is expected to be close |
| | | to pkt6-solicit-received. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-reply-sent | integer | Number of REPLY packets sent. This |
| | | statistic is expected to grow in |
| | | most cases after a SOLICIT (with |
| | | rapid-commit), REQUEST, RENEW, |
| | | REBIND, RELEASE, DECLINE, or |
| | | INFORMATION-REQUEST is processed. |
| | | There are certain cases where |
| | | there is no response. |
+---------------------------------------------------+----------------+------------------------------------+
| pkt6-dhcpv4-response-sent | integer | Number of DHCPv4-RESPONSE packets |
| | | sent. This statistic is expected |
| | | to grow in most cases after a |
| | | DHCPv4-QUERY is processed. There |
| | | are certain cases where there is |
| | | no response. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].total-nas | big integer | Total number of NA addresses |
| | | available for DHCPv6 management |
| | | for a given subnet; in other |
| | | words, this is the count of all |
| | | addresses in all configured pools. |
| | | This statistic changes only during |
| | | configuration changes. It does not |
| | | take into account any addresses |
| | | that may be reserved due to host |
| | | reservation. The *id* is the |
| | | subnet-id of a given subnet. This |
| | | statistic is exposed for each |
| | | subnet separately, and is reset |
| | | during a reconfiguration event. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].pool[pid].total-nas | big integer | Total number of NA addresses |
| | | available for DHCPv6 management |
| | | for a given subnet pool; in other |
| | | words, this is the count of all |
| | | addresses in configured subnet |
| | | pool. This statistic changes only |
| | | during configuration changes. It |
| | | does not take into account any |
| | | addresses that may be reserved due |
| | | to host reservation. The *id* is |
| | | the subnet-id of a given subnet. |
| | | The *pid* is the pool-id of a |
| | | given pool. This statistic is |
| | | exposed for each subnet pool |
| | | separately, and is reset during a |
| | | reconfiguration event. |
+---------------------------------------------------+----------------+------------------------------------+
| cumulative-assigned-nas | integer | Cumulative number of NA addresses |
| | | that have been assigned since |
| | | server startup. It is incremented |
| | | each time a NA address is assigned |
| | | and is not reset when the server |
| | | is reconfigured. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].cumulative-assigned-nas | integer | Cumulative number of NA addresses |
| | | in a given subnet that were |
| | | assigned. It increases every time |
| | | a new lease is allocated (as a |
| | | result of receiving a REQUEST |
| | | message) and is never decreased. |
| | | The *id* is the subnet-id of a |
| | | given subnet. This statistic is |
| | | exposed for each subnet |
| | | separately, and is reset during a |
| | | reconfiguration event. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].pool[pid].cumulative-assigned-nas | integer | Cumulative number of NA addresses |
| | | in a given subnet pool that were |
| | | assigned. It increases every time |
| | | a new lease is allocated (as a |
| | | result of receiving a REQUEST |
| | | message) and is never decreased. |
| | | The *id* is the subnet-id of a |
| | | given subnet. The *pid* is the |
| | | pool-id of a given pool. This |
| | | statistic is exposed for each |
| | | subnet pool separately, and is |
| | | reset during a reconfiguration |
| | | event. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].assigned-nas | integer | Number of NA addresses in a given |
| | | subnet that are assigned. It |
| | | increases every time a new lease |
| | | is allocated (as a result of |
| | | receiving a REQUEST message) and |
| | | is decreased every time a lease is |
| | | released (a RELEASE message is |
| | | received) or expires. The *id* is |
| | | the subnet-id of a given subnet. |
| | | This statistic is exposed for each |
| | | subnet separately, and is reset |
| | | during a reconfiguration event. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].pool[pid].assigned-nas | integer | Number of NA addresses in a given |
| | | subnet pool that are assigned. It |
| | | increases every time a new lease |
| | | is allocated (as a result of |
| | | receiving a REQUEST message) and |
| | | is decreased every time a lease is |
| | | released (a RELEASE message is |
| | | received) or expires. The *id* is |
| | | the subnet-id of a given subnet. |
| | | The *pid* is the pool-id of the |
| | | pool. This statistic is exposed |
| | | for each subnet pool separately, |
| | | and is reset during a |
| | | reconfiguration event. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].total-pds | big integer | Total number of PD prefixes |
| | | available for DHCPv6 management |
| | | for a given subnet; in other |
| | | words, this is the count of all |
| | | prefixes in all configured pools. |
| | | This statistic changes only during |
| | | configuration changes. Note it |
| | | does not take into account any |
| | | prefixes that may be reserved due |
| | | to host reservation. The *id* is |
| | | the subnet-id of a given subnet. |
| | | This statistic is exposed for each |
| | | subnet separately, and is reset |
| | | during a reconfiguration event. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].pd-pool[pid].total-pds | big integer | Total number of PD prefixes |
| | | available for DHCPv6 management |
| | | for a given subnet pool; in other |
| | | words, this is the count of all |
| | | prefixes in configured subnet |
| | | pd-pool. This statistic changes |
| | | only during configuration changes. |
| | | It does not take into account any |
| | | prefixes that may be reserved due |
| | | to host reservation. The *id* is |
| | | the subnet-id of a given subnet. |
| | | The *pid* is the pool-id of a |
| | | given pool. This statistic is |
| | | exposed for each subnet pd-pool |
| | | separately, and is reset during a |
| | | reconfiguration event. |
+---------------------------------------------------+----------------+------------------------------------+
| cumulative-assigned-pds | integer | Cumulative number of PD prefixes |
| | | that have been assigned since |
| | | server startup. It is incremented |
| | | each time a PD prefix is assigned |
| | | and is not reset when the server |
| | | is reconfigured. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].cumulative-assigned-pds | integer | Cumulative number of PD prefixes |
| | | in a given subnet that were |
| | | assigned. It increases every time |
| | | a new lease is allocated (as a |
| | | result of receiving a REQUEST |
| | | message) and is never decreased. |
| | | The *id* is the subnet-id of a |
| | | given subnet. This statistic is |
| | | exposed for each subnet |
| | | separately, and is reset during a |
| | | reconfiguration event. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].pd-pool[pid].cumulative-assigned-pds | integer | Cumulative number of PD prefixes |
| | | in a given subnet pd-pool that |
| | | were assigned. It increases every |
| | | time a new lease is allocated (as |
| | | a result of receiving a REQUEST |
| | | message) and is never decreased. |
| | | The *id* is the subnet-id of a |
| | | given subnet. The *pid* is the |
| | | pool-id of a given pd-pool. This |
| | | statistic is exposed for each |
| | | subnet pd-pool separately, and is |
| | | reset during a reconfiguration |
| | | event. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].assigned-pds | integer | Number of PD prefixes in a given |
| | | subnet that are assigned. It |
| | | increases every time a new lease |
| | | is allocated (as a result of |
| | | receiving a REQUEST message) and |
| | | is decreased every time a lease is |
| | | released (a RELEASE message is |
| | | received) or expires. The *id* is |
| | | the subnet-id of a given subnet. |
| | | This statistic is exposed for each |
| | | subnet separately, and is reset |
| | | during a reconfiguration event. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].pd-pool[pid].assigned-pds | integer | Number of PD prefixes in a given |
| | | subnet pd-pool that are assigned. |
| | | It increases every time a new |
| | | lease is allocated (as a result of |
| | | receiving a REQUEST message) and |
| | | is decreased every time a lease is |
| | | released (a RELEASE message is |
| | | received) or expires. The *id* is |
| | | the subnet-id of a given subnet. |
| | | The *pid* is the pool-id of the |
| | | pd-pool. This statistic is exposed |
| | | for each subnet pd-pool |
| | | separately, and is reset during a |
| | | reconfiguration event. |
+---------------------------------------------------+----------------+------------------------------------+
| reclaimed-leases | integer | Number of expired leases that have |
| | | been reclaimed since server |
| | | startup. It is incremented each |
| | | time an expired lease is reclaimed |
| | | (counting both NA and PD |
| | | reclamations). This statistic |
| | | never decreases. It can be used as |
| | | a long-term indicator of how many |
| | | actual leases have been reclaimed. |
| | | This is a global statistic that |
| | | covers all subnets. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].reclaimed-leases | integer | Number of expired leases |
| | | associated with a given subnet |
| | | that have been reclaimed since |
| | | server startup. It is incremented |
| | | each time an expired lease is |
| | | reclaimed (counting both NA and PD |
| | | reclamations). The *id* is the |
| | | subnet-id of a given subnet. This |
| | | statistic is exposed for each |
| | | subnet separately. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].pool[pid].reclaimed-leases | integer | Number of expired NA addresses |
| | | associated with a given subnet |
| | | pool that have been reclaimed |
| | | since server startup. It is |
| | | incremented each time an expired |
| | | lease is reclaimed. The *id* is |
| | | the subnet-id of a given subnet. |
| | | The *pid* is the pool-id of the |
| | | pool. This statistic is exposed |
| | | for each subnet pool separately, |
| | | and is reset during a |
| | | reconfiguration event. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].pd-pool[pid].reclaimed-leases | integer | Number of expired PD prefixes |
| | | associated with a given subnet |
| | | pd-pool that have been reclaimed |
| | | since server startup. It is |
| | | incremented each time an expired |
| | | lease is reclaimed. The *id* is |
| | | the subnet-id of a given subnet. |
| | | The *pid* is the pool-id of the |
| | | pd-pool. This statistic is exposed |
| | | for each subnet pd-pool |
| | | separately, and is reset during a |
| | | reconfiguration event. |
+---------------------------------------------------+----------------+------------------------------------+
| declined-addresses | integer | Number of IPv6 addresses that are |
| | | currently declined; a count of the |
| | | number of leases currently |
| | | unavailable. Once a lease is |
| | | recovered, this statistic will be |
| | | decreased; ideally, this statistic |
| | | should be zero. If this statistic |
| | | is non-zero or increasing, a |
| | | network administrator should |
| | | investigate whether there is a |
| | | misbehaving device in the network. |
| | | This is a global statistic that |
| | | covers all subnets. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].declined-addresses | integer | Number of IPv6 addresses that are |
| | | currently declined in a given |
| | | subnet; a count of the number of |
| | | leases currently unavailable. Once |
| | | a lease is recovered, this |
| | | statistic will be decreased; |
| | | ideally, this statistic should be |
| | | zero. If this statistic is |
| | | non-zero or increasing, a network |
| | | administrator should investigate |
| | | whether there is a misbehaving |
| | | device in the network. The *id* is |
| | | the subnet-id of a given subnet. |
| | | This statistic is exposed for each |
| | | subnet separately. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].pool[pid].declined-addresses | integer | Number of IPv6 addresses that are |
| | | currently declined in a given |
| | | subnet pool; a count of the number |
| | | of leases currently unavailable. |
| | | Once a lease is recovered, this |
| | | statistic will be decreased; |
| | | ideally, this statistic should be |
| | | zero. If this statistic is |
| | | non-zero or increasing, a network |
| | | administrator should investigate |
| | | whether there is a misbehaving |
| | | device in the network. The *id* is |
| | | the subnet-id of a given subnet. |
| | | The *pid* is the pool-id of the |
| | | pool. This statistic is exposed |
| | | for each subnet pool separately. |
+---------------------------------------------------+----------------+------------------------------------+
| reclaimed-declined-addresses | integer | Number of IPv6 addresses that were |
| | | declined, but have now been |
| | | recovered. Unlike |
| | | declined-addresses, this statistic |
| | | never decreases. It can be used as |
| | | a long-term indicator of how many |
| | | actual valid declines were |
| | | processed and recovered from. This |
| | | is a global statistic that covers |
| | | all subnets. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].reclaimed-declined-addresses | integer | Number of IPv6 addresses that were |
| | | declined, but have now been |
| | | recovered. Unlike |
| | | declined-addresses, this statistic |
| | | never decreases. It can be used as |
| | | a long-term indicator of how many |
| | | actual valid declines were |
| | | processed and recovered from. The |
| | | *id* is the subnet-id of a given |
| | | subnet. This statistic is exposed |
| | | for each subnet separately. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].pool[pid].reclaimed-declined-addresses | integer | Number of IPv6 addresses that were |
| | | declined, but have now been |
| | | recovered. Unlike |
| | | declined-addresses, this statistic |
| | | never decreases. It can be used as |
| | | a long-term indicator of how many |
| | | actual valid declines were |
| | | processed and recovered from. The |
| | | *id* is the subnet-id of a given |
| | | subnet. The *pid* is the pool-id |
| | | of the pool. This statistic is |
| | | exposed for each subnet pool |
| | | separately. |
+---------------------------------------------------+----------------+------------------------------------+
| v6-allocation-fail | integer | Number of total address allocation |
| | | failures for a particular client. |
| | | This consists in the number of |
| | | lease allocation attempts that the |
| | | server made before giving up and |
| | | was unable to use any of the |
| | | address pools. This is a global |
| | | statistic that covers all subnets. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].v6-allocation-fail | integer | Number of total address allocation |
| | | failures for a particular client. |
| | | This consists in the number of |
| | | lease allocation attempts that the |
| | | server made before giving up and |
| | | was unable to use any of the |
| | | address pools. The *id* is the |
| | | subnet-id of a given subnet. This |
| | | statistic is exposed for each |
| | | subnet separately. |
+---------------------------------------------------+----------------+------------------------------------+
| v6-allocation-fail-shared-network | integer | Number of address allocation |
| | | failures for a particular client |
| | | connected to a shared network. |
| | | This is a global statistic that |
| | | covers all subnets. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].v6-allocation-fail-shared-network | integer | Number of address allocation |
| | | failures for a particular client |
| | | connected to a shared network. |
| | | The *id* is the subnet-id of a |
| | | given subnet. This statistic is |
| | | exposed for each subnet |
| | | separately. |
+---------------------------------------------------+----------------+------------------------------------+
| v6-allocation-fail-subnet | integer | Number of address allocation |
| | | failures for a particular client |
| | | connected to a subnet that does |
| | | not belong to a shared network. |
| | | This is a global statistic that |
| | | covers all subnets. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].v6-allocation-fail-subnet | integer | Number of address allocation |
| | | failures for a particular client |
| | | connected to a subnet that does |
| | | not belong to a shared network. |
| | | The *id* is the subnet-id of a |
| | | given subnet. This statistic is |
| | | exposed for each subnet |
| | | separately. |
+---------------------------------------------------+----------------+------------------------------------+
| v6-allocation-fail-no-pools | integer | Number of address allocation |
| | | failures because the server could |
| | | not use any configured pools for |
| | | a particular client. It is also |
| | | possible that all of the subnets |
| | | from which the server attempted to |
| | | assign an address lack address |
| | | pools. In this case, it should be |
| | | considered misconfiguration if an |
| | | operator expects that some clients |
| | | should be assigned dynamic |
| | | addresses. This is a global |
| | | statistic that covers all subnets. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].v6-allocation-fail-no-pools | integer | Number of address allocation |
| | | failures because the server could |
| | | not use any configured pools for |
| | | a particular client. It is also |
| | | possible that all of the subnets |
| | | from which the server attempted to |
| | | assign an address lack address |
| | | pools. In this case, it should be |
| | | considered misconfiguration if an |
| | | operator expects that some clients |
| | | should be assigned dynamic |
| | | addresses. The *id* is the |
| | | subnet-id of a given subnet. This |
| | | statistic is exposed for each |
| | | subnet separately. |
+---------------------------------------------------+----------------+------------------------------------+
| v6-allocation-fail-classes | integer | Number of address allocation |
| | | failures when the client's packet |
| | | belongs to one or more classes. |
| | | There may be several reasons why a |
| | | lease was not assigned. One of |
| | | them may be a case when all pools |
| | | require packet to belong to |
| | | certain classes and the incoming |
| | | packet didn't belong to any of |
| | | them. Another case where this |
| | | information may be useful is to |
| | | point out that the pool reserved |
| | | to a given class has ran out of |
| | | addresses. This is a global |
| | | statistic that covers all subnets. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].v6-allocation-fail-classes | integer | Number of address allocation |
| | | failures when the client's packet |
| | | belongs to one or more classes. |
| | | There may be several reasons why a |
| | | lease was not assigned. One of |
| | | them may be a case when all pools |
| | | require packet to belong to |
| | | certain classes and the incoming |
| | | packet didn't belong to any of |
| | | them. Another case where this |
| | | information may be useful is to |
| | | point out that the pool reserved |
| | | to a given class has ran out of |
| | | addresses. The *id* is the |
| | | subnet-id of a given subnet. This |
| | | statistic is exposed for each |
| | | subnet separately. |
+---------------------------------------------------+----------------+------------------------------------+
| v6-ia-na-lease-reuses | integer | Number of times an IA_NA lease had |
| | | its CLTT increased in memory and |
| | | its expiration time left unchanged |
| | | in persistent storage as part of |
| | | the lease caching feature. This is |
| | | referred to as a lease reuse. |
| | | This statistic is global. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].v6-ia-na-lease-reuses | integer | Number of times an IA_NA lease had |
| | | its CLTT increased in memory and |
| | | its expiration time left unchanged |
| | | in persistent storage as part of |
| | | the lease caching feature. This is |
| | | referred to as a lease reuse. |
| | | This statistic is on a per-subnet |
| | | basis. The *id* is the subnet-id |
| | | of a given subnet. |
+---------------------------------------------------+----------------+------------------------------------+
| v6-ia-pd-lease-reuses | integer | Number of times an IA_PD lease had |
| | | its CLTT increased in memory and |
| | | its expiration time left unchanged |
| | | in persistent storage as part of |
| | | the lease caching feature. This is |
| | | referred to as a lease reuse. |
| | | This statistic is global. |
+---------------------------------------------------+----------------+------------------------------------+
| subnet[id].v6-ia-pd-lease-reuses | integer | Number of times an IA_PD lease had |
| | | its CLTT increased in memory and |
| | | its expiration time left unchanged |
| | | in persistent storage as part of |
| | | the lease caching feature. This is |
| | | referred to as a lease reuse. |
| | | This statistic is on a per-subnet |
| | | basis. The *id* is the subnet-id |
| | | of a given subnet. |
+---------------------------------------------------+----------------+------------------------------------+
.. note::
The pool ID can be configured on each pool by explicitly setting the ``pool-id``
parameter in the pool parameter map. If not configured, ``pool-id`` defaults to 0.
The statistics related to pool ID 0 refer to all the statistics of all the pools
that have unconfigured ``pool-id``.
The pool ID does not need to be unique within the subnet or across subnets.
The statistics regarding a specific pool ID within a subnet will be combined with the
other statistics of all other pools with the same pool ID in the respective subnet.
.. note::
This section describes DHCPv6-specific statistics. For a general
overview and usage of statistics, see :ref:`stats`.
The DHCPv6 server provides two global parameters to control the default sample
limits of statistics:
- ``statistic-default-sample-count`` - determines the default maximum
number of samples which are kept. The special value of 0
indicates that a default maximum age should be used.
- ``statistic-default-sample-age`` - determines the default maximum
age in seconds of samples which are kept.
For instance, to reduce the statistic-keeping overhead, set
the default maximum sample count to 1 so only one sample is kept:
::
"Dhcp6": {
"statistic-default-sample-count": 1,
"subnet6": [
{
...
},
...
],
...
}
Statistics can be retrieved periodically to gain more insight into Kea operations. One tool that
leverages that capability is ISC Stork. See :ref:`stork` for details.
.. _dhcp6-ctrl-channel:
Management API for the DHCPv6 Server
====================================
The management API allows the issuing of specific management commands,
such as statistics retrieval, reconfiguration, or shutdown. For more
details, see :ref:`ctrl-channel`. Currently, the only supported
communication channel type is the UNIX stream socket. By default there are
no sockets open; to instruct Kea to open a socket, the following entry
in the configuration file can be used:
::
"Dhcp6": {
"control-socket": {
"socket-type": "unix",
"socket-name": "/path/to/the/unix/socket"
},
"subnet6": [
{
...
},
...
],
...
}
The length of the path specified by the ``socket-name`` parameter is
restricted by the maximum length for the UNIX socket name on the administrator's
operating system, i.e. the size of the ``sun_path`` field in the
``sockaddr_un`` structure, decreased by 1. This value varies on
different operating systems, between 91 and 107 characters. Typical
values are 107 on Linux and 103 on FreeBSD.
Communication over the control channel is conducted using JSON
structures. See the
`Control Channel section in the Kea Developer's Guide
<https://reports.kea.isc.org/dev_guide/d2/d96/ctrlSocket.html>`__
for more details.
The DHCPv6 server supports the following operational commands:
- :isccmd:`build-report`
- :isccmd:`config-get`
- :isccmd:`config-hash-get`
- :isccmd:`config-reload`
- :isccmd:`config-set`
- :isccmd:`config-test`
- :isccmd:`config-write`
- :isccmd:`dhcp-disable`
- :isccmd:`dhcp-enable`
- :isccmd:`leases-reclaim`
- :isccmd:`list-commands`
- :isccmd:`shutdown`
- :isccmd:`status-get`
- :isccmd:`version-get`
as described in :ref:`commands-common`. In addition, it supports the
following statistics-related commands:
- :isccmd:`statistic-get`
- :isccmd:`statistic-reset`
- :isccmd:`statistic-remove`
- :isccmd:`statistic-get`-all
- :isccmd:`statistic-reset`-all
- :isccmd:`statistic-remove`-all
- :isccmd:`statistic-sample-age-set`
- :isccmd:`statistic-sample-age-set`-all
- :isccmd:`statistic-sample-count-set`
- :isccmd:`statistic-sample-count-set`-all
as described in :ref:`command-stats`.
.. _dhcp6-user-contexts:
User Contexts in IPv6
=====================
Kea allows the loading of hook libraries that can sometimes benefit from
additional parameters. If such a parameter is specific to the whole
library, it is typically defined as a parameter for the hook library.
However, sometimes there is a need to specify parameters that are
different for each pool.
See :ref:`user-context` for additional background regarding the
user-context idea. See :ref:`user-context-hooks` for a discussion from the
hooks perspective.
User contexts can be specified at global scope; at the shared-network, subnet,
pool, client-class, option-data, or definition level; and via host
reservation. One other useful feature is the ability to store comments or
descriptions.
Let's consider an example deployment of lightweight 4over6, an
IPv6 transition technology that allows mapping IPv6 prefixes into full
or partial IPv4 addresses. In the DHCP context, these are specific
parameters that are supposed to be delivered to clients in the form of
additional options. Values of these options are correlated to delegated
prefixes, so it is reasonable to keep these parameters together with the
prefix delegation (PD) pool. On the other hand, lightweight 4over6 is not a commonly used
feature, so it is not a part of the base Kea code. The solution to this
problem is to specify a user context. For each PD pool that is expected to be
used for lightweight 4over6, a user context with extra parameters is
defined. Those extra parameters will be used by a hook library
and loaded only when dynamic calculation of the lightweight 4over6
option is actually needed. An example configuration looks as follows:
::
"Dhcp6": {
"subnet6": [ {
"pd-pools": [
{
"prefix": "2001:db8::",
"prefix-len": 56,
"delegated-len": 64,
# This is a pool specific context.
"user-context": {
"threshold-percent": 85,
"v4-network": "192.168.0.0/16",
"v4-overflow": "10.0.0.0/16",
"lw4over6-sharing-ratio": 64,
"lw4over6-v4-pool": "192.0.2.0/24",
"lw4over6-sysports-exclude": true,
"lw4over6-bind-prefix-len": 56
}
} ],
"id": 1,
"subnet": "2001:db8::/32",
# This is a subnet-specific context. Any type of
# information can be entered here as long as it is valid JSON.
"user-context": {
"comment": "Those v4-v6 migration technologies are tricky.",
"experimental": true,
"billing-department": 42,
"contacts": [ "Alice", "Bob" ]
}
} ]
}
Kea does not interpret or use the user-context information; it simply
stores it and makes it available to the hook libraries. It is up to each
hook library to extract that information and use it. The parser
translates a ``comment`` entry into a user context with the entry, which
allows a comment to be attached inside the configuration itself.
.. _dhcp6-std:
Supported DHCPv6 Standards
==========================
The following standards are currently supported in Kea:
- *Dynamic Host Configuration Protocol for IPv6*, `RFC
3315 <https://tools.ietf.org/html/rfc3315>`__: Supported messages are
SOLICIT, ADVERTISE, REQUEST, RELEASE, RENEW, REBIND,
INFORMATION-REQUEST, CONFIRM, DECLINE and REPLY. The only
unsupported message is RECONFIGURE.
- *Dynamic Host Configuration Protocol (DHCPv6) Options for
Session Initiation Protocol (SIP) Servers*, `RFC 3319
<https://tools.ietf.org/html/rfc3319>`__: All defined options are supported.
- *IPv6 Prefix Options for Dynamic Host Configuration Protocol (DHCP)
version 6*, `RFC 3633 <https://tools.ietf.org/html/rfc3633>`__:
Supported options are IA_PD and IA_PREFIX. Also supported is the
status code NoPrefixAvail.
- *DNS Configuration options for Dynamic Host Configuration Protocol for IPv6
(DHCPv6)*, `RFC 3646 <https://tools.ietf.org/html/rfc3646>`__: All defined
options are supported.
- *Stateless Dynamic Host Configuration Protocol (DHCP) Service for IPv6*, `RFC
3736 <https://tools.ietf.org/html/rfc3736>`__: Server operation in
stateless mode is supported. Kea is currently server-only, so the client side
is not implemented.
- *Information Refresh Time Option for Dynamic Host Configuration Protocol for
IPv6 (DHCPv6)*, `RFC 4242 <https://tools.ietf.org/html/rfc4242>`__: The
sole defined option (``information-refresh-time``) is supported.
- *The Dynamic Host Configuration Protocol for IPv6 (DHCPv6) Relay
Agent Remote-ID Option*, `RFC
4649 <https://tools.ietf.org/html/rfc4649>`__: The REMOTE-ID option is
supported.
- *Resolution of Fully Qualified Domain Name (FQDN) Conflicts among Dynamic Host
Configuration Protocol (DHCP) Clients*, `RFC 4703
<https://tools.ietf.org/html/rfc4703>`__: The DHCPv6 server uses the DHCP-DDNS
server to resolve conflicts.
- *The Dynamic Host Configuration Protocol for IPv6 (DHCPv6) Client
Fully Qualified Domain Name (FQDN) Option*, `RFC
4704 <https://tools.ietf.org/html/rfc4704>`__: The supported option is
CLIENT_FQDN.
- *Dynamic Host Configuration Protocol for IPv6 (DHCPv6) Option for
Dual-Stack Lite*, `RFC 6334 <https://tools.ietf.org/html/rfc6334>`__:
The AFTR-Name DHCPv6 Option is supported.
- *Relay-Supplied DHCP Options*, `RFC
6422 <https://tools.ietf.org/html/rfc6422>`__: The full functionality is
supported: OPTION_RSOO; the ability of the server to echo back the
options; verification of whether an option is RSOO-enabled; the ability to mark
additional options as RSOO-enabled.
- *Prefix Exclude Option for DHCPv6-based Prefix Delegation*, `RFC
6603 <https://tools.ietf.org/html/rfc6603>`__: The Prefix Exclude option
is supported.
- *Client Link-Layer Address Option in DHCPv6*, `RFC
6939 <https://tools.ietf.org/html/rfc6939>`__: The supported option is
the client link-layer address option.
- *Issues and Recommendations with Multiple Stateful DHCPv6 Options*,
`RFC 7550 <https://tools.ietf.org/html/rfc7550>`__: All
recommendations related to the DHCPv6 server operation are supported.
- *DHCPv6 Options for Configuration of Softwire Address and Port-Mapped
Clients*, `RFC 7598 <https://tools.ietf.org/html/rfc7598>`__: All
options indicated in this specification are supported by the DHCPv6
server.
- *Generalized UDP Source Port for DHCP Relay*, `RFC 8357
<https://tools.ietf.org/html/rfc8357>`__: The Kea server is able
to handle Relay Source Port option in a received Relay-forward
message, remembers the UDP port and sends back Relay-reply with a
copy of the option to the relay agent using this UDP port.
- *Dynamic Host Configuration Protocol for IPv6 (DHCPv6)*, `RFC 8415
<https://tools.ietf.org/html/rfc8415>`__: This new DHCPv6 protocol specification
obsoletes RFC 3315, RFC 3633, RFC 3736, RFC 4242, RFC 7083, RFC 7283,
and RFC 7550. All features, with the exception of the RECONFIGURE mechanism and
the now-deprecated temporary addresses (IA_TA) mechanism, are supported.
- *Captive-Portal Identification in DHCP and Router Advertisements (RAs)*, `RFC 8910
<https://tools.ietf.org/html/rfc8910>`__: The Kea server can configure both v4
and v6 versions of the captive portal options.
.. _dhcp6-limit:
DHCPv6 Server Limitations
=========================
These are the current known limitations of the Kea DHCPv6 server software. Most of
them are reflections of the current stage of development and should be
treated as “not implemented yet”, rather than actual limitations.
- The server will allocate, renew, or rebind a maximum of one lease for
a particular IA option (IA_NA or IA_PD) sent by a client. `RFC
8415 <https://tools.ietf.org/html/rfc8415>`__ allows for multiple
addresses or prefixes to be allocated for a single IA.
- Temporary addresses are not supported. There is no intention to ever
implement this feature, as it is deprecated in `RFC 8415
<https://tools.ietf.org/html/rfc8415>`__.
- Client reconfiguration (RECONFIGURE) is not yet supported.
.. _dhcp6-srv-examples:
Kea DHCPv6 Server Examples
==========================
A collection of simple-to-use examples for the DHCPv6 component of Kea
is available with the source files, located in the ``doc/examples/kea6``
directory.
.. _dhcp6-cb:
Configuration Backend in DHCPv6
===============================
In the :ref:`config-backend` section we have described the Configuration
Backend (CB) feature, its applicability, and its limitations. This section focuses
on the usage of the CB with the DHCPv6 server. It lists the supported
parameters, describes limitations, and gives examples of DHCPv6
server configurations to take advantage of the CB. Please also refer to
the corresponding section :ref:`dhcp4-cb` for DHCPv4-specific usage of
the CB.
.. _dhcp6-cb-parameters:
Supported Parameters
--------------------
The ultimate goal for the CB is to serve as a central configuration
repository for one or multiple Kea servers connected to a database.
In currently supported Kea versions, only a subset of
the DHCPv6 server parameters can be configured in the database. All other
parameters must be specified in the JSON configuration file, if
required.
All supported parameters can be configured via :ischooklib:`libdhcp_cb_cmds.so`.
The general rule is that
scalar global parameters are set using
:isccmd:`remote-global-parameter6-set`; shared-network-specific parameters
are set using :isccmd:`remote-network6-set`; and subnet-level and pool-level
parameters are set using :isccmd:`remote-subnet6-set`. Whenever
there is an exception to this general rule, it is highlighted in the
table. Non-scalar global parameters have dedicated commands; for example,
the global DHCPv6 options (``option-data``) are modified using
:isccmd:`remote-option6-global-set`. Client classes, together with class-specific
option definitions and DHCPv6 options, are configured using the
:isccmd:`remote-class6-set` command.
The :ref:`cb-sharing` section explains the concept of shareable
and non-shareable configuration elements and the limitations for
sharing them between multiple servers. In the DHCP configuration (both DHCPv4
and DHCPv6), the shareable configuration elements are subnets and shared
networks. Thus, they can be explicitly associated with multiple server tags.
The global parameters, option definitions, and global options are non-shareable
and can be associated with only one server tag. This rule does not apply
to the configuration elements associated with ``all`` servers. Any configuration
element associated with ``all`` servers (using the ``all`` keyword as a server tag) is
used by all servers connecting to the configuration database.
The following table lists DHCPv6-specific parameters supported by the
Configuration Backend, with an indication of the level of the hierarchy
at which it is currently supported.
.. table:: List of DHCPv6 parameters supported by the Configuration Backend
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| Parameter | Global | Client | Shared | Subnet | Pool | Prefix |
| | | Class | Network | | | Delegation |
| | | | | | | Pool |
+=============================+============================+===========+===========+===========+===========+============+
| allocator | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| cache-max-age | yes | n/a | no | no | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| cache-threshold | yes | n/a | no | no | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| calculate-tee-times | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| client-class | n/a | n/a | yes | yes | yes | yes |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| ddns-send-update | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| ddns-override-no-update | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| ddns-override-client-update | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| ddns-replace-client-name | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| ddns-generated-prefix | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| ddns-qualifying-suffix | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| decline-probation-period | yes | n/a | n/a | n/a | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| delegated-len | n/a | n/a | n/a | n/a | n/a | yes |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| dhcp4o6-port | yes | n/a | n/a | n/a | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| excluded-prefix | n/a | n/a | n/a | n/a | n/a | yes |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| excluded-prefix-len | n/a | n/a | n/a | n/a | n/a | yes |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| hostname-char-set | no | n/a | no | no | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| hostname-char-replacement | no | n/a | no | no | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| interface | n/a | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| interface-id | n/a | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| max-preferred-lifetime | yes | yes | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| max-valid-lifetime | yes | yes | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| min-preferred-lifetime | yes | yes | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| min-valid-lifetime | yes | yes | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| option-data | yes (via | yes | yes | yes | yes | yes |
| | remote-option6-global-set) | | | | | |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| option-def | yes (via | yes | n/a | n/a | n/a | n/a |
| | remote-option-def6-set) | | | | | |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| pd-allocator | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| preferred-lifetime | yes | yes | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| prefix | n/a | n/a | n/a | n/a | n/a | yes |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| prefix-len | n/a | n/a | n/a | n/a | n/a | yes |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| rapid-commit | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| rebind-timer | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| relay | n/a | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| renew-timer | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| require-client-classes | n/a | n/a | yes | yes | yes | yes |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| reservation-mode | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| reservations-global | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| reservations-in-subnet | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| reservations-out-of-pool | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| t1-percent | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| t2-percent | yes | n/a | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
| valid-lifetime | yes | yes | yes | yes | n/a | n/a |
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
- ``yes`` - indicates that the parameter is supported at the given
level of the hierarchy and can be configured via the Configuration Backend.
- ``no`` - indicates that a parameter is supported at the given level
of the hierarchy but cannot be configured via the Configuration Backend.
- ``n/a`` - indicates that a given parameter is not applicable
at the particular level of the hierarchy or that the
server does not support the parameter at that level.
.. _dhcp6-cb-json:
Enabling the Configuration Backend
----------------------------------
Consider the following configuration snippet, which uses a MySQL configuration
database:
.. code-block:: json
{
"Dhcp6": {
"server-tag": "my DHCPv6 server",
"config-control": {
"config-databases": [
{
"type": "mysql",
"name": "kea",
"user": "kea",
"password": "kea",
"host": "2001:db8:1::1",
"port": 3302
}
],
"config-fetch-wait-time": 20
},
"hooks-libraries": [
{
"library": "/usr/local/lib/kea/hooks/libdhcp_mysql_cb.so"
},
{
"library": "/usr/local/lib/kea/hooks/libdhcp_cb_cmds.so"
}
]
}
}
The configuration structure is almost identical to that of the DHCPv4 server
(see :ref:`dhcp4-cb-json` for the detailed description).
.. _dhcp6-compatibility:
Kea DHCPv6 Compatibility Configuration Parameters
=================================================
ISC's intention is for Kea to follow the RFC documents to promote better standards
compliance. However, many buggy DHCP implementations already exist that cannot be
easily fixed or upgraded. Therefore, Kea provides an easy-to-use compatibility
mode for broken or non-compliant clients. For that purpose, the compatibility option must be
enabled to permit uncommon practices:
.. code-block:: json
{
"Dhcp6": {
"compatibility": {
}
}
}
Lenient Option Parsing
----------------------
By default, DHCPv6 option 16's ``vendor-class-data`` field is parsed as a set of
length-value pairs. Same for tuple fields defined in custom options.
With ``"lenient-option-parsing": true``, if a length ever exceeds the rest of
the option's buffer, previous versions of Kea returned a log message ``unable to
parse the opaque data tuple, the buffer length is x, but the tuple length is y``
with ``x < y``; this no longer occurs. Instead, the value is considered to be the rest of the buffer,
or in terms of the log message above, the tuple length ``y`` becomes ``x``.
Enabling this flag is expected to improve compatibility with devices such as RAD
MiNID.
.. code-block:: json
{
"Dhcp6": {
"compatibility": {
"lenient-option-parsing": true
}
}
}
.. _dhcp6_allocation_strategies:
Address Allocation Strategies in DHCPv6
=======================================
A DHCP server follows a complicated algorithm to select a DHCPv6 lease for a client.
It prefers assigning specific addresses or delegated prefixes requested by the client
and the ones for which the client has reservations. If the client requests no particular
lease and has no reservations, or other clients are already using any requested leases, the server must
find another available lease within the configured pools. A server function called
an "allocator" is responsible in Kea for finding an available lease in such a case.
The Kea DHCPv6 server provides configuration parameters to select different allocators
at the global, shared-network, and subnet levels. It also
allows for selecting different allocation strategies for address assignments and
prefix delegation.
Consider the following example:
.. code-block:: json
{
"Dhcp6": {
"allocator": "iterative",
"pd-allocator": "random",
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/64",
"allocator": "random"
},
{
"id": 2,
"subnet": "2001:db8:2::/64",
"pd-allocator": "iterative"
}
]
}
}
The iterative allocator is globally selected for address assignments, while the
random allocator is globally selected for prefix delegation. These settings
are selectively overridden at the subnet level.
The following sections describe the supported allocators and their
recommended uses.
Allocators Comparison
---------------------
In the table below, we briefly compare the supported allocators. The
detailed allocators' descriptions are in later sections.
.. table:: Comparison of the lease allocators supported by Kea DHCPv6
+------------------+-----------------------------+------------------------------+-----------------------+------------------------------+----------------+
| Allocator | Low Utilization Performance | High Utilization Performance | Lease Randomization | Startup/Configuration | Memory Usage |
+==================+=============================+==============================+=======================+==============================+================+
| Iterative | very high | low | no | very fast | low |
+------------------+-----------------------------+------------------------------+-----------------------+------------------------------+----------------+
| Random | high | low | yes | very fast | high (varying) |
+------------------+-----------------------------+------------------------------+-----------------------+------------------------------+----------------+
| Free Lease Queue | high | high | yes | slow (depends on pool sizes) | high (varying) |
+------------------+-----------------------------+------------------------------+-----------------------+------------------------------+----------------+
Iterative Allocator
-------------------
This is the default allocator used by the Kea DHCPv6 server. It remembers the
last offered lease and offers the following sequential lease to the next client.
For example, it may offer addresses in this order: ``2001:db8:1::10``,
``2001:db8:1::11``, ``2001:db8:1::12``, and so on. Similarly, it offers the
next sequential delegated prefix after the previous one to the next client. The time to
find and offer the next lease is very short; thus, this is the most performant
allocator when pool utilization is low and there is a high probability
that the next selected lease is available.
The iterative allocation underperforms when multiple DHCP servers share a lease
database or are connected to a cluster. The servers tend to offer and allocate
the same blocks of addresses to different clients independently, which causes many
allocation conflicts between the servers and retransmissions by clients. A random
allocation addresses this issue by dispersing the allocation order.
Random Allocator
----------------
The random allocator uses a uniform randomization function to select offered
addresses and delegated prefixes from subnet pools. It is suitable in deployments
where multiple servers are connected
to a shared database or a database cluster. By dispersing the offered leases, the
servers minimize the risk of allocating the same lease to two different clients at
the same or nearly the same time. In addition, it improves the server's
resilience against attacks based on allocation predictability.
The random allocator is, however, slightly slower than the iterative allocator.
Moreover, it increases the server's memory consumption because it must remember
randomized leases to avoid offering them repeatedly. Memory consumption grows
with the number of offered leases; in other words, larger pools and more
clients increase memory consumption by random allocation.
Free Lease Queue Allocator (Prefix Delegation Only)
---------------------------------------------------
This is a sophisticated allocator whose use should be considered in subnets
with highly utilized delegated prefix pools. In such cases, it can take a
considerable amount of time for the iterative or random allocator to find
an available prefix, because they must repeatedly check whether there is a
valid lease for a prefix they will offer. The number of checks can be as
high as the number of delegated prefixes in the subnet when the subnet pools
are exhausted, which can have a direct negative impact on the DHCP response time for
each request.
The Free Lease Queue (FLQ) allocator tracks lease allocations and de-allocations
and maintains a running list of available delegated prefixes for each pool.
It allows an available lease to be selected within a constant time, regardless of
the subnet pools' utilization. The allocator continuously updates the list of
free leases by removing any allocated leases and adding released or
reclaimed ones.
The following configuration snippet shows how to select the FLQ allocator
for prefix delegation in a subnet:
.. code-block:: json
{
"Dhcp6": {
"subnet6": [
{
"id": 1,
"subnet": "2001:db8:1::/64",
"pd-allocator": "flq"
}
]
}
}
.. note::
The Free Lease Queue allocator can only be used for DHCPv6 prefix delegation.
An attempt to use this allocator for address assignment (with the ``allocator``
parameter) will cause a configuration error. DHCPv6 address pools are
typically very large and their utilization is low; in these situation, the benefits
of using the FLQ allocator diminish. The amount of time required for the
allocator to populate the free lease queue would cause the server to freeze
upon startup.
There are several considerations that the administrator should take into account
before using this allocator for prefix delegation. The FLQ allocator can heavily
impact the server's startup and reconfiguration time, because the allocator
has to populate the list of free leases for each subnet where it is used.
These delays can be observed both during the configuration reload and when
the subnets are created using :ischooklib:`libdhcp_subnet_cmds.so`. The allocator
increases the memory consumption to hold the list of free leases,
proportional to the total size of the pools for which this allocator is used.
Finally, lease reclamation must be enabled with a low value of the
``reclaim-timer-wait-time`` parameter, to ensure that the server frequently
collects expired leases and makes them available for allocation via the
free lease queue. Expired leases are not considered free by
the allocator until they are reclaimed by the server. See
:ref:`lease-reclamation` for more details about the lease reclamation process.
We recommend that the FLQ allocator be selected
only after careful consideration. The server puts no restrictions on the
delegated prefix pool sizes used with the FLQ allocator, so we advise users to
test how long it takes for the server to load the pools before deploying the
configuration using the FLQ allocator in production. We also recommend
specifying another allocator type in the global configuration settings
and overriding this selection at the subnet or shared-network level, to use
the FLQ allocator only for selected subnets. That way, when a new subnet is
added without an allocator specification, the global setting is used, thus
avoiding unnecessary impact on the server's startup time.
Like the random allocator, the FLQ allocator offers leases in
random order, which makes it suitable for use with a shared lease database.
|