summaryrefslogtreecommitdiffstats
path: root/docs/changes-by-section-casablanca.rst
blob: 713321e337a1a166fa1f75804f1e7b49fbd2061d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
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
.. Modifications Copyright © 2017-2018 AT&T Intellectual Property.

.. Licensed under the Creative Commons License, Attribution 4.0 Intl.
   (the "License"); you may not use this documentation except in compliance
   with the License. You may obtain a copy of the License at

.. https://creativecommons.org/licenses/by/4.0/

.. Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.


Requirement Changes Introduced in Casablanca
--------------------------------------------

This document summarizes the requirement changes by section that were
introduced between the Beijing release and
Casablanca release. Click on the requirement number to
navigate to the

.. contents::
    :depth: 2

Summary of Changes
^^^^^^^^^^^^^^^^^^

* **Requirements Added:** 102
* **Requirements Changed:** 232
* **Requirements Removed:** 63


Configuration Management > Ansible Standards and Capabilities > xNF Configuration via Ansible Requirements > Ansible Client Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~

.. container:: note

    :need:`R-24482`

    The xNF **MUST** provide Ansible playbooks that are designed to run using
    an inventory hosts file in a supported format; with site group that shall
    be used to add site specific configurations to the target xNF VM(s) as
    needed.


.. container:: note

    :need:`R-45197`

    The xNF **MUST** define the "from=" clause to provide the list of IP
    addresses of the Ansible Servers in the Cluster, separated by coma, to
    restrict use of the SSH key pair to elements that are part of the Ansible
    Cluster owner of the issued and assigned mechanized user ID.


.. container:: note

    :need:`R-67124`

    The xNF **MUST** provide Ansible playbooks that are designed to run using
    an inventory hosts file in a supported format; with group names matching
    VNFC 3-character string adding "vip" for groups with virtual IP addresses
    shared by multiple VMs as seen in examples provided in Appendix.


.. container:: note

    :need:`R-73459`

    The xNF **MUST** provide the ability to include a "from=" clause in SSH
    public keys associated with mechanized user IDs created for an Ansible
    Server cluster to use for xNF VM authentication.


.. container:: note

    :need:`R-94567`

    The xNF **MUST** provide Ansible playbooks that are designed to run using
    an inventory hosts file in a supported format with only IP addresses or
    IP addresses and VM/xNF names.


.. container:: note

    :need:`R-97345`

    The xNF **MUST** permit authentication, using root account, only right
    after instantiation and until post-instantiation configuration is
    completed.


.. container:: note

    :need:`R-97451`

    The xNF **MUST** provide the ability to remove root access once
    post-instantiation configuration (Configure) is completed.


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-32217`

    The xNF **MUST** have routable management IP addresses or FQDNs that
    are reachable via the Ansible Server for the endpoints (VMs) of a
    xNF that playbooks will target. ONAP will initiate requests to the
    Ansible Server for invocation of playbooks against these end
    points [#7.3.3]_.


.. container:: note

    :need:`R-91745`

    The xNF **MUST** update the Ansible Server and other entities
    storing and using the SSH keys for authentication when the SSH
    keys used by Ansible are regenerated/updated.

    **Note**: Ansible Server itself may be used to upload new SSH public
    keys onto supported xNFs.


.. container:: note

    :need:`R-82018`

    The xNF **MUST** load the Ansible Server SSH public key onto xNF
    VM(s) /root/.ssh/authorized_keys as part of instantiation. Alternative,
    is for Ansible Server SSH public key to be loaded onto xNF VM(s) under
    /home/<Mechanized user ID>/.ssh/authorized_keys as part of instantiation,
    when a Mechanized user ID is created during instantiation, and Configure
    and all playbooks are designed to use a mechanized user ID only for
    authentication (never using root authentication during Configure playbook
    run). This will allow the Ansible Server to authenticate to perform
    post-instantiation configuration without manual intervention and without
    requiring specific xNF login IDs and passwords.

    *CAUTION*: For xNFs configured using Ansible, to eliminate the need
    for manual steps, post-instantiation and pre-configuration, to
    upload of SSH public keys, SSH public keys loaded during (heat)
    instantiation shall be preserved and not removed by (heat) embedded
    (userdata) scripts.


.. container:: note

    :need:`R-35401`

    The xNF **MUST** support SSH and allow SSH access by the
    Ansible server to the endpoint VM(s) and comply with the Network
    Cloud Service Provider guidelines for authentication and access.


.. container:: note

    :need:`R-92866`

    The xNF **MUST** include as part of post-instantiation configuration
    done by Ansible Playbooks the removal/update of the SSH public key from
    /root/.ssh/authorized_keys, and update of SSH keys loaded through
    instantiation to support Ansible. This may include creating Mechanized user
    ID(s) used by the Ansible Server(s) on VNF VM(s) and uploading and
    installing new SSH keys used by the mechanized use ID(s).


Configuration Management > Ansible Standards and Capabilities > xNF Configuration via Ansible Requirements > Ansible Playbook Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-24189`

    The xNF provider **MUST** deliver a new set of playbooks that includes
    all updated and unchanged playbooks for any new revision to an existing
    set of playbooks.


.. container:: note

    :need:`R-49751`

    The xNF **MUST** support Ansible playbooks that are compatible with
    Ansible version 2.6 or later.


.. container:: note

    :need:`R-49911`

    The xNF provider **MUST** assign a new point release to the updated
    playbook set. The functionality of a new playbook set must be tested before
    it is deployed to the production.


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-48698`

    The xNF **MUST** utilize information from key value pairs that will be
    provided by the Ansible Server as "extra-vars" during invocation to
    execute the desired xNF action. The "extra-vars" attribute-value pairs
    are passed to the Ansible Server by an APPC/SDN-C as part of the
    Rest API request. If the playbook requires files, they must also be
    supplied using the methodology detailed in the Ansible Server API, unless
    they are bundled with playbooks, example, generic templates. Any files
    containing instance specific info (attribute-value pairs), not obtainable
    from any ONAP inventory databases or other sources, referenced and used an
    input by playbooks, shall be provisioned (and distributed) in advance of
    use, e.g., xNF instantiation. Recommendation is to avoid these instance
    specific, manually created in advance of instantiation, files.


.. container:: note

    :need:`R-43353`

    The xNF **MUST** return control from Ansible Playbooks only after all
    tasks performed by playbook are fully complete, signaling that the
    playbook completed all tasks. When starting services, return control
    only after all services are up. This is critical for workflows where
    the next steps are dependent on prior tasks being fully completed.


.. container:: note

    :need:`R-51442`

    The xNF **SHOULD** use playbooks that are designed to
    automatically 'rollback' to the original state in case of any errors
    for actions that change state of the xNF (e.g., configure).

    **Note**: In case rollback at the playbook level is not supported or
    possible, the xNF provider shall provide alternative rollback
    mechanism (e.g., for a small xNF the rollback mechanism may rely
    on workflow to terminate and re-instantiate VNF VMs and then re-run
    playbook(s)). Backing up updated files is also recommended to support
    rollback when soft rollback is feasible.


.. container:: note

    :need:`R-50252`

    The xNF **MUST** write to a response file in JSON format that will be
    retrieved and made available by the Ansible Server if, as part of a xNF
    action (e.g., audit), a playbook is required to return any xNF
    information/response. The text files must be written in the main playbook
    home directory, in JSON format. The JSON file must be created for the xNF
    with the name '<xNF name>_results.txt'. All playbook output results, for
    all xNF VMs, to be provided as a response to the request, must be written
    to this response file.


.. container:: note

    :need:`R-49396`

    The xNF **MUST** support each APPC/SDN-C xNF action
    by invocation of **one** playbook [#7.3.4]_. The playbook will be responsible
    for executing all necessary tasks (as well as calling other playbooks)
    to complete the request.


.. container:: note

    :need:`R-02651`

    The xNF **SHOULD** use available backup capabilities to save a
    copy of configuration files before implementing changes to support
    operations such as backing out of software upgrades, configuration
    changes or other work as this will help backing out of configuration
    changes when needed.


.. container:: note

    :need:`R-58301`

    The xNF **SHOULD NOT** use playbooks that make requests to
    Cloud resources e.g. Openstack (nova, neutron, glance, heat, etc.);
    therefore, there is no use for Cloud specific variables like Openstack
    UUIDs in Ansible Playbook related artifacts.

    **Rationale**: Flows that require interactions with Cloud services e.g.
    Openstack shall rely on workflows run by an Orchestrator
    (Change Management) or other capability (such as a control loop or
    Operations GUI) outside Ansible Server which can be executed by a
    APPC/SDN-C. There are policies, as part of Control Loop
    models, that send remediation action requests to an APPC/SDN-C; these
    are triggered as a response to an event or correlated events published
    to Event Bus.


Configuration Management > Chef Standards and Capabilities > xNF Configuration via Chef Requirements > Chef Roles/Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-26567`

    The xNF Package **MUST** include a run list of
    roles/cookbooks/recipes, for each supported xNF action, that will
    perform the desired xNF action in its entirety as specified by ONAP
    (see Section 7.c, APPC/SDN-C APIs and Behavior, for list of xNF
    actions and requirements), when triggered by a chef-client run list
    in JSON file.


Configuration Management > Controller Interactions With xNF > Configuration Commands
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-20741`

    The xNF **MUST** support APPC/SDN-C ``Configure`` command.


.. container:: note

    :need:`R-94084`

    The xNF **MUST** support APPC/SDN-C ``ConfigScaleOut`` command.


.. container:: note

    :need:`R-32981`

    The xNF **MUST** support APPC ``ConfigBackup`` command.


.. container:: note

    :need:`R-48247`

    The xNF **MUST** support APPC ``ConfigRestore`` command.


.. container:: note

    :need:`R-56385`

    The xNF **MUST** support APPC ``Audit`` command.


.. container:: note

    :need:`R-19366`

    The xNF **MUST** support APPC ``ConfigModify`` command.


Configuration Management > Controller Interactions With xNF > HealthCheck and Failure Related Commands
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-41430`

    The xNF **MUST** support APPC/SDN-C ``HealthCheck`` command.


Configuration Management > Controller Interactions With xNF > Lifecycle Management Related Commands
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-328086`

    The xNF **MUST**, if serving as a distribution point or anchor point for
    steering point from source to destination, support the ONAP Controller's
    ``DistributeTraffic`` command.


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-12706`

    The xNF **MUST** support APPC/SDN-C ``QuiesceTraffic`` command.


.. container:: note

    :need:`R-49466`

    The xNF **MUST** support APPC/SDN-C ``UpgradeSoftware`` command.


.. container:: note

    :need:`R-82811`

    The xNF **MUST** support APPC ``StartApplication`` command.


.. container:: note

    :need:`R-07251`

    The xNF **MUST** support APPC/SDN-C ``ResumeTraffic`` command.


.. container:: note

    :need:`R-45856`

    The xNF **MUST** support APPC/SDN-C ``UpgradePostCheck`` command.


.. container:: note

    :need:`R-65641`

    The xNF **MUST** support APPC/SDN-C ``UpgradeBackOut`` command.


.. container:: note

    :need:`R-83146`

    The xNF **MUST** support APPC ``StopApplication`` command.


.. container:: note

    :need:`R-97343`

    The xNF **MUST** support APPC/SDN-C ``UpgradeBackup`` command.


.. container:: note

    :need:`R-19922`

    The xNF **MUST** support APPC/SDN-C ``UpgradePrecheck`` command.


Configuration Management > NETCONF Standards and Capabilities > xNF Configuration via NETCONF Requirements > NETCONF Server Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-18733`

    The xNF **MUST** implement the protocol operation:
    ``discard-changes()`` - Revert the candidate configuration
    data store to the running configuration.


.. container:: note

    :need:`R-29488`

    The xNF **MUST** implement the protocol operation:
    ``get-config(source, filter`` - Retrieve a (filtered subset of
    a) configuration from the configuration data store source.


.. container:: note

    :need:`R-70496`

    The xNF **MUST** implement the protocol operation:
    ``commit(confirmed, confirm-timeout)`` - Commit candidate
    configuration data store to the running configuration.


.. container:: note

    :need:`R-44281`

    The xNF **MUST** implement the protocol operation:
    ``edit-config(target, default-operation, test-option, error-option,
    config)`` - Edit the target configuration data store by merging,
    replacing, creating, or deleting new config elements.


.. container:: note

    :need:`R-02597`

    The xNF **MUST** implement the protocol operation:
    ``lock(target)`` - Lock the configuration data store target.


.. container:: note

    :need:`R-90007`

    The xNF **MUST** implement the protocol operation:
    ``close-session()`` - Gracefully close the current session.


.. container:: note

    :need:`R-11235`

    The xNF **MUST** implement the protocol operation:
    ``kill-session(session``- Force the termination of **session**.


.. container:: note

    :need:`R-96554`

    The xNF **MUST** implement the protocol operation:
    ``unlock(target)`` - Unlock the configuration data store target.


.. container:: note

    :need:`R-88031`

    The xNF **SHOULD** implement the protocol operation:
    ``delete-config(target)`` - Delete the named configuration
    data store target.


.. container:: note

    :need:`R-29324`

    The xNF **SHOULD** implement the protocol operation:
    ``copy-config(target, source)`` - Copy the content of the
    configuration data store source to the configuration data store target.


Contrail Resource Parameters > Contrail Network Parameters > External Networks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-02164`

    When a VNF's Heat Orchestration Template's Contrail resource
    has a property that
    references an external network that requires the network's
    Fully Qualified Domain Name (FQDN), the property parameter

    * **MUST** follow the format ``{network-role}_net_fqdn``
    * **MUST** be declared as type ``string``
    * **MUST NOT** be enumerated in the VNF's Heat Orchestration Template's
      Environment File


Heat > Cinder Volumes
^^^^^^^^^^^^^^^^^^^^^


Requirements Removed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    R-79531

    The VNF Heat Orchestration Template **MUST** define
    "outputs" in the volume template for each Cinder volume
    resource universally unique identifier (UUID) (i.e. ONAP
    Volume Template Output Parameters).


Heat > Heat Orchestration Template Format > Heat Orchestration Template Structure > resources > metadata
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Removed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    R-97199

    A VNF's Heat Orchestration Template's OS::Nova::Server
    resource **MUST** contain the attribute "metadata".


Heat > Heat Template Constructs > Heat Files Support (get_file)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Removed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    R-62177

    When using the intrinsic function get_file, the included files
    **MUST** have unique file names within the scope of the VNF.


Heat > Heat Template Constructs > Nested Heat Template Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Removed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    R-89868

    The VNF Heat Orchestration Template **MUST** have unique
    file names within the scope of the VNF for a nested heat yaml file.


Heat > Networking > External Networks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Removed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    R-29865

    When a VNF connects to an external network, a network role,
    referred to as the '{network-role}' **MUST** be assigned to the
    external network for use in the VNF's Heat Orchestration Template.


Heat > Networking > Internal Networks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Removed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    R-34726

    If a VNF's port is connected to an internal network and the port
    is created in the same Heat Orchestration Template as the internal network,
    then the port resource **MUST** use a 'get_resource' to obtain
    the network UUID.


Heat > ONAP Resource ID and Parameter Naming Convention > Contrail Resource Parameters > Contrail Network Parameters > External Networks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Removed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    R-73228

    A VNF's Heat Orchestration Template's parameter
    '{network-role}_net_fqdn'
    **MUST** be declared as type 'string'.


Heat > ONAP Resource ID and Parameter Naming Convention > Resource: OS::Nova::Server – Metadata Parameters > vm_role
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Removed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    R-46823

    A VNF's Heat Orchestration Template's OS::Nova::Server
    Resource metadata map value parameter 'vnf_name' **MUST** be
    either

     - enumerated in the VNF's Heat Orchestration
       Template's environment file.

     - hard coded in the VNF's Heat Orchestration
       Template's OS::Nova::Resource metadata property.


Heat > ONAP Support of Environment Files
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Removed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    R-22656

    The VNF Heat Orchestration Template **MUST** have a
    corresponding environment file for a Cinder Volume Module.


.. container:: note

    R-35727

    The VNF Heat Orchestration Template **MUST** have a
    corresponding environment file for an Incremental module.


.. container:: note

    R-67205

    The VNF Heat Orchestration Template **MUST** have a corresponding
    environment file for a Base Module.


Monitoring & Management > Data Structure Specification of the Event Record
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-120182`

    The xNF provider **MUST** indicate specific conditions that may arise, and
    recommend actions that may be taken at specific thresholds, or if specific
    conditions repeat within a specified time interval, using the semantics and
    syntax described by the :doc:`VES Event Registration specification<../../../../vnfsdk/module.git/files/VESEventRegistration_3_0>`.


.. container:: note

    :need:`R-123044`

    The xNF Provider **MAY** require that specific events, identified by their
    ``eventName``, require that certain fields, which are optional in the common
    event format, must be present when they are published.


.. container:: note

    :need:`R-520802`

    The xNF provider **MUST** provide a YAML file formatted in adherence with
    the :doc:`VES Event Registration specification<../../../../vnfsdk/module.git/files/VESEventRegistration_3_0>`
    that defines the following information for each event produced by the VNF:

    * ``eventName``
    * Required fields
    * Optional fields
    * Any special handling to be performed for that event


.. container:: note

    :need:`R-570134`

    The events produced by the xNF **MUST** must be compliant with the common
    event format defined in the
    :doc:`VES Event Listener<../../../../vnfsdk/model.git/docs/files/VESEventListener_7_0_1>`
    specification.


Monitoring & Management > Event Records - Data Structure Description > Common Event Header
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-528866`

    The VNF **MUST** produce VES events that include the following mandatory
    fields in the common event header.

     * ``domain`` - the event domain enumeration
     * ``eventId`` - the event key unique to the event source
     * ``eventName`` - the unique event name
     * ``lastEpochMicrosec`` - the latest unix time (aka epoch time) associated
       with the event
     * ``priority`` - the processing priority enumeration
     * ``reportingEntityName`` - name of the entity reporting the event or
       detecting a problem in another xNF
     * ``sequence`` - the ordering of events communicated by an event source
     * ``sourceName`` - name of the entity experiencing the event issue, which
       may be detected and reported by a separate reporting entity
     * ``startEpochMicrosec`` - the earliest unix time (aka epoch time)
       associated with the event
     * ``version`` - the version of the event header
     * ``vesEventListenerVersion`` - Version of the VES event listener API spec
       that this event is compliant with


Monitoring & Management > Event Records - Data Structure Description > Miscellaneous
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-283988`

    The VNF, when publishing events, **MUST NOT** send information through
    extensible structures if the event specification has explicitly defined
    fields for that information.


.. container:: note

    :need:`R-408813`

    The VNF, when publishing events, **MUST** pass all information it is
    able to collect even if the information field is identified as optional.
    However, if the data cannot be collected, then optional fields can be
    omitted.


.. container:: note

    :need:`R-470963`

    The VNF, when publishing events, **MUST** leverage camel case to separate
    words and acronyms used as keys that will be sent through extensible fields.
    When an acronym is used as the key, then only the first letter shall be
    capitalized.


Monitoring & Management > Monitoring & Management Requirements > Asynchronous and Synchronous Data Delivery
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-332680`

    The xNF **SHOULD** deliver all syslog messages to the VES Collector per the
    specifications in Monitoring and Management chapter.


Monitoring & Management > Monitoring & Management Requirements > Bulk Performance Measurement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-440220`

    The xNF **SHOULD** support File transferring protocol, such as FTPES or SFTP,
    when supporting the event-driven bulk transfer of monitoring data.


.. container:: note

    :need:`R-75943`

    The xNF **SHOULD** support the data schema defined in 3GPP TS 32.435, when
    supporting the event-driven bulk transfer of monitoring data.


.. container:: note

    :need:`R-841740`

    The xNF **SHOULD** support FileReady VES event for event-driven bulk transfer
    of monitoring data.


Monitoring & Management > Monitoring & Management Requirements > Google Protocol Buffers (GPB)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-257367`

    The xNF, when leveraging Google Protocol Buffers for events, **MUST**
    serialize the events using native Google Protocol Buffers (GPB) according
    to the following guidelines:

       * The keys are represented as integers pointing to the system resources
         for the xNF being monitored
       * The values correspond to integers or strings that identify the
         operational state of the VNF resource, such a statistics counters and
         the state of an xNF resource.
       * The required Google Protocol Buffers (GPB) metadata is provided in the
         form of .proto files.


.. container:: note

    :need:`R-978752`

    The xNF providers **MUST** provide the Service Provider the following
    artifacts to support the delivery of high-volume xNF telemetry to
    DCAE via GPB over TLS/TCP:

       * A valid VES Event .proto definition file, to be used validate and
         decode an event
       * A valid high volume measurement .proto definition file, to be used for
         processing high volume events
       * A supporting PM content metadata file to be used by analytics
         applications to process high volume measurement events


Monitoring & Management > Monitoring & Management Requirements > JSON
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-19624`

    The xNF, when leveraging JSON for events, **MUST** encode and serialize
    content delivered to ONAP using JSON (RFC 7159) plain text format.
    High-volume data is to be encoded and serialized using
    `Avro <http://avro.apache.org/>`_, where the Avro [#7.4.1]_ data
    format are described using JSON.


Monitoring & Management > Monitoring & Management Requirements > Reporting Frequency
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-146931`

    The xNF **MUST** report exactly one Measurement event per period
    per source name.


Monitoring & Management > Monitoring & Management Requirements > VNF telemetry via standardized interface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-821473`

    The xNF MUST produce heartbeat indicators consisting of events containing
    the common event header only per the VES Listener Specification.


Requirements Removed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    R-51910

    The xNF **MUST** provide all telemetry (e.g., fault event
    records, syslog records, performance records etc.) to ONAP using the
    model, format and mechanisms described in this section.


Monitoring & Management > Transports and Protocols Supporting Resource Interfaces
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-798933`

    The xNF **SHOULD** deliver event records that fall into the event domains
    supported by VES.


.. container:: note

    :need:`R-821839`

    The xNF **MUST** deliver event records to ONAP using the common transport
    mechanisms and protocols defined in this document.


.. container:: note

    :need:`R-932071`

    The xNF provider **MUST** reach agreement with the Service Provider on
    the selected methods for encoding, serialization and data delivery
    prior to the on-boarding of the xNF into ONAP SDC Design Studio.


Monitoring & Management > Transports and Protocols Supporting Resource Interfaces > Bulk Telemetry Transmission
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-908291`

    The XNF **MAY** leverage bulk xNF telemetry transmission mechanism, as
    depicted in Figure 4, in instances where other transmission methods are not
    practical or advisable.


Monitoring & Management > Transports and Protocols Supporting Resource Interfaces > xNF Telemetry using Google Protocol Buffers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-697654`

    The xNF **MAY** leverage the Google Protocol Buffers (GPB) delivery model
    depicted in Figure 3 to support real-time performance management (PM) data.
    In this model the VES events are streamed as binary-encoded GBPs over via
    TCP sockets.


Monitoring & Management > Transports and Protocols Supporting Resource Interfaces > xNF Telemetry using VES/JSON Model
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-659655`

    The xNF **SHOULD** leverage the JSON-driven model, as depicted in Figure 2,
    for data delivery unless there are specific performance or operational
    concerns agreed upon by the Service Provider that would warrant using an
    alternate model.


ONAP Heat Cinder Volumes
^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-270358`

    A VNF's Heat Orchestration Template's Cinder Volume Template **MUST**
    contain either

    * An ``OS::Cinder::Volume`` resource
    * An ``OS::Heat::ResourceGroup`` resource that references a Nested YAML
      file that contains an ``OS::Cinder::Volume`` resource
    * A resource that defines the property ``type`` as a Nested YAML file
      (i.e., static nesting) and the Nested YAML contains
      an ``OS::Cinder::Volume`` resource


ONAP Heat Heat Template Constructs > Heat Files Support (get_file)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-05050`

    A VNF's Heat Orchestration Templates intrinsic function
    ``get_file`` <content key> **MAY** be used:

        * more than once in a VNF's Heat Orchestration Template
        * in two or more of a VNF's Heat Orchestration Templates
        * in a VNF's Heat Orchestration Templates nested YAML file


.. container:: note

    :need:`R-76718`

    If a VNF's Heat Orchestration Template uses the intrinsic function
    ``get_file``, the ``get_file`` target **MUST** be referenced in
    the Heat Orchestration Template by file name.


.. container:: note

    :need:`R-41888`

    A VNF's Heat Orchestration Template intrinsic function
    ``get_file`` **MUST NOT** utilize URL-based file retrieval.


.. container:: note

    :need:`R-87848`

    When using the intrinsic function get_file, ONAP does not support
    a directory hierarchy for included files. All files must be in a
    single, flat directory per VNF. A VNF's Heat Orchestration
    Template's ``get_file`` target files **MUST** be in the same
    directory hierarchy as the VNF's Heat Orchestration Templates.


ONAP Heat Heat Template Constructs > Nested Heat Templates > Nested Heat Template Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-70112`

    A VNF's Heat Orchestration Template **MUST** reference a Nested YAML
    file by name. The use of ``resource_registry`` in the VNF's Heat
    Orchestration Templates Environment File **MUST NOT** be used.


ONAP Heat Networking > External Networks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-00606`

    A VNF **MAY** be connected to zero, one or more than one external
    network.


ONAP Heat Networking > Internal Networks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-46461`

    A VNF's port connected to an internal network **MUST NOT** use the port
    for the purpose of reaching VMs in another VNF and/or an
    external gateway and/or
    external router.


.. container:: note

    :need:`R-52425`

    A VNF's port connected to an internal network **MUST**
    use the port for the purpose of reaching VMs in the same VNF.


.. container:: note

    :need:`R-87096`

    A VNF **MAY** contain zero, one or more than one internal network.


ONAP Heat Orchestration Template Format
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-92635`

    A VNF's Heat Orchestration Template **MUST** be compliant with the
    OpenStack Template Guide.


ONAP Heat Orchestration Template Format > Environment File Format
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-86285`

    A VNF's Heat Orchestration template **MUST** have a
    corresponding environment file.


.. container:: note

    :need:`R-68198`

    A VNF's Heat Orchestration template's Environment File's
    ``parameters:`` section **MAY** (or **MAY NOT**) enumerate parameters.


.. container:: note

    :need:`R-03324`

    A VNF's Heat Orchestration template's Environment File **MUST**
    contain the ``parameters:`` section.


ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-90279`

    A VNF Heat Orchestration's template's parameter **MUST** be used
    in a resource with the exception of the parameters for the
    ``OS::Nova::Server`` resource property ``availability_zone``.


.. container:: note

    :need:`R-91273`

    A VNF Heat Orchestration's template's parameter for the
    ``OS::Nova::Server`` resource property ``availability_zone``
    **MAY NOT** be used in any ``OS::Nova::Server``.


ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > parameters > constraints
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-88863`

    A VNF's Heat Orchestration Template's parameter defined
    in a non-nested YAML file as type
    ``number`` **MUST** have a parameter constraint of ``range`` or
    ``allowed_values`` defined.


.. container:: note

    :need:`R-00011`

    A VNF's Heat Orchestration Template's parameter defined
    in a nested YAML file
    **MUST NOT** have a parameter constraint defined.


.. container:: note

    :need:`R-06613`

    A VNF's Heat Orchestration Template's parameter defined
    in a non-nested YAML file as type
    ``boolean`` **MAY** have a parameter constraint defined.


.. container:: note

    :need:`R-40518`

    A VNF's Heat Orchestration Template's parameter defined
    in a non-nested YAML file as type
    ``string`` **MAY** have a parameter constraint defined.


.. container:: note

    :need:`R-96227`

    A VNF's Heat Orchestration Template's parameter defined
    in a non-nested YAML file as type
    ``json`` **MAY** have a parameter constraint defined.


.. container:: note

    :need:`R-79817`

    A VNF's Heat Orchestration Template's parameter defined
    in a non-nested YAML file as
    type ``comma_delimited_list`` **MAY** have a parameter constraint defined.


ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > parameters > default
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-26124`

    If a VNF Heat Orchestration Template parameter has a default value,
    it **MUST** be enumerated in the environment file.


ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > parameters > type
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-11441`

    A VNF's Heat Orchestration Template's parameter type **MUST** be one of
    the following values:

    * ``string``
    * ``number``
    * ``json``
    * ``comma_delimited_list``
    * ``boolean``


ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > resources
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-40551`

    A VNF's Heat Orchestration Template's Nested YAML files **MAY**
    (or **MAY NOT**) contain the section ``resources:``.


ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > resources > deletion_policy
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-43740`

    VNF's Heat Orchestration Template's Resource **MAY** declare the
    attribute ``deletion_policy:``.


ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > resources > external_id
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-78569`

    VNF's Heat Orchestration Template's Resource **MAY** declare the
    attribute ``external_id:``.


ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > resources > metadata
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-67386`

    A VNF's Heat Orchestration Template's Resource **MAY** declare the
    attribute ``metadata``.


ONAP Heat Orchestration Template Format > Heat Orchestration Template Structure > resources > properties
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-10834`

    If a VNF's Heat Orchestration Template resource attribute
    ``property:`` uses a nested ``get_param``, the nested
    ``get_param`` **MUST** reference an index.


ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Base Modules
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-81339`

    A VNF Heat Orchestration Template's Base Module file name **MUST** include
    case insensitive 'base' in the filename and
    **MUST** match one of the following four
    formats:

     1.) ``base_<text>.y[a]ml``

     2.) ``<text>_base.y[a]ml``

     3.) ``base.y[a]ml``

     4.) ``<text>_base_<text>``.y[a]ml

    where ``<text>`` **MUST** contain only alphanumeric characters and
    underscores '_' and **MUST NOT** contain the case insensitive word ``base``.


ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Cinder Volume Modules
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-31141`

    VNF Heat Orchestration Template's Cinder Volume Module's Environment File
    **MUST** be named identical to the VNF Heat Orchestration Template's
    Cinder Volume Module with ``.y[a]ml`` replaced with ``.env``.


.. container:: note

    :need:`R-82732`

    A VNF Heat Orchestration Template's Cinder Volume Module **MUST**
    be named identical to the base or incremental module it is supporting with
    ``_volume`` appended.


ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Incremental Modules
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-87247`

    VNF Heat Orchestration Template's Incremental Module file name
    **MUST** contain only alphanumeric characters and underscores
    '_' and **MUST NOT** contain the case insensitive word ``base``.


ONAP Heat Orchestration Templates Overview > ONAP Heat Orchestration Template Filenames > Nested Heat file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-76057`

    VNF Heat Orchestration Template's Nested YAML file name **MUST** contain
    only alphanumeric characters and underscores '_' and
    **MUST NOT** contain the case insensitive word ``base``.


ONAP Heat Orchestration Templates Overview > ONAP VNF Modularity Overview
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-38474`

    A VNF's Base Module **MUST** have a corresponding Environment File.


.. container:: note

    :need:`R-20974`

    At orchestration time, the VNF's Base Module **MUST**
    be deployed first, prior to any incremental modules.


.. container:: note

    :need:`R-53433`

    A VNF's Cinder Volume Module **MUST** have a corresponding environment file


.. container:: note

    :need:`R-11200`

    A VNF's Cinder Volume Module, when it exists, **MUST** be 1:1
    with a Base module or Incremental module.


.. container:: note

    :need:`R-33132`

    A VNF's Heat Orchestration Template **MAY** be
     1.) Base Module Heat Orchestration Template (also referred to as a
         Base Module),
     2.) Incremental Module Heat Orchestration Template (referred to as
         an Incremental Module), or
     3.) a Cinder Volume Module Heat Orchestration Template (referred to as
         Cinder Volume  Module).


.. container:: note

    :need:`R-81725`

    A VNF's Incremental Module **MUST** have a corresponding Environment File


.. container:: note

    :need:`R-37028`

    A VNF **MUST** be composed of one Base Module


ONAP Heat Orchestration Templates Overview > Output Parameters > ONAP Volume Module Output Parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-07443`

    A VNF's Heat Orchestration Templates' Cinder Volume Module Output
    Parameter's name and type **MUST** match the input parameter name and type
    in the corresponding Base Module or Incremental Module unless the Output
    Parameter is of the type ``comma_delimited_list``, then the corresponding
    input parameter **MUST** be declared as type ``json``.


.. container:: note

    :need:`R-89913`

    A VNF's Heat Orchestration Template's Cinder Volume Module Output
    Parameter(s)
    **MUST** include the
    UUID(s) of the Cinder Volumes created in template,
    while others **MAY** be included.


ONAP Heat VNF Modularity
^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-61001`

    A shared Heat Orchestration Template resource is a resource that **MUST**
    be defined in the base module and will be referenced by one or
    more resources in one or more incremental modules.

    The UUID of the shared resource (created in the base module) **MUST** be
    exposed by declaring a parameter in the
    ``outputs`` section of the base module.

    For ECOMP to provided the UUID value of the shared resource to the
    incremental module, the parameter name defined in the ``outputs``
    section of the base module **MUST** be defined as a parameter
    in the ``parameters`` section of the incremental module.

    ECOMP will capture the output parameter name and value in the base module
    and provide the value to the corresponding parameter(s) in the
    incremental module(s).


ONAP Output Parameter Names > Predefined Output Parameters > OAM Management IP Addresses
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-56287`

    If the VNF's OAM Management IP Address is assigned by ONAP SDN-C and
    assigned in the VNF's Heat Orchestration Template's via a heat resource
    ``OS::Neutron::Port`` property ``fixed_ips`` map property
    ``ip_adress`` parameter (e.g., ``{vm-type}_{network-role}_ip_{index}``,
    ``{vm-type}_{network-role}_v6_ip_{index}``)
    and the OAM IP Address is required to be inventoried in ONAP A&AI,
    then the parameter **MUST** be echoed in an output statement.

    .. code-block:: yaml

      outputs:
          oam_management_v4_address:
            value: {get_param: {vm-type}_{network-role}_ip_{index} }
          oam_management_v6_address:
            value: {get_param: {vm-type}_{network-role}_v6_ip_{index} }


.. container:: note

    :need:`R-48987`

    If the VNF's OAM Management IP Address is cloud assigned and
    and the OAM IP Address is required to be inventoried in ONAP A&AI,
    then the parameter **MUST** be obtained by the
    resource ``OS::Neutron::Port``
    attribute ``ip_address``.


.. container:: note

    :need:`R-94669`

    If a VNF has one IPv6 OAM Management IP Address and the
    IP Address needs to be inventoried in ONAP's A&AI
    database, an output parameter **MUST** be declared in only one of the
    VNF's Heat Orchestration Templates and the parameter **MUST** be named
    ``oam_management_v6_address``.


ONAP TOSCA VNFD Requirements > TOSCA VNF Descriptor > Capability Types
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-67895`

    The VNFD provided by VNF vendor may use the below described TOSCA
    capabilities. An on-boarding entity (ONAP SDC) **MUST** support them.

      **tosca.capabilities.nfv.VirtualBindable**

        A node type that includes the VirtualBindable capability indicates
        that it can be pointed by **tosca.relationships.nfv.VirtualBindsTo**
        relationship type.

      **tosca.capabilities.nfv.VirtualLinkable**

        A node type that includes the VirtualLinkable capability indicates
        that it can be pointed by **tosca.relationships.nfv.VirtualLinksTo**
        relationship.

      **tosca.capabilities.nfv.ExtVirtualLinkable**

        A node type that includes the ExtVirtualLinkable capability
        indicates that it can be pointed by
        **tosca.relationships.nfv.VirtualLinksTo** relationship.

      **Note**: This capability type is used in Casablanca how it does
      not exist in the last SOL001 draft

      **tosca.capabilities.nfv.VirtualCompute** and
      **tosca.capabilities.nfv.VirtualStorage** includes flavours of VDU


ONAP TOSCA VNFD Requirements > TOSCA VNF Descriptor > Data Types
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-54356`

    The below table includes the data types used by NFV node and is based
    on TOSCA/YAML constructs specified in draft GS NFV-SOL 001. The node
    data definitions/attributes used in VNFD **MUST** comply with the below
    table.


.. container:: note

    :need:`R-54876`

    The below table describes the data types used for LCM configuration
    and is based on TOSCA constructs specified in draft GS NFV-SOL 001.
    The LCM configuration data elements used in VNFD **MUST** comply
    with the below table.


ONAP TOSCA VNFD Requirements > TOSCA VNF Descriptor > General
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-15837`

    The following table defines the major TOSCA  Types specified in
    ETSI NFV-SOL001 standard draft. The VNFD provided by a VNF vendor
    **MUST** comply with the below definitions:


.. container:: note

    :need:`R-17852`

    The VNFD **MAY** include TOSCA/YAML definitions that are not part of
    NFV Profile. If provided, these definitions MUST comply with TOSCA
    Simple Profile in YAML v.1.2.


.. container:: note

    :need:`R-35854`

    The VNF Descriptor (VNFD) provided by VNF vendor **MUST** comply with
    TOSCA/YAML based Service template for VNF descriptor specified in
    ETSI NFV-SOL001.

    **Note**: As the ETSI NFV-SOL001 is work in progress the below tables
    summarizes the TOSCA definitions agreed to be part of current version
    of NFV profile and that VNFD MUST comply with in ONAP Release 2+
    Requirements.


.. container:: note

    :need:`R-46527`

    A VNFD is a deployment template which describes a VNF in terms of
    deployment and operational behavior requirements. It contains
    virtualized resources (nodes) requirements as well as connectivity
    and interfaces requirements and **MUST** comply with info elements
    specified in ETSI GS NFV-IFA 011. The main parts of the VNFD are
    the following:

      - VNF topology: it is modeled in a cloud agnostic way using virtualized
        containers and their connectivity. Virtual Deployment Units (VDU)
        describe the capabilities of the virtualized containers, such as
        virtual CPU, RAM, disks; their connectivity is modeled with VDU
        Connection Point Descriptors (VduCpd), Virtual Link Descriptors
        (VnfVld) and VNF External Connection Point Descriptors
        (VnfExternalCpd);

      - VNF deployment aspects: they are described in one or more
        deployment flavours, including configurable parameters, instantiation
        levels, placement constraints (affinity / antiaffinity), minimum and
        maximum VDU instance numbers. Horizontal scaling is modeled with
        scaling aspects and the respective scaling levels in the deployment
        flavours;

    **Note**: The deployment aspects (deployment flavour etc.) are postponed
    for future ONAP releases.

      - VNF lifecycle management (LCM) operations: describes the LCM operations
        supported per deployment flavour, and their input parameters;
        Note, thatthe actual LCM implementation resides in a different layer,
        namely referring to additional template artifacts.


.. container:: note

    :need:`R-65486`

    The VNFD **MUST** comply with ETSI GS NFV-SOL001 document endorsing
    the above mentioned NFV Profile and maintaining the gaps with the
    requirements specified in ETSI GS NFV-IFA011 standard.


ONAP TOSCA VNFD Requirements > TOSCA VNF Descriptor > Interface Types
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-32155`

    The VNFD provided by VNF vendor may use the below described TOSCA
    interface types. An on-boarding entity (ONAP SDC) **MUST** support them.

      **tosca.interfaces.nfv.vnf.lifecycle.Nfv** supports LCM operations


ONAP TOSCA VNFD Requirements > TOSCA VNF Descriptor > Relationship Types
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-95321`

    The VNFD provided by VNF vendor may use the below described TOSCA
    relationships. An on-boarding entity (ONAP SDC) **MUST** support them.

      **tosca.relationships.nfv.VirtualBindsTo**

        This relationship type represents an association relationship between
        VDU and CP node types.

      **tosca.relationships.nfv.VirtualLinksTo**

        This relationship type represents an association relationship between
        the VduCpd's and VirtualLinkDesc node types.


ONAP TOSCA VNFD Requirements > VNF CSAR Package > VNF Package Contents
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-01123`

    The VNF package Manifest file **MUST** contain: VNF package meta-data, a
    list of all artifacts (both internal and external) entry's including
    their respected URI's, an algorithm to calculate a digest and a digest
    result calculated on the content of each artifacts, as specified in
    ETSI GS NFV-SOL004. The VNF Package MUST include VNF Identification
    Data to uniquely identify the resource for a given VNF provider. The
    identification data must include: an identifier for the VNF, the name
    of the VNF as was given by the VNF provider, VNF description, VNF
    provider, and version.


.. container:: note

    :need:`R-10087`

    The VNF package **MUST** contain all standard artifacts as specified in
    ETSI GS NFV-SOL004 including Manifest file, VNFD (or Main TOSCA/YAML
    based Service Template) and other optional artifacts. CSAR Manifest
    file as per SOL004 - for example ROOT\\ **MainServiceTemplate.mf**


.. container:: note

    :need:`R-21322`

    The VNF provider **MUST** provide their testing scripts to support
    testing as specified in ETSI NFV-SOL004 - Testing directory in CSAR


.. container:: note

    :need:`R-26885`

    The VNF provider **MUST** provide the binaries and images needed to
    instantiate the VNF (VNF and VNFC images) either as:

      - Local artifact in CSAR: ROOT\\Artifacts\\ **VNF_Image.bin**

      - externally referred (by URI) artifact in Manifest file (also may be
        referred by VNF Descriptor)

    Note: Currently, ONAP doesn't have the capability of Image management,
    we upload the image into VIM/VNFM manually.


.. container:: note

    :need:`R-40820`

    The VNF provider MUST enumerate all of the open source licenses
    their VNF(s) incorporate. CSAR License directory as per ETSI SOL004.

    for example ROOT\\Licenses\\ **License_term.txt**


ONAP TOSCA VNFD Requirements > VNF CSAR Package > VNF Package Structure and Format
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-51347`

    The VNF package **MUST** be arranged as a CSAR archive as specified in
    TOSCA Simple Profile in YAML 1.2.


.. container:: note

    :need:`R-87234`

    The VNF package provided by a VNF vendor **MAY** be either with
    TOSCA-Metadata directory (CSAR Option 1) or without TOSCA-Metadata
    directory (CSAR Option 2) as specified in ETSI GS NFV-SOL004. On-boarding
    entity (ONAP SDC) must support both options.

    **Note:** SDC supports only the CSAR Option 1 in Casablanca. The Option 2
    will be considered in future ONAP releases,


PNF Plug and Play > PNF Plug and Play
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-01427`

    The PNF **MUST** support the provisioning of security and authentication
    parameters (HTTP username and password) in order to be able to authenticate
    with DCAE (in ONAP).

    Note: In R3, a username and password are used with the DCAE VES Event
    Listener which are used for HTTP Basic Authentication.

    Note: The configuration management and provisioning software are specific
    to a vendor architecture.


.. container:: note

    :need:`R-106240`

    The following VES Events **MUST** be supported by the PNF: pnfRegistration
    VES Event, HVol VES Event, and Fault VES Event. These are onboarded via
    he SDC Design Studio.

    Note: these VES Events are emitted from the PNF to support PNF Plug and
    Play, High Volume Measurements, and Fault events respectively.


.. container:: note

    :need:`R-17624`

    The PNF **MAY** support the optional parameters for Service
    Configuration Parameters.

    Note: These are detailed in the Stage 5 PnP

    Note: These parameters are optional, and not all PNFs will support any
    or all of these parameters, it is up to the vendor and service provider
    to ascertain which ones are supported up to an including all of the ones
    that have been defined. Note: It is expected that there will be a growing
    list of supported configuration parameters in future releases of ONAP.


.. container:: note

    :need:`R-256347`

    The PNF **MUST** support the Ansible protocol for a Service Configuration
    message exchange between the PNF and PNF Controller (in ONAP).

    Note: this exchange may be either Ansible, Chef, or NetConf depending on
    the PNF. Note: The PNF Controller may be VF-C, APP-C or SDN-C based on the
    PNF and PNF domain. Note: for R3 (Casablanca) only Ansible is supported.


.. container:: note

    :need:`R-258352`

    The PNF **MUST** support & accept the provisioning of an ONAP contact IP
    address (in IPv4 or IPv6 format).

    Note: For example, it a possibility is that an external EMS would configure
    & provision the ONAP contact IP address to the PNF (in either IPv4 or
    IPv6 format). For the PNF Plug and Play Use Case, this IP address is the
    service provider's "point of entry" to the DCAE VES Listener.

    Note: different service provider's network architecture may also require
    special setup to allow an external PNF to contact the ONAP installation.
    For example, in the AT&T network, a maintenance tunnel is used to access
    ONAP.


.. container:: note

    :need:`R-284934`

    If the PNF encounters an error authenticating, reaching the ONAP DCAE VES
    Event listener or recieves an error response from sending the pnfRegistration
    VES Event, it **MAY** log the error, and notify the operator.

    Note: the design of how errors are logged, retrieved and reported
    will be a vendor-specific architecture. Reporting faults and errors
    is also a vendor specific design. It is expected that the PNF shall
    have a means to log an error and notify a user when a fault condition
    occurs in trying to contact ONAP, authenticate or send a pnfRegistration
    event.


.. container:: note

    :need:`R-378131`

    (Error Case) - If an error is encountered by the PNF during a
    Service Configuration exchange with ONAP, the PNF **MAY** log the
    error and notify an operator.


.. container:: note

    :need:`R-56718`

    The PNF Vendor **MAY** provide software version(s) to be supported by PNF
    for SDC Design Studio PNF Model. This is set in the PNF Model property
    software_versions.


.. container:: note

    :need:`R-579051`

    The PNF **MAY** support a HTTP connection to the DCAE VES Event Listener.

    Note: HTTP is allowed but not recommended.


.. container:: note

    :need:`R-638216`

    (Error Case) - The PNF **MUST** support a configurable timer to stop the
    periodicity sending of the pnfRegistration VES event. If this timer expires
    during a Service Configuration exchange between the PNF and ONAP, it
    MAY log a time-out error and notify an operator.

    Note: It is expected that each vendor will enforce and define a PNF
    service configuration timeout period. This is because the PNF cannot
    wait indefinitely as there may also be a technician on-site trying to
    complete installation & commissioning. The management of the VES event
    exchange is also a requirement on the PNF to be developed by the PNF
    vendor.


.. container:: note

    :need:`R-686466`

    The PNF **MUST** support sending a pnfRegistration VES event.


.. container:: note

    :need:`R-707977`

    When the PNF receives a Service configuration from ONAP, the PNF **MUST**
    cease sending the pnfRegistration VES Event.


.. container:: note

    :need:`R-763774`

    The PNF **MUST** support a HTTPS connection to the DCAE VES Event
    Listener.


.. container:: note

    :need:`R-793716`

    The PNF **MUST** have "ONAP Aware" software which is capable of performing
    PNF PnP registration with ONAP. The "ONAP Aware" software is capable of
    performing the PNF PnP Registration with ONAP MUST either be loaded
    separately or integrated into the PNF software upon physical delivery
    and installation of the PNF.

    Note: It is up to the specific vendor to design the software management
    functions.


.. container:: note

    :need:`R-809261`

    The PNF **MUST** use a IP address to contact ONAP.

    Note: it is expected that an ONAP operator can ascertain the ONAP IP
    address or the security gateway to reach ONAP on the VID or ONAP portal
    GUI.

    Note: The ONAP contact IP address has been previously configured and
    provisioned prior to this step.

    Note: The ONAP IP address could be provisioned or resolved through
    FQDN & DNS.


.. container:: note

    :need:`R-894004`

    When the PNF sets up a HTTP or HTTPS connection, it **MUST** provide a
    username and password to the DCAE VES Collector for HTTP Basic
    Authentication.

    Note: HTTP Basic Authentication has 4 steps: Request, Authenticate,
    Authorization with Username/Password Credentials, and Authentication Status
    as per RFC7617 and RFC 2617.


.. container:: note

    :need:`R-952314`

    If the PNF set up a TLS connection and mutual (two-way) authentication is
    being used, then the PNF **MUST** provide its own X.509v3 Certificate to
    the DCAE VES Collector for authentication.

    Note: This allows TLS authentication by DCAE VES Collector.

    Note: The PNF got its X.509 certificate through Enrollment with an
    operator certificate authority or a X.509 vendor certificate from the
    vendor factory CA.

    Note: In R3 three authentication options are supported:

    (1) HTTP with Username & Password and no TLS.

    (2) HTTP with Username & Password & TLS with two-way certificate
        authentication.

    (3) HTTP with Username & Password & TLS with server-side
        certificate authentication.


.. container:: note

    :need:`R-980039`

    The PNF **MUST** send the pnfRegistration VES event periodically.


.. container:: note

    :need:`R-981585`

    The pnfRegistration VES event periodicity **MUST** be configurable.

    Note: The PNF uses the service configuration request as a semaphore to
    stop sending the pnfRegistration sent. See the requirement PNP-5360
    requirement.


Resource IDs
^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-98138`

    When a VNF's Heat Orchestration Template's resource is associated with a
    single internal network, the Resource ID **MUST** contain the text
    ``int_{network-role}``.


.. container:: note

    :need:`R-67793`

    When a VNF's Heat Orchestration Template's resource is associated
    with more than one ``{vm-type}`` and/or more than one internal and/or
    external network, the Resource ID **MUST** not contain the ``{vm-type}``
    and/or ``{network-role}``/``int_{network-role}``. It also should contain the
    term ``shared`` and/or contain text that identifies the VNF.


.. container:: note

    :need:`R-82115`

    When a VNF's Heat Orchestration Template's resource is associated with a
    single ``{vm-type}``
    and a single external network, the Resource ID text **MUST** contain both
    the ``{vm-type}``
    and the ``{network-role}``

    - the ``{vm-type}`` **MUST** appear before the ``{network-role}`` and
      **MUST** be separated by an underscore '_'


      - e.g., ``{vm-type}_{network-role}``, ``{vm-type}_{index}_{network-role}``


    - note that an ``{index}`` value **MAY** separate the ``{vm-type}`` and the
      ``{network-role}`` and when this occurs underscores **MUST** separate the
      three values.  (e.g., ``{vm-type}_{index}_{network-role}``).


.. container:: note

    :need:`R-82551`

    When a VNF's Heat Orchestration Template's resource is associated with a
    single ``{vm-type}`` and a single internal network, the Resource ID **MUST**
    contain both the ``{vm-type}`` and the ``int_{network-role}`` and

    - the ``{vm-type}`` **MUST** appear before the ``int_{network-role}`` and
      **MUST** be separated by an underscore '_'

      - (e.g., ``{vm-type}_int_{network-role}``,
        ``{vm-type}_{index}_int_{network-role}``)

    - note that an ``{index}`` value **MAY** separate the
      ``{vm-type}`` and the ``int_{network-role}`` and when this occurs
      underscores **MUST** separate the three values.
      (e.g., ``{vm-type}_{index}_int_{network-role}``).


Resource IDs > Contrail Heat Resources Resource ID Naming Convention > OS::ContrailV2::VirtualNetwork
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-99110`

    A VNF's Heat Orchestration Template's Resource
    ``OS::ContrailV2::VirtualNetwork`` Resource ID **MUST** use the naming convention

    1) ``int_{network-role}_network``

    or

    2) ``int_{network-role}_RVN`` where RVN represents Resource Virtual
       Network

    VNF Heat Orchestration Templates can only create internal networks.
    There is no ``{index}`` after ``{network-role}`` because ``{network-role}``
    **MUST** be unique in the scope of the VNF's
    Heat Orchestration Template.

    Note that option 1 is preferred.


Resource IDs > OpenStack Heat Resources Resource ID Naming Convention > OS::Neutron::Net
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-25720`

    A VNF's Heat Orchestration Template's Resource ``OS::Neutron::Net``
    Resource ID **MUST** use the naming convention

    * ``int_{network-role}_network``

    VNF Heat Orchestration Templates can only create internal networks.
    There is no ``{index}`` after ``{network-role}`` because ``{network-role}``
    **MUST** be unique in the scope of the VNF's
    Heat Orchestration Template.


Resource: OS::Neutron::Port - Parameters > Introduction > Items to Note
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-48880`

    If a VNF's Port is attached to an external network and the port's
    IP addresses are assigned by ONAP's SDN-Controller,
    the ``OS::Neutron::Port`` Resource's

    * property ``fixed_ips`` map property ``ip_address`` **MUST** be used
    * property ``fixed_ips`` map property ``subnet``
      **MUST NOT** be used


.. container:: note

    :need:`R-45602`

    If a VNF's Port is attached to a network (internal or external)
    and the port's IP addresses are cloud assigned by OpenStack's DHCP
    Service, the ``OS::Neutron::Port`` Resource's

    * property ``fixed_ips`` map property ``ip_address`` **MUST NOT** be used
    * property ``fixed_ips`` map property ``subnet``
      **MAY** be used


.. container:: note

    :need:`R-70964`

    If a VNF's Port is attached to an internal network and the port's
    IP addresses are statically assigned by the VNF's Heat Orchestration\
    Template (i.e., enumerated in the Heat Orchestration Template's
    environment file), the ``OS::Neutron::Port`` Resource's

    * property ``fixed_ips`` map property ``ip_address`` **MUST** be used
    * property ``fixed_ips`` map property ``subnet``
      **MUST NOT** be used


Resource: OS::Neutron::Port - Parameters > Property: allowed_address_pairs, Map Property: ip_address > VIP Assignment, External Networks, Supported by Automation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-35735`

    When the VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` is attaching to an external network (per the
    ONAP definition, see Requirement R-57424),
    and an IPv6 Virtual IP (VIP)
    address is assigned via ONAP automation
    using the property ``allowed_address_pairs``
    map property ``ip_address``,
    the parameter name **MUST** follow the
    naming convention

      * ``{vm-type}_{network-role}_floating_v6_ip``

    where

      * ``{vm-type}`` is the {vm-type} associated with the
        OS::Nova::Server
      * ``{network-role}`` is the {network-role} of the external
        network

    And the parameter **MUST** be declared as type ``string``.


.. container:: note

    :need:`R-41492`

    When the VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` is attaching to an external network (per the
    ONAP definition, see Requirement R-57424),
    and an IPv4 Virtual IP (VIP)
    address is assigned via ONAP automation
    using the property ``allowed_address_pairs``
    map property ``ip_address`` and
    the parameter name **MUST** follow the
    naming convention

      * ``{vm-type}_{network-role}_floating_ip``

    where

      * ``{vm-type}`` is the {vm-type} associated with the
        OS::Nova::Server
      * ``{network-role}`` is the {network-role} of the external
        network

    And the parameter **MUST** be declared as type ``string``.


Resource: OS::Neutron::Port - Parameters > Property: fixed_ips, Map Property: ip_address
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-28795`

    The VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` property ``fixed_ips``
    map property ``ip_address`` parameter
    ``{vm-type}_int_{network-role}_ip_{index}``
    **MUST** be enumerated in the
    VNF's Heat Orchestration Template's Environment File.


.. container:: note

    :need:`R-39841`

    The VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` property ``fixed_ips``
    map property ``ip_address`` parameter
    ``{vm-type}_{network-role}_ip_{index}``
    **MUST NOT** be enumerated in the
    VNF's Heat Orchestration Template's Environment File.


.. container:: note

    :need:`R-85235`

    When the VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` is attaching to an internal network (per the
    ONAP definition, see Requirements R-52425 and R-46461),
    and an IPv4 address is assigned
    using the property ``fixed_ips``
    map property ``ip_address`` and the parameter type is defined as a
    ``comma_delimited_list``,
    the parameter name **MUST** follow the
    naming convention

      * ``{vm-type}_int_{network-role}_ips``

    where

      * ``{vm-type}`` is the {vm-type} associated with the
        ``OS::Nova::Server``
      * ``{network-role}`` is the {network-role} of the internal
        network


.. container:: note

    :need:`R-78380`

    When the VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` is attaching to an internal network (per the
    ONAP definition, see Requirements R-52425 and R-46461),
    and an IPv4 address is assigned
    using the property ``fixed_ips``
    map property ``ip_address`` and the parameter type is
    defined as a ``string``,
    the parameter name **MUST** follow the
    naming convention

      * ``{vm-type}_int_{network-role}_ip_{index}``

    where

      * ``{vm-type}`` is the {vm-type} associated with the
        OS::Nova::Server
      * ``{network-role}`` is the {network-role} of the internal
        network
      * the value for ``{index`` must start at zero (0) and increment by one


.. container:: note

    :need:`R-90206`

    The VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` property ``fixed_ips``
    map property ``ip_address`` parameter
    ``{vm-type}_int_{network-role}_int_ips``
    **MUST** be enumerated in the
    VNF's Heat Orchestration Template's Environment File.


.. container:: note

    :need:`R-23503`

    When the VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` is attaching to an external network (per the
    ONAP definition, see Requirement R-57424),
    and an IPv6 address is assigned
    using the property ``fixed_ips``
    map property ``ip_address`` and the parameter type is defined as a
    ``comma_delimited_list``,
    the parameter name **MUST** follow the
    naming convention

      * ``{vm-type}_{network-role}_v6_ips``

    where

      * ``{vm-type}`` is the {vm-type} associated with the
        OS::Nova::Server
      * ``{network-role}`` is the {network-role} of the external
        network


.. container:: note

    :need:`R-87123`

    The VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` property ``fixed_ips``
    map property ``ip_address`` parameter
    ``{vm-type}_{network-role}_v6_ip_{index}``
    **MUST NOT** be enumerated in the
    VNF's Heat Orchestration Template's Environment File.


.. container:: note

    :need:`R-98569`

    The VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` property ``fixed_ips``
    map property ``ip_address`` parameter
    ``{vm-type}_int_{network-role}_v6_ips``
    **MUST** be enumerated in the
    VNF's Heat Orchestration Template's Environment File.


.. container:: note

    :need:`R-93496`

    The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``
    property ``fixed_ips``
    map property ``ip_address``
    parameter associated with an internal network, i.e.,

     * ``{vm-type}_int_{network-role}_ip_{index}``
     * ``{vm-type}_int_{network-role}_v6_ip_{index}``
     * ``{vm-type}_int_{network-role}_ips``
     * ``{vm-type}_int_{network-role}_v6_ips``


    **MUST** be enumerated in the Heat Orchestration
    Template's Environment File and IP addresses **MUST** be
    assigned.


.. container:: note

    :need:`R-40971`

    When the VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` is attaching to an external network (per the
    ONAP definition, see Requirement R-57424),
    and an IPv4 address is assigned
    using the property ``fixed_ips``
    map property ``ip_address`` and the parameter type is defined as a string,
    the parameter name **MUST** follow the
    naming convention

      * ``{vm-type}_{network-role}_ip_{index}``

      where

      * ``{vm-type}`` is the {vm-type} associated with the
        ``OS::Nova::Server``
      * ``{network-role}`` is the {network-role} of the external
        network
      * the value for ``{index}`` must start at zero (0) and increment by one


.. container:: note

    :need:`R-29765`

    When the VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` is attaching to an internal network (per the
    ONAP definition, see Requirements R-52425 and R-46461),
    and an IPv6 address is assigned
    using the property ``fixed_ips``
    map property ``ip_address`` and the parameter type is defined as a
    ``comma_delimited_list``,
    the parameter name **MUST** follow the
    naming convention

      * ``{vm-type}_int_{network-role}_v6_ips``

    where

      * ``{vm-type}`` is the {vm-type} associated with the
        ``OS::Nova::Server``
      * ``{network-role}`` is the {network-role} of the internal
        network


.. container:: note

    :need:`R-71577`

    When the VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` is attaching to an external network (per the
    ONAP definition, see Requirement R-57424),
    and an IPv6 address is assigned
    using the property ``fixed_ips``
    map property ``ip_address`` and the parameter type is defined as a string,
    the parameter name **MUST** follow the
    naming convention

      * ``{vm-type}_{network-role}_v6_ip_{index}``

      where

      * ``{vm-type}`` is the {vm-type} associated with the
        OS::Nova::Server
      * ``{network-role}`` is the {network-role} of the external
        network
      * the value for ``{index}`` must start at zero (0) and increment by one


.. container:: note

    :need:`R-62590`

    The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``
    property ``fixed_ips``
    map property ``ip_address``
    parameter associated with an external network, i.e.,

     * ``{vm-type}_{network-role}_ip_{index}``
     * ``{vm-type}_{network-role}_v6_ip_{index}``
     * ``{vm-type}_{network-role}_ips``
     * ``{vm-type}_{network-role}_v6_ips``


    **MUST NOT** be enumerated in the Heat Orchestration
    Template's Environment File.  ONAP provides the IP address
    assignments at orchestration time.


.. container:: note

    :need:`R-04697`

    When the VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` is attaching to an external network (per the
    ONAP definition, see Requirement R-57424),
    and an IPv4 address is assigned
    using the property ``fixed_ips``
    map property ``ip_address`` and the parameter type is defined as a
    ``comma_delimited_list``,
    the parameter name **MUST** follow the
    naming convention

      * ``{vm-type}_{network-role}_ips``

      where

      * ``{vm-type}`` is the {vm-type} associated with the
        ``OS::Nova::Server``
      * ``{network-role}`` is the {network-role} of the external
        network


.. container:: note

    :need:`R-97201`

    The VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` property ``fixed_ips``
    map property ``ip_address`` parameter
    ``{vm-type}_int_{network-role}_v6_ip_{index}``
    **MUST** be enumerated in the
    VNF's Heat Orchestration Template's Environment File.


.. container:: note

    :need:`R-27818`

    When the VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` is attaching to an internal network (per the
    ONAP definition, see RRequirements R-52425 and R-46461),
    and an IPv6 address is assigned
    using the property ``fixed_ips``
    map property ``ip_address`` and the parameter type is defined as a
    ``string``,
    the parameter name **MUST** follow the
    naming convention

      * ``{vm-type}_int_{network-role}_v6_ip_{index}``

    where

      * ``{vm-type}`` is the {vm-type} associated with the
        ``OS::Nova::Server``
      * ``{network-role}`` is the {network-role} of the internal
        network
      * the value for ``{index}`` must start at zero (0) and increment by one


Resource: OS::Neutron::Port - Parameters > Property: fixed_ips, Map Property: subnet
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-84123`

    When

      * the VNF's Heat Orchestration Template's
        resource ``OS::Neutron::Port`` in an Incremental Module is attaching
        to an internal network (per the ONAP definition, see
        Requirements R-52425 and R-46461)
        that is created in the Base Module, AND
      * an IPv4 address is being cloud assigned by OpenStack's DHCP Service AND
      * the internal network IPv4 subnet is to be specified
        using the property ``fixed_ips`` map property ``subnet``,

    the parameter **MUST** follow the naming convention

      * ``int_{network-role}_subnet_id``

    where

      * ``{network-role}`` is the network role of the internal network

    Note that the parameter **MUST** be defined as an ``output`` parameter in
    the base module.


.. container:: note

    :need:`R-62802`

    When the VNF's Heat Orchestration Template's
    resource ``OS::Neutron::Port`` is attaching
    to an external network (per the ONAP definition, see
    Requirement R-57424),
    and an IPv4 address is being cloud assigned by OpenStack's DHCP Service
    and the external network IPv4 subnet is to be specified
    using the property ``fixed_ips``
    map property ``subnet``, the parameter
    **MUST** follow the naming convention

      * ``{network-role}_subnet_id``

    where

      * ``{network-role}`` is the network role of the network.


.. container:: note

    :need:`R-22288`

    The VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` property ``fixed_ips``
    map property ``subnet`` parameter
    ``int_{network-role}_v6_subnet_id``
    **MUST NOT** be enumerated in the
    VNF's Heat Orchestration Template's Environment File.


.. container:: note

    :need:`R-76160`

    When

      * the VNF's Heat Orchestration Template's
        resource ``OS::Neutron::Port`` in an Incremental Module is attaching
        to an internal network (per the ONAP definition, see Requirements
        R-52425 and R-46461)
        that is created in the Base Module, AND
      * an IPv6 address is being cloud assigned by OpenStack's DHCP Service AND
      * the internal network IPv6 subnet is to be specified
        using the property ``fixed_ips`` map property ``subnet``,

    the parameter **MUST** follow the naming convention
    ``int_{network-role}_v6_subnet_id``,
    where ``{network-role}`` is the network role of the internal network.

    Note that the parameter **MUST** be defined as an ``output`` parameter in
    the base module.


.. container:: note

    :need:`R-15287`

    When the VNF's Heat Orchestration Template's
    resource ``OS::Neutron::Port`` is attaching
    to an external network (per the ONAP definition, see
    Requirement R-57424),
    and an IPv6 address is being cloud assigned by OpenStack's DHCP Service
    and the external network IPv6 subnet is to be specified
    using the property ``fixed_ips``
    map property ``subnet``, the parameter
    **MUST** follow the naming convention

      * ``{network-role}_v6_subnet_id``

    where

      * ``{network-role}`` is the network role of the network.


.. container:: note

    :need:`R-83677`

    The VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` property ``fixed_ips``
    map property ``subnet`` parameter
    ``{network-role}_subnet_id``
    **MUST NOT** be enumerated in the
    VNF's Heat Orchestration Template's Environment File.


.. container:: note

    :need:`R-80829`

    The VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` property ``fixed_ips``
    map property ``subnet`` parameter
    ``{network-role}_v6_subnet_id``
    **MUST NOT** be enumerated in the
    VNF's Heat Orchestration Template's Environment File.


.. container:: note

    :need:`R-38236`

    The VNF's Heat Orchestration Template's
    resource ``OS::Neutron::Port`` property ``fixed_ips``
    map property ``subnet`` parameter
    **MUST** be declared type ``string``.


.. container:: note

    :need:`R-69634`

    The VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` property ``fixed_ips``
    map property ``subnet`` parameter
    ``int_{network-role}_subnet_id``
    **MUST NOT** be enumerated in the
    VNF's Heat Orchestration Template's Environment File.


Resource: OS::Neutron::Port - Parameters > Property: network
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-29872`

    The VNF's Heat Orchestration Template's Resource ``OS::Neutron::Port``
    property ``network``
    parameter **MUST NOT** be enumerated in the Heat Orchestration
    Template's Environment File.


.. container:: note

    :need:`R-62983`

    When the VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` is attaching to an external network (per the
    ONAP definition, see Requirement R-57424), the
    ``network`` parameter name **MUST**

      * follow the naming convention ``{network-role}_net_id`` if the Neutron
        network UUID value is used to reference the network
      * follow the naming convention ``{network-role}_net_name`` if the
        OpenStack network name is used to reference the network.

    where ``{network-role}`` is the network-role of the external network
    and a ``get_param`` **MUST** be used as the intrinsic function.


.. container:: note

    :need:`R-93177`

    When the VNF's Heat Orchestration Template's resource
    ``OS::Neutron::Port`` is attaching to an internal network (per the
    ONAP definition, see Requirements R-52425 and R-46461),
    and the internal network is created in the
    same Heat Orchestration Template as the ``OS::Neutron::Port``,
    the ``network`` property value **MUST** obtain the UUID
    of the internal network by using the intrinsic function
    ``get_resource``
    and referencing the Resource ID of the internal network.


.. container:: note

    :need:`R-86182`

    When the VNF's Heat Orchestration Template's Resource
    ``OS::Neutron::Port`` is attaching to an internal network (per the
    ONAP definition, see Requirements R-52425 and R-46461),
    and the internal network is created in a
    different Heat Orchestration Template than the ``OS::Neutron::Port``,
    the ``network`` parameter name **MUST**

      * follow the naming convention ``int_{network-role}_net_id`` if the Neutron
        network UUID value is used to reference the network
      * follow the naming convention ``int_{network-role}_net_name`` if the
        OpenStack network name in is used to reference the network.

    where ``{network-role}`` is the network-role of the internal network and
    a ``get_param`` **MUST** be used as the intrinsic function.


Resource: OS::Nova::Server - Parameters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-304011`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource's

    * Resource ID
    * property ``image`` parameter name
    * property ``flavor`` parameter name
    * property ``name`` parameter name


    **MUST** contain the identical ``{vm-type}``
    and **MUST** follow the naming conventions defined
    in R-58670, R-45188, R-54171, R-87817, and R-29751.


Resource: OS::Nova::Server - Parameters > Property: Name
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-663631`

    The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``
    property ``name`` value **MUST** be be obtained via a ``get_param``.


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-40899`

    When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``
    property ``name`` parameter is defined as a ``string``, a parameter
    **MUST** be delcared for
    each ``OS::Nova::Server`` resource associated with the ``{vm-type}``.


.. container:: note

    :need:`R-54171`

    When the VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``
    property ``name`` parameter is defined as a ``string``,
    the parameter name **MUST** follow the naming convention
    ``{vm-type}_name_{index}``, where ``{index}`` is a numeric
    value that starts at
    zero and increments by one.


.. container:: note

    :need:`R-51430`

    The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``
    property
    ``name`` parameter **MUST** be declared as either type ``string``
    or type ``comma_delimited_list``.


Resource: OS::Nova::Server - Parameters > Property: Name > Contrail Issue with Values for OS::Nova::Server Property Name
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-44271`

    The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``
    property
    ``name`` parameter value **SHOULD NOT** contain special characters
    since the Contrail GUI has a limitation displaying special characters.

    However, if special characters must be used, the only special characters
    supported are: --- \" ! $ ' (\ \ ) = ~ ^ | @ ` { } [ ] > , . _


Resource: OS::Nova::Server - Parameters > Property: availability_zone
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-01359`

    A VNF's Heat Orchestration Template that contains an ``OS::Nova:Server``
    Resource **MAY** define a parameter for the property
    ``availability_zone`` that is not utilized in any ``OS::Nova::Server``
    resources in the Heat Orchestration Template.


.. container:: note

    :need:`R-98450`

    The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``
    property
    ``availability_zone`` parameter name **MUST** follow the naming convention
    ``availability_zone_{index}`` where the ``{index}``
    **MUST** start at zero and
    increment by one.


Resource: OS::Nova::Server - Parameters > Property: flavor
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-481670`

    The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``
    property ``flavor`` value **MUST** be be obtained via a ``get_param``.


Resource: OS::Nova::Server - Parameters > Property: image
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-901331`

    The VNF's Heat Orchestration Template's Resource ``OS::Nova::Server``
    property ``image`` value **MUST** be be obtained via a ``get_param``.


Resource: OS::Nova::Server Metadata Parameters > environment_context
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-13194`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property
    ``metadata`` key/value pair ``environment_context`` **MUST NOT**
    be enumerated in the Heat Orchestration Template's environment file.


.. container:: note

    :need:`R-56183`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata``key/value pair ``environment_context``
    parameter ``environment_context`` **MUST NOT**
    have parameter constraints defined.


.. container:: note

    :need:`R-20308`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``environment_context``
    parameter **MUST** be declared as ``environment_context`` and the
    parameter type **MUST** be defined as type: ``string``.


Resource: OS::Nova::Server Metadata Parameters > vf_module_id
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-86237`

    If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property
    ``metadata`` key/value pair ``vf_module_id`` is passed into a
    Nested YAML
    file, the key/value pair name ``vf_module_id`` **MUST NOT** change.


.. container:: note

    :need:`R-71493`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` **MUST**
    contain the key/value pair ``vf_module_id``
    and the value MUST be obtained via a ``get_param``.


.. container:: note

    :need:`R-82134`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property
    ``metadata`` key/value pair ``vf_module_id`` parameter **MUST**
    be declared as ``vf_module_id`` and the parameter **MUST**
    be defined as type: ``string``.


.. container:: note

    :need:`R-98374`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property
    ``metadata`` key/value pair ``vf_module_id`` parameter ``vf_module_id``
    **MUST NOT**
    have parameter constraints defined.


.. container:: note

    :need:`R-72871`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property
    ``metadata`` key/value pair ``vf_module_id`` parameter ``vf_module_id``
    **MUST NOT**
    be enumerated in the Heat Orchestration Template's environment file.


Resource: OS::Nova::Server Metadata Parameters > vf_module_index
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-37039`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property
    ``metadata`` key/value pair ``vf_module_index`` parameter
    ``vf_module_index`` **MUST NOT**
    be enumerated in the Heat Orchestration Template's environment file.


.. container:: note

    :need:`R-09811`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``vf_module_index`` **MUST NOT**
    have parameter constraints defined.


.. container:: note

    :need:`R-22441`

    If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``vf_module_index`` is passed into a
    Nested YAML file, the key/value pair
    ``vf_module_index`` **MUST NOT** change.


.. container:: note

    :need:`R-50816`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server``
    resource  property ``metadata`` **MAY**
    contain the key/value pair ``vf_module_index``
    and the value **MUST** be obtained via a ``get_param``.


.. container:: note

    :need:`R-55306`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``vf_module_index`` **MUST NOT**
    be used in a ``OS::Cinder::Volume`` resource and **MUST NOT** be
    used in VNF's Volume template;
    it is not supported.


.. container:: note

    :need:`R-54340`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property
    ``metadata`` key/value pair ``vf_module_index`` parameter **MUST**
    be declared as ``vf_module_index`` and the parameter **MUST** be
    defined as type: ``number``.


Resource: OS::Nova::Server Metadata Parameters > vf_module_name
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-68023`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` **SHOULD**
    contain the key/value pair ``vf_module_name`` and the value **MUST**
    be obtained via a ``get_param``.


.. container:: note

    :need:`R-49177`

    If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``vf_module_name`` is passed into a
    Nested YAML
    file, the key/value pair name ``vf_module_name`` **MUST NOT** change.


.. container:: note

    :need:`R-80374`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``vf_module_name``
    parameter ``vf_module_name`` **MUST NOT**
    be enumerated in the Heat Orchestration Template's environment file.


.. container:: note

    :need:`R-15480`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property
    ``metadata`` key/value pair ``vf_module_name`` parameter ``vf_module_name``
    **MUST NOT** have parameter constraints defined.


.. container:: note

    :need:`R-39067`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property
    ``metadata`` key/value pair ``vf_module_name`` parameter **MUST** be
    declared as ``vf_module_name`` and the parameter **MUST**
    be defined as type: ``string``.


Resource: OS::Nova::Server Metadata Parameters > vm_role
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-67597`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``vm_role`` parameter ``vm_role``
    **MUST NOT** have parameter constraints defined.


.. container:: note

    :need:`R-70757`

    If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``vm_role`` is passed into a Nested
    YAML
    file, the key/value pair name ``vm_role`` **MUST NOT** change.


.. container:: note

    :need:`R-86476`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``vm_role`` value **MUST**
    only contain alphanumeric characters and underscores (i.e., '_').


.. container:: note

    :need:`R-95430`

    If a VNF's Heat Orchestration Template's ``OS::Nova::Server``
    resource property
    ``metadata`` key/value pair ``vm_role`` value is obtained via
    ``get_param``, the parameter **MUST** be declared as ``vm_role``
    and the parameter **MUST** be defined as type: ``string``.


.. container:: note

    :need:`R-85328`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property
    ``metadata`` **MAY**
    contain the key/value pair ``vm_role`` and the value **MUST** be
    obtained either via

    - ``get_param``
    - hard coded in the key/value pair ``vm_role``.


Resource: OS::Nova::Server Metadata Parameters > vnf_id
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-44491`

    If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property
    ``metadata`` key/value pair ``vnf_id`` is passed into a Nested YAML
    file, the key/value pair name ``vnf_id`` **MUST NOT** change.


.. container:: note

    :need:`R-20856`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server``
    resource property
    ``metadata`` key/value pair ``vnf_id`` parameter ``vnf_id`` **MUST NOT**
    be enumerated in the Heat Orchestration Template's environment file.


.. container:: note

    :need:`R-07507`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server``
    resource property
    ``metadata`` key/value pair ``vnf_id`` parameter
    **MUST** be declared as ``vnf_id`` and the parameter **MUST**
    be defined as type: ``string``.


.. container:: note

    :need:`R-37437`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server``
    resource property ``metadata`` **MUST**
    contain the  key/value pair ``vnf_id``
    and the value **MUST** be obtained via a ``get_param``.


.. container:: note

    :need:`R-55218`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server``
    resource property
    ``metadata`` key/value pair ``vnf_id`` parameter ``vnf_id`` **MUST NOT**
    have parameter constraints defined.


Resource: OS::Nova::Server Metadata Parameters > vnf_name
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-36542`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``vnf_name`` parameter
    ``vnf_name`` **MUST NOT**
    be enumerated in the Heat Orchestration Template's environment file.


.. container:: note

    :need:`R-72483`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource property
    ``metadata`` **MUST** contain the key/value pair ``vnf_name`` and the
    value **MUST** be obtained via a ``get_param``.


.. container:: note

    :need:`R-44318`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``vnf_name``
    parameter ``vnf_name`` **MUST NOT**
    have parameter constraints defined.


.. container:: note

    :need:`R-62428`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``vnf_name`` parameter **MUST**
    be declared as ``vnf_name`` and the parameter **MUST** be defined as
    type: ``string``.


.. container:: note

    :need:`R-16576`

    If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property
    ``metadata`` key/value pair ``vnf_name`` is passed into a Nested YAML
    file, the key/value pair name ``vnf_name`` **MUST NOT** change.


Resource: OS::Nova::Server Metadata Parameters > workload_context
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-74978`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``workload_context``
    parameter **MUST**
    be declared as ``workload_context`` and the parameter **MUST**
    be defined as type: ``string``.


.. container:: note

    :need:`R-02691`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``workload_context``
    parameter ``workload_context`` **MUST NOT**
    be enumerated in the Heat Orchestration Template's environment file.


.. container:: note

    :need:`R-34055`

    A VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``workload_context``
    parameter ``workload_context`` **MUST NOT**
    have parameter constraints defined.


.. container:: note

    :need:`R-75202`

    If a VNF's Heat Orchestration Template's ``OS::Nova::Server`` resource
    property ``metadata`` key/value pair ``workload_context``
    is passed into a Nested YAML
    file, the key/value pair name ``workload_context`` **MUST NOT** change.


VNF On-boarding and package management > Resource Description
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-22346`

    The VNF package MUST provide :doc:`VES Event Registration <../../../../vnfsdk/module.git/files/VESEventRegistration_3_0>`
    for all VES events provided by that xNF.


.. container:: note

    :need:`R-384337`

    The VNF documentation **MUST** contain a list of the files within the VNF
    package that are static during the VNF's runtime.


VNF On-boarding and package management > Testing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-43958`

    The xNF Package **MUST** include documentation describing
    the tests that were conducted by the xNF provider and the test results.


VNF Resiliency > Virtual Function - Container Recovery Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-46851`

    The VNF **MUST** support ONAP Controller's Evacuate command.


.. container:: note

    :need:`R-48761`

    The VNF **MUST** support ONAP Controller's Snapshot command.


VNF Security > VNF API Security Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-21210`

    The VNF **MUST** implement the following input validation control
    on APIs: Validate that any input file has a correct and valid
    Multipurpose Internet Mail Extensions (MIME) type. Input files
    should be tested for spoofed MIME types.


.. container:: note

    :need:`R-54930`

    The VNF **MUST** implement the following input validation controls:
    Do not permit input that contains content or characters inappropriate
    to the input expected by the design. Inappropriate input, such as
    SQL expressions, may cause the system to execute undesirable and
    unauthorized transactions against the database or allow other
    inappropriate access to the internal network (injection attacks).


.. container:: note

    :need:`R-43884`

    The VNF **SHOULD** integrate with the Operator's authentication and
    authorization services (e.g., IDAM).


Requirements Removed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    R-02137

    The VNF **MUST** implement all monitoring and logging as
    described in the Security Analytics section.


.. container:: note

    R-15659

    The VNF **MUST** restrict changing the criticality level of
    a system security alarm to administrator(s).


.. container:: note

    R-19367

    The VNF **MUST** monitor API invocation patterns to detect
    anomalous access patterns that may represent fraudulent access or
    other types of attacks, or integrate with tools that implement anomaly
    and abuse detection.


.. container:: note

    R-19804

    The VNF **MUST** validate the CA signature on the certificate,
    ensure that the date is within the validity period of the certificate,
    check the Certificate Revocation List (CRL), and recognize the identity
    represented by the certificate where PKI-based authentication is used.


.. container:: note

    R-23772

    The VNF **MUST** validate input at all layers implementing VNF APIs.


.. container:: note

    R-25878

    The VNF **MUST** use certificates issued from publicly
    recognized Certificate Authorities (CA) for the authentication process
    where PKI-based authentication is used.


.. container:: note

    R-37608

    The VNF **MUST** provide a mechanism to restrict access based
    on the attributes of the VNF and the attributes of the subject.


.. container:: note

    R-78066

    The VNF **MUST** support requests for information from law
    enforcement and government agencies.


.. container:: note

    R-87135

    The VNF **MUST** comply with NIST standards and industry
    best practices for all implementations of cryptography.


VNF Security > VNF Cryptography Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-48080`

    The VNF **SHOULD** support an automated certificate management protocol
    such as CMPv2, Simple Certificate Enrollment Protocol (SCEP) or
    Automated Certificate Management Environment (ACME).


.. container:: note

    :need:`R-93860`

    The VNF **SHOULD** provide the capability to integrate with an
    external encryption service.


.. container:: note

    :need:`R-41994`

    The VNF **MUST** support the use of X.509 certificates issued from any
    Certificate Authority (CA) that is compliant with RFC5280, e.g., a public
    CA such as DigiCert or Let's Encrypt, or an RFC5280  compliant Operator
    CA.

    Note: The VNF provider cannot require the use of self-signed certificates
    in an Operator's run time environment.


.. container:: note

    :need:`R-49109`

    The VNF **MUST** support HTTP/S using TLS v1.2 or higher
    with strong cryptographic ciphers.


VNF Security > VNF Data Protection Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-69610`

    The VNF **MUST** provide the capability of using X.509 certificates
    issued by an external Certificate Authority.


.. container:: note

    :need:`R-58964`

    The VNF **MUST** provide the capability to restrict read
    and write access to data handled by the VNF.


.. container:: note

    :need:`R-47204`

    The VNF **MUST** be capable of protecting the confidentiality and integrity
    of data at rest and in transit from unauthorized access and modification.


.. container:: note

    :need:`R-32641`

    The VNF **MUST** provide the capability to encrypt data on
    non-volatile memory.Non-volative memory is storage that is
    capable of retaining data without electrical power, e.g.
    Complementary metal-oxide-semiconductor (CMOS) or hard drives.


.. container:: note

    :need:`R-73067`

    The VNF **MUST** use NIST and industry standard cryptographic
    algorithms and standard modes of operations when implementing
    cryptography.


.. container:: note

    :need:`R-95864`

    The VNF **MUST** support digital certificates that comply with X.509
    standards.


.. container:: note

    :need:`R-02170`

    The VNF **MUST** use, whenever possible, standard implementations
    of security applications, protocols, and formats, e.g., S/MIME, TLS, SSH,
    IPSec, X.509 digital certificates for cryptographic implementations.
    These implementations must be purchased from reputable vendors or obtained
    from reputable open source communities and must not be developed in-house.


.. container:: note

    :need:`R-70933`

    The VNF **MUST** provide the ability to migrate to newer
    versions of cryptographic algorithms and protocols with minimal impact.


.. container:: note

    :need:`R-12467`

    The VNF **MUST NOT** use compromised encryption algorithms.
    For example, SHA, DSS, MD5, SHA-1 and Skipjack algorithms.
    Acceptable algorithms can be found in the NIST FIPS publications
    (https://csrc.nist.gov/publications/fips) and in the
    NIST Special Publications (https://csrc.nist.gov/publications/sp).


Requirements Removed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    R-22645

    The VNF **SHOULD** use commercial algorithms only when there
    are no applicable governmental standards for specific cryptographic
    functions, e.g., public key cryptography, message digests.


.. container:: note

    R-99112

    The VNF **MUST** provide the capability to restrict access
    to data to specific users.


VNF Security > VNF General Security Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-118669`

    Login access (e.g., shell access) to the operating system layer, whether
    interactive or as part of an automated process, **MUST** be through an
    encrypted protocol such as SSH or TLS.


.. container:: note

    :need:`R-240760`

    The VNF **MUST NOT** contain any backdoors.


.. container:: note

    :need:`R-256267`

    If SNMP is utilized, the VNF **MUST** support at least SNMPv3 with
    message authentication.


.. container:: note

    :need:`R-258686`

    The VNF application processes **MUST NOT** run as root.


.. container:: note

    :need:`R-343842`

    The VNF **MUST**, after a successful login at command line or a GUI,
    display the last valid login date and time and the number of unsuccessful
    attempts since then made with that user's ID. This requirement is only
    applicable when the user account is defined locally in the VNF.


.. container:: note

    :need:`R-638682`

    The VNF **MUST** log any security event required by the VNF Requirements to
    Syslog using LOG_AUTHPRIV for any event that would contain sensitive
    information and LOG_AUTH for all other relevant events.


.. container:: note

    :need:`R-756950`

    The VNF **MUST** be operable without the use of Network File System (NFS).


.. container:: note

    :need:`R-842258`

    The VNF **MUST** include a configuration, e.g., a heat template or CSAR
    package, that specifies the targetted parameters, e.g. a limited set of
    ports, over which the VNF will communicate (including internal, external
    and management communication).


.. container:: note

    :need:`R-872986`

    The VNF **MUST** store Authentication Credentials used to authenticate to
    other systems encrypted except where there is a technical need to store
    the password unencrypted in which case it must be protected using other
    security techniques that include the use of file and directory permissions.
    Ideally, credentials SHOULD rely on a HW Root of Trust, such as a
    TPM or HSM.


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-62498`

    The VNF **MUST** support encrypted access protocols, e.g., TLS,
    SSH, SFTP.


.. container:: note

    :need:`R-23882`

    The VNF **SHOULD** provide the capability for the Operator to run security
    vulnerability scans of the operating system and all application layers.


.. container:: note

    :need:`R-61354`

    The VNF **MUST** provide a mechanism (e.g., access control list) to
    permit and/or restrict access to services on the VNF by source,
    destination, protocol, and/or port.


.. container:: note

    :need:`R-19768`

    The VNF **SHOULD** support network segregation, i.e., separation of OA&M
    traffic from signaling and payload traffic, using technologies such as
    VPN and VLAN.


.. container:: note

    :need:`R-19082`

    The VNF **MUST** allow the Operator to disable or remove any security
    testing tools or programs included in the VNF, e.g., password cracker,
    port scanner.


.. container:: note

    :need:`R-86261`

    The VNF **MUST** support the ability to prohibit remote access to the VNF
    via a host based security mechanism.


.. container:: note

    :need:`R-99771`

    The VNF **MUST** have all code (e.g., QCOW2) and configuration files
    (e.g., HEAT template, Ansible playbook, script) hardened, or with
    documented recommended configurations for hardening and interfaces that
    allow the Operator to harden the VNF. Actions taken to harden a system
    include disabling all unnecessary services, and changing default values
    such as default credentials and community strings.


.. container:: note

    :need:`R-80335`

    For all GUI and command-line interfaces, the VNF **MUST** provide the
    ability to present a warning notice that is set by the Operator. A warning
    notice is a formal statement of resource intent presented to everyone
    who accesses the system.


.. container:: note

    :need:`R-21819`

    The VNF **MUST** provide functionality that enables the Operator to comply
    with requests for information from law enforcement and government agencies.


.. container:: note

    :need:`R-23740`

    The VNF **MUST** implement and enforce the principle of least privilege
    on all protected interfaces.


.. container:: note

    :need:`R-40813`

    The VNF **SHOULD** support the use of virtual trusted platform
    module.


.. container:: note

    :need:`R-69649`

    The VNF Provider **MUST** have patches available for vulnerabilities
    in the VNF as soon as possible. Patching shall be controlled via change
    control process with vulnerabilities disclosed along with
    mitigation recommendations.


.. container:: note

    :need:`R-92207`

    The VNF **SHOULD** provide a mechanism that enables the operators to
    perform automated system configuration auditing at configurable time
    intervals.


Requirements Removed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    R-26586

    The VNF **SHOULD** support the ability to work with aliases
    (e.g., gateways, proxies) to protect and encapsulate resources.


.. container:: note

    R-33981

    The VNF **SHOULD** interoperate with various access control
    mechanisms for the Network Cloud execution environment (e.g.,
    Hypervisors, containers).


.. container:: note

    R-35144

    The VNF **MUST**, if not using the NCSP's IDAM API, comply
    with the NCSP's credential management policy.


.. container:: note

    R-39342

    The VNF **MUST**, if not using the NCSP's IDAM API, comply
    with "password changes (includes default passwords)" policy. Products
    will support password aging, syntax and other credential management
    practices on a configurable basis.


.. container:: note

    R-40521

    The VNF **MUST**, if not using the NCSP's IDAM API, support
    use of common third party authentication and authorization tools such
    as TACACS+, RADIUS.


.. container:: note

    R-42681

    The VNF **MUST** use the NCSP's IDAM API or comply with
    the requirements if not using the NCSP's IDAM API, for identification,
    authentication and access control of OA&M and other system level
    functions.


.. container:: note

    R-49956

    The VNF **MUST** pass all access to applications (Bearer,
    signaling and OA&M) through various security tools and platforms from
    ACLs, stateful firewalls and application layer gateways depending on
    manner of deployment. The application is expected to function (and in
    some cases, interwork) with these security tools.


.. container:: note

    R-52085

    The VNF **MUST**, if not using the NCSP's IDAM API, provide
    the ability to support Multi-Factor Authentication (e.g., 1st factor =
    Software token on device (RSA SecureID); 2nd factor = User Name+Password,
    etc.) for the users.


.. container:: note

    R-55830

    The VNF **MUST** distribute all production code from NCSP
    internal sources only. No production code, libraries, OS images, etc.
    shall be distributed from publically accessible depots.


.. container:: note

    R-63217

    The VNF **MUST**, if not using the NCSP's IDAM API, support
    logging via ONAP for a historical view of "who did what and when."


.. container:: note

    R-68589

    The VNF **MUST**, if not using the NCSP's IDAM API, support
    User-IDs and passwords to uniquely identify the user/application. VNF
    needs to have appropriate connectors to the Identity, Authentication
    and Authorization systems that enables access at OS, Database and
    Application levels as appropriate.


.. container:: note

    R-85633

    The VNF **MUST** implement Data Storage Encryption
    (database/disk encryption) for Sensitive Personal Information (SPI)
    and other subscriber identifiable data.

    Note: Subscribers SPI/data must be encrypted at rest, and other
    subscriber identifiable data should be encrypted at rest. Other
    data protection requirements exist and should be well understood
    by the developer.


VNF Security > VNF Identity and Access Management Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-231402`

    The VNF **MUST** provide a means for the user to explicitly logout, thus
    ending that session for that authenticated user.


.. container:: note

    :need:`R-45719`

    The VNF **MUST**, if not integrated with the Operator's Identity and Access
    Management system, or enforce a configurable "terminate idle sessions"
    policy by terminating the session after a configurable period of inactivity.


.. container:: note

    :need:`R-479386`

    The VNF **MUST NOT** display "Welcome" notices or messages that could
    be misinterpreted as extending an invitation to unauthorized users.


.. container:: note

    :need:`R-581188`

    A failed authentication attempt **MUST NOT** identify the reason for the
    failure to the user, only that the authentication failed.


.. container:: note

    :need:`R-814377`

    The VNF **MUST** have the capability of allowing the Operator to create,
    manage, and automatically provision user accounts using an Operator
    approved identity lifecycle management tool using a standard protocol,
    e.g., NETCONF API.


.. container:: note

    :need:`R-844011`

    The VNF MUST not store authentication credentials to itself in clear
    text or any reversible form and must use salting.


.. container:: note

    :need:`R-931076`

    The VNF **MUST** support account names that contain at least A-Z, a-z,
    0-9 character sets and be at least 6 characters in length.


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-23135`

    The VNF **MUST**, if not integrated with the Operator's identity and
    access management system, authenticate all access to protected GUIs, CLIs,
    and APIs.


.. container:: note

    :need:`R-15671`

    The VNF **MUST** provide access controls that allow the Operator
    to restrict access to VNF functions and data to authorized entities.


.. container:: note

    :need:`R-78010`

    The VNF **MUST** integrate with standard identity and access management
    protocols such as LDAP, TACACS+, Windows Integrated Authentication
    (Kerberos), SAML federation, or OAuth 2.0.


.. container:: note

    :need:`R-86835`

    The VNF **MUST** set the default settings for user access
    to deny authorization, except for a super user type of account.
    When a VNF is added to the network, nothing should be able to use
    it until the super user configures the VNF to allow other users
    (human and application)  have access.


.. container:: note

    :need:`R-59391`

    The VNF **MUST NOT** allow the assumption of the permissions of another
    account to mask individual accountability. For example, use SUDO when a
    user requires elevated permissions such as root or admin.


.. container:: note

    :need:`R-75041`

    The VNF **MUST**, if not integrated with the Operator's Identity and
    Access Management system, support configurable password expiration.


.. container:: note

    :need:`R-71787`

    Each architectural layer of the VNF (eg. operating system, network,
    application) **MUST** support access restriction independently of all
    other layers so that Segregation of Duties can be implemented.


.. container:: note

    :need:`R-79107`

    The VNF **MUST**, if not integrated with the Operator's Identity
    and Access Management system, support the ability to disable the
    userID after a configurable number of consecutive unsuccessful
    authentication attempts using the same userID.


.. container:: note

    :need:`R-46908`

    The VNF **MUST**, if not integrated with the Operator's Identity and
    Access Management system, comply with "password complexity" policy. When
    passwords are used, they shall be complex and shall at least meet the
    following password construction requirements: (1) be a minimum configurable
    number of characters in length, (2) include 3 of the 4 following types of
    characters: upper-case alphabetic, lower-case alphabetic, numeric, and
    special, (3) not be the same as the UserID with which they are associated
    or other common strings as specified by the environment, (4) not contain
    repeating or sequential characters or numbers, (5) not to use special
    characters that may have command functions, and (6) new passwords must
    not contain sequences of three or more characters from the previous
    password.


.. container:: note

    :need:`R-85419`

    The VNF **SHOULD** support OAuth 2.0 authorization using an external
    Authorization Server.


.. container:: note

    :need:`R-98391`

    The VNF **MUST**, if not integrated with the Operator's Identity and
    Access Management system, support Role-Based Access Control to enforce
    least privilege.


.. container:: note

    :need:`R-99174`

    The VNF **MUST**, if not integrated with the Operator's Identity and
    Access Management system, support the creation of multiple IDs so that
    individual accountability can be supported.


.. container:: note

    :need:`R-81147`

    The VNF **MUST** support strong authentication, also known as
    multifactor authentication, on all protected interfaces exposed by the
    VNF for use by human users. Strong authentication uses at least two of the
    three different types of authentication factors in order to prove the
    claimed identity of a user.


.. container:: note

    :need:`R-42874`

    The VNF **MUST** allow the Operator to restrict access based on
    the assigned permissions associated with an ID in order to support
    Least Privilege (no more privilege than required to perform job
    functions).


Requirements Removed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    R-05470

    The VNF **MUST** host connectors for access to the database layer.


.. container:: note

    R-14025

    The VNF **MUST** provide or support the Identity and Access
    Management (IDAM) based threat detection data for Session Hijacking.


.. container:: note

    R-19790

    The VNF **MUST NOT** include authentication credentials
    in security audit logs, even if encrypted.


.. container:: note

    R-24825

    The VNF **MUST** provide Context awareness data (device,
    location, time, etc.) and be able to integrate with threat detection system.


.. container:: note

    R-29301

    The VNF **MUST** provide or support the Identity and Access
    Management (IDAM) based threat detection data for Password Attacks.


.. container:: note

    R-31412

    The VNF **MUST** provide or support the Identity and Access
    Management (IDAM) based threat detection data for XSS / CSRF.


.. container:: note

    R-31751

    The VNF **MUST** subject VNF provider access to privilege
    reconciliation tools to prevent access creep and ensure correct
    enforcement of access policies.


.. container:: note

    R-44032

    The VNF **MUST** provide or support the Identity and Access
    Management (IDAM) based threat detection data for Man in the Middle (MITM).


.. container:: note

    R-45496

    The VNF **MUST** host connectors for access to the OS (Operating System) layer.


.. container:: note

    R-49945

    The VNF **MUST** authorize VNF provider access through a
    client application API by the client application owner and the resource
    owner of the VNF before provisioning authorization through Role Based
    Access Control (RBAC), Attribute Based Access Control (ABAC), or other
    policy based mechanism.


.. container:: note

    R-51883

    The VNF **MUST** provide or support the Identity and Access
    Management (IDAM) based threat detection data for Replay.


.. container:: note

    R-58977

    The VNF **MUST** provide or support the Identity and Access
    Management (IDAM) based threat detection data for Eavesdropping.


.. container:: note

    R-58998

    The VNF **MUST** provide or support the Identity and Access
    Management (IDAM) based threat detection data for Malware (Key Logger).


.. container:: note

    R-64503

    The VNF **MUST** provide minimum privileges for initial
    and default settings for new user accounts.


.. container:: note

    R-72243

    The VNF **MUST** provide or support the Identity and Access
    Management (IDAM) based threat detection data for Phishing / SMishing.


.. container:: note

    R-73541

    The VNF **MUST** use access controls for VNFs and their
    supporting computing systems at all times to restrict access to
    authorized personnel only, e.g., least privilege. These controls
    could include the use of system configuration or access control
    software.


.. container:: note

    R-77157

    The VNF **MUST** conform to approved request, workflow
    authorization, and authorization provisioning requirements when
    creating privileged users.


.. container:: note

    R-85028

    The VNF **MUST** authenticate system to system access and
    do not conceal a VNF provider user's individual accountability for
    transactions.


.. container:: note

    R-89753

    The VNF **MUST NOT** install or use systems, tools or
    utilities capable of capturing or logging data that was not created
    by them or sent specifically to them in production, without
    authorization of the VNF system owner.


.. container:: note

    R-95105

    The VNF **MUST** host connectors for access to the application layer.


VNF Security > VNF Security Analytics Requirements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^


Requirements Added
~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-303569`

    The VNF **MUST** log the Source IP address in the security audit logs.


.. container:: note

    :need:`R-465236`

    The VNF **SHOULD** provide the capability of maintaining the integrity of
    its static files using a cryptographic method.


.. container:: note

    :need:`R-629534`

    The VNF **MUST** be capable of automatically synchronizing the system clock
    daily with the Operator's trusted time source, to assure accurate time
    reporting in log files. It is recommended that Coordinated Universal Time
    (UTC) be used where possible, so as to eliminate ambiguity owing to daylight
    savings time.


.. container:: note

    :need:`R-703767`

    The VNF **MUST** have the capability to securely transmit the security logs
    and security events to a remote system before they are purged from the
    system.


.. container:: note

    :need:`R-859208`

    The VNF **MUST** log automated remote activities performed with
    elevated privileges.


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-07617`

    The VNF **MUST** log success and unsuccessful creation, removal, or
    change to the inherent privilege level of users.


.. container:: note

    :need:`R-22367`

    The VNF **MUST** support detection of malformed packets due to software
    misconfiguration or software vulnerability, and generate an error to the
    syslog console facility.


.. container:: note

    :need:`R-34552`

    The VNF **MUST** be implemented so that it is not vulnerable to OWASP
    Top 10 web application security risks.


.. container:: note

    :need:`R-54520`

    The VNF **MUST** log successful and unsuccessful authentication
    attempts, e.g., authentication associated with a transaction,
    authentication to create a session, authentication to assume elevated
    privilege.


.. container:: note

    :need:`R-58370`

    The VNF **SHOULD** operate with anti-virus software which produces alarms
    every time a virus is detected.


.. container:: note

    :need:`R-94525`

    The VNF **MUST** log connections to the network listeners of the
    resource.


.. container:: note

    :need:`R-43332`

    The VNF **MUST** activate security alarms automatically when
    it detects the successful modification of a critical system or
    application file.


.. container:: note

    :need:`R-41825`

    The VNF **MUST** activate security alarms automatically when
    a configurable number of consecutive unsuccessful login attempts
    is reached.


.. container:: note

    :need:`R-29705`

    The VNF **MUST** restrict changing the criticality level of a
    system security alarm to users with administrative privileges.


.. container:: note

    :need:`R-63330`

    The VNF **MUST** detect when its security audit log storage
    medium is approaching capacity (configurable) and issue an alarm.


.. container:: note

    :need:`R-30932`

    The VNF **MUST** log successful and unsuccessful access to VNF
    resources, including data.


.. container:: note

    :need:`R-04492`

    The VNF **MUST** generate security audit logs that can be sent
    to Security Analytics Tools for analysis.


.. container:: note

    :need:`R-74958`

    The VNF **MUST** activate security alarms automatically when
    it detects an unsuccessful attempt to gain permissions
    or assume the identity of another user.


.. container:: note

    :need:`R-54816`

    The VNF **MUST** support the storage of security audit logs for a
    configurable period of time.


Requirements Removed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    R-08598

    The VNF **MUST** log successful and unsuccessful changes to a privilege level.


.. container:: note

    R-19219

    The VNF **MUST** provide audit logs that include user ID, dates,
    times for log-on and log-off, and terminal location at minimum.


.. container:: note

    R-20912

    The VNF **MUST** support alternative monitoring capabilities
    when VNFs do not expose data or control traffic or use proprietary and
    optimized protocols for inter VNF communication.


.. container:: note

    R-25094

    The VNF **MUST** perform data capture for security functions.


.. container:: note

    R-31961

    The VNF **MUST** support integrated DPI/monitoring functionality
    as part of VNFs (e.g., PGW, MME).


.. container:: note

    R-56786

    The VNF **MUST** implement "Closed Loop" automatic implementation
    (without human intervention) for Known Threats with detection rate in low
    false positives.


.. container:: note

    R-57271

    The VNF **MUST** provide the capability of generating security
    audit logs by interacting with the operating system (OS) as appropriate.


.. container:: note

    R-61648

    The VNF **MUST** support event logging, formats, and delivery
    tools to provide the required degree of event data to ONAP.


{network-role}
^^^^^^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-26506`

    A VNF's Heat Orchestration Template's ``{network-role}`` **MUST** contain
    only alphanumeric characters and/or underscores '_' and
    **MUST NOT** contain any of the following strings:
    ``_int`` or ``int_`` or ``_int_``.


.. container:: note

    :need:`R-84322`

    A VNF's Heat Orchestration Template's Resource property parameter that
    is associated with an internal network **MUST** include
    ``int_{network-role}`` as part of the parameter name,
    where ``int_`` is a hard coded string.


.. container:: note

    :need:`R-96983`

    A VNF's Heat Orchestration Template's Resource ID that is associated
    with an internal network **MUST** include ``int_{network-role}`` as part
    of the Resource ID, where ``int_`` is a hard coded string.


{vm-type}
^^^^^^^^^


Requirements Changed
~~~~~~~~~~~~~~~~~~~~


.. container:: note

    :need:`R-82481`

    A VNF's Heat Orchestration Template's Resource property parameter that is
    associated with a unique Virtual Machine type **MUST** include
    ``{vm-type}`` as part of the parameter name with two exceptions:

     1.) The Resource ``OS::Nova::Server`` property ``availability_zone``
     parameter **MUST NOT** be prefixed with a common ``{vm-type}`` identifier,

     2.) The Resource ``OS::Nova::Server`` eight mandatory and optional
     ``metadata``
     parameters (i.e., ``vnf_name``, ``vnf_id``, ``vf_module_id``,
     ``vf_module_name``, ``vm_role``,
     ``vf_module_index``, ``environment_context``, ``workload_context``)
     **MUST NOT** be prefixed with a common ``{vm-type}`` identifier.


.. container:: note

    :need:`R-98407`

    A VNF's Heat Orchestration Template's ``{vm-type}`` **MUST** contain only
    alphanumeric characters and/or underscores '_' and **MUST NOT**
    contain any of the following strings:
    ``_int`` or ``int_`` or ``_int_``.


.. container:: note

    :need:`R-01455`

    When a VNF's Heat Orchestration Template creates a Virtual Machine
    (i.e., ``OS::Nova::Server``),
    each "class" of VMs **MUST** be assigned a VNF unique
    ``{vm-type}``; where "class" defines VMs that
    **MUST** have the following identical characteristics:

      1.) ``OS::Nova::Server`` resource property ``flavor`` value

      2.) ``OS::Nova::Server`` resource property ``image`` value

      3.) Cinder Volume attachments

        - Each VM in the "class" **MUST** have the identical Cinder Volume
          configuration

      4.) Network attachments and IP address requirements

        - Each VM in the "class" **MUST** have the the identical number of
          ports connecting to the identical networks and requiring the identical
          IP address configuration.